Scrada
API docs by Redocly

Scrada API V1 (1.14)

E-mail: info@scrada.be

Introduction

This API document describes the Scrada API.

Changelog

1.14

  • Journal returns MinimumPossibleLineDate and MaximumPossibleLineDate.
  • Journal has a setting AllowMultipleEntries.
  • Cash book returns MinimumPossibleLineDate and MaximumPossibleLineDate.

1.13

  • Journal AddFiguresApi has a new option 5.

1.12

  • Company invoice extended with InvoiceSend, PartyLanguageCode, PartyTaxNumberType, PartyTaxNumber, and PartyGlnNumber.
  • Company invoice support payment method 1 Unknown, 9 Debit Card.

1.11

  • Add cash book lines extended with optional properties ExternalReference and ExternalData.

1.10

  • Add invoice lines extended with AccountingAnalytical1 till AccountingAnalytical5.
  • Add lines to the journal response extended with Message.

1.9

  • Company invoice PartyAccountingCode added.
  • Company invoice line AccountingGeneralLedger added.

1.8

  • Company invoice VAT types added.

1.7

  • Add AllowMultiple to Payment method.

1.6

  • Company invoices added.
  • Add lines to the journal extended with InvoiceID, InvoiceReference ExternalReference and ExternalData.

1.5

  • Cash book, Company, VAT period and Journal API's added.

1.4

  • Extended add lines to the cash book with additional (optional) fields.

1.3

  • Minor fixes.

1.2

  • Add lines to the cash book added.

Environments

Test environment:

Production environment:

Authentication

api_key

Authentication on the Scrada API is handled using API keys. The API Key and corresponding password are added to every request on the API using the following header keys:

  • X-API-KEY
  • X-PASSWORD

The API key and password are unique for each company in Scrada.

To obtain an API key go to the Scrada web client. In the menu go to 'Settings' > 'API Keys'.

API Keys

Here you can either create an API Key or see existing API keys of your company.

Data formats

The Scrada API expects data in the following way.

Data type Expected format Example
Number Use a . [dot] as decimal separator.
If not specified max. 2 numbers after the decimal separator.		 3.55
Date yyyy-mm-dd 2022-12-31

Localization

The API is, like the Scrada Mobile app and web client, multilingual. To change the response language you can set the header key Language, the following values can be used:

Value Language
EN English
NL Dutch
FR French

English will be used when no language key is provided.

Examples

Add daily receipt and invoice payment

This examples show how you can add invoices in Scrada and add a payment to one invoice.

1. Add the invoice

Add an invoice in Scrada by using the Add invoice API.

https://api.scrada.be/v1/company/{companyID}/invoice

Fore more information about this API call go to the Invoice > 'Add invoice' section.

{
  "bookYear": "2023",
  "journal": "Store1",
  "number": "123",
  "type": 1,
  "creditInvoice": false,
  "invoiceDate": "2023-01-01",
  "invoiceExpiryDate": "2023-01-08",
  "partyCode": "CUST01",
  "partyName": "Customer 01",
  "partyStreet": "Customer street",
  "partyStreetNumber": "1",
  "partyCity": "Fropus",
  "partyZipCode": "1000",
  "partyCountryCode": "BE",
  "totalInclVat": 200.00,
  "totalVat": 34.71,
  "totalExclVat": 165.29,
  "payableRoundingAmount": 0,
  "comment": "",
  "lines": [
    {
      "lineNumber": "1",
      "itemName": "Demo item",
      "quantity": 1,
      "unitType": 1,
      "itemExclVat": 165.29,
      "vatType": 1,
      "vatPerc": 21,
      "totalDiscountExclVat": 0,
      "totalExclVat": 165.29,
      "totalVat": 34.71
    }
  ],
  "paymentMethods": [
    {
      "paymentType": 9,
      "paymentReference": "+++022/0126/70950+++",
      "name": "Bancontact",
      "totalPaid": 0,
      "totalToPay": 200
    }
  ]
}

This will return a GUID, for example cac6315f-ef7a-4405-b1cf-1ccccc2cc007. We will use this GUID in the next step to add a payment to the invoice.

2. Add journal lines

Now we will add €500,00 of dailyreceipts to the journal, of which €400,00 was paid by Bancontact and €100,00 cash, and add a payment of €200,00 paid by Bancontact to the invoice we created in step 1. We add the lines using the Add lines to the journal API.

https://api.scrada.be/v1/company/{companyID}/journal/{journalID}/lines

{
  "date": "2023-01-01",
  "lastJournalLineID": "{lastJournalLineID}", // Optional GUID from your previous add journal lines call
  "lines": [
    {
      "lineType": 1,
      "vatTypeID": "8424d909-78b9-483c-9b1d-4584fb537846",
      "vatPerc": 21,
      "amount": 500,
      "categoryID": "{categoryID}", // 21% VAT category
      "externalReference": "", // Additional reference from your system
      "externalData": "" // Additional information from your system like receipts numbers and their individual amounts
    }
  ],
  "paymentMethods": [
    {
      "paymentMethodID": "{paymentMethodID}", // Bancontact payment method ID
      "amount": 600.00, // Total received 600.00 by Bancontact
      "remark": "",
      "externalReference": "", // Additional reference from your system
      "externalData": "" // Additional information from your system like receipts numbers and their individual amounts
    },
    {
      "paymentMethodID": "{paymentMethodID}", // Cash payment method ID
      "amount": 100.00, // Received 100.00 cash
      "remark": "",
      "externalReference": "", // Additional reference from your system
      "externalData": "" // Additional information from your system like receipts numbers and their individual amounts
    },
    {
      "paymentMethodID": "{paymentMethodID}",  // Invoice payed payment method ID
      "amount": -200.00, // Deduct paid invoice amount
      "remark": "string",
      "invoiceID": "cac6315f-ef7a-4405-b1cf-1ccccc2cc007", // GUID of the invoice created in step 1
      "invoiceReference": "+++022/0126/70950+++", // Optional invoice reference, when invoiceID is provided Scrada will add a payment reference if provided on the invoice
      "externalReference": "", // Additional reference from your system
      "externalData": "" // Additional information from your system like receipts number and its amount
    }
  ]
}

This will return a GUID for the journalLInes, the last journalLines GUID can be used in your next add journal lines call lastJournalLineID.

Add line

Add lines to the cash book

Add new transaction lines to a cash book.
To obtain the current (/start) balance get the current cash book object (Get cash book function) and use the 'currentBalance' field.

path Parameters
companyID
required
string <uuid>
cashBookID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:
date
required
string <date>

The transaction date.

startBalance
required
number <double>

The current cash book balance. Max precision is 2.

required
Array of objects (v1.CashBookAddLineModel)

The transaction lines to add in the cash book.

endBalance
required
number <double>

The cash book balance after the provided line transactions. Max precision is 2.

Responses

Request samples

Content type
{
  • "date": "2019-08-24",
  • "startBalance": 0,
  • "lines": [
    ],
  • "endBalance": 0
}

Response samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Add lines to the journal

Add new transaction lines to a daily receipts book.
To obtain the last journal line ID get the current journal object (Get journal function) and use the 'lastLineID' field.
The rules that are defined on VAT category or Payment method are also applied when using the API. This means that if configured that a payment method/VAT category must be positive that also the values in the API must be positive. If configured that it must be positive but the value is negative then there will be an error.
It is not always required to have payment methods. More information can be found on the 'PaymentMethods' property.

Remark: In case of a correction all lines must be of type Correction and also the remark of all lines must be the same.

path Parameters
companyID
required
string <uuid>
journalID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:
date
required
string <date>

The transaction date.

lastJournalLineID
string or null <uuid>

Optional the GUID ID of the last entered line. When provided a check will be performed to verify that this was indeed the last created line ID.

required
Array of objects (v1.AddJournalLineModel)

The lines to add in the journal.

Array of objects or null (v1.AddJournalPaymentMethodModel)

How the daily receipts are paid.
The sum of the amounts of the payment methods must be the same as the sum of the amounts of the lines.

If the journal is not linked to a cash book then the payment methods must be blanc.
If a journal is linked to a cash book but the journal is configured that payment methods are booked as proposal then it is not required to fill in the payment methods. In all other cases the payments must be set.

A certain payment method can only be used multiple times in this list if configured on the payment method that this is allowed!

On payment method several requirements can be active like remark required or not, amount can be positive, ... This can be configured on the payment method itself. It is checked both when entering manual data or when using the API.

Responses

Request samples

Content type
{
  • "date": "2019-08-24",
  • "lastJournalLineID": "3c22b09b-1d1a-4ef4-9f78-9d83f56e0b7a",
  • "lines": [
    ],
  • "paymentMethods": [
    ]
}

Response samples

Content type
application/json
{
  • "journalLines": [
    ],
  • "cashBookLines": [
    ],
  • "message": {
    }
}

Cash book

Get all cash books

Get all cash books belonging to this company.

path Parameters
companyID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create cash book

Add a new cash book.

path Parameters
companyID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:
active
boolean or null

Show the cash book in the dashboard.

name
required
string

The cash book name.

startDate
required
string or null <date-time>

The start date.

endDate
string or null <date-time>

The closing date.

startBalance
number or null <double>

The start balance.

warnBalanceTooHigh
number or null <double>

Optional warning level for high balance.

codaFileType
integer <int32> (v1.CashBookFormatType)
Enum: 1 2

The CODA format.

  • 1: Only lines
  • 2: Lines and payment methods
codaGenerationPeriodType
integer <int32> (v1.CashBookCodaGenerationPeriodType)
Enum: 1 2 3

The CODA generation period.

  • 1: Every day
  • 2: Every week
  • 3: Every month
codaGenerationStartWeekDay
integer <int32> (v1.CashBookCodaGenerationDayOfWeek)
Enum: 0 1 2 3 4 5 6

Day of the week to generate CODA file.

  • 0: Sunday
  • 1: Monday
  • 2: Tuesday
  • 3: Wednesday
  • 4: Thursday
  • 5: Friday
  • 6: Saturday
allowEntryAfterCoda
boolean or null

Allow entries in the cash book after a CODA file has been generated. Only applicable when the cash book is linked to a journal.

addPaymentReference
boolean or null

Add journal payment reference to CODA files.

Responses

Request samples

Content type
{
  • "active": true,
  • "name": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "startBalance": 0,
  • "warnBalanceTooHigh": 0,
  • "codaFileType": 1,
  • "codaGenerationPeriodType": 1,
  • "codaGenerationStartWeekDay": 0,
  • "allowEntryAfterCoda": true,
  • "addPaymentReference": true
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Get cash book

Get the specified cash book.

path Parameters
companyID
required
string <uuid>
cashBookID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "active": true,
  • "name": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "iban": "string",
  • "startBalance": 0,
  • "currentBalance": 0,
  • "lastLineDate": "2019-08-24T14:15:22Z",
  • "warnBalanceTooHigh": 0,
  • "codaFileType": 1,
  • "codaGenerationPeriodType": 1,
  • "codaGenerationStartWeekDay": 0,
  • "allowEntryAfterCoda": true,
  • "addPaymentReference": true,
  • "invoicedTill": "2019-08-24T14:15:22Z",
  • "paidTill": "2019-08-24T14:15:22Z",
  • "minimumPossibleLineDate": "2019-08-24T14:15:22Z",
  • "maximumPossibleLineDate": "2019-08-24T14:15:22Z"
}

Update cash book

Update an existing cash book.
If a property of the cash book is set null or a property is missing then the system assumes that this property must keep its original value. Only in case of property endDate, if this property is missing or has has value null, the system assumes that it has value null.

path Parameters
companyID
required
string <uuid>
cashBookID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:
active
boolean or null

Show the cash book in the dashboard.

name
required
string

The cash book name.

startDate
required
string or null <date-time>

The start date.

endDate
string or null <date-time>

The closing date.

startBalance
number or null <double>

The start balance.

warnBalanceTooHigh
number or null <double>

Optional warning level for high balance.

codaFileType
integer <int32> (v1.CashBookFormatType)
Enum: 1 2

The CODA format.

  • 1: Only lines
  • 2: Lines and payment methods
codaGenerationPeriodType
integer <int32> (v1.CashBookCodaGenerationPeriodType)
Enum: 1 2 3

The CODA generation period.

  • 1: Every day
  • 2: Every week
  • 3: Every month
codaGenerationStartWeekDay
integer <int32> (v1.CashBookCodaGenerationDayOfWeek)
Enum: 0 1 2 3 4 5 6

Day of the week to generate CODA file.

  • 0: Sunday
  • 1: Monday
  • 2: Tuesday
  • 3: Wednesday
  • 4: Thursday
  • 5: Friday
  • 6: Saturday
allowEntryAfterCoda
boolean or null

Allow entries in the cash book after a CODA file has been generated. Only applicable when the cash book is linked to a journal.

addPaymentReference
boolean or null

Add journal payment reference to CODA files.

Responses

Request samples

Content type
{
  • "active": true,
  • "name": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "startBalance": 0,
  • "warnBalanceTooHigh": 0,
  • "codaFileType": 1,
  • "codaGenerationPeriodType": 1,
  • "codaGenerationStartWeekDay": 0,
  • "allowEntryAfterCoda": true,
  • "addPaymentReference": true
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "defaultFormat": "string",
  • "innerErrors": [
    ]
}

Link journal to cash book

Link an existing journal to an existing cash book. To remove an existing link between a journal and cashbook set the cash book ID to NULL.
When experiencing unsupported media type errors with the cash book ID (body) NULL add a 'Content-Type' header with value application/json.

path Parameters
companyID
required
string <uuid>
journalID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:

The cash book ID or NULL to remove the link.

string <uuid>

Responses

Request samples

Content type
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "defaultFormat": "string",
  • "innerErrors": [
    ]
}

Transaction type

Get all transaction types

Get all transaction types belonging to this cash book.

path Parameters
companyID
required
string <uuid>
cashBookID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create transaction type

Add a new cash book transaction type. New transaction types must have line type 14 (Own / custom).

path Parameters
companyID
required
string <uuid>
cashBookID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:
nameNL
required
string or null <= 200 characters

The Dutch Transaction Type name.

nameEN
required
string or null <= 200 characters

The English Transaction Type name.

nameFR
required
string or null <= 200 characters

The French Transaction Type name.

nameDE
required
string or null <= 200 characters

The German Transaction Type name.

position
integer or null <int32>

The sorting position. Lowest is shown first.

inputType
integer <int32> (v1.CashBookTransactionTypeInputType)
Enum: 1 2 3 4

The input visibility.

  • 1: Not visible
  • 2: Only receive
  • 3: Only expense
  • 4: Receive or expense
lineType
integer or null <int32> (v1.CashBookTransactionTypeLineType)
Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14

Transaction type of this line. Use either this line type or use the TransactionTypeID, not supported for custom transaction types.

  • 1: Private take
  • 2: Private deposit
  • 3: Customer
  • 4: Supplier
  • 5: Transfer bank to cash
  • 6: Transfer cash to bank
  • 7: Cost
  • 8: Cash difference
  • 9: Daily receipts cash (Only allowed when no journal is linked)
  • 12: Transfer cash to cash in
  • 13: Transfer cash to cash out
  • 14: Own/ custom type (Requires TransactionTypeID)
commentType
integer <int32> (v1.CashBookTransactionTypeCommentType)
Enum: 2 3

The comment visibility.

  • 2: Optional
  • 3: Required

Responses

Request samples

Content type
{
  • "nameNL": "string",
  • "nameEN": "string",
  • "nameFR": "string",
  • "nameDE": "string",
  • "position": 0,
  • "inputType": 1,
  • "lineType": 1,
  • "commentType": 2
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Get transaction type

Get the specified cash book transaction type.

path Parameters
companyID
required
string <uuid>
cashBookID
required
string <uuid>
transactionTypeID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "nameNL": "string",
  • "nameEN": "string",
  • "nameFR": "string",
  • "nameDE": "string",
  • "position": 0,
  • "inputType": 1,
  • "lineType": 1,
  • "commentType": 2
}

Update transaction type

Update an existing cash book transaction type.
If a property of the transaction type is set null or a property is missing then the system assumes that this property must keep its original value.

path Parameters
companyID
required
string <uuid>
cashBookID
required
string <uuid>
transactionTypeID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:
nameNL
required
string or null <= 200 characters

The Dutch Transaction Type name.

nameEN
required
string or null <= 200 characters

The English Transaction Type name.

nameFR
required
string or null <= 200 characters

The French Transaction Type name.

nameDE
required
string or null <= 200 characters

The German Transaction Type name.

position
integer or null <int32>

The sorting position. Lowest is shown first.

inputType
integer <int32> (v1.CashBookTransactionTypeInputType)
Enum: 1 2 3 4

The input visibility.

  • 1: Not visible
  • 2: Only receive
  • 3: Only expense
  • 4: Receive or expense
lineType
integer or null <int32> (v1.CashBookTransactionTypeLineType)
Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14

Transaction type of this line. Use either this line type or use the TransactionTypeID, not supported for custom transaction types.

  • 1: Private take
  • 2: Private deposit
  • 3: Customer
  • 4: Supplier
  • 5: Transfer bank to cash
  • 6: Transfer cash to bank
  • 7: Cost
  • 8: Cash difference
  • 9: Daily receipts cash (Only allowed when no journal is linked)
  • 12: Transfer cash to cash in
  • 13: Transfer cash to cash out
  • 14: Own/ custom type (Requires TransactionTypeID)
commentType
integer <int32> (v1.CashBookTransactionTypeCommentType)
Enum: 2 3

The comment visibility.

  • 2: Optional
  • 3: Required

Responses

Request samples

Content type
{
  • "nameNL": "string",
  • "nameEN": "string",
  • "nameFR": "string",
  • "nameDE": "string",
  • "position": 0,
  • "inputType": 1,
  • "lineType": 1,
  • "commentType": 2
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "defaultFormat": "string",
  • "innerErrors": [
    ]
}

Company

Get company

Get the specified company.

path Parameters
companyID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "active": true,
  • "code": "string",
  • "name": "string",
  • "email": "user@example.com",
  • "street": "string",
  • "zipCode": "string",
  • "city": "string",
  • "countryID": "bd19ff8d-7ba1-4038-b160-c71803bc9bc0",
  • "vatNumber": "string",
  • "phone": "string",
  • "reportLanguageID": "f0f88c39-5cb3-4c3b-8d00-177eb738f7cf",
  • "invoiceInfo": 1,
  • "invoiceEmail": "user@example.com",
  • "invoiceStreet": "string",
  • "invoiceZipCode": "string",
  • "invoiceCity": "string",
  • "invoiceCountryID": "df13d8e7-0987-43f4-9448-3817f1e4d0d2",
  • "invoiceCompanyID": "27187182-1800-43a1-b0c3-e0debbc31c79"
}

Update company

Update an existing company.
If a property of the company is set null or a property is missing then the system assumes that this property must keep its original value.

path Parameters
companyID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:
active
boolean or null

Show the company in the company overview screen.

code
string or null <= 200 characters

The company code. Is used by Scrada as parameter in emails or integrations

name
required
string or null <= 200 characters

The company name.

email
required
string or null <email> <= 250 characters

The company email.

street
required
string or null <= 1000 characters

The company street.

zipCode
required
string or null <= 50 characters

The company ZIP code.

city
required
string or null <= 250 characters

The company city.

countryID
required
string or null <uuid>

The company country ID.

  • 12b741b9-c0ad-42b5-8471-e720763f3227: België/Belgique
  • 97e88925-b346-4b76-b671-ef1cf7d68733: Nederland
  • 74a68d03-8c08-4074-a41e-59d830024344: France
  • 597fde4e-a4db-42ac-99e1-af3962bbffa4: Deutschland
vatNumber
string or null <= 30 characters

The company VAT number.

phone
required
string or null <tel> <= 50 characters

The company phone number.

reportLanguageID
required
string or null <uuid>

The language ID in which language the company reports (like daily receipt invoice) need to be generated in.

  • e1e8395c-35b3-4282-89db-3feeaacc23bd: Nederlands (nl-BE)
  • 5300381e-f434-4e01-a1f8-53e7676d4cac: Français (fr-BE)
  • 68f89f67-b153-43e6-b9a6-f8d73b56a67a: English (en-US)
invoiceInfo
required
integer <int32> (v1.CompanyInvoiceInfo)
Enum: 1 2 3

The invoice information to use.

  • 1: Company address
  • 2: Invoice address
  • 3: Other company information
invoiceEmail
string or null <email> <= 250 characters

The email address to receive the invoices on. If not provided the invoice will be send to the company email. Not applicable when 'invoiceInfo' is set to 3.

invoiceStreet
string or null <= 1000 characters

The invoice street. Only applicable when 'invoiceInfo' is set to 2.

invoiceZipCode
string or null <= 50 characters

The invoice ZIP code. Only applicable when 'invoiceInfo' is set to 2.

invoiceCity
string or null <= 250 characters

The invoice city. Only applicable when 'invoiceInfo' is set to 2.

invoiceCountryID
string or null <uuid>

The invoice country ID. Only applicable when 'invoiceInfo' is set to 2.

  • 12b741b9-c0ad-42b5-8471-e720763f3227: België/Belgique
  • 97e88925-b346-4b76-b671-ef1cf7d68733: Nederland
  • 74a68d03-8c08-4074-a41e-59d830024344: France
  • 597fde4e-a4db-42ac-99e1-af3962bbffa4: Deutschland
invoiceCompanyID
string or null <uuid>

The company ID to which the invoice need to be send. Only applicable when 'invoiceInfo' is set to 3.
Remark: To set a different invoice company the user needs to have access rights to both companies. The API credentials only provide access to a single company, it is therefore not possible to change this setting using the external API.

Responses

Request samples

Content type
{
  • "active": true,
  • "code": "string",
  • "name": "string",
  • "email": "user@example.com",
  • "street": "string",
  • "zipCode": "string",
  • "city": "string",
  • "countryID": "bd19ff8d-7ba1-4038-b160-c71803bc9bc0",
  • "vatNumber": "string",
  • "phone": "string",
  • "reportLanguageID": "f0f88c39-5cb3-4c3b-8d00-177eb738f7cf",
  • "invoiceInfo": 1,
  • "invoiceEmail": "user@example.com",
  • "invoiceStreet": "string",
  • "invoiceZipCode": "string",
  • "invoiceCity": "string",
  • "invoiceCountryID": "df13d8e7-0987-43f4-9448-3817f1e4d0d2",
  • "invoiceCompanyID": "27187182-1800-43a1-b0c3-e0debbc31c79"
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "defaultFormat": "string",
  • "innerErrors": [
    ]
}

Invoice

Add invoice

Add a new sales/purchase invoice.
For a sales invoice the party references to the customer.
For a purchase invoice the party references the supplier.

Peppol / UBL: There are different codes used to identify a company in the UBL or on the Peppol network. Scrada will use the following information as company identifier.

  1. `PartyTaxNumber` (Can be used to send invoice over the Peppol network)
  2. `PartyVatNumber` (Can be used to send invoice over the Peppol network)
  3. `PartyGlnNumber` (Can be used to send invoice over the Peppol network)
  4. `partyAccountingCode`
  5. `partyEmail`

Remark: Purchase invoices are under development. Contact info@scrada.be for more information.
path Parameters
companyID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:
bookYear
required
string <= 200 characters

The book year in which the invoice is created. Scrada will check that the following combination is unique: BookYear, Journal, Number and Type. This field cannot be 'NULL'.

journal
required
string <= 200 characters

The journal name or code. This field cannot be 'NULL'.

number
required
string [ 1 .. 250 ] characters

The invoice number.

type
integer <int32> (v1.CompanyInvoiceType)
Value: 1

The invoice type.

  • 1: Sales invoice
  • 2: Purchase invoice*
    • * Under development. Contact info@scrada.be for more information.
creditInvoice
boolean or null

The invoice is an credit invoice. Default value is false

invoiceDate
required
string <date>

The invoice date.

invoiceExpiryDate
required
string <date>

The invoice expiry date.

alreadySendToCustomer
boolean or null

Indicator if the invoice is already send to the customer. If not (by default) Scrada can send the invoice.

buyerReference
string or null

The buyers reference or purchase order number.

partyCode
string or null

The party identification code.

partyAccountingCode
string or null

The party identification code in the accounting system. This code is used as reference key to this party.

partyLanguageCode
string or null

The party language code according to ISO 639-1.

partyName
required
string non-empty

The party name.

partyStreet
string or null

The party street.

partyStreetNumber
string or null

The party street number.

partyStreetBox
string or null

The party street postbox.

partyCity
string or null

The party city.

partyZipCode
string or null

The party ZIP code.

partyCountryCode
string or null <= 2 characters

The party country code according to ISO 3166-1 alpha 2.

partyPhone
string or null <= 50 characters

The party phone number.

partyEmail
string or null <= 250 characters

The party email address.

partyInvoiceEmail
string or null <= 250 characters

The party invoice email address.

partyContact
string or null

The party contact name.

partyTaxNumberType
integer <int32> (v1.CompanyInvoiceTaxNumberType)
Enum: 1 2 3

The tax number typed used to identify the party.

  • 1: Numero d'entreprise / ondernemingsnummer / Unternehmensnummer / Enterprise number (Belgium)
  • 2: Kamer van koophandel nummer (the Netherlands)
  • 3: SIRENE (France)
partyTaxNumber
string or null

The party tax number according to the type PartyTaxNumberType.

partyVatNumber
string or null

The party VAT number. This must be a valid VAT number!

partyGlnNumber
string or null

The party GLN number. This must be a valid GLN number!

totalInclVat
number or null <double>

The total invoice amount including VAT. Default value is 0. Max precision is 2.

totalVat
number or null <double>

The total invoice VAT amount. Default value is 0. Max precision is 2.

totalExclVat
number or null <double>

The total invoice amount excluding VAT. Default value is 0. Max precision is 2.

payableRoundingAmount
number or null <double>

The payable rounding amount. The amount to be added to the invoice total to round the amount to be paid. Max precision is 2.

comment
string or null

The invoice comment.

Array of objects or null (Invoice line)
Array of objects or null (Invoice payment method)
filename
string or null

The invoice document file name including file extension.

mimeType
string or null

The invoice document mime type. The following mime types are supported:

  • text/csv
  • application/pdf
  • image/png
  • image/jpeg
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  • application/vnd.oasis.opendocument.spreadsheet
base64Data
string or null

The invoice document with Base64 encoding.

Responses

Request samples

Content type
{
  • "bookYear": "string",
  • "journal": "string",
  • "number": "string",
  • "type": 1,
  • "creditInvoice": true,
  • "invoiceDate": "2019-08-24",
  • "invoiceExpiryDate": "2019-08-24",
  • "alreadySendToCustomer": true,
  • "buyerReference": "string",
  • "partyCode": "string",
  • "partyAccountingCode": "string",
  • "partyLanguageCode": "string",
  • "partyName": "string",
  • "partyStreet": "string",
  • "partyStreetNumber": "string",
  • "partyStreetBox": "string",
  • "partyCity": "string",
  • "partyZipCode": "string",
  • "partyCountryCode": "st",
  • "partyPhone": "string",
  • "partyEmail": "string",
  • "partyInvoiceEmail": "string",
  • "partyContact": "string",
  • "partyTaxNumberType": 1,
  • "partyTaxNumber": "string",
  • "partyVatNumber": "string",
  • "partyGlnNumber": "string",
  • "totalInclVat": 0,
  • "totalVat": 0,
  • "totalExclVat": 0,
  • "payableRoundingAmount": 0,
  • "comment": "string",
  • "lines": [
    ],
  • "paymentMethods": [
    ],
  • "filename": "string",
  • "mimeType": "string",
  • "base64Data": "string"
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Update invoice

Update an existing invoice.
If a property of the invoice is set null or a property is missing then the system assumes that this property must keep its original value.
If sending also a document of the invoice then this must always be send for every update. If document is not send then it is removed from the invoice.

path Parameters
companyID
required
string <uuid>
invoiceID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:
bookYear
required
string <= 200 characters

The book year in which the invoice is created. Scrada will check that the following combination is unique: BookYear, Journal, Number and Type. This field cannot be 'NULL'.

journal
required
string <= 200 characters

The journal name or code. This field cannot be 'NULL'.

number
required
string [ 1 .. 250 ] characters

The invoice number.

type
integer <int32> (v1.CompanyInvoiceType)
Value: 1

The invoice type.

  • 1: Sales invoice
  • 2: Purchase invoice*
    • * Under development. Contact info@scrada.be for more information.
creditInvoice
boolean or null

The invoice is an credit invoice. Default value is false

invoiceDate
required
string <date>

The invoice date.

invoiceExpiryDate
required
string <date>

The invoice expiry date.

alreadySendToCustomer
boolean or null

Indicator if the invoice is already send to the customer. If not (by default) Scrada can send the invoice.

buyerReference
string or null

The buyers reference or purchase order number.

partyCode
string or null

The party identification code.

partyAccountingCode
string or null

The party identification code in the accounting system. This code is used as reference key to this party.

partyLanguageCode
string or null

The party language code according to ISO 639-1.

partyName
required
string non-empty

The party name.

partyStreet
string or null

The party street.

partyStreetNumber
string or null

The party street number.

partyStreetBox
string or null

The party street postbox.

partyCity
string or null

The party city.

partyZipCode
string or null

The party ZIP code.

partyCountryCode
string or null <= 2 characters

The party country code according to ISO 3166-1 alpha 2.

partyPhone
string or null <= 50 characters

The party phone number.

partyEmail
string or null <= 250 characters

The party email address.

partyInvoiceEmail
string or null <= 250 characters

The party invoice email address.

partyContact
string or null

The party contact name.

partyTaxNumberType
integer <int32> (v1.CompanyInvoiceTaxNumberType)
Enum: 1 2 3

The tax number typed used to identify the party.

  • 1: Numero d'entreprise / ondernemingsnummer / Unternehmensnummer / Enterprise number (Belgium)
  • 2: Kamer van koophandel nummer (the Netherlands)
  • 3: SIRENE (France)
partyTaxNumber
string or null

The party tax number according to the type PartyTaxNumberType.

partyVatNumber
string or null

The party VAT number. This must be a valid VAT number!

partyGlnNumber
string or null

The party GLN number. This must be a valid GLN number!

totalInclVat
number or null <double>

The total invoice amount including VAT. Default value is 0. Max precision is 2.

totalVat
number or null <double>

The total invoice VAT amount. Default value is 0. Max precision is 2.

totalExclVat
number or null <double>

The total invoice amount excluding VAT. Default value is 0. Max precision is 2.

payableRoundingAmount
number or null <double>

The payable rounding amount. The amount to be added to the invoice total to round the amount to be paid. Max precision is 2.

comment
string or null

The invoice comment.

Array of objects or null (Invoice line)
Array of objects or null (Invoice payment method)
filename
string or null

The invoice document file name including file extension.

mimeType
string or null

The invoice document mime type. The following mime types are supported:

  • text/csv
  • application/pdf
  • image/png
  • image/jpeg
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  • application/vnd.oasis.opendocument.spreadsheet
base64Data
string or null

The invoice document with Base64 encoding.

Responses

Request samples

Content type
{
  • "bookYear": "string",
  • "journal": "string",
  • "number": "string",
  • "type": 1,
  • "creditInvoice": true,
  • "invoiceDate": "2019-08-24",
  • "invoiceExpiryDate": "2019-08-24",
  • "alreadySendToCustomer": true,
  • "buyerReference": "string",
  • "partyCode": "string",
  • "partyAccountingCode": "string",
  • "partyLanguageCode": "string",
  • "partyName": "string",
  • "partyStreet": "string",
  • "partyStreetNumber": "string",
  • "partyStreetBox": "string",
  • "partyCity": "string",
  • "partyZipCode": "string",
  • "partyCountryCode": "st",
  • "partyPhone": "string",
  • "partyEmail": "string",
  • "partyInvoiceEmail": "string",
  • "partyContact": "string",
  • "partyTaxNumberType": 1,
  • "partyTaxNumber": "string",
  • "partyVatNumber": "string",
  • "partyGlnNumber": "string",
  • "totalInclVat": 0,
  • "totalVat": 0,
  • "totalExclVat": 0,
  • "payableRoundingAmount": 0,
  • "comment": "string",
  • "lines": [
    ],
  • "paymentMethods": [
    ],
  • "filename": "string",
  • "mimeType": "string",
  • "base64Data": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "defaultFormat": "string",
  • "innerErrors": [
    ]
}

VAT period

Get all VAT periods

Get all VAT periods belonging to this company.

path Parameters
companyID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create VAT period

Add a new journal VAT period.

path Parameters
companyID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:
fromDate
string or null <date-time>

The starting date of the VAT period.

vatPeriodType
required
integer <int32> (v1.CompanyVatPeriodType)
Enum: 0 1 3 12

The VAT type.

  • 0: No VAT obligation
  • 1: Monty
  • 3: Quarterly
  • 12: Yearly

Responses

Request samples

Content type
{
  • "fromDate": "2019-08-24T14:15:22Z",
  • "vatPeriodType": 0
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Get VAT period

Get the specified company VAT period.

path Parameters
companyID
required
string <uuid>
vatPeriodID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "tillDate": "2019-08-24T14:15:22Z",
  • "vatPeriodType": 0
}

Update VAT period

Update an existing company VAT period.

path Parameters
companyID
required
string <uuid>
vatPeriodID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:
integer <int32> (v1.CompanyVatPeriodType)
Enum: 0 1 3 12

The VAT type.

  • 0: No VAT obligation
  • 1: Monty
  • 3: Quarterly
  • 12: Yearly

Responses

Request samples

Content type
0
0

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "defaultFormat": "string",
  • "innerErrors": [
    ]
}

Journal

Get all journals

Get all journals belonging to this company.

path Parameters
companyID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create journal

Add a new journal.
The new journal will get a default VAT category after creation. This VAT category can be changed, as long as it remains unused, with the 'Update VAT category' API.

path Parameters
companyID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:
active
boolean or null

Show the journal in the dashboard.

name
required
string or null

The journal name.

startDate
string or null <date-time>

The start date. If new book and not specified then today is used as start date.

endDate
string or null <date-time>

The closing date.

invoiceGenerationPeriodType
integer <int32> (v1.JournalInvoicePeriodType)
Enum: 1 2 3

The invoice generation period.

  • 1: Every day
  • 2: Every week
  • 3: Every month
invoiceGenerationStartWeekDay
integer <int32> (v1.JournalInvoiceDayOfWeek)
Enum: 0 1 2 3 4 5 6

Day of the week to generate journal invoice. Only applicable when 'journalInvoicePeriodType' is set to 2(EveryWeek).

  • 0: Sunday
  • 1: Monday
  • 2: Tuesday
  • 3: Wednesday
  • 4: Thursday
  • 5: Friday
  • 6: Saturday
customerName
string or null <= 250 characters

The journal invoice customer name.

customerReference
string or null <= 250 characters

The journal invoice customer reference.

invoiceNumberExternalFormat
string or null <= 100 characters

The journal invoice number format.
Own invoice number can contain automatically filled in values like {VATYear}, {VATPeriod}, {InvoiceNumber}, {DateDay}, {DateMonth}, {DateYear} or {DateShortYear} (more info can be found in the FAQ on the website of Scrada). If you want that a value has minimum length then you can use the value format {::}. The default filling char 0 is used. Samples are '{VATYear}{VATPeriod:2}' or 'V1/{InvoiceNumber:8}'.

invoiceNumberExternalReset
string or null <= 10 characters

Reset the journal invoice number on a specified day.
Format of values is /. Sample 1/5 if reset on the first of May.

openOnMonday
boolean or null

Business is opened on Monday. Default value is true.

openOnTuesday
boolean or null

Business is opened on Tuesday. Default value is true.

openOnWednesday
boolean or null

Business is opened on Wednesday. Default value is true.

openOnThursday
boolean or null

Business is opened on Thursday. Default value is true.

openOnFriday
boolean or null

Business is opened on Friday. Default value is true.

openOnSaturday
boolean or null

Business is opened on Saturday. Default value is true.

openOnSunday
boolean or null

Business is opened on Sunday. Default value is true.

emailNoLinesDays
integer or null <int32> [ 1 .. 1000 ]

Send an email after this number of days no lines entered.

allowMultipleEntries
boolean or null

Allow multiple entries on a single day in the daily receipts book. This doesn't include correction entries.

autoLoadPaymentProvider
boolean or null

If value is true then the payment providers (like payconiq, ... ) are filled in automatically when adding manual lines. Default value true.

addFiguresUser
integer <int32> (v1.JournalAllowAddFiguresUserType)
Enum: 1 2

Allow users to add entries to the journal.

  • 1: Block
  • 2: Directly add figures
addFiguresApi
integer <int32> (v1.JournalAllowAddFiguresApiType)
Enum: 1 2 3 4 5

Allow API users to add entries to the journal.

  • 1: Block
  • 2: Directly add figures
  • 3: Directly add daily receipts figures and add payment methods as proposal
  • 4: Add as proposal (requires confirmation by user)
  • 5: Add as proposal and update with payment provider info

Responses

Request samples

Content type
{
  • "active": true,
  • "name": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "invoiceGenerationPeriodType": 1,
  • "invoiceGenerationStartWeekDay": 0,
  • "customerName": "string",
  • "customerReference": "string",
  • "invoiceNumberExternalFormat": "string",
  • "invoiceNumberExternalReset": "string",
  • "openOnMonday": true,
  • "openOnTuesday": true,
  • "openOnWednesday": true,
  • "openOnThursday": true,
  • "openOnFriday": true,
  • "openOnSaturday": true,
  • "openOnSunday": true,
  • "emailNoLinesDays": 1,
  • "allowMultipleEntries": true,
  • "autoLoadPaymentProvider": true,
  • "addFiguresUser": 1,
  • "addFiguresApi": 1
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Get journal

Get the specified journal.

path Parameters
companyID
required
string <uuid>
journalID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "active": true,
  • "name": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "lastLineDate": "2019-08-24T14:15:22Z",
  • "lastLineID": "16c2f113-478e-4b3a-8e6e-b0c5a0627baa",
  • "invoiceGenerationPeriodType": 1,
  • "invoiceGenerationStartWeekDay": 0,
  • "customerName": "string",
  • "customerReference": "string",
  • "invoiceNumberExternalFormat": "string",
  • "invoiceNumberExternalReset": "string",
  • "openOnMonday": true,
  • "openOnTuesday": true,
  • "openOnWednesday": true,
  • "openOnThursday": true,
  • "openOnFriday": true,
  • "openOnSaturday": true,
  • "openOnSunday": true,
  • "cashbookID": "da76995c-8bdc-4961-ae83-c79ba4470dba",
  • "emailNoLinesDays": 1,
  • "allowMultipleEntries": true,
  • "autoLoadPaymentProvider": true,
  • "addFiguresUser": 1,
  • "addFiguresApi": 1,
  • "invoicedTill": "2019-08-24T14:15:22Z",
  • "paidTill": "2019-08-24T14:15:22Z",
  • "minimumPossibleLineDate": "2019-08-24T14:15:22Z",
  • "maximumPossibleLineDate": "2019-08-24T14:15:22Z"
}

Update journal

Update an existing journal.
If a property of the journal is set null or a property is missing then the system assumes that this property must keep its original value. Only in case of property endDate, if this property is missing or has has value null, the system assumes that it has value null.

path Parameters
companyID
required
string <uuid>
journalID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:
active
boolean or null

Show the journal in the dashboard.

name
required
string or null

The journal name.

startDate
string or null <date-time>

The start date. If new book and not specified then today is used as start date.

endDate
string or null <date-time>

The closing date.

invoiceGenerationPeriodType
integer <int32> (v1.JournalInvoicePeriodType)
Enum: 1 2 3

The invoice generation period.

  • 1: Every day
  • 2: Every week
  • 3: Every month
invoiceGenerationStartWeekDay
integer <int32> (v1.JournalInvoiceDayOfWeek)
Enum: 0 1 2 3 4 5 6

Day of the week to generate journal invoice. Only applicable when 'journalInvoicePeriodType' is set to 2(EveryWeek).

  • 0: Sunday
  • 1: Monday
  • 2: Tuesday
  • 3: Wednesday
  • 4: Thursday
  • 5: Friday
  • 6: Saturday
customerName
string or null <= 250 characters

The journal invoice customer name.

customerReference
string or null <= 250 characters

The journal invoice customer reference.

invoiceNumberExternalFormat
string or null <= 100 characters

The journal invoice number format.
Own invoice number can contain automatically filled in values like {VATYear}, {VATPeriod}, {InvoiceNumber}, {DateDay}, {DateMonth}, {DateYear} or {DateShortYear} (more info can be found in the FAQ on the website of Scrada). If you want that a value has minimum length then you can use the value format {::}. The default filling char 0 is used. Samples are '{VATYear}{VATPeriod:2}' or 'V1/{InvoiceNumber:8}'.

invoiceNumberExternalReset
string or null <= 10 characters

Reset the journal invoice number on a specified day.
Format of values is /. Sample 1/5 if reset on the first of May.

openOnMonday
boolean or null

Business is opened on Monday. Default value is true.

openOnTuesday
boolean or null

Business is opened on Tuesday. Default value is true.

openOnWednesday
boolean or null

Business is opened on Wednesday. Default value is true.

openOnThursday
boolean or null

Business is opened on Thursday. Default value is true.

openOnFriday
boolean or null

Business is opened on Friday. Default value is true.

openOnSaturday
boolean or null

Business is opened on Saturday. Default value is true.

openOnSunday
boolean or null

Business is opened on Sunday. Default value is true.

emailNoLinesDays
integer or null <int32> [ 1 .. 1000 ]

Send an email after this number of days no lines entered.

allowMultipleEntries
boolean or null

Allow multiple entries on a single day in the daily receipts book. This doesn't include correction entries.

autoLoadPaymentProvider
boolean or null

If value is true then the payment providers (like payconiq, ... ) are filled in automatically when adding manual lines. Default value true.

addFiguresUser
integer <int32> (v1.JournalAllowAddFiguresUserType)
Enum: 1 2

Allow users to add entries to the journal.

  • 1: Block
  • 2: Directly add figures
addFiguresApi
integer <int32> (v1.JournalAllowAddFiguresApiType)
Enum: 1 2 3 4 5

Allow API users to add entries to the journal.

  • 1: Block
  • 2: Directly add figures
  • 3: Directly add daily receipts figures and add payment methods as proposal
  • 4: Add as proposal (requires confirmation by user)
  • 5: Add as proposal and update with payment provider info

Responses

Request samples

Content type
{
  • "active": true,
  • "name": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "invoiceGenerationPeriodType": 1,
  • "invoiceGenerationStartWeekDay": 0,
  • "customerName": "string",
  • "customerReference": "string",
  • "invoiceNumberExternalFormat": "string",
  • "invoiceNumberExternalReset": "string",
  • "openOnMonday": true,
  • "openOnTuesday": true,
  • "openOnWednesday": true,
  • "openOnThursday": true,
  • "openOnFriday": true,
  • "openOnSaturday": true,
  • "openOnSunday": true,
  • "emailNoLinesDays": 1,
  • "allowMultipleEntries": true,
  • "autoLoadPaymentProvider": true,
  • "addFiguresUser": 1,
  • "addFiguresApi": 1
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "defaultFormat": "string",
  • "innerErrors": [
    ]
}

Link journal to cash book

Link an existing journal to an existing cash book. To remove an existing link between a journal and cashbook set the cash book ID to NULL.
When experiencing unsupported media type errors with the cash book ID (body) NULL add a 'Content-Type' header with value application/json.

path Parameters
companyID
required
string <uuid>
journalID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:

The cash book ID or NULL to remove the link.

string <uuid>

Responses

Request samples

Content type
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "defaultFormat": "string",
  • "innerErrors": [
    ]
}

Payment method

Get all payment methods

Get all payment methods belonging to this journal.

path Parameters
companyID
required
string <uuid>
journalID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create payment method

Add a new journal payment method.

path Parameters
companyID
required
string <uuid>
journalID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:
nameNL
required
string or null <= 200 characters

The Dutch payment method name.

nameEN
required
string or null <= 200 characters

The English payment method name.

nameFR
required
string or null <= 200 characters

The French payment method name.

nameDE
required
string or null <= 200 characters

The German payment method name.

isCash
boolean or null

Mark the payment method as cash payment. Cash payments will get added to the linked cashbook.

position
integer or null <int32>

The sorting position. Lowest is shown first.

isCalculated
boolean or null

Sets whether this payment method gets calculated in the GUI.

isDefault
boolean or null

Indicator for the default payment method.

inputEntry
integer <int32> (v1.JournalPaymentMethodInputType)
Enum: 1 2 3 4 5 6 7

The input visibility.

  • 1: Not visible
  • 2: Always visible
  • 3: Only positive
  • 4: Only negative
  • 5: Warning on positive
  • 6: Warning on negative
  • 7: Always warning
inputCorrection
integer <int32> (v1.JournalPaymentMethodInputType)
Enum: 1 2 3 4 5 6 7

The input visibility.

  • 1: Not visible
  • 2: Always visible
  • 3: Only positive
  • 4: Only negative
  • 5: Warning on positive
  • 6: Warning on negative
  • 7: Always warning
commentType
integer <int32> (v1.JournalPaymentMethodCommentType)
Enum: 1 2 3

The comment visibility.

  • 1: Not visible
  • 2: Optional
  • 3: Required
allowMultiple
boolean or null

Whether to allow multiple instances of this payment method in a singe daily receipt transaction. Default false, cannot be used in combination with a payment provider integration.

Responses

Request samples

Content type
{
  • "nameNL": "string",
  • "nameEN": "string",
  • "nameFR": "string",
  • "nameDE": "string",
  • "isCash": true,
  • "position": 0,
  • "isCalculated": true,
  • "isDefault": true,
  • "inputEntry": 1,
  • "inputCorrection": 1,
  • "commentType": 1,
  • "allowMultiple": true
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Get payment method

Get the specified journal payment method.

path Parameters
companyID
required
string <uuid>
journalID
required
string <uuid>
paymentMethodID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "nameNL": "string",
  • "nameEN": "string",
  • "nameFR": "string",
  • "nameDE": "string",
  • "isCash": true,
  • "position": 0,
  • "isCalculated": true,
  • "isDefault": true,
  • "inputEntry": 1,
  • "inputCorrection": 1,
  • "commentType": 1,
  • "allowMultiple": true
}

Update payment method

Update an existing journal payment method.
If a property of the journal payment method is set null or a property is missing then the system assumes that this property must keep its original value.

path Parameters
companyID
required
string <uuid>
journalID
required
string <uuid>
paymentMethodID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:
nameNL
required
string or null <= 200 characters

The Dutch payment method name.

nameEN
required
string or null <= 200 characters

The English payment method name.

nameFR
required
string or null <= 200 characters

The French payment method name.

nameDE
required
string or null <= 200 characters

The German payment method name.

isCash
boolean or null

Mark the payment method as cash payment. Cash payments will get added to the linked cashbook.

position
integer or null <int32>

The sorting position. Lowest is shown first.

isCalculated
boolean or null

Sets whether this payment method gets calculated in the GUI.

isDefault
boolean or null

Indicator for the default payment method.

inputEntry
integer <int32> (v1.JournalPaymentMethodInputType)
Enum: 1 2 3 4 5 6 7

The input visibility.

  • 1: Not visible
  • 2: Always visible
  • 3: Only positive
  • 4: Only negative
  • 5: Warning on positive
  • 6: Warning on negative
  • 7: Always warning
inputCorrection
integer <int32> (v1.JournalPaymentMethodInputType)
Enum: 1 2 3 4 5 6 7

The input visibility.

  • 1: Not visible
  • 2: Always visible
  • 3: Only positive
  • 4: Only negative
  • 5: Warning on positive
  • 6: Warning on negative
  • 7: Always warning
commentType
integer <int32> (v1.JournalPaymentMethodCommentType)
Enum: 1 2 3

The comment visibility.

  • 1: Not visible
  • 2: Optional
  • 3: Required
allowMultiple
boolean or null

Whether to allow multiple instances of this payment method in a singe daily receipt transaction. Default false, cannot be used in combination with a payment provider integration.

Responses

Request samples

Content type
{
  • "nameNL": "string",
  • "nameEN": "string",
  • "nameFR": "string",
  • "nameDE": "string",
  • "isCash": true,
  • "position": 0,
  • "isCalculated": true,
  • "isDefault": true,
  • "inputEntry": 1,
  • "inputCorrection": 1,
  • "commentType": 1,
  • "allowMultiple": true
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "defaultFormat": "string",
  • "innerErrors": [
    ]
}

VAT category

Get all VAT categories

Get all VAT categories belonging to this journal.

path Parameters
companyID
required
string <uuid>
journalID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create VAT category

Add a new journal VAT category.

path Parameters
companyID
required
string <uuid>
journalID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:
nameNL
required
string or null <= 200 characters

The Dutch VAT category name.

nameEN
required
string or null <= 200 characters

The English VAT category name.

nameFR
required
string or null <= 200 characters

The French VAT category name.

nameDE
required
string or null <= 200 characters

The German VAT category name.

vatTypeID
string or null <uuid>

VAT type ID of the category.
Belgium:

  • cbff0b5e-96e3-4201-91d0-51304cee2605: 00 (0%) VAT
  • 7befe0fc-7131-4b15-9fe6-ca4b9280b63c: 01 (6%) VAT
  • 647ed17b-fb6f-4772-baf5-928de98f4db1: 02 (12%) VAT
  • 8424d909-78b9-483c-9b1d-4584fb537846: 03 (21%) VAT
  • cc9b638f-3b54-44c8-91e5-83d337ae6591: NA
The Netherlands:
  • fb145f3f-c866-4322-9169-8d8219d40e8a: 00 (0%) VAT
  • 3aa951e7-f307-4902-b315-b764eb81d211: 02 (9%) VAT
  • aeb8b26c-00b1-4c6a-9cf2-bc1c71d89196: 03 (21%) VAT
  • a29f353e-5549-460a-97cb-70a607b28581: NA
Luxembourg:
  • 1693aca4-a715-4543-be5d-64f0210f0078: 00 (0%) VAT
  • 03120fb9-18ea-43a1-9119-1af511895e28: 01 (3%) VAT
  • 3f3556ee-6afb-43d1-9545-d309087ac461: 02 (8%) VAT
  • d5b9db32-49d7-4929-9e60-dec7b00c2e2f: 03 (14%) VAT
  • e701b521-2ff0-4176-9533-3e297d52809e: 04 (17%) VAT
  • ea73a071-18dd-4964-8fd7-fe58ff782c2c: NA
position
integer or null <int32>

The sorting position. Lowest is shown first.

inputEntry
integer <int32> (v1.JournalVatCategoryInputType)
Enum: 1 2 3 4 5 6 7

The input visibility.

  • 1: Not visible
  • 2: Always visible
  • 3: Only positive
  • 4: Only negative
  • 5: Warning on positive
  • 6: Warning on negative
  • 7: Always warning
inputCorrection
integer <int32> (v1.JournalVatCategoryInputType)
Enum: 1 2 3 4 5 6 7

The input visibility.

  • 1: Not visible
  • 2: Always visible
  • 3: Only positive
  • 4: Only negative
  • 5: Warning on positive
  • 6: Warning on negative
  • 7: Always warning
commentType
integer <int32> (v1.JournalVatCategoryCommentType)
Enum: 1 2 3

The comment visibility.

  • 1: Not visible
  • 2: Optional
  • 3: Required
accountingGeneralLedger
string or null

The accounting general ledger number. Must be empty or fully numeric.

accountingAnalytical1
string or null

The accounting analytical 1. Function depends on the accounting system.

accountingAnalytical2
string or null

The accounting analytical 2. Function depends on the accounting system.

accountingAnalytical3
string or null

The accounting analytical 3. Function depends on the accounting system.

accountingAnalytical4
string or null

The accounting analytical 4. Function depends on the accounting system.

accountingAnalytical5
string or null

The accounting analytical 5. Function depends on the accounting system.

Responses

Request samples

Content type
{
  • "nameNL": "string",
  • "nameEN": "string",
  • "nameFR": "string",
  • "nameDE": "string",
  • "vatTypeID": "5d348dc4-4d2d-4cb9-972e-4f14233d67f0",
  • "position": 0,
  • "inputEntry": 1,
  • "inputCorrection": 1,
  • "commentType": 1,
  • "accountingGeneralLedger": "string",
  • "accountingAnalytical1": "string",
  • "accountingAnalytical2": "string",
  • "accountingAnalytical3": "string",
  • "accountingAnalytical4": "string",
  • "accountingAnalytical5": "string"
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Get VAT category

Get the specified journal VAT category.

path Parameters
companyID
required
string <uuid>
journalID
required
string <uuid>
vatCategoryID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "nameNL": "string",
  • "nameEN": "string",
  • "nameFR": "string",
  • "nameDE": "string",
  • "vatTypeID": "5d348dc4-4d2d-4cb9-972e-4f14233d67f0",
  • "position": 0,
  • "inputEntry": 1,
  • "inputCorrection": 1,
  • "commentType": 1,
  • "accountingGeneralLedger": "string",
  • "accountingAnalytical1": "string",
  • "accountingAnalytical2": "string",
  • "accountingAnalytical3": "string",
  • "accountingAnalytical4": "string",
  • "accountingAnalytical5": "string"
}

Update VAT category

Update an existing journal VAT category.
If a property of the journal VAT category is set null or a property is missing then the system assumes that this property must keep its original value.

path Parameters
companyID
required
string <uuid>
journalID
required
string <uuid>
vatCategoryID
required
string <uuid>
header Parameters
Language
String

Language

X-API-KEY
required
any

The API Key.

X-PASSWORD
required
any

The password.

Request Body schema:
nameNL
required
string or null <= 200 characters

The Dutch VAT category name.

nameEN
required
string or null <= 200 characters

The English VAT category name.

nameFR
required
string or null <= 200 characters

The French VAT category name.

nameDE
required
string or null <= 200 characters

The German VAT category name.

vatTypeID
string or null <uuid>

VAT type ID of the category.
Belgium:

  • cbff0b5e-96e3-4201-91d0-51304cee2605: 00 (0%) VAT
  • 7befe0fc-7131-4b15-9fe6-ca4b9280b63c: 01 (6%) VAT
  • 647ed17b-fb6f-4772-baf5-928de98f4db1: 02 (12%) VAT
  • 8424d909-78b9-483c-9b1d-4584fb537846: 03 (21%) VAT
  • cc9b638f-3b54-44c8-91e5-83d337ae6591: NA
The Netherlands:
  • fb145f3f-c866-4322-9169-8d8219d40e8a: 00 (0%) VAT
  • 3aa951e7-f307-4902-b315-b764eb81d211: 02 (9%) VAT
  • aeb8b26c-00b1-4c6a-9cf2-bc1c71d89196: 03 (21%) VAT
  • a29f353e-5549-460a-97cb-70a607b28581: NA
Luxembourg:
  • 1693aca4-a715-4543-be5d-64f0210f0078: 00 (0%) VAT
  • 03120fb9-18ea-43a1-9119-1af511895e28: 01 (3%) VAT
  • 3f3556ee-6afb-43d1-9545-d309087ac461: 02 (8%) VAT
  • d5b9db32-49d7-4929-9e60-dec7b00c2e2f: 03 (14%) VAT
  • e701b521-2ff0-4176-9533-3e297d52809e: 04 (17%) VAT
  • ea73a071-18dd-4964-8fd7-fe58ff782c2c: NA
position
integer or null <int32>

The sorting position. Lowest is shown first.

inputEntry
integer <int32> (v1.JournalVatCategoryInputType)
Enum: 1 2 3 4 5 6 7

The input visibility.

  • 1: Not visible
  • 2: Always visible
  • 3: Only positive
  • 4: Only negative
  • 5: Warning on positive
  • 6: Warning on negative
  • 7: Always warning
inputCorrection
integer <int32> (v1.JournalVatCategoryInputType)
Enum: 1 2 3 4 5 6 7

The input visibility.

  • 1: Not visible
  • 2: Always visible
  • 3: Only positive
  • 4: Only negative
  • 5: Warning on positive
  • 6: Warning on negative
  • 7: Always warning
commentType
integer <int32> (v1.JournalVatCategoryCommentType)
Enum: 1 2 3

The comment visibility.

  • 1: Not visible
  • 2: Optional
  • 3: Required
accountingGeneralLedger
string or null

The accounting general ledger number. Must be empty or fully numeric.

accountingAnalytical1
string or null

The accounting analytical 1. Function depends on the accounting system.

accountingAnalytical2
string or null

The accounting analytical 2. Function depends on the accounting system.

accountingAnalytical3
string or null

The accounting analytical 3. Function depends on the accounting system.

accountingAnalytical4
string or null

The accounting analytical 4. Function depends on the accounting system.

accountingAnalytical5
string or null

The accounting analytical 5. Function depends on the accounting system.

Responses

Request samples

Content type
{
  • "nameNL": "string",
  • "nameEN": "string",
  • "nameFR": "string",
  • "nameDE": "string",
  • "vatTypeID": "5d348dc4-4d2d-4cb9-972e-4f14233d67f0",
  • "position": 0,
  • "inputEntry": 1,
  • "inputCorrection": 1,
  • "commentType": 1,
  • "accountingGeneralLedger": "string",
  • "accountingAnalytical1": "string",
  • "accountingAnalytical2": "string",
  • "accountingAnalytical3": "string",
  • "accountingAnalytical4": "string",
  • "accountingAnalytical5": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "defaultFormat": "string",
  • "innerErrors": [
    ]
}