Skip to content

document-invoice-settings​

Manage invoice settings

Operations​

GET/accounts/{accountUuid}/documents/v2/invoices/settings/conditionsPATCH/accounts/{accountUuid}/documents/v2/invoices/settings/conditionsGET/accounts/{accountUuid}/documents/v2/invoices/settings/default-conditionsPATCH/accounts/{accountUuid}/documents/v2/invoices/settings/default-conditionsGET/accounts/{accountUuid}/documents/v2/invoices/settings/dunningsPATCH/accounts/{accountUuid}/documents/v2/invoices/settings/dunningsGET/accounts/{accountUuid}/documents/v2/invoices/settings/payment-slipPATCH/accounts/{accountUuid}/documents/v2/invoices/settings/payment-slipGET/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings/dunning-level-1PATCH/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings/dunning-level-1GET/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings/dunning-level-2PATCH/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings/dunning-level-2GET/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings/dunning-level-3PATCH/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings/dunning-level-3GET/accounts/{accountUuid}/documents/v2/invoices/settings/number-ranges/invoicesPATCH/accounts/{accountUuid}/documents/v2/invoices/settings/number-ranges/invoicesGET/accounts/{accountUuid}/documents/v2/invoices/settings/number-ranges/recurring-invoicesPATCH/accounts/{accountUuid}/documents/v2/invoices/settings/number-ranges/recurring-invoicesGET/accounts/{accountUuid}/documents/v2/invoices/settings/number-ranges/templatesPATCH/accounts/{accountUuid}/documents/v2/invoices/settings/number-ranges/templates

Get invoice payment-condition setting​

GET
/accounts/{accountUuid}/documents/v2/invoices/settings/conditions

Get invoice payment-condition setting

Authorizations​

ApiToken

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

Type
HTTP (bearer)

Parameters​

Path Parameters

accountUuid*
Type
string
Required
Format
"uuid"

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"paymentTerms": 0,
  
  
"paymentConditions": [
  
  
  
{
  
  
  
  
"condition": 0,
  
  
  
  
"amount": 0,
  
  
  
  
"days": 0
  
  
  
}
  
  
]
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​


Update invoice payment-condition setting​

PATCH
/accounts/{accountUuid}/documents/v2/invoices/settings/conditions

Update invoice payment-condition setting

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
JSON
{
  
"paymentTerms": 0,
  
"paymentConditions": [
  
  
{
  
  
  
"condition": 0,
  
  
  
"amount": 0,
  
  
  
"days": 0
  
  
}
  
]
}

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"paymentTerms": 0,
  
  
"paymentConditions": [
  
  
  
{
  
  
  
  
"condition": 0,
  
  
  
  
"amount": 0,
  
  
  
  
"days": 0
  
  
  
}
  
  
]
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Get invoice default-condition settings​

GET
/accounts/{accountUuid}/documents/v2/invoices/settings/default-conditions

Get invoice default-condition settings

Authorizations​

ApiToken

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

Type
HTTP (bearer)

Parameters​

Path Parameters

accountUuid*
Type
string
Required
Format
"uuid"

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"de": {
  
  
  
"defaultConditions": "string"
  
  
},
  
  
"en": {
  
  
  
"defaultConditions": "string"
  
  
},
  
  
"fr": {
  
  
  
"defaultConditions": "string"
  
  
},
  
  
"it": {
  
  
  
"defaultConditions": "string"
  
  
}
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​


Update invoice default-condition settings​

PATCH
/accounts/{accountUuid}/documents/v2/invoices/settings/default-conditions

Update invoice default-condition settings

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
JSON
{
  
"de": {
  
  
"defaultConditions": "string"
  
},
  
"en": {
  
  
"defaultConditions": "string"
  
},
  
"fr": {
  
  
"defaultConditions": "string"
  
},
  
"it": {
  
  
"defaultConditions": "string"
  
}
}

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"de": {
  
  
  
"defaultConditions": "string"
  
  
},
  
  
"en": {
  
  
  
"defaultConditions": "string"
  
  
},
  
  
"fr": {
  
  
  
"defaultConditions": "string"
  
  
},
  
  
"it": {
  
  
  
"defaultConditions": "string"
  
  
}
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Get Dunning Settings​

GET
/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings

Returns all dunning settings

Authorizations​

ApiToken

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

Type
HTTP (bearer)

Parameters​

Path Parameters

accountUuid*
Type
string
Required
Format
"uuid"

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"enableDunning": true,
  
  
"enableDunningAmount": true,
  
  
"dunningType": 0,
  
  
"dunningLevel1": {
  
  
  
"isEnabled": true,
  
  
  
"numberOfDays": 0,
  
  
  
"direction": 0,
  
  
  
"field": 0,
  
  
  
"dunningAmount": 0,
  
  
  
"isPrintActive": true,
  
  
  
"translations": {
  
  
  
  
"de": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"en": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"fr": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"it": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
}
  
  
  
}
  
  
},
  
  
"dunningLevel2": {
  
  
  
"isEnabled": true,
  
  
  
"numberOfDays": 0,
  
  
  
"direction": 0,
  
  
  
"field": 0,
  
  
  
"dunningAmount": 0,
  
  
  
"isPrintActive": true,
  
  
  
"translations": {
  
  
  
  
"de": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"en": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"fr": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"it": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
}
  
  
  
}
  
  
},
  
  
"dunningLevel3": {
  
  
  
"isEnabled": true,
  
  
  
"numberOfDays": 0,
  
  
  
"direction": 0,
  
  
  
"field": 0,
  
  
  
"dunningAmount": 0,
  
  
  
"isPrintActive": true,
  
  
  
"translations": {
  
  
  
  
"de": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"en": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"fr": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"it": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
}
  
  
  
}
  
  
}
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​


Update Dunning Settings​

PATCH
/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings

Updates the accounts dunning settings

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
JSON
{
  
"enableDunning": true,
  
"enableDunningAmount": true,
  
"dunningType": 0,
  
"dunningLevel1": {
  
  
"isEnabled": true,
  
  
"numberOfDays": 0,
  
  
"direction": 0,
  
  
"field": 0,
  
  
"dunningAmount": 0,
  
  
"isPrintActive": true,
  
  
"translations": {
  
  
  
"de": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"en": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"fr": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"it": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
}
  
  
}
  
},
  
"dunningLevel2": {
  
  
"isEnabled": true,
  
  
"numberOfDays": 0,
  
  
"direction": 0,
  
  
"field": 0,
  
  
"dunningAmount": 0,
  
  
"isPrintActive": true,
  
  
"translations": {
  
  
  
"de": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"en": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"fr": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"it": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
}
  
  
}
  
},
  
"dunningLevel3": {
  
  
"isEnabled": true,
  
  
"numberOfDays": 0,
  
  
"direction": 0,
  
  
"field": 0,
  
  
"dunningAmount": 0,
  
  
"isPrintActive": true,
  
  
"translations": {
  
  
  
"de": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"en": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"fr": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"it": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
}
  
  
}
  
}
}

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"enableDunning": true,
  
  
"enableDunningAmount": true,
  
  
"dunningType": 0,
  
  
"dunningLevel1": {
  
  
  
"isEnabled": true,
  
  
  
"numberOfDays": 0,
  
  
  
"direction": 0,
  
  
  
"field": 0,
  
  
  
"dunningAmount": 0,
  
  
  
"isPrintActive": true,
  
  
  
"translations": {
  
  
  
  
"de": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"en": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"fr": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"it": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
}
  
  
  
}
  
  
},
  
  
"dunningLevel2": {
  
  
  
"isEnabled": true,
  
  
  
"numberOfDays": 0,
  
  
  
"direction": 0,
  
  
  
"field": 0,
  
  
  
"dunningAmount": 0,
  
  
  
"isPrintActive": true,
  
  
  
"translations": {
  
  
  
  
"de": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"en": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"fr": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"it": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
}
  
  
  
}
  
  
},
  
  
"dunningLevel3": {
  
  
  
"isEnabled": true,
  
  
  
"numberOfDays": 0,
  
  
  
"direction": 0,
  
  
  
"field": 0,
  
  
  
"dunningAmount": 0,
  
  
  
"isPrintActive": true,
  
  
  
"translations": {
  
  
  
  
"de": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"en": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"fr": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
},
  
  
  
  
"it": {
  
  
  
  
  
"emailSubject": "string",
  
  
  
  
  
"emailTemplate": "string",
  
  
  
  
  
"dunningLetter": "string",
  
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
  
}
  
  
  
}
  
  
}
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Get payment slip settings​

GET
/accounts/{accountUuid}/documents/v2/invoices/settings/payment-slip

Get invoices payment slip settings

Authorizations​

ApiToken

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

Type
HTTP (bearer)

Parameters​

Path Parameters

accountUuid*
Type
string
Required
Format
"uuid"

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"newPage": true,
  
  
"showAmount": true,
  
  
"addAdditionalProcedures": true,
  
  
"additionalProcedures1": "string",
  
  
"additionalProcedures2": "string",
  
  
"enableAdvertisementImage": true
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​


Update payment slip settings​

PATCH
/accounts/{accountUuid}/documents/v2/invoices/settings/payment-slip

Update invoices payment slip settings

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
JSON
{
  
"newPage": true,
  
"showAmount": true,
  
"addAdditionalProcedures": true,
  
"additionalProcedures1": "string",
  
"additionalProcedures2": "string",
  
"enableAdvertisementImage": true
}

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"newPage": true,
  
  
"showAmount": true,
  
  
"addAdditionalProcedures": true,
  
  
"additionalProcedures1": "string",
  
  
"additionalProcedures2": "string",
  
  
"enableAdvertisementImage": true
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Get First Dunning Settings​

GET
/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings/dunning-level-1

Returns the first dunning settings

Authorizations​

ApiToken

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

Type
HTTP (bearer)

Parameters​

Path Parameters

accountUuid*
Type
string
Required
Format
"uuid"

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"isEnabled": true,
  
  
"numberOfDays": 0,
  
  
"direction": 0,
  
  
"field": 0,
  
  
"dunningAmount": 0,
  
  
"isPrintActive": true,
  
  
"translations": {
  
  
  
"de": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"en": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"fr": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"it": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
}
  
  
}
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​


Update First Dunning Settings​

PATCH
/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings/dunning-level-1

Updates the first dunning settings

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
JSON
{
  
"isEnabled": true,
  
"numberOfDays": 0,
  
"direction": 0,
  
"field": 0,
  
"dunningAmount": 0,
  
"isPrintActive": true,
  
"translations": {
  
  
"de": {
  
  
  
"emailSubject": "string",
  
  
  
"emailTemplate": "string",
  
  
  
"dunningLetter": "string",
  
  
  
"dunningAmountLabel": "string"
  
  
},
  
  
"en": {
  
  
  
"emailSubject": "string",
  
  
  
"emailTemplate": "string",
  
  
  
"dunningLetter": "string",
  
  
  
"dunningAmountLabel": "string"
  
  
},
  
  
"fr": {
  
  
  
"emailSubject": "string",
  
  
  
"emailTemplate": "string",
  
  
  
"dunningLetter": "string",
  
  
  
"dunningAmountLabel": "string"
  
  
},
  
  
"it": {
  
  
  
"emailSubject": "string",
  
  
  
"emailTemplate": "string",
  
  
  
"dunningLetter": "string",
  
  
  
"dunningAmountLabel": "string"
  
  
}
  
}
}

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"isEnabled": true,
  
  
"numberOfDays": 0,
  
  
"direction": 0,
  
  
"field": 0,
  
  
"dunningAmount": 0,
  
  
"isPrintActive": true,
  
  
"translations": {
  
  
  
"de": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"en": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"fr": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"it": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
}
  
  
}
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Get Second Dunning Settings​

GET
/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings/dunning-level-2

Returns the second dunning settings

Authorizations​

ApiToken

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

Type
HTTP (bearer)

Parameters​

Path Parameters

accountUuid*
Type
string
Required
Format
"uuid"

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"isEnabled": true,
  
  
"numberOfDays": 0,
  
  
"direction": 0,
  
  
"field": 0,
  
  
"dunningAmount": 0,
  
  
"isPrintActive": true,
  
  
"translations": {
  
  
  
"de": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"en": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"fr": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"it": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
}
  
  
}
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​


Update Second Dunning Settings​

PATCH
/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings/dunning-level-2

Updates the second dunning settings

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
JSON
{
  
"isEnabled": true,
  
"numberOfDays": 0,
  
"direction": 0,
  
"field": 0,
  
"dunningAmount": 0,
  
"isPrintActive": true,
  
"translations": {
  
  
"de": {
  
  
  
"emailSubject": "string",
  
  
  
"emailTemplate": "string",
  
  
  
"dunningLetter": "string",
  
  
  
"dunningAmountLabel": "string"
  
  
},
  
  
"en": {
  
  
  
"emailSubject": "string",
  
  
  
"emailTemplate": "string",
  
  
  
"dunningLetter": "string",
  
  
  
"dunningAmountLabel": "string"
  
  
},
  
  
"fr": {
  
  
  
"emailSubject": "string",
  
  
  
"emailTemplate": "string",
  
  
  
"dunningLetter": "string",
  
  
  
"dunningAmountLabel": "string"
  
  
},
  
  
"it": {
  
  
  
"emailSubject": "string",
  
  
  
"emailTemplate": "string",
  
  
  
"dunningLetter": "string",
  
  
  
"dunningAmountLabel": "string"
  
  
}
  
}
}

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"isEnabled": true,
  
  
"numberOfDays": 0,
  
  
"direction": 0,
  
  
"field": 0,
  
  
"dunningAmount": 0,
  
  
"isPrintActive": true,
  
  
"translations": {
  
  
  
"de": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"en": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"fr": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"it": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
}
  
  
}
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Get Third Dunning Settings​

GET
/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings/dunning-level-3

Returns the third dunning settings

Authorizations​

ApiToken

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

Type
HTTP (bearer)

Parameters​

Path Parameters

accountUuid*
Type
string
Required
Format
"uuid"

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"isEnabled": true,
  
  
"numberOfDays": 0,
  
  
"direction": 0,
  
  
"field": 0,
  
  
"dunningAmount": 0,
  
  
"isPrintActive": true,
  
  
"translations": {
  
  
  
"de": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"en": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"fr": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"it": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
}
  
  
}
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​


Update Third Dunning Settings​

PATCH
/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings/dunning-level-3

Updates the third dunning settings

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
JSON
{
  
"isEnabled": true,
  
"numberOfDays": 0,
  
"direction": 0,
  
"field": 0,
  
"dunningAmount": 0,
  
"isPrintActive": true,
  
"translations": {
  
  
"de": {
  
  
  
"emailSubject": "string",
  
  
  
"emailTemplate": "string",
  
  
  
"dunningLetter": "string",
  
  
  
"dunningAmountLabel": "string"
  
  
},
  
  
"en": {
  
  
  
"emailSubject": "string",
  
  
  
"emailTemplate": "string",
  
  
  
"dunningLetter": "string",
  
  
  
"dunningAmountLabel": "string"
  
  
},
  
  
"fr": {
  
  
  
"emailSubject": "string",
  
  
  
"emailTemplate": "string",
  
  
  
"dunningLetter": "string",
  
  
  
"dunningAmountLabel": "string"
  
  
},
  
  
"it": {
  
  
  
"emailSubject": "string",
  
  
  
"emailTemplate": "string",
  
  
  
"dunningLetter": "string",
  
  
  
"dunningAmountLabel": "string"
  
  
}
  
}
}

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"isEnabled": true,
  
  
"numberOfDays": 0,
  
  
"direction": 0,
  
  
"field": 0,
  
  
"dunningAmount": 0,
  
  
"isPrintActive": true,
  
  
"translations": {
  
  
  
"de": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"en": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"fr": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
},
  
  
  
"it": {
  
  
  
  
"emailSubject": "string",
  
  
  
  
"emailTemplate": "string",
  
  
  
  
"dunningLetter": "string",
  
  
  
  
"dunningAmountLabel": "string"
  
  
  
}
  
  
}
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Get invoice number range settings​

GET
/accounts/{accountUuid}/documents/v2/invoices/settings/number-ranges/invoices

Get invoice number range settings

Authorizations​

ApiToken

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

Type
HTTP (bearer)

Parameters​

Path Parameters

accountUuid*
Type
string
Required
Format
"uuid"

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"counter": 0,
  
  
"pattern": "string",
  
  
"padding": 0
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​


Update invoice number range settings​

PATCH
/accounts/{accountUuid}/documents/v2/invoices/settings/number-ranges/invoices

Update invoice number range settings

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
JSON
{
  
"counter": 0,
  
"pattern": "string",
  
"padding": 0
}

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"counter": 0,
  
  
"pattern": "string",
  
  
"padding": 0
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Get recurring invoice number range settings​

GET
/accounts/{accountUuid}/documents/v2/invoices/settings/number-ranges/recurring-invoices

Get recurring invoice number range settings

Authorizations​

ApiToken

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

Type
HTTP (bearer)

Parameters​

Path Parameters

accountUuid*
Type
string
Required
Format
"uuid"

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"counter": 0,
  
  
"pattern": "string",
  
  
"padding": 0
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​


Update recurring invoice number range settings​

PATCH
/accounts/{accountUuid}/documents/v2/invoices/settings/number-ranges/recurring-invoices

Update recurring invoice number range settings

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
JSON
{
  
"counter": 0,
  
"pattern": "string",
  
"padding": 0
}

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"counter": 0,
  
  
"pattern": "string",
  
  
"padding": 0
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Get invoice template number range settings​

GET
/accounts/{accountUuid}/documents/v2/invoices/settings/number-ranges/templates

Get invoice template number range settings

Authorizations​

ApiToken

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

Type
HTTP (bearer)

Parameters​

Path Parameters

accountUuid*
Type
string
Required
Format
"uuid"

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"counter": 0,
  
  
"pattern": "string",
  
  
"padding": 0
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​


Update invoice template number range settings​

PATCH
/accounts/{accountUuid}/documents/v2/invoices/settings/number-ranges/templates

Update invoice template number range settings

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
JSON
{
  
"counter": 0,
  
"pattern": "string",
  
"padding": 0
}

Responses​

Successful response

application/json
JSON
{
  
"data": {
  
  
"counter": 0,
  
  
"pattern": "string",
  
  
"padding": 0
  
},
  
"message": "string",
  
"status": 200,
  
"meta": {
  
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​