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

NameDescriptionTypeAdditional 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

LoyaltyPointsByInvoiceReturn
NameDescriptionTypeAdditional information
InvoiceId

globally unique identifier

None.
PointsEarned

integer

None.
PointsBalance

integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "InvoiceId": "055e86c8-0805-4047-a735-dc26dd1046e5",
  "PointsEarned": 2,
  "PointsBalance": 3
}