GET Companies({CompanyId})/SalesInvoiceSummaries?filter={filter}
Returns Invoice Summaries for a Company with Filtering
Information:
Base URL:
https://api.covasoft.net/pointofsale
Example of a call would be:
https://api.covasoft.net/pointofsale/Companies({CompanyId})/SalesInvoiceSummaries?$filter=CustomerId eq guid'{CustomerId}'
Odata Filters
CustomerId eq guid'{CustomerId}'
PrintableId eq '{InvoiceNumber}'
ReceiptNumber eq '{ReceiptNumber}'
LocationId eq {LocationId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
CompanyId |
The unique Company Id that was provided in your onboarding pacakage. |
integer |
Required |
filter |
The Odata filter applied to this call, see Odata filter section above |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Invoice Summaries for a Company with Filtering
Collection of GetSalesInvoiceSummariesReturnName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
PrintableId | string |
None. |
|
ReceiptNumber | string |
None. |
|
InvoiceTotal | decimal number |
None. |
|
InvoiceType | string |
None. |
|
PaymentTypes | string |
None. |
|
CustomerId | globally unique identifier |
None. |
|
CustomerName | string |
None. |
|
LocationId | integer |
None. |
|
LocationName | string |
None. |
|
UserId | integer |
None. |
|
CreatedByUser | string |
None. |
|
CreatedDateUtc | date |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": "be5a9007-5777-4de6-9917-b10a68ce79e1", "PrintableId": "sample string 2", "ReceiptNumber": "sample string 3", "InvoiceTotal": 4.1, "InvoiceType": "sample string 5", "PaymentTypes": "sample string 6", "CustomerId": "9676be17-7a89-449d-83df-1d424548e15d", "CustomerName": "sample string 7", "LocationId": 8, "LocationName": "sample string 9", "UserId": 10, "CreatedByUser": "sample string 11", "CreatedDateUtc": "2024-11-25T11:51:37.6354306+00:00" }, { "Id": "be5a9007-5777-4de6-9917-b10a68ce79e1", "PrintableId": "sample string 2", "ReceiptNumber": "sample string 3", "InvoiceTotal": 4.1, "InvoiceType": "sample string 5", "PaymentTypes": "sample string 6", "CustomerId": "9676be17-7a89-449d-83df-1d424548e15d", "CustomerName": "sample string 7", "LocationId": 8, "LocationName": "sample string 9", "UserId": 10, "CreatedByUser": "sample string 11", "CreatedDateUtc": "2024-11-25T11:51:37.6354306+00:00" } ]