GET Companies({CompanyId})/Sales({SalesOrderId})
Returns Details for the Sales Order Id provided
Information:
Base URL:
https://api.covasoft.net/pointofsale
Example of a call would be:
https://api.covasoft.net/pointofsale/Companies({CompanyId})/Sales({SalesOrderId})
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId |
The unique Company Id that was provided in your onboarding pacakage. |
integer |
Required |
| SalesOrderId |
This is Sales Order Id Guid that you want details for |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Details for the Sales Order Id provided
GetSalesOrderByIdReturn| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Location | Location |
None. |
|
| Status | string |
None. |
|
| CreatedTime | date |
None. |
|
| TenderedByUserId | integer |
None. |
|
| TenderedBy | string |
None. |
|
| Customer | Customer |
None. |
|
| ReceiptNumber | string |
None. |
|
| InStock | Collection of InStock |
None. |
|
| TaxCalculation | TaxCalculation |
None. |
|
| Payments | Payments |
None. |
|
| Discounts | Discounts |
None. |
|
| InvoiceType | string |
None. |
|
| Total | Total |
None. |
|
| SaleOverrides | SaleOverrides |
None. |
|
| PricingScheme | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "36513070-9ebc-43bd-8f39-1c951ed229eb",
"Location": {
"Id": 1,
"Name": "sample string 2"
},
"Status": "sample string 2",
"CreatedTime": "2025-11-21T14:56:13.3005491+00:00",
"TenderedByUserId": 4,
"TenderedBy": "sample string 5",
"Customer": {
"Id": "9b29638b-d81e-450b-bee1-a397912ea8c0",
"Number": "sample string 2",
"FullName": "sample string 3",
"ShippingAddressId": "sample string 4",
"ShippingAddress": "sample string 5",
"BillingAddress": "sample string 6",
"BillingAddressId": "sample string 7",
"AddressId": "sample string 8",
"MedicalInformation": "sample string 9"
},
"ReceiptNumber": "sample string 6",
"InStock": [
{
"No": 1,
"CatalogId": "dda7ed2c-f316-4114-96aa-6fe1ae808d18",
"Name": "sample string 3",
"SKU": "sample string 4",
"SoldAtPrice": 5,
"ListPrice": 6,
"SalePrice": 1.1,
"Quantity": 7,
"UnitId": 8,
"UnitAbbreviation": "sample string 9",
"MeasurementType": "sample string 10",
"PackageNumber": "sample string 11",
"Batch": "sample string 12",
"SerialNumbers": [
"sample string 1",
"sample string 2"
],
"Attributes": {
"equivalent To": "sample string 1",
"net Weight": "sample string 2",
"retail Marijuana Product Type": "sample string 3"
}
},
{
"No": 1,
"CatalogId": "dda7ed2c-f316-4114-96aa-6fe1ae808d18",
"Name": "sample string 3",
"SKU": "sample string 4",
"SoldAtPrice": 5,
"ListPrice": 6,
"SalePrice": 1.1,
"Quantity": 7,
"UnitId": 8,
"UnitAbbreviation": "sample string 9",
"MeasurementType": "sample string 10",
"PackageNumber": "sample string 11",
"Batch": "sample string 12",
"SerialNumbers": [
"sample string 1",
"sample string 2"
],
"Attributes": {
"equivalent To": "sample string 1",
"net Weight": "sample string 2",
"retail Marijuana Product Type": "sample string 3"
}
}
],
"TaxCalculation": {
"TaxCalculcationId": "sample string 1",
"Lines": [
{
"Tax": 1.1,
"ExemptAmount": 2.1,
"LineNumber": "sample string 3",
"TaxDetails": [
{
"TaxId": "c1579e27-65f2-47ee-8028-80628c7968f6",
"Rate": 2.1,
"TaxName": "sample string 3",
"Tax": 4.1,
"Exemptions": {
"Total": 1.1,
"Details": [
{
"ExemptAmount": 1.1
},
{
"ExemptAmount": 1.1
}
]
},
"TaxAuthorityType": "sample string 5",
"TaxType": "sample string 6",
"Layer": 7
},
{
"TaxId": "c1579e27-65f2-47ee-8028-80628c7968f6",
"Rate": 2.1,
"TaxName": "sample string 3",
"Tax": 4.1,
"Exemptions": {
"Total": 1.1,
"Details": [
{
"ExemptAmount": 1.1
},
{
"ExemptAmount": 1.1
}
]
},
"TaxAuthorityType": "sample string 5",
"TaxType": "sample string 6",
"Layer": 7
}
]
},
{
"Tax": 1.1,
"ExemptAmount": 2.1,
"LineNumber": "sample string 3",
"TaxDetails": [
{
"TaxId": "c1579e27-65f2-47ee-8028-80628c7968f6",
"Rate": 2.1,
"TaxName": "sample string 3",
"Tax": 4.1,
"Exemptions": {
"Total": 1.1,
"Details": [
{
"ExemptAmount": 1.1
},
{
"ExemptAmount": 1.1
}
]
},
"TaxAuthorityType": "sample string 5",
"TaxType": "sample string 6",
"Layer": 7
},
{
"TaxId": "c1579e27-65f2-47ee-8028-80628c7968f6",
"Rate": 2.1,
"TaxName": "sample string 3",
"Tax": 4.1,
"Exemptions": {
"Total": 1.1,
"Details": [
{
"ExemptAmount": 1.1
},
{
"ExemptAmount": 1.1
}
]
},
"TaxAuthorityType": "sample string 5",
"TaxType": "sample string 6",
"Layer": 7
}
]
}
]
},
"Payments": {
"Items": [
{
"TimeTakenUtc": "2025-11-21T14:56:13.3005491+00:00",
"RetainedAmount": 2.1,
"MethodName": "sample string 3",
"PaymentType": "sample string 4",
"Amount": 5.1,
"IntegratedTransactionId": "sample string 6",
"ReferenceId": "sample string 7",
"MappedMethodId": 8,
"DrawerId": "sample string 9",
"Last4Digits": 10,
"CustomerAccountId": "sample string 11"
},
{
"TimeTakenUtc": "2025-11-21T14:56:13.3005491+00:00",
"RetainedAmount": 2.1,
"MethodName": "sample string 3",
"PaymentType": "sample string 4",
"Amount": 5.1,
"IntegratedTransactionId": "sample string 6",
"ReferenceId": "sample string 7",
"MappedMethodId": 8,
"DrawerId": "sample string 9",
"Last4Digits": 10,
"CustomerAccountId": "sample string 11"
}
],
"ChangeDue": 1,
"CashBack": 2
},
"Discounts": {
"Id": "sample string 1",
"InvoiceLevel": [
{
"Id": "sample string 1",
"Name": "sample string 2",
"Type": "sample string 3",
"DiscountType": "sample string 4",
"DiscountLevel": "sample string 5",
"TaxApplication": "sample string 6",
"Amount": 7.1,
"ReasonForDiscountId": "sample string 8",
"PromotionId": "sample string 9",
"LoyaltyRewardId": "sample string 10",
"LineLevelBreakdown": [
{
"LineNumber": 1,
"Amount": 2.1
},
{
"LineNumber": 1,
"Amount": 2.1
}
]
},
{
"Id": "sample string 1",
"Name": "sample string 2",
"Type": "sample string 3",
"DiscountType": "sample string 4",
"DiscountLevel": "sample string 5",
"TaxApplication": "sample string 6",
"Amount": 7.1,
"ReasonForDiscountId": "sample string 8",
"PromotionId": "sample string 9",
"LoyaltyRewardId": "sample string 10",
"LineLevelBreakdown": [
{
"LineNumber": 1,
"Amount": 2.1
},
{
"LineNumber": 1,
"Amount": 2.1
}
]
}
],
"LineLevel": [
{
"Id": "sample string 1",
"Name": "sample string 2",
"Type": "sample string 3",
"DiscountType": "sample string 4",
"DiscountLevel": "sample string 5",
"TaxApplication": "sample string 6",
"Amount": 7.1,
"ReasonForDiscountId": "sample string 8",
"PromotionId": "sample string 9",
"LoyaltyRewardId": "sample string 10",
"LineLevelBreakdown": [
{
"LineNumber": 1,
"Amount": 2.1
},
{
"LineNumber": 1,
"Amount": 2.1
}
]
},
{
"Id": "sample string 1",
"Name": "sample string 2",
"Type": "sample string 3",
"DiscountType": "sample string 4",
"DiscountLevel": "sample string 5",
"TaxApplication": "sample string 6",
"Amount": 7.1,
"ReasonForDiscountId": "sample string 8",
"PromotionId": "sample string 9",
"LoyaltyRewardId": "sample string 10",
"LineLevelBreakdown": [
{
"LineNumber": 1,
"Amount": 2.1
},
{
"LineNumber": 1,
"Amount": 2.1
}
]
}
],
"Total": 2.1
},
"InvoiceType": "sample string 7",
"Total": {
"Products": 1,
"Taxes": 2.1
},
"SaleOverrides": {
"UserId": 1,
"Authorizations": {
"Discount": {
"invoiceLevel": [
{
"name": "sample string 1",
"value": 2.1,
"valueType": "sample string 3"
},
{
"name": "sample string 1",
"value": 2.1,
"valueType": "sample string 3"
}
],
"Granted": true,
"Tag": "sample string 2",
"Percentage": 1.1,
"Dollar": 1.1
}
}
},
"PricingScheme": "sample string 8"
}