Appearance

document-credit-notes​

Update credit note​

PATCH
/accounts/{accountUuid}/documents/v2/credit-notes/{creditNoteUuid}

Update credit note

Authorizations​

ApiToken

Bearer token authentication. Create tokens in Settings > API Token.

Type
HTTP (bearer)

Parameters​

Path Parameters

accountUuid*
Type
string
Required
Format
"uuid"
creditNoteUuid*
Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
  
"documents": [
  
  
{
  
  
  
"isTemplate": true,
  
  
  
"creditNoteDate": "string",
  
  
  
"dueDate": "string",
  
  
  
"pricesIncludeVat": true,
  
  
  
"documentTotal": 0,
  
  
  
"positions": [
  
  
  
  
{
  
  
  
  
  
"positionNumber": 0,
  
  
  
  
  
"uuid": "string",
  
  
  
  
  
"kind": "page_break",
  
  
  
  
  
"unitUuid": "string",
  
  
  
  
  
"unitCode": "C62",
  
  
  
  
  
"quantity": 1,
  
  
  
  
  
"singlePrice": 0,
  
  
  
  
  
"discount": {
  
  
  
  
  
  
"percentage": 0,
  
  
  
  
  
  
"amount": 0
  
  
  
  
  
},
  
  
  
  
  
"vatUuid": "string",
  
  
  
  
  
"vat": {
  
  
  
  
  
  
"percentage": 0
  
  
  
  
  
},
  
  
  
  
  
"productUuid": null,
  
  
  
  
  
"productNumber": "string",
  
  
  
  
  
"productDescription": "string",
  
  
  
  
  
"title": "string",
  
  
  
  
  
"text": "string",
  
  
  
  
  
"items": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"positionNumber": 0,
  
  
  
  
  
  
  
"kind": "product",
  
  
  
  
  
  
  
"unitUuid": "string",
  
  
  
  
  
  
  
"unitCode": "C62",
  
  
  
  
  
  
  
"quantity": 1,
  
  
  
  
  
  
  
"singlePrice": 0,
  
  
  
  
  
  
  
"discount": {
  
  
  
  
  
  
  
  
"percentage": 0,
  
  
  
  
  
  
  
  
"amount": 0
  
  
  
  
  
  
  
},
  
  
  
  
  
  
  
"vatUuid": "string",
  
  
  
  
  
  
  
"vat": {
  
  
  
  
  
  
  
  
"percentage": 0
  
  
  
  
  
  
  
},
  
  
  
  
  
  
  
"productUuid": null,
  
  
  
  
  
  
  
"productNumber": "string",
  
  
  
  
  
  
  
"productDescription": "string"
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"showCollapsed": true
  
  
  
  
}
  
  
  
],
  
  
  
"documentDiscount": {
  
  
  
  
"percentage": 0,
  
  
  
  
"amount": 0
  
  
  
},
  
  
  
"currencyCode": "string",
  
  
  
"title": "string",
  
  
  
"reference": "string",
  
  
  
"customField1": "string",
  
  
  
"customField2": "string",
  
  
  
"customField3": "string",
  
  
  
"customField4": "string",
  
  
  
"terms": "string",
  
  
  
"publicNotes": "string",
  
  
  
"footerText": "string",
  
  
  
"receiver": {
  
  
  
  
"addressUuid": "string",
  
  
  
  
"personUuid": "string",
  
  
  
  
"deliveryAddressUuid": "string",
  
  
  
  
"companyUuid": "string",
  
  
  
  
"contactPersonUuid": "string",
  
  
  
  
"additionalReceivers": [
  
  
  
  
  
{
  
  
  
  
  
  
"personUuid": "string"
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"customerNumber": "string"
  
  
  
}
  
  
}
  
]
}

Responses​

Credit note updated

application/json
JSON
{
  
"data": {
  
  
"documents": [
  
  
  
{
  
  
  
  
"uuid": "string",
  
  
  
  
"currencyCode": "string",
  
  
  
  
"currencyCodeRecognized": "string",
  
  
  
  
"title": "string",
  
  
  
  
"reference": "string",
  
  
  
  
"sentStatus": "string",
  
  
  
  
"status": "string",
  
  
  
  
"customField1": "string",
  
  
  
  
"customField2": "string",
  
  
  
  
"customField3": "string",
  
  
  
  
"customField4": "string",
  
  
  
  
"terms": "string",
  
  
  
  
"publicNotes": "string",
  
  
  
  
"footerText": "string",
  
  
  
  
"receiver": {
  
  
  
  
  
"addressUuid": "string",
  
  
  
  
  
"companyUuid": "string",
  
  
  
  
  
"networkUuid": "string",
  
  
  
  
  
"networkKey": "string",
  
  
  
  
  
"networkName": "string",
  
  
  
  
  
"deliveryAddressUuid": "string",
  
  
  
  
  
"contactPersonUuid": "string",
  
  
  
  
  
"additionalReceivers": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"personUuid": "string"
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"receiverInformation": {
  
  
  
  
  
  
"customerNumber": "string",
  
  
  
  
  
  
"companyName": "string",
  
  
  
  
  
  
"name": "string",
  
  
  
  
  
  
"nameWithSalutation": "string",
  
  
  
  
  
  
"careOfAddress": "string",
  
  
  
  
  
  
"address": "string",
  
  
  
  
  
  
"extension": "string",
  
  
  
  
  
  
"houseNumber": "string",
  
  
  
  
  
  
"zipCode": "string",
  
  
  
  
  
  
"city": "string",
  
  
  
  
  
  
"countryCode": "string",
  
  
  
  
  
  
"email": "string",
  
  
  
  
  
  
"language": "string",
  
  
  
  
  
  
"deliveryAddress": {
  
  
  
  
  
  
  
"companyName": "string",
  
  
  
  
  
  
  
"name": "string",
  
  
  
  
  
  
  
"nameWithSalutation": "string",
  
  
  
  
  
  
  
"careOfAddress": "string",
  
  
  
  
  
  
  
"address": "string",
  
  
  
  
  
  
  
"extension": "string",
  
  
  
  
  
  
  
"houseNumber": "string",
  
  
  
  
  
  
  
"zipCode": "string",
  
  
  
  
  
  
  
"city": "string",
  
  
  
  
  
  
  
"countryCode": "string"
  
  
  
  
  
  
},
  
  
  
  
  
  
"additionalReceivers": [
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
  
"fullName": "string",
  
  
  
  
  
  
  
  
"email": "string"
  
  
  
  
  
  
  
}
  
  
  
  
  
  
]
  
  
  
  
  
},
  
  
  
  
  
"personUuid": "string"
  
  
  
  
},
  
  
  
  
"creditNoteDate": "string",
  
  
  
  
"dueDate": "string",
  
  
  
  
"pricesIncludeVat": true,
  
  
  
  
"documentTotal": 0,
  
  
  
  
"positions": [
  
  
  
  
  
{
  
  
  
  
  
  
"uuid": "string",
  
  
  
  
  
  
"positionNumber": 0,
  
  
  
  
  
  
"kind": "string",
  
  
  
  
  
  
"productNumber": "string",
  
  
  
  
  
  
"productDescription": "string",
  
  
  
  
  
  
"productUuid": "string",
  
  
  
  
  
  
"productGroupUuid": "string",
  
  
  
  
  
  
"singlePrice": 0,
  
  
  
  
  
  
"positionTotal": 0,
  
  
  
  
  
  
"discount": {
  
  
  
  
  
  
  
"amount": 0,
  
  
  
  
  
  
  
"percentage": 0
  
  
  
  
  
  
},
  
  
  
  
  
  
"vatUuid": "string",
  
  
  
  
  
  
"vat": {
  
  
  
  
  
  
  
"percentage": 0,
  
  
  
  
  
  
  
"amount": 0
  
  
  
  
  
  
},
  
  
  
  
  
  
"quantity": 0,
  
  
  
  
  
  
"unitUuid": "string",
  
  
  
  
  
  
"employeeActivityUuid": "string",
  
  
  
  
  
  
"employeeActivityEmployeeUuid": "string",
  
  
  
  
  
  
"employeeActivityStartDate": "string",
  
  
  
  
  
  
"relatedInvoice": {
  
  
  
  
  
  
  
"uuid": "string",
  
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
  
"number": "string"
  
  
  
  
  
  
},
  
  
  
  
  
  
"originalInvoice": {
  
  
  
  
  
  
  
"uuid": "string",
  
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
  
"number": "string"
  
  
  
  
  
  
},
  
  
  
  
  
  
"title": "string",
  
  
  
  
  
  
"showCollapsed": true,
  
  
  
  
  
  
"items": [
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
  
"uuid": "string",
  
  
  
  
  
  
  
  
"positionNumber": 0,
  
  
  
  
  
  
  
  
"kind": "string",
  
  
  
  
  
  
  
  
"productNumber": "string",
  
  
  
  
  
  
  
  
"productDescription": "string",
  
  
  
  
  
  
  
  
"productUuid": "string",
  
  
  
  
  
  
  
  
"productGroupUuid": "string",
  
  
  
  
  
  
  
  
"singlePrice": 0,
  
  
  
  
  
  
  
  
"positionTotal": 0,
  
  
  
  
  
  
  
  
"discount": {
  
  
  
  
  
  
  
  
  
"amount": 0,
  
  
  
  
  
  
  
  
  
"percentage": 0
  
  
  
  
  
  
  
  
},
  
  
  
  
  
  
  
  
"vatUuid": "string",
  
  
  
  
  
  
  
  
"vat": {
  
  
  
  
  
  
  
  
  
"percentage": 0,
  
  
  
  
  
  
  
  
  
"amount": 0
  
  
  
  
  
  
  
  
},
  
  
  
  
  
  
  
  
"quantity": 0,
  
  
  
  
  
  
  
  
"unitUuid": "string",
  
  
  
  
  
  
  
  
"employeeActivityUuid": "string",
  
  
  
  
  
  
  
  
"employeeActivityEmployeeUuid": "string",
  
  
  
  
  
  
  
  
"employeeActivityStartDate": "string",
  
  
  
  
  
  
  
  
"relatedInvoice": {
  
  
  
  
  
  
  
  
  
"uuid": "string",
  
  
  
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
  
  
  
"number": "string"
  
  
  
  
  
  
  
  
},
  
  
  
  
  
  
  
  
"originalInvoice": {
  
  
  
  
  
  
  
  
  
"uuid": "string",
  
  
  
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
  
  
  
"number": "string"
  
  
  
  
  
  
  
  
},
  
  
  
  
  
  
  
  
"unitCode": "string"
  
  
  
  
  
  
  
}
  
  
  
  
  
  
],
  
  
  
  
  
  
"unitCode": "string",
  
  
  
  
  
  
"text": "string"
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"isTemplate": true,
  
  
  
  
"creditNoteNumber": "string",
  
  
  
  
"openAmount": 0,
  
  
  
  
"abanetSendAt": "string",
  
  
  
  
"abanetConfirmedAt": "string",
  
  
  
  
"type": "string",
  
  
  
  
"documentDiscount": {
  
  
  
  
  
"amount": 0,
  
  
  
  
  
"percentage": 0
  
  
  
  
}
  
  
  
}
  
  
]
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​