v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Redeem the loyalty points of a guest

Use this API to redeem a guest’s applicable loyalty points while taking payment for an invoice.

You must specify appropriate details for the InvoiceId parameter in the API request. Optionally, you can provide the required value for the expand parameter.

In addition, you can specify the necessary details for the body parameters.

post/v1/invoices/{InvoiceId}/payments/loyalty_points

Path parameters

InvoiceIdstring required

Mandatory Unique 32-character identifier of the invoice for which this API will redeem the guest's applicable loyalty points.

Query parameters

expandstring

Optional For example, if you specify the value of this parameter as invoice_details, this API returns the details of the invoice along with the loyalty points-payment details.

Response

200

{"stackTrail":"paths:/v1/invoices/{InvoiceId}/payments/loyalty_points:post:responses:200:content:application/json:schema:properties:redemptions","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/invoices/{InvoiceId}/payments/loyalty_points:post:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "payment": {
    "PaymentOption": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "PaymentMode": 7,
      "CardNumber": "10"
    },
    "TotalAmountPaid": 0.71,
    "AmountPaid": 0.71,
    "TransactionId": "5e7a88f5-f80f-42ae-be53-b03b95b5f65e",
    "PaymentDate": "2020-10-23T04:08:46"
  },
  "invoice": {
    "Id": "f9e54f8b-6534-498a-b96e-a05e76f5656f",
    "InvoiceNumber": "RR11450",
    "Guest": {
      "Id": "fc9b7071-3c3c-4e2f-ad65-89b8ca0842b5",
      "FirstName": "Test",
      "LastName": "Lpgue1",
      "Email": "test@lpgue1.com",
      "MobileNumber": "+91 4567987654",
      "MobilePhoneModel": {
        "CountryId": -1,
        "Number": "+91 4567987654",
        "DisplayNumber": "+91 4567987654"
      },
      "Gender": 1,
      "Address1": ", Telangana",
      "State": {
        "Id": 3227,
        "Code": "IN0036",
        "Name": "Telangana",
        "ShortName": "TS"
      },
      "Country": {
        "Id": 95,
        "Code": "IN",
        "Name": "India",
        "PhoneCode": 91,
        "Nationality": "Indian"
      },
      "CenterId": "a11f578a-1b81-4de0-8834-915f79e5362b",
      "GuestIndicator": "0@0@0@0@0@0@0@x@0@0@0",
      "FormDetails": [
        {
          "AppointmentId": "00000000-0000-0000-0000-000000000000",
          "FormId": "00000000-0000-0000-0000-000000000000",
          "LastFilledDate": "0001-01-01T00:00:00",
          "FormType": 4
        }
      ],
      "LpTierInfo": "0@x",
      "GuestIndicatorValue": {
        "Dues": true
      }
    },
    "Price": {
      "CurrencyId": 126,
      "Sales": 100,
      "Final": 100,
      "Final1": 100
    },
    "SaleDate": "2020-10-23T08:51:11",
    "InvoiceProducts": [
      {
        "AppointmentProduct": {
          "Product": {
            "Id": "e78b2e05-e2f7-4326-98c9-d9644d2bb895",
            "Name": "product_test2_100",
            "Price": {
              "CurrencyId": 126,
              "Sales": 100,
              "Final": 100,
              "Final1": 100
            }
          },
          "InvoiceItemId": "926b97b3-9162-4989-aa42-3a2932037ae1",
          "InvoiceItemAddedTime": "2020-10-23T08:51:11",
          "Quantity": 1,
          "Price": {
            "CurrencyId": 126,
            "Sales": 100,
            "Final": 100,
            "Final1": 100
          },
          "Employee": {
            "Id": "b793463d-2f03-43e5-ae47-a5a1c1be0de6",
            "FullName": "Alyssum Owner",
            "Email": "sureshm@zenoti.com",
            "PhoneNumber": "9494443946",
            "Gender": 1,
            "FirstName": "Alyssum",
            "LastName": "Owner"
          }
        }
      }
    ],
    "Payments": [
      {
        "PaymentOption": {
          "Id": "9b11fdaa-4fb5-4f62-badf-33241ccc2700",
          "PaymentMode": 7,
          "PaymentName": "LoyaltyPoints",
          "CardNumber": "10"
        },
        "TotalAmountPaid": 0.7143,
        "AmountPaid": 0.7143,
        "TransactionId": "5e7a88f5-f80f-42ae-be53-b03b95b5f65e",
        "PaymentDate": "2020-10-23T04:08:46.39"
      }
    ],
    "CenterId": "a11f578a-1b81-4de0-8834-915f79e5362b",
    "Center": {
      "Id": "a11f578a-1b81-4de0-8834-915f79e5362b",
      "Country": {
        "Id": 95,
        "Code": "IN",
        "Name": "India",
        "PhoneCode": 91,
        "Nationality": "Indian"
      },
      "State": {
        "Id": 3227,
        "Code": "IN0036",
        "Name": "Telangana",
        "ShortName": "TS"
      },
      "Name": "Khammam",
      "Address1": "This is Address 1 field for Khammam",
      "Address2": "This is Address 2 field for Khammam",
      "City": "City of Khammam",
      "ZipCode": "507160",
      "Phone1": {
        "CountryId": 95,
        "Number": "9014345696",
        "DisplayNumber": "9014345696"
      },
      "Phone2": {
        "CountryId": 95,
        "Number": "9014345696",
        "DisplayNumber": "9014345696"
      },
      "Email": "khammamk@zenoti.com",
      "ServiceTaxNo": "STIVY",
      "TIN": "TINIVY",
      "VAT": "VATIVY",
      "CST": "CSTIVY",
      "CanBook": true,
      "CenterCode": "KMM",
      "TimeZone": {
        "Id": 68,
        "Name": "(UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi",
        "StandardName": "India Standard Time",
        "Symbol": "India Standard Time"
      },
      "CollectFeedback": true,
      "AllowSelfCheckinBefore": 45,
      "Zone": {
        "id": "00000000-0000-0000-0000-000000000000"
      }
    },
    "CollectFeedback": true,
    "InvoiceAuthStatus": -3,
    "InvoiceAuthorizationStatus": -3,
    "InvTransactionStatusForAutoPay": -2
  }
}