COcodatio
Payments

Get create payment model

Changed on

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

Payments represent an allocation of money within any customer accounts receivable account.

Integration-specific behavior

See the response examples for integration-specific indicative models.

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

Request

  • Base URL
    https://api.codat.io
  • 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

  • 4bfab0afa6caRevision 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

  • 948b47a54450Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status