COcodatio
Credit notes

Get create/update credit note model

Changed on

The Get create/update credit note model endpoint returns the expected data for the request payload when creating and updating a credit note for a given company and integration.

Credit notes are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.

Integration-specific behavior

See the response examples for integration-specific indicative models.

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

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