document-contract-notes

Manage contract notes

Operations

GET/accounts/{accountUuid}/documents/v2/contract-notesPOST/accounts/{accountUuid}/documents/v2/contract-notesGET/accounts/{accountUuid}/documents/v2/contract-notes/{contractNoteUuid}PATCH/accounts/{accountUuid}/documents/v2/contract-notes/{contractNoteUuid}GET/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actionsPOST/accounts/{accountUuid}/documents/v2/contract-notes/calculateGET/accounts/{accountUuid}/documents/v2/contract-notes/{contractNoteUuid}/actionsGET/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/attachmentsPOST/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/attachmentsPOST/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/calculatePATCH/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/archivePATCH/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/collectInvoicePATCH/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/markSentPATCH/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/massDownloadZipPATCH/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/massPrintPATCH/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/massSentPATCH/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/plannedMailPATCH/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/archivePATCH/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/cancelPATCH/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/cancelPermanentlyPATCH/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/clonePATCH/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/convertCNDNPATCH/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/convertCNIPATCH/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/convertTemplateToContractNotePATCH/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/convertToTemplatePATCH/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/createFinalPATCH/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/createPartialPATCH/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/deletePATCH/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/downloadPdfPATCH/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/emailPATCH/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/markSentPATCH/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/plannedMailPATCH/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/printPATCH/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/restoreDELETE/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/attachments/{attachmentUuid}

---

Get contract notes

GET

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

Get contract notes

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

Query Parameters

is_template

get templates

Type

boolean

Default

false

updatedSince

filter for updated items

limit

pagination limit

Type

[ "number", "null" ]

Maximum

400

Minimum

1

page

pagination page

Type

[ "number", "null" ]

Default

1

Minimum

1

Responses

Successful response

Content-Type

application/json

{

  

"data": {

  

  

"uuid": "string",

  

  

"id": 0,

  

  

"currencyCode": "string",

  

  

"currencyCodeRecognized": "string",

  

  

"title": "string",

  

  

"reference": "string",

  

  

"status": "string",

  

  

"sentStatus": "string",

  

  

"customField1": "string",

  

  

"customField2": "string",

  

  

"customField3": "string",

  

  

"customField4": "string",

  

  

"contractNoteDate": "string",

  

  

"dueDate": "string",

  

  

"receiver": {

  

  

  

"addressUuid": "string",

  

  

  

"companyUuid": "string",

  

  

  

"customerNumber": "string",

  

  

  

"name": "string",

  

  

  

"email": "string"

  

  

},

  

  

"documentTotal": 0,

  

  

"contractNoteNumber": "string",

  

  

"isArchived": true,

  

  

"isCancelled": true,

  

  

"updatedAt": "string",

  

  

"isTemplate": true

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

GET

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

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

is_template

updatedSince

limit

page

Samples

---

Create contract note

POST

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

Create 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"

Request Body

application/json

{

  

"documents": [

  

  

{

  

  

  

"currencyCode": "string",

  

  

  

"title": "string",

  

  

  

"reference": "string",

  

  

  

"customField1": "string",

  

  

  

"customField2": "string",

  

  

  

"customField3": "string",

  

  

  

"customField4": "string",

  

  

  

"terms": "string",

  

  

  

"publicNotes": "string",

  

  

  

"footerText": "string",

  

  

  

"isTemplate": true,

  

  

  

"contractNoteDate": "string",

  

  

  

"dueDate": "string",

  

  

  

"deliveryDate": "string",

  

  

  

"paymentInstructions": null,

  

  

  

"pricesIncludeVat": true,

  

  

  

"documentTotal": 0,

  

  

  

"positions": [

  

  

  

  

{

  

  

  

  

  

"positionNumber": 0,

  

  

  

  

  

"uuid": "string",

  

  

  

  

  

"kind": "product",

  

  

  

  

  

"unitUuid": "string",

  

  

  

  

  

"unitCode": "C62",

  

  

  

  

  

"quantity": 1,

  

  

  

  

  

"singlePrice": 0,

  

  

  

  

  

"discount": {

  

  

  

  

  

  

"percentage": 0

  

  

  

  

  

},

  

  

  

  

  

"vatUuid": "string",

  

  

  

  

  

"vat": {

  

  

  

  

  

  

"percentage": 0

  

  

  

  

  

},

  

  

  

  

  

"productUuid": "string",

  

  

  

  

  

"productDescription": "string"

  

  

  

  

}

  

  

  

],

  

  

  

"documentDiscount": {

  

  

  

  

"percentage": 0

  

  

  

},

  

  

  

"receiver": null

  

  

}

  

]

}

Responses

Contract note created

Content-Type

application/json

{

  

"data": {

  

  

"documents": [

  

  

  

{

  

  

  

  

"id": 0,

  

  

  

  

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

  

  

  

  

  

  

  

}

  

  

  

  

  

  

]

  

  

  

  

  

}

  

  

  

  

},

  

  

  

  

"contractNoteDate": "string",

  

  

  

  

"dueDate": "string",

  

  

  

  

"deliveryDate": "string",

  

  

  

  

"paymentInstructions": {

  

  

  

  

  

"bankAccountUuid": "string",

  

  

  

  

  

"iban": "string",

  

  

  

  

  

"bic": "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

  

  

  

  

  

  

},

  

  

  

  

  

  

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

  

  

  

  

  

  

}

  

  

  

  

  

}

  

  

  

  

],

  

  

  

  

"isTemplate": true,

  

  

  

  

"isImported": true,

  

  

  

  

"contractNoteNumber": "string",

  

  

  

  

"type": "string",

  

  

  

  

"documentDiscount": {

  

  

  

  

  

"amount": 0

  

  

  

  

}

  

  

  

}

  

  

]

  

},

  

"status": 201,

  

"message": "string",

  

"meta": {

  

}

}

POST

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

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

Body

Samples

---

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": [

  

  

  

{

  

  

  

  

"id": 0,

  

  

  

  

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

  

  

  

  

  

  

  

}

  

  

  

  

  

  

]

  

  

  

  

  

}

  

  

  

  

},

  

  

  

  

"contractNoteDate": "string",

  

  

  

  

"dueDate": "string",

  

  

  

  

"deliveryDate": "string",

  

  

  

  

"paymentInstructions": {

  

  

  

  

  

"bankAccountUuid": "string",

  

  

  

  

  

"iban": "string",

  

  

  

  

  

"bic": "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

  

  

  

  

  

  

},

  

  

  

  

  

  

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

  

  

  

  

  

  

}

  

  

  

  

  

}

  

  

  

  

],

  

  

  

  

"isTemplate": true,

  

  

  

  

"isImported": true,

  

  

  

  

"contractNoteNumber": "string",

  

  

  

  

"type": "string",

  

  

  

  

"documentDiscount": {

  

  

  

  

  

"amount": 0

  

  

  

  

}

  

  

  

}

  

  

]

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

GET

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

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

contractNoteUuid*

Samples

---

Update contract note

PATCH

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

Update 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"

Request Body

application/json

{

  

"documents": [

  

  

{

  

  

  

"currencyCode": "string",

  

  

  

"title": "string",

  

  

  

"reference": "string",

  

  

  

"customField1": "string",

  

  

  

"customField2": "string",

  

  

  

"customField3": "string",

  

  

  

"customField4": "string",

  

  

  

"terms": "string",

  

  

  

"publicNotes": "string",

  

  

  

"footerText": "string",

  

  

  

"isTemplate": true,

  

  

  

"contractNoteDate": "string",

  

  

  

"dueDate": "string",

  

  

  

"deliveryDate": "string",

  

  

  

"paymentInstructions": null,

  

  

  

"pricesIncludeVat": true,

  

  

  

"documentTotal": 0,

  

  

  

"positions": [

  

  

  

  

{

  

  

  

  

  

"positionNumber": 0,

  

  

  

  

  

"uuid": "string",

  

  

  

  

  

"kind": "product",

  

  

  

  

  

"unitUuid": "string",

  

  

  

  

  

"unitCode": "C62",

  

  

  

  

  

"quantity": 1,

  

  

  

  

  

"singlePrice": 0,

  

  

  

  

  

"discount": {

  

  

  

  

  

  

"percentage": 0

  

  

  

  

  

},

  

  

  

  

  

"vatUuid": "string",

  

  

  

  

  

"vat": {

  

  

  

  

  

  

"percentage": 0

  

  

  

  

  

},

  

  

  

  

  

"productUuid": "string",

  

  

  

  

  

"productDescription": "string"

  

  

  

  

}

  

  

  

],

  

  

  

"documentDiscount": {

  

  

  

  

"percentage": 0

  

  

  

},

  

  

  

"receiver": null

  

  

}

  

]

}

Responses

Contract note updated

Content-Type

application/json

{

  

"data": {

  

  

"documents": [

  

  

  

{

  

  

  

  

"id": 0,

  

  

  

  

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

  

  

  

  

  

  

  

}

  

  

  

  

  

  

]

  

  

  

  

  

}

  

  

  

  

},

  

  

  

  

"contractNoteDate": "string",

  

  

  

  

"dueDate": "string",

  

  

  

  

"deliveryDate": "string",

  

  

  

  

"paymentInstructions": {

  

  

  

  

  

"bankAccountUuid": "string",

  

  

  

  

  

"iban": "string",

  

  

  

  

  

"bic": "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

  

  

  

  

  

  

},

  

  

  

  

  

  

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

  

  

  

  

  

  

}

  

  

  

  

  

}

  

  

  

  

],

  

  

  

  

"isTemplate": true,

  

  

  

  

"isImported": true,

  

  

  

  

"contractNoteNumber": "string",

  

  

  

  

"type": "string",

  

  

  

  

"documentDiscount": {

  

  

  

  

  

"amount": 0

  

  

  

  

}

  

  

  

}

  

  

]

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

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

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

contractNoteUuid*

Body

Samples

---

Get bulk actions

GET

/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions

Get contract note bulk actions

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

Query Parameters

forList

filter list actions

Type

boolean

Default

false

Responses

Successful response

Content-Type

application/json

{

  

"data": {

  

  

"additionalProperties": "string"

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

GET

/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

forList

Samples

---

Calculate amounts of new document

POST

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

Calculates the amounts of a document for previewing without manipulating any resources

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"currencyCode": "string",

  

"positions": [

  

  

{

  

  

  

"positionNumber": 0,

  

  

  

"uuid": "string",

  

  

  

"kind": "product",

  

  

  

"unitUuid": "string",

  

  

  

"unitCode": "C62",

  

  

  

"quantity": 1,

  

  

  

"singlePrice": 0,

  

  

  

"discount": {

  

  

  

  

"percentage": 0

  

  

  

},

  

  

  

"vatUuid": "string",

  

  

  

"vat": {

  

  

  

  

"percentage": 0

  

  

  

},

  

  

  

"productUuid": "string",

  

  

  

"productDescription": "string"

  

  

}

  

],

  

"documentDiscount": {

  

  

"percentage": 0

  

},

  

"invoiceDate": "string",

  

"pricesIncludeVat": true

}

Responses

Successful response

Content-Type

application/json

{

  

"data": {

  

  

"total": 0,

  

  

"positionTotal": 0,

  

  

"discount": 0,

  

  

"roundingDifference": 0,

  

  

"taxes": [

  

  

  

{

  

  

  

  

"rate": 0,

  

  

  

  

"value": 0,

  

  

  

  

"name": "string",

  

  

  

  

"baseSum": 0

  

  

  

}

  

  

],

  

  

"totalInvoicedAmount": 0

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

POST

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

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

Body

Samples

---

Get actions

GET

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

Get contract note actions

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"

Query Parameters

forList

filter list actions

Type

boolean

Default

false

Responses

Successful response

Content-Type

application/json

{

  

"data": {

  

  

"additionalProperties": "string"

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

GET

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

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

contractNoteUuid*

forList

Samples

---

Get attachments

GET

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/attachments

Get attachments for a document

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

documentUuid*

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"uuid": "string",

  

  

  

"name": "string",

  

  

  

"fileSize": 0,

  

  

  

"mimeType": "string",

  

  

  

"url": "string"

  

  

}

  

],

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

GET

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/attachments

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Samples

---

Upload attachment

POST

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/attachments

Upload an attachment for a document

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

documentUuid*

Type

string

Required

Format

"uuid"

Request Body

multipart/form-data

Format"binary"

Responses

Document attachment uploaded

Content-Type

application/json

{

  

"data": {

  

  

"uuid": "string",

  

  

"name": "string",

  

  

"fileSize": 0,

  

  

"mimeType": "string",

  

  

"url": "string"

  

},

  

"status": 201,

  

"message": "string",

  

"meta": {

  

}

}

POST

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/attachments

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Body

Samples

---

Calculate amounts of an existing document

POST

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/calculate

Calculates the amounts of an existing document for previewing without manipulating any resources

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

documentUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"currencyCode": "string",

  

"positions": [

  

  

{

  

  

  

"positionNumber": 0,

  

  

  

"uuid": "string",

  

  

  

"kind": "product",

  

  

  

"unitUuid": "string",

  

  

  

"unitCode": "C62",

  

  

  

"quantity": 1,

  

  

  

"singlePrice": 0,

  

  

  

"discount": {

  

  

  

  

"percentage": 0

  

  

  

},

  

  

  

"vatUuid": "string",

  

  

  

"vat": {

  

  

  

  

"percentage": 0

  

  

  

},

  

  

  

"productUuid": "string",

  

  

  

"productDescription": "string"

  

  

}

  

],

  

"documentDiscount": {

  

  

"percentage": 0

  

},

  

"invoiceDate": "string",

  

"pricesIncludeVat": true

}

Responses

Successful response

Content-Type

application/json

{

  

"data": {

  

  

"total": 0,

  

  

"positionTotal": 0,

  

  

"discount": 0,

  

  

"roundingDifference": 0,

  

  

"taxes": [

  

  

  

{

  

  

  

  

"rate": 0,

  

  

  

  

"value": 0,

  

  

  

  

"name": "string",

  

  

  

  

"baseSum": 0

  

  

  

}

  

  

],

  

  

"totalInvoicedAmount": 0

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

POST

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/calculate

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Body

Samples

---

Execute archive bulk action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/archive

Marks the document as archived

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"documentUuids": [

  

  

"string"

  

]

}

Responses

Successfully bulk executed action

Content-Type

application/json

{

  

"data": {

  

  

"additionalProperties": [

  

  

]

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/archive

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

Body

Samples

---

Execute collectInvoice bulk action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/collectInvoice

Creates a collective invoice out of the selected items

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"documentUuids": [

  

  

"string"

  

]

}

Responses

Successfully bulk executed action

Content-Type

application/json

{

  

"data": {

  

  

"type": "string",

  

  

"id": 0,

  

  

"uuid": "string",

  

  

"isTemplate": true

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/collectInvoice

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

Body

Samples

---

Execute markSent bulk action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/markSent

Triggers the mark sent action for each document

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"documentUuids": [

  

  

"string"

  

]

}

Responses

Successfully bulk executed action

Content-Type

application/json

{

  

"data": {

  

  

"additionalProperties": [

  

  

]

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/markSent

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

Body

Samples

---

Execute massDownloadZip bulk action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/massDownloadZip

Zips and downloads each document. The result is sent to the inbox

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"documentUuids": [

  

  

"string"

  

]

}

Responses

Successfully bulk executed action

Content-Type

application/json

{

  

"data": {

  

  

"additionalProperties": "string"

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/massDownloadZip

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

Body

Samples

---

Execute massPrint bulk action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/massPrint

Triggers the print action for each document

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"documentUuids": [

  

  

"string"

  

]

}

Responses

Successfully bulk executed action

Content-Type

application/json

{

  

"data": {

  

  

"additionalProperties": [

  

  

]

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/massPrint

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

Body

Samples

---

Execute massSent bulk action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/massSent

Triggers the send action for each document

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"documentUuids": [

  

  

"string"

  

]

}

Responses

Successfully bulk executed action

Content-Type

application/json

{

  

"data": {

  

  

"additionalProperties": [

  

  

]

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/massSent

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

Body

Samples

---

Execute plannedMail bulk action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/plannedMail

Triggers the plan mail action for each document

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"documentUuids": [

  

  

"string"

  

]

}

Responses

Successfully bulk executed action

Content-Type

application/json

{

  

"data": {

  

  

"additionalProperties": [

  

  

]

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/plannedMail

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

Body

Samples

---

Execute archive action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/archive

Archives the document

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

documentUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully executed action

Content-Type

application/json

{

  

"data": "string",

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/archive

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Samples

---

Execute cancel action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/cancel

Cancels and moves the document back to draft

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

documentUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully executed action

Content-Type

application/json

{

  

"data": "string",

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/cancel

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Samples

---

Execute cancelPermanently action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/cancelPermanently

Cancels the document permanently. It cannot be edited afterwards

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

documentUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully executed action

Content-Type

application/json

{

  

"data": "string",

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/cancelPermanently

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Samples

---

Execute clone action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/clone

Creates a copy of the document

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

documentUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully executed action

Content-Type

application/json

{

  

"data": {

  

  

"type": "string",

  

  

"id": 0,

  

  

"uuid": "string",

  

  

"isTemplate": true

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/clone

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Samples

---

Execute convertCNDN action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/convertCNDN

Creates a delivery note out of a 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"

documentUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully executed action

Content-Type

application/json

{

  

"data": {

  

  

"type": "string",

  

  

"id": 0,

  

  

"uuid": "string",

  

  

"isTemplate": true

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/convertCNDN

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Samples

---

Execute convertCNI action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/convertCNI

Creates an invoice out of a 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"

documentUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully executed action

Content-Type

application/json

{

  

"data": {

  

  

"type": "string",

  

  

"id": 0,

  

  

"uuid": "string",

  

  

"isTemplate": true

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/convertCNI

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Samples

---

Execute convertTemplateToContractNote action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/convertTemplateToContractNote

Creates a contract note out of a template

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

documentUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully executed action

Content-Type

application/json

{

  

"data": {

  

  

"type": "string",

  

  

"id": 0,

  

  

"uuid": "string",

  

  

"isTemplate": true

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/convertTemplateToContractNote

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Samples

---

Execute convertToTemplate action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/convertToTemplate

Creates a template out of a document

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

documentUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully executed action

Content-Type

application/json

{

  

"data": {

  

  

"type": "string",

  

  

"id": 0,

  

  

"uuid": "string",

  

  

"isTemplate": true

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/convertToTemplate

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Samples

---

Execute createFinal action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/createFinal

Creates a final invoice for a 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"

documentUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"relatedInvoiceDate": "string",

  

"relatedDueDate": "string"

}

Responses

Successfully executed action

Content-Type

application/json

{

  

"data": {

  

  

"printUrl": "string"

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/createFinal

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Body

Samples

---

Execute createPartial action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/createPartial

Create a partial invoice for a 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"

documentUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"invoiceItemUuids": [

  

  

"string"

  

],

  

"relatedInvoiceDate": "string",

  

"relatedDueDate": "string"

}

Responses

Successfully executed action

Content-Type

application/json

{

  

"data": {

  

  

"printUrl": "string"

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/createPartial

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Body

Samples

---

Execute delete action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/delete

Deletes a document

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

documentUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully executed action

Content-Type

application/json

{

  

"data": "string",

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/delete

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Samples

---

Execute downloadPdf action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/downloadPdf

Gets the download uri for the document's pdf

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

documentUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully executed action

Content-Type

application/json

{

  

"data": {

  

  

"downloadUrl": "string"

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/downloadPdf

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Samples

---

Execute email action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/email

Sends the document via email

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

documentUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully executed action

Content-Type

application/json

{

  

"data": "string",

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/email

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Samples

---

Execute markSent action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/markSent

Marks the invoice as sent

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

documentUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully executed action

Content-Type

application/json

{

  

"data": {

  

  

"type": "string",

  

  

"id": 0,

  

  

"uuid": "string"

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/markSent

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Samples

---

Execute plannedMail action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/plannedMail

Schedules the email for sending the document

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

documentUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully executed action

Content-Type

application/json

{

  

"data": "string",

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/plannedMail

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Samples

---

Execute print action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/print

Creates the PDF for printing

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

documentUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully executed action

Content-Type

application/json

{

  

"data": {

  

  

"type": "string",

  

  

"id": 0,

  

  

"uuid": "string",

  

  

"printUrl": "string",

  

  

"document": {

  

  

  

"url": "string",

  

  

  

"preview_url": "string"

  

  

}

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/print

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Samples

---

Execute restore action

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/restore

Restores an archived document

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

documentUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully executed action

Content-Type

application/json

{

  

"data": {

  

  

"type": "string",

  

  

"id": 0,

  

  

"uuid": "string"

  

},

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/restore

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

Samples

---

Delete attachment

DELETE

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/attachments/{attachmentUuid}

Delete an attachment from a document

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

documentUuid*

Type

string

Required

Format

"uuid"

attachmentUuid*

Type

string

Required

Format

"uuid"

Responses

Document attachment deleted

Content-Type

application/json

{

  

"data": "string",

  

"status": 200,

  

"message": "string",

  

"meta": {

  

}

}

DELETE

/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/attachments/{attachmentUuid}

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

documentUuid*

attachmentUuid*

Samples

---