Basics
- HTTP
- JSON
- Base64 encoding for binary files.
- UTF-8 encoding for data files.
- SSL is required. Use at least TLSv1.2.
- Files are processed daily, usually around 01:00 AM. The actual time can be found in the import settings of the specific administration.
- If no data file is available for the automatic import a notification is added to the import page.
- Any PDF files of the original invoices are linked based on the file name. The file name must contain the exact invoice number of the invoice. Example: 141234.PDF can be linked to invoice 141234. In order to link the files properly, a setting on the Payt side must be made by the implementation specialist or the service desk.
- In the
Importtab of the relevant administration within Payt, linkingbased on supplied CSV filesandautomatic importmust be enabled. The administration code must also be entered directly. - When using the FTP/SFTP integration, it is also possible to provide files in a zip archive. These archives will automatically be unarchived in the same directory. Note: only files are unarchived, directories within the zip archive will be ignored.
- When using the HTTP endpoints, it is also possible to provide gzipped files. Files with a .gz extension will automatically be decompressed before further processing. Make sure the extension of the original file is intact (e.g. 20220728.csv.gz will be decompressed and processed as 20220728.csv).
Endpoints
Submit a POST request to one of the following endpoints, depending on the file type:| File type | Endpoint |
|---|---|
| CSV / XML data file | https://backend.paytsoftware.com/import/files/csv |
| Invoice PDF | https://backend.paytsoftware.com/import/files/invoice_pdf |
| Invoice UBL | https://backend.paytsoftware.com/import/files/invoice_ubl |
| Invoice attachment | https://backend.paytsoftware.com/import/files/invoice_attachment |
| Declaration file (MZ301/AP304/ZIP) | https://backend.paytsoftware.com/import/files/declaration_file |
Format of the data
Provide the following headers with the POST request:- Accept-Charset: UTF-8
- Accept: application/json
- Content-Type: application/json
Many base64 libraries generate their output with line breaks every 76 characters (due to support for legacy email systems). Line breaks are not valid in JSON strings, so must be removed.
administration_code an administration_id can also be used: