Environments

Codat has two environments - UAT and Production. These environments are completely separated which allows you to:

  • Use UAT as a sandbox for testing.
  • Share UAT credentials with all engineers across your organisation without affecting the security of your Production environment.

Environment access

The base URLs for both environments are shown below. Developers must use a separate API key for each environment.

Environment

Base URL

UAT

https://api-uat.codat.io/

Production

https://api.codat.io/

UAT limits

To maintain the performance of the UAT environment the following usage limits are in place.

Limit type

Limit

Limit reached

Account expiry

Free accounts expire after 30 days.

Contact our sales team to extend your account within 90 days of the expiry.

No. of companies

Set up and use a maximum of 50 companies at one time.

Delete companies that are no longer required.

Sync frequency

  • In the Codat portal - Daily, weekly, or monthly syncs are available.

  • From the API - Sync frequencies of 24 hours or more are available.

Sync frequencies of under 24 hours are only available in Production.

Contact our solutions team if you require further information.

Error code and messages

When an API call breaches a UAT limit, you will receive a 402 error code.

30-day account expiry limit

Error response when your account has expired and you make a request to any endpoint.

{
  "statusCode": 402,
  "service": "PublicApi",
  "error": "Payment Required",
  "correlationId": "00000000-0000-0000-0000-000000000000",
  "validation": {
    "errors": [
      {
        "message": "Account expired. Learn more at https://docs.codat.io/docs/environments-1",
      }
    ],
    "warnings": []
  }
}

50 company limit

Error response from POST /companies when you try to exceed the 50 company limit.

{
  "statusCode": 402,
  "service": "PublicApi",
  "error": "CompanyValidationException: Company limit exceeded",
  "correlationId": "00000000-0000-0000-0000-000000000000",
  "validation": {
    "errors": [
      {
        "itemId": "Company",
        "message": "Company limit exceeded. Learn more at https://docs.codat.io/docs/environments-1",
        "validatorName": "CreateCompany"
      }
    ],
    "warnings": []
  }
}

Sync frequency limit

Error response from POST /profile/syncSettings when syncSchedule is set to less than 24.

{
  "statusCode": 402,
  "service": "ClientsApi",
  "error": "SyncSettingsValidationException: Sync schedule not allowed",
  "correlationId": "00000000-0000-0000-0000-000000000000",
  "validation": {
    "errors": [
      {
        "itemId": "SyncSettings",
        "message": "Sync schedule not allowed in UAT. Learn more at https://docs.codat.io/docs/environments-1",
        "validatorName": "SyncSettings"
      }
    ],
    "warnings": []
  }
}

Did this page help you?