GET api/Invoice/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

InvoiceData
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

StopId

globally unique identifier

Required

BillToCustomerId

globally unique identifier

None.

RadiusInvoiceNumber

string

Required

ClientInvoiceNumber

string

None.

SalesTerritoryId

globally unique identifier

None.

InvoiceType

integer

Required

Status

integer

Required

CurrentBalance

decimal number

Required

TotalAmount

decimal number

Required

BalanceOverdue

decimal number

Required

TxnDate

date

None.

DueDate

date

None.

ConfirmationDate

date

None.

TrackingNumber

string

None.

PONumber

string

None.

Identifier

string

None.

SalesOrderIdentifier

string

None.

Updated

date

None.

DriverTerritoryId

globally unique identifier

None.

ShipMethodId

string

None.

IsDeleted

integer

None.

RepNotes

string

None.

ProcessNotes

string

None.

ShipDate

date

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "c6062b4f-c936-4027-971b-bf2d2fcd6306",
  "StopId": "03173bbb-2a9e-46b4-87b2-845c61499af4",
  "BillToCustomerId": "ca3e06b0-aa66-4015-9eff-b49bd755d2f1",
  "RadiusInvoiceNumber": "sample string 2",
  "ClientInvoiceNumber": "sample string 3",
  "SalesTerritoryId": "32d23fb9-3966-4c58-a411-f998ab96d22b",
  "InvoiceType": 4,
  "Status": 5,
  "CurrentBalance": 6.0,
  "TotalAmount": 7.0,
  "BalanceOverdue": 8.0,
  "TxnDate": "2025-10-26T02:46:50.0882556-04:00",
  "DueDate": "2025-10-26T02:46:50.0882556-04:00",
  "ConfirmationDate": "2025-10-26T02:46:50.0882556-04:00",
  "TrackingNumber": "sample string 9",
  "PONumber": "sample string 10",
  "Identifier": "sample string 11",
  "SalesOrderIdentifier": "sample string 12",
  "Updated": "2025-10-26T02:46:50.0882556-04:00",
  "DriverTerritoryId": "65352772-9736-4995-ab25-c1ae4fee7001",
  "ShipMethodId": "sample string 13",
  "IsDeleted": 1,
  "RepNotes": "sample string 14",
  "ProcessNotes": "sample string 15",
  "ShipDate": "2025-10-26T02:46:50.0882556-04:00"
}

application/xml, text/xml

Sample:
<InvoiceData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IosWebApi.Models">
  <BalanceOverdue>8</BalanceOverdue>
  <BillToCustomerId>ca3e06b0-aa66-4015-9eff-b49bd755d2f1</BillToCustomerId>
  <ClientInvoiceNumber>sample string 3</ClientInvoiceNumber>
  <ConfirmationDate>2025-10-26T02:46:50.0882556-04:00</ConfirmationDate>
  <CurrentBalance>6</CurrentBalance>
  <DriverTerritoryId>65352772-9736-4995-ab25-c1ae4fee7001</DriverTerritoryId>
  <DueDate>2025-10-26T02:46:50.0882556-04:00</DueDate>
  <Id>c6062b4f-c936-4027-971b-bf2d2fcd6306</Id>
  <Identifier>sample string 11</Identifier>
  <InvoiceType>4</InvoiceType>
  <IsDeleted>1</IsDeleted>
  <PONumber>sample string 10</PONumber>
  <ProcessNotes>sample string 15</ProcessNotes>
  <RadiusInvoiceNumber>sample string 2</RadiusInvoiceNumber>
  <RepNotes>sample string 14</RepNotes>
  <SalesOrderIdentifier>sample string 12</SalesOrderIdentifier>
  <SalesTerritoryId>32d23fb9-3966-4c58-a411-f998ab96d22b</SalesTerritoryId>
  <ShipDate>2025-10-26T02:46:50.0882556-04:00</ShipDate>
  <ShipMethodId>sample string 13</ShipMethodId>
  <Status>5</Status>
  <StopId>03173bbb-2a9e-46b4-87b2-845c61499af4</StopId>
  <TotalAmount>7</TotalAmount>
  <TrackingNumber>sample string 9</TrackingNumber>
  <TxnDate>2025-10-26T02:46:50.0882556-04:00</TxnDate>
  <Updated>2025-10-26T02:46:50.0882556-04:00</Updated>
</InvoiceData>