Gets invoice data
Endpoint:
GET v1/Invoice?invoiceId={invoiceId}&orderId={orderId}&startDate={startDate}&poNumber={poNumber}&invoiceStatus={invoiceStatus}
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
invoiceId |
Invoice Id |
integer |
None. |
orderId |
Order Id |
integer |
None. |
startDate |
Specifies the minimum invoice date for returned records |
date |
None. |
poNumber |
Po Number |
string |
None. |
invoiceStatus |
Invoice Status (Open, Closed) |
string |
None. |
Body Parameters
None.
Response Information
Collection of InvoiceHeadName | Description | Type | Additional information |
---|---|---|---|
InvoiceStatus | string |
None. |
|
InvoiceId | integer |
None. |
|
Total | decimal number |
None. |
|
Balance | decimal number |
None. |
|
OrderId | integer |
None. |
|
LineCount | integer |
None. |
|
PoNumber | string |
None. |
|
InvoiceDate | string |
None. |
|
DueDate | string |
None. |
|
ClosedDate | string |
None. |
|
InvoiceSuffix | string |
None. |
|
DiscountAmount | decimal number |
None. |
|
MiscTotal | decimal number |
None. |
|
TaxTotal | decimal number |
None. |
Response Examples
application/json, text/json :
[ { "InvoiceStatus": "sample string 1", "InvoiceId": 2, "Total": 4.0, "Balance": 6.0, "OrderId": 10, "LineCount": 11, "PoNumber": "sample string 12", "InvoiceDate": "9/7/2024", "DueDate": "9/7/2024", "ClosedDate": "9/7/2024", "InvoiceSuffix": "sample string 16", "DiscountAmount": 21.0, "MiscTotal": 22.0, "TaxTotal": 23.0 }, { "InvoiceStatus": "sample string 1", "InvoiceId": 2, "Total": 4.0, "Balance": 6.0, "OrderId": 10, "LineCount": 11, "PoNumber": "sample string 12", "InvoiceDate": "9/7/2024", "DueDate": "9/7/2024", "ClosedDate": "9/7/2024", "InvoiceSuffix": "sample string 16", "DiscountAmount": 21.0, "MiscTotal": 22.0, "TaxTotal": 23.0 } ]
text/javascript :
[{"InvoiceStatus":"sample string 1","InvoiceId":2,"Total":4.0,"Balance":6.0,"OrderId":10,"LineCount":11,"PoNumber":"sample string 12","InvoiceDate":"9/7/2024","DueDate":"9/7/2024","ClosedDate":"9/7/2024","InvoiceSuffix":"sample string 16","DiscountAmount":21.0,"MiscTotal":22.0,"TaxTotal":23.0},{"InvoiceStatus":"sample string 1","InvoiceId":2,"Total":4.0,"Balance":6.0,"OrderId":10,"LineCount":11,"PoNumber":"sample string 12","InvoiceDate":"9/7/2024","DueDate":"9/7/2024","ClosedDate":"9/7/2024","InvoiceSuffix":"sample string 16","DiscountAmount":21.0,"MiscTotal":22.0,"TaxTotal":23.0}]
application/xml, text/xml :
<ArrayOfInvoiceHead xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sunlight.Library.Models"> <InvoiceHead> <Balance>6</Balance> <ClosedDate>9/7/2024</ClosedDate> <DiscountAmount>21</DiscountAmount> <DueDate>9/7/2024</DueDate> <InvoiceDate>9/7/2024</InvoiceDate> <InvoiceId>2</InvoiceId> <InvoiceStatus>sample string 1</InvoiceStatus> <InvoiceSuffix>sample string 16</InvoiceSuffix> <LineCount>11</LineCount> <MiscTotal>22</MiscTotal> <OrderId>10</OrderId> <PoNumber>sample string 12</PoNumber> <TaxTotal>23</TaxTotal> <Total>4</Total> </InvoiceHead> <InvoiceHead> <Balance>6</Balance> <ClosedDate>9/7/2024</ClosedDate> <DiscountAmount>21</DiscountAmount> <DueDate>9/7/2024</DueDate> <InvoiceDate>9/7/2024</InvoiceDate> <InvoiceId>2</InvoiceId> <InvoiceStatus>sample string 1</InvoiceStatus> <InvoiceSuffix>sample string 16</InvoiceSuffix> <LineCount>11</LineCount> <MiscTotal>22</MiscTotal> <OrderId>10</OrderId> <PoNumber>sample string 12</PoNumber> <TaxTotal>23</TaxTotal> <Total>4</Total> </InvoiceHead> </ArrayOfInvoiceHead>
text/csv :
InvoiceStatus,InvoiceId,Total,Balance,OrderId,LineCount,PoNumber,InvoiceDate,DueDate,ClosedDate,InvoiceSuffix,DiscountAmount,MiscTotal,TaxTotal sample string 1,2,4,6,10,11,sample string 12,9/7/2024,9/7/2024,9/7/2024,sample string 16,21,22,23 sample string 1,2,4,6,10,11,sample string 12,9/7/2024,9/7/2024,9/7/2024,sample string 16,21,22,23
text/tsv :
InvoiceStatus InvoiceId Total Balance OrderId LineCount PoNumber InvoiceDate DueDate ClosedDate InvoiceSuffix DiscountAmount MiscTotal TaxTotal sample string 1 2 4 6 10 11 sample string 12 9/7/2024 9/7/2024 9/7/2024 sample string 16 21 22 23 sample string 1 2 4 6 10 11 sample string 12 9/7/2024 9/7/2024 9/7/2024 sample string 16 21 22 23