v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Create an invoice for the sale of a membership

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

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

post/api/Catalog/Memberships/CreateInvoice

Response

200

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

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

Example response

{
  "Invoice": {
    "Id": "eafdf692-28c5-4045-87a4-304af218c6f1",
    "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": 500,
      "Final": 500,
      "Final1": 500
    },
    "SaleDate": "2020-09-24T17:37:08",
    "Status": 1,
    "InvoiceMemberships": [
      {
        "AppointmentMembership": {
          "Membership": {
            "Id": "23aa3e9b-ee21-407c-923b-db751b9e3154",
            "VersionId": "23aa3e9b-ee21-407c-923b-db751b9e3154",
            "Name": "Non Recurring June Mem",
            "Price": {
              "CurrencyId": 148,
              "Sales": 500,
              "Final": 500,
              "Final1": 500
            },
            "DisplayName": "Non Recurring June Mem Catalog name",
            "Description": "Non Recurring June Mem General Tab",
            "HTMLDescription": "Non+Recurring+June+Mem+Catalog+html+desc+update",
            "TermsandConditions": "<ol>\r\n<li>hi</li>\r\n<li>hi1</li>\r\n<li>hi2</li>\r\n<li>hi3</li>\r\n</ol>"
          },
          "InvoiceItemId": "b4b2c7cf-f163-41a9-9c2a-dc6e751dce89",
          "Quantity": 1,
          "Price": {
            "CurrencyId": 148,
            "Sales": 500,
            "Final": 500,
            "Final1": 500
          },
          "HasFilledMembershipForms": true
        }
      }
    ],
    "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
  }
}