Developer reference
API problem types
When a Corplyst API request fails, the response body follows RFC 9457 (formerly RFC 7807) problem details. Its type field is a link to one of the pages below, which explains what went wrong and how to fix it. Match on type in your code, not on title or detail.
Sign-in and access
- 401Unauthorized
unauthorized - 401Authentication Failed
authentication-failed - 401Invalid Token
invalid-token - 429Account Temporarily Locked
account-locked - 429Too Many Requests
rate-limit-exceeded - 403Forbidden
forbidden - 403No Active Company
no-active-company - 403Company Suspended
tenant-suspended - 403Account Suspended
group-suspended - 403Role Grant Not Allowed
role-grant-not-allowed - 400Weak Password
weak-password
Requests
- 400Validation Failed
validation-failed - 400Malformed Request
malformed-request - 400Invalid Request
invalid-request - 400Invalid Upload Object Key
invalid-upload-object-key
Accounting
- 404Journal Entry Not Found
journal-entry-not-found - 409Journal Entry Already Reversed
journal-entry-already-reversed - 400Unknown Account Code
unknown-account-code - 409Concurrent Posting Conflict
concurrent-posting-conflict
Invoices, quotes and payments
- 404Invoice Not Found
invoice-not-found - 409Invoice Not Editable
invoice-not-editable - 403Invoice Edit Not Authorized
invoice-edit-not-authorized - 409Invoice Not Issued
invoice-not-issued - 404Recurring Invoice Schedule Not Found
recurring-invoice-schedule-not-found - 409Recurring Invoice Schedule Invalid Transition
recurring-invoice-schedule-invalid-transition - 404Quote Not Found
quote-not-found - 409Quote Not Editable
quote-not-editable - 409Quote Not Accepted
quote-not-accepted - 409Quote Already Converted
quote-already-converted - 404Payment Not Found
payment-not-found - 400Payment Exceeds Balance
payment-exceeds-balance - 409Payment Already Reversed
payment-already-reversed - 422Exchange Rate Unavailable
exchange-rate-unavailable
Expenses and documents
- 404Expense Not Found
expense-not-found - 409Expense Not Editable
expense-not-editable - 400Unsupported Receipt
unsupported-receipt - 404Receipt Not Found
receipt-not-found - 404Company Document Not Found
company-document-not-found
Clients, suppliers and products
- 404Client Not Found
client-not-found - 404Supplier Not Found
supplier-not-found - 404Product Not Found
product-not-found
Employees and payroll
- 404Employee Not Found
employee-not-found - 409Employee Invalid Transition
employee-invalid-transition - 404Employment Contract Not Found
employment-contract-not-found - 409Employment Contract Invalid Transition
employment-contract-invalid-transition - 404Contract Clause Template Not Found
contract-clause-template-not-found - 409System Default Clause Template
system-default-clause-template - 404Payroll Run Not Found
payroll-run-not-found - 409Payroll Run Invalid Transition
payroll-run-invalid-transition - 404Payslip Not Found
payslip-not-found - 409Payslip Invalid Transition
payslip-invalid-transition
Tax Center
- 409Tax Form Not Ready For Filing
tax-form-not-ready-for-filing - 404Company Profile Not Found
company-profile-not-found - 404Bank Account Not Found
bank-account-not-found
Account and company administration
- 409Email Already In Use
email-already-in-use - 409Already A Member
already-member-of-company - 409Company Limit Reached
group-tenant-limit-exceeded - 409User Limit Reached
group-user-limit-exceeded - 400Limit Below Current Usage
group-limit-below-current-usage - 404Group Not Found
group-not-found - 409Invalid Group Status Transition
invalid-group-status-transition