GET v1/Companies({CompanyId})/InvoiceSummaries?filter={filter}

Gets Invoice Summaries for a Company with Filtering

Information:

Base URL:

https://api.covasoft.net/invoice

Example of a call would be:

https://api.covasoft.net/invoice/v1/Companies({CompanyId})/InvoiceSummaries?$filter=ReceiptNumber eq '{ReceiptNumber}'

Odata Filters

PrintableId eq '{InvoiceNumber}'

ReceiptNumber eq '{ReceiptNumber}'

PrintableId eq '{PrintableId}'

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 GetInvoiceSummariesReturn

Name	Type	Additional information
Id	globally unique identifier	None.
PrintableId	string	None.
ReceiptNumber	string	None.
InvoiceTotal	decimal number	None.
CashBack	integer	None.
InvoiceType	string	None.
PaymentTypes	string	None.
CustomerId	globally unique identifier	None.
CustomerName	string	None.
LocationId	integer	None.
UserId	integer	None.
CreatedByUser	string	None.
CreatedDateUtc	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "92a0c58e-6edb-41d7-9af5-cff6f9d3d0b3",
    "PrintableId": "sample string 2",
    "ReceiptNumber": "sample string 3",
    "InvoiceTotal": 4.1,
    "CashBack": 5,
    "InvoiceType": "sample string 6",
    "PaymentTypes": "sample string 7",
    "CustomerId": "eb6268ce-c3ae-4b02-9f15-baa5243e6d0b",
    "CustomerName": "sample string 8",
    "LocationId": 9,
    "UserId": 10,
    "CreatedByUser": "sample string 11",
    "CreatedDateUtc": "2024-11-07T08:49:56.12707+00:00"
  },
  {
    "Id": "92a0c58e-6edb-41d7-9af5-cff6f9d3d0b3",
    "PrintableId": "sample string 2",
    "ReceiptNumber": "sample string 3",
    "InvoiceTotal": 4.1,
    "CashBack": 5,
    "InvoiceType": "sample string 6",
    "PaymentTypes": "sample string 7",
    "CustomerId": "eb6268ce-c3ae-4b02-9f15-baa5243e6d0b",
    "CustomerName": "sample string 8",
    "LocationId": 9,
    "UserId": 10,
    "CreatedByUser": "sample string 11",
    "CreatedDateUtc": "2024-11-07T08:49:56.12707+00:00"
  }
]