Get create/update credit note model

https://api.codat.io/companies/{companyId}/connections/{connectionId}/options/creditNotes

Get create/update credit note model. Returns the expected data for the request payload. See the examples for integration-specific indicative models. > **Supported Integrations** > > Check out our Knowledge UI for integrations that support creating and updating a credit note.

Access Token Required: API Key

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://api.codat.io/companies/{companyId}/connections/{connectionId}/options/creditNotes' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET