GET v1/Companies({CompanyId})/Entities({LocationId})/ByInvoiceWithProducts?filter={filter}

Returns Completed orders for a Company by Date Range with Filtering

Information:

Base URL:

https://api.covasoft.net/posreports

Example of a call would be:

https://api.covasoft.net/posreports/v1/Companies({CompanyId})/Entities({LocationId})/ByInvoiceWithProducts?DateRange=Date ge datetime'2019-08-27T00:00:00.0000000Z' and Date le datetime'2019-08-28T06: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

Name	Description	Type	Additional information
CompanyId	The unique Company Id that was provided in your onboarding pacakage.	integer	Required
LocationId	This is Location Id where you want to get the Completed Sales Orders	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 with Filtering

Collection of InvoicePollingByDataRangeReturn

Name	Type	Additional information
Id	globally unique identifier	None.
CompanyId	integer	None.
SoldAtEntityId	integer	None.
SoldAtEntityName	string	None.
PrintableId	string	None.
ReceiptNumber	string	None.
SoldByEmployeeId	integer	None.
SoldByEmployeeName	string	None.
CustomerId	globally unique identifier	None.
CustomerName	string	None.
Medical	string	None.
MedicalRecommendationNumber	string	None.
DriverLicenseNumber	string	None.
CustomerState	string	None.
CustomerDateOfBirth	date	None.
CustomerMobileNumber	string	None.
CreatedDateUtc	date	None.
Type	string	None.
Delivery	string	None.
ChangeDue	decimal number	None.
CashBack	decimal number	None.
Taxes	Collection of InvoiceTax	None.
Payments	Collection of InvoicePollingPayment	None.
PostTaxDiscounts	Collection of Object	None.
Products	Collection of InvoiceProduct	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "8020fa07-ecb1-49c8-9011-15eaf8a68762",
    "CompanyId": 2,
    "SoldAtEntityId": 3,
    "SoldAtEntityName": "sample string 4",
    "PrintableId": "sample string 5",
    "ReceiptNumber": "sample string 6",
    "SoldByEmployeeId": 7,
    "SoldByEmployeeName": "sample string 8",
    "CustomerId": "bccd6214-a3ee-4980-9770-7f16b8a5dddf",
    "CustomerName": "sample string 9",
    "Medical": "sample string 10",
    "MedicalRecommendationNumber": "sample string 11",
    "DriverLicenseNumber": "sample string 12",
    "CustomerState": "sample string 13",
    "CustomerDateOfBirth": "2024-11-07T08:43:25.6746958+00:00",
    "CustomerMobileNumber": "sample string 14",
    "CreatedDateUtc": "2024-11-07T08:43:25.6746958+00:00",
    "Type": "sample string 16",
    "Delivery": "sample string 17",
    "ChangeDue": 18.1,
    "CashBack": 19.1,
    "Taxes": [
      {
        "TaxId": "2f39b748-c69c-46af-95ef-296b781de927",
        "TaxAuthorityType": {},
        "Amount": 3.1,
        "Name": "sample string 4"
      },
      {
        "TaxId": "2f39b748-c69c-46af-95ef-296b781de927",
        "TaxAuthorityType": {},
        "Amount": 3.1,
        "Name": "sample string 4"
      }
    ],
    "Payments": [
      {
        "Id": 1,
        "Amount": 2.1,
        "Name": "sample string 3"
      },
      {
        "Id": 1,
        "Amount": 2.1,
        "Name": "sample string 3"
      }
    ],
    "PostTaxDiscounts": [
      {},
      {}
    ],
    "Products": [
      {
        "CatalogItemId": "c5ea4790-73fc-42ca-8c2e-b50551069dcf",
        "ProductName": "sample string 2",
        "SerialNumber": 3,
        "Quantity": 4,
        "ListPrice": 5.1,
        "SalePrice": {},
        "SoldAtPrice": 7.1,
        "UnitCost": 8.1,
        "UnitOfMeasureType": "sample string 9",
        "Manufacturer": "sample string 10",
        "Classification": "sample string 11",
        "SourceLicenseNumber": 1,
        "NetWeightAmount": 1.1,
        "NetWeightUnit": "sample string 12",
        "DisplayedCategoryPath": "sample string 13",
        "LotNumber": "sample string 14",
        "ThcContent": 1.1,
        "CbdContent": 1.1,
        "Brand": {},
        "Sku": "sample string 16"
      },
      {
        "CatalogItemId": "c5ea4790-73fc-42ca-8c2e-b50551069dcf",
        "ProductName": "sample string 2",
        "SerialNumber": 3,
        "Quantity": 4,
        "ListPrice": 5.1,
        "SalePrice": {},
        "SoldAtPrice": 7.1,
        "UnitCost": 8.1,
        "UnitOfMeasureType": "sample string 9",
        "Manufacturer": "sample string 10",
        "Classification": "sample string 11",
        "SourceLicenseNumber": 1,
        "NetWeightAmount": 1.1,
        "NetWeightUnit": "sample string 12",
        "DisplayedCategoryPath": "sample string 13",
        "LotNumber": "sample string 14",
        "ThcContent": 1.1,
        "CbdContent": 1.1,
        "Brand": {},
        "Sku": "sample string 16"
      }
    ]
  },
  {
    "Id": "8020fa07-ecb1-49c8-9011-15eaf8a68762",
    "CompanyId": 2,
    "SoldAtEntityId": 3,
    "SoldAtEntityName": "sample string 4",
    "PrintableId": "sample string 5",
    "ReceiptNumber": "sample string 6",
    "SoldByEmployeeId": 7,
    "SoldByEmployeeName": "sample string 8",
    "CustomerId": "bccd6214-a3ee-4980-9770-7f16b8a5dddf",
    "CustomerName": "sample string 9",
    "Medical": "sample string 10",
    "MedicalRecommendationNumber": "sample string 11",
    "DriverLicenseNumber": "sample string 12",
    "CustomerState": "sample string 13",
    "CustomerDateOfBirth": "2024-11-07T08:43:25.6746958+00:00",
    "CustomerMobileNumber": "sample string 14",
    "CreatedDateUtc": "2024-11-07T08:43:25.6746958+00:00",
    "Type": "sample string 16",
    "Delivery": "sample string 17",
    "ChangeDue": 18.1,
    "CashBack": 19.1,
    "Taxes": [
      {
        "TaxId": "2f39b748-c69c-46af-95ef-296b781de927",
        "TaxAuthorityType": {},
        "Amount": 3.1,
        "Name": "sample string 4"
      },
      {
        "TaxId": "2f39b748-c69c-46af-95ef-296b781de927",
        "TaxAuthorityType": {},
        "Amount": 3.1,
        "Name": "sample string 4"
      }
    ],
    "Payments": [
      {
        "Id": 1,
        "Amount": 2.1,
        "Name": "sample string 3"
      },
      {
        "Id": 1,
        "Amount": 2.1,
        "Name": "sample string 3"
      }
    ],
    "PostTaxDiscounts": [
      {},
      {}
    ],
    "Products": [
      {
        "CatalogItemId": "c5ea4790-73fc-42ca-8c2e-b50551069dcf",
        "ProductName": "sample string 2",
        "SerialNumber": 3,
        "Quantity": 4,
        "ListPrice": 5.1,
        "SalePrice": {},
        "SoldAtPrice": 7.1,
        "UnitCost": 8.1,
        "UnitOfMeasureType": "sample string 9",
        "Manufacturer": "sample string 10",
        "Classification": "sample string 11",
        "SourceLicenseNumber": 1,
        "NetWeightAmount": 1.1,
        "NetWeightUnit": "sample string 12",
        "DisplayedCategoryPath": "sample string 13",
        "LotNumber": "sample string 14",
        "ThcContent": 1.1,
        "CbdContent": 1.1,
        "Brand": {},
        "Sku": "sample string 16"
      },
      {
        "CatalogItemId": "c5ea4790-73fc-42ca-8c2e-b50551069dcf",
        "ProductName": "sample string 2",
        "SerialNumber": 3,
        "Quantity": 4,
        "ListPrice": 5.1,
        "SalePrice": {},
        "SoldAtPrice": 7.1,
        "UnitCost": 8.1,
        "UnitOfMeasureType": "sample string 9",
        "Manufacturer": "sample string 10",
        "Classification": "sample string 11",
        "SourceLicenseNumber": 1,
        "NetWeightAmount": 1.1,
        "NetWeightUnit": "sample string 12",
        "DisplayedCategoryPath": "sample string 13",
        "LotNumber": "sample string 14",
        "ThcContent": 1.1,
        "CbdContent": 1.1,
        "Brand": {},
        "Sku": "sample string 16"
      }
    ]
  }
]