GET api/Invoices?StartDate={StartDate}&EndDate={EndDate}&OrderId={OrderId}&Page={Page}&Records={Records}

Retrieves invoice detail records by invoice date range, or by order with an optional invoice date range.

Request Information

URI Parameters

Name	Description	Type	Additional information
StartDate	Required invoice start date unless OrderId is supplied. Optional lower invoice date bound when OrderId is supplied.	date	None.
EndDate	Required invoice end date unless OrderId is supplied. Optional upper invoice date bound when OrderId is supplied.	date	None.
OrderId	Optional order id used to return invoice details associated with a single order.	integer	None.
Page	Optional page number to return. Defaults to 1.	integer	Default value is 1
Records	Optional number of records to display per page. Defaults to 250 and cannot exceed 10,000.	integer	Default value is 250

Body Parameters

None.

Response Information

Resource Description

InvoiceDetailsResponse

Name	Description	Type	Additional information
Summary	Summary information for the returned invoice detail page.	InvoiceDetailsSummary	None.
InvoiceDetails	Invoice detail records for the requested page.	Collection of InvoiceDetailData	None.

Response Formats

application/json, text/json

Sample:

{
  "Summary": {
    "Page": 1,
    "DisplayedRecords": 2,
    "TotalRecords": 3
  },
  "InvoiceDetails": [
    {
      "InvoiceDetailId": 1,
      "InvoiceId": 2,
      "InvoiceNumber": "sample string 3",
      "Invoiced": "2026-06-12T11:11:38.9878041+00:00",
      "ClientCode": "sample string 5",
      "WarehouseCode": "sample string 7",
      "ReceivingId": 1,
      "OrderId": 1,
      "ClientOrderId": "sample string 8",
      "ActivityDate": "2026-06-12T11:11:38.9878041+00:00",
      "Activity": "sample string 10",
      "Charge": "sample string 11",
      "Description": "sample string 12",
      "Quantity": 13.0,
      "ChargeAmount": 14.0
    },
    {
      "InvoiceDetailId": 1,
      "InvoiceId": 2,
      "InvoiceNumber": "sample string 3",
      "Invoiced": "2026-06-12T11:11:38.9878041+00:00",
      "ClientCode": "sample string 5",
      "WarehouseCode": "sample string 7",
      "ReceivingId": 1,
      "OrderId": 1,
      "ClientOrderId": "sample string 8",
      "ActivityDate": "2026-06-12T11:11:38.9878041+00:00",
      "Activity": "sample string 10",
      "Charge": "sample string 11",
      "Description": "sample string 12",
      "Quantity": 13.0,
      "ChargeAmount": 14.0
    }
  ]
}

application/xml, text/xml

Sample:

<InvoiceDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCAPI2.Controllers">
  <InvoiceDetails>
    <InvoiceDetailData>
      <Activity>sample string 10</Activity>
      <ActivityDate>2026-06-12T11:11:38.9878041+00:00</ActivityDate>
      <Charge>sample string 11</Charge>
      <ChargeAmount>14</ChargeAmount>
      <ClientCode>sample string 5</ClientCode>
      <ClientId>4</ClientId>
      <ClientOrderId>sample string 8</ClientOrderId>
      <Description>sample string 12</Description>
      <FulfillmentPricingId>1</FulfillmentPricingId>
      <InventoryUnitId>1</InventoryUnitId>
      <InvoiceDetailId>1</InvoiceDetailId>
      <InvoiceId>2</InvoiceId>
      <InvoiceNumber>sample string 3</InvoiceNumber>
      <Invoiced>2026-06-12T11:11:38.9878041+00:00</Invoiced>
      <OrderDetailId>1</OrderDetailId>
      <OrderId>1</OrderId>
      <ParcelChargeId>1</ParcelChargeId>
      <Quantity>13</Quantity>
      <ReceivingDetailId>1</ReceivingDetailId>
      <ReceivingId>1</ReceivingId>
      <WarehouseCode>sample string 7</WarehouseCode>
      <WarehouseId>6</WarehouseId>
    </InvoiceDetailData>
    <InvoiceDetailData>
      <Activity>sample string 10</Activity>
      <ActivityDate>2026-06-12T11:11:38.9878041+00:00</ActivityDate>
      <Charge>sample string 11</Charge>
      <ChargeAmount>14</ChargeAmount>
      <ClientCode>sample string 5</ClientCode>
      <ClientId>4</ClientId>
      <ClientOrderId>sample string 8</ClientOrderId>
      <Description>sample string 12</Description>
      <FulfillmentPricingId>1</FulfillmentPricingId>
      <InventoryUnitId>1</InventoryUnitId>
      <InvoiceDetailId>1</InvoiceDetailId>
      <InvoiceId>2</InvoiceId>
      <InvoiceNumber>sample string 3</InvoiceNumber>
      <Invoiced>2026-06-12T11:11:38.9878041+00:00</Invoiced>
      <OrderDetailId>1</OrderDetailId>
      <OrderId>1</OrderId>
      <ParcelChargeId>1</ParcelChargeId>
      <Quantity>13</Quantity>
      <ReceivingDetailId>1</ReceivingDetailId>
      <ReceivingId>1</ReceivingId>
      <WarehouseCode>sample string 7</WarehouseCode>
      <WarehouseId>6</WarehouseId>
    </InvoiceDetailData>
  </InvoiceDetails>
  <Summary>
    <DisplayedRecords>2</DisplayedRecords>
    <Page>1</Page>
    <TotalRecords>3</TotalRecords>
  </Summary>
</InvoiceDetailsResponse>