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

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "63990c0a-2703-4fcb-aca8-ab5aa6e9d3af",
    "PrintableId": "sample string 2",
    "ReceiptNumber": "sample string 3",
    "InvoiceTotal": 4.1,
    "CashBack": 5,
    "InvoiceType": "sample string 6",
    "PaymentTypes": "sample string 7",
    "CustomerId": "c5324a9a-ee79-480b-8711-b2fd47b60acd",
    "CustomerName": "sample string 8",
    "LocationId": 9,
    "UserId": 10,
    "CreatedByUser": "sample string 11",
    "CreatedDateUtc": "2024-11-25T11:24:48.2223774+00:00"
  },
  {
    "Id": "63990c0a-2703-4fcb-aca8-ab5aa6e9d3af",
    "PrintableId": "sample string 2",
    "ReceiptNumber": "sample string 3",
    "InvoiceTotal": 4.1,
    "CashBack": 5,
    "InvoiceType": "sample string 6",
    "PaymentTypes": "sample string 7",
    "CustomerId": "c5324a9a-ee79-480b-8711-b2fd47b60acd",
    "CustomerName": "sample string 8",
    "LocationId": 9,
    "UserId": 10,
    "CreatedByUser": "sample string 11",
    "CreatedDateUtc": "2024-11-25T11:24:48.2223774+00:00"
  }
]