v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Create an invoice for the sale of a series package

This API helps you to create an invoice for the sale of a series package.

You must specify appropriate details for the parameters in the API request body. For more information, refer to the Request Body Parameters table.

post/Catalog/SeriesPackages/CreateInvoice

Query parameters

CenterIdstring

Unique 32-character identifier of the center.

userIdstring

Unique 32-character identifier of the guest.

packageIdsstring

IDs of the package applied on the appointment invoice.

Response

200

{"stackTrail":"paths:/Catalog/SeriesPackages/CreateInvoice:post:responses:200:content:application/json:schema:properties:PaymentOptions","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/Catalog/SeriesPackages/CreateInvoice:post:responses:200:content:application/json:schema:properties:Error","oasType":"schema","type":"unknown"}

Example response

{
  "Invoice": {
    "Id": "533f0849-7f25-4afe-b99f-e1b50e65c549",
    "Guest": {
      "Id": "687a1c1a-720e-4933-8a54-8f2745f2d6ec",
      "FirstName": "testuser6",
      "LastName": "prasthana",
      "MobilePhoneModel": {
        "CountryId": -1
      },
      "DateOfBirth": "1990-06-07T00:00:00",
      "State": {
        "Id": -1
      },
      "Country": {
        "Id": 225,
        "Code": "US",
        "Name": "United States",
        "PhoneCode": 1,
        "Nationality": "American"
      },
      "CenterId": "d51712b1-6040-4dd4-abff-cffc9d36f89e",
      "GuestIndicator": "0@0@0@0@0@0@0@x@0@0@0",
      "FormDetails": [
        {
          "AppointmentId": "00000000-0000-0000-0000-000000000000",
          "FormId": "7f51b43a-829c-4d4b-8429-26803b11043b",
          "Name": "Guest Intake Form",
          "LastFilledDate": "0001-01-01T00:00:00",
          "FormType": 3
        }
      ],
      "LpTierInfo": "0@x",
      "GuestIndicatorValue": {
        "Member": 2,
        "Dues": true,
        "CardOnFile": true
      }
    },
    "Price": {
      "CurrencyId": 148,
      "Sales": 1500,
      "Final": 1500,
      "Final1": 1500
    },
    "SaleDate": "2020-09-24T17:41:50",
    "Status": 1,
    "InvoiceSeriesPackages": [
      {
        "AppointmentSeriesPackage": {
          "Package": {
            "Id": "0af3cd21-2ff3-49f5-a97f-2c8bd6f9ba77",
            "Name": "Pkg_02",
            "Price": {
              "CurrencyId": 148,
              "Sales": 1500,
              "Final": 1500,
              "Final1": 1500
            }
          },
          "InvoiceItemId": "e9bc0a4d-c421-49c3-bb09-e00e271cd115",
          "PackageUserId": "f7af7094-5d13-4a72-93a3-1101211fbd27",
          "Quantity": 1,
          "Price": {
            "CurrencyId": 148,
            "Sales": 1500,
            "Final": 1500,
            "Final1": 1500
          }
        }
      }
    ],
    "CenterId": "d51712b1-6040-4dd4-abff-cffc9d36f89e",
    "Center": {
      "Id": "d51712b1-6040-4dd4-abff-cffc9d36f89e",
      "Country": {
        "Id": 225,
        "Code": "US",
        "Name": "United States",
        "PhoneCode": 1,
        "Nationality": "American"
      },
      "State": {
        "Id": 36,
        "Code": "US01",
        "Name": "Alabama",
        "ShortName": "AL"
      },
      "Name": "PRASTHANA KDEV",
      "GeoLatitude": 17.385,
      "GeoLongitude": 78.4867,
      "Address1": "Kothaguda",
      "Address2": "hytech city",
      "Phone1": {
        "CountryId": 225
      },
      "Phone2": {
        "CountryId": 225
      },
      "CanBook": true,
      "CenterCode": "PRAS987",
      "TimeZone": {
        "Id": 68,
        "Name": "(UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi",
        "StandardName": "India Standard Time",
        "Symbol": "India Standard Time"
      },
      "CollectFeedback": true,
      "Zone": {
        "id": "00000000-0000-0000-0000-000000000000"
      }
    },
    "CollectFeedback": true,
    "InvoiceAuthStatus": -3,
    "InvoiceAuthorizationStatus": -3,
    "InvTransactionStatusForAutoPay": -2,
    "InvoiceSource": 2
  }
}