Loan writeback

Get create payment model

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
  • URL: https://api.codat.io/companies/{companyId}/connections/{connectionId}/options/payments
  • 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

No recorded changes to this operation across all 54 revisions of this API.