GET v1/Companies({CompanyId})/Entities({LocationId})/Invoices({InvoiceId})
Returns the Loyalty Points for an Invoice
Information:
Base URL:
https://api.covasoft.net/iqloyalty
Example of a call would be:
https://api.covasoft.net/iqloyalty/v1/Companies({CompanyId})/Entities({LocationId})/Invoices({InvoiceId})
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
CompanyId |
The unique Company Id that was provided in your onboarding pacakage |
integer |
Required |
LocationId |
The Location where you want Loyalty Rewards |
integer |
Required |
InvoiceId |
The Invoice Id Guid that you want the Loyalty Rewards Summary |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Loyalty Points for an Invoice
LoyaltyPointsByInvoiceReturnName | Description | Type | Additional information |
---|---|---|---|
InvoiceId | globally unique identifier |
None. |
|
PointsEarned | integer |
None. |
|
PointsBalance | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "InvoiceId": "9abd8e42-a6c9-4655-ac45-244846901f9b", "PointsEarned": 2, "PointsBalance": 3 }