Status codes

Status codes

The status codes used in Codat are listed in the table below.

Status code

Meaning

200

Success

202

Accepted (pending)

400

Bad Request -- The server cannot or will not process the request due to an apparent client-side error.

401

Unauthorized -- Your Codat API key is incorrect.

402

UAT limits have been reached. Either:

  • You have exceeded the company limit.

  • You have requested a sync schedule that is not allowed in UAT.

  • Your account has expired.

If you have exceeded the company limit, we suggest that you delete any companies you no longer need and retry the request.

If your account has expired or you need to test hourly sync schedules in UAT, please contact our solutions team.

403

Forbidden -- either:

  • The requested endpoint is for administrators only, or

  • A downstream endpoint cannot be accessed.

404

Not Found -- either:

  • The resource could not be found, or

  • Data type is not support by the platform.
    In such case, the error message would be: Datatype 'yyy' not supported by platform(s) 'zzz'.

405

Method Not Allowed -- You are using an unauthorized method.

409

Conflict -- The resource is not ready.

If syncing a data set, this could mean that either:

  • The data set has not been requested.

  • The syncing of data set has not been completed.

429

Too Many Requests -- You have made too many requests in a given amount of time. Please retry later.

500

Internal Server Error -- We had a problem with our server. Please try again later.

503

Service Unavailable -- We're temporarially offline for maintanance. Please try again later.

Error Responses

The content of an error response should include a more detailed error message and a correlationId which can be used to identify a particular response to Codat support. If you are contacting Codat support regarding an error, please include the correlationId in text format.

{
  "statusCode": 404,
  "service": "QuickbooksOnline",
  "error": "InvoicePdfNotFoundException: Invoice not found for company 360cb9b3-d9cf-4f66-b8db-8a3523fe3dc5 and invoice ID 12345",
  "correlationId": "131f0225-5467-421a-b179-4531d6b4a942"
}

Status codes in asynchronous push responses

Status codes for push operations created in Codat API may be different from the status codes returned in the responses from the service providers. When a push operation is created in Codat API, some service providers may use a 202 Accepted code (to imply that the request has been accepted for processing, but the processing has not completed). However, push API may return a 200 Success code for the push operation successfully created in Codat API.


Did this page help you?