GET v1/Companies({CompanyId})/Invoices({InvoiceId})
This call returns a finalized sale invoice by ID
Information:
Base URL:
https://api.covasoft.net/invoice
Example of a call would be:
https://api.covasoft.net/invoice/v1/Companies({CompanyId})/Invoices({InvoiceId})
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
CompanyId |
Company Id from your onboarding package |
integer |
Required |
InvoiceId |
Sales Invoice Guid Id that you want to get the Sales Order Id |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Get Sales Order Id from Sales Invoice
GetSalesOrderIdFromInvoiceIdReturnName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
OriginalInvoiceId | globally unique identifier |
None. |
|
LocationId | integer |
None. |
|
UserId | integer |
None. |
|
PrintableId | string |
None. |
|
OriginalPrintableId | string |
None. |
|
ReceiptNumber | string |
None. |
|
OriginalReceiptNumber | string |
None. |
|
Notes | string |
None. |
|
Annotation | string |
None. |
|
InvoiceType | string |
None. |
|
Customer | Customer |
None. |
|
Orders | Collection of InvoiceOrder |
None. |
|
DropshipOrders | Collection of Object |
None. |
|
Payments | Collection of InvoicePayment |
None. |
|
Discounts | decimal number |
None. |
|
ChangeDue | decimal number |
None. |
|
CashBack | decimal number |
None. |
|
TaxCalculationResult | TaxCalculationResult |
None. |
|
SaleOverrides | Object |
None. |
|
CreatedByUser | string |
None. |
|
CreatedDateUtc | date |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": "cb0f742f-85a2-49f9-b052-bc5204374f5a", "OriginalInvoiceId": "0cd39ab3-9c23-4bef-84cf-c8f95a7f6d62", "LocationId": 2, "UserId": 3, "PrintableId": "sample string 4", "OriginalPrintableId": "sample string 5", "ReceiptNumber": "sample string 6", "OriginalReceiptNumber": "sample string 7", "Notes": "sample string 8", "Annotation": "sample string 9", "InvoiceType": "sample string 10", "Customer": { "Id": "5438aae1-6e4f-4cc4-9a85-6505c80a3963", "Number": "sample string 2", "FullName": "sample string 3", "ShippingAddressId": {}, "ShippingAddress": {}, "BillingAddress": {}, "BillingAddressId": {}, "AddressId": {}, "MedicalInformation": {} }, "Orders": [ { "Id": "63b6906e-d184-4f55-bf01-6cb90d298484", "PrintableId": {}, "ReferenceId": {}, "Items": [ { "LineNumber": 1, "ProductId": "e472841b-e602-451f-8d55-000feaf51747", "Quantity": 3, "UnitId": 4, "UnitAbbreviation": "sample string 5", "Lot": "sample string 6", "SoldAtPrice": 7, "SalePrice": {}, "ListPrice": 9, "Description": "sample string 10", "Sku": "sample string 11", "SerialNumber": "sample string 12", "Total": 13, "Attributes": { "equivalent To": "sample string 1", "net Weight": "sample string 2", "retail Marijuana Product Type": "sample string 3" } }, { "LineNumber": 1, "ProductId": "e472841b-e602-451f-8d55-000feaf51747", "Quantity": 3, "UnitId": 4, "UnitAbbreviation": "sample string 5", "Lot": "sample string 6", "SoldAtPrice": 7, "SalePrice": {}, "ListPrice": 9, "Description": "sample string 10", "Sku": "sample string 11", "SerialNumber": "sample string 12", "Total": 13, "Attributes": { "equivalent To": "sample string 1", "net Weight": "sample string 2", "retail Marijuana Product Type": "sample string 3" } } ] }, { "Id": "63b6906e-d184-4f55-bf01-6cb90d298484", "PrintableId": {}, "ReferenceId": {}, "Items": [ { "LineNumber": 1, "ProductId": "e472841b-e602-451f-8d55-000feaf51747", "Quantity": 3, "UnitId": 4, "UnitAbbreviation": "sample string 5", "Lot": "sample string 6", "SoldAtPrice": 7, "SalePrice": {}, "ListPrice": 9, "Description": "sample string 10", "Sku": "sample string 11", "SerialNumber": "sample string 12", "Total": 13, "Attributes": { "equivalent To": "sample string 1", "net Weight": "sample string 2", "retail Marijuana Product Type": "sample string 3" } }, { "LineNumber": 1, "ProductId": "e472841b-e602-451f-8d55-000feaf51747", "Quantity": 3, "UnitId": 4, "UnitAbbreviation": "sample string 5", "Lot": "sample string 6", "SoldAtPrice": 7, "SalePrice": {}, "ListPrice": 9, "Description": "sample string 10", "Sku": "sample string 11", "SerialNumber": "sample string 12", "Total": 13, "Attributes": { "equivalent To": "sample string 1", "net Weight": "sample string 2", "retail Marijuana Product Type": "sample string 3" } } ] } ], "DropshipOrders": [ {}, {} ], "Payments": [ { "Id": "d27c9731-02d3-4d7d-985a-fa7aee076b1c", "OriginalPaymentId": {}, "DrawerId": "e38107c2-4eda-450d-b863-3d8351cb0f98", "Last4Digits": {}, "CustomerAccountId": {}, "PaymentMethodId": 6, "PaymentMethodName": "sample string 7", "Amount": 8.1, "TransactionDateUtc": "2025-03-31T10:35:32.7536545+00:00" }, { "Id": "d27c9731-02d3-4d7d-985a-fa7aee076b1c", "OriginalPaymentId": {}, "DrawerId": "e38107c2-4eda-450d-b863-3d8351cb0f98", "Last4Digits": {}, "CustomerAccountId": {}, "PaymentMethodId": 6, "PaymentMethodName": "sample string 7", "Amount": 8.1, "TransactionDateUtc": "2025-03-31T10:35:32.7536545+00:00" } ], "Discounts": 1.1, "ChangeDue": 11.1, "CashBack": 12.1, "TaxCalculationResult": { "Id": "f348e164-a1d6-4874-8da1-1915222bdd17", "Lines": [ { "LineNumber": "sample string 1", "Taxable": 2, "Rate": 3, "Tax": 4.1, "ExemptAmount": 5, "Discount": 6.1, "TaxDetails": [ { "TaxId": "860a560d-93c0-4745-b785-5f6d66d9d518", "CountryCode": {}, "RegionCode": {}, "TaxType": "sample string 4", "TaxAuthority": {}, "TaxAuthorityType": "sample string 6", "Rate": 7.1, "Tax": 8.1, "Exemptions": {}, "Taxable": 10, "TaxName": "sample string 11", "Layer": 12 }, { "TaxId": "860a560d-93c0-4745-b785-5f6d66d9d518", "CountryCode": {}, "RegionCode": {}, "TaxType": "sample string 4", "TaxAuthority": {}, "TaxAuthorityType": "sample string 6", "Rate": 7.1, "Tax": 8.1, "Exemptions": {}, "Taxable": 10, "TaxName": "sample string 11", "Layer": 12 } ] }, { "LineNumber": "sample string 1", "Taxable": 2, "Rate": 3, "Tax": 4.1, "ExemptAmount": 5, "Discount": 6.1, "TaxDetails": [ { "TaxId": "860a560d-93c0-4745-b785-5f6d66d9d518", "CountryCode": {}, "RegionCode": {}, "TaxType": "sample string 4", "TaxAuthority": {}, "TaxAuthorityType": "sample string 6", "Rate": 7.1, "Tax": 8.1, "Exemptions": {}, "Taxable": 10, "TaxName": "sample string 11", "Layer": 12 }, { "TaxId": "860a560d-93c0-4745-b785-5f6d66d9d518", "CountryCode": {}, "RegionCode": {}, "TaxType": "sample string 4", "TaxAuthority": {}, "TaxAuthorityType": "sample string 6", "Rate": 7.1, "Tax": 8.1, "Exemptions": {}, "Taxable": 10, "TaxName": "sample string 11", "Layer": 12 } ] } ] }, "SaleOverrides": {}, "CreatedByUser": "sample string 14", "CreatedDateUtc": "2025-03-31T10:35:32.7536545+00:00" }