document-invoices

---

Create preview

POST

/accounts/{accountUuid}/documents/v2/{type}/{invoiceUuid}/preview

Creates a new PDF preview for a document or returns the sent PDF if one exists

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

invoiceUuid*

Type

string

Required

Format

"uuid"

type*

Type of the document

Type

string

Required

Valid values

"invoices""contract-notes""recurring-invoices""quotes""delivery-notes""credit-notes"

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,

  

  

  

"invoiceDate": "string",

  

  

  

"dueDate": "string",

  

  

  

"deliveryDate": "string",

  

  

  

"paymentInstructions": null,

  

  

  

"pricesIncludeVat": true,

  

  

  

"isVariantInvoice": false,

  

  

  

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

  

  

  

  

}

  

  

  

],

  

  

  

"cashDiscounts": [

  

  

  

  

{

  

  

  

  

  

"days": 0,

  

  

  

  

  

"percentage": 0

  

  

  

  

}

  

  

  

],

  

  

  

"documentDiscount": {

  

  

  

  

"percentage": 0

  

  

  

},

  

  

  

"receiver": null

  

  

}

  

]

}

Responses

Created a preview PDF

Content-Type

application/json

{

  

"data": {

  

  

"previewUrl": "string",

  

  

"downloadUrl": "string",

  

  

"expiresAt": "string"

  

},

  

"status": 201,

  

"message": "string",

  

"meta": {

  

}

}

POST

/accounts/{accountUuid}/documents/v2/{type}/{invoiceUuid}/preview

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

invoiceUuid*

type*

Body

Samples

---

document-contract-notes

---

Create preview

POST

/accounts/{accountUuid}/documents/v2/{type}/{invoiceUuid}/preview

Creates a new PDF preview for a document or returns the sent PDF if one exists

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

invoiceUuid*

Type

string

Required

Format

"uuid"

type*

Type of the document

Type

string

Required

Valid values

"invoices""contract-notes""recurring-invoices""quotes""delivery-notes""credit-notes"

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,

  

  

  

"invoiceDate": "string",

  

  

  

"dueDate": "string",

  

  

  

"deliveryDate": "string",

  

  

  

"paymentInstructions": null,

  

  

  

"pricesIncludeVat": true,

  

  

  

"isVariantInvoice": false,

  

  

  

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

  

  

  

  

}

  

  

  

],

  

  

  

"cashDiscounts": [

  

  

  

  

{

  

  

  

  

  

"days": 0,

  

  

  

  

  

"percentage": 0

  

  

  

  

}

  

  

  

],

  

  

  

"documentDiscount": {

  

  

  

  

"percentage": 0

  

  

  

},

  

  

  

"receiver": null

  

  

}

  

]

}

Responses

Created a preview PDF

Content-Type

application/json

{

  

"data": {

  

  

"previewUrl": "string",

  

  

"downloadUrl": "string",

  

  

"expiresAt": "string"

  

},

  

"status": 201,

  

"message": "string",

  

"meta": {

  

}

}

POST

/accounts/{accountUuid}/documents/v2/{type}/{invoiceUuid}/preview

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

invoiceUuid*

type*

Body

Samples

---

document-recurring-invoices

---

Create preview

POST

/accounts/{accountUuid}/documents/v2/{type}/{invoiceUuid}/preview

Creates a new PDF preview for a document or returns the sent PDF if one exists

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

invoiceUuid*

Type

string

Required

Format

"uuid"

type*

Type of the document

Type

string

Required

Valid values

"invoices""contract-notes""recurring-invoices""quotes""delivery-notes""credit-notes"

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,

  

  

  

"invoiceDate": "string",

  

  

  

"dueDate": "string",

  

  

  

"deliveryDate": "string",

  

  

  

"paymentInstructions": null,

  

  

  

"pricesIncludeVat": true,

  

  

  

"isVariantInvoice": false,

  

  

  

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

  

  

  

  

}

  

  

  

],

  

  

  

"cashDiscounts": [

  

  

  

  

{

  

  

  

  

  

"days": 0,

  

  

  

  

  

"percentage": 0

  

  

  

  

}

  

  

  

],

  

  

  

"documentDiscount": {

  

  

  

  

"percentage": 0

  

  

  

},

  

  

  

"receiver": null

  

  

}

  

]

}

Responses

Created a preview PDF

Content-Type

application/json

{

  

"data": {

  

  

"previewUrl": "string",

  

  

"downloadUrl": "string",

  

  

"expiresAt": "string"

  

},

  

"status": 201,

  

"message": "string",

  

"meta": {

  

}

}

POST

/accounts/{accountUuid}/documents/v2/{type}/{invoiceUuid}/preview

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

invoiceUuid*

type*

Body

Samples

---

document-quotes

---

Create preview

POST

/accounts/{accountUuid}/documents/v2/{type}/{invoiceUuid}/preview

Creates a new PDF preview for a document or returns the sent PDF if one exists

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

invoiceUuid*

Type

string

Required

Format

"uuid"

type*

Type of the document

Type

string

Required

Valid values

"invoices""contract-notes""recurring-invoices""quotes""delivery-notes""credit-notes"

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,

  

  

  

"invoiceDate": "string",

  

  

  

"dueDate": "string",

  

  

  

"deliveryDate": "string",

  

  

  

"paymentInstructions": null,

  

  

  

"pricesIncludeVat": true,

  

  

  

"isVariantInvoice": false,

  

  

  

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

  

  

  

  

}

  

  

  

],

  

  

  

"cashDiscounts": [

  

  

  

  

{

  

  

  

  

  

"days": 0,

  

  

  

  

  

"percentage": 0

  

  

  

  

}

  

  

  

],

  

  

  

"documentDiscount": {

  

  

  

  

"percentage": 0

  

  

  

},

  

  

  

"receiver": null

  

  

}

  

]

}

Responses

Created a preview PDF

Content-Type

application/json

{

  

"data": {

  

  

"previewUrl": "string",

  

  

"downloadUrl": "string",

  

  

"expiresAt": "string"

  

},

  

"status": 201,

  

"message": "string",

  

"meta": {

  

}

}

POST

/accounts/{accountUuid}/documents/v2/{type}/{invoiceUuid}/preview

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

invoiceUuid*

type*

Body

Samples

---

document-delivery-notes

---

Create preview

POST

/accounts/{accountUuid}/documents/v2/{type}/{invoiceUuid}/preview

Creates a new PDF preview for a document or returns the sent PDF if one exists

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

invoiceUuid*

Type

string

Required

Format

"uuid"

type*

Type of the document

Type

string

Required

Valid values

"invoices""contract-notes""recurring-invoices""quotes""delivery-notes""credit-notes"

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,

  

  

  

"invoiceDate": "string",

  

  

  

"dueDate": "string",

  

  

  

"deliveryDate": "string",

  

  

  

"paymentInstructions": null,

  

  

  

"pricesIncludeVat": true,

  

  

  

"isVariantInvoice": false,

  

  

  

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

  

  

  

  

}

  

  

  

],

  

  

  

"cashDiscounts": [

  

  

  

  

{

  

  

  

  

  

"days": 0,

  

  

  

  

  

"percentage": 0

  

  

  

  

}

  

  

  

],

  

  

  

"documentDiscount": {

  

  

  

  

"percentage": 0

  

  

  

},

  

  

  

"receiver": null

  

  

}

  

]

}

Responses

Created a preview PDF

Content-Type

application/json

{

  

"data": {

  

  

"previewUrl": "string",

  

  

"downloadUrl": "string",

  

  

"expiresAt": "string"

  

},

  

"status": 201,

  

"message": "string",

  

"meta": {

  

}

}

POST

/accounts/{accountUuid}/documents/v2/{type}/{invoiceUuid}/preview

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

invoiceUuid*

type*

Body

Samples

---

document-credit-notes

---

Create preview

POST

/accounts/{accountUuid}/documents/v2/{type}/{invoiceUuid}/preview

Creates a new PDF preview for a document or returns the sent PDF if one exists

Authorizations

ApiToken

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

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

invoiceUuid*

Type

string

Required

Format

"uuid"

type*

Type of the document

Type

string

Required

Valid values

"invoices""contract-notes""recurring-invoices""quotes""delivery-notes""credit-notes"

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,

  

  

  

"invoiceDate": "string",

  

  

  

"dueDate": "string",

  

  

  

"deliveryDate": "string",

  

  

  

"paymentInstructions": null,

  

  

  

"pricesIncludeVat": true,

  

  

  

"isVariantInvoice": false,

  

  

  

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

  

  

  

  

}

  

  

  

],

  

  

  

"cashDiscounts": [

  

  

  

  

{

  

  

  

  

  

"days": 0,

  

  

  

  

  

"percentage": 0

  

  

  

  

}

  

  

  

],

  

  

  

"documentDiscount": {

  

  

  

  

"percentage": 0

  

  

  

},

  

  

  

"receiver": null

  

  

}

  

]

}

Responses

Created a preview PDF

Content-Type

application/json

{

  

"data": {

  

  

"previewUrl": "string",

  

  

"downloadUrl": "string",

  

  

"expiresAt": "string"

  

},

  

"status": 201,

  

"message": "string",

  

"meta": {

  

}

}

POST

/accounts/{accountUuid}/documents/v2/{type}/{invoiceUuid}/preview

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

invoiceUuid*

type*

Body

Samples

---