GET api/Invoice/{invoiceRefNumber}
Returns a summarized view of the specified invoice
Request Information
URI Parameters
Name | Type | Description | Additional information |
---|---|---|---|
invoiceRefNumber | string |
Invoice number to return |
Required |
Body Parameters
None
Response Information
Resource Description
Summarized view of the specified invoice
InvoiceResponseName | Type | Description | Additional information |
---|---|---|---|
IsSuccessful | boolean |
|
|
Message | string |
|
|
InvoiceRefNumber | string |
|
|
InvoiceParentRefNumber | string |
|
|
BusinessUnit | string |
|
|
ClientDisplayName | string |
|
|
InvoiceFriendlyStatus | string |
|
|
Terms | string |
|
|
StartDate | date |
|
|
EndDate | date |
|
|
DueDate | date |
|
|
IssuedDate | date |
|
|
ProcessPeriodType | string |
|
|
TotalInvoicedAmount | decimal number |
|
|
TotalAverageAmount | decimal number |
|
|
TotalPublishedAmount | decimal number |
|
|
TotalInvoiceLinesCount | integer |
|
|
TotalDiscountAmount | decimal number |
|
|
InvoiceAmountOwed | decimal number |
|
|
Summaries | Collection of InvoiceSummaryResponse |
|
|
Averages | Collection of InvoiceTotalAveragesResponse |
|
Response Formats
application/json, text/json
Sample:
{ "IsSuccessful": true, "Message": "sample string 2", "InvoiceRefNumber": "sample string 3", "InvoiceParentRefNumber": "sample string 4", "BusinessUnit": "sample string 5", "ClientDisplayName": "sample string 6", "InvoiceFriendlyStatus": "sample string 7", "Terms": "sample string 8", "StartDate": "2025-01-18T04:56:30.0326304+00:00", "EndDate": "2025-01-18T04:56:30.0326304+00:00", "DueDate": "2025-01-18T04:56:30.0326304+00:00", "IssuedDate": "2025-01-18T04:56:30.0326304+00:00", "ProcessPeriodType": "sample string 9", "TotalInvoicedAmount": 10.0, "TotalAverageAmount": 11.0, "TotalPublishedAmount": 12.0, "TotalInvoiceLinesCount": 13, "TotalDiscountAmount": 14.0, "InvoiceAmountOwed": 15.0, "Summaries": [ { "ChargeTypeDisplay": "sample string 4 - sample string 3 - sample string 6", "BillingEventType": "sample string 1", "Carrier": "sample string 2", "Category": "sample string 3", "ChargeType": "sample string 4", "ServiceType": "sample string 5", "SubCategory": "sample string 6", "WarehouseLocation": "sample string 7", "TotalPublishedAmount": 8.0, "TotalDiscountAmount": 9.0, "TotalInvoicedAmount": 10.0 }, { "ChargeTypeDisplay": "sample string 4 - sample string 3 - sample string 6", "BillingEventType": "sample string 1", "Carrier": "sample string 2", "Category": "sample string 3", "ChargeType": "sample string 4", "ServiceType": "sample string 5", "SubCategory": "sample string 6", "WarehouseLocation": "sample string 7", "TotalPublishedAmount": 8.0, "TotalDiscountAmount": 9.0, "TotalInvoicedAmount": 10.0 } ], "Averages": [ { "HeaderOne": "sample string 1", "HeaderTwo": "sample string 2", "HeaderThree": "sample string 3", "Quantity": 4, "Average": 5.0 }, { "HeaderOne": "sample string 1", "HeaderTwo": "sample string 2", "HeaderThree": "sample string 3", "Quantity": 4, "Average": 5.0 } ] }
application/xml, text/xml
Sample:
<InvoiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <IsSuccessful>true</IsSuccessful> <Message>sample string 2</Message> <InvoiceRefNumber>sample string 3</InvoiceRefNumber> <InvoiceParentRefNumber>sample string 4</InvoiceParentRefNumber> <BusinessUnit>sample string 5</BusinessUnit> <ClientDisplayName>sample string 6</ClientDisplayName> <InvoiceFriendlyStatus>sample string 7</InvoiceFriendlyStatus> <Terms>sample string 8</Terms> <StartDate>2025-01-18T04:56:30.0326304+00:00</StartDate> <EndDate>2025-01-18T04:56:30.0326304+00:00</EndDate> <DueDate>2025-01-18T04:56:30.0326304+00:00</DueDate> <IssuedDate>2025-01-18T04:56:30.0326304+00:00</IssuedDate> <ProcessPeriodType>sample string 9</ProcessPeriodType> <TotalInvoicedAmount>10</TotalInvoicedAmount> <TotalAverageAmount>11</TotalAverageAmount> <TotalPublishedAmount>12</TotalPublishedAmount> <TotalInvoiceLinesCount>13</TotalInvoiceLinesCount> <TotalDiscountAmount>14</TotalDiscountAmount> <InvoiceAmountOwed>15</InvoiceAmountOwed> <InvoiceSummaries> <InvoiceSummaryResponse> <BillingEventType>sample string 1</BillingEventType> <Carrier>sample string 2</Carrier> <Category>sample string 3</Category> <ChargeType>sample string 4</ChargeType> <ServiceType>sample string 5</ServiceType> <SubCategory>sample string 6</SubCategory> <WarehouseLocation>sample string 7</WarehouseLocation> <TotalPublishedAmount>8</TotalPublishedAmount> <TotalDiscountAmount>9</TotalDiscountAmount> <TotalInvoicedAmount>10</TotalInvoicedAmount> </InvoiceSummaryResponse> <InvoiceSummaryResponse> <BillingEventType>sample string 1</BillingEventType> <Carrier>sample string 2</Carrier> <Category>sample string 3</Category> <ChargeType>sample string 4</ChargeType> <ServiceType>sample string 5</ServiceType> <SubCategory>sample string 6</SubCategory> <WarehouseLocation>sample string 7</WarehouseLocation> <TotalPublishedAmount>8</TotalPublishedAmount> <TotalDiscountAmount>9</TotalDiscountAmount> <TotalInvoicedAmount>10</TotalInvoicedAmount> </InvoiceSummaryResponse> </InvoiceSummaries> <InvoiceTotalAverages> <InvoiceTotalAveragesResponse> <HeaderOne>sample string 1</HeaderOne> <HeaderTwo>sample string 2</HeaderTwo> <HeaderThree>sample string 3</HeaderThree> <Quantity>4</Quantity> <Average>5</Average> </InvoiceTotalAveragesResponse> <InvoiceTotalAveragesResponse> <HeaderOne>sample string 1</HeaderOne> <HeaderTwo>sample string 2</HeaderTwo> <HeaderThree>sample string 3</HeaderThree> <Quantity>4</Quantity> <Average>5</Average> </InvoiceTotalAveragesResponse> </InvoiceTotalAverages> </InvoiceResponse>