Credit notes

Get create/update credit note model

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

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