Invoices
This describes the invoice resource in the Provet Connect API.
List Invoices
Get a list of invoices from Provet Connect.
GET /invoices
| Parameter |
Type |
Required |
Description |
| DateFrom |
Date |
False |
The date to start the invoice list from |
| DateTo |
Date |
False |
The date to end the invoice list on |
| UpdatedAfter |
DateTime |
False |
The result is limited to only those invoices’s that have had their associated data updated after the supplied DateTime.
Specified in UTC ISO 8601 standard.
Example: UpdatedAfter=2015-07-17T06:00:00+10:00
Note you may need to encode the date for correct URL parsing (eg: 2015-07-17T06:00:00%2B10:00)
|
Response
Returns as array of InvoiceSummary resources.
| Name |
Type |
Description |
| InvoiceNumber |
Integer |
The Provet invoice number |
| OrderId |
Integer |
The Provet Electronic Order Id. This is a unique reference allocated to all orders received electronically. |
| Date |
Date |
|
| PurchaseOrderNumber |
String |
The purchase order number of the order |
| Total |
Decimal |
|
| AccountCode |
String |
The Provet account code for the Invoice |
Get Invoice
Get an invoice from Provet Connect.
GET /invoices/{InvoiceNumber}
| Parameter |
Type |
Required |
Description |
| InvoiceNumber |
Integer |
True |
The Provet invoice number |
Response
The Invoice returned in the response
| Name |
Type |
Description |
| InvoiceNumber |
Integer |
The Provet invoice number |
| OrderId |
Integer |
The Provet Electronic Order Id. This is a unique reference allocated to all orders received electronically. |
| PurchaseOrderNumber |
String |
The purchase order number of the order |
| AccountCode |
String |
The Provet account code |
| Date |
Date |
|
| Notes |
String |
|
| Shipping |
Shipping |
|
| PaymentDue |
Date |
|
| Freight |
Decimal |
|
| Tax |
Decimal |
|
| Total |
Array of InvoiceLine |
|
InvoiceLine
| Name |
Type |
Description |
| ProductCode |
String |
The Provet product code |
| Description |
String |
|
| QuantityOrdered |
Integer |
The quantity ordered from the order |
| QuantityShipped |
Integer |
The quantity shipped with this invoice |
| PurchaseOrderNumber |
String |
The purchase order number of the order |
| Price |
Decimal |
|
| ListPrice |
Decimal |
|
| RRP |
Decimal |
|
| Tax |
Decimal |
|
| Batch |
String |
Not currently populated |
| Expiry |
Date |
Not currently populated |
| MiscellaneousItem |
Boolean |
Denotes if the product is a miscellaneous or one off item that is not normally stocked nor is orderable |
Shipping
| Name |
Type |
Description |
| Name |
String |
|
| Address |
Address |
|
| Carrier |
String |
The carrier name |
| TrackingId |
String |
The Tracking Id |
Address
| Name |
Type |
Description |
| AddressLine1 |
String |
|
| AddressLine2 |
String |
|
| Suburb |
String |
|
| State |
String |
|
| Postcode |
Integer |
|
| Country |
String |
|