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

Returns Completed orders for a Company by Date Range Broken up by Products and by Customer

Information:

Base URL:

https://api.covasoft.net/posreports

Example of a call would be:

https://api.covasoft.net/posreports/v1/Companies({CompanyId})/ByProductByCustomerByInvoice?DateRange=Date ge datetime'2018-10-03T06:00:00.0000000Z' and Date le datetime'2018-11-03T06:00:00.0000000Z'

Odata Filters

Required: DateRange=Date ge datetime'{UTCdatetime}' and Date le datetime'{UTCdatetime}'

Normal Odata pagings with $top & $skip

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

Required

Body Parameters

None.

Response Information

Resource Description

Completed orders for a Company by Date Range Broken up by Products and by Customer

Collection of InvoicePollingByDataRangeforCustomerByProductReturn
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

CompanyId

integer

None.

LocationId

integer

None.

InvoiceId

globally unique identifier

None.

CustomerName

string

None.

MobileNumber

integer

None.

BillingCity

string

None.

BillingState

string

None.

BillingZip

string

None.

BillingCountry

string

None.

BillingStreetAddress

string

None.

Sku

string

None.

ProductName

string

None.

ItemsSold

decimal number

None.

CategoryName

string

None.

SoldAtPrice

decimal number

None.

InvoiceDateTimeUtc

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "caa1120e-e984-4ea9-ad0f-6ed109f91acb",
    "CompanyId": 2,
    "LocationId": 3,
    "InvoiceId": "010f55ce-6899-4939-b5fe-c67c4327a16c",
    "CustomerName": "sample string 5",
    "MobileNumber": 1,
    "BillingCity": "sample string 6",
    "BillingState": "sample string 7",
    "BillingZip": "sample string 8",
    "BillingCountry": "sample string 9",
    "BillingStreetAddress": "sample string 10",
    "Sku": "sample string 11",
    "ProductName": "sample string 12",
    "ItemsSold": 13.1,
    "CategoryName": "sample string 14",
    "SoldAtPrice": 15.1,
    "InvoiceDateTimeUtc": "2024-11-25T11:31:19.3884764+00:00"
  },
  {
    "Id": "caa1120e-e984-4ea9-ad0f-6ed109f91acb",
    "CompanyId": 2,
    "LocationId": 3,
    "InvoiceId": "010f55ce-6899-4939-b5fe-c67c4327a16c",
    "CustomerName": "sample string 5",
    "MobileNumber": 1,
    "BillingCity": "sample string 6",
    "BillingState": "sample string 7",
    "BillingZip": "sample string 8",
    "BillingCountry": "sample string 9",
    "BillingStreetAddress": "sample string 10",
    "Sku": "sample string 11",
    "ProductName": "sample string 12",
    "ItemsSold": 13.1,
    "CategoryName": "sample string 14",
    "SoldAtPrice": 15.1,
    "InvoiceDateTimeUtc": "2024-11-25T11:31:19.3884764+00:00"
  }
]