This GET method allows you to retrieve a list of purchase transactions (invoices) from your administration. You can also retreive the details of a single purchase using the InvoiceNumber request parameter.
Notes:
- Maximum 100 invoices will be returned per request
- You can retrieve more invoices by doing multiple requests and using the offset parameter
- The returned invoices will be sorted by date (descending)
- Request
- Response
Parameters
InvoiceNumber
Integer
Details
Optional parameter. Use this to retreive the details of a single purchase transaction.
Limit
Integer
Details
Define an optional limit for the retrieve. Defaults to 100 which is also the maximum.
Offset
Integer
Details
Define an optional offset for the retrieve.
DateFrom
Date String (dd-MM-yyyy)
Details
The invoice from date filter in format dd-MM-yyyy. (http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html). Default to no from date filter.
DateTill
Date String (dd-MM-yyyy)
Details
The invoice till date filter in format dd-MM-yyyy. (http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html). Default to no from date filter.
CURL Example
1 |
curl -X GET -H "Content-Type: application/json" -H "ApiKey: b7d343Bnhd436f3ec3bd3504582" -H "Username: [email protected]" "https://rest-api.silvasoft.nl/rest/listpurchasetransactions/" |
Parameters
SupplierNumber
Integer
More info
The suppliernumber of the relation associated with this invoice.
SupplierName
String
More info
The suppliername of the relation associated with this invoice.
InvoiceNumberSilvasoft
Integer
More info
The internal invoice number (booking number). This is an incremental autonumber.
InvoiceNumber
String
More info
The supplier invoice number. This is a free-format number (can be a string as well).
InvoiceNotes
String
More info
Notes added to the invoice
InvoiceDate
String Date (dd-MM-yyyy)
More info
The invoice date in format dd-MM-yyyy. (http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html) Defaults to current date.
InvoiceTotalExclTax
Float
More info
The total invoice amount excluding taxes
InvoiceTotalInclTax
Float
More info
The total invoice amount including taxes
InvoiceTaxAmount
Float
More info
The total VAT amount
InvoiceOutstandingAmount
Float
More info
The outstanding amount for this purchase transaction (amount still to be payed)
InvoiceDueDate
String Date (dd-MM-yyyy)
More info
The invoice due date in format dd-MM-yyyy. (http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html) Defaults to current date.
ProjectName
String
More info
If the invoice is associated with a project, the project name will be returned
ProjectNumber
String
More info
If the invoice is associated with a project, the project number will be returned
PurchaseInvoice_Contact
Array
More info
This contains a JSON array of contacts associated with the supplier. At the moment this will return only the main contact of the supplier.
PurchaseInvoice_Contact > ContactType
String
More info
Will always return "Invoice"
PurchaseInvoice_Contact > FirstName
String
More info
PurchaseInvoice_Contact > Phone
String
More info
PurchaseInvoice_Contact > Email
String
More info
PurchaseInvoice_Contact > Sex
String
More info
Contact sex (Man|Vrouw)
PurchaseInvoice_Contact > LastName
String
More info
PurchaseInvoice_Contact > ContactNotes
String
More info
PurchaseInvoice_Contact > DefaultContact
Boolean (true|false)
More info
PurchaseInvoice_Address
String
More info
A JSON array of customer addresses. At the moment this will never contain more then one address, which is the default address for the supplier.
PurchaseInvoice_Address > Address_CountryCode
String
More info
ISO 3166 (A2) country code of the order address
PurchaseInvoice_Address > Address_PostalCode
String
More info
Postal / zip code
PurchaseInvoice_Address > Address_Street
String
More info
PurchaseInvoice_Address > Address_Unit
String
More info
PurchaseInvoice_Address > Address_City
String
More info
PurchaseInvoice_Address > Address_UnitAppendix
String
More info
Appendix (e.g. appartment/suite/floor) for the address unit
PurchaseInvoice_Address > AddressType
String
More info
At the moment this will always return "InvoiceAddress"
Response JSON Example
The response order can vary from the parameter order above
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
[ { "InvoiceOutstandingAmount": 150.45, "InvoiceNotes": "Purchase invoice Google Ads", "ProjectName": "", "ProjectNumber": "", "InvoiceTotalInclTax": 371.47, "PurchaseInvoice_Address": [ { "Address_CountryCode": "NL", "Address_Unit": "", "Address_City": "Amsterdam", "Address_UnitAppendix": "", "AddressType": "InvoiceAddress", "Address_PostalCode": "5555CC", "Address_Street": "Amsterdamstreet 4" }], "PurchaseInvoice_Contact": [ { "Preposition": null, "ContactType": "Invoice", "ContactNotes": null, "FamilyName": null, "FirstName": "Jeremy", "Phone": "0505121212", "Sex": "Man", "LastName": "Doe", "DefaultContact": true }], "SupplierNumber": 454545, "InvoiceTaxAmount": 64.47, "InvoiceDueDate": "23-11-2019", "SupplierName": "Google Ads", "InvoiceNumber": "ads-123123", "InvoiceDate": "16-05-2019", "InvoiceTotalExclTax": 307 } ] |