Export invoices/quotes
Export an XML file containing all invoices or quotations including details lines. This method combines the results of the two calls (LIEN)Get invoices/quotes from any project and (LIEN)Get invoice lines and produces a single xml.
URL
(GET) invoices/export
PARAMETERS
token | The token obtained on connection | Required |
from | The first record to show starting with index 0. Default is 0 | Optional |
count | The number of records to show, up to 100 at a time. Default is 100. | Optional |
filter | A json containing filter information (see below) | Required |
Warning
The “filter” parameter is mandatory. The minimum requirement is to specify whether to retrieve client or supplier invoices/quotes. For example:
http://api.wordbee-translator.com:32490/invoices/export?token=…&filter={"isClientInvoices":true }
JSON format of "filter" parameter
You can filter the list of invoices that you want to download. You need to specify if you want client or supplier invoices. All other filter options are optional.
| isClientInvoices | Boolean value. If set to 'true', you obtain client invoices/quotes. Otherwise, you obtain supplier invoices/quotes. | Required |
| ids | An array containing the ids of the invoices to download. For example: [2,58,124] | Optional |
| statuses | The statuses of the invoices to download. Array of integer value. See InvoiceStatus in ApiInvoice For example, to get "Invoice sent" and "Invoice approved" use: [11,15] | Optional |
| reference | Filter on the reference of the invoice. | Optional |
| clientCompanyId | Filter on the id of the client company | Optional |
| clientCompanyName | Filter on the name of the client company | Optional |
| supplierCompanyId | Filter on the id of the supplier company | Optional |
| supplierCompanyName | Filter on the name of the supplier company | Optional |
| projectRef | Filter on the reference of the associated project | Optional |
| projectId | Filter on the id of the associated project | Optional |
| invoiceNo | Filter on the invoice number | Optional |
| quoteNo | Filter on the quote number | Optional |
RESULTS
An XML file composed of records, where each record has the following properties: Export - Invoice