COcodatio
Advanced controls

Get company configuration

Changed on

Returns a company's commerce sync configuration'.

get/config/companies/{companyId}/sync/commerce

Request

  • Base URL
    https://api.codat.io
  • URL
    https://api.codat.io/config/companies/{companyId}/sync/commerce
  • Auth
    API key in header Authorization

Path parameters

companyIdstring uuid required

Unique identifier for your SMB in Codat.

Example:8a210b68-6988-11ed-a1eb-0242ac120002

Unique identifier for a company.

Response

Success

companyIdSchema (unresolved $ref)
accountingSoftwareCompanyNamestring

The company name defined in the accounting software.

enableboolean

True if Sync for Commerce is enabled for the company.

configuredboolean

True if Sync for Commerce has been configured for the company.

scheduleSyncSchedule (unresolved $ref)
configurationCommerceConfiguration (unresolved $ref)

Changes

  • 929640e0cab2Revision changes
    • breaking

      the response's property type changed from no type to string, and format from no format to uuid for status

  • a96819c0110cRevision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status