GET api/InvoiceListByPro?User={User}&Pass={Pass}&ProNumber={ProNumber}
Use this function to retrieve the invoice reference associated with a specific pro number.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| User |
Enter the Logon Code assigned to your account (1-8 characters) |
string |
Required |
| Pass |
Enter the Password associated with your Logon Code |
string |
Required |
| ProNumber |
Enter a valid Pro Number (value between 1 and 2147483647) |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
an XML or JSON list of invoice numbers associated with the pro number provided.
InvoiceList| Name | Description | Type | Additional information |
|---|---|---|---|
| ErrorInfo |
This field will be empty (blank) if the API Request was processed with no errors. A non-blank response will describe the issue(s) encountered in processing the request. |
string |
None. |
| Comment |
Additional supporting information for this list |
string |
None. |
| InvoicePickList |
Represents the list of pros associated with the invoice |
Collection of ProToInvoice |
None. |
Response Formats
application/json, text/json
Sample:
{
"ErrorInfo": "sample string 1",
"Comment": "sample string 2",
"InvoicePickList": [
{
"ProNumber": "sample string 1",
"InvoiceNumber": "sample string 2"
},
{
"ProNumber": "sample string 1",
"InvoiceNumber": "sample string 2"
}
]
}
application/xml, text/xml
Sample:
<InvoiceList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DUBLAPI">
<Comment>sample string 2</Comment>
<ErrorInfo>sample string 1</ErrorInfo>
<InvoicePickList>
<ProToInvoice>
<InvoiceNumber>sample string 2</InvoiceNumber>
<ProNumber>sample string 1</ProNumber>
</ProToInvoice>
<ProToInvoice>
<InvoiceNumber>sample string 2</InvoiceNumber>
<ProNumber>sample string 1</ProNumber>
</ProToInvoice>
</InvoicePickList>
</InvoiceList>