FAQ
Frequently asked questions and best practices.
General Questions
Q: How long is the API Key valid? A: By default it does not expire, though you can give it an expiry date when you create it. You disable it by revoking it from My Company → Integrations → API Integration.
Q: Can I re-upload data to update existing records?
A: Yes, records are matched by their erp_*_id fields and updated if they already exist.
Q: What happens if I upload files out of order? A: Rows whose dependency does not exist (for example, a contact of a customer that has not been uploaded yet) are dropped while the file is processed, and the response had already confirmed the upload: it will not tell you. For contacts, classifications, invoices, vouchers and installments, if no dependency in the file exists nothing is processed; payments, by contrast, are reported as successful even when every row is dropped. Always upload in the recommended order.
Q: Is there a file size limit? A: The API does not set a limit of its own, but it is worth splitting very large files: validation and upload are faster and errors are easier to locate.
Best Practices
- UTF-8 Encoding: Always save CSV files with UTF-8 encoding.
- Respect Dependencies: Upload base entities (Customers) first.
- Batch Processing: For large datasets, split files and upload in batches.
- API Key Security: Store the API Key securely; it is shown only when you create it. If it is exposed, revoke it and create a new one.