COcodatio
Journals

Get create journal model

Changed on

The Get create journal model endpoint returns the expected data for the request payload when creating a journal for a given company and integration.

Journals are used to record all the financial transactions of a company.

Integration-specific behaviour

See the response examples for integration-specific indicative models.

get/companies/{companyId}/connections/{connectionId}/options/journals

Request

  • Base URL
    https://api.codat.io
  • URL
    https://api.codat.io/companies/{companyId}/connections/{connectionId}/options/journals
  • Auth
    API key in header Authorization

Response

OK

typePushOptionType required(unresolved $ref)
displayNameDisplayName required(unresolved $ref)
descriptionDescription (unresolved $ref)
requiredRequired required(unresolved $ref)
propertiesobject nullable
optionsPushOptionChoice[] nullable(unresolved $ref)
validationPushValidationInfo (unresolved $ref)

Changes

  • fc70787de2f3Revision changes
    • 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

    • info

      added the optional property to the response with the status