v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Close a series package sale invoice

This API helps you to close the invoice of a series package sale.

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

post/Catalog/SeriesPackages/CloseInvoice/{invoice_id}

Query parameters

invoice_idstring

Unique 32-character identifier of the series package sale invoice.

Response

200

MailSentSuccessboolean

ReceiptSentSuccessboolean

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

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

Example response

{
  "Invoice": {
    "Id": "693b776f-efbf-4e06-b230-2bf3783de71b",
    "InvoiceNumber": "2823",
    "ReceiptNumber": "R251",
    "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": 100,
      "Final": 100,
      "Final1": 100
    },
    "SaleDate": "2020-09-24T16:39:06",
    "Status": 4,
    "InvoiceMemberships": [
      {
        "AppointmentMembership": {
          "Membership": {
            "Id": "7e401b0b-d1d1-49f9-84c7-099ea51f5e73",
            "VersionId": "7e401b0b-d1d1-49f9-84c7-099ea51f5e73",
            "Name": "JunNRPtsExpired",
            "Price": {
              "CurrencyId": 148,
              "Sales": 100,
              "Final": 100,
              "Final1": 100
            },
            "DisplayName": "JunNRPtsExpired"
          },
          "InvoiceItemId": "6f118c98-f7e6-4391-b3e5-4646d4258296",
          "Quantity": 1,
          "Price": {
            "CurrencyId": 148,
            "Sales": 100,
            "Final": 100,
            "Final1": 100
          },
          "UserMembershipId": "fe86a1a6-fbbe-410e-8edc-d58004f52a5f",
          "HasFilledMembershipForms": true
        }
      }
    ],
    "Payments": [
      {
        "PaymentOption": {
          "Id": "ed6c0895-d748-48b1-b031-247916bd07d5",
          "PaymentMode": 5,
          "PaymentName": "Visa",
          "CardNumber": "0007"
        },
        "TotalAmountPaid": 100,
        "AmountPaid": 100,
        "TransactionId": "c2959ff3-b91c-4b8a-92bf-723049687fca",
        "PaymentDate": "2020-09-24T11:10:02.723"
      }
    ],
    "RefundItems": [
      {
        "InvoiceItemId": "6f118c98-f7e6-4391-b3e5-4646d4258296",
        "ItemId": "7e401b0b-d1d1-49f9-84c7-099ea51f5e73",
        "Quantity": 1,
        "RefundAmount": 100,
        "RefundDate": "2020-09-24T11:14:19.997"
      }
    ],
    "Lock": 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
  }
}