document-contract-notes

---

Get contract note

GET

/accounts/{accountUuid}/documents/v2/contract-notes/{contractNoteUuid}

Get a single contract note

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

contractNoteUuid*

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/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"

  

  

  

  

},

  

  

  

  

"contractNoteDate": "string",

  

  

  

  

"dueDate": "string",

  

  

  

  

"deliveryDate": "string",

  

  

  

  

"paymentInstructions": {

  

  

  

  

  

"bankAccountUuid": "string",

  

  

  

  

  

"iban": "string",

  

  

  

  

  

"bic": "string",

  

  

  

  

  

"qrIban": "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,

  

  

  

  

"contractNoteNumber": "string",

  

  

  

  

"type": "string",

  

  

  

  

"documentDiscount": {

  

  

  

  

  

"amount": 0,

  

  

  

  

  

"percentage": 0

  

  

  

  

}

  

  

  

}

  

  

]

  

},

  

"message": "string",

  

"status": 200,

  

"meta": {

  

}

}

GET

/accounts/{accountUuid}/documents/v2/contract-notes/{contractNoteUuid}

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

contractNoteUuid*

Samples

---