The following endpoints are available for the Candis Export API:

1. Create an Export
2. Get a list Exports
3. Get an Export
4. Get a list of Exporting Postings
5. Download PDF file by ID

Create an Export

Create an export set of all approved invoices in Candis, ready for transfer to your accounting or ERP system. This ensures that the data is saved permanently. After this process, the user in Candis can no longer send the document back for approval or delete it. Additionally, no details, such as the accounts payable number or general ledger account, can be modified.

Furthermore, an export ID is generated, which is required for other endpoints.

With "Create an Export," you can choose between two entity types:

• DOCUMENT
• CARD_TRANSACTION

By default, only invoices associated with the 'DOCUMENT' entity are available.

Get a list Exports

This endpoint provides you with a complete list of all exports made with the corresponding ID. It can be used to recognize duplicates or to check whether all exports have been processed.

Get an Export

The status of the export can be retrieved with Get an Export. Depending on the number of invoices retrieved under the Create an Export endpoint, this may take a different amount of time. However, the query should be made at short intervals to prevent the export process from being artificially prolonged.

If the status changes from ‘EXPORTING’ to ‘EXPORTED’, you can continue with the next endpoint.

Get a list of Export Postings

Once the status of the export is set to ‘EXPORTED’, the invoices can be retrieved using 'Get a list of Export Postings'.

There are two different entityTypes

• 'DOCUMENT'
• 'CARD_TRANSACTION'

Differences between the entityType 'DOCUMENT' and 'CARD_TRANSACTION'. The entityType 'CARD_TRANSACTION' includes 'CREDIT CARDS POSTING'. The following objects are added to that Type:

• creditCardSettings
  • bookingAccount
  • transitAccount
• payment
  • method
  • paidAt

With those informations you can create another posting for Credit Cards in you ERP. The posting of the invoice is still identical to the entityType 'DOCUMENT'.

Another posting has to be created with the following changes:

1. invoiceDate will be exchanged with paidAt.
2. generalLedgerAccount will be exchanged with bookingAccount.
3. The invoice posting increases your payable to the supplier, while the credit card transaction reduces it by the same value.

Download PDF file by ID

The last endpoint can be used to call up the document images. We distinguish between the:

1. main document (INVOICE, XRECHNUNG)
2. attachments (ATTACHMENT)
3. summary (AUDIT_TRAIL)