Service
https://api.timewax.com/invoicing/list/
Goal
Requesting invoice lines for the new invoicing module.
Request
The following xml structure must be provided:
<request>
<token></token>
<dateFrom></dateFrom>
<dateTo></dateTo>
<project></project>
<client></client>
</request>
Parameter | Description | Required |
---|---|---|
token | Token for this request | yes |
dateFrom | Starting date. Format: yyyy-mm-dd. | yes |
dateTo | Date to. Format: yyyy-mm-dd. | yes |
project | Code or name. | no |
client | Code or name | no |
The following xml structure is received after an successful execution:
<response>
<valid>true</valid>
<invoices>
<invoice>
<id></id>
<period></period>
<date></date>
<rawDate></rawDate>
<number></number>
<creditNote></creditNote>
<amountInclVat></amountInclVat>
<clientCode></clientCode>
<clientName></clientName>
<projectCode></projectCode>
<projectName></projectName>
<currencyCode></currencyCode>
<invoiceReference1 - 5></invoiceReference1 - 5>
<debtorName></debtorName>
<debtorAttn></debtorAttn>
<debtorPostcode></debtorPostcode>
<debtorCity></debtorCity>
<debtorCountry></debtorCountry>
<debtorNumber></debtorNumber>
<debtorEmail></debtorEmail>
<Lines>
<description></description>
<amountExclVat></amountExclVat>
<vatCode></vatCode>
<vatAmount></vatAmount>
<amountInclVat></amountInclVat>
<items>
<item>
<date></date>
<rawDate></rawDate>
<resourceCode></resourceCode>
<resourceName></resourceName>
<breakdownCode></breakdownCode>
<breakdownName></breakdownName>
<hours></hours>
<rate></rate>
<amount></amount>
<description></description>
<km></km>
</item>
</items>
</line>
</lines>
</invoice>
</invoices>
</response>
Code and name. Can be blanc depending on invoice lay-out settings
Parameter | Description |
---|---|
valid | Indication that service was executed successfully |
period | Invoice period |
date | Invoice date, format: dd-mm-yyyy |
rawDate | Invoice date format: yyyy-mm-dd |
number | Invoice number |
creditNote | Yes or No |
amountInclVat | Total amount |
clientCode | Code client |
clientName | Name client |
projectCode | Code project |
projectName | Name project |
currencyCode | Currency code |
invoiceReference1 - 5 | InvoiceReference 1 to 5 |
debtorName | Debtor name |
debtorAttn | Debtor attention |
debtorPostcode | Debtor postcode |
debtorCity | Debtor city |
debtorCountry | Debtor country |
debtorNumber | Debtor number |
debtorEmail | Debtor email |
lines/description | Line description. In case line has items the description of the lines is merged in this field |
lines/amountExclVat | Total amount for this line |
lines/vatCode | Vat code for this line |
lines/vatAmount | Vat amount for this line |
lines/amountInclVat | Total amount for this line |
item/date | Date for this item, format: dd-mm-yyyy |
item/rawdate | Date for this item, format: yyyy-mm-dd |
item/resourceCode and Name | Code and name. Can be empty depending on invoice lay-out settings |
item/breakdownCode and Name | Code and name. Can be empty depending on invoice lay-out settings |
item/hours | Hours. Can be empty depending on line type |
item/rate | Commercial rate. Can be empty depending on line type |
item/amount | Line amount |
item/description | Description |
item/km | KM. Can be empty depending on line type |
The following xml structure is received after an incorrect execution:
<response>
<valid>no</valid>
<errors></errors>
</response>
Parameter | Description |
---|---|
valid | Indication that service was not executed successfully |
errors | Reason why the service has executed unsuccessfully |
Opmerkingen