NAV Navbar
Logo

TL;DR

curl "https://rest.reviso.com/customers" \
    --header "X-AppSecretToken: demo" \
    --header "X-AgreementGrantToken: demo" \
    --header "Content-Type: application/json" 

Add these three headers to your requests.

Header Value What is this?
X-AppSecretToken YOUR_PRIVATE_TOKEN This identifies your app. This is your secret token. Try using the value demo.
X-AgreementGrantToken YOUR_AGREEMENT_GRANT_TOKEN This identifies the grant issued by an agreement, to allow your app to access their data. Try using the value demo.
Content-Type application/json This tells us that you agree with us on using JSON.

Issue a GET to https://rest.reviso.com/customers and see what is returned.

Next try fetching https://rest.reviso.com and see what resources are available.

To get started with your own data you should head over to our Developer portal and get hold of a free developer agreement.

Happy coding!

Introduction

Welcome to the Reviso REST API Documentation!

The Reviso API is a document based JSON REST API. We have tried to make it human-readable and approachable for developers with limited understanding of the inner workings of Reviso.

Learn the basics of working with the API in our Getting started guide.

For more in-depth information about Reviso in general please look at our Online Help.

Demo authentication

If you wish to try out the API before registering a developer agreement, you can do this using a special demo agreement. There are two ways of doing that.

Via query string

The first way is really easy. Just append the query string ?demo=true to your request URL. You only need to this on the first request, then all links in the API will have that query string appended. All 401 Not Authorized responses also include a demo link to that exact resource. This allows for easy browsing of the API when discovering what is available.

Example: https://rest.reviso.com/customers?demo=true

Via headers

The second way is one that allows for an easy “hello world” application. This mimics the authentication flow you will have to use when you create your own app. Just specify HTTP header tokens X-AgreementGrantToken: demo and X-AppSecretToken: demo. That way you can create an application and connect just as you would if you had a real integration. But without the need to register.

Meta stuff

All resources and collections have a property “self” which value is a unique URL that represents that exact resource or collection. The self link for a collection will also contain any pagination, filtering or sorting applied.

Collections vs. Resources

The Reviso REST Api is a json document based API, that consists of a number of resources and collections of resources. Collections are named after the type of resource that can be found in the collection, and then pluralized. For example a collection of customers is called just that: https://rest.reviso.com/customers.

Each resource in the collection will contain a self link, that is made up of the collection self link with the resource identifier appended. So customer #20 will have the following self link; https://rest.reviso.com/customers/20.

Errors

All errors returned has the same format.

The format is as described:

{
    "message": "Some error occured",
    "developerHint": "More thorough help regarding the error",
    "errorCode": "A_V_45",
    "errors": [
        {
            "message": "Some sub error occured",
            "developerHint": "More thorough help regarding the sub error",
            "errorCode": "A_V_43",
        },
        {
            "message": "Some other sub error occured",
            "developerHint": "More thorough help regarding the other sub error",
            "errorCode": "A_V_44",
        }
    ]
}

For instance creating a supplier with missing data:

{
    "developerHint": "Check your request against the schema.",
    "errorCode": "E00500",
    "errors": [
        {
            "errorCode": "E00500",
            "message": "Required properties are missing from object: currency, supplierGroup, name, paymentTerms, vatZone. Line 1, position 1."
        }
    ],
    "httpStatusCode": 400,
    "message": "Schema validation failed."
}

A specific error consists of the following information or a subset there of:

Property Description
errorCode The error code assosiated with this particular error
message A text describing the error
errors Sub errors
additionalData Contains information such as input
developerHint A message to developers to try to help them resolve the issue

Versioning

Currently we offer no versioning of the API. Some endpoints will be stable and others will be experimental. This is displayed directly on the home resource of the API. As endpoints move out of their experimental mode and become stable, we’ll update the home resource to reflect this.

Later on, as our API evolves, we might find it necessary to add versioning. But calling directly on the root of the API will always provide you with the latest API version.

Pagination

We use pagination on our collections. If nothing else is specified the collection endpoints will return 20 resources. URL parameters will allow you to increase this to 1.000 resources and to skip pages if necessary. Each endpoint offers convenient links to navigate through the pagination. The examples below is what you would get on a resource with 40 entries.

First page

https://rest.reviso.com/invoices/drafts?skippages=0&pagesize=20

Next page

https://rest.reviso.com/invoices/drafts?skippages=1&pagesize=20

Last page

https://rest.reviso.com/invoices/drafts?skippages=2&pagesize=20

Filtering

Filtering is enabled on all collection endpoints but not on all properties.

Filtering on collections can be done using the query string parameter filter. A filter is made up of a set of predicates, and follows a syntax inspired by mongoDB. A predicate is made up of a property name, an operator and a value.

Example: ?filter=name$eq:Joe

This matches all resources with the value Joe in the property name.

Predicates can be chained using either of the logical operators AND and OR.

Example: ?filter=name$eq:Joe$and:city$like:*port

Filtering on strings is case insensitive.

Specifying Operator affinity

If you want to control the operator affinity then you can use parentheses.

An example is: ?filter=name$eq:Joe$and:(city$like:*port$or:age$lt:40)

Filter Operators

The allowed filtering operators are:

Operator Syntax
Equals “$eq:”
Not equals “$ne:”
Greater than “$gt:”
Greater than or equal “$gte:”
Less than “$lt:”
Less than or equal “$lte:”
Substring match “$like:”
And also “$and:”
Or else “$or:”
In “$in:”
Not In “$nin:”

Substring matching

The $like: filter supports both using wildcards (*) and not using wildcards. If no wildcards are used, the expression is considered a contains expression and effectively becomes a filter with a wildcard at the start of the string and one at the end of the string.

Escaping special characters in your filter

In order to not interfere with the parsing of the filter expression, certain escape sequences are necessary.

Using null values in your filter

Should you want to filter for the non existence of a property (i.e. null value) you can use the null escape sequence.

$null:

Using in and not in operators

To determine whether a specified value matches any value in (or not in) a list you filter using the $in: or $nin: operator. The list to filter by has to be inclosed in brackets and values seperated by commas.

customerNumber$in:[2,5,7,22,45]

We only allow in and not in operators on numeric properties. So it is not possible to use on string properties. It is possible to also use the $null: keyword if you wish to include that in the filter.

Information about what properties allow filtering can be found in the schema for the collection. Each property that allows filtering has the property "filterable": true set. If you try to sort on something that isn’t allowed the server will respond with a status code 400.

Sorting

Sorting on strings is case insensitive.

Sort ascending

Sorting on collections can be done using the query string parameter ‘sort’.

?sort=name

Sort descending

The default sort direction is ascending, but this can be turned by prepending a minus (-).

?sort=-name

Sort by multiple properties

If you need to sort by multiple properties these can just be separated by commas. Mixing of directions is allowed.

?sort=-name,age

Sort alphabetically

In certain cases you might want to enforce that even numeric values are sorted alphabetically, so 1000 is less than 30. In those cases you can prepend the sort property with a tilde (~).

?sort=~name

Information about what properties are sortable can be found in the schema for the collection. Each property that allows sorting has the property "sortable": true set. The property the collection is sorted by by default has the property defaultSorting set to either ascending or descending.

HTTP Status Codes

The REST API returns these HTTP status codes.

Code Text Description
200 OK Everything is OK
201 Created When you create resources, this is what you get. This will be accompanied by the created resource in the body and a location header with a link to the created resource.
204 No Content In certain cases there is nothing to return. So we will let you know by returning a 204.
400 Bad Request The request you made was somehow malformed. A malformed request could be failed validation on creation or updating. If you try to filter on something that isn’t filterable this is also what you’ll see. Whenever possible we will also try to include a developer hint to help you get around this issue.
401 Unauthorized The credentials you supplied us with weren’t correct, or perhaps you forgot them all together. If an agreement has revoked the grant they gave your app, this is what you will see.
403 Forbidden You won’t necessarily have access to everything. So even though you were authorized we might still deny access to certain resources. This depends on the roles asked for when the grant was issued.
404 Not Found This is returned when you try to request something that doesn’t exist. This could be a resource that has been deleted or just a url you tried to hack. If you see a lot of these, it could be an indication that you aren’t using the links provided by the API. You should never need to concatenate any urls. The API should provide you with the links needed.
405 Method Not Allowed Not all endpoints support all http methods. If you try issue a PUT request to a collection resource this is what you get.
415 Unsupported Media Type Our API is a JSON api. If you ask us to give you anything else, we give you this, and tell you why in the JSON body of the response.
500 Internal Server Error We don’t like to see these, and they are flagged in our logs. When you see this, something went wrong on our end. Either try again, or contact our support.
501 Not Implemented The API is still evolving, and sometimes our resources will link to stuff that we haven’t implemented yet.

Endpoints

This section contains documentation of all our public endpoints. Our home resource lists our endpoints as either stable, experimental or deprecated. In this documentation we will also flag endpoints that are either experimental and deprecated.

Please note that we might have endpoints listed on our home resource that we have not added documentation for yet.

Account Categories

Get Account Categories

GET /account-categories

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Values Description
accountCategoryNumber integer Category number identifier.
accountCategoryType object BalanceSheet, ProfitAndLoss Category type.
description string English description of the category.
parent object Reference to the parent Category, if any.
parent.accountCategoryNumber integer Category number identifier.
useInvertedAccountCategory boolean Whether or not the category has an inverted account category.

Get specific Account Categories

GET /account-categories/:categoryNumber

Return type

This method returns a single object

Properties

Name Type Values Description
accountCategoryNumber integer Category number identifier.
accountCategoryType object BalanceSheet, ProfitAndLoss Category type.
description string English description of the category.
parent object Reference to the parent Category, if any.
parent.accountCategoryNumber integer Category number identifier.
useInvertedAccountCategory boolean Whether or not the category has an inverted account category.

Accounting Years

Accounting years define time spans for when your financial events take place. An accounting year can span anywhere from 6 to 18 months depending on when in your company life it is placed.

For more information please look at the Online Help.

Get all Accounting Years

GET /accounting-years

View response example

Schema name

accounting-years.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Filterable properties

closed, fromDate, toDate, year

Sortable properties

closed, fromDate, toDate, year

Default sorting

fromDate : ascending

Properties

Name Type Format Description
closed boolean Determines if the accounting year is closed for further transactions.
entries string uri A link to a collection of all entries booked in the accounting year.
fromDate string full-date The first date in the accounting year in the format YYYY-MM-DD. Except for the first accounting year on an agreement, it must be the date immediately following the previous accounting year, and thus must be the first day of a month. The first accounting year on an agreement can begin on any day of the month.
periods string uri A link to the collection of accounting year periods on an agreement.
self string uri A unique link reference to the accounting year item.
toDate string full-date The last date in the accounting year in the format YYYY-MM-DD. It must be the last date in the last month of the accounting year. An accounting year can at most have a duration of 18 months.
totals string uri A link to the chart of accounts with the years total in base currency.
vouchers string uri A link to a collection of vouchers created in the accounting year.
year string The calendar year or years spanned by the accounting year in the format YYYY or YYYY/YYYY.

Get specific Accounting Year

GET /accounting-years/:accountingYear

Schema name

accounting-years.accountingYear.get.schema.json

Return type

This method returns a single object

Filterable properties

closed, fromDate, toDate, year

Sortable properties

closed, fromDate, toDate, year

Default sorting

fromDate : ascending

Properties

Name Type Format Description
closed boolean If true this indicates that the accounting year is closed for further transactions.
entries string uri A link to a collection of all entries booked in the accounting year.
fromDate string full-date The first date in the accounting year in the format YYYY-MM-DD. Except for the first accounting year on an agreement, it must be the date immediately following the previous accounting year, and thus must be the first day of a month. The first accounting year on an agreement can begin on any day of the month.
periods string uri A link to the collection of accounting year periods in the accounting year.
self string uri A unique link reference to the accounting year item.
toDate string full-date The last date in the accounting year in the format YYYY-MM-DD. It must be the last date in the last month of the accounting year. An accounting year can at most have a duration of 18 months.
totals string uri A link to the chart of accounts with the years total in base currency.
vouchers string uri A link to a collection of vouchers created in the accounting year. This requires that international ledger is enabled.
year string The calendar year or years spanned by the accounting year in the format YYYY or YYYY/YYYY.

Create Accounting Year

POST /accounting-years

Return type

This method returns a single object

Required properties

fromDate, toDate

Properties

Name Type Format Description
closed boolean Determines if the accounting year is closed for further transactions.
entries object A link to a collection of all entries booked in the accounting year.
fromDate string full-date The first date in the accounting year in the format YYYY-MM-DD. Except for the first accounting year on an agreement, it must be the date immediately following the previous accounting year, and thus must be the first day of a month. The first accounting year on an agreement can begin on any day of the month.
periods object A link to the collection of accounting year periods on an agreement.
toDate string full-date The last date in the accounting year in the format YYYY-MM-DD. It must be the last date in the last month of the accounting year. An accounting year can at most have a duration of 18 months.
totals object A link to the chart of accounts with the years total in base currency.
vouchers object A link to a collection of vouchers created in the accounting year.
year string The calendar year or years spanned by the accounting year in the format YYYY or YYYY/YYYY.

Delete Accounting Year

DELETE /accounting-years/:accountingYear

Get Entries in Accounting Year

GET /accounting-years/:accountingYear/entries

Schema name

accounting-years.accountingYear.entries.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Filterable properties

currency, date

Sortable properties

currency, date

Properties

Name Type Format Max length Min value Values Description
account object The account the entry is connected to.
account.accountNumber integer 1 A unique identifier of the account.
account.self string uri A unique reference to the account resource.
amount number The total entry amount.
amountInBaseCurrency number The total entry amount in base currency.
currency string The ISO 4217 currency code of the entry.
date string full-date Entry issue date. The date is formatted according to ISO-8601(YYYY-MM-DD).
departmentalDistribution object A departmental distribution defines which departments this entry is distributed between. This requires the departments module to be enabled.
departmentalDistribution.departmentalDistributionNumber integer 1 A unique identifier of the departmental distribution.
departmentalDistribution.self string uri A unique reference to the departmental distribution resource.
entryNumber integer The unique identifier of the entry line.
entryType Enum customerInvoice, customerPayment, supplierInvoice, supplierPayment, financeVoucher, reminder, openingEntry, transferredOpeningEntry, systemEntry, manualDebtorInvoice The type of entry.
project object A reference to any project this entry might be related to. This requires the projects module to be enabled.
project.projectNumber integer 1 A unique identifier of the project.
project.self string uri A unique reference to the project resource.
self string uri A unique reference to the accounting year entries resource.
text string 255 A short description about the entry.
vatAccount object The account for VAT.
vatAccount.self string uri A unique link reference to the vatAccount item.
vatAccount.vatCode string 5 The unique identifier of the vat account.
voucherNumber integer The identifier of the voucher this entry belongs to.

Get Totals for Accounting Year

GET /accounting-years/:accountingYear/totals

Schema name

accounting-years.accountingYear.totals.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Filterable properties

account.accountNumber, fromDate, toDate

Sortable properties

account.accountNumber, fromDate, toDate

Default sorting

fromDate : ascending

Properties

Name Type Format Description
account object The account used.
account.accountNumber integer The account number.
account.self string uri A unique reference to the account resource.
fromDate string full-date The first date in the period formated according to ISO-8601 (YYYY-MM-DD).
self string uri A unique reference to the account accounting year totals resource.
toDate string full-date The last date in the period formated according to ISO-8601 (YYYY-MM-DD).
totalInBaseCurrency number The total entry amount in base currency for the accounting year.

Get Periods in Accounting Year

GET /accounting-years/:accountingYear/periods

Schema name

accounting-years.accountingYear.periods.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Filterable properties

closed, fromDate, toDate

Sortable properties

closed, fromDate, toDate

Default sorting

fromDate : ascending

Properties

Name Type Format Max length Min value Description
accountingYear object The accounting year the period is part of.
accountingYear.self string uri A unique reference to the accounting year resource.
accountingYear.year string 10 A unique identifier of the accounting year.
closed boolean If true this indicates that the accounting period is closed for further transactions.
entries string uri A link to a collection of all entries booked in the period.
fromDate string full-date The first date in the period formated according to ISO-8601 (YYYY-MM-DD).
periodNumber integer 1 A unique identifier of the period.
self string uri A unique link reference to the period item.
toDate string full-date The last date in the period formated according to ISO-8601 (YYYY-MM-DD).
totals string uri A link to the chart of accounts with the periods total in base currency.

Get specific Period in Accounting Year

GET /accounting-years/:accountingYear/periods/:accountingYearPeriod

Schema name

accounting-years.accountingYear.periods.accountingYearPeriod.get.schema.json

Return type

This method returns a single object

Filterable properties

closed, fromDate, toDate

Sortable properties

closed, fromDate, toDate

Default sorting

fromDate : ascending

Properties

Name Type Format Max length Min value Description
accountingYear object The accounting year the period is part of.
accountingYear.self string uri A unique reference to the accounting year resource.
accountingYear.year string 4 A unique identifier of the accounting year.
closed boolean If true this indicates that the accounting period is closed for further transactions.
entries string uri A link to a collection of all entries booked in the period.
fromDate string full-date The first date in the period formatted according to ISO-8601(YYYY-MM-DD).
periodNumber integer 1 A unique identifier of the period.
self string uri A unique link reference to the period item.
toDate string full-date The last date in the period formatted according to ISO-8601(YYYY-MM-DD).
totals string uri A link to the chart of accounts with the periods total in base currency.

Get Entries in Period

GET /accounting-years/:accountingYear/periods/:accountingYearPeriod/entries

Schema name

accounting-years.accountingYear.periods.accountingYearPeriod.entries.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Filterable properties

currency, date

Sortable properties

currency, date

Properties

Name Type Format Max length Min value Values Description
account object The account the entry is connected to.
account.accountNumber integer 1 A unique identifier of the account.
account.self string uri A unique reference to the account resource.
amount number The total entry amount.
amountInBaseCurrency number The total entry amount in base currency.
currency string The ISO 4217 currency code of the entry.
date string full-date Invoice issue date. The date is formatted according to ISO-8601(YYYY-MM-DD).
departmentalDistribution object The departmental distribution the entry is connected to.
departmentalDistribution.departmentalDistributionNumber integer 1 A unique identifier of the departmental distribution.
departmentalDistribution.self string uri A unique reference to the departmental distribution resource.
entryNumber integer The unique identifier of the entry line.
entryType Enum customerInvoice, customerPayment, supplierInvoice, supplierPayment, financeVoucher, reminder, openingEntry, transferredOpeningEntry, systemEntry, manualDebtorInvoice The type of entry.
pdf object References a pdf representation of this entry.
pdf.self string uri The unique reference of the pdf representation for this entry.
project object The project the entry is connected to.
project.projectNumber integer 1 A unique identifier of the project.
project.self string uri A unique reference to the project resource.
self string uri A unique reference to the entry resource.
text string 255 A short description about the entry.
vatAccount object The account for VAT.
vatAccount.self string uri A unique link reference to the vatAccount item.
vatAccount.vatCode string 5 The unique identifier of the vat account.
voucherNumber integer The identifier of the voucher this entry belongs to.

Get Totals for Period

GET /accounting-years/:accountingYear/periods/:accountingYearPeriod/totals

Schema name

accounting-years.accountingYear.periods.accountingYearPeriod.totals.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Filterable properties

account.accountNumber, fromDate, toDate

Sortable properties

account.accountNumber, fromDate, toDate

Default sorting

fromDate : ascending

Properties

Name Type Format Description
account object A reference to the account totaled.
account.accountNumber integer The account number.
account.self string uri A unique reference to the account resource.
fromDate string full-date The first date in the period formatted according to ISO-8601(YYYY-MM-DD).
self string uri A unique reference to the totals resource.
toDate string full-date The last date in the period formatted according to ISO-8601(YYYY-MM-DD).
totalInBaseCurrency number The total entry amount in base currency for the accounting year period.

Get all Vouchers in Accounting year

GET /accounting-years/:accountingYear/vouchers

Schema name

accounting-years.accountingYear.vouchers.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Required properties

date, lines.amount, lines.supplier.supplierNumber, numberSeries, voucherNumber, voucherType

Filterable properties

lines.accruals.account.accountNumber, lines.contraAccount.accountNumber, lines.contraAccount.accountType

Sortable properties

lines.accruals.account.accountNumber, lines.contraAccount.accountNumber, lines.contraAccount.accountType

Properties

Name Type Format Read-only Max length Min value Values Description
attachment string uri A unique link reference to the attachment resource for this voucher item.
booked boolean True Is this voucher booked or not.
date string full-date Voucher issue date. The date is formatted according to ISO-8601 (YYYY-MM-DD). This is part of the unique identifier of a voucher. The other part of the unique identifier is the voucherId.
dueDate string full-date The date the voucher is due for payment. Format according to ISO-8601 (YYYY-MM-DD). This is only used if the terms of payment is of type ‘duedate’.
lines array An array containing the specific voucher lines.
lines.accruals object This is used to divide payments into equal sizes over a certain period of time.
lines.accruals.account object The account used by the accruals.
lines.accruals.account.accountNumber integer The account number.
lines.accruals.account.self string uri A unique reference to the account resource.
lines.accruals.endDate string full-date Accruals end date. The date is formatted according to ISO-8601.
lines.accruals.self string uri A unique link reference to the accruals item.
lines.accruals.startDate string full-date Accruals start date. The date is formatted according to ISO-8601.
lines.amount number The amount on the invoice line.
lines.amountInBaseCurrency number If you use base currency this must be the same as amount or not specified at all.
lines.booked boolean True Is this voucher booked or not.
lines.contraAccount object The contra account.
lines.contraAccount.accountNumber integer The account number.
lines.contraAccount.accountType Enum profitAndLoss, status The contra account must be of either ProfitAndLoss or Status type.
lines.contraAccount.self string uri A unique reference to the account resource.
lines.contraVatAccount object The contra account for VAT.
lines.contraVatAccount.self string uri A unique link reference to the contraVatAccount item.
lines.contraVatAccount.vatCode string 5 The unique identifier of the contra vat account.
lines.contraVatAmount number The amount of VAT on the voucher on the contra account.
lines.contraVatAmountInBaseCurrency number The amount of VAT on the voucher on the contra account in base currency.
lines.currency string 3 The currency the invoice is specified in.
lines.department object A reference to the department that this voucher is credited to.
lines.department.departmentNumber integer The unique identifier of the department.
lines.department.self string uri A unique link reference to the department item.
lines.departmentalDistribution object A departmental distribution defines which departments this entry is distributed between. This requires the departments module to be enabled.
lines.departmentalDistribution.departmentalDistributionNumber integer 1 A unique identifier of the departmental distribution.
lines.departmentalDistribution.self string uri A unique reference to the departmental distribution resource.
lines.document string uri The unique reference to the file.
lines.entryNumber integer True The unique identifier of the invoice line.
lines.exchangeRate number The exchange rate between the base currency and the invoice currency.
lines.remittanceInformation object
lines.remittanceInformation.creditorId string 50 This could be the IBAN/SWIFT no, bank account no, bankgiro no or postgiro no depending on the payment type.
lines.remittanceInformation.creditorInvoiceId string 30 The OCR or message sent together with the creditorId.
lines.remittanceInformation.paymentType object The payment type used.
lines.remittanceInformation.paymentType.paymentTypeNumber integer The unique identifier of the payment type.
lines.remittanceInformation.paymentType.self string uri A unique link reference to the paymentType item.
lines.remittanceInformation.self string uri A unique link reference to the remittanceInformation item.
lines.supplier object The supplier is the vendor from whom you buy your goods.
lines.supplier.self string uri A unique self reference of the supplier.
lines.supplier.supplierNumber integer The supplier number is a unique numerical identifier.
lines.supplierInvoiceNumber string The unique identifier of the supplier invoice gotten from the supplier.
lines.text string 250 The text on the voucher line.
lines.vatAccount object The account for VAT.
lines.vatAccount.self string uri A unique link reference to the vatAccount item.
lines.vatAccount.vatCode string 5 The unique identifier of the vat account.
lines.vatAmount number The amount of VAT on the voucher. Used if the line has a VAT account.
lines.vatAmountInBaseCurrency number The amount of VAT on the voucher in base currency.
numberSeries object The number series corresponding to the voucher type.
numberSeries.numberSeriesNumber integer The unique identifier of the number series.
numberSeries.self string uri A unique link reference to the number series item.
remainder number True Remaining amount to be paid.
remainderInDefaultCurrency number True Remaining amount to be paid in default currency.
self string uri A unique link reference to the voucher item.
voucherId number True Part of the unique identifier of a voucher. The other part of the unique identifier is the date.
voucherNumber object The number series corresponding to the voucher type.
voucherNumber.displayVoucherNumber string True This is a concatenation of the prefix and voucherNumber.
voucherNumber.prefix string The number series prefix.
voucherNumber.voucherNumber number The number of the voucher.
voucherType Enum customerInvoice, customerPayment, supplierInvoice, supplierPayment, financeVoucher, reminder, openingEntry, transferredOpeningEntry, systemEntry, manualDebtorInvoice The type of voucher. Must be SupplierInvoice.

Get specific Voucher in Accounting Year

GET /accounting-years/:accountingYear/vouchers/:voucherId

Schema name

accounting-years.accountingYear.vouchers.voucherId.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Required properties

date, lines.amount, lines.supplier.supplierNumber, numberSeries, voucherNumber, voucherType

Filterable properties

lines.accruals.account.accountNumber, lines.contraAccount.accountNumber, lines.contraAccount.accountType

Sortable properties

lines.accruals.account.accountNumber, lines.contraAccount.accountNumber, lines.contraAccount.accountType

Properties

Name Type Format Read-only Max length Values Description
attachment string uri A unique link reference to the attachment resource for this voucher item.
booked boolean True Is this voucher booked or not.
date string full-date Voucher issue date. The date is formatted according to ISO-8601 (YYYY-MM-DD).
dueDate string full-date The date the voucher is due for payment. Format according to ISO-8601 (YYYY-MM-DD). This is only used if the terms of payment is of type 'duedate’.
lines array An array containing the specific voucher lines.
lines.accruals object This is used to divide payments into equal sizes over a certain period of time.
lines.accruals.account object The account used by the accruals.
lines.accruals.account.accountNumber integer The account number.
lines.accruals.account.self string uri A unique reference to the account resource.
lines.accruals.endDate string full-date Accruals end date. The date is formatted according to ISO-8601.
lines.accruals.self string uri A unique link reference to the accruals item.
lines.accruals.startDate string full-date Accruals start date. The date is formatted according to ISO-8601.
lines.amount number The amount on the invoice line.
lines.amountInBaseCurrency number If you use base currency this must be the same as amount or not specified at all.
lines.booked boolean True Is this voucher booked or not.
lines.contraAccount object The contra account.
lines.contraAccount.accountNumber integer The account number.
lines.contraAccount.accountType Enum profitAndLoss, status The contra account must be of either ProfitAndLoss or Status type.
lines.contraAccount.self string uri A unique reference to the account resource.
lines.contraVatAccount object The contra account for VAT.
lines.contraVatAccount.self string uri A unique link reference to the contraVatAccount item.
lines.contraVatAccount.vatCode string 5 The unique identifier of the contra vat account.
lines.contraVatAmount number The amount of VAT on the voucher on the contra account.
lines.contraVatAmountInBaseCurrency number The amount of VAT on the voucher on the contra account in base currency.
lines.currency string 3 The currency the invoice is specified in.
lines.department object A reference to the department that this voucher will be connected with.
lines.department.departmentNumber integer The unique identifier of the department.
lines.department.self string uri A unique link reference to the department item.
lines.document string uri The unique reference to the file.
lines.entryNumber integer True The unique identifier of the invoice line.
lines.exchangeRate number The exchange rate between the base currency and the invoice currency.
lines.remittanceInformation object
lines.remittanceInformation.creditorId string 50 This could be the IBAN/SWIFT no, bank account no, bankgiro no or postgiro no depending on the payment type.
lines.remittanceInformation.creditorInvoiceId string 30 The OCR or message sent together with the creditorId.
lines.remittanceInformation.paymentType object The payment type used.
lines.remittanceInformation.paymentType.paymentTypeNumber integer The unique identifier of the payment type.
lines.remittanceInformation.paymentType.self string uri A unique link reference to the paymentType item.
lines.remittanceInformation.self string uri A unique link reference to the remittanceInformation item.
lines.supplier object The supplier is the vendor from whom you buy your goods.
lines.supplier.self string uri A unique self reference of the supplier.
lines.supplier.supplierNumber integer The supplier number is a unique numerical identifier.
lines.supplierInvoiceNumber string The unique identifier of the supplier invoice gotten from the supplier.
lines.text string 250 The text on the voucher line.
lines.vatAccount object The account for VAT.
lines.vatAccount.self string uri A unique link reference to the vatAccount item.
lines.vatAccount.vatCode string 5 The unique identifier of the vat account.
lines.vatAmount number The amount of VAT on the voucher. Used if the line has a VAT account.
lines.vatAmountInBaseCurrency number The amount of VAT on the voucher in base currency.
numberSeries object The number series corresponding to the voucher type.
numberSeries.numberSeriesNumber integer The unique identifier of the number series.
numberSeries.self string uri A unique link reference to the number series item.
remainder number True Remaining amount to be paid.
remainderInDefaultCurrency number True Remaining amount to be paid in default currency.
self string uri A unique link reference to the voucher item.
voucherId number True Part of the unique identifier of a voucher.
voucherNumber object The number series corresponding to the voucher type.
voucherNumber.displayVoucherNumber string True This is a concatenation of the prefix and voucherNumber.
voucherNumber.prefix string The number series prefix.
voucherNumber.voucherNumber number The number of the voucher.
voucherType Enum customerInvoice, customerPayment, supplierInvoice, supplierPayment, financeVoucher, reminder, openingEntry, transferredOpeningEntry, systemEntry, manualDebtorInvoice The type of voucher. Must be SupplierInvoice.

Get Voucher by date and Accounting Year

GET /accounting-years/:accountingYear/vouchers/:voucherId/:date

Schema name

accounting-years.accountingYear.vouchers.voucherId.date.get.schema.json

Return type

This method returns a single object

Required properties

date, lines.amount, lines.supplier.supplierNumber, numberSeries, voucherNumber, voucherType

Filterable properties

lines.accruals.account.accountNumber, lines.contraAccount.accountNumber, lines.contraAccount.accountType

Sortable properties

lines.accruals.account.accountNumber, lines.contraAccount.accountNumber, lines.contraAccount.accountType

Properties

Name Type Format Read-only Max length Values Description
attachment string uri A unique link reference to the attachment resource for this voucher item.
booked boolean True Is this voucher booked or not.
date string full-date Voucher issue date. The date is formatted according to ISO-8601 (YYYY-MM-DD).
dueDate string full-date The date the voucher is due for payment. Format according to ISO-8601 (YYYY-MM-DD). This is only used if the terms of payment is of type 'duedate’.
lines array An array containing the specific voucher lines.
lines.accruals object This is used to divide payments into equal sizes over a certain period of time.
lines.accruals.account object The account used by the accruals.
lines.accruals.account.accountNumber integer The account number.
lines.accruals.account.self string uri A unique reference to the account resource.
lines.accruals.endDate string full-date Accruals end date. The date is formatted according to ISO-8601.
lines.accruals.self string uri A unique link reference to the accruals item.
lines.accruals.startDate string full-date Accruals start date. The date is formatted according to ISO-8601.
lines.amount number The amount on the invoice line.
lines.amountInBaseCurrency number If you use base currency this must be the same as amount or not specified at all.
lines.booked boolean True Is this voucher booked or not.
lines.contraAccount object The contra account.
lines.contraAccount.accountNumber integer The account number.
lines.contraAccount.accountType Enum profitAndLoss, status The contra account must be of either ProfitAndLoss or Status type.
lines.contraAccount.self string uri A unique reference to the account resource.
lines.contraVatAccount object The contra account for VAT.
lines.contraVatAccount.self string uri A unique link reference to the contraVatAccount item.
lines.contraVatAccount.vatCode string 5 The unique identifier of the contra vat account.
lines.contraVatAmount number The amount of VAT on the voucher on the contra account.
lines.contraVatAmountInBaseCurrency number The amount of VAT on the voucher on the contra account in base currency.
lines.currency string 3 The currency the invoice is specified in.
lines.department object A reference to the department that this voucher will be connected with.
lines.department.departmentNumber integer The unique identifier of the department.
lines.department.self string uri A unique link reference to the department item.
lines.document string uri The unique reference to the file.
lines.entryNumber integer True The unique identifier of the invoice line.
lines.exchangeRate number The exchange rate between the base currency and the invoice currency.
lines.remittanceInformation object
lines.remittanceInformation.creditorId string 50 This could be the IBAN/SWIFT no, bank account no, bankgiro no or postgiro no depending on the payment type.
lines.remittanceInformation.creditorInvoiceId string 30 The OCR or message sent together with the creditorId.
lines.remittanceInformation.paymentType object The payment type used.
lines.remittanceInformation.paymentType.paymentTypeNumber integer The unique identifier of the payment type.
lines.remittanceInformation.paymentType.self string uri A unique link reference to the paymentType item.
lines.remittanceInformation.self string uri A unique link reference to the remittanceInformation item.
lines.supplier object The supplier is the vendor from whom you buy your goods.
lines.supplier.self string uri A unique self reference of the supplier.
lines.supplier.supplierNumber integer The supplier number is a unique numerical identifier.
lines.supplierInvoiceNumber string The unique identifier of the supplier invoice gotten from the supplier.
lines.text string 250 The text on the voucher line.
lines.vatAccount object The account for VAT.
lines.vatAccount.self string uri A unique link reference to the vatAccount item.
lines.vatAccount.vatCode string 5 The unique identifier of the vat account.
lines.vatAmount number The amount of VAT on the voucher. Used if the line has a VAT account.
lines.vatAmountInBaseCurrency number The amount of VAT on the voucher in base currency.
numberSeries object The number series corresponding to the voucher type.
numberSeries.numberSeriesNumber integer The unique identifier of the number series.
numberSeries.self string uri A unique link reference to the number series item.
remainder number True Remaining amount to be paid.
remainderInDefaultCurrency number True Remaining amount to be paid in default currency.
self string uri A unique link reference to the voucher item.
voucherId number True Part of the unique identifier of a voucher.
voucherNumber object The number series corresponding to the voucher type.
voucherNumber.displayVoucherNumber string True This is a concatenation of the prefix and voucherNumber.
voucherNumber.prefix string The number series prefix.
voucherNumber.voucherNumber number The number of the voucher.
voucherType Enum customerInvoice, customerPayment, supplierInvoice, supplierPayment, financeVoucher, reminder, openingEntry, transferredOpeningEntry, systemEntry, manualDebtorInvoice The type of voucher. Must be SupplierInvoice.

Accounts

Accounts are the records in the general ledger where companies record the monetary transactions.

Get all Accounts

GET /accounts

View response example

Schema name

accounts.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Filterable properties

accountNumber, accountType, balance, barred, blockDirectEntries, debitCredit, name

Sortable properties

accountNumber, accountType, balance, blockDirectEntries, debitCredit, name

Default sorting

accountNumber : ascending

Properties

Name Type Format Max length Values Description
accountCategory object The category of each account.
accountCategory.accountCategoryNumber integer The unique account category number.
accountCategory.useInvertedAccountCategory boolean Allows the account category to change automatically.
accountingYears string uri A link to a list of accounting years for which the account is usable.
accountNumber integer The account’s number.
accountsSummed array An array of the account intervals used for calculating the total for this account.
accountsSummed.fromAccount object The first account in the interval.
accountsSummed.fromAccount.accountNumber integer Account number of the first account in the interval.
accountsSummed.fromAccount.self string uri The unique self link of the first account in the interval.
accountsSummed.toAccount object The last account in the interval.
accountsSummed.toAccount.accountNumber integer Account number of the last account in the interval.
accountsSummed.toAccount.self string uri The unique self link of the last account in the interval.
accountType Enum profitAndLoss, status, totalFrom, heading, headingStart, sumInterval, sumAlpha The type of account in the chart of accounts.
balance number The current balanace of the account.
barred boolean Shows if the account is barred from being used.
blockDirectEntries boolean Determines if the account can be manually updated with entries.
contraAccount object The default contra account of the account.
contraAccount.accountNumber integer Account number of the contra account.
contraAccount.self string uri The unique self link of the contra account.
debitCredit Enum debit, credit Describes the default update type of the account.
draftBalance number The current balance of the account including draft (not yet booked) entries.
name string 125 The name of the account.
self string uri A unique reference to the account ressource.
totalFromAccount object The account from which the sum total for this account is calculated.
totalFromAccount.accountNumber integer Account number of the first account.
totalFromAccount.self string uri The unique self link of the first account.
vatAccount object The default VAT code for this account.
vatAccount.self string uri The unique self link of the VAT code.
vatAccount.vatCode string 5 The VAT code of the VAT account for this account.

Get specific Account

GET /accounts/:accountNumber

Schema name

accounts.accountNumber.get.schema.json

Return type

This method returns a single object

Filterable properties

accountNumber, accountType, balance, barred, blockDirectEntries, debitCredit, name

Sortable properties

accountNumber, accountType, balance, blockDirectEntries, debitCredit, name

Properties

Name Type Format Max length Values Description
accountCategory object The category for this account.
accountCategory.accountCategoryNumber integer The unique account category number.
accountCategory.useInvertedAccountCategory boolean Allows the account category to change automatically.
accountingYears string uri A link to a list of accounting years for which the account is usable.
accountNumber integer The account’s number.
accountsSummed array An array of the account intervals used for calculating the total for this account.
accountsSummed.fromAccount object The first account in the interval.
accountsSummed.fromAccount.accountNumber integer Account number of the first account in the interval.
accountsSummed.fromAccount.self string uri The unique self link of the first account in the interval.
accountsSummed.toAccount object The last account in the interval.
accountsSummed.toAccount.accountNumber integer Account number of the last account in the interval.
accountsSummed.toAccount.self string uri The unique self link of the last account in the interval.
accountType Enum profitAndLoss, status, totalFrom, heading, headingStart, sumInterval, sumAlpha The type of account in the chart of accounts.
balance number The current balanace of the account.
barred boolean Shows if the account is barred from being used.
blockDirectEntries boolean Determines if the account can be manually updated with entries.
contraAccount object The default contra account of the account.
contraAccount.accountNumber integer Account number of the contra account.
contraAccount.self string uri The unique self link of the contra account.
debitCredit Enum debit, credit Describes the default update type of the account.
draftBalance number The current balance of the account including draft (not yet booked) entries.
name string 125 The name of the account.
self string uri A unique reference to the account ressource.
totalFromAccount object The account from which the sum total for this account is calculated.
totalFromAccount.accountNumber integer Account number of the first account.
totalFromAccount.self string uri The unique self link of the first account.
vatAccount object The default VAT code for this account.
vatAccount.self string uri The unique self link of the VAT code.
vatAccount.vatCode string 5 The VAT code of the VAT account for this account.

Create Account

POST /accounts

Return type

This method returns a single object

Properties

Name Type Values Description
accountCategory object The category of the account.
accountingYears object A link to a list of accounting years for which the account is usable.
accountNumber integer The number of the account
accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
barred boolean Used to bar the account from being used - default is false.
blockDirectEntries boolean Determines if the account can be manually updated with entries.
contraAccount object The default contra account of the account.
debitCredit object Debit, Credit Describes the default update type of the account.
department object Department associated with the account.
departmentalDistribution object Departmental distribution, used to split on more than one department.
displayNumber string String representation of the Account number, for display and sorting purposes.
openingAccount object The associted opening account.
requireDepartmentalDistributionOnEntries boolean Whether or not the departmental distribution is required on entries.
totalFromAccount object The account from which the sum total for this account is calculated.
vatAccount object The default VAT code for this account.

Update Account

PUT /accounts/:accountNumber

Return type

This method returns a single object

Properties

Name Type Values Description
accountCategory object The category of the account.
accountingYears object A link to a list of accounting years for which the account is usable.
accountNumber integer The number of the account
accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
barred boolean Used to bar the account from being used - default is false.
blockDirectEntries boolean Determines if the account can be manually updated with entries.
contraAccount object The default contra account of the account.
debitCredit object Debit, Credit Describes the default update type of the account.
department object Department associated with the account.
departmentalDistribution object Departmental distribution, used to split on more than one department.
displayNumber string String representation of the Account number, for display and sorting purposes.
openingAccount object The associted opening account.
requireDepartmentalDistributionOnEntries boolean Whether or not the departmental distribution is required on entries.
totalFromAccount object The account from which the sum total for this account is calculated.
vatAccount object The default VAT code for this account.

Delete Account

DELETE /accounts/:accountNumber

Get all Accounting Years for Account

GET /accounts/:accountNumber/accounting-years

Schema name

accounts.accountNumber.accounting-years.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Filterable properties

closed, fromDate, toDate, year

Sortable properties

closed, fromDate, toDate, year

Default sorting

fromDate : ascending

Properties

Name Type Format Description
closed boolean Determines if the accounting year is closed for further transactions.
entries string uri A link to a collection of all entries booked in the accounting year.
fromDate string full-date The first date in the accounting year formated according to ISO-8601 (YYYY-MM-DD). Except for the first accounting year on an agreement, it must be the date immediately following the previous accounting year, and thus must be the first day of a month. The first accounting year on an agreement can begin on any day of the month.
periods string uri A link to the collection of accounting year periods on an agreement.
self string uri A unique link reference to the accounting year item.
toDate string full-date The last date in the accounting year formated according to ISO-8601 (YYYY-MM-DD). It must be the last date in the last month of the accounting year. An accounting year can at most have a duration of 18 months.
totals string uri A link to the chart of accounts with the years total in base currency.
vouchers string uri A link to a collection of vouchers created in the accounting year.
year string The calendar year or years spanned by the accounting year formatted according to ISO-8601(YYYY-MM-DD).

Get specific Accounting Year

GET /accounts/:accountNumber/accounting-years/:accountingYear

Schema name

accounts.accountNumber.accounting-years.accountingYear.get.schema.json

Return type

This method returns a single object

Filterable properties

closed, fromDate, toDate, year

Sortable properties

closed, fromDate, toDate, year

Default sorting

fromDate : ascending

Properties

Name Type Format Description
closed boolean Determines if the accounting year is closed for further transactions.
entries string uri A link to a collection of all entries booked in the accounting year.
fromDate string full-date The first date in the accounting year formatted according to ISO-8601(YYYY-MM-DD). Except for the first accounting year on an agreement, it must be the date immediately following the previous accounting year, and thus must be the first day of a month. The first accounting year on an agreement can begin on any day of the month.
periods string uri A link to the collection of accounting year periods on an agreement.
self string uri A unique link reference to the accounting year item.
toDate string full-date The last date in the accounting year formatted according to ISO-8601(YYYY-MM-DD). It must be the last date in the last month of the accounting year. An accounting year can at most have a duration of 18 months.
totals string uri A link to the chart of accounts with the years total in base currency.
vouchers string uri A link to a collection of vouchers created in the accounting year.
year string The calendar year or years spanned by the accounting year formatted according to ISO-8601(YYYY-MM-DD).

Get Entries on Account in Accounting Year

GET /accounts/:accountNumber/accounting-years/:accountingYear/entries

Schema name

accounts.accountNumber.accounting-years.accountingYear.entries.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Filterable properties

currency, date

Sortable properties

currency, date

Properties

Name Type Format Max length Min value Values Description
account object The account the entry is connected to.
account.accountNumber integer 1 A unique identifier of the account.
account.self string uri A unique reference to the account resource.
amount number The total entry amount.
amountInBaseCurrency number The total entry amount in base currency.
currency string The ISO 4217 currency code of the entry.
date string full-date Invoice issue date. The date is formatted according to ISO-8601(YYYY-MM-DD).
departmentalDistribution object The departmental distribution the entry is connected to.
departmentalDistribution.departmentalDistributionNumber integer 1 A unique identifier of the departmental distribution.
departmentalDistribution.self string uri A unique reference to the departmental distribution resource.
entryNumber integer The unique identifier of the entry line.
entryType Enum customerInvoice, customerPayment, supplierInvoice, supplierPayment, financeVoucher, reminder, openingEntry, transferredOpeningEntry, systemEntry, manualDebtorInvoice The type of entry.
pdf object References a pdf representation of this entry.
pdf.self string uri The unique reference of the pdf representation for this entry.
project object The project the entry is connected to.
project.projectNumber integer 1 A unique identifier of the project.
project.self string uri A unique reference to the project resource.
self string uri A unique reference to the accounting year entries resource.
text string 255 A short description about the entry.
vatAccount object The account for VAT.
vatAccount.self string uri A unique link reference to the vatAccount item.
vatAccount.vatCode string 5 The unique identifier of the vat account.
voucherNumber integer The identifier of the voucher this entry belongs to.

Get Totals for Account in Accounting Year

GET /accounts/:accountNumber/accounting-years/:accountingYear/totals

Schema name

accounts.accountNumber.accounting-years.accountingYear.totals.get.schema.json

Return type

This method returns a single object

Filterable properties

account.accountNumber, fromDate, toDate

Sortable properties

account.accountNumber, fromDate, toDate

Default sorting

fromDate : ascending

Properties

Name Type Format Description
account object The account used.
account.accountNumber integer The account number.
account.self string uri A unique reference to the account resource.
fromDate string full-date The first date in the period formated according to ISO-8601 (YYYY-MM-DD).
toDate string full-date The last date in the period formated according to ISO-8601 (YYYY-MM-DD).
totalInBaseCurrency number The total entry amount in base currency for the accounting year.

Get Vouchers on Account in Accounting Year

GET /accounts/:accountNumber/accounting-years/:accountingYear/vouchers

Schema name

accounts.accountNumber.accounting-years.accountingYear.vouchers.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Required properties

date, lines.amount, lines.supplier.supplierNumber, numberSeries, voucherType

Filterable properties

lines.accruals.account.accountNumber, lines.contraAccount.accountNumber, lines.contraAccount.accountType

Sortable properties

lines.accruals.account.accountNumber, lines.contraAccount.accountNumber, lines.contraAccount.accountType

Properties

Name Type Format Read-only Max length Values Description
booked boolean True Is this voucher booked or not.
date string full-date Voucher issue date. The date is formatted according to ISO-8601 (YYYY-MM-DD).
dueDate string full-date The date the voucher is due for payment. Format according to ISO-8601 (YYYY-MM-DD). This is only used if the terms of payment is of type ‘duedate’.
lines array An array containing the specific voucher lines.
lines.accruals object This is used to divide payments into equal sizes over a certain period of time.
lines.accruals.account object The account used by the accruals.
lines.accruals.account.accountNumber integer The account number.
lines.accruals.account.self string uri A unique reference to the account resource.
lines.accruals.endDate string full-date Accruals end date. The date is formatted according to ISO-8601.
lines.accruals.self string uri A unique link reference to the accruals item.
lines.accruals.startDate string full-date Accruals start date. The date is formatted according to ISO-8601.
lines.amount number The amount on the invoice line.
lines.amountInBaseCurrency number If you use base currency this must be the same as amount or not specified at all.
lines.booked boolean True Is this voucher booked or not.
lines.contraAccount object The contra account.
lines.contraAccount.accountNumber integer The account number.
lines.contraAccount.accountType Enum profitAndLoss, status The contra account must be of either ProfitAndLoss or Status type.
lines.contraAccount.self string uri A unique reference to the account resource.
lines.contraVatAccount object The contra account for VAT.
lines.contraVatAccount.self string uri A unique link reference to the contraVatAccount item.
lines.contraVatAccount.vatCode string 5 The unique identifier of the contra vat account.
lines.contraVatAmount number The amount of VAT on the voucher on the contra account.
lines.contraVatAmountInBaseCurrency number The amount of VAT on the voucher on the contra account in base currency.
lines.currency string 3 The currency the invoice is specified in.
lines.department object A reference to the department that this voucher will be connected with.
lines.department.departmentNumber integer The unique identifier of the department.
lines.department.self string uri A unique link reference to the department item.
lines.document string uri The unique reference to the file.
lines.entryNumber integer True The unique identifier of the invoice line.
lines.exchangeRate number The exchange rate between the base currency and the invoice currency.
lines.remittanceInformation object
lines.remittanceInformation.creditorId string 50 This could be the IBAN/SWIFT no, bank account no, bankgiro no or postgiro no depending on the payment type.
lines.remittanceInformation.creditorInvoiceId string 30 The OCR or message sent together with the creditorId.
lines.remittanceInformation.paymentType object The payment type used.
lines.remittanceInformation.paymentType.paymentTypeNumber integer The unique identifier of the payment type.
lines.remittanceInformation.paymentType.self string uri A unique link reference to the paymentType item.
lines.remittanceInformation.self string uri A unique link reference to the remittanceInformation item.
lines.supplier object The supplier is the vendor from whom you buy your goods.
lines.supplier.self string uri A unique self reference of the supplier.
lines.supplier.supplierNumber integer The supplier number is a unique numerical identifier.
lines.supplierInvoiceNumber string The unique identifier of the supplier invoice gotten from the supplier.
lines.text string 250 The text on the voucher line.
lines.vatAccount object The account for VAT.
lines.vatAccount.self string uri A unique link reference to the vatAccount item.
lines.vatAccount.vatCode string 5 The unique identifier of the vat account.
lines.vatAmount number The amount of VAT on the voucher. Used if the line has a VAT account.
lines.vatAmountInBaseCurrency number The amount of VAT on the voucher in base currency.
numberSeries object The number series corresponding to the voucher type.
numberSeries.numberSeriesNumber integer The unique identifier of the number series.
numberSeries.self string uri A unique link reference to the number series item.
remainder number True Remaining amount to be paid.
remainderInDefaultCurrency number True Remaining amount to be paid in default currency.
self string uri A unique reference to the accounting year vouchers resource.
voucherType Enum supplierInvoice The type of voucher. Must be SupplierInvoice.

Get Periods for Account

GET /accounts/:accountNumber/accounting-years/:accountingYear/periods

Schema name

accounts.accountNumber.accounting-years.accountingYear.periods.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Filterable properties

closed, fromDate, toDate

Sortable properties

closed, fromDate, toDate

Default sorting

fromDate : ascending

Properties

Name Type Format Max length Min value Description
accountingYear object The accounting year the period is part of.
accountingYear.self string uri A unique reference to the accounting year resource.
accountingYear.year string 4 A unique identifier of the accounting year.
closed boolean Determines if the period is closed for further transactions.
entries string uri A link to a collection of all entries booked in the period.
fromDate string full-date The first date in the period formated according to ISO-8601 (YYYY-MM-DD).
periodNumber integer 1 A unique identifier of the period.
self string uri A unique link reference to the period item.
toDate string full-date The last date in the period formated according to ISO-8601 (YYYY-MM-DD).
totals string uri A link to the chart of accounts with the periods total in base currency.

Get specific Period for Account

GET /accounts/:accountNumber/accounting-years/:accountingYear/periods/:accountingYearPeriod

Schema name

accounts.accountNumber.accounting-years.accountingYear.periods.accountingYearPeriod.get.schema.json

Return type

This method returns a single object

Filterable properties

closed, fromDate, toDate

Sortable properties

closed, fromDate, toDate

Default sorting

fromDate : ascending

Properties

Name Type Format Max length Min value Description
accountingYear object The accounting year the period is part of.
accountingYear.self string uri A unique reference to the accounting year resource.
accountingYear.year string 4 A unique identifier of the accounting year.
closed boolean Determines if the period is closed for further transactions.
entries string uri A link to a collection of all entries booked in the period.
fromDate string full-date The first date in the period formatted according to ISO-8601(YYYY-MM-DD).
periodNumber integer 1 A unique identifier of the period.
self string uri A unique link reference to the period item.
toDate string full-date The last date in the period formatted according to ISO-8601(YYYY-MM-DD).
totals string uri A link to the chart of accounts with the periods total in base currency.

Get Entries on Account in specific Period

GET /accounts/:accountNumber/accounting-years/:accountingYear/periods/:accountingYearPeriod/entries

Schema name

accounts.accountNumber.accounting-years.accountingYear.periods.accountingYearPeriod.entries.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Filterable properties

currency, date

Sortable properties

currency, date

Properties

Name Type Format Max length Min value Values Description
account object The account the entry is connected to.
account.accountNumber integer 1 A unique identifier of the account.
account.self string uri A unique reference to the account resource.
amount number The total entry amount.
amountInBaseCurrency number The total entry amount in base currency.
currency string The ISO 4217 currency code of the entry.
date string full-date Invoice issue date. The date is formatted according to ISO-8601(YYYY-MM-DD).
departmentalDistribution object The departmental distribution the entry is connected to.
departmentalDistribution.departmentalDistributionNumber integer 1 A unique identifier of the departmental distribution.
departmentalDistribution.self string uri A unique reference to the departmental distribution resource.
entryNumber integer The unique identifier of the entry line.
entryType Enum customerInvoice, customerPayment, supplierInvoice, supplierPayment, financeVoucher, reminder, openingEntry, transferredOpeningEntry, systemEntry, manualDebtorInvoice The type of entry.
pdf object References a pdf representation of this entry.
pdf.self string uri The unique reference of the pdf representation for this entry.
project object The project the entry is connected to.
project.projectNumber integer 1 A unique identifier of the project.
project.self string uri A unique reference to the project resource.
self string uri A unique reference to the accounting year period entries resource.
text string 255 A short description about the entry.
vatAccount object The account for VAT.
vatAccount.self string uri A unique link reference to the vatAccount item.
vatAccount.vatCode string 5 The unique identifier of the vat account.
voucherNumber integer The identifier of the voucher this entry belongs to.

Get Period Totals for Account

GET /accounts/:accountNumber/accounting-years/:accountingYear/periods/:accountingYearPeriod/totals

Schema name

accounts.accountNumber.accounting-years.accountingYear.periods.accountingYearPeriod.totals.get.schema.json

Return type

This method returns a single object

Filterable properties

account.accountNumber, fromDate, toDate

Sortable properties

account.accountNumber, fromDate, toDate

Default sorting

fromDate : ascending

Properties

Name Type Format Description
account object The account used.
account.accountNumber integer The account number.
account.self string uri A unique reference to the account resource.
fromDate string full-date The first date in the period formatted according to ISO-8601(YYYY-MM-DD).
toDate string full-date The last date in the period formatted according to ISO-8601(YYYY-MM-DD).
totalInBaseCurrency number The total entry amount in base currency for the accounting year period.

Get Vouchers on Account in specific Period

GET /accounts/:accountNumber/accounting-years/:accountingYear/periods/:accountingYearPeriod/vouchers

Schema name

accounts.accountNumber.accounting-years.accountingYear.periods.accountingYearPeriod.vouchers.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Required properties

date, lines.amount, lines.supplier.supplierNumber, numberSeries, voucherType

Filterable properties

lines.accruals.account.accountNumber, lines.contraAccount.accountNumber, lines.contraAccount.accountType

Sortable properties

lines.accruals.account.accountNumber, lines.contraAccount.accountNumber, lines.contraAccount.accountType

Properties

Name Type Format Read-only Max length Values Description
booked boolean True Is this voucher booked or not.
date string full-date Voucher issue date. The date is formatted according to ISO-8601 (YYYY-MM-DD).
dueDate string full-date The date the voucher is due for payment. Format according to ISO-8601 (YYYY-MM-DD). This is only used if the terms of payment is of type 'duedate’.
lines array An array containing the specific voucher lines.
lines.accruals object This is used to divide payments into equal sizes over a certain period of time.
lines.accruals.account object The account used by the accruals.
lines.accruals.account.accountNumber integer The account number.
lines.accruals.account.self string uri A unique reference to the account resource.
lines.accruals.endDate string full-date Accruals end date. The date is formatted according to ISO-8601(YYYY-MM-DD).
lines.accruals.self string uri A unique link reference to the accruals item.
lines.accruals.startDate string full-date Accruals start date. The date is formatted according to ISO-8601(YYYY-MM-DD).
lines.amount number The amount on the invoice line.
lines.amountInBaseCurrency number If you use base currency this must be the same as amount or not specified at all.
lines.booked boolean True Is this voucher booked or not.
lines.contraAccount object The contra account.
lines.contraAccount.accountNumber integer The account number.
lines.contraAccount.accountType Enum profitAndLoss, status The contra account must be of either ProfitAndLoss or Status type.
lines.contraAccount.self string uri A unique reference to the account resource.
lines.contraVatAccount object The contra account for VAT.
lines.contraVatAccount.self string uri A unique link reference to the contraVatAccount item.
lines.contraVatAccount.vatCode string 5 The unique identifier of the contra vat account.
lines.contraVatAmount number The amount of VAT on the voucher on the contra account.
lines.contraVatAmountInBaseCurrency number The amount of VAT on the voucher on the contra account in base currency.
lines.currency string 3 The currency the invoice is specified in.
lines.department object A reference to the department that this voucher will be connected with.
lines.department.departmentNumber integer The unique identifier of the department.
lines.department.self string uri A unique link reference to the department item.
lines.document string uri The unique reference to the file.
lines.entryNumber integer True The unique identifier of the invoice line.
lines.exchangeRate number The exchange rate between the base currency and the invoice currency.
lines.remittanceInformation object
lines.remittanceInformation.creditorId string 50 This could be the IBAN/SWIFT no, bank account no, bankgiro no or postgiro no depending on the payment type.
lines.remittanceInformation.creditorInvoiceId string 30 The OCR or message sent together with the creditorId.
lines.remittanceInformation.paymentType object The payment type used.
lines.remittanceInformation.paymentType.paymentTypeNumber integer The unique identifier of the payment type.
lines.remittanceInformation.paymentType.self string uri A unique link reference to the paymentType item.
lines.remittanceInformation.self string uri A unique link reference to the remittanceInformation item.
lines.supplier object The supplier is the vendor from whom you buy your goods.
lines.supplier.self string uri A unique self reference of the supplier.
lines.supplier.supplierNumber integer The supplier number is a unique numerical identifier.
lines.supplierInvoiceNumber string The unique identifier of the supplier invoice gotten from the supplier.
lines.text string 250 The text on the voucher line.
lines.vatAccount object The account for VAT.
lines.vatAccount.self string uri A unique link reference to the vatAccount item.
lines.vatAccount.vatCode string 5 The unique identifier of the vat account.
lines.vatAmount number The amount of VAT on the voucher. Used if the line has a VAT account.
lines.vatAmountInBaseCurrency number The amount of VAT on the voucher in base currency.
numberSeries object The number series corresponding to the voucher type.
numberSeries.numberSeriesNumber integer The unique identifier of the number series.
numberSeries.self string uri A unique link reference to the number series item.
remainder number True Remaining amount to be paid.
remainderInDefaultCurrency number True Remaining amount to be paid in default currency.
self string uri A unique reference to the accounting year vouchers resource.
voucherType Enum supplierInvoice The type of voucher. Must be SupplierInvoice.

Additional Expenses

Additional expenses allow adding supplementary lines to an invoice.
Read the blog post for more info and examples.

Get all Additional Expenses

GET /additional-expenses

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Read-only Description
account object Account
account.accountNumber integer The number of the account
account.name string True The name of the account.
additionalExpenseNumber integer A reference number for the additional expense.
name string Additional expense name
vatAccount object Default VAT account
vatAccount.vatCode string The vat code of the vat account.

Get a single Additional Expense

GET /additional-expenses/:expenseNumber

Return type

This method returns a single object

Properties

Name Type Read-only Description
account object Account
account.accountNumber integer The number of the account
account.name string True The name of the account.
additionalExpenseNumber integer A reference number for the additional expense.
name string Additional expense name
vatAccount object Default VAT account
vatAccount.vatCode string The vat code of the vat account.

Create a new Additional Expense

POST /additional-expenses

Return type

This method returns a single object

Required properties

account, name, vatAccount

Properties

Name Type Description
account object Account
additionalExpenseNumber integer A reference number for the additional expense.
name string Additional expense name
vatAccount object Default VAT account

Create or Update an Additional Expense

PUT /additional-expenses/:expenseNumber

Return type

This method returns a single object

Required properties

account, name, vatAccount

Properties

Name Type Description
account object Account
additionalExpenseNumber integer A reference number for the additional expense.
name string Additional expense name
vatAccount object Default VAT account

Delete an Additional Expense

DELETE /additional-expenses/:expenseNumber

Alias-Layers

The API exposes a list of all the alias-layers available in Reviso.

Get Alias-Layers

GET /alias-layers

Get list of all available alias-layers.

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Description
aliasLayerNumber integer A unique identifier of the alias layer.
name string The name of the alias layer.
productAliases object The product aliases for the current alias-layer.
productAliases.descriptionAlias string The alias for the description of the product.
productAliases.nameAlias string The alias for the name of the product.
productAliases.productNumber string The product identifier.

Get specific Alias-Layer

GET /alias-layers/:code

Return type

This method returns a single object

Properties

Name Type Description
aliasLayerNumber integer A unique identifier of the alias layer.
name string The name of the alias layer.
productAliases object The product aliases for the current alias-layer.
productAliases.descriptionAlias string The alias for the description of the product.
productAliases.nameAlias string The alias for the name of the product.
productAliases.productNumber string The product identifier.

App roles

When requesting an API token, the external App asks for access to a certain set of features on behalf of the user. Each set of privileges is called an App role. This exposes the list of available App roles and their required modules.

Get App roles

GET /app-roles

View response example

<!_app-roles.get.schema.md!>

Get specific App role

GET /app-roles/:roleNumber

<!_app-roles.roleNumber.get.schema.md!>

Apps

API Apps are what the users of your product interact with. This resource defines what level of access an app requires as well as a descriptive name.

When you create an app, a private key is returned in the response. Save that, since you will not see that in any subsequent responses.

Get Apps

GET /apps

View response example

<!_apps.get.schema.md!>

Get specific App

GET /apps/:appNumber

Schema name

apps.appNumber.get.schema.json

Return type

This method returns a single object

Properties

Name Type Format Max length Min length Min value Values Description
appNumber integer 0 A reference number for the API App.
appPublicToken string 50 1 The appPublicToken is used for issuing grants.
appSecretToken string 50 1 The appSecretToken is used for accessing the API along side the agreementGrantToken. This is only displayed right after creating a new app.
created string full-date Date when the API App was created.
grantUrl string 500 1 Link used for issuing grants.
name string 50 1 API App name, which is displayed to people before they grant access.
requiredRoles array Roles required to issue a grant.
requiredRoles.name string 100 1 SuperUser, BookKeeping, Sales, ProjectEmployee API Role name.
requiredRoles.requiredModules object Module or modules required for the role.
requiredRoles.roleNumber integer 0 A reference number for the API Role.
rootUrl string 200 1 Root URL used for issuing grants. Redirects after the grant are restricted to this Root URL.
self string uri The unique self reference of the app.

Create App

POST /apps

<!_apps.post.schema.md!>

App Settings

These endpoints allow you to save and modify a set of custom settings specific to your app. The settings will only be exposed for your app and are not visible for anybody else. Settings can be specific to the authenticated user or to the agreement as a whole. You can save up to 200 settings per user and 200 per agreement.

The settings are key-value sets where the key is a string and the setting has to be a valid json document.

Get App Settings

GET /app-settings

View example

Schema name

app-settings.get.schema.json

Return type

This method returns a single object

Properties

Name Type Format Description
agreement string uri A reference to the agreements app settings collection.
user string uri A reference to the users app settings collection.

Get App Settings for current agreement

GET /app-settings/agreement

View example

Schema name

app-settings.agreement.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Required properties

content, settingKey

Properties

Name Type Format Description
content object The setting payload.
self string uri A unique link reference to the app setting item.
settingKey string A unique key.

Get specific App setting

GET /app-settings/agreement/:settingId

Schema name

app-settings.agreement.settingId.get.schema.json

Return type

This method returns a single object

Required properties

content, settingKey

Properties

Name Type Format Description
content object The setting payload.
self string uri A unique link reference to the app setting item.
settingKey string A unique key.

Create/update App Setting

PUT /app-settings/agreement/:settingId

View code example

Schema name

app-settings.agreement.settingId.put.schema.json

Return type

This method returns a single object

Required properties

content, settingKey

Properties

Name Type Format Description
content object The setting payload.
self string uri A unique link reference to the setting item.
settingKey string A unique key.

Delete App Setting

DELETE /app-settings/agreement/:settingId

Get App Settings for current user

GET /app-settings/user

View response example

Schema name

app-settings.user.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Required properties

content, settingKey

Properties

Name Type Format Description
content object The setting payload.
self string uri A unique link reference to the app setting item.
settingKey string A unique key.

Get specific App Setting for current user

GET /app-settings/user/:settingId

Schema name

app-settings.user.settingId.get.schema.json

Return type

This method returns a single object

Required properties

content, settingKey

Properties

Name Type Format Description
content object The setting payload.
self string uri A unique link reference to the app setting item.
settingKey string A unique key.

Create/update App Setting for current user

PUT /app-settings/user/:settingId

Schema name

app-settings.user.settingId.put.schema.json

Return type

This method returns a single object

Required properties

content, settingKey

Properties

Name Type Format Description
content object The setting payload.
self string uri A unique link reference to the setting item.
settingKey string A unique key.

Delete App Setting for current user

DELETE /app-settings/user/:settingId

Asset Groups

Get Asset Groups

GET /asset-groups

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Read-only Description
additionAccount object Asset addition account.
additionAccount.accountNumber integer The number of the account
additionAccount.name string True The name of the account.
assetGroupNumber integer The group number is a unique numerical identifier.
depreciationAccountBalanceSheet object Asset depreciation account in the balance sheet.
depreciationAccountBalanceSheet.accountNumber integer The number of the account
depreciationAccountBalanceSheet.name string True The name of the account.
depreciationAccountProfitLoss object Asset depreciation account in the profit and loss.
depreciationAccountProfitLoss.accountNumber integer The number of the account
depreciationAccountProfitLoss.name string True The name of the account.
disposalsAccount object Asset disposals account.
disposalsAccount.accountNumber integer The number of the account
disposalsAccount.name string True The name of the account.
name string The name of the asset group.
netBookedValueAccount object Net Booked Value account.
netBookedValueAccount.accountNumber integer The number of the account
netBookedValueAccount.name string True The name of the account.
openingAdditionAccount object Opening addition account.
openingAdditionAccount.accountNumber integer The number of the account
openingAdditionAccount.name string True The name of the account.
openingDepreciationAccount object Opening depreciation account.
openingDepreciationAccount.accountNumber integer The number of the account
openingDepreciationAccount.name string True The name of the account.
residualValue integer Value of the asset at the end of the useful life.
reversedDepreciationsAccount object Asset reversed depreciation account.
reversedDepreciationsAccount.accountNumber integer The number of the account
reversedDepreciationsAccount.name string True The name of the account.
usefulLife integer Useful life of the asset in months.

Get specific Asset Group

GET /asset-groups/:assetGroupNumber

Return type

This method returns a single object

Properties

Name Type Read-only Description
additionAccount object Asset addition account.
additionAccount.accountNumber integer The number of the account
additionAccount.name string True The name of the account.
assetGroupNumber integer The group number is a unique numerical identifier.
depreciationAccountBalanceSheet object Asset depreciation account in the balance sheet.
depreciationAccountBalanceSheet.accountNumber integer The number of the account
depreciationAccountBalanceSheet.name string True The name of the account.
depreciationAccountProfitLoss object Asset depreciation account in the profit and loss.
depreciationAccountProfitLoss.accountNumber integer The number of the account
depreciationAccountProfitLoss.name string True The name of the account.
disposalsAccount object Asset disposals account.
disposalsAccount.accountNumber integer The number of the account
disposalsAccount.name string True The name of the account.
name string The name of the asset group.
netBookedValueAccount object Net Booked Value account.
netBookedValueAccount.accountNumber integer The number of the account
netBookedValueAccount.name string True The name of the account.
openingAdditionAccount object Opening addition account.
openingAdditionAccount.accountNumber integer The number of the account
openingAdditionAccount.name string True The name of the account.
openingDepreciationAccount object Opening depreciation account.
openingDepreciationAccount.accountNumber integer The number of the account
openingDepreciationAccount.name string True The name of the account.
residualValue integer Value of the asset at the end of the useful life.
reversedDepreciationsAccount object Asset reversed depreciation account.
reversedDepreciationsAccount.accountNumber integer The number of the account
reversedDepreciationsAccount.name string True The name of the account.
usefulLife integer Useful life of the asset in months.

Country Codes

Get Country Codes

GET /country-codes

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Description
code string The 2 letter code for the country.

Get specific Country Code

GET /country-codes/:code

Return type

This method returns a single object

Properties

Name Type Description
code string The 2 letter code for the country.

Currencies

The API exposes a list of all the currencies available in Reviso.

Exchange rates are not available through the API. Consider using an external service such as Fixer.io to get live exchange rates.

Get Currencies

GET /currencies

Get list of all available currencies.

View response example

Schema name

currencies.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Max length Description
code string 3 The ISO 4217 code of the currency.
isoNumber string 3 The ISO 4217 numeric code of the currency.
name string 50 The name of the currency.
self string uri The unique self reference of the currency resource.

Get specific Currency

GET /currencies/:code

Schema name

currencies.code.get.schema.json

Return type

This method returns a single object

Properties

Name Type Format Max length Description
code string 3 The ISO 4217 code of the currency.
isoNumber string 3 The ISO 4217 numeric code of the currency.
name string 50 The name of the currency.
self string uri The unique self reference of the currency resource.

Customer Groups

Read more about Customer Groups in our online help.

Get Customer Groups

GET /customer-groups

View response example

Schema name

customer-groups.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Filterable properties

account.accountNumber, account.accountType, account.balance, account.blockDirectEntries, account.debitCredit, account.name, customerGroupNumber, name

Sortable properties

account.accountNumber, account.accountType, account.balance, account.blockDirectEntries, account.debitCredit, account.name, customerGroupNumber, name

Properties

Name Type Format Max length Values Description
account object The account used by the accruals.
account.accountingYears string uri A unique reference to the accounting years for this account.
account.accountNumber integer The account number.
account.accountType Enum profitAndLoss, status, totalFrom, heading, headingStart, sumInterval, sumAlpha The type of account in the chart of accounts.
account.balance number The current balance of the account.
account.blockDirectEntries boolean Determines if the account can be manually updated with entries.
account.debitCredit Enum debit, credit Describes the default update type of the account.
account.name string 125 The name of the account.
account.self string uri A unique reference to the account resource.
customerGroupNumber integer The customer groups number.
customers string uri The unique self reference of the customers belonging to this customer group.
name string 50 The name of the customer group.
self string uri The unique self reference of the customer group.

Get specific Customer Group

GET /customer-groups/:customerGroupNumber

Schema name

customer-groups.customerGroupNumber.get.schema.json

Return type

This method returns a single object

Filterable properties

account.accountNumber, account.accountType, account.balance, account.blockDirectEntries, account.debitCredit, account.name, customerGroupNumber, name

Sortable properties

account.accountNumber, account.accountType, account.balance, account.blockDirectEntries, account.debitCredit, account.name, customerGroupNumber, name

Properties

Name Type Format Max length Values Description
account object The account used by the accruals.
account.accountingYears string uri A unique reference to the accounting years for this account.
account.accountNumber integer The account number.
account.accountType Enum profitAndLoss, status, totalFrom, heading, headingStart, sumInterval, sumAlpha The type of account in the chart of accounts.
account.balance number The current balance of the account.
account.blockDirectEntries boolean Determines if the account can be manually updated with entries.
account.debitCredit Enum debit, credit Describes the default update type of the account.
account.name string 125 The name of the account.
account.self string uri A unique reference to the account resource.
customerGroupNumber integer The customer groups number.
customers string uri The unique self reference of the customers belonging to this customer group.
name string 50 The name of the customer group.
self string uri The unique self reference of the customer group.

Get Customers in Customer Group

GET /customer-groups/:customerGroupNumber/customers

Schema name

customer-groups.customerGroupNumber.customers.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Required properties

currency, customerGroup, name, paymentTerms, vatZone

Properties

Name Type Format Read-only Max length Min length Description
address string 510 Address for the customer including street and number.
attention object The customer’s person of attention.
attention.customerContactNumber integer The unique identifier of the customer employee.
attention.self string uri A unique link reference to the customer employee item.
balance number True The outstanding amount for this customer.
barred boolean Boolean indication of whether the customer is barred from invoicing.
ciNumber string 40 Company Identification Number. For example CVR in Denmark.
city string 50 The customer’s city.
country string 50 The customer’s country.
county string 255 The customer’s county.
creditLimit number A maximum credit for this customer. Once the maximum is reached or passed in connection with an order/quotation/invoice for this customer you see a warning in the system.
currency string 3 3 Default payment currency.
customerContact object Reference to main contact employee at customer.
customerContact.customerContactnumber integer The unique identifier of the customer contact.
customerContact.self string uri A unique link reference to the customer contact item.
customerGroup object In order to set up a new customer, it is necessary to specify a customer group. It is useful to group a company’s customers (e.g., ‘domestic’ and ‘foreign’ customers) and to link the group members to the same account when generating reports.
customerGroup.customerGroupNumber integer The unique identifier of the customer group.
customerGroup.self string uri A unique link reference to the customer group item.
customerNumber integer The customer number is a unique numerical identifier with a maximum of 9 digits. If no customer number is specified a number will be supplied by the system.
ean string 40 International Article Number (originally European Article Number). EAN is used for invoicing the Danish public sector.
email string 255 Customer e-mail address where invoices should be emailed. Note: you can specify multiple email addresses in this field, separated by a space. If you need to send a copy of the invoice or write to other e-mail addresses, you can also create one or more customer contacts.
layout object Layout to be applied for invoices and other documents for this customer.
layout.layoutNumber integer The unique identifier of the layout.
layout.self string uri A unique link reference to the layout item.
name string 255 1 The customer name.
paymentTerms object The default payment terms for the customer.
paymentTerms.paymentTermsNumber integer The unique identifier of the payment terms.
paymentTerms.self string uri A unique link reference to the payment terms item.
publicEntryNumber string 50 The public entry number is used for electronic invoicing, to define the account invoices will be registered on at the customer.
salesPerson object Reference to the employee responsible for contact with this customer.
salesPerson.employeeNumber integer The unique identifier of the employee.
salesPerson.self string uri A unique link reference to the employee resource.
self string uri The unique self reference of the customer resource.
telephoneAndFaxNumber string 255 The customer’s telephone and/or fax number.
vatNumber string 50 The customer’s value added tax identification number. This field is only available to agreements in Sweden, UK, Germany, Poland and Finland. Not to be mistaken for the danish CVR number, which is defined on the ciNumber property.
vatZone object Indicates in which VAT-zone the customer is located (e.g.: domestically, in Europe or elsewhere abroad).
vatZone.self string uri A unique link reference to the VAT-zone item.
vatZone.vatZoneNumber integer The unique identifier of the VAT-zone.
website string 255 Customer website, if applicable.
zip string 30 The customer’s postcode.

Create Customer Group

POST /customer-groups

Return type

This method returns a single object

Required properties

account, customerGroupNumber, name

Properties

Name Type Description
account object The posting account of the customer group.
customerGroupNumber integer The unique identifier of the customer group.
deduction object The deduction settings for the customer group.
defaultDiscountPct number The customer groups’s default discount percent to apply to new invoice lines if the customer itself doesn’t have a discount percent.
layout object The default layout for the customer group.
manualSalesInvoiceNumberSeries object Number series for manual sales invoice .
name string The descriptive name of the customer group.
priceList object Default price list for the customer group
salesInvoiceNumberSeries object Number series for sales invoice

Update Customer Group

PUT /customer-groups/:customerGroupNumber

Return type

This method returns a single object

Required properties

account, customerGroupNumber, name

Properties

Name Type Description
account object The posting account of the customer group.
customerGroupNumber integer The unique identifier of the customer group.
deduction object The deduction settings for the customer group.
defaultDiscountPct number The customer groups’s default discount percent to apply to new invoice lines if the customer itself doesn’t have a discount percent.
layout object The default layout for the customer group.
manualSalesInvoiceNumberSeries object Number series for manual sales invoice .
name string The descriptive name of the customer group.
priceList object Default price list for the customer group
salesInvoiceNumberSeries object Number series for sales invoice

Delete Customer Group

DELETE /customer-groups/:customerGroupNumber

Customers

For more information please look at the Online Help.

Get Customers

GET /customers

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Read-only Values Description
address string Address for the customer including street and number.
aliasLayer object The customer’s alias-layer.
aliasLayer.aliasLayerNumber integer A unique identifier of the alias layer.
attention object The customer’s person of attention.
attention.customer object The customer to which the contact belongs.
attention.customerContactNumber integer Unique numerical identifier. This identifier is unique in the context of a customer.
attention.deleted boolean Flag indicating if the contact person is deleted.
attention.eInvoiceId string Electronic invoicing Id. This will appear on EAN invoices in the field cbc:ID.
attention.email string Customer contact e-mail address. This is where copies of sales documents are sent.
attention.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
attention.name string Customer contact name.
attention.notes string Any notes you need to keep on a contact person.
attention.phone string Customer contact phone number.
balance number True The outstanding amount for this customer.
barred boolean Boolean indication of whether the customer is barred from invoicing.
city string The customer’s city.
contacts object The customer’s contacts.
corporateIdentificationNumber string Corporate Identification Number.
country string The customer’s country.
countryCode object The customer’s country code - only exposed in Spain
countryCode.code string The 2 letter code for the country.
county string The customer’s county.
creditLimit number A maximum credit for this customer. Once the maximum is reached or passed in connection with an order/quotation/invoice for this customer you see a warning in the system.
currency string Default payment currency.
customerContact object Reference to main contact employee at customer.
customerContact.customer object The customer to which the contact belongs.
customerContact.customerContactNumber integer Unique numerical identifier. This identifier is unique in the context of a customer.
customerContact.deleted boolean Flag indicating if the contact person is deleted.
customerContact.eInvoiceId string Electronic invoicing Id. This will appear on EAN invoices in the field cbc:ID.
customerContact.email string Customer contact e-mail address. This is where copies of sales documents are sent.
customerContact.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
customerContact.name string Customer contact name.
customerContact.notes string Any notes you need to keep on a contact person.
customerContact.phone string Customer contact phone number.
customerGroup object The customer group to which the customer belongs.
customerGroup.account object The posting account of the customer group.
customerGroup.customerGroupNumber integer The unique identifier of the customer group.
customerGroup.deduction object The deduction settings for the customer group.
customerGroup.defaultDiscountPct number The customer groups’s default discount percent to apply to new invoice lines if the customer itself doesn’t have a discount percent.
customerGroup.layout object The default layout for the customer group.
customerGroup.manualSalesInvoiceNumberSeries object Number series for manual sales invoice .
customerGroup.manualSalesInvoiceNumberSeries.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
customerGroup.name string The descriptive name of the customer group.
customerGroup.priceList object Default price list for the customer group
customerGroup.salesInvoiceNumberSeries object Number series for sales invoice
customerGroup.salesInvoiceNumberSeries.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
customerNumber integer The unique identifier of the customer.
defaultDeliveryLocation object The customer’s default delivery location.
defaultDeliveryLocation.address string The address of the delivery location.
defaultDeliveryLocation.barred boolean Whether the delivery location is barred.
defaultDeliveryLocation.city string The city of the delivery location.
defaultDeliveryLocation.country string The country of the delivery location.
defaultDeliveryLocation.county string The county of the delivery location.
defaultDeliveryLocation.deliveryLocationNumber integer A unique identifier for the delivery location.
defaultDeliveryLocation.electronicInvoicingOfficeCode string The office code used for electronic invoicing.
defaultDeliveryLocation.externalId string The external id.
defaultDeliveryLocation.postalCode string The zip code of the delivery location.
defaultDeliveryLocation.terms string The terms applying to the delivery location.
defaultDiscountPct number The customer’s default discount percent to apply to new invoice lines.
ean string International Article Number (originally European Article Number). EAN is used for invoicing the Danish public sector.
email string Customer e-mail address where invoices should be emailed. Multiple email addresses are separated by a space.
iban string The customer’s iban. Must match a proper IBAN- example: DE44500105175407324931
italianCertifiedEmail string The customer’s certified Italian email.
italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
lastUpdated string full-date The date the customer was last updated. Presented in UTC
layout object Layout to be applied for invoices and other documents for this customer.
layout.deleted boolean A boolean indicating the deletion status of the layout.
layout.isDefault boolean True if the layout is the default selected by the user. This property is read only.
layout.layoutNumber integer The unique identifier of the layout.
layout.name string The descriptive name of the layout.
name string The customer name.
paymentTerms object The default payment terms for the customer.
paymentTerms.barred boolean If this payment term is accessible.
paymentTerms.cashDiscountAccount object The cash discount account.
paymentTerms.cashDiscountDayLimit integer The cash discount day limit.
paymentTerms.cashDiscountRate number The cash discount rate.
paymentTerms.contraAccountForPrepaidAmount object The contra account. Used for PaidInCash and Factoring only.
paymentTerms.contraAccountForRemainderAmount object The contra account for the remainder amount. Used for Factoring only.
paymentTerms.creditCardCompany object The credit card company. Used for type CreditCard only.
paymentTerms.creditCardCompany.italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
paymentTerms.daysOfCredit integer The number of days of credit on the order. This field is only valid if terms of payment is not of type ‘duedate’.
paymentTerms.description string The description of the payment term.
paymentTerms.name string The name of the payment terms.
paymentTerms.numberSeriesForCustomerPayment object The number series to use for creating customer payment vouchers. Used for paidInCash or creditcard type only.
paymentTerms.numberSeriesForCustomerPayment.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
paymentTerms.paymentTermsNumber integer A unique identifier of the payment term.
paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.percentageForPrepaidAmount number The percentage for prepaid amount. Used for Factoring only.
paymentTerms.percentageForRemainderAmount number The percentage for the remainder amount. Used for Factoring only.
paymentTerms.timetablePaymentTemplate object The timetable payment template. Used for Timetable only.
paymentTerms.timetablePaymentTemplate.lines object An array containing the timetable pament template lines.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms object The payment term for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.timetablePaymentTemplate.lines.percentage number The percentage to use for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.timetablePaymentTemplateLineNumber integer A unique identifier of the timetable payment template line.
paymentTerms.type string The type the payment term.
paymentType object A type description how the payment should be executed.
paymentType.fields object List of the payment type’s fields.
paymentType.fields.dataType object String, Integer Data type of the payment type field.
paymentType.name string Payment type’s name.
paymentType.paymentTypeNumber integer Unique identifier of the payment type.
priceGroup object The customer’s price group.
priceGroup.name string The name of the price group.
priceGroup.priceGroupNumber integer The number of the price group.
priceGroup.products object The list of products the price group has special prices for.
priceList object The customer’s default price-list.
priceList.name string Price list’s name.
priceList.number integer Unique identifier of the price list.
province object The customer’s province.
province.countryCode object Country Code of the province’s country.
province.provinceNumber integer Numeric value that identifies the province within the country.
publicEntryNumber string The public entry number is used for electronic invoicing, to define the account invoices will be registered on at the customer.
salesPerson object Reference to the employee responsible for contact with this customer.
salesPerson.address string The Address of the employee.
salesPerson.barred boolean Shows if the employee is barred from being used.
salesPerson.bookedInvoices object A link to the collection of booked invoices which has the employee as a reference.
salesPerson.canApprove boolean Shows if the user can approve. Only for time logger profiles.
salesPerson.canInvoice boolean Shows if the user can invoice. Only for project managers and time logger profiles.
salesPerson.city string The City of the employee.
salesPerson.costPriceAfter number Employee cost price after the cut-off date.
salesPerson.costPriceBefore number Employee cost price before the cut-off date.
salesPerson.customers object A link to the collection of customers which has the employee as a reference.
salesPerson.cutoffDate string full-date The cut-off date for employee cost/sales prices.
salesPerson.draftInvoices object A link to the collection of draft invoices which has the employee as a reference.
salesPerson.email string The email address of the employee.
salesPerson.employeeGroup object The group to which the employee belongs.
salesPerson.employeeNumber integer The employee number is a unique numerical identifier with a maximum of 9 digits.
salesPerson.employeeType object Employee type.
salesPerson.initials string Userid of related user.
salesPerson.name string The name of the employee.
salesPerson.phone string The phone number of the employee.
salesPerson.postCode string The PostCode of the employee.
salesPerson.salesPriceAfter number Employee after price sales the cut-off date.
salesPerson.salesPriceBefore number Employee sales price before the cut-off date.
splitPayment boolean The customer’s split payment regime indicator.
swift string The customer’s swift.
telephoneAndFaxNumber string The customer’s telephone and/or fax number.
templates object The template of the customer.
templates.invoice object
tenderContract object The customer’s tender contract.
tenderContract.cig string Public administration tender reference number.
tenderContract.cup string Public administration project reference.
tenderContract.customerNumber integer Customer’s reference.
tenderContract.description string Custom description.
tenderContract.documentNumber string Document number.
tenderContract.tenderContractNumber integer Unique identifier of the contract.
tenderContract.type object Contract, Convention
vatAccount object Indicates that a customer has to be invoiced with a specific VAT code.
vatAccount.vatCode string The vat code of the vat account.
vatNumber string The customer’s value added tax identification number.
vatZone object Indicates in which VAT-zone the customer is located (e.g.: domestically, in Europe or elsewhere abroad).
vatZone.editionEnum string The edition to where the vat zone belongs.
vatZone.enabledForCustomer boolean A boolean value indicating if the vat zone is enabled for customers.
vatZone.enabledForSupplier boolean A boolean value indicating if the vat zone is enabled for suppliers.
vatZone.isDomestic boolean A boolean value indicating if the vat zone is domestic.
vatZone.isExemptVatZone boolean A boolean value indicating if the vat zone is exempt.
vatZone.isProjectAccount boolean
vatZone.name string The descriptive name of the vat zone.
vatZone.textId string The text id for the vat zone.
vatZone.vatZoneNumber integer The unique identifier of the vat zone.
website string Customer website, if applicable.
zip string The customer’s zip code.

Get specific Customer

GET /customers/:customerNumber

Return type

This method returns a single object

Properties

Name Type Format Read-only Values Description
address string Address for the customer including street and number.
aliasLayer object The customer’s alias-layer.
aliasLayer.aliasLayerNumber integer A unique identifier of the alias layer.
attention object The customer’s person of attention.
attention.customer object The customer to which the contact belongs.
attention.customerContactNumber integer Unique numerical identifier. This identifier is unique in the context of a customer.
attention.deleted boolean Flag indicating if the contact person is deleted.
attention.eInvoiceId string Electronic invoicing Id. This will appear on EAN invoices in the field cbc:ID.
attention.email string Customer contact e-mail address. This is where copies of sales documents are sent.
attention.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
attention.name string Customer contact name.
attention.notes string Any notes you need to keep on a contact person.
attention.phone string Customer contact phone number.
balance number True The outstanding amount for this customer.
barred boolean Boolean indication of whether the customer is barred from invoicing.
city string The customer’s city.
contacts object The customer’s contacts.
corporateIdentificationNumber string Corporate Identification Number.
country string The customer’s country.
countryCode object The customer’s country code - only exposed in Spain
countryCode.code string The 2 letter code for the country.
county string The customer’s county.
creditLimit number A maximum credit for this customer. Once the maximum is reached or passed in connection with an order/quotation/invoice for this customer you see a warning in the system.
currency string Default payment currency.
customerContact object Reference to main contact employee at customer.
customerContact.customer object The customer to which the contact belongs.
customerContact.customerContactNumber integer Unique numerical identifier. This identifier is unique in the context of a customer.
customerContact.deleted boolean Flag indicating if the contact person is deleted.
customerContact.eInvoiceId string Electronic invoicing Id. This will appear on EAN invoices in the field cbc:ID.
customerContact.email string Customer contact e-mail address. This is where copies of sales documents are sent.
customerContact.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
customerContact.name string Customer contact name.
customerContact.notes string Any notes you need to keep on a contact person.
customerContact.phone string Customer contact phone number.
customerGroup object The customer group to which the customer belongs.
customerGroup.account object The posting account of the customer group.
customerGroup.customerGroupNumber integer The unique identifier of the customer group.
customerGroup.deduction object The deduction settings for the customer group.
customerGroup.defaultDiscountPct number The customer groups’s default discount percent to apply to new invoice lines if the customer itself doesn’t have a discount percent.
customerGroup.layout object The default layout for the customer group.
customerGroup.manualSalesInvoiceNumberSeries object Number series for manual sales invoice .
customerGroup.manualSalesInvoiceNumberSeries.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
customerGroup.name string The descriptive name of the customer group.
customerGroup.priceList object Default price list for the customer group
customerGroup.salesInvoiceNumberSeries object Number series for sales invoice
customerGroup.salesInvoiceNumberSeries.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
customerNumber integer The unique identifier of the customer.
defaultDeliveryLocation object The customer’s default delivery location.
defaultDeliveryLocation.address string The address of the delivery location.
defaultDeliveryLocation.barred boolean Whether the delivery location is barred.
defaultDeliveryLocation.city string The city of the delivery location.
defaultDeliveryLocation.country string The country of the delivery location.
defaultDeliveryLocation.county string The county of the delivery location.
defaultDeliveryLocation.deliveryLocationNumber integer A unique identifier for the delivery location.
defaultDeliveryLocation.electronicInvoicingOfficeCode string The office code used for electronic invoicing.
defaultDeliveryLocation.externalId string The external id.
defaultDeliveryLocation.postalCode string The zip code of the delivery location.
defaultDeliveryLocation.terms string The terms applying to the delivery location.
defaultDiscountPct number The customer’s default discount percent to apply to new invoice lines.
ean string International Article Number (originally European Article Number). EAN is used for invoicing the Danish public sector.
email string Customer e-mail address where invoices should be emailed. Multiple email addresses are separated by a space.
iban string The customer’s iban. Must match a proper IBAN- example: DE44500105175407324931
italianCertifiedEmail string The customer’s certified Italian email.
italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
lastUpdated string full-date The date the customer was last updated. Presented in UTC
layout object Layout to be applied for invoices and other documents for this customer.
layout.deleted boolean A boolean indicating the deletion status of the layout.
layout.isDefault boolean True if the layout is the default selected by the user. This property is read only.
layout.layoutNumber integer The unique identifier of the layout.
layout.name string The descriptive name of the layout.
name string The customer name.
paymentTerms object The default payment terms for the customer.
paymentTerms.barred boolean If this payment term is accessible.
paymentTerms.cashDiscountAccount object The cash discount account.
paymentTerms.cashDiscountDayLimit integer The cash discount day limit.
paymentTerms.cashDiscountRate number The cash discount rate.
paymentTerms.contraAccountForPrepaidAmount object The contra account. Used for PaidInCash and Factoring only.
paymentTerms.contraAccountForRemainderAmount object The contra account for the remainder amount. Used for Factoring only.
paymentTerms.creditCardCompany object The credit card company. Used for type CreditCard only.
paymentTerms.creditCardCompany.italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
paymentTerms.daysOfCredit integer The number of days of credit on the order. This field is only valid if terms of payment is not of type 'duedate’.
paymentTerms.description string The description of the payment term.
paymentTerms.name string The name of the payment terms.
paymentTerms.numberSeriesForCustomerPayment object The number series to use for creating customer payment vouchers. Used for paidInCash or creditcard type only.
paymentTerms.numberSeriesForCustomerPayment.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
paymentTerms.paymentTermsNumber integer A unique identifier of the payment term.
paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.percentageForPrepaidAmount number The percentage for prepaid amount. Used for Factoring only.
paymentTerms.percentageForRemainderAmount number The percentage for the remainder amount. Used for Factoring only.
paymentTerms.timetablePaymentTemplate object The timetable payment template. Used for Timetable only.
paymentTerms.timetablePaymentTemplate.lines object An array containing the timetable pament template lines.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms object The payment term for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.timetablePaymentTemplate.lines.percentage number The percentage to use for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.timetablePaymentTemplateLineNumber integer A unique identifier of the timetable payment template line.
paymentTerms.type string The type the payment term.
paymentType object A type description how the payment should be executed.
paymentType.fields object List of the payment type’s fields.
paymentType.fields.dataType object String, Integer Data type of the payment type field.
paymentType.name string Payment type’s name.
paymentType.paymentTypeNumber integer Unique identifier of the payment type.
priceGroup object The customer’s price group.
priceGroup.name string The name of the price group.
priceGroup.priceGroupNumber integer The number of the price group.
priceGroup.products object The list of products the price group has special prices for.
priceList object The customer’s default price-list.
priceList.name string Price list’s name.
priceList.number integer Unique identifier of the price list.
province object The customer’s province.
province.countryCode object Country Code of the province’s country.
province.provinceNumber integer Numeric value that identifies the province within the country.
publicEntryNumber string The public entry number is used for electronic invoicing, to define the account invoices will be registered on at the customer.
salesPerson object Reference to the employee responsible for contact with this customer.
salesPerson.address string The Address of the employee.
salesPerson.barred boolean Shows if the employee is barred from being used.
salesPerson.bookedInvoices object A link to the collection of booked invoices which has the employee as a reference.
salesPerson.canApprove boolean Shows if the user can approve. Only for time logger profiles.
salesPerson.canInvoice boolean Shows if the user can invoice. Only for project managers and time logger profiles.
salesPerson.city string The City of the employee.
salesPerson.costPriceAfter number Employee cost price after the cut-off date.
salesPerson.costPriceBefore number Employee cost price before the cut-off date.
salesPerson.customers object A link to the collection of customers which has the employee as a reference.
salesPerson.cutoffDate string full-date The cut-off date for employee cost/sales prices.
salesPerson.draftInvoices object A link to the collection of draft invoices which has the employee as a reference.
salesPerson.email string The email address of the employee.
salesPerson.employeeGroup object The group to which the employee belongs.
salesPerson.employeeNumber integer The employee number is a unique numerical identifier with a maximum of 9 digits.
salesPerson.employeeType object Employee type.
salesPerson.initials string Userid of related user.
salesPerson.name string The name of the employee.
salesPerson.phone string The phone number of the employee.
salesPerson.postCode string The PostCode of the employee.
salesPerson.salesPriceAfter number Employee after price sales the cut-off date.
salesPerson.salesPriceBefore number Employee sales price before the cut-off date.
splitPayment boolean The customer’s split payment regime indicator.
swift string The customer’s swift.
telephoneAndFaxNumber string The customer’s telephone and/or fax number.
templates object The template of the customer.
templates.invoice object
tenderContract object The customer’s tender contract.
tenderContract.cig string Public administration tender reference number.
tenderContract.cup string Public administration project reference.
tenderContract.customerNumber integer Customer’s reference.
tenderContract.description string Custom description.
tenderContract.documentNumber string Document number.
tenderContract.tenderContractNumber integer Unique identifier of the contract.
tenderContract.type object Contract, Convention
vatAccount object Indicates that a customer has to be invoiced with a specific VAT code.
vatAccount.vatCode string The vat code of the vat account.
vatNumber string The customer’s value added tax identification number.
vatZone object Indicates in which VAT-zone the customer is located (e.g.: domestically, in Europe or elsewhere abroad).
vatZone.editionEnum string The edition to where the vat zone belongs.
vatZone.enabledForCustomer boolean A boolean value indicating if the vat zone is enabled for customers.
vatZone.enabledForSupplier boolean A boolean value indicating if the vat zone is enabled for suppliers.
vatZone.isDomestic boolean A boolean value indicating if the vat zone is domestic.
vatZone.isExemptVatZone boolean A boolean value indicating if the vat zone is exempt.
vatZone.isProjectAccount boolean
vatZone.name string The descriptive name of the vat zone.
vatZone.textId string The text id for the vat zone.
vatZone.vatZoneNumber integer The unique identifier of the vat zone.
website string Customer website, if applicable.
zip string The customer’s zip code.

Create Customer

POST /customers

View code sample

Return type

This method returns a single object

Required properties

currency, customerGroup, customerGroup.customerGroupNumber, name, paymentTerms, vatZone

Properties

Name Type Format Values Description
address string Address for the customer including street and number.
aliasLayer object The customer’s alias-layer.
attention object The customer’s person of attention.
attention.customerContactNumber integer Unique numerical identifier. This identifier is unique in the context of a customer.
barred boolean Boolean indication of whether the customer is barred from invoicing.
city string The customer’s city.
contacts object The customer’s contacts.
corporateIdentificationNumber string Corporate Identification Number.
country string The customer’s country.
countryCode object The customer’s country code - only exposed in Spain
county string The customer’s county.
creditLimit number A maximum credit for this customer. Once the maximum is reached or passed in connection with an order/quotation/invoice for this customer you see a warning in the system.
currency string Default payment currency.
customerContact object Reference to main contact employee at customer.
customerContact.customerContactNumber integer Unique numerical identifier. This identifier is unique in the context of a customer.
customerGroup object The customer group to which the customer belongs.
customerGroup.customerGroupNumber integer The unique identifier of the customer group.
customerNumber integer The unique identifier of the customer.
defaultDeliveryLocation object The customer’s default delivery location.
defaultDiscountPct number The customer’s default discount percent to apply to new invoice lines.
ean string International Article Number (originally European Article Number). EAN is used for invoicing the Danish public sector.
email string Customer e-mail address where invoices should be emailed. Multiple email addresses are separated by a space.
iban string The customer’s iban. Must match a proper IBAN- example: DE44500105175407324931
italianCertifiedEmail string The customer’s certified Italian email.
italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
lastUpdated string full-date The date the customer was last updated. Presented in UTC
layout object Layout to be applied for invoices and other documents for this customer.
name string The customer name.
paymentTerms object The default payment terms for the customer.
paymentType object A type description how the payment should be executed.
priceGroup object The customer’s price group.
priceList object The customer’s default price-list.
province object The customer’s province.
publicEntryNumber string The public entry number is used for electronic invoicing, to define the account invoices will be registered on at the customer.
salesPerson object Reference to the employee responsible for contact with this customer.
splitPayment boolean The customer’s split payment regime indicator.
swift string The customer’s swift.
telephoneAndFaxNumber string The customer’s telephone and/or fax number.
templates object The template of the customer.
tenderContract object The customer’s tender contract.
vatAccount object Indicates that a customer has to be invoiced with a specific VAT code.
vatNumber string The customer’s value added tax identification number.
vatZone object Indicates in which VAT-zone the customer is located (e.g.: domestically, in Europe or elsewhere abroad).
vatZone.vatZoneNumber integer The unique identifier of the vat zone.
website string Customer website, if applicable.
zip string The customer’s zip code.

Update Customer

PUT /customers/:customerNumber

Return type

This method returns a single object

Required properties

currency, customerGroup, customerGroup.customerGroupNumber, name, paymentTerms, vatZone

Properties

Name Type Format Values Description
address string Address for the customer including street and number.
aliasLayer object The customer’s alias-layer.
attention object The customer’s person of attention.
attention.customerContactNumber integer Unique numerical identifier. This identifier is unique in the context of a customer.
barred boolean Boolean indication of whether the customer is barred from invoicing.
city string The customer’s city.
contacts object The customer’s contacts.
corporateIdentificationNumber string Corporate Identification Number.
country string The customer’s country.
countryCode object The customer’s country code - only exposed in Spain
county string The customer’s county.
creditLimit number A maximum credit for this customer. Once the maximum is reached or passed in connection with an order/quotation/invoice for this customer you see a warning in the system.
currency string Default payment currency.
customerContact object Reference to main contact employee at customer.
customerContact.customerContactNumber integer Unique numerical identifier. This identifier is unique in the context of a customer.
customerGroup object The customer group to which the customer belongs.
customerGroup.customerGroupNumber integer The unique identifier of the customer group.
customerNumber integer The unique identifier of the customer.
defaultDeliveryLocation object The customer’s default delivery location.
defaultDiscountPct number The customer’s default discount percent to apply to new invoice lines.
ean string International Article Number (originally European Article Number). EAN is used for invoicing the Danish public sector.
email string Customer e-mail address where invoices should be emailed. Multiple email addresses are separated by a space.
iban string The customer’s iban. Must match a proper IBAN- example: DE44500105175407324931
italianCertifiedEmail string The customer’s certified Italian email.
italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
lastUpdated string full-date The date the customer was last updated. Presented in UTC
layout object Layout to be applied for invoices and other documents for this customer.
name string The customer name.
paymentTerms object The default payment terms for the customer.
paymentType object A type description how the payment should be executed.
priceGroup object The customer’s price group.
priceList object The customer’s default price-list.
province object The customer’s province.
publicEntryNumber string The public entry number is used for electronic invoicing, to define the account invoices will be registered on at the customer.
salesPerson object Reference to the employee responsible for contact with this customer.
splitPayment boolean The customer’s split payment regime indicator.
swift string The customer’s swift.
telephoneAndFaxNumber string The customer’s telephone and/or fax number.
templates object The template of the customer.
tenderContract object The customer’s tender contract.
vatAccount object Indicates that a customer has to be invoiced with a specific VAT code.
vatNumber string The customer’s value added tax identification number.
vatZone object Indicates in which VAT-zone the customer is located (e.g.: domestically, in Europe or elsewhere abroad).
vatZone.vatZoneNumber integer The unique identifier of the vat zone.
website string Customer website, if applicable.
zip string The customer’s zip code.

Delete Customer

DELETE /customers/:customerNumber

Return type

This method returns a single object

Properties

Name Type Description
customerNumber integer The unique identifier of the customer.

Get Customer Contacts

GET /customers/:customerNumber/contacts

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Description
customer object The customer to which the contact belongs.
customer.customerNumber integer The unique identifier of the customer.
customer.name string The customer name.
customerContactNumber integer Unique numerical identifier. This identifier is unique in the context of a customer.
deleted boolean Flag indicating if the contact person is deleted.
eInvoiceId string Electronic invoicing Id. This will appear on EAN invoices in the field cbc:ID.
email string Customer contact e-mail address. This is where copies of sales documents are sent.
emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
name string Customer contact name.
notes string Any notes you need to keep on a contact person.
phone string Customer contact phone number.

Get specific Customer Contact

GET /customers/:customerNumber/contacts/:contactNumber

Return type

This method returns a single object

Properties

Name Type Description
customer object The customer to which the contact belongs.
customer.customerNumber integer The unique identifier of the customer.
customer.name string The customer name.
customerContactNumber integer Unique numerical identifier. This identifier is unique in the context of a customer.
deleted boolean Flag indicating if the contact person is deleted.
eInvoiceId string Electronic invoicing Id. This will appear on EAN invoices in the field cbc:ID.
email string Customer contact e-mail address. This is where copies of sales documents are sent.
emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
name string Customer contact name.
notes string Any notes you need to keep on a contact person.
phone string Customer contact phone number.

Create Customer Contact

POST /customers/:customerNumber/contacts

Return type

This method returns a single object

Required properties

customer, name

Properties

Name Type Description
customer object The customer to which the contact belongs.
customer.customerNumber integer The unique identifier of the customer.
customerContactNumber integer Unique numerical identifier. This identifier is unique in the context of a customer.
deleted boolean Flag indicating if the contact person is deleted.
eInvoiceId string Electronic invoicing Id. This will appear on EAN invoices in the field cbc:ID.
email string Customer contact e-mail address. This is where copies of sales documents are sent.
emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
name string Customer contact name.
notes string Any notes you need to keep on a contact person.
phone string Customer contact phone number.

Update Customer Contact

PUT /customers/:customerNumber/contacts/:contactNumber

Return type

This method returns a single object

Required properties

customer, name

Properties

Name Type Description
customer object The customer to which the contact belongs.
customer.customerNumber integer The unique identifier of the customer.
customerContactNumber integer Unique numerical identifier. This identifier is unique in the context of a customer.
deleted boolean Flag indicating if the contact person is deleted.
eInvoiceId string Electronic invoicing Id. This will appear on EAN invoices in the field cbc:ID.
email string Customer contact e-mail address. This is where copies of sales documents are sent.
emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
name string Customer contact name.
notes string Any notes you need to keep on a contact person.
phone string Customer contact phone number.

Delete Customer Contact

DELETE /customers/:customerNumber/contacts/:contactNumber

Return type

This method returns a single object

Properties

Name Type Description
customerContactNumber integer Unique numerical identifier. This identifier is unique in the context of a customer.

Get Customer Delivery locations

GET /customers/:customerNumber/delivery-locations

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Description
address string The address of the delivery location.
barred boolean Whether the delivery location is barred.
city string The city of the delivery location.
country string The country of the delivery location.
county string The county of the delivery location.
deliveryLocationNumber integer A unique identifier for the delivery location.
electronicInvoicingOfficeCode string The office code used for electronic invoicing.
externalId string The external id.
postalCode string The zip code of the delivery location.
terms string The terms applying to the delivery location.

Get specific Customer Delivery location

GET /customers/:customerNumber/delivery-locations/:locationNumber

Return type

This method returns a single object

Properties

Name Type Description
address string The address of the delivery location.
barred boolean Whether the delivery location is barred.
city string The city of the delivery location.
country string The country of the delivery location.
county string The county of the delivery location.
deliveryLocationNumber integer A unique identifier for the delivery location.
electronicInvoicingOfficeCode string The office code used for electronic invoicing.
externalId string The external id.
postalCode string The zip code of the delivery location.
terms string The terms applying to the delivery location.

Create Customer Delivery locations

POST /customers/:customerNumber/delivery-locations

Return type

This method returns a single object

Properties

Name Type Description
address string The address of the delivery location.
barred boolean Whether the delivery location is barred.
city string The city of the delivery location.
country string The country of the delivery location.
county string The county of the delivery location.
deliveryLocationNumber integer A unique identifier for the delivery location.
electronicInvoicingOfficeCode string The office code used for electronic invoicing.
externalId string The external id.
postalCode string The zip code of the delivery location.
terms string The terms applying to the delivery location.

Update Customer Delivery location

PUT /customers/:customerNumber/delivery-locations/:locationNumber

Return type

This method returns a single object

Properties

Name Type Description
address string The address of the delivery location.
barred boolean Whether the delivery location is barred.
city string The city of the delivery location.
country string The country of the delivery location.
county string The county of the delivery location.
deliveryLocationNumber integer A unique identifier for the delivery location.
electronicInvoicingOfficeCode string The office code used for electronic invoicing.
externalId string The external id.
postalCode string The zip code of the delivery location.
terms string The terms applying to the delivery location.

Delete Customer Delivery location

DELETE /customers/:customerNumber/delivery-locations/:locationNumber

Return type

This method returns a single object

Properties

Name

Get Customer Templates

GET /customers/:customerNumber/templates/

Returns the templates available for customers. Templates are used to simplify the creation of resources that can otherwise be complex to build.

Get Invoice Template

GET /customers/:customerNumber/templates/invoice

Returns a draft invoice template based on the Customer. This can be modified and posted to /v2/invoices/drafts.

Departmental Distributions

Get Departmental Distributions

GET /departmental-distributions/

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Values Description
barred boolean Indicates whether or not the departmental distribution is barred.
departmentalDistributionNumber integer The unique identifier of the departmental distribution.
distributions object List of distributions with percentage for each department.
distributions.department object
distributions.percentage number
distributionType object Distribution, Department
name string Name of the departmental distribution.

Get specific Departmental Distribution

GET /departmental-distributions/:departmentalDistributionNumber

Return type

This method returns a single object

Properties

Name Type Values Description
barred boolean Indicates whether or not the departmental distribution is barred.
departmentalDistributionNumber integer The unique identifier of the departmental distribution.
distributions object List of distributions with percentage for each department.
distributions.department object
distributions.percentage number
distributionType object Distribution, Department
name string Name of the departmental distribution.

Get Departments

GET /departmental-distributions/departments/

Filter only departments.

Get specific Department

GET /departmental-distributions/departments/:departmentNumber

Get Distributions

GET /departmental-distributions/distributions

Filter only distributions.

Get specific Distribution

GET /departmental-distributions/distributions/:distributionNumber

Departments

Read more about Departments and Dimensions in our Online help.

Get Departments

GET /departments

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Description
barred boolean Whether or not the department has been barred.
departmentNumber integer Unique numerical identifier of the department.
name string Department’s name.

Get specific Department

GET /departments/:departmentNumber

Return type

This method returns a single object

Properties

Name Type Description
barred boolean Whether or not the department has been barred.
departmentNumber integer Unique numerical identifier of the department.
name string Department’s name.

DocumenT Categories

Get Document Categories

GET /document-categories

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Description
categoryNumber integer A unique identifier of the Category.
name string The descriptive name of the Category.

Echo

GET /echo

Convenience endpoint for testing. The /echo endpoint will return everything you throw at it.

Accepts query string parameter statuscode. When provided it will determine the status code of the response. This can be used to test the error responses of the API.

The endpoint supports GET, POST, PUT, PATCH and DELETE.

Employee Groups

Get Employee Groups

GET /employee-groups

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Description
employeeGroupNumber integer The group number is a unique numerical identifier.
name string The name of the group.

Get specific Employee Group

GET /employee-groups/:groupId

Return type

This method returns a single object

Properties

Name Type Description
employeeGroupNumber integer The group number is a unique numerical identifier.
name string The name of the group.

Employees

Get Employees

GET /employees

View response example

Schema name

employees.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Filterable properties

barred, email, employeeGroup.employeeGroupNumber, employeeNumber, name, phone

Sortable properties

email, employeeGroup.employeeGroupNumber, employeeNumber, name, phone

Properties

Name Type Format Max length Min value Description
barred boolean Shows if the employee is barred from being used.
bookedInvoices string uri A link to the collection of booked invoices which has the employee as a reference.
customers string uri A link to the collection of customers which has the employee as a reference.
draftInvoices string uri A link to the collection of draft invoices which has the employee as a reference.
email string 250 The email address of the employee
employeeGroup object The group to which the employee belongs.
employeeGroup.employeeGroupNumber integer 1 The unique identifier of the employee group.
employeeGroup.self string uri A unique link reference to the employee group item.
employeeNumber integer 1 The employee number is a unique numerical identifier with a maximum of 9 digits.
name string 250 The name of the employee
phone string 250 The phone number of the employee
self string uri A unique link reference to the employee item.

Get specific Employee

GET /employees/:employeeId

Schema name

employees.employeeNumber.get.schema.json

Return type

This method returns a single object

Filterable properties

barred, email, employeeGroup.employeeGroupNumber, employeeNumber, name, phone

Sortable properties

email, employeeGroup.employeeGroupNumber, employeeNumber, name, phone

Properties

Name Type Format Max length Min value Description
barred boolean Shows if the employee is barred from being used.
bookedInvoices string uri A link to the collection of booked invoices which has the employee as a reference.
customers string uri A link to the collection of customers which has the employee as a reference.
draftInvoices string uri A link to the collection of draft invoices which has the employee as a reference.
email string 250 The email address of the employee
employeeGroup object The group to which the employee belongs.
employeeGroup.employeeGroupNumber integer 1 The unique identifier of the employee group.
employeeGroup.self string uri A unique link reference to the employee group item.
employeeNumber integer 1 The employee number is a unique numerical identifier with a maximum of 9 digits.
name string 250 The name of the employee
phone string 250 The phone number of the employee
self string uri A unique link reference to the employee item.

Get Customers for Employee

GET /employees/:employeeId/customers

Entries

Financial entries are always exposed in the context of another entity. The contexts provided right now are /accounting-years and /accounts.

Get Entries on Account

GET /accounts/:accountNumber/accounting-years/:year/entries

Get Entries on Account in Period

GET /accounts/:accountNumber/accounting-years/:year/periods/:period/entries

Get Entries in Accounting year

GET /accounting-years/:year/entries

Get Entries in Period

GET /accounting-years/:year/periods/:period/entries

Entry Subtypes

The Entry subtypes collection contains all the supported types of financial Entries in Reviso.

Get Entry Subtypes

GET /entry-subtypes

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Values Description
entrySubtypeNumber integer Unique numerical identifier of the resource.
entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote Type of the entry.
hideInUi boolean
isAcrossAccountingYears boolean
name string Name of the entry subtype.

Get specific Entry Subtype

GET /entry-subtypes/:entrySubtypeNumber

Return type

This method returns a single object

Properties

Name Type Values Description
entrySubtypeNumber integer Unique numerical identifier of the resource.
entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote Type of the entry.
hideInUi boolean
isAcrossAccountingYears boolean
name string Name of the entry subtype.

Exempt Vat Codes

Get Exempt Vat Codes

GET /exempt-vat-codes

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Description
code string The code of the exempt vat code.
name string The name of the exempt vat code.

Get Specific Exempt Vat Code

GET /exempt-vat-codes/:vatCode

Return type

This method returns a single object

Properties

Name Type Description
code string The code of the exempt vat code.
name string The name of the exempt vat code.

Invoices

Sales invoices are rich entities that contain references to Products, Customers, Payment Terms, Layouts etc. They are created as editable drafts which can be booked and sent to a Customer.

You should use the /v2/invoices endpoints when working with invoices that are managed by Reviso. If you need to import invoices that are created in another system you should take a look at the Manual Customer Invoice Voucher endpoints instead.

Invoice entry point

GET /v2/invoices/

View response example

Get draft Invoices

GET /v2/invoices/drafts

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Read-only Values Description
additionalExpenseLines object A list of additional expense lines
additionalExpenseLines.additionalExpense object The additional expense used on the line
additionalExpenseLines.amount number Additional expense amount
additionalExpenseLines.lineNumber integer Line number
additionalExpenseLines.vatAccount object VAT account (if different from additional expense)
additionalExpenseLines.vatAmount number VAT amount
bankAccount object Bank Account
bankAccount.accountNumber integer The number of the account
bankAccount.name string True The name of the account.
costPriceInBaseCurrency number True The total cost of the items on the sales document in the base currency of the agreement.
currency string The ISO 4217 currency code of the sales document.
customer object The customer on the sales document.
customer.customerNumber integer The unique identifier of the customer.
customer.name string The customer name.
date string full-date Sales document issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the sales document. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
delivery.address string Street address where the goods must be delivered to the customer.
delivery.city string The city of the place of delivery.
delivery.country string The country of the place of delivery.
delivery.county string The county of the place of delivery.
delivery.deliveryDate string full-date The date of delivery.
delivery.deliveryTerms string Details about the terms of delivery.
delivery.zip string The zip code of the place of delivery.
deliveryDetails object Details about the delivery. Used for printing delivery notes etc.
deliveryDetails.carrierInfo object Details about the carrier.
deliveryDetails.deliveryNoteNumber integer Delivery note number.
deliveryDetails.deliveryNoteNumberSeries object Delivery note number series.
deliveryDetails.deliveryNoteNumberSeries.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
deliveryDetails.deliveryStartDateTime string full-date Date and time (in UTC) the delivery started.
deliveryDetails.descriptionOfPackages string Verbal description of the packages.
deliveryDetails.numberOfPackages integer Number of packages in the delivery.
deliveryDetails.reasonForDelivery string The reason for delivery.
deliveryLocation object A reference to the place of delivery for the goods on the sales document.
deliveryLocation.address string The address of the delivery location.
deliveryLocation.barred boolean Whether the delivery location is barred.
deliveryLocation.city string The city of the delivery location.
deliveryLocation.country string The country of the delivery location.
deliveryLocation.county string The county of the delivery location.
deliveryLocation.deliveryLocationNumber integer A unique identifier for the delivery location.
deliveryLocation.electronicInvoicingOfficeCode string The office code used for electronic invoicing.
deliveryLocation.externalId string The external id.
deliveryLocation.postalCode string The zip code of the delivery location.
deliveryLocation.terms string The terms applying to the delivery location.
dueDate string full-date The date the sales document is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type ‘duedate’.
exchangeRate number The exchange rate between the sales document currency and the base currency of the agreement. The exchange rate expresses how much it will cost in base currency to buy 100 units of the order currency.
grossAmount number The total sales document amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
id integer A reference number for the sales document.
isArchived boolean Boolean indication of whether the sales document is archived.
isSent boolean Boolean indication of whether the sales document is sent.
layout object The layout used for the document.
layout.deleted boolean A boolean indicating the deletion status of the layout.
layout.isDefault boolean True if the layout is the default selected by the user. This property is read only.
layout.layoutNumber integer The unique identifier of the layout.
layout.name string The descriptive name of the layout.
lines object An array containing the specific sales document lines.
lines.accruals object The start and end date of accruals
lines.deliveredQuantity number The delivered quantity.
lines.deliveryDate string full-date The delivery date.
lines.departmentalDistribution object The departmental distribution used by the line.
lines.departmentalDistribution.distributionType object Distribution, Department
lines.description string The description of the line.
lines.discountPercentage number The discount percentage.
lines.lineNumber integer The line number.
lines.manuallyEditedSalesPrice boolean Indicated if sales price on line was manually edited
lines.marginInBaseCurrency number The margin in the base currency of the agreement.
lines.marginPercentage number The margin percentage.
lines.product object The product.
lines.quantity number The quantity.
lines.sortKey integer The sort key.
lines.totalNetAmount number The total net amount.
lines.unit object The unit.
lines.unitCostPrice number The unit cost price.
lines.unitNetPrice number The unit net price.
locks object Locks that does not allow document to be modified
locks.description string Description of lock
locks.lockType integer Type number of the lock
locks.salesDocumentDraftNumber integer Sales Document number which is locked by this lock
marginInBaseCurrency number The difference between the net price and the cost price on the sales document line in base currency.
marginPercentage number The margin on the sales document line expressed as a percentage.
netAmount number The total sales document amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total sales document amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the sales document.
notes.heading string The order heading. Usually displayed at the top of the order.
notes.text1 string The first line of supplementary text on the order. This is usually displayed right under the heading in a smaller font.
notes.text2 string The second line of supplementary text in the notes on the order. This is usually displayed as a footer on the order.
number integer The number of the workflow - quotation - order - draft invoice
numberSeries object The number series used for the sales document.
numberSeries.allowGaps boolean A boolean value, indicating if gaps are allowed between the entry numbers.
numberSeries.entrySubtype object The entry sub type of the number series.
numberSeries.entrySubtype.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote Type of the entry.
numberSeries.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
numberSeries.isOrdered boolean A boolean value, indicating if the number series is an ordered number series. If left out, it means that the number series is not ordered
numberSeries.name string The name of the number series.
numberSeries.numberSeriesNumber integer The number of the number series
numberSeries.peeks object An array of peek values for the number series.
numberSeries.prefix string The prefix for the number series.
numberSeries.systemGenerated boolean A boolean value, indicating if the number series is generated by the system.
paymentLines object An array containing the payment lines splitting the payment into multiple due dates. These can only be used if you have the feature.
paymentLines.amount number
paymentLines.dueDate string full-date
paymentLines.lineNumber integer
paymentTerms object The terms of payment for the sales document.
paymentTerms.paymentTermsNumber integer A unique identifier of the payment term.
paymentType object A type description how the payment should be executed
paymentType.fields object List of the payment type’s fields.
paymentType.fields.dataType object String, Integer Data type of the payment type field.
paymentType.name string Payment type’s name.
paymentType.paymentTypeNumber integer Unique identifier of the payment type.
pdf object References a pdf representation of this sales document.
pdf.download object The unique reference of the pdf representation for this order.
priceList object A price list that is used for product prices
priceList.name string Price list’s name.
priceList.number integer Unique identifier of the price list.
project object References the project this sales document belongs to.
project.projectNumber integer A unique identifier of the project.
recipient object The actual recipient of the sales document. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
recipient.address string The street address of the actual recipient.
recipient.attention object The person to whom this order is addressed.
recipient.attention.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
recipient.city string The city of the actual recipient.
recipient.country string The country of the actual recipient.
recipient.county string The county of the actual recipient.
recipient.ean string The 'International Article Number’ of the actual recipient.
recipient.name string The name of the actual recipient.
recipient.publicEntryNumber string The public entry number of the actual recipient.
recipient.vatZone object Recipient vat zone.
recipient.zip string The zip code of the actual recipient.
references object Customer and company references related to this sales document.
references.customerContact object The customer contact is a reference to the employee at the customer to contact regarding the order.
references.customerContact.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
references.other string A text field that can be used to save any custom reference on the order.
references.primarySalesPerson object The sales person is a reference to the employee who sold the goods on the order. This is also the person who is credited with this sale in reports.
references.secondarySalesPerson object A reference to any second employee involved in the sale.
roundingAmount number The total rounding error, if any, on the sales document in base currency.
tenderContract object The tender contract used for the sales document.
tenderContract.cig string Public administration tender reference number.
tenderContract.cup string Public administration project reference.
tenderContract.customerNumber integer Customer’s reference.
tenderContract.description string Custom description.
tenderContract.documentNumber string Document number.
tenderContract.tenderContractNumber integer Unique identifier of the contract.
tenderContract.type object Contract, Convention
vatAccount object References the VAT account overriding VAT on all lines.
vatAccount.vatCode string The vat code of the vat account.
vatAmount number The total amount of VAT on the sales document in the currency. This will have the same sign as net amount.
vatIncluded boolean If VatMatrix is not enabled this flag will tell that vat should be calculated for this invoice. If VatMatrix is enabled this flag is readonly.
voucher object The voucher related to the invoice
voucher.booked boolean
voucher.date string full-date
voucher.externalDocumentId string
voucher.voucherId integer
voucher.voucherNumber object
voucher.voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote

Get draft Invoice

GET /v2/invoices/drafts/:draftInvoiceNumber

Return type

This method returns a single object

Properties

Name Type Format Read-only Values Description
additionalExpenseLines object A list of additional expense lines
additionalExpenseLines.additionalExpense object The additional expense used on the line
additionalExpenseLines.amount number Additional expense amount
additionalExpenseLines.lineNumber integer Line number
additionalExpenseLines.vatAccount object VAT account (if different from additional expense)
additionalExpenseLines.vatAmount number VAT amount
bankAccount object Bank Account
bankAccount.accountNumber integer The number of the account
bankAccount.name string True The name of the account.
costPriceInBaseCurrency number True The total cost of the items on the sales document in the base currency of the agreement.
currency string The ISO 4217 currency code of the sales document.
customer object The customer on the sales document.
customer.customerNumber integer The unique identifier of the customer.
customer.name string The customer name.
date string full-date Sales document issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the sales document. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
delivery.address string Street address where the goods must be delivered to the customer.
delivery.city string The city of the place of delivery.
delivery.country string The country of the place of delivery.
delivery.county string The county of the place of delivery.
delivery.deliveryDate string full-date The date of delivery.
delivery.deliveryTerms string Details about the terms of delivery.
delivery.zip string The zip code of the place of delivery.
deliveryDetails object Details about the delivery. Used for printing delivery notes etc.
deliveryDetails.carrierInfo object Details about the carrier.
deliveryDetails.deliveryNoteNumber integer Delivery note number.
deliveryDetails.deliveryNoteNumberSeries object Delivery note number series.
deliveryDetails.deliveryNoteNumberSeries.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
deliveryDetails.deliveryStartDateTime string full-date Date and time (in UTC) the delivery started.
deliveryDetails.descriptionOfPackages string Verbal description of the packages.
deliveryDetails.numberOfPackages integer Number of packages in the delivery.
deliveryDetails.reasonForDelivery string The reason for delivery.
deliveryLocation object A reference to the place of delivery for the goods on the sales document.
deliveryLocation.address string The address of the delivery location.
deliveryLocation.barred boolean Whether the delivery location is barred.
deliveryLocation.city string The city of the delivery location.
deliveryLocation.country string The country of the delivery location.
deliveryLocation.county string The county of the delivery location.
deliveryLocation.deliveryLocationNumber integer A unique identifier for the delivery location.
deliveryLocation.electronicInvoicingOfficeCode string The office code used for electronic invoicing.
deliveryLocation.externalId string The external id.
deliveryLocation.postalCode string The zip code of the delivery location.
deliveryLocation.terms string The terms applying to the delivery location.
dueDate string full-date The date the sales document is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type 'duedate’.
exchangeRate number The exchange rate between the sales document currency and the base currency of the agreement. The exchange rate expresses how much it will cost in base currency to buy 100 units of the order currency.
grossAmount number The total sales document amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
id integer A reference number for the sales document.
isArchived boolean Boolean indication of whether the sales document is archived.
isSent boolean Boolean indication of whether the sales document is sent.
layout object The layout used for the document.
layout.deleted boolean A boolean indicating the deletion status of the layout.
layout.isDefault boolean True if the layout is the default selected by the user. This property is read only.
layout.layoutNumber integer The unique identifier of the layout.
layout.name string The descriptive name of the layout.
lines object An array containing the specific sales document lines.
lines.accruals object The start and end date of accruals
lines.deliveredQuantity number The delivered quantity.
lines.deliveryDate string full-date The delivery date.
lines.departmentalDistribution object The departmental distribution used by the line.
lines.departmentalDistribution.distributionType object Distribution, Department
lines.description string The description of the line.
lines.discountPercentage number The discount percentage.
lines.lineNumber integer The line number.
lines.manuallyEditedSalesPrice boolean Indicated if sales price on line was manually edited
lines.marginInBaseCurrency number The margin in the base currency of the agreement.
lines.marginPercentage number The margin percentage.
lines.product object The product.
lines.quantity number The quantity.
lines.sortKey integer The sort key.
lines.totalNetAmount number The total net amount.
lines.unit object The unit.
lines.unitCostPrice number The unit cost price.
lines.unitNetPrice number The unit net price.
locks object Locks that does not allow document to be modified
locks.description string Description of lock
locks.lockType integer Type number of the lock
locks.salesDocumentDraftNumber integer Sales Document number which is locked by this lock
marginInBaseCurrency number The difference between the net price and the cost price on the sales document line in base currency.
marginPercentage number The margin on the sales document line expressed as a percentage.
netAmount number The total sales document amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total sales document amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the sales document.
notes.heading string The order heading. Usually displayed at the top of the order.
notes.text1 string The first line of supplementary text on the order. This is usually displayed right under the heading in a smaller font.
notes.text2 string The second line of supplementary text in the notes on the order. This is usually displayed as a footer on the order.
number integer The number of the workflow - quotation - order - draft invoice
numberSeries object The number series used for the sales document.
numberSeries.allowGaps boolean A boolean value, indicating if gaps are allowed between the entry numbers.
numberSeries.entrySubtype object The entry sub type of the number series.
numberSeries.entrySubtype.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote Type of the entry.
numberSeries.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
numberSeries.isOrdered boolean A boolean value, indicating if the number series is an ordered number series. If left out, it means that the number series is not ordered
numberSeries.name string The name of the number series.
numberSeries.numberSeriesNumber integer The number of the number series
numberSeries.peeks object An array of peek values for the number series.
numberSeries.prefix string The prefix for the number series.
numberSeries.systemGenerated boolean A boolean value, indicating if the number series is generated by the system.
paymentLines object An array containing the payment lines splitting the payment into multiple due dates. These can only be used if you have the feature.
paymentLines.amount number
paymentLines.dueDate string full-date
paymentLines.lineNumber integer
paymentTerms object The terms of payment for the sales document.
paymentTerms.paymentTermsNumber integer A unique identifier of the payment term.
paymentType object A type description how the payment should be executed
paymentType.fields object List of the payment type’s fields.
paymentType.fields.dataType object String, Integer Data type of the payment type field.
paymentType.name string Payment type’s name.
paymentType.paymentTypeNumber integer Unique identifier of the payment type.
pdf object References a pdf representation of this sales document.
pdf.download object The unique reference of the pdf representation for this order.
priceList object A price list that is used for product prices
priceList.name string Price list’s name.
priceList.number integer Unique identifier of the price list.
project object References the project this sales document belongs to.
project.projectNumber integer A unique identifier of the project.
recipient object The actual recipient of the sales document. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
recipient.address string The street address of the actual recipient.
recipient.attention object The person to whom this order is addressed.
recipient.attention.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
recipient.city string The city of the actual recipient.
recipient.country string The country of the actual recipient.
recipient.county string The county of the actual recipient.
recipient.ean string The 'International Article Number’ of the actual recipient.
recipient.name string The name of the actual recipient.
recipient.publicEntryNumber string The public entry number of the actual recipient.
recipient.vatZone object Recipient vat zone.
recipient.zip string The zip code of the actual recipient.
references object Customer and company references related to this sales document.
references.customerContact object The customer contact is a reference to the employee at the customer to contact regarding the order.
references.customerContact.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
references.other string A text field that can be used to save any custom reference on the order.
references.primarySalesPerson object The sales person is a reference to the employee who sold the goods on the order. This is also the person who is credited with this sale in reports.
references.secondarySalesPerson object A reference to any second employee involved in the sale.
roundingAmount number The total rounding error, if any, on the sales document in base currency.
tenderContract object The tender contract used for the sales document.
tenderContract.cig string Public administration tender reference number.
tenderContract.cup string Public administration project reference.
tenderContract.customerNumber integer Customer’s reference.
tenderContract.description string Custom description.
tenderContract.documentNumber string Document number.
tenderContract.tenderContractNumber integer Unique identifier of the contract.
tenderContract.type object Contract, Convention
vatAccount object References the VAT account overriding VAT on all lines.
vatAccount.vatCode string The vat code of the vat account.
vatAmount number The total amount of VAT on the sales document in the currency. This will have the same sign as net amount.
vatIncluded boolean If VatMatrix is not enabled this flag will tell that vat should be calculated for this invoice. If VatMatrix is enabled this flag is readonly.
voucher object The voucher related to the invoice
voucher.booked boolean
voucher.date string full-date
voucher.externalDocumentId string
voucher.voucherId integer
voucher.voucherNumber object
voucher.voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote

Get draft Invoice as PDF

GET /v2/invoices/drafts/:draftInvoiceNumber/pdf

Update draft Invoice

PUT /v2/invoices/drafts/:draftInvoiceNumber

Return type

This method returns a single object

Properties

Name Type Format Description
additionalExpenseLines object A list of additional expense lines
bankAccount object Bank Account
currency string The ISO 4217 currency code of the sales document.
customer object The customer on the sales document.
customer.customerNumber integer The unique identifier of the customer.
date string full-date Sales document issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the sales document. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
deliveryDetails object Details about the delivery. Used for printing delivery notes etc.
deliveryLocation object A reference to the place of delivery for the goods on the sales document.
dueDate string full-date The date the sales document is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type 'duedate’.
exchangeRate number The exchange rate between the sales document currency and the base currency of the agreement. The exchange rate expresses how much it will cost in base currency to buy 100 units of the order currency.
grossAmount number The total sales document amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
id integer A reference number for the sales document.
isArchived boolean Boolean indication of whether the sales document is archived.
isSent boolean Boolean indication of whether the sales document is sent.
layout object The layout used for the document.
lines object An array containing the specific sales document lines.
locks object Locks that does not allow document to be modified
marginInBaseCurrency number The difference between the net price and the cost price on the sales document line in base currency.
marginPercentage number The margin on the sales document line expressed as a percentage.
netAmount number The total sales document amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total sales document amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the sales document.
number integer The number of the workflow - quotation - order - draft invoice
numberSeries object The number series used for the sales document.
paymentLines object An array containing the payment lines splitting the payment into multiple due dates. These can only be used if you have the feature.
paymentTerms object The terms of payment for the sales document.
paymentType object A type description how the payment should be executed
pdf object References a pdf representation of this sales document.
priceList object A price list that is used for product prices
project object References the project this sales document belongs to.
recipient object The actual recipient of the sales document. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
references object Customer and company references related to this sales document.
roundingAmount number The total rounding error, if any, on the sales document in base currency.
tenderContract object The tender contract used for the sales document.
vatAccount object References the VAT account overriding VAT on all lines.
vatAmount number The total amount of VAT on the sales document in the currency. This will have the same sign as net amount.
vatIncluded boolean If VatMatrix is not enabled this flag will tell that vat should be calculated for this invoice. If VatMatrix is enabled this flag is readonly.
voucher object The voucher related to the invoice

Create draft Invoice

POST /v2/invoices/drafts/

Return type

This method returns a single object

Properties

Name Type Format Description
additionalExpenseLines object A list of additional expense lines
bankAccount object Bank Account
currency string The ISO 4217 currency code of the sales document.
customer object The customer on the sales document.
customer.customerNumber integer The unique identifier of the customer.
date string full-date Sales document issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the sales document. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
deliveryDetails object Details about the delivery. Used for printing delivery notes etc.
deliveryLocation object A reference to the place of delivery for the goods on the sales document.
dueDate string full-date The date the sales document is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type 'duedate’.
exchangeRate number The exchange rate between the sales document currency and the base currency of the agreement. The exchange rate expresses how much it will cost in base currency to buy 100 units of the order currency.
grossAmount number The total sales document amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
id integer A reference number for the sales document.
isArchived boolean Boolean indication of whether the sales document is archived.
isSent boolean Boolean indication of whether the sales document is sent.
layout object The layout used for the document.
lines object An array containing the specific sales document lines.
locks object Locks that does not allow document to be modified
marginInBaseCurrency number The difference between the net price and the cost price on the sales document line in base currency.
marginPercentage number The margin on the sales document line expressed as a percentage.
netAmount number The total sales document amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total sales document amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the sales document.
number integer The number of the workflow - quotation - order - draft invoice
numberSeries object The number series used for the sales document.
paymentLines object An array containing the payment lines splitting the payment into multiple due dates. These can only be used if you have the feature.
paymentTerms object The terms of payment for the sales document.
paymentType object A type description how the payment should be executed
pdf object References a pdf representation of this sales document.
priceList object A price list that is used for product prices
project object References the project this sales document belongs to.
recipient object The actual recipient of the sales document. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
references object Customer and company references related to this sales document.
roundingAmount number The total rounding error, if any, on the sales document in base currency.
tenderContract object The tender contract used for the sales document.
vatAccount object References the VAT account overriding VAT on all lines.
vatAmount number The total amount of VAT on the sales document in the currency. This will have the same sign as net amount.
vatIncluded boolean If VatMatrix is not enabled this flag will tell that vat should be calculated for this invoice. If VatMatrix is enabled this flag is readonly.
voucher object The voucher related to the invoice

Delete all draft Invoices

DELETE /v2/invoices/drafts/

Delete draft Invoice

DELETE /v2/invoices/drafts/:draftInvoiceNumber

Return type

This method returns a single object

Properties

Name Type Description
id integer A reference number for the sales document.

Attach PDF to draft Invoice

POST /v2/invoices/drafts/:draftInvoiceNumber/attachment

Notes
Example request
curl --request POST \
  --url https://rest.reviso.com/v2/invoices/drafts/72/attachment \
  --header 'X-AgreementGrantToken: your_agreement_grant_token' \
  --header 'X-AppSecretToken: your_app_secret_token' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form '=@C:\path\to\your\file\file_name.pdf'

Delete PDF attachment

DELETE /v2/invoices/drafts/:draftInvoiceNumber/attachment

Book draft Invoice

POST /v2/invoices/booked

Book a single draft invoice by POST'ing its ID to /v2/invoices/booked like this:

{
    "id": 58
}

Get booked Invoices

GET /v2/invoices/booked

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Read-only Values Description
additionalExpenseLines object A list of additional expenses
additionalExpenseLines.account object Account
additionalExpenseLines.amount number Additional expense amount
additionalExpenseLines.lineNumber integer Line number
additionalExpenseLines.name string Additional expense name
additionalExpenseLines.vatAccount object VAT account (if different from additional expense)
additionalExpenseLines.vatAmount number VAT amount
bankAccount object The bank account used for the invoice
bankAccount.accountNumber integer The number of the account
bankAccount.name string True The name of the account.
bookedInvoiceNumber integer A reference number for the invoice.
currency string The ISO 4217 currency code of the invoice.
customer object The customer on the invoice.
customer.customerNumber integer The unique identifier of the customer.
customer.name string The customer name.
date string full-date Invoice issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the invoice. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
delivery.address string Street address where the goods must be delivered to the customer.
delivery.city string The city of the place of delivery.
delivery.country string The country of the place of delivery.
delivery.county string The county of the place of delivery.
delivery.deliveryDate string full-date The date of delivery.
delivery.deliveryTerms string Details about the terms of delivery.
delivery.zip string The zip code of the place of delivery.
deliveryLocation object A reference to the place of delivery for the goods on the invoice.
deliveryLocation.address string The address of the delivery location.
deliveryLocation.barred boolean Whether the delivery location is barred.
deliveryLocation.city string The city of the delivery location.
deliveryLocation.country string The country of the delivery location.
deliveryLocation.county string The county of the delivery location.
deliveryLocation.deliveryLocationNumber integer A unique identifier for the delivery location.
deliveryLocation.electronicInvoicingOfficeCode string The office code used for electronic invoicing.
deliveryLocation.externalId string The external id.
deliveryLocation.postalCode string The zip code of the delivery location.
deliveryLocation.terms string The terms applying to the delivery location.
displayInvoiceNumber string The human readable invoice number.
dueDate string full-date The date the invoice is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type 'duedate’.
electronicInvoiceFiles object A link to manage this invoice electronically
electronicInvoiceFiles.downloadLink object
electronicInvoiceFiles.excludeDueDatePayments boolean
electronicInvoiceFiles.fileCreationDate string full-date
electronicInvoiceFiles.fileName string
electronicInvoiceFiles.invoice object
electronicInvoiceFiles.number integer
electronicInvoiceFiles.status object None, GeneratingFile, FileGenerated, FailedToGenerateFile
grossAmount number The total invoice amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
layout object The layout used for the document.
layout.deleted boolean A boolean indicating the deletion status of the layout.
layout.isDefault boolean True if the layout is the default selected by the user. This property is read only.
layout.layoutNumber integer The unique identifier of the layout.
layout.name string The descriptive name of the layout.
lines object An array containing the specific invoice lines.
lines.deliveryDate string full-date The delivery date.
lines.departmentalDistribution object The departmental distribution used by the line.
lines.departmentalDistribution.distributionType object Distribution, Department
lines.description string The description of the line.
lines.discountPercentage number The discount percentage.
lines.lineNumber integer The line number.
lines.product object The product.
lines.quantity number The quantity.
lines.sortKey integer The sort key.
lines.totalNetAmount number The total net amount.
lines.unit object The unit.
lines.unitCostPrice number The unit cost price.
lines.unitNetPrice number The unit net price.
lines.vatAccount object The vat account of the invoice line.
lines.vatAmount number The total vat amount of the invoice line.
lines.vatRate number The vat rate of the invoice line.
netAmount number The total invoice amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total invoice amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the invoice.
notes.heading string The invoice heading. Usually displayed at the top of the invoice.
notes.textLine1 string The first line of supplementary text on the invoice. This is usually displayed right under the heading in a smaller font.
notes.textLine2 string The second line of supplementary text in the notes on the invoice. This is usually displayed as a footer on the invoice.
number integer Workflow number - assigned at first step, which could be order or draft
paymentTerms object The terms of payment for the invoice.
paymentTerms.barred boolean If this payment term is accessible.
paymentTerms.cashDiscountAccount object The cash discount account.
paymentTerms.cashDiscountDayLimit integer The cash discount day limit.
paymentTerms.cashDiscountRate number The cash discount rate.
paymentTerms.contraAccountForPrepaidAmount object The contra account. Used for PaidInCash and Factoring only.
paymentTerms.contraAccountForRemainderAmount object The contra account for the remainder amount. Used for Factoring only.
paymentTerms.creditCardCompany object The credit card company. Used for type CreditCard only.
paymentTerms.creditCardCompany.italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
paymentTerms.daysOfCredit integer The number of days of credit on the order. This field is only valid if terms of payment is not of type 'duedate’.
paymentTerms.description string The description of the payment term.
paymentTerms.name string The name of the payment terms.
paymentTerms.numberSeriesForCustomerPayment object The number series to use for creating customer payment vouchers. Used for paidInCash or creditcard type only.
paymentTerms.numberSeriesForCustomerPayment.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
paymentTerms.paymentTermsNumber integer A unique identifier of the payment term.
paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.percentageForPrepaidAmount number The percentage for prepaid amount. Used for Factoring only.
paymentTerms.percentageForRemainderAmount number The percentage for the remainder amount. Used for Factoring only.
paymentTerms.timetablePaymentTemplate object The timetable payment template. Used for Timetable only.
paymentTerms.timetablePaymentTemplate.lines object An array containing the timetable pament template lines.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms object The payment term for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.timetablePaymentTemplate.lines.percentage number The percentage to use for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.timetablePaymentTemplateLineNumber integer A unique identifier of the timetable payment template line.
paymentTerms.type string The type the payment term.
paymentType object A type description how the payment should be executed
paymentType.fields object List of the payment type’s fields.
paymentType.fields.dataType object String, Integer Data type of the payment type field.
paymentType.name string Payment type’s name.
paymentType.paymentTypeNumber integer Unique identifier of the payment type.
pdf object References a pdf representation of this invoice.
pdf.download object The unique reference of the pdf representation for this invoice.
project object References the project this invoice belongs to.
project.projectNumber integer A unique identifier of the project.
recipient object The actual recipient of the invoice. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
recipient.address string The street address of the actual recipient.
recipient.attention object The person to whom this order is addressed.
recipient.attention.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
recipient.city string The city of the actual recipient.
recipient.country string The country of the actual recipient.
recipient.county string The county of the actual recipient.
recipient.ean string The 'International Article Number’ of the actual recipient.
recipient.name string The name of the actual recipient.
recipient.publicEntryNumber string The public entry number of the actual recipient.
recipient.vatZone object Recipient vat zone.
recipient.zip string The zip code of the actual recipient.
references object Customer and company references related to this invoice.
references.customerContact object The customer contact is a reference to the employee at the customer to contact regarding the invoice.
references.customerContact.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
references.other string A text field that can be used to save any custom reference on the invoice.
references.salesPerson object The sales person is a reference to the employee who sold the goods on the invoice. This is also the person who is credited with this sale in reports.
references.vendorReference object A reference to the vender.
remainder number The total remainder, if any, on the invoice.
remainderInBaseCurrency number The total remainder, if any, on the invoice in base currency.
roundingAmount number The total rounding error, if any, on the invoice in base currency.
tenderContract object The tender contract used for the sales document.
tenderContract.cig string Public administration tender reference number.
tenderContract.cup string Public administration project reference.
tenderContract.customerNumber integer Customer’s reference.
tenderContract.description string Custom description.
tenderContract.documentNumber string Document number.
tenderContract.tenderContractNumber integer Unique identifier of the contract.
tenderContract.type object Contract, Convention
vatAccount object The vat code that overrides vat for all lines
vatAccount.vatCode string The vat code of the vat account.
vatAmount number The total amount of VAT on the invoice in the currency. This will have the same sign as net amount.
voucher object The voucher related to the invoice
voucher.booked boolean
voucher.date string full-date
voucher.externalDocumentId string
voucher.voucherId integer
voucher.voucherNumber object
voucher.voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote

Get specific booked Invoice

GET /v2/invoices/booked/:bookedInvoiceNumber

Return type

This method returns a single object

Properties

Name Type Format Read-only Values Description
additionalExpenseLines object A list of additional expenses
additionalExpenseLines.account object Account
additionalExpenseLines.amount number Additional expense amount
additionalExpenseLines.lineNumber integer Line number
additionalExpenseLines.name string Additional expense name
additionalExpenseLines.vatAccount object VAT account (if different from additional expense)
additionalExpenseLines.vatAmount number VAT amount
bankAccount object The bank account used for the invoice
bankAccount.accountNumber integer The number of the account
bankAccount.name string True The name of the account.
bookedInvoiceNumber integer A reference number for the invoice.
currency string The ISO 4217 currency code of the invoice.
customer object The customer on the invoice.
customer.customerNumber integer The unique identifier of the customer.
customer.name string The customer name.
date string full-date Invoice issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the invoice. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
delivery.address string Street address where the goods must be delivered to the customer.
delivery.city string The city of the place of delivery.
delivery.country string The country of the place of delivery.
delivery.county string The county of the place of delivery.
delivery.deliveryDate string full-date The date of delivery.
delivery.deliveryTerms string Details about the terms of delivery.
delivery.zip string The zip code of the place of delivery.
deliveryLocation object A reference to the place of delivery for the goods on the invoice.
deliveryLocation.address string The address of the delivery location.
deliveryLocation.barred boolean Whether the delivery location is barred.
deliveryLocation.city string The city of the delivery location.
deliveryLocation.country string The country of the delivery location.
deliveryLocation.county string The county of the delivery location.
deliveryLocation.deliveryLocationNumber integer A unique identifier for the delivery location.
deliveryLocation.electronicInvoicingOfficeCode string The office code used for electronic invoicing.
deliveryLocation.externalId string The external id.
deliveryLocation.postalCode string The zip code of the delivery location.
deliveryLocation.terms string The terms applying to the delivery location.
displayInvoiceNumber string The human readable invoice number.
dueDate string full-date The date the invoice is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type 'duedate’.
electronicInvoiceFiles object A link to manage this invoice electronically
electronicInvoiceFiles.downloadLink object
electronicInvoiceFiles.excludeDueDatePayments boolean
electronicInvoiceFiles.fileCreationDate string full-date
electronicInvoiceFiles.fileName string
electronicInvoiceFiles.invoice object
electronicInvoiceFiles.number integer
electronicInvoiceFiles.status object None, GeneratingFile, FileGenerated, FailedToGenerateFile
grossAmount number The total invoice amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
layout object The layout used for the document.
layout.deleted boolean A boolean indicating the deletion status of the layout.
layout.isDefault boolean True if the layout is the default selected by the user. This property is read only.
layout.layoutNumber integer The unique identifier of the layout.
layout.name string The descriptive name of the layout.
lines object An array containing the specific invoice lines.
lines.deliveryDate string full-date The delivery date.
lines.departmentalDistribution object The departmental distribution used by the line.
lines.departmentalDistribution.distributionType object Distribution, Department
lines.description string The description of the line.
lines.discountPercentage number The discount percentage.
lines.lineNumber integer The line number.
lines.product object The product.
lines.quantity number The quantity.
lines.sortKey integer The sort key.
lines.totalNetAmount number The total net amount.
lines.unit object The unit.
lines.unitCostPrice number The unit cost price.
lines.unitNetPrice number The unit net price.
lines.vatAccount object The vat account of the invoice line.
lines.vatAmount number The total vat amount of the invoice line.
lines.vatRate number The vat rate of the invoice line.
netAmount number The total invoice amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total invoice amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the invoice.
notes.heading string The invoice heading. Usually displayed at the top of the invoice.
notes.textLine1 string The first line of supplementary text on the invoice. This is usually displayed right under the heading in a smaller font.
notes.textLine2 string The second line of supplementary text in the notes on the invoice. This is usually displayed as a footer on the invoice.
number integer Workflow number - assigned at first step, which could be order or draft
paymentTerms object The terms of payment for the invoice.
paymentTerms.barred boolean If this payment term is accessible.
paymentTerms.cashDiscountAccount object The cash discount account.
paymentTerms.cashDiscountDayLimit integer The cash discount day limit.
paymentTerms.cashDiscountRate number The cash discount rate.
paymentTerms.contraAccountForPrepaidAmount object The contra account. Used for PaidInCash and Factoring only.
paymentTerms.contraAccountForRemainderAmount object The contra account for the remainder amount. Used for Factoring only.
paymentTerms.creditCardCompany object The credit card company. Used for type CreditCard only.
paymentTerms.creditCardCompany.italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
paymentTerms.daysOfCredit integer The number of days of credit on the order. This field is only valid if terms of payment is not of type 'duedate’.
paymentTerms.description string The description of the payment term.
paymentTerms.name string The name of the payment terms.
paymentTerms.numberSeriesForCustomerPayment object The number series to use for creating customer payment vouchers. Used for paidInCash or creditcard type only.
paymentTerms.numberSeriesForCustomerPayment.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
paymentTerms.paymentTermsNumber integer A unique identifier of the payment term.
paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.percentageForPrepaidAmount number The percentage for prepaid amount. Used for Factoring only.
paymentTerms.percentageForRemainderAmount number The percentage for the remainder amount. Used for Factoring only.
paymentTerms.timetablePaymentTemplate object The timetable payment template. Used for Timetable only.
paymentTerms.timetablePaymentTemplate.lines object An array containing the timetable pament template lines.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms object The payment term for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.timetablePaymentTemplate.lines.percentage number The percentage to use for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.timetablePaymentTemplateLineNumber integer A unique identifier of the timetable payment template line.
paymentTerms.type string The type the payment term.
paymentType object A type description how the payment should be executed
paymentType.fields object List of the payment type’s fields.
paymentType.fields.dataType object String, Integer Data type of the payment type field.
paymentType.name string Payment type’s name.
paymentType.paymentTypeNumber integer Unique identifier of the payment type.
pdf object References a pdf representation of this invoice.
pdf.download object The unique reference of the pdf representation for this invoice.
project object References the project this invoice belongs to.
project.projectNumber integer A unique identifier of the project.
recipient object The actual recipient of the invoice. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
recipient.address string The street address of the actual recipient.
recipient.attention object The person to whom this order is addressed.
recipient.attention.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
recipient.city string The city of the actual recipient.
recipient.country string The country of the actual recipient.
recipient.county string The county of the actual recipient.
recipient.ean string The 'International Article Number’ of the actual recipient.
recipient.name string The name of the actual recipient.
recipient.publicEntryNumber string The public entry number of the actual recipient.
recipient.vatZone object Recipient vat zone.
recipient.zip string The zip code of the actual recipient.
references object Customer and company references related to this invoice.
references.customerContact object The customer contact is a reference to the employee at the customer to contact regarding the invoice.
references.customerContact.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
references.other string A text field that can be used to save any custom reference on the invoice.
references.salesPerson object The sales person is a reference to the employee who sold the goods on the invoice. This is also the person who is credited with this sale in reports.
references.vendorReference object A reference to the vender.
remainder number The total remainder, if any, on the invoice.
remainderInBaseCurrency number The total remainder, if any, on the invoice in base currency.
roundingAmount number The total rounding error, if any, on the invoice in base currency.
tenderContract object The tender contract used for the sales document.
tenderContract.cig string Public administration tender reference number.
tenderContract.cup string Public administration project reference.
tenderContract.customerNumber integer Customer’s reference.
tenderContract.description string Custom description.
tenderContract.documentNumber string Document number.
tenderContract.tenderContractNumber integer Unique identifier of the contract.
tenderContract.type object Contract, Convention
vatAccount object The vat code that overrides vat for all lines
vatAccount.vatCode string The vat code of the vat account.
vatAmount number The total amount of VAT on the invoice in the currency. This will have the same sign as net amount.
voucher object The voucher related to the invoice
voucher.booked boolean
voucher.date string full-date
voucher.externalDocumentId string
voucher.voucherId integer
voucher.voucherNumber object
voucher.voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote

Get booked Invoice as PDF

GET /v2/invoices/booked/:bookedInvoiceNumber/pdf

Get all unpaid Invoices

GET /v2/invoices/unpaid

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Read-only Values Description
additionalExpenseLines object A list of additional expenses
additionalExpenseLines.account object Account
additionalExpenseLines.amount number Additional expense amount
additionalExpenseLines.lineNumber integer Line number
additionalExpenseLines.name string Additional expense name
additionalExpenseLines.vatAccount object VAT account (if different from additional expense)
additionalExpenseLines.vatAmount number VAT amount
bankAccount object The bank account used for the invoice
bankAccount.accountNumber integer The number of the account
bankAccount.name string True The name of the account.
bookedInvoiceNumber integer A reference number for the invoice.
currency string The ISO 4217 currency code of the invoice.
customer object The customer on the invoice.
customer.customerNumber integer The unique identifier of the customer.
customer.name string The customer name.
date string full-date Invoice issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the invoice. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
delivery.address string Street address where the goods must be delivered to the customer.
delivery.city string The city of the place of delivery.
delivery.country string The country of the place of delivery.
delivery.county string The county of the place of delivery.
delivery.deliveryDate string full-date The date of delivery.
delivery.deliveryTerms string Details about the terms of delivery.
delivery.zip string The zip code of the place of delivery.
deliveryLocation object A reference to the place of delivery for the goods on the invoice.
deliveryLocation.address string The address of the delivery location.
deliveryLocation.barred boolean Whether the delivery location is barred.
deliveryLocation.city string The city of the delivery location.
deliveryLocation.country string The country of the delivery location.
deliveryLocation.county string The county of the delivery location.
deliveryLocation.deliveryLocationNumber integer A unique identifier for the delivery location.
deliveryLocation.electronicInvoicingOfficeCode string The office code used for electronic invoicing.
deliveryLocation.externalId string The external id.
deliveryLocation.postalCode string The zip code of the delivery location.
deliveryLocation.terms string The terms applying to the delivery location.
displayInvoiceNumber string The human readable invoice number.
dueDate string full-date The date the invoice is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type 'duedate’.
electronicInvoiceFiles object A link to manage this invoice electronically
electronicInvoiceFiles.downloadLink object
electronicInvoiceFiles.excludeDueDatePayments boolean
electronicInvoiceFiles.fileCreationDate string full-date
electronicInvoiceFiles.fileName string
electronicInvoiceFiles.invoice object
electronicInvoiceFiles.number integer
electronicInvoiceFiles.status object None, GeneratingFile, FileGenerated, FailedToGenerateFile
grossAmount number The total invoice amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
layout object The layout used for the document.
layout.deleted boolean A boolean indicating the deletion status of the layout.
layout.isDefault boolean True if the layout is the default selected by the user. This property is read only.
layout.layoutNumber integer The unique identifier of the layout.
layout.name string The descriptive name of the layout.
lines object An array containing the specific invoice lines.
lines.deliveryDate string full-date The delivery date.
lines.departmentalDistribution object The departmental distribution used by the line.
lines.departmentalDistribution.distributionType object Distribution, Department
lines.description string The description of the line.
lines.discountPercentage number The discount percentage.
lines.lineNumber integer The line number.
lines.product object The product.
lines.quantity number The quantity.
lines.sortKey integer The sort key.
lines.totalNetAmount number The total net amount.
lines.unit object The unit.
lines.unitCostPrice number The unit cost price.
lines.unitNetPrice number The unit net price.
lines.vatAccount object The vat account of the invoice line.
lines.vatAmount number The total vat amount of the invoice line.
lines.vatRate number The vat rate of the invoice line.
netAmount number The total invoice amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total invoice amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the invoice.
notes.heading string The invoice heading. Usually displayed at the top of the invoice.
notes.textLine1 string The first line of supplementary text on the invoice. This is usually displayed right under the heading in a smaller font.
notes.textLine2 string The second line of supplementary text in the notes on the invoice. This is usually displayed as a footer on the invoice.
number integer Workflow number - assigned at first step, which could be order or draft
paymentTerms object The terms of payment for the invoice.
paymentTerms.barred boolean If this payment term is accessible.
paymentTerms.cashDiscountAccount object The cash discount account.
paymentTerms.cashDiscountDayLimit integer The cash discount day limit.
paymentTerms.cashDiscountRate number The cash discount rate.
paymentTerms.contraAccountForPrepaidAmount object The contra account. Used for PaidInCash and Factoring only.
paymentTerms.contraAccountForRemainderAmount object The contra account for the remainder amount. Used for Factoring only.
paymentTerms.creditCardCompany object The credit card company. Used for type CreditCard only.
paymentTerms.creditCardCompany.italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
paymentTerms.daysOfCredit integer The number of days of credit on the order. This field is only valid if terms of payment is not of type 'duedate’.
paymentTerms.description string The description of the payment term.
paymentTerms.name string The name of the payment terms.
paymentTerms.numberSeriesForCustomerPayment object The number series to use for creating customer payment vouchers. Used for paidInCash or creditcard type only.
paymentTerms.numberSeriesForCustomerPayment.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
paymentTerms.paymentTermsNumber integer A unique identifier of the payment term.
paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.percentageForPrepaidAmount number The percentage for prepaid amount. Used for Factoring only.
paymentTerms.percentageForRemainderAmount number The percentage for the remainder amount. Used for Factoring only.
paymentTerms.timetablePaymentTemplate object The timetable payment template. Used for Timetable only.
paymentTerms.timetablePaymentTemplate.lines object An array containing the timetable pament template lines.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms object The payment term for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.timetablePaymentTemplate.lines.percentage number The percentage to use for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.timetablePaymentTemplateLineNumber integer A unique identifier of the timetable payment template line.
paymentTerms.type string The type the payment term.
paymentType object A type description how the payment should be executed
paymentType.fields object List of the payment type’s fields.
paymentType.fields.dataType object String, Integer Data type of the payment type field.
paymentType.name string Payment type’s name.
paymentType.paymentTypeNumber integer Unique identifier of the payment type.
pdf object References a pdf representation of this invoice.
pdf.download object The unique reference of the pdf representation for this invoice.
project object References the project this invoice belongs to.
project.projectNumber integer A unique identifier of the project.
recipient object The actual recipient of the invoice. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
recipient.address string The street address of the actual recipient.
recipient.attention object The person to whom this order is addressed.
recipient.attention.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
recipient.city string The city of the actual recipient.
recipient.country string The country of the actual recipient.
recipient.county string The county of the actual recipient.
recipient.ean string The 'International Article Number’ of the actual recipient.
recipient.name string The name of the actual recipient.
recipient.publicEntryNumber string The public entry number of the actual recipient.
recipient.vatZone object Recipient vat zone.
recipient.zip string The zip code of the actual recipient.
references object Customer and company references related to this invoice.
references.customerContact object The customer contact is a reference to the employee at the customer to contact regarding the invoice.
references.customerContact.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
references.other string A text field that can be used to save any custom reference on the invoice.
references.salesPerson object The sales person is a reference to the employee who sold the goods on the invoice. This is also the person who is credited with this sale in reports.
references.vendorReference object A reference to the vender.
remainder number The total remainder, if any, on the invoice.
remainderInBaseCurrency number The total remainder, if any, on the invoice in base currency.
roundingAmount number The total rounding error, if any, on the invoice in base currency.
tenderContract object The tender contract used for the sales document.
tenderContract.cig string Public administration tender reference number.
tenderContract.cup string Public administration project reference.
tenderContract.customerNumber integer Customer’s reference.
tenderContract.description string Custom description.
tenderContract.documentNumber string Document number.
tenderContract.tenderContractNumber integer Unique identifier of the contract.
tenderContract.type object Contract, Convention
vatAccount object The vat code that overrides vat for all lines
vatAccount.vatCode string The vat code of the vat account.
vatAmount number The total amount of VAT on the invoice in the currency. This will have the same sign as net amount.
voucher object The voucher related to the invoice
voucher.booked boolean
voucher.date string full-date
voucher.externalDocumentId string
voucher.voucherId integer
voucher.voucherNumber object
voucher.voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote

Get all paid Invoices

GET /v2/invoices/paid

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Read-only Values Description
additionalExpenseLines object A list of additional expenses
additionalExpenseLines.account object Account
additionalExpenseLines.amount number Additional expense amount
additionalExpenseLines.lineNumber integer Line number
additionalExpenseLines.name string Additional expense name
additionalExpenseLines.vatAccount object VAT account (if different from additional expense)
additionalExpenseLines.vatAmount number VAT amount
bankAccount object The bank account used for the invoice
bankAccount.accountNumber integer The number of the account
bankAccount.name string True The name of the account.
bookedInvoiceNumber integer A reference number for the invoice.
currency string The ISO 4217 currency code of the invoice.
customer object The customer on the invoice.
customer.customerNumber integer The unique identifier of the customer.
customer.name string The customer name.
date string full-date Invoice issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the invoice. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
delivery.address string Street address where the goods must be delivered to the customer.
delivery.city string The city of the place of delivery.
delivery.country string The country of the place of delivery.
delivery.county string The county of the place of delivery.
delivery.deliveryDate string full-date The date of delivery.
delivery.deliveryTerms string Details about the terms of delivery.
delivery.zip string The zip code of the place of delivery.
deliveryLocation object A reference to the place of delivery for the goods on the invoice.
deliveryLocation.address string The address of the delivery location.
deliveryLocation.barred boolean Whether the delivery location is barred.
deliveryLocation.city string The city of the delivery location.
deliveryLocation.country string The country of the delivery location.
deliveryLocation.county string The county of the delivery location.
deliveryLocation.deliveryLocationNumber integer A unique identifier for the delivery location.
deliveryLocation.electronicInvoicingOfficeCode string The office code used for electronic invoicing.
deliveryLocation.externalId string The external id.
deliveryLocation.postalCode string The zip code of the delivery location.
deliveryLocation.terms string The terms applying to the delivery location.
displayInvoiceNumber string The human readable invoice number.
dueDate string full-date The date the invoice is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type 'duedate’.
electronicInvoiceFiles object A link to manage this invoice electronically
electronicInvoiceFiles.downloadLink object
electronicInvoiceFiles.excludeDueDatePayments boolean
electronicInvoiceFiles.fileCreationDate string full-date
electronicInvoiceFiles.fileName string
electronicInvoiceFiles.invoice object
electronicInvoiceFiles.number integer
electronicInvoiceFiles.status object None, GeneratingFile, FileGenerated, FailedToGenerateFile
grossAmount number The total invoice amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
layout object The layout used for the document.
layout.deleted boolean A boolean indicating the deletion status of the layout.
layout.isDefault boolean True if the layout is the default selected by the user. This property is read only.
layout.layoutNumber integer The unique identifier of the layout.
layout.name string The descriptive name of the layout.
lines object An array containing the specific invoice lines.
lines.deliveryDate string full-date The delivery date.
lines.departmentalDistribution object The departmental distribution used by the line.
lines.departmentalDistribution.distributionType object Distribution, Department
lines.description string The description of the line.
lines.discountPercentage number The discount percentage.
lines.lineNumber integer The line number.
lines.product object The product.
lines.quantity number The quantity.
lines.sortKey integer The sort key.
lines.totalNetAmount number The total net amount.
lines.unit object The unit.
lines.unitCostPrice number The unit cost price.
lines.unitNetPrice number The unit net price.
lines.vatAccount object The vat account of the invoice line.
lines.vatAmount number The total vat amount of the invoice line.
lines.vatRate number The vat rate of the invoice line.
netAmount number The total invoice amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total invoice amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the invoice.
notes.heading string The invoice heading. Usually displayed at the top of the invoice.
notes.textLine1 string The first line of supplementary text on the invoice. This is usually displayed right under the heading in a smaller font.
notes.textLine2 string The second line of supplementary text in the notes on the invoice. This is usually displayed as a footer on the invoice.
number integer Workflow number - assigned at first step, which could be order or draft
paymentTerms object The terms of payment for the invoice.
paymentTerms.barred boolean If this payment term is accessible.
paymentTerms.cashDiscountAccount object The cash discount account.
paymentTerms.cashDiscountDayLimit integer The cash discount day limit.
paymentTerms.cashDiscountRate number The cash discount rate.
paymentTerms.contraAccountForPrepaidAmount object The contra account. Used for PaidInCash and Factoring only.
paymentTerms.contraAccountForRemainderAmount object The contra account for the remainder amount. Used for Factoring only.
paymentTerms.creditCardCompany object The credit card company. Used for type CreditCard only.
paymentTerms.creditCardCompany.italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
paymentTerms.daysOfCredit integer The number of days of credit on the order. This field is only valid if terms of payment is not of type 'duedate’.
paymentTerms.description string The description of the payment term.
paymentTerms.name string The name of the payment terms.
paymentTerms.numberSeriesForCustomerPayment object The number series to use for creating customer payment vouchers. Used for paidInCash or creditcard type only.
paymentTerms.numberSeriesForCustomerPayment.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
paymentTerms.paymentTermsNumber integer A unique identifier of the payment term.
paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.percentageForPrepaidAmount number The percentage for prepaid amount. Used for Factoring only.
paymentTerms.percentageForRemainderAmount number The percentage for the remainder amount. Used for Factoring only.
paymentTerms.timetablePaymentTemplate object The timetable payment template. Used for Timetable only.
paymentTerms.timetablePaymentTemplate.lines object An array containing the timetable pament template lines.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms object The payment term for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.timetablePaymentTemplate.lines.percentage number The percentage to use for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.timetablePaymentTemplateLineNumber integer A unique identifier of the timetable payment template line.
paymentTerms.type string The type the payment term.
paymentType object A type description how the payment should be executed
paymentType.fields object List of the payment type’s fields.
paymentType.fields.dataType object String, Integer Data type of the payment type field.
paymentType.name string Payment type’s name.
paymentType.paymentTypeNumber integer Unique identifier of the payment type.
pdf object References a pdf representation of this invoice.
pdf.download object The unique reference of the pdf representation for this invoice.
project object References the project this invoice belongs to.
project.projectNumber integer A unique identifier of the project.
recipient object The actual recipient of the invoice. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
recipient.address string The street address of the actual recipient.
recipient.attention object The person to whom this order is addressed.
recipient.attention.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
recipient.city string The city of the actual recipient.
recipient.country string The country of the actual recipient.
recipient.county string The county of the actual recipient.
recipient.ean string The 'International Article Number’ of the actual recipient.
recipient.name string The name of the actual recipient.
recipient.publicEntryNumber string The public entry number of the actual recipient.
recipient.vatZone object Recipient vat zone.
recipient.zip string The zip code of the actual recipient.
references object Customer and company references related to this invoice.
references.customerContact object The customer contact is a reference to the employee at the customer to contact regarding the invoice.
references.customerContact.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
references.other string A text field that can be used to save any custom reference on the invoice.
references.salesPerson object The sales person is a reference to the employee who sold the goods on the invoice. This is also the person who is credited with this sale in reports.
references.vendorReference object A reference to the vender.
remainder number The total remainder, if any, on the invoice.
remainderInBaseCurrency number The total remainder, if any, on the invoice in base currency.
roundingAmount number The total rounding error, if any, on the invoice in base currency.
tenderContract object The tender contract used for the sales document.
tenderContract.cig string Public administration tender reference number.
tenderContract.cup string Public administration project reference.
tenderContract.customerNumber integer Customer’s reference.
tenderContract.description string Custom description.
tenderContract.documentNumber string Document number.
tenderContract.tenderContractNumber integer Unique identifier of the contract.
tenderContract.type object Contract, Convention
vatAccount object The vat code that overrides vat for all lines
vatAccount.vatCode string The vat code of the vat account.
vatAmount number The total amount of VAT on the invoice in the currency. This will have the same sign as net amount.
voucher object The voucher related to the invoice
voucher.booked boolean
voucher.date string full-date
voucher.externalDocumentId string
voucher.voucherId integer
voucher.voucherNumber object
voucher.voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote

Get all overdue Invoices

GET /v2/invoices/overdue

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Read-only Values Description
additionalExpenseLines object A list of additional expenses
additionalExpenseLines.account object Account
additionalExpenseLines.amount number Additional expense amount
additionalExpenseLines.lineNumber integer Line number
additionalExpenseLines.name string Additional expense name
additionalExpenseLines.vatAccount object VAT account (if different from additional expense)
additionalExpenseLines.vatAmount number VAT amount
bankAccount object The bank account used for the invoice
bankAccount.accountNumber integer The number of the account
bankAccount.name string True The name of the account.
bookedInvoiceNumber integer A reference number for the invoice.
currency string The ISO 4217 currency code of the invoice.
customer object The customer on the invoice.
customer.customerNumber integer The unique identifier of the customer.
customer.name string The customer name.
date string full-date Invoice issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the invoice. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
delivery.address string Street address where the goods must be delivered to the customer.
delivery.city string The city of the place of delivery.
delivery.country string The country of the place of delivery.
delivery.county string The county of the place of delivery.
delivery.deliveryDate string full-date The date of delivery.
delivery.deliveryTerms string Details about the terms of delivery.
delivery.zip string The zip code of the place of delivery.
deliveryLocation object A reference to the place of delivery for the goods on the invoice.
deliveryLocation.address string The address of the delivery location.
deliveryLocation.barred boolean Whether the delivery location is barred.
deliveryLocation.city string The city of the delivery location.
deliveryLocation.country string The country of the delivery location.
deliveryLocation.county string The county of the delivery location.
deliveryLocation.deliveryLocationNumber integer A unique identifier for the delivery location.
deliveryLocation.electronicInvoicingOfficeCode string The office code used for electronic invoicing.
deliveryLocation.externalId string The external id.
deliveryLocation.postalCode string The zip code of the delivery location.
deliveryLocation.terms string The terms applying to the delivery location.
displayInvoiceNumber string The human readable invoice number.
dueDate string full-date The date the invoice is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type 'duedate’.
electronicInvoiceFiles object A link to manage this invoice electronically
electronicInvoiceFiles.downloadLink object
electronicInvoiceFiles.excludeDueDatePayments boolean
electronicInvoiceFiles.fileCreationDate string full-date
electronicInvoiceFiles.fileName string
electronicInvoiceFiles.invoice object
electronicInvoiceFiles.number integer
electronicInvoiceFiles.status object None, GeneratingFile, FileGenerated, FailedToGenerateFile
grossAmount number The total invoice amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
layout object The layout used for the document.
layout.deleted boolean A boolean indicating the deletion status of the layout.
layout.isDefault boolean True if the layout is the default selected by the user. This property is read only.
layout.layoutNumber integer The unique identifier of the layout.
layout.name string The descriptive name of the layout.
lines object An array containing the specific invoice lines.
lines.deliveryDate string full-date The delivery date.
lines.departmentalDistribution object The departmental distribution used by the line.
lines.departmentalDistribution.distributionType object Distribution, Department
lines.description string The description of the line.
lines.discountPercentage number The discount percentage.
lines.lineNumber integer The line number.
lines.product object The product.
lines.quantity number The quantity.
lines.sortKey integer The sort key.
lines.totalNetAmount number The total net amount.
lines.unit object The unit.
lines.unitCostPrice number The unit cost price.
lines.unitNetPrice number The unit net price.
lines.vatAccount object The vat account of the invoice line.
lines.vatAmount number The total vat amount of the invoice line.
lines.vatRate number The vat rate of the invoice line.
netAmount number The total invoice amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total invoice amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the invoice.
notes.heading string The invoice heading. Usually displayed at the top of the invoice.
notes.textLine1 string The first line of supplementary text on the invoice. This is usually displayed right under the heading in a smaller font.
notes.textLine2 string The second line of supplementary text in the notes on the invoice. This is usually displayed as a footer on the invoice.
number integer Workflow number - assigned at first step, which could be order or draft
paymentTerms object The terms of payment for the invoice.
paymentTerms.barred boolean If this payment term is accessible.
paymentTerms.cashDiscountAccount object The cash discount account.
paymentTerms.cashDiscountDayLimit integer The cash discount day limit.
paymentTerms.cashDiscountRate number The cash discount rate.
paymentTerms.contraAccountForPrepaidAmount object The contra account. Used for PaidInCash and Factoring only.
paymentTerms.contraAccountForRemainderAmount object The contra account for the remainder amount. Used for Factoring only.
paymentTerms.creditCardCompany object The credit card company. Used for type CreditCard only.
paymentTerms.creditCardCompany.italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
paymentTerms.daysOfCredit integer The number of days of credit on the order. This field is only valid if terms of payment is not of type 'duedate’.
paymentTerms.description string The description of the payment term.
paymentTerms.name string The name of the payment terms.
paymentTerms.numberSeriesForCustomerPayment object The number series to use for creating customer payment vouchers. Used for paidInCash or creditcard type only.
paymentTerms.numberSeriesForCustomerPayment.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
paymentTerms.paymentTermsNumber integer A unique identifier of the payment term.
paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.percentageForPrepaidAmount number The percentage for prepaid amount. Used for Factoring only.
paymentTerms.percentageForRemainderAmount number The percentage for the remainder amount. Used for Factoring only.
paymentTerms.timetablePaymentTemplate object The timetable payment template. Used for Timetable only.
paymentTerms.timetablePaymentTemplate.lines object An array containing the timetable pament template lines.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms object The payment term for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.timetablePaymentTemplate.lines.percentage number The percentage to use for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.timetablePaymentTemplateLineNumber integer A unique identifier of the timetable payment template line.
paymentTerms.type string The type the payment term.
paymentType object A type description how the payment should be executed
paymentType.fields object List of the payment type’s fields.
paymentType.fields.dataType object String, Integer Data type of the payment type field.
paymentType.name string Payment type’s name.
paymentType.paymentTypeNumber integer Unique identifier of the payment type.
pdf object References a pdf representation of this invoice.
pdf.download object The unique reference of the pdf representation for this invoice.
project object References the project this invoice belongs to.
project.projectNumber integer A unique identifier of the project.
recipient object The actual recipient of the invoice. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
recipient.address string The street address of the actual recipient.
recipient.attention object The person to whom this order is addressed.
recipient.attention.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
recipient.city string The city of the actual recipient.
recipient.country string The country of the actual recipient.
recipient.county string The county of the actual recipient.
recipient.ean string The 'International Article Number’ of the actual recipient.
recipient.name string The name of the actual recipient.
recipient.publicEntryNumber string The public entry number of the actual recipient.
recipient.vatZone object Recipient vat zone.
recipient.zip string The zip code of the actual recipient.
references object Customer and company references related to this invoice.
references.customerContact object The customer contact is a reference to the employee at the customer to contact regarding the invoice.
references.customerContact.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
references.other string A text field that can be used to save any custom reference on the invoice.
references.salesPerson object The sales person is a reference to the employee who sold the goods on the invoice. This is also the person who is credited with this sale in reports.
references.vendorReference object A reference to the vender.
remainder number The total remainder, if any, on the invoice.
remainderInBaseCurrency number The total remainder, if any, on the invoice in base currency.
roundingAmount number The total rounding error, if any, on the invoice in base currency.
tenderContract object The tender contract used for the sales document.
tenderContract.cig string Public administration tender reference number.
tenderContract.cup string Public administration project reference.
tenderContract.customerNumber integer Customer’s reference.
tenderContract.description string Custom description.
tenderContract.documentNumber string Document number.
tenderContract.tenderContractNumber integer Unique identifier of the contract.
tenderContract.type object Contract, Convention
vatAccount object The vat code that overrides vat for all lines
vatAccount.vatCode string The vat code of the vat account.
vatAmount number The total amount of VAT on the invoice in the currency. This will have the same sign as net amount.
voucher object The voucher related to the invoice
voucher.booked boolean
voucher.date string full-date
voucher.externalDocumentId string
voucher.voucherId integer
voucher.voucherNumber object
voucher.voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote

Get all Invoices that are not yet due.

GET /v2/invoices/not-due

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Read-only Values Description
additionalExpenseLines object A list of additional expenses
additionalExpenseLines.account object Account
additionalExpenseLines.amount number Additional expense amount
additionalExpenseLines.lineNumber integer Line number
additionalExpenseLines.name string Additional expense name
additionalExpenseLines.vatAccount object VAT account (if different from additional expense)
additionalExpenseLines.vatAmount number VAT amount
bankAccount object The bank account used for the invoice
bankAccount.accountNumber integer The number of the account
bankAccount.name string True The name of the account.
bookedInvoiceNumber integer A reference number for the invoice.
currency string The ISO 4217 currency code of the invoice.
customer object The customer on the invoice.
customer.customerNumber integer The unique identifier of the customer.
customer.name string The customer name.
date string full-date Invoice issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the invoice. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
delivery.address string Street address where the goods must be delivered to the customer.
delivery.city string The city of the place of delivery.
delivery.country string The country of the place of delivery.
delivery.county string The county of the place of delivery.
delivery.deliveryDate string full-date The date of delivery.
delivery.deliveryTerms string Details about the terms of delivery.
delivery.zip string The zip code of the place of delivery.
deliveryLocation object A reference to the place of delivery for the goods on the invoice.
deliveryLocation.address string The address of the delivery location.
deliveryLocation.barred boolean Whether the delivery location is barred.
deliveryLocation.city string The city of the delivery location.
deliveryLocation.country string The country of the delivery location.
deliveryLocation.county string The county of the delivery location.
deliveryLocation.deliveryLocationNumber integer A unique identifier for the delivery location.
deliveryLocation.electronicInvoicingOfficeCode string The office code used for electronic invoicing.
deliveryLocation.externalId string The external id.
deliveryLocation.postalCode string The zip code of the delivery location.
deliveryLocation.terms string The terms applying to the delivery location.
displayInvoiceNumber string The human readable invoice number.
dueDate string full-date The date the invoice is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type 'duedate’.
electronicInvoiceFiles object A link to manage this invoice electronically
electronicInvoiceFiles.downloadLink object
electronicInvoiceFiles.excludeDueDatePayments boolean
electronicInvoiceFiles.fileCreationDate string full-date
electronicInvoiceFiles.fileName string
electronicInvoiceFiles.invoice object
electronicInvoiceFiles.number integer
electronicInvoiceFiles.status object None, GeneratingFile, FileGenerated, FailedToGenerateFile
grossAmount number The total invoice amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
layout object The layout used for the document.
layout.deleted boolean A boolean indicating the deletion status of the layout.
layout.isDefault boolean True if the layout is the default selected by the user. This property is read only.
layout.layoutNumber integer The unique identifier of the layout.
layout.name string The descriptive name of the layout.
lines object An array containing the specific invoice lines.
lines.deliveryDate string full-date The delivery date.
lines.departmentalDistribution object The departmental distribution used by the line.
lines.departmentalDistribution.distributionType object Distribution, Department
lines.description string The description of the line.
lines.discountPercentage number The discount percentage.
lines.lineNumber integer The line number.
lines.product object The product.
lines.quantity number The quantity.
lines.sortKey integer The sort key.
lines.totalNetAmount number The total net amount.
lines.unit object The unit.
lines.unitCostPrice number The unit cost price.
lines.unitNetPrice number The unit net price.
lines.vatAccount object The vat account of the invoice line.
lines.vatAmount number The total vat amount of the invoice line.
lines.vatRate number The vat rate of the invoice line.
netAmount number The total invoice amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total invoice amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the invoice.
notes.heading string The invoice heading. Usually displayed at the top of the invoice.
notes.textLine1 string The first line of supplementary text on the invoice. This is usually displayed right under the heading in a smaller font.
notes.textLine2 string The second line of supplementary text in the notes on the invoice. This is usually displayed as a footer on the invoice.
number integer Workflow number - assigned at first step, which could be order or draft
paymentTerms object The terms of payment for the invoice.
paymentTerms.barred boolean If this payment term is accessible.
paymentTerms.cashDiscountAccount object The cash discount account.
paymentTerms.cashDiscountDayLimit integer The cash discount day limit.
paymentTerms.cashDiscountRate number The cash discount rate.
paymentTerms.contraAccountForPrepaidAmount object The contra account. Used for PaidInCash and Factoring only.
paymentTerms.contraAccountForRemainderAmount object The contra account for the remainder amount. Used for Factoring only.
paymentTerms.creditCardCompany object The credit card company. Used for type CreditCard only.
paymentTerms.creditCardCompany.italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
paymentTerms.daysOfCredit integer The number of days of credit on the order. This field is only valid if terms of payment is not of type 'duedate’.
paymentTerms.description string The description of the payment term.
paymentTerms.name string The name of the payment terms.
paymentTerms.numberSeriesForCustomerPayment object The number series to use for creating customer payment vouchers. Used for paidInCash or creditcard type only.
paymentTerms.numberSeriesForCustomerPayment.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
paymentTerms.paymentTermsNumber integer A unique identifier of the payment term.
paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.percentageForPrepaidAmount number The percentage for prepaid amount. Used for Factoring only.
paymentTerms.percentageForRemainderAmount number The percentage for the remainder amount. Used for Factoring only.
paymentTerms.timetablePaymentTemplate object The timetable payment template. Used for Timetable only.
paymentTerms.timetablePaymentTemplate.lines object An array containing the timetable pament template lines.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms object The payment term for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.timetablePaymentTemplate.lines.percentage number The percentage to use for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.timetablePaymentTemplateLineNumber integer A unique identifier of the timetable payment template line.
paymentTerms.type string The type the payment term.
paymentType object A type description how the payment should be executed
paymentType.fields object List of the payment type’s fields.
paymentType.fields.dataType object String, Integer Data type of the payment type field.
paymentType.name string Payment type’s name.
paymentType.paymentTypeNumber integer Unique identifier of the payment type.
pdf object References a pdf representation of this invoice.
pdf.download object The unique reference of the pdf representation for this invoice.
project object References the project this invoice belongs to.
project.projectNumber integer A unique identifier of the project.
recipient object The actual recipient of the invoice. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
recipient.address string The street address of the actual recipient.
recipient.attention object The person to whom this order is addressed.
recipient.attention.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
recipient.city string The city of the actual recipient.
recipient.country string The country of the actual recipient.
recipient.county string The county of the actual recipient.
recipient.ean string The 'International Article Number’ of the actual recipient.
recipient.name string The name of the actual recipient.
recipient.publicEntryNumber string The public entry number of the actual recipient.
recipient.vatZone object Recipient vat zone.
recipient.zip string The zip code of the actual recipient.
references object Customer and company references related to this invoice.
references.customerContact object The customer contact is a reference to the employee at the customer to contact regarding the invoice.
references.customerContact.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
references.other string A text field that can be used to save any custom reference on the invoice.
references.salesPerson object The sales person is a reference to the employee who sold the goods on the invoice. This is also the person who is credited with this sale in reports.
references.vendorReference object A reference to the vender.
remainder number The total remainder, if any, on the invoice.
remainderInBaseCurrency number The total remainder, if any, on the invoice in base currency.
roundingAmount number The total rounding error, if any, on the invoice in base currency.
tenderContract object The tender contract used for the sales document.
tenderContract.cig string Public administration tender reference number.
tenderContract.cup string Public administration project reference.
tenderContract.customerNumber integer Customer’s reference.
tenderContract.description string Custom description.
tenderContract.documentNumber string Document number.
tenderContract.tenderContractNumber integer Unique identifier of the contract.
tenderContract.type object Contract, Convention
vatAccount object The vat code that overrides vat for all lines
vatAccount.vatCode string The vat code of the vat account.
vatAmount number The total amount of VAT on the invoice in the currency. This will have the same sign as net amount.
voucher object The voucher related to the invoice
voucher.booked boolean
voucher.date string full-date
voucher.externalDocumentId string
voucher.voucherId integer
voucher.voucherNumber object
voucher.voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote

Layouts

Layouts are a collection of templates defining the appearance of certain documents (invoice, credit note, etc..).

For more information please look at the Design and layout online Help.

Get Layouts

GET /layouts

View response example

Schema name

layouts.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Max length Description
deleted boolean A flag indicating that the layout is deleted. Layouts with this flag set will not appear in the collection of layouts, but resources such as booked invoices might still reference this layout.
layoutNumber integer A unique identifier of the layout.
name string 250 The name of the layout.
self string uri A unique link reference to the layout item.

Get specific Layout

GET /layouts/:layoutNumber

Schema name

layouts.layoutNumber.get.schema.json

Return type

This method returns a single object

Properties

Name Type Format Max length Description
deleted boolean A flag indicating that the layout is deleted. Layouts with this flag set will not appear in the collection of layouts, but resources such as booked invoices might still reference this layout.
layoutNumber integer A unique identifier of the layout.
name string 250 The name of the layout.
self string uri A unique link reference to the layout item.

Modules

Lists available add-on modules for the current agreement.

Tip: Use GET /self to see which modules are enabled for the current agreement.

Read more about Reviso Add-on modules in our online help.

Get Modules

GET /modules

View response example

Get Modules for current agreement

GET /modules/agreement

View response example

Get specific Module

GET /modules/agreement/:moduleId

Number Series

Get Number Series

GET /number-series

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Values Description
allowGaps boolean A boolean value, indicating if gaps are allowed between the entry numbers.
entrySubtype object The entry sub type of the number series.
entrySubtype.entrySubtypeNumber integer Unique numerical identifier of the resource.
entrySubtype.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote Type of the entry.
entrySubtype.hideInUi boolean
entrySubtype.isAcrossAccountingYears boolean
entrySubtype.name string Name of the entry subtype.
entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
isOrdered boolean A boolean value, indicating if the number series is an ordered number series. If left out, it means that the number series is not ordered
name string The name of the number series.
numberSeriesNumber integer The number of the number series
peeks object An array of peek values for the number series.
peeks.accountingYear object The accounting year.
peeks.nextVoucherNumber integer The expected next voucher number.
prefix string The prefix for the number series.
systemGenerated boolean A boolean value, indicating if the number series is generated by the system.

Get specific Number Series

GET /number-series/:numberSeriesId

Return type

This method returns a single object

Properties

Name Type Values Description
allowGaps boolean A boolean value, indicating if gaps are allowed between the entry numbers.
entrySubtype object The entry sub type of the number series.
entrySubtype.entrySubtypeNumber integer Unique numerical identifier of the resource.
entrySubtype.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote Type of the entry.
entrySubtype.hideInUi boolean
entrySubtype.isAcrossAccountingYears boolean
entrySubtype.name string Name of the entry subtype.
entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
isOrdered boolean A boolean value, indicating if the number series is an ordered number series. If left out, it means that the number series is not ordered
name string The name of the number series.
numberSeriesNumber integer The number of the number series
peeks object An array of peek values for the number series.
peeks.accountingYear object The accounting year.
peeks.nextVoucherNumber integer The expected next voucher number.
prefix string The prefix for the number series.
systemGenerated boolean A boolean value, indicating if the number series is generated by the system.

Create Number Series

POST /number-series

Return type

This method returns a single object

Properties

Name Type Values Description
allowGaps boolean A boolean value, indicating if gaps are allowed between the entry numbers.
entrySubtype object The entry sub type of the number series.
entrySubtype.entrySubtypeNumber integer Unique numerical identifier of the resource.
entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
isOrdered boolean A boolean value, indicating if the number series is an ordered number series. If left out, it means that the number series is not ordered
name string The name of the number series.
numberSeriesNumber integer The number of the number series
peeks object An array of peek values for the number series.
prefix string The prefix for the number series.
systemGenerated boolean A boolean value, indicating if the number series is generated by the system.

Update Number Series

PUT /number-series/:numberSeriesId

Return type

This method returns a single object

Properties

Name Type Values Description
allowGaps boolean A boolean value, indicating if gaps are allowed between the entry numbers.
entrySubtype object The entry sub type of the number series.
entrySubtype.entrySubtypeNumber integer Unique numerical identifier of the resource.
entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
isOrdered boolean A boolean value, indicating if the number series is an ordered number series. If left out, it means that the number series is not ordered
name string The name of the number series.
numberSeriesNumber integer The number of the number series
peeks object An array of peek values for the number series.
prefix string The prefix for the number series.
systemGenerated boolean A boolean value, indicating if the number series is generated by the system.

Delete Number Series

DELETE /number-series/:numberSeriesId

Opening Balances

Read the blog post for more info and examples.

Get all Opening Balances

GET /opening-balances

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Description
booked boolean Whether or not the opening balance has been booked.
date string full-date Opening balance date.
lines object List of opening balance’s lines.
lines.account object Account reference.
lines.amountInBaseCurrency number The line amount specified in the base agreement currency.
lines.customer object Customer reference.
lines.department object Department which the opening balance line belongs to.
lines.documentDate string full-date Date of the external document.
lines.documentNumber string Reference to an external document number (e.g. supplier or customer invoice).
lines.dueDate string full-date Optional due date.
lines.entryNumber integer Numerical identifier for the single line.
lines.supplier object Supplier reference.
lines.text string A short description about the line.
voucherId integer Numerical identifier that is unique for the whole agreement.
voucherNumber object Numerical identifier that is unique within the Number Series and Accounting Year.
voucherNumber.displayVoucherNumber string
voucherNumber.prefix string
voucherNumber.voucherNumber integer

Get all drafts Opening Balances

GET /opening-balances/drafts

Get a specific draft Opening Balance

GET /opening-balances/drafts/:voucherId

Return type

This method returns a single object

Properties

Name Type Format Description
booked boolean Whether or not the opening balance has been booked.
date string full-date Opening balance date.
lines object List of opening balance’s lines.
lines.account object Account reference.
lines.amountInBaseCurrency number The line amount specified in the base agreement currency.
lines.customer object Customer reference.
lines.department object Department which the opening balance line belongs to.
lines.documentDate string full-date Date of the external document.
lines.documentNumber string Reference to an external document number (e.g. supplier or customer invoice).
lines.dueDate string full-date Optional due date.
lines.entryNumber integer Numerical identifier for the single line.
lines.supplier object Supplier reference.
lines.text string A short description about the line.
voucherId integer Numerical identifier that is unique for the whole agreement.
voucherNumber object Numerical identifier that is unique within the Number Series and Accounting Year.
voucherNumber.displayVoucherNumber string
voucherNumber.prefix string
voucherNumber.voucherNumber integer

Get all booked Opening Balances

GET /opening-balances/booked

Get a specific booked Opening Balance

GET /opening-balances/booked/:voucherId

Create a new Opening Balance

POST /opening-balances/drafts

Return type

This method returns a single object

Required properties

date, lines

Properties

Name Type Format Description
booked boolean Whether or not the opening balance has been booked.
date string full-date Opening balance date.
lines object List of opening balance’s lines.
voucherId integer Numerical identifier that is unique for the whole agreement.
voucherNumber object Numerical identifier that is unique within the Number Series and Accounting Year.

Book an existing Opening Balance

POST /opening-balances/booked

Update a draft Opening Balance

PUT /opening-balances/drafts/:voucherId

Return type

This method returns a single object

Required properties

date, lines

Properties

Name Type Format Description
booked boolean Whether or not the opening balance has been booked.
date string full-date Opening balance date.
lines object List of opening balance’s lines.
voucherId integer Numerical identifier that is unique for the whole agreement.
voucherNumber object Numerical identifier that is unique within the Number Series and Accounting Year.

Delete a draft Opening Balance

DELETE /opening-balances/drafts/:voucherId

Orders

Get Orders

GET /orders

View response example

Note: additional expenses are not yet supported on orders

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Read-only Values Description
additionalExpenseLines object A list of additional expense lines
additionalExpenseLines.additionalExpense object The additional expense used on the line
additionalExpenseLines.amount number Additional expense amount
additionalExpenseLines.lineNumber integer Line number
additionalExpenseLines.vatAccount object VAT account (if different from additional expense)
additionalExpenseLines.vatAmount number VAT amount
bankAccount object Bank Account
bankAccount.accountNumber integer The number of the account
bankAccount.name string True The name of the account.
costPriceInBaseCurrency number True The total cost of the items on the sales document in the base currency of the agreement.
currency string The ISO 4217 currency code of the sales document.
customer object The customer on the sales document.
customer.customerNumber integer The unique identifier of the customer.
customer.name string The customer name.
date string full-date Sales document issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the sales document. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
delivery.address string Street address where the goods must be delivered to the customer.
delivery.city string The city of the place of delivery.
delivery.country string The country of the place of delivery.
delivery.county string The county of the place of delivery.
delivery.deliveryDate string full-date The date of delivery.
delivery.deliveryTerms string Details about the terms of delivery.
delivery.zip string The zip code of the place of delivery.
deliveryDetails object Details about the delivery. Used for printing delivery notes etc.
deliveryDetails.carrierInfo object Details about the carrier.
deliveryDetails.deliveryNoteNumber integer Delivery note number.
deliveryDetails.deliveryNoteNumberSeries object Delivery note number series.
deliveryDetails.deliveryNoteNumberSeries.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
deliveryDetails.deliveryStartDateTime string full-date Date and time (in UTC) the delivery started.
deliveryDetails.descriptionOfPackages string Verbal description of the packages.
deliveryDetails.numberOfPackages integer Number of packages in the delivery.
deliveryDetails.reasonForDelivery string The reason for delivery.
deliveryLocation object A reference to the place of delivery for the goods on the sales document.
deliveryLocation.address string The address of the delivery location.
deliveryLocation.barred boolean Whether the delivery location is barred.
deliveryLocation.city string The city of the delivery location.
deliveryLocation.country string The country of the delivery location.
deliveryLocation.county string The county of the delivery location.
deliveryLocation.deliveryLocationNumber integer A unique identifier for the delivery location.
deliveryLocation.electronicInvoicingOfficeCode string The office code used for electronic invoicing.
deliveryLocation.externalId string The external id.
deliveryLocation.postalCode string The zip code of the delivery location.
deliveryLocation.terms string The terms applying to the delivery location.
dueDate string full-date The date the sales document is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type ‘duedate’.
exchangeRate number The exchange rate between the sales document currency and the base currency of the agreement. The exchange rate expresses how much it will cost in base currency to buy 100 units of the order currency.
grossAmount number The total sales document amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
id integer A reference number for the sales document.
isArchived boolean Boolean indication of whether the sales document is archived.
isSent boolean Boolean indication of whether the sales document is sent.
layout object The layout used for the document.
layout.deleted boolean A boolean indicating the deletion status of the layout.
layout.isDefault boolean True if the layout is the default selected by the user. This property is read only.
layout.layoutNumber integer The unique identifier of the layout.
layout.name string The descriptive name of the layout.
lines object An array containing the specific sales document lines.
lines.accruals object The start and end date of accruals
lines.deliveredQuantity number The delivered quantity.
lines.deliveryDate string full-date The delivery date.
lines.departmentalDistribution object The departmental distribution used by the line.
lines.departmentalDistribution.distributionType object Distribution, Department
lines.description string The description of the line.
lines.discountPercentage number The discount percentage.
lines.lineNumber integer The line number.
lines.manuallyEditedSalesPrice boolean Indicated if sales price on line was manually edited
lines.marginInBaseCurrency number The margin in the base currency of the agreement.
lines.marginPercentage number The margin percentage.
lines.product object The product.
lines.quantity number The quantity.
lines.sortKey integer The sort key.
lines.totalNetAmount number The total net amount.
lines.unit object The unit.
lines.unitCostPrice number The unit cost price.
lines.unitNetPrice number The unit net price.
locks object Locks that does not allow document to be modified
locks.description string Description of lock
locks.lockType integer Type number of the lock
locks.salesDocumentDraftNumber integer Sales Document number which is locked by this lock
marginInBaseCurrency number The difference between the net price and the cost price on the sales document line in base currency.
marginPercentage number The margin on the sales document line expressed as a percentage.
netAmount number The total sales document amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total sales document amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the sales document.
notes.heading string The order heading. Usually displayed at the top of the order.
notes.text1 string The first line of supplementary text on the order. This is usually displayed right under the heading in a smaller font.
notes.text2 string The second line of supplementary text in the notes on the order. This is usually displayed as a footer on the order.
number integer The number of the workflow - quotation - order - draft invoice
numberSeries object The number series used for the sales document.
numberSeries.allowGaps boolean A boolean value, indicating if gaps are allowed between the entry numbers.
numberSeries.entrySubtype object The entry sub type of the number series.
numberSeries.entrySubtype.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote Type of the entry.
numberSeries.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
numberSeries.isOrdered boolean A boolean value, indicating if the number series is an ordered number series. If left out, it means that the number series is not ordered
numberSeries.name string The name of the number series.
numberSeries.numberSeriesNumber integer The number of the number series
numberSeries.peeks object An array of peek values for the number series.
numberSeries.prefix string The prefix for the number series.
numberSeries.systemGenerated boolean A boolean value, indicating if the number series is generated by the system.
paymentLines object An array containing the payment lines splitting the payment into multiple due dates. These can only be used if you have the feature.
paymentLines.amount number
paymentLines.dueDate string full-date
paymentLines.lineNumber integer
paymentTerms object The terms of payment for the sales document.
paymentTerms.paymentTermsNumber integer A unique identifier of the payment term.
paymentType object A type description how the payment should be executed
paymentType.fields object List of the payment type’s fields.
paymentType.fields.dataType object String, Integer Data type of the payment type field.
paymentType.name string Payment type’s name.
paymentType.paymentTypeNumber integer Unique identifier of the payment type.
pdf object References a pdf representation of this sales document.
pdf.download object The unique reference of the pdf representation for this order.
priceList object A price list that is used for product prices
priceList.name string Price list’s name.
priceList.number integer Unique identifier of the price list.
project object References the project this sales document belongs to.
project.projectNumber integer A unique identifier of the project.
recipient object The actual recipient of the sales document. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
recipient.address string The street address of the actual recipient.
recipient.attention object The person to whom this order is addressed.
recipient.attention.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
recipient.city string The city of the actual recipient.
recipient.country string The country of the actual recipient.
recipient.county string The county of the actual recipient.
recipient.ean string The 'International Article Number’ of the actual recipient.
recipient.name string The name of the actual recipient.
recipient.publicEntryNumber string The public entry number of the actual recipient.
recipient.vatZone object Recipient vat zone.
recipient.zip string The zip code of the actual recipient.
references object Customer and company references related to this sales document.
references.customerContact object The customer contact is a reference to the employee at the customer to contact regarding the order.
references.customerContact.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
references.other string A text field that can be used to save any custom reference on the order.
references.primarySalesPerson object The sales person is a reference to the employee who sold the goods on the order. This is also the person who is credited with this sale in reports.
references.secondarySalesPerson object A reference to any second employee involved in the sale.
roundingAmount number The total rounding error, if any, on the sales document in base currency.
tenderContract object The tender contract used for the sales document.
tenderContract.cig string Public administration tender reference number.
tenderContract.cup string Public administration project reference.
tenderContract.customerNumber integer Customer’s reference.
tenderContract.description string Custom description.
tenderContract.documentNumber string Document number.
tenderContract.tenderContractNumber integer Unique identifier of the contract.
tenderContract.type object Contract, Convention
vatAccount object References the VAT account overriding VAT on all lines.
vatAccount.vatCode string The vat code of the vat account.
vatAmount number The total amount of VAT on the sales document in the currency. This will have the same sign as net amount.
vatIncluded boolean If VatMatrix is not enabled this flag will tell that vat should be calculated for this invoice. If VatMatrix is enabled this flag is readonly.
voucher object The voucher related to the invoice
voucher.booked boolean
voucher.date string full-date
voucher.externalDocumentId string
voucher.voucherId integer
voucher.voucherNumber object
voucher.voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote

Get specific Order

GET /orders/:orderNumber

Return type

This method returns a single object

Properties

Name Type Format Read-only Values Description
additionalExpenseLines object A list of additional expense lines
additionalExpenseLines.additionalExpense object The additional expense used on the line
additionalExpenseLines.amount number Additional expense amount
additionalExpenseLines.lineNumber integer Line number
additionalExpenseLines.vatAccount object VAT account (if different from additional expense)
additionalExpenseLines.vatAmount number VAT amount
bankAccount object Bank Account
bankAccount.accountNumber integer The number of the account
bankAccount.name string True The name of the account.
costPriceInBaseCurrency number True The total cost of the items on the sales document in the base currency of the agreement.
currency string The ISO 4217 currency code of the sales document.
customer object The customer on the sales document.
customer.customerNumber integer The unique identifier of the customer.
customer.name string The customer name.
date string full-date Sales document issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the sales document. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
delivery.address string Street address where the goods must be delivered to the customer.
delivery.city string The city of the place of delivery.
delivery.country string The country of the place of delivery.
delivery.county string The county of the place of delivery.
delivery.deliveryDate string full-date The date of delivery.
delivery.deliveryTerms string Details about the terms of delivery.
delivery.zip string The zip code of the place of delivery.
deliveryDetails object Details about the delivery. Used for printing delivery notes etc.
deliveryDetails.carrierInfo object Details about the carrier.
deliveryDetails.deliveryNoteNumber integer Delivery note number.
deliveryDetails.deliveryNoteNumberSeries object Delivery note number series.
deliveryDetails.deliveryNoteNumberSeries.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
deliveryDetails.deliveryStartDateTime string full-date Date and time (in UTC) the delivery started.
deliveryDetails.descriptionOfPackages string Verbal description of the packages.
deliveryDetails.numberOfPackages integer Number of packages in the delivery.
deliveryDetails.reasonForDelivery string The reason for delivery.
deliveryLocation object A reference to the place of delivery for the goods on the sales document.
deliveryLocation.address string The address of the delivery location.
deliveryLocation.barred boolean Whether the delivery location is barred.
deliveryLocation.city string The city of the delivery location.
deliveryLocation.country string The country of the delivery location.
deliveryLocation.county string The county of the delivery location.
deliveryLocation.deliveryLocationNumber integer A unique identifier for the delivery location.
deliveryLocation.electronicInvoicingOfficeCode string The office code used for electronic invoicing.
deliveryLocation.externalId string The external id.
deliveryLocation.postalCode string The zip code of the delivery location.
deliveryLocation.terms string The terms applying to the delivery location.
dueDate string full-date The date the sales document is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type 'duedate’.
exchangeRate number The exchange rate between the sales document currency and the base currency of the agreement. The exchange rate expresses how much it will cost in base currency to buy 100 units of the order currency.
grossAmount number The total sales document amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
id integer A reference number for the sales document.
isArchived boolean Boolean indication of whether the sales document is archived.
isSent boolean Boolean indication of whether the sales document is sent.
layout object The layout used for the document.
layout.deleted boolean A boolean indicating the deletion status of the layout.
layout.isDefault boolean True if the layout is the default selected by the user. This property is read only.
layout.layoutNumber integer The unique identifier of the layout.
layout.name string The descriptive name of the layout.
lines object An array containing the specific sales document lines.
lines.accruals object The start and end date of accruals
lines.deliveredQuantity number The delivered quantity.
lines.deliveryDate string full-date The delivery date.
lines.departmentalDistribution object The departmental distribution used by the line.
lines.departmentalDistribution.distributionType object Distribution, Department
lines.description string The description of the line.
lines.discountPercentage number The discount percentage.
lines.lineNumber integer The line number.
lines.manuallyEditedSalesPrice boolean Indicated if sales price on line was manually edited
lines.marginInBaseCurrency number The margin in the base currency of the agreement.
lines.marginPercentage number The margin percentage.
lines.product object The product.
lines.quantity number The quantity.
lines.sortKey integer The sort key.
lines.totalNetAmount number The total net amount.
lines.unit object The unit.
lines.unitCostPrice number The unit cost price.
lines.unitNetPrice number The unit net price.
locks object Locks that does not allow document to be modified
locks.description string Description of lock
locks.lockType integer Type number of the lock
locks.salesDocumentDraftNumber integer Sales Document number which is locked by this lock
marginInBaseCurrency number The difference between the net price and the cost price on the sales document line in base currency.
marginPercentage number The margin on the sales document line expressed as a percentage.
netAmount number The total sales document amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total sales document amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the sales document.
notes.heading string The order heading. Usually displayed at the top of the order.
notes.text1 string The first line of supplementary text on the order. This is usually displayed right under the heading in a smaller font.
notes.text2 string The second line of supplementary text in the notes on the order. This is usually displayed as a footer on the order.
number integer The number of the workflow - quotation - order - draft invoice
numberSeries object The number series used for the sales document.
numberSeries.allowGaps boolean A boolean value, indicating if gaps are allowed between the entry numbers.
numberSeries.entrySubtype object The entry sub type of the number series.
numberSeries.entrySubtype.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote Type of the entry.
numberSeries.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
numberSeries.isOrdered boolean A boolean value, indicating if the number series is an ordered number series. If left out, it means that the number series is not ordered
numberSeries.name string The name of the number series.
numberSeries.numberSeriesNumber integer The number of the number series
numberSeries.peeks object An array of peek values for the number series.
numberSeries.prefix string The prefix for the number series.
numberSeries.systemGenerated boolean A boolean value, indicating if the number series is generated by the system.
paymentLines object An array containing the payment lines splitting the payment into multiple due dates. These can only be used if you have the feature.
paymentLines.amount number
paymentLines.dueDate string full-date
paymentLines.lineNumber integer
paymentTerms object The terms of payment for the sales document.
paymentTerms.paymentTermsNumber integer A unique identifier of the payment term.
paymentType object A type description how the payment should be executed
paymentType.fields object List of the payment type’s fields.
paymentType.fields.dataType object String, Integer Data type of the payment type field.
paymentType.name string Payment type’s name.
paymentType.paymentTypeNumber integer Unique identifier of the payment type.
pdf object References a pdf representation of this sales document.
pdf.download object The unique reference of the pdf representation for this order.
priceList object A price list that is used for product prices
priceList.name string Price list’s name.
priceList.number integer Unique identifier of the price list.
project object References the project this sales document belongs to.
project.projectNumber integer A unique identifier of the project.
recipient object The actual recipient of the sales document. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
recipient.address string The street address of the actual recipient.
recipient.attention object The person to whom this order is addressed.
recipient.attention.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
recipient.city string The city of the actual recipient.
recipient.country string The country of the actual recipient.
recipient.county string The county of the actual recipient.
recipient.ean string The 'International Article Number’ of the actual recipient.
recipient.name string The name of the actual recipient.
recipient.publicEntryNumber string The public entry number of the actual recipient.
recipient.vatZone object Recipient vat zone.
recipient.zip string The zip code of the actual recipient.
references object Customer and company references related to this sales document.
references.customerContact object The customer contact is a reference to the employee at the customer to contact regarding the order.
references.customerContact.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
references.other string A text field that can be used to save any custom reference on the order.
references.primarySalesPerson object The sales person is a reference to the employee who sold the goods on the order. This is also the person who is credited with this sale in reports.
references.secondarySalesPerson object A reference to any second employee involved in the sale.
roundingAmount number The total rounding error, if any, on the sales document in base currency.
tenderContract object The tender contract used for the sales document.
tenderContract.cig string Public administration tender reference number.
tenderContract.cup string Public administration project reference.
tenderContract.customerNumber integer Customer’s reference.
tenderContract.description string Custom description.
tenderContract.documentNumber string Document number.
tenderContract.tenderContractNumber integer Unique identifier of the contract.
tenderContract.type object Contract, Convention
vatAccount object References the VAT account overriding VAT on all lines.
vatAccount.vatCode string The vat code of the vat account.
vatAmount number The total amount of VAT on the sales document in the currency. This will have the same sign as net amount.
vatIncluded boolean If VatMatrix is not enabled this flag will tell that vat should be calculated for this invoice. If VatMatrix is enabled this flag is readonly.
voucher object The voucher related to the invoice
voucher.booked boolean
voucher.date string full-date
voucher.externalDocumentId string
voucher.voucherId integer
voucher.voucherNumber object
voucher.voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote

Create Order

POST /orders

Return type

This method returns a single object

Properties

Name Type Format Description
additionalExpenseLines object A list of additional expense lines
bankAccount object Bank Account
currency string The ISO 4217 currency code of the sales document.
customer object The customer on the sales document.
customer.customerNumber integer The unique identifier of the customer.
date string full-date Sales document issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the sales document. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
deliveryDetails object Details about the delivery. Used for printing delivery notes etc.
deliveryLocation object A reference to the place of delivery for the goods on the sales document.
dueDate string full-date The date the sales document is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type 'duedate’.
exchangeRate number The exchange rate between the sales document currency and the base currency of the agreement. The exchange rate expresses how much it will cost in base currency to buy 100 units of the order currency.
grossAmount number The total sales document amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
id integer A reference number for the sales document.
isArchived boolean Boolean indication of whether the sales document is archived.
isSent boolean Boolean indication of whether the sales document is sent.
layout object The layout used for the document.
lines object An array containing the specific sales document lines.
locks object Locks that does not allow document to be modified
marginInBaseCurrency number The difference between the net price and the cost price on the sales document line in base currency.
marginPercentage number The margin on the sales document line expressed as a percentage.
netAmount number The total sales document amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total sales document amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the sales document.
number integer The number of the workflow - quotation - order - draft invoice
numberSeries object The number series used for the sales document.
paymentLines object An array containing the payment lines splitting the payment into multiple due dates. These can only be used if you have the feature.
paymentTerms object The terms of payment for the sales document.
paymentType object A type description how the payment should be executed
pdf object References a pdf representation of this sales document.
priceList object A price list that is used for product prices
project object References the project this sales document belongs to.
recipient object The actual recipient of the sales document. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
references object Customer and company references related to this sales document.
roundingAmount number The total rounding error, if any, on the sales document in base currency.
tenderContract object The tender contract used for the sales document.
vatAccount object References the VAT account overriding VAT on all lines.
vatAmount number The total amount of VAT on the sales document in the currency. This will have the same sign as net amount.
vatIncluded boolean If VatMatrix is not enabled this flag will tell that vat should be calculated for this invoice. If VatMatrix is enabled this flag is readonly.
voucher object The voucher related to the invoice

Update Order

PUT /orders/:orderNumber

Return type

This method returns a single object

Properties

Name Type Format Description
additionalExpenseLines object A list of additional expense lines
bankAccount object Bank Account
currency string The ISO 4217 currency code of the sales document.
customer object The customer on the sales document.
customer.customerNumber integer The unique identifier of the customer.
date string full-date Sales document issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the sales document. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
deliveryDetails object Details about the delivery. Used for printing delivery notes etc.
deliveryLocation object A reference to the place of delivery for the goods on the sales document.
dueDate string full-date The date the sales document is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type 'duedate’.
exchangeRate number The exchange rate between the sales document currency and the base currency of the agreement. The exchange rate expresses how much it will cost in base currency to buy 100 units of the order currency.
grossAmount number The total sales document amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
id integer A reference number for the sales document.
isArchived boolean Boolean indication of whether the sales document is archived.
isSent boolean Boolean indication of whether the sales document is sent.
layout object The layout used for the document.
lines object An array containing the specific sales document lines.
locks object Locks that does not allow document to be modified
marginInBaseCurrency number The difference between the net price and the cost price on the sales document line in base currency.
marginPercentage number The margin on the sales document line expressed as a percentage.
netAmount number The total sales document amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total sales document amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the sales document.
number integer The number of the workflow - quotation - order - draft invoice
numberSeries object The number series used for the sales document.
paymentLines object An array containing the payment lines splitting the payment into multiple due dates. These can only be used if you have the feature.
paymentTerms object The terms of payment for the sales document.
paymentType object A type description how the payment should be executed
pdf object References a pdf representation of this sales document.
priceList object A price list that is used for product prices
project object References the project this sales document belongs to.
recipient object The actual recipient of the sales document. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
references object Customer and company references related to this sales document.
roundingAmount number The total rounding error, if any, on the sales document in base currency.
tenderContract object The tender contract used for the sales document.
vatAccount object References the VAT account overriding VAT on all lines.
vatAmount number The total amount of VAT on the sales document in the currency. This will have the same sign as net amount.
vatIncluded boolean If VatMatrix is not enabled this flag will tell that vat should be calculated for this invoice. If VatMatrix is enabled this flag is readonly.
voucher object The voucher related to the invoice

Delete Order

DELETE /orders

Return type

This method returns a single object

Properties

Name Type Description
id integer A reference number for the sales document.

Attach PDF to Order

POST /orders/:orderNumber/attachment

Notes
Example request
curl --request POST \
  --url https://rest.reviso.com/orders/15/attachment \
  --header 'X-AgreementGrantToken: your_agreement_grant_token' \
  --header 'X-AppSecretToken: your_app_secret_token' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form '=@C:\path\to\your\file\file_name.pdf'

Delete PDF attachment

DELETE /orders/:orderNumber/attachment

Payment Bank Accounts

Payment Bank Accounts

GET /payment-management/bank-accounts

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Read-only Values Description
account object The account linked to the bank.
account.accountNumber integer The number of the account
account.name string True The name of the account.
bank object The payment bank.
bank.edition object None, Denmark, Norway, Sweden, Com, Eu, Uk, Germany, Spain, Poland, Finland, France, Italy, ItalyEasyfatt Edition where the bank is available.
bank.name string Bank name.
bank.paymentBankNumber integer Bank identification number.
bankAccountNumber string The bank account number.
bankAgreementNumber string The bank agreement number.
iban string The bank account Iban.
isIntegrationAccount boolean The bank account is bound to an external integration service.
paymentBankAccountNumber integer The unique identifier of the payment bank account.
sbfAccount object The effetti SBF account for the Distinta workflow.
sbfAccount.accountNumber integer The number of the account
sbfAccount.name string True The name of the account.
sepaCuc string The SEPA CUC code.
sepaId string The SEPA ID code.
siaCode string The SIA code.
sortCode string The bank sort code.
swiftCode string The bank swift code.

Get specific Payment Bank Account

GET /payment-management/bank-accounts/:paymentBankAccountNumber

Return type

This method returns a single object

Properties

Name Type Read-only Values Description
account object The account linked to the bank.
account.accountNumber integer The number of the account
account.name string True The name of the account.
bank object The payment bank.
bank.edition object None, Denmark, Norway, Sweden, Com, Eu, Uk, Germany, Spain, Poland, Finland, France, Italy, ItalyEasyfatt Edition where the bank is available.
bank.name string Bank name.
bank.paymentBankNumber integer Bank identification number.
bankAccountNumber string The bank account number.
bankAgreementNumber string The bank agreement number.
iban string The bank account Iban.
isIntegrationAccount boolean The bank account is bound to an external integration service.
paymentBankAccountNumber integer The unique identifier of the payment bank account.
sbfAccount object The effetti SBF account for the Distinta workflow.
sbfAccount.accountNumber integer The number of the account
sbfAccount.name string True The name of the account.
sepaCuc string The SEPA CUC code.
sepaId string The SEPA ID code.
siaCode string The SIA code.
sortCode string The bank sort code.
swiftCode string The bank swift code.

Create Payment Bank Account

POST /payment-management/bank-accounts

Return type

This method returns a single object

Required properties

account, bank, sbfAccount

Properties

Name Type Description
account object The account linked to the bank.
bank object The payment bank.
bank.paymentBankNumber integer Bank identification number.
bankAccountNumber string The bank account number.
bankAgreementNumber string The bank agreement number.
iban string The bank account Iban.
isIntegrationAccount boolean The bank account is bound to an external integration service.
paymentBankAccountNumber integer The unique identifier of the payment bank account.
sbfAccount object The effetti SBF account for the Distinta workflow.
sepaCuc string The SEPA CUC code.
sepaId string The SEPA ID code.
siaCode string The SIA code.
sortCode string The bank sort code.
swiftCode string The bank swift code.

Update Payment Bank Account

PUT /payment-management/bank-accounts/:paymentBankAccountNumber

Return type

This method returns a single object

Required properties

account, bank, sbfAccount

Properties

Name Type Description
account object The account linked to the bank.
bank object The payment bank.
bank.paymentBankNumber integer Bank identification number.
bankAccountNumber string The bank account number.
bankAgreementNumber string The bank agreement number.
iban string The bank account Iban.
isIntegrationAccount boolean The bank account is bound to an external integration service.
paymentBankAccountNumber integer The unique identifier of the payment bank account.
sbfAccount object The effetti SBF account for the Distinta workflow.
sepaCuc string The SEPA CUC code.
sepaId string The SEPA ID code.
siaCode string The SIA code.
sortCode string The bank sort code.
swiftCode string The bank swift code.

Delete Payment Bank Account

DELETE /payment-management/bank-accounts/:paymentBankAccountNumber

Payment Banks

Get Payment Banks

GET /payment-management/banks

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Values Description
edition object None, Denmark, Norway, Sweden, Com, Eu, Uk, Germany, Spain, Poland, Finland, France, Italy, ItalyEasyfatt Edition where the bank is available.
name string Bank name.
paymentBankNumber integer Bank identification number.

Get specific Payment Bank

GET /payment-management/banks/:paymentBankNumber

Return type

This method returns a single object

Properties

Name Type Values Description
edition object None, Denmark, Norway, Sweden, Com, Eu, Uk, Germany, Spain, Poland, Finland, France, Italy, ItalyEasyfatt Edition where the bank is available.
name string Bank name.
paymentBankNumber integer Bank identification number.

Payment Info

Get Payment Info

GET /payment-management/payment-info

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Values Description
isReadOnly boolean Indicates whether the entity is editable or not.
lines object The list of every line in the payment.
lines.amount number Line amount.
lines.amountBaseCurrency number Line amount value in the base currency.
lines.bankAccountNumber integer Bank account line is associated with.
lines.dueDate string full-date Due date.
lines.exports object
lines.exports.type object SepaDirectDebit, CbiSepaDirectDebit, CbiSepaDirectCredit, Riba, BankFile, SepaDirectCredit The type of the current export.
lines.lineNumber integer Unique line number.
lines.paymentCreditorIdentifier string Creditor ID of the payment type chosen - IBAN, etc.
lines.paymentIdentifier string Custom message associated with the payment type chosen.
lines.paymentTypeId integer Type of the payment made: cash, wire transfer, etc.
lines.remainderBaseCurrency number Remainder value in the base currency.
lines.status object Paid, PartiallyPaid, NotOpen, Open, Exported Line status.
paymentInfoNumber integer Unique payment info identifier. This is not set for payments or draft invoices, as they cannot be changed.
type object CustomerInvoice, CustomerCreditNote, CustomerPayment, SupplierInvoice, SupplierCreditNote, SupplierPayment The payment type.
version2Draft boolean
voucherSummary object The referenced voucher summary.
voucherSummary.currency object Currency reference.
voucherSummary.customer object The customer reference, if applicable.
voucherSummary.customer.italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
voucherSummary.displayNumber string The voucher’s displayed number.
voucherSummary.grossAmountBaseCurrency number The voucher gross amount in the base currency
voucherSummary.salesInvoice object Invoice reference.
voucherSummary.supplier object The supplier reference, if applicable.
voucherSummary.supplierInvoice object Supplier Invoice reference.
voucherSummary.voucher object The voucher reference.
voucherSummary.voucher.voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote

Get specific Payment Info

GET /payment-management/payment-info/:paymentInfoNumber

Return type

This method returns a single object

Properties

Name Type Format Values Description
isReadOnly boolean Indicates whether the entity is editable or not.
lines object The list of every line in the payment.
lines.amount number Line amount.
lines.amountBaseCurrency number Line amount value in the base currency.
lines.bankAccountNumber integer Bank account line is associated with.
lines.dueDate string full-date Due date.
lines.exports object
lines.exports.type object SepaDirectDebit, CbiSepaDirectDebit, CbiSepaDirectCredit, Riba, BankFile, SepaDirectCredit The type of the current export.
lines.lineNumber integer Unique line number.
lines.paymentCreditorIdentifier string Creditor ID of the payment type chosen - IBAN, etc.
lines.paymentIdentifier string Custom message associated with the payment type chosen.
lines.paymentTypeId integer Type of the payment made: cash, wire transfer, etc.
lines.remainderBaseCurrency number Remainder value in the base currency.
lines.status object Paid, PartiallyPaid, NotOpen, Open, Exported Line status.
paymentInfoNumber integer Unique payment info identifier. This is not set for payments or draft invoices, as they cannot be changed.
type object CustomerInvoice, CustomerCreditNote, CustomerPayment, SupplierInvoice, SupplierCreditNote, SupplierPayment The payment type.
version2Draft boolean
voucherSummary object The referenced voucher summary.
voucherSummary.currency object Currency reference.
voucherSummary.customer object The customer reference, if applicable.
voucherSummary.customer.italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
voucherSummary.displayNumber string The voucher’s displayed number.
voucherSummary.grossAmountBaseCurrency number The voucher gross amount in the base currency
voucherSummary.salesInvoice object Invoice reference.
voucherSummary.supplier object The supplier reference, if applicable.
voucherSummary.supplierInvoice object Supplier Invoice reference.
voucherSummary.voucher object The voucher reference.
voucherSummary.voucher.voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote

Update Payment Info

PUT /payment-management/payment-info/:paymentInfoNumber

Return type

This method returns a single object

Required property

paymentInfoNumber

Properties

Name Type Values Description
isReadOnly boolean Indicates whether the entity is editable or not.
lines object The list of every line in the payment.
lines.lineNumber integer Unique line number.
paymentInfoNumber integer Unique payment info identifier. This is not set for payments or draft invoices, as they cannot be changed.
type object CustomerInvoice, CustomerCreditNote, CustomerPayment, SupplierInvoice, SupplierCreditNote, SupplierPayment The payment type.
version2Draft boolean
voucherSummary object The referenced voucher summary.

Get Customer payments

GET /payment-management/payment-info/customers

Filter only customer related payments.

Get Supplier payments

GET /payment-management/payment-info/suppliers

Filter only supplier related payments.

Export due payments

POST /payment-management/payment-info/export

Export XML file of due bank payments.

Payment Terms

Payment Terms are the different ways your customers can pay you in regards to, type of payment, days of credit etc.

For more information please look at the Online Help.

Get Payment Terms

GET /payment-terms

View response example

Schema name

payment-terms.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Required property

paymentTermsType

Properties

Name Type Format Max length Values Description
contraAccountForPrepaidAmount object The contra account for prepaid amount of the payment term.
contraAccountForPrepaidAmount.accountNumber integer The account number for the contraAccountForPrepaidAmount.
contraAccountForPrepaidAmount.self string uri A unique link reference to the contra account for prepaid amount item.
contraAccountForRemainderAmount object The contra account for remainder amount of the payment term.
contraAccountForRemainderAmount.accountNumber integer The account number for the contraAccountForRemainderAmount.
contraAccountForRemainderAmount.self string uri A unique link reference to the contra account for remainder amount item.
creditCardCompany object The credit card company of the payment term.
creditCardCompany.customerNumber integer The credit card company customer number.
creditCardCompany.self string uri A unique link reference to the credit card company customer item.
daysOfCredit integer The number of days before payment must be made.
description string 1000 A description of the payment term.
name string 50 The name of the payment term.
paymentTermsNumber integer A unique identifier of the payment term.
paymentTermsType Enum net, invoiceMonth, paidInCash, prepaid, dueDate, factoring, invoiceWeekStartingSunday, invoiceWeekStartingMonday, creditcard, timeTable, endOfMonth The type of payment term.
percentageForPrepaidAmount number The % to be pre paid.
percentageForRemainderAmount number The % to be post paid.
self string uri A unique link reference to the payment term item.

Get specific Payment Terms

GET /payment-terms/:paymentTermsNumber

Schema name

payment-terms.paymentTermsNumber.get.schema.json

Return type

This method returns a single object

Required property

paymentTermsType

Properties

Name Type Format Max length Values Description
contraAccountForPrepaidAmount object The contra account for prepaid amount of the payment term.
contraAccountForPrepaidAmount.accountNumber integer The account number of the contra account.
contraAccountForPrepaidAmount.self string uri A unique link reference to the contra account for prepaid amount item.
contraAccountForRemainderAmount object The contra account for remainder amount of the payment term.
contraAccountForRemainderAmount.accountNumber integer The account number of the contra account.
contraAccountForRemainderAmount.self string uri A unique link reference to the contra account for remainder amount item.
creditCardCompany object The credit card company of the payment term.
creditCardCompany.customerNumber integer The credit card company customer number.
creditCardCompany.self string uri A unique link reference to the customer item.
daysOfCredit integer The number of days before payment must be made.
description string 1000 A description of the payment term.
name string 50 The name of the payment term.
paymentTermsNumber integer A unique identifier of the payment term.
paymentTermsType Enum net, invoiceMonth, paidInCash, prepaid, dueDate, factoring, invoiceWeekStartingSunday, invoiceWeekStartingMonday, creditcard, timeTable, endOfMonth The type of payment term defines how the payment term behaves.
percentageForPrepaidAmount number The % to be pre paid.
percentageForRemainderAmount number The % to be post paid.
self string uri A unique link reference to the payment term item.

Create Payment Terms

POST /payment-terms

Schema name

payment-terms.post.schema.json

Return type

This method returns a single object

Required properties

name, paymentTermsType

Properties

Name Type Format Max length Values Description
contraAccountForPrepaidAmount object The contra account for prepaid amount of the payment term.
contraAccountForPrepaidAmount.accountNumber integer The account number of the contra account.
contraAccountForPrepaidAmount.self string uri A unique link reference to the contra account for prepaid amount item.
contraAccountForRemainderAmount object The contra account for remainder amount of the payment term.
contraAccountForRemainderAmount.accountNumber integer The account number of the contra account.
contraAccountForRemainderAmount.self string uri A unique link reference to the contra account for remainder amount item.
creditCardCompany object The credit card company of the payment term.
creditCardCompany.customerNumber integer The credit card company customer number.
creditCardCompany.self string uri A unique link reference to the customer item.
daysOfCredit integer The number of days before payment must be made.
description string 1000 A description of the payment term.
name string 50 The name of the payment term.
paymentTermsType Enum net, invoiceMonth, paidInCash, prepaid, dueDate, factoring, invoiceWeekStartingSunday, invoiceWeekStartingMonday, creditcard, timeTable, endOfMonth The type of payment term.
percentageForPrepaidAmount number The % to be pre paid.
percentageForRemainderAmount number The % to be post paid.

Update Payment Terms

PUT /payment-terms/:paymentTermsNumber

Schema name

payment-terms.paymentTermsNumber.put.schema.json

Return type

This method returns a single object

Required properties

name, paymentTermsType

Properties

Name Type Format Max length Values Description
contraAccountForPrepaidAmount object The contra account for prepaid amount of the payment term.
contraAccountForPrepaidAmount.accountNumber integer The account number of the contra account.
contraAccountForPrepaidAmount.self string uri A unique link reference to the contra account for prepaid amount item.
contraAccountForRemainderAmount object The contra account for remainder amount of the payment term.
contraAccountForRemainderAmount.accountNumber integer The account number of the contra account.
contraAccountForRemainderAmount.self string uri A unique link reference to the contra account for remainder amount item.
creditCardCompany object The credit card company of the payment term.
creditCardCompany.customerNumber integer The credit card company customer number.
creditCardCompany.self string uri A unique link reference to the customer item.
daysOfCredit integer The number of days before payment must be made.
description string 1000 A description of the payment term.
name string 50 The name of the payment term.
paymentTermsType Enum net, invoiceMonth, paidInCash, prepaid, dueDate, factoring, invoiceWeekStartingSunday, invoiceWeekStartingMonday, creditcard, timeTable, endOfMonth The type of payment term.
percentageForPrepaidAmount number The % to be pre paid.
percentageForRemainderAmount number The % to be pre paid.

Delete Payment Terms

DELETE /payment-terms/:paymentTermsNumber

Payment Types

Get Payment Types

GET /payment-types

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Values Description
fields object List of the payment type’s fields.
fields.dataType object String, Integer Data type of the payment type field.
fields.description string Field’s description.
fields.maximumLength integer Maximum length of the field.
fields.minimumLength integer Minimum length of the field.
fields.name string Field’s name
fields.paymentTypeFieldNumber integer Unique numeric identifier.
name string Payment type’s name.
paymentTypeNumber integer Unique identifier of the payment type.

Get specific Payment Type

GET /payment-types/:paymentTypeNumber

Return type

This method returns a single object

Properties

Name Type Values Description
fields object List of the payment type’s fields.
fields.dataType object String, Integer Data type of the payment type field.
fields.description string Field’s description.
fields.maximumLength integer Maximum length of the field.
fields.minimumLength integer Minimum length of the field.
fields.name string Field’s name
fields.paymentTypeFieldNumber integer Unique numeric identifier.
name string Payment type’s name.
paymentTypeNumber integer Unique identifier of the payment type.

Price Groups

Get Price Groups

GET /price-groups

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Description
name string The name of the price group.
priceGroupNumber integer The number of the price group.
products object The list of products the price group has special prices for.
products.product object The product the price is for.
products.specialPriceBaseCurrency number The price in the base currency.
products.specialPrices object The prices as defined in other currencies.

Get specific Price Group

GET /price-groups/:priceGroupNumber

Return type

This method returns a single object

Properties

Name Type Description
name string The name of the price group.
priceGroupNumber integer The number of the price group.
products object The list of products the price group has special prices for.
products.product object The product the price is for.
products.specialPriceBaseCurrency number The price in the base currency.
products.specialPrices object The prices as defined in other currencies.

Product Groups

Products are organized in Product groups.

You can read more about Product groups on our Online Help.

Get Product Groups

GET /product-groups

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Read-only Values Description
accrual object The accrual account of the product group.
accrual.accountCategory object The category of the account.
accrual.accountCategory.accountCategoryType object BalanceSheet, ProfitAndLoss Category type.
accrual.accountingYears object A link to a list of accounting years for which the account is usable.
accrual.accountNumber integer The number of the account
accrual.accountsSummed object True An array of the account intervals used for calculating the total for this account.
accrual.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
accrual.balance number True The current balance of the account.
accrual.barred boolean Used to bar the account from being used - default is false.
accrual.blockDirectEntries boolean Determines if the account can be manually updated with entries.
accrual.contraAccount object The default contra account of the account.
accrual.contraAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
accrual.contraAccount.debitCredit object Debit, Credit Describes the default update type of the account.
accrual.debitCredit object Debit, Credit Describes the default update type of the account.
accrual.department object Department associated with the account.
accrual.departmentalDistribution object Departmental distribution, used to split on more than one department.
accrual.departmentalDistribution.distributionType object Distribution, Department
accrual.displayNumber string String representation of the Account number, for display and sorting purposes.
accrual.name string True The name of the account.
accrual.openingAccount object The associted opening account.
accrual.openingAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
accrual.openingAccount.debitCredit object Debit, Credit Describes the default update type of the account.
accrual.requireDepartmentalDistributionOnEntries boolean Whether or not the departmental distribution is required on entries.
accrual.totalFromAccount object The account from which the sum total for this account is calculated.
accrual.totalFromAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
accrual.totalFromAccount.debitCredit object Debit, Credit Describes the default update type of the account.
accrual.vatAccount object The default VAT code for this account.
hasDeduction boolean Whether or not deductions should apply.
includeInProjects boolean Whether or not we should include the product group in projects.
inventory object Inventory object containing references to sales and purchase account.
inventory.purchaseAccount object
inventory.purchaseAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
inventory.purchaseAccount.debitCredit object Debit, Credit Describes the default update type of the account.
inventory.salesAccount object
inventory.salesAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
inventory.salesAccount.debitCredit object Debit, Credit Describes the default update type of the account.
inventoryEnabled boolean Whether or not the inventory is enabled for this product group.
name string Name of the product group.
productGroupNumber integer The unique identifier of the product group.
products object A link to the product in the product group.
salesAccounts object A link to the sales accounts in the product group.
salesAccountsList object List of sales accounts in the product group.
salesAccountsList.salesAccount object
salesAccountsList.salesAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
salesAccountsList.salesAccount.debitCredit object Debit, Credit Describes the default update type of the account.
salesAccountsList.vatZone object

Get specific Product Group

GET /product-groups/:productGroupNumber

Return type

This method returns a single object

Properties

Name Type Read-only Values Description
accrual object The accrual account of the product group.
accrual.accountCategory object The category of the account.
accrual.accountCategory.accountCategoryType object BalanceSheet, ProfitAndLoss Category type.
accrual.accountingYears object A link to a list of accounting years for which the account is usable.
accrual.accountNumber integer The number of the account
accrual.accountsSummed object True An array of the account intervals used for calculating the total for this account.
accrual.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
accrual.balance number True The current balance of the account.
accrual.barred boolean Used to bar the account from being used - default is false.
accrual.blockDirectEntries boolean Determines if the account can be manually updated with entries.
accrual.contraAccount object The default contra account of the account.
accrual.contraAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
accrual.contraAccount.debitCredit object Debit, Credit Describes the default update type of the account.
accrual.debitCredit object Debit, Credit Describes the default update type of the account.
accrual.department object Department associated with the account.
accrual.departmentalDistribution object Departmental distribution, used to split on more than one department.
accrual.departmentalDistribution.distributionType object Distribution, Department
accrual.displayNumber string String representation of the Account number, for display and sorting purposes.
accrual.name string True The name of the account.
accrual.openingAccount object The associted opening account.
accrual.openingAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
accrual.openingAccount.debitCredit object Debit, Credit Describes the default update type of the account.
accrual.requireDepartmentalDistributionOnEntries boolean Whether or not the departmental distribution is required on entries.
accrual.totalFromAccount object The account from which the sum total for this account is calculated.
accrual.totalFromAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
accrual.totalFromAccount.debitCredit object Debit, Credit Describes the default update type of the account.
accrual.vatAccount object The default VAT code for this account.
hasDeduction boolean Whether or not deductions should apply.
includeInProjects boolean Whether or not we should include the product group in projects.
inventory object Inventory object containing references to sales and purchase account.
inventory.purchaseAccount object
inventory.purchaseAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
inventory.purchaseAccount.debitCredit object Debit, Credit Describes the default update type of the account.
inventory.salesAccount object
inventory.salesAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
inventory.salesAccount.debitCredit object Debit, Credit Describes the default update type of the account.
inventoryEnabled boolean Whether or not the inventory is enabled for this product group.
name string Name of the product group.
productGroupNumber integer The unique identifier of the product group.
products object A link to the product in the product group.
salesAccounts object A link to the sales accounts in the product group.
salesAccountsList object List of sales accounts in the product group.
salesAccountsList.salesAccount object
salesAccountsList.salesAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
salesAccountsList.salesAccount.debitCredit object Debit, Credit Describes the default update type of the account.
salesAccountsList.vatZone object

Create Product Group

POST /product-groups

Return type

This method returns a single object

Required properties

name, productGroupNumber, salesAccountsList

Properties

Name Type Description
accrual object The accrual account of the product group.
hasDeduction boolean Whether or not deductions should apply.
includeInProjects boolean Whether or not we should include the product group in projects.
inventory object Inventory object containing references to sales and purchase account.
inventoryEnabled boolean Whether or not the inventory is enabled for this product group.
name string Name of the product group.
productGroupNumber integer The unique identifier of the product group.
products object A link to the product in the product group.
salesAccounts object A link to the sales accounts in the product group.
salesAccountsList object List of sales accounts in the product group.

Update Product Group

PUT /product-groups/:productGroupNumber

Return type

This method returns a single object

Required properties

name, productGroupNumber, salesAccountsList

Properties

Name Type Description
accrual object The accrual account of the product group.
hasDeduction boolean Whether or not deductions should apply.
includeInProjects boolean Whether or not we should include the product group in projects.
inventory object Inventory object containing references to sales and purchase account.
inventoryEnabled boolean Whether or not the inventory is enabled for this product group.
name string Name of the product group.
productGroupNumber integer The unique identifier of the product group.
products object A link to the product in the product group.
salesAccounts object A link to the sales accounts in the product group.
salesAccountsList object List of sales accounts in the product group.

Delete Product Group

DELETE /product-groups/:productGroupNumber

Get Sales Accounts for Product Group

GET /product-groups/:productGroupNumber/sales-accounts

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Read-only Values Description
salesAccount object
salesAccount.accountCategory object The category of the account.
salesAccount.accountCategory.accountCategoryType object BalanceSheet, ProfitAndLoss Category type.
salesAccount.accountingYears object A link to a list of accounting years for which the account is usable.
salesAccount.accountNumber integer The number of the account
salesAccount.accountsSummed object True An array of the account intervals used for calculating the total for this account.
salesAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
salesAccount.balance number True The current balance of the account.
salesAccount.barred boolean Used to bar the account from being used - default is false.
salesAccount.blockDirectEntries boolean Determines if the account can be manually updated with entries.
salesAccount.contraAccount object The default contra account of the account.
salesAccount.contraAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
salesAccount.contraAccount.debitCredit object Debit, Credit Describes the default update type of the account.
salesAccount.debitCredit object Debit, Credit Describes the default update type of the account.
salesAccount.department object Department associated with the account.
salesAccount.departmentalDistribution object Departmental distribution, used to split on more than one department.
salesAccount.departmentalDistribution.distributionType object Distribution, Department
salesAccount.displayNumber string String representation of the Account number, for display and sorting purposes.
salesAccount.name string True The name of the account.
salesAccount.openingAccount object The associted opening account.
salesAccount.openingAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
salesAccount.openingAccount.debitCredit object Debit, Credit Describes the default update type of the account.
salesAccount.requireDepartmentalDistributionOnEntries boolean Whether or not the departmental distribution is required on entries.
salesAccount.totalFromAccount object The account from which the sum total for this account is calculated.
salesAccount.totalFromAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
salesAccount.totalFromAccount.debitCredit object Debit, Credit Describes the default update type of the account.
salesAccount.vatAccount object The default VAT code for this account.
vatZone object
vatZone.editionEnum string The edition to where the vat zone belongs.
vatZone.enabledForCustomer boolean A boolean value indicating if the vat zone is enabled for customers.
vatZone.enabledForSupplier boolean A boolean value indicating if the vat zone is enabled for suppliers.
vatZone.isDomestic boolean A boolean value indicating if the vat zone is domestic.
vatZone.isExemptVatZone boolean A boolean value indicating if the vat zone is exempt.
vatZone.isProjectAccount boolean
vatZone.name string The descriptive name of the vat zone.
vatZone.textId string The text id for the vat zone.
vatZone.vatZoneNumber integer The unique identifier of the vat zone.

Get Products in Product Group

GET /product-groups/:productGroupNumber/products

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Read-only Values Description
barCode string String representation of a machine readable barcode symbol that represents this product.
barred boolean If this value is true, then the product can no longer be sold, and trying to book an invoice with this product will not be possible.
costPrice number True The cost of the goods. If you have the inventory module enabled, this is read-only and will just be ignored.
departmentalDistribution object A reference to the department that will receive credit for the revenue generated by sales of this product. If you have set a value on this property you cannot set a value in the property distributionKey. You need to enable the Dimension module to use this. If dimension is not enabled this will just be ignored.
departmentalDistribution.barred boolean Indicates whether or not the departmental distribution is barred.
departmentalDistribution.departmentalDistributionNumber integer The unique identifier of the departmental distribution.
departmentalDistribution.distributions object List of distributions with percentage for each department.
departmentalDistribution.distributionType object Distribution, Department
departmentalDistribution.name string Name of the departmental distribution.
description string Free text description of product.
inventory object A collection of properties that are only applicable if the inventory module is enabled.
inventory.available number True The number of units available to sell. This is the difference between the amount in stock and the amount ordered by customers.
inventory.inStock number True The number of units in stock including any that have been ordered by customers.
inventory.orderedByCustomers number True The number of units that have been ordered by customers, but haven’t been sold yet.
inventory.orderedFromSuppliers number True The number of units that have been ordered from your suppliers, but haven’t been delivered to you yet.
inventory.packageVolume number The volume the shipped package makes up.
lastUpdated string full-date
name string Descriptive name of the product.
productGroup object A reference to the product group this product is contained within.
productGroup.accrual object The accrual account of the product group.
productGroup.accrual.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
productGroup.accrual.debitCredit object Debit, Credit Describes the default update type of the account.
productGroup.hasDeduction boolean Whether or not deductions should apply.
productGroup.includeInProjects boolean Whether or not we should include the product group in projects.
productGroup.inventory object Inventory object containing references to sales and purchase account.
productGroup.inventoryEnabled boolean Whether or not the inventory is enabled for this product group.
productGroup.name string Name of the product group.
productGroup.productGroupNumber integer The unique identifier of the product group.
productGroup.products object A link to the product in the product group.
productGroup.salesAccounts object A link to the sales accounts in the product group.
productGroup.salesAccountsList object List of sales accounts in the product group.
productNumber string Unique alphanumeric product number.
recommendedPrice number Recommended retail price of the goods.
salesPrice number This is the unit net price that will appear on invoice lines when a product is added to an invoice line.
unit object A reference to the unit this product is counted in.
unit.name string Name of the unit.
unit.products object
unit.unitNumber integer Unique number identifying the unit.

Products

This endpoint lists all products and their various attributes. Products can be updated and created here as well.

For more information please look at the Online Help.

Get Products

GET /products

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Read-only Values Description
barCode string String representation of a machine readable barcode symbol that represents this product.
barred boolean If this value is true, then the product can no longer be sold, and trying to book an invoice with this product will not be possible.
costPrice number True The cost of the goods. If you have the inventory module enabled, this is read-only and will just be ignored.
departmentalDistribution object A reference to the department that will receive credit for the revenue generated by sales of this product. If you have set a value on this property you cannot set a value in the property distributionKey. You need to enable the Dimension module to use this. If dimension is not enabled this will just be ignored.
departmentalDistribution.barred boolean Indicates whether or not the departmental distribution is barred.
departmentalDistribution.departmentalDistributionNumber integer The unique identifier of the departmental distribution.
departmentalDistribution.distributions object List of distributions with percentage for each department.
departmentalDistribution.distributionType object Distribution, Department
departmentalDistribution.name string Name of the departmental distribution.
description string Free text description of product.
inventory object A collection of properties that are only applicable if the inventory module is enabled.
inventory.available number True The number of units available to sell. This is the difference between the amount in stock and the amount ordered by customers.
inventory.inStock number True The number of units in stock including any that have been ordered by customers.
inventory.orderedByCustomers number True The number of units that have been ordered by customers, but haven’t been sold yet.
inventory.orderedFromSuppliers number True The number of units that have been ordered from your suppliers, but haven’t been delivered to you yet.
inventory.packageVolume number The volume the shipped package makes up.
lastUpdated string full-date
name string Descriptive name of the product.
productGroup object A reference to the product group this product is contained within.
productGroup.accrual object The accrual account of the product group.
productGroup.accrual.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
productGroup.accrual.debitCredit object Debit, Credit Describes the default update type of the account.
productGroup.hasDeduction boolean Whether or not deductions should apply.
productGroup.includeInProjects boolean Whether or not we should include the product group in projects.
productGroup.inventory object Inventory object containing references to sales and purchase account.
productGroup.inventoryEnabled boolean Whether or not the inventory is enabled for this product group.
productGroup.name string Name of the product group.
productGroup.productGroupNumber integer The unique identifier of the product group.
productGroup.products object A link to the product in the product group.
productGroup.salesAccounts object A link to the sales accounts in the product group.
productGroup.salesAccountsList object List of sales accounts in the product group.
productNumber string Unique alphanumeric product number.
recommendedPrice number Recommended retail price of the goods.
salesPrice number This is the unit net price that will appear on invoice lines when a product is added to an invoice line.
unit object A reference to the unit this product is counted in.
unit.name string Name of the unit.
unit.products object
unit.unitNumber integer Unique number identifying the unit.

Get a specific Product

GET /products/:productId

Return type

This method returns a single object

Properties

Name Type Format Read-only Values Description
barCode string String representation of a machine readable barcode symbol that represents this product.
barred boolean If this value is true, then the product can no longer be sold, and trying to book an invoice with this product will not be possible.
costPrice number True The cost of the goods. If you have the inventory module enabled, this is read-only and will just be ignored.
departmentalDistribution object A reference to the department that will receive credit for the revenue generated by sales of this product. If you have set a value on this property you cannot set a value in the property distributionKey. You need to enable the Dimension module to use this. If dimension is not enabled this will just be ignored.
departmentalDistribution.barred boolean Indicates whether or not the departmental distribution is barred.
departmentalDistribution.departmentalDistributionNumber integer The unique identifier of the departmental distribution.
departmentalDistribution.distributions object List of distributions with percentage for each department.
departmentalDistribution.distributionType object Distribution, Department
departmentalDistribution.name string Name of the departmental distribution.
description string Free text description of product.
inventory object A collection of properties that are only applicable if the inventory module is enabled.
inventory.available number True The number of units available to sell. This is the difference between the amount in stock and the amount ordered by customers.
inventory.inStock number True The number of units in stock including any that have been ordered by customers.
inventory.orderedByCustomers number True The number of units that have been ordered by customers, but haven’t been sold yet.
inventory.orderedFromSuppliers number True The number of units that have been ordered from your suppliers, but haven’t been delivered to you yet.
inventory.packageVolume number The volume the shipped package makes up.
lastUpdated string full-date
name string Descriptive name of the product.
productGroup object A reference to the product group this product is contained within.
productGroup.accrual object The accrual account of the product group.
productGroup.accrual.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
productGroup.accrual.debitCredit object Debit, Credit Describes the default update type of the account.
productGroup.hasDeduction boolean Whether or not deductions should apply.
productGroup.includeInProjects boolean Whether or not we should include the product group in projects.
productGroup.inventory object Inventory object containing references to sales and purchase account.
productGroup.inventoryEnabled boolean Whether or not the inventory is enabled for this product group.
productGroup.name string Name of the product group.
productGroup.productGroupNumber integer The unique identifier of the product group.
productGroup.products object A link to the product in the product group.
productGroup.salesAccounts object A link to the sales accounts in the product group.
productGroup.salesAccountsList object List of sales accounts in the product group.
productNumber string Unique alphanumeric product number.
recommendedPrice number Recommended retail price of the goods.
salesPrice number This is the unit net price that will appear on invoice lines when a product is added to an invoice line.
unit object A reference to the unit this product is counted in.
unit.name string Name of the unit.
unit.products object
unit.unitNumber integer Unique number identifying the unit.

Create a Product

POST /products

Schema name

products.post.schema.json

Return type

This method returns a single object

Required properties

name, productGroup, productNumber

Properties

Name Type Format Read-only Max length Min length Description
barCode string 50 String representation of a machine readable barcode symbol that represents this product.
barred boolean If this value is true, then the product can no longer be sold, and trying to book an invoice with this product will not be possible.
costPrice number The cost of the goods. If you have the inventory module enabled, this is read-only and will just be ignored.
department object A reference to the department that will receive credit for the revenue generated by sales of this product. If you have set a value on this property you cannot set a value in the property distributionKey. You need to enable the Dimension module to use this. If dimension is not enabled this will just be ignored.
department.departmentNumber integer Unique number identifying the department.
department.self string uri A unique reference to the department resource.
description string 500 Free text description of product.
inventory object A collection of properties that are only applicable if the inventory module is enabled.
inventory.available number True The number of units available to sell. This is the difference between the amount in stock and the amount ordered by customers.
inventory.inStock number True The number of units in stock including any that have been ordered by customers.
inventory.orderedByCustomers number True The number of units that have been ordered by customers, but haven’t been sold yet.
inventory.orderedFromSuppliers number True The number of units that have been ordered from your suppliers, but haven’t been delivered to you yet.
inventory.packageVolume number The volume the shipped package makes up.
name string 300 1 Descriptive name of the product.
productGroup object A reference to the product group this product is contained within.
productGroup.productGroupNumber integer Unique number identifying the product group.
productGroup.self string uri A unique reference to the product group resource.
productNumber string 25 1 Unique alphanumeric product number.
recommendedPrice number Recommended retail price of the goods.
salesPrice number This is the unit net price that will appear on invoice lines when a product is added to an invoice line.
unit object A reference to the unit this product is counted in.
unit.self string uri A unique reference to the unit resource.
unit.unitNumber integer Unique number identifying the unit.

Update a Product

PUT /products/:productId

Return type

This method returns a single object

Required property

productGroup.productGroupNumber

Properties

Name Type Format Description
barCode string String representation of a machine readable barcode symbol that represents this product.
barred boolean If this value is true, then the product can no longer be sold, and trying to book an invoice with this product will not be possible.
departmentalDistribution object A reference to the department that will receive credit for the revenue generated by sales of this product. If you have set a value on this property you cannot set a value in the property distributionKey. You need to enable the Dimension module to use this. If dimension is not enabled this will just be ignored.
description string Free text description of product.
inventory object A collection of properties that are only applicable if the inventory module is enabled.
lastUpdated string full-date
name string Descriptive name of the product.
productGroup object A reference to the product group this product is contained within.
productGroup.productGroupNumber integer The unique identifier of the product group.
productNumber string Unique alphanumeric product number.
recommendedPrice number Recommended retail price of the goods.
salesPrice number This is the unit net price that will appear on invoice lines when a product is added to an invoice line.
unit object A reference to the unit this product is counted in.

Delete a Product

DELETE /products/:productId

Note that you cannot delete a product that has been used on an Invoice.

Projects

These endpoints require access to the Project add-on module.

Get Project entry point

GET /project

Schema name

project.get.schema.json

Return type

This method returns a single object

Properties

Name Type Format Description
costTypes string uri The reference to list of cost types.
projects string uri The reference to list of projects.

Get Projects

GET /project/projects

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Read-only Values Description
barred boolean Shows if the project is barred from being used.
customer object The customer relating to the project.
customer.address string Address for the customer including street and number.
customer.aliasLayer object The customer’s alias-layer.
customer.attention object The customer’s person of attention.
customer.attention.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
customer.balance number True The outstanding amount for this customer.
customer.barred boolean Boolean indication of whether the customer is barred from invoicing.
customer.city string The customer’s city.
customer.contacts object The customer’s contacts.
customer.corporateIdentificationNumber string Corporate Identification Number.
customer.country string The customer’s country.
customer.countryCode object The customer’s country code - only exposed in Spain
customer.county string The customer’s county.
customer.creditLimit number A maximum credit for this customer. Once the maximum is reached or passed in connection with an order/quotation/invoice for this customer you see a warning in the system.
customer.currency string Default payment currency.
customer.customerContact object Reference to main contact employee at customer.
customer.customerContact.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
customer.customerGroup object The customer group to which the customer belongs.
customer.customerNumber integer The unique identifier of the customer.
customer.defaultDeliveryLocation object The customer’s default delivery location.
customer.defaultDiscountPct number The customer’s default discount percent to apply to new invoice lines.
customer.ean string International Article Number (originally European Article Number). EAN is used for invoicing the Danish public sector.
customer.email string Customer e-mail address where invoices should be emailed. Multiple email addresses are separated by a space.
customer.iban string The customer’s iban. Must match a proper IBAN- example: DE44500105175407324931
customer.italianCertifiedEmail string The customer’s certified Italian email.
customer.italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
customer.lastUpdated string full-date The date the customer was last updated. Presented in UTC
customer.layout object Layout to be applied for invoices and other documents for this customer.
customer.name string The customer name.
customer.paymentTerms object The default payment terms for the customer.
customer.paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
customer.paymentType object A type description how the payment should be executed.
customer.priceGroup object The customer’s price group.
customer.priceList object The customer’s default price-list.
customer.province object The customer’s province.
customer.publicEntryNumber string The public entry number is used for electronic invoicing, to define the account invoices will be registered on at the customer.
customer.salesPerson object Reference to the employee responsible for contact with this customer.
customer.splitPayment boolean The customer’s split payment regime indicator.
customer.swift string The customer’s swift.
customer.telephoneAndFaxNumber string The customer’s telephone and/or fax number.
customer.templates object The template of the customer.
customer.tenderContract object The customer’s tender contract.
customer.tenderContract.type object Contract, Convention
customer.vatAccount object Indicates that a customer has to be invoiced with a specific VAT code.
customer.vatNumber string The customer’s value added tax identification number.
customer.vatZone object Indicates in which VAT-zone the customer is located (e.g.: domestically, in Europe or elsewhere abroad).
customer.website string Customer website, if applicable.
customer.zip string The customer’s zip code.
defaultDeliveryLocation object The default delivery location for the project.
defaultDeliveryLocation.address string The address of the delivery location.
defaultDeliveryLocation.barred boolean Whether the delivery location is barred.
defaultDeliveryLocation.city string The city of the delivery location.
defaultDeliveryLocation.country string The country of the delivery location.
defaultDeliveryLocation.county string The county of the delivery location.
defaultDeliveryLocation.deliveryLocationNumber integer A unique identifier for the delivery location.
defaultDeliveryLocation.electronicInvoicingOfficeCode string The office code used for electronic invoicing.
defaultDeliveryLocation.externalId string The external id.
defaultDeliveryLocation.postalCode string The zip code of the delivery location.
defaultDeliveryLocation.terms string The terms applying to the delivery location.
description string A description of the project.
group object The group to which the project belongs.
group.name string The descriptive name of the project group.
group.projectGroupNumber integer A unique identifier of the project group.
isClosed boolean Shows if the project is closed.
isMain boolean Shows if the project is a main project.
mileage number The mileage count for the project.
name string The descriptive name of the project.
parent object The parent project, if not a main project.
parent.projectNumber integer A unique identifier of the project.
projectNumber integer A unique identifier of the project.
responsibleEmployee object The employee responsible for the project.
responsibleEmployee.address string The Address of the employee.
responsibleEmployee.barred boolean Shows if the employee is barred from being used.
responsibleEmployee.bookedInvoices object A link to the collection of booked invoices which has the employee as a reference.
responsibleEmployee.canApprove boolean Shows if the user can approve. Only for time logger profiles.
responsibleEmployee.canInvoice boolean Shows if the user can invoice. Only for project managers and time logger profiles.
responsibleEmployee.city string The City of the employee.
responsibleEmployee.costPriceAfter number Employee cost price after the cut-off date.
responsibleEmployee.costPriceBefore number Employee cost price before the cut-off date.
responsibleEmployee.customers object A link to the collection of customers which has the employee as a reference.
responsibleEmployee.cutoffDate string full-date The cut-off date for employee cost/sales prices.
responsibleEmployee.draftInvoices object A link to the collection of draft invoices which has the employee as a reference.
responsibleEmployee.email string The email address of the employee.
responsibleEmployee.employeeGroup object The group to which the employee belongs.
responsibleEmployee.employeeNumber integer The employee number is a unique numerical identifier with a maximum of 9 digits.
responsibleEmployee.employeeType object Employee type.
responsibleEmployee.initials string Userid of related user.
responsibleEmployee.name string The name of the employee.
responsibleEmployee.phone string The phone number of the employee.
responsibleEmployee.postCode string The PostCode of the employee.
responsibleEmployee.salesPriceAfter number Employee after price sales the cut-off date.
responsibleEmployee.salesPriceBefore number Employee sales price before the cut-off date.

Get specific Project

GET /project/projects/:projectNumber

Return type

This method returns a single object

Properties

Name Type Format Read-only Values Description
barred boolean Shows if the project is barred from being used.
customer object The customer relating to the project.
customer.address string Address for the customer including street and number.
customer.aliasLayer object The customer’s alias-layer.
customer.attention object The customer’s person of attention.
customer.attention.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
customer.balance number True The outstanding amount for this customer.
customer.barred boolean Boolean indication of whether the customer is barred from invoicing.
customer.city string The customer’s city.
customer.contacts object The customer’s contacts.
customer.corporateIdentificationNumber string Corporate Identification Number.
customer.country string The customer’s country.
customer.countryCode object The customer’s country code - only exposed in Spain
customer.county string The customer’s county.
customer.creditLimit number A maximum credit for this customer. Once the maximum is reached or passed in connection with an order/quotation/invoice for this customer you see a warning in the system.
customer.currency string Default payment currency.
customer.customerContact object Reference to main contact employee at customer.
customer.customerContact.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
customer.customerGroup object The customer group to which the customer belongs.
customer.customerNumber integer The unique identifier of the customer.
customer.defaultDeliveryLocation object The customer’s default delivery location.
customer.defaultDiscountPct number The customer’s default discount percent to apply to new invoice lines.
customer.ean string International Article Number (originally European Article Number). EAN is used for invoicing the Danish public sector.
customer.email string Customer e-mail address where invoices should be emailed. Multiple email addresses are separated by a space.
customer.iban string The customer’s iban. Must match a proper IBAN- example: DE44500105175407324931
customer.italianCertifiedEmail string The customer’s certified Italian email.
customer.italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
customer.lastUpdated string full-date The date the customer was last updated. Presented in UTC
customer.layout object Layout to be applied for invoices and other documents for this customer.
customer.name string The customer name.
customer.paymentTerms object The default payment terms for the customer.
customer.paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
customer.paymentType object A type description how the payment should be executed.
customer.priceGroup object The customer’s price group.
customer.priceList object The customer’s default price-list.
customer.province object The customer’s province.
customer.publicEntryNumber string The public entry number is used for electronic invoicing, to define the account invoices will be registered on at the customer.
customer.salesPerson object Reference to the employee responsible for contact with this customer.
customer.splitPayment boolean The customer’s split payment regime indicator.
customer.swift string The customer’s swift.
customer.telephoneAndFaxNumber string The customer’s telephone and/or fax number.
customer.templates object The template of the customer.
customer.tenderContract object The customer’s tender contract.
customer.tenderContract.type object Contract, Convention
customer.vatAccount object Indicates that a customer has to be invoiced with a specific VAT code.
customer.vatNumber string The customer’s value added tax identification number.
customer.vatZone object Indicates in which VAT-zone the customer is located (e.g.: domestically, in Europe or elsewhere abroad).
customer.website string Customer website, if applicable.
customer.zip string The customer’s zip code.
defaultDeliveryLocation object The default delivery location for the project.
defaultDeliveryLocation.address string The address of the delivery location.
defaultDeliveryLocation.barred boolean Whether the delivery location is barred.
defaultDeliveryLocation.city string The city of the delivery location.
defaultDeliveryLocation.country string The country of the delivery location.
defaultDeliveryLocation.county string The county of the delivery location.
defaultDeliveryLocation.deliveryLocationNumber integer A unique identifier for the delivery location.
defaultDeliveryLocation.electronicInvoicingOfficeCode string The office code used for electronic invoicing.
defaultDeliveryLocation.externalId string The external id.
defaultDeliveryLocation.postalCode string The zip code of the delivery location.
defaultDeliveryLocation.terms string The terms applying to the delivery location.
description string A description of the project.
group object The group to which the project belongs.
group.name string The descriptive name of the project group.
group.projectGroupNumber integer A unique identifier of the project group.
isClosed boolean Shows if the project is closed.
isMain boolean Shows if the project is a main project.
mileage number The mileage count for the project.
name string The descriptive name of the project.
parent object The parent project, if not a main project.
parent.projectNumber integer A unique identifier of the project.
projectNumber integer A unique identifier of the project.
responsibleEmployee object The employee responsible for the project.
responsibleEmployee.address string The Address of the employee.
responsibleEmployee.barred boolean Shows if the employee is barred from being used.
responsibleEmployee.bookedInvoices object A link to the collection of booked invoices which has the employee as a reference.
responsibleEmployee.canApprove boolean Shows if the user can approve. Only for time logger profiles.
responsibleEmployee.canInvoice boolean Shows if the user can invoice. Only for project managers and time logger profiles.
responsibleEmployee.city string The City of the employee.
responsibleEmployee.costPriceAfter number Employee cost price after the cut-off date.
responsibleEmployee.costPriceBefore number Employee cost price before the cut-off date.
responsibleEmployee.customers object A link to the collection of customers which has the employee as a reference.
responsibleEmployee.cutoffDate string full-date The cut-off date for employee cost/sales prices.
responsibleEmployee.draftInvoices object A link to the collection of draft invoices which has the employee as a reference.
responsibleEmployee.email string The email address of the employee.
responsibleEmployee.employeeGroup object The group to which the employee belongs.
responsibleEmployee.employeeNumber integer The employee number is a unique numerical identifier with a maximum of 9 digits.
responsibleEmployee.employeeType object Employee type.
responsibleEmployee.initials string Userid of related user.
responsibleEmployee.name string The name of the employee.
responsibleEmployee.phone string The phone number of the employee.
responsibleEmployee.postCode string The PostCode of the employee.
responsibleEmployee.salesPriceAfter number Employee after price sales the cut-off date.
responsibleEmployee.salesPriceBefore number Employee sales price before the cut-off date.

Create Project

POST /project/projects

Return type

This method returns a single object

Properties

Name Type Description
barred boolean Shows if the project is barred from being used.
customer object The customer relating to the project.
customer.customerNumber integer The unique identifier of the customer.
defaultDeliveryLocation object The default delivery location for the project.
description string A description of the project.
group object The group to which the project belongs.
isClosed boolean Shows if the project is closed.
isMain boolean Shows if the project is a main project.
mileage number The mileage count for the project.
name string The descriptive name of the project.
parent object The parent project, if not a main project.
projectNumber integer A unique identifier of the project.
responsibleEmployee object The employee responsible for the project.

Update Project

PUT /project/projects/:projectNumber

Return type

This method returns a single object

Properties

Name Type Description
barred boolean Shows if the project is barred from being used.
customer object The customer relating to the project.
customer.customerNumber integer The unique identifier of the customer.
defaultDeliveryLocation object The default delivery location for the project.
description string A description of the project.
group object The group to which the project belongs.
isClosed boolean Shows if the project is closed.
isMain boolean Shows if the project is a main project.
mileage number The mileage count for the project.
name string The descriptive name of the project.
parent object The parent project, if not a main project.
projectNumber integer A unique identifier of the project.
responsibleEmployee object The employee responsible for the project.

Get Project Cost types

GET /project/cost-types

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Description
costTypeNumber integer A unique identifier of the cost type.
group object The group to which the project belongs.
group.accountClosed object The account used for closed project costs in this group.
group.accountOngoing object The account used for ongoing project costs in this group.
group.name string The descriptive name of the project cost group.
group.projectCostGroupNumber integer The unique identifier of the project cost group.
name string The descriptive name of the cost type.
vatAccount object The vat account for the cost type.
vatAccount.account object The account of the vat account.
vatAccount.barred boolean A boolean indicating if the vat account is barred from being used.
vatAccount.contraAccount object The contra account of the vat account.
vatAccount.exemptVatCode object The exempt vat code of the vat account.
vatAccount.extraRatePercentage number In some cases vat accounts has an extra rate that should be applied on top of the normal rate.
vatAccount.name string The name of the vat account.
vatAccount.nonDeductibleRate number Percentage of the vat rate that is not deductible.
vatAccount.ratePercentage number The vat rate of the vat account.
vatAccount.vatCode string The vat code of the vat account.
vatAccount.vatReportSetup object The VAT rate type used for reporting.
vatAccount.vatType object The type of the vat account.

Get specific Cost type

GET /project/cost-types/:costTypeNumber

Return type

This method returns a single object

Properties

Name Type Description
costTypeNumber integer A unique identifier of the cost type.
group object The group to which the project belongs.
group.accountClosed object The account used for closed project costs in this group.
group.accountOngoing object The account used for ongoing project costs in this group.
group.name string The descriptive name of the project cost group.
group.projectCostGroupNumber integer The unique identifier of the project cost group.
name string The descriptive name of the cost type.
vatAccount object The vat account for the cost type.
vatAccount.account object The account of the vat account.
vatAccount.barred boolean A boolean indicating if the vat account is barred from being used.
vatAccount.contraAccount object The contra account of the vat account.
vatAccount.exemptVatCode object The exempt vat code of the vat account.
vatAccount.extraRatePercentage number In some cases vat accounts has an extra rate that should be applied on top of the normal rate.
vatAccount.name string The name of the vat account.
vatAccount.nonDeductibleRate number Percentage of the vat rate that is not deductible.
vatAccount.ratePercentage number The vat rate of the vat account.
vatAccount.vatCode string The vat code of the vat account.
vatAccount.vatReportSetup object The VAT rate type used for reporting.
vatAccount.vatType object The type of the vat account.

Provinces

Get Provinces

GET /provinces

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Description
code string Alphanumeric identifying code.
countryCode object Country Code of the province’s country.
countryCode.code string The 2 letter code for the country.
name string Province’s name.
provinceNumber integer Numeric value that identifies the province within the country.

Get Provinces by Country Code

GET /provinces/:countryCode

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Description
code string Alphanumeric identifying code.
countryCode object Country Code of the province’s country.
countryCode.code string The 2 letter code for the country.
name string Province’s name.
provinceNumber integer Numeric value that identifies the province within the country.

Get specific Province

GET /provinces/:countryCode/:provinceNumber

Return type

This method returns a single object

Properties

Name Type Description
code string Alphanumeric identifying code.
countryCode object Country Code of the province’s country.
countryCode.code string The 2 letter code for the country.
name string Province’s name.
provinceNumber integer Numeric value that identifies the province within the country.

Quotations

Get Quotations

GET /quotations

View response example

Note: additional expenses are not yet supported on quotations

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Read-only Values Description
additionalExpenseLines object A list of additional expense lines
additionalExpenseLines.additionalExpense object The additional expense used on the line
additionalExpenseLines.amount number Additional expense amount
additionalExpenseLines.lineNumber integer Line number
additionalExpenseLines.vatAccount object VAT account (if different from additional expense)
additionalExpenseLines.vatAmount number VAT amount
bankAccount object Bank Account
bankAccount.accountNumber integer The number of the account
bankAccount.name string True The name of the account.
costPriceInBaseCurrency number True The total cost of the items on the sales document in the base currency of the agreement.
currency string The ISO 4217 currency code of the sales document.
customer object The customer on the sales document.
customer.customerNumber integer The unique identifier of the customer.
customer.name string The customer name.
date string full-date Sales document issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the sales document. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
delivery.address string Street address where the goods must be delivered to the customer.
delivery.city string The city of the place of delivery.
delivery.country string The country of the place of delivery.
delivery.county string The county of the place of delivery.
delivery.deliveryDate string full-date The date of delivery.
delivery.deliveryTerms string Details about the terms of delivery.
delivery.zip string The zip code of the place of delivery.
deliveryDetails object Details about the delivery. Used for printing delivery notes etc.
deliveryDetails.carrierInfo object Details about the carrier.
deliveryDetails.deliveryNoteNumber integer Delivery note number.
deliveryDetails.deliveryNoteNumberSeries object Delivery note number series.
deliveryDetails.deliveryNoteNumberSeries.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
deliveryDetails.deliveryStartDateTime string full-date Date and time (in UTC) the delivery started.
deliveryDetails.descriptionOfPackages string Verbal description of the packages.
deliveryDetails.numberOfPackages integer Number of packages in the delivery.
deliveryDetails.reasonForDelivery string The reason for delivery.
deliveryLocation object A reference to the place of delivery for the goods on the sales document.
deliveryLocation.address string The address of the delivery location.
deliveryLocation.barred boolean Whether the delivery location is barred.
deliveryLocation.city string The city of the delivery location.
deliveryLocation.country string The country of the delivery location.
deliveryLocation.county string The county of the delivery location.
deliveryLocation.deliveryLocationNumber integer A unique identifier for the delivery location.
deliveryLocation.electronicInvoicingOfficeCode string The office code used for electronic invoicing.
deliveryLocation.externalId string The external id.
deliveryLocation.postalCode string The zip code of the delivery location.
deliveryLocation.terms string The terms applying to the delivery location.
dueDate string full-date The date the sales document is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type ‘duedate’.
exchangeRate number The exchange rate between the sales document currency and the base currency of the agreement. The exchange rate expresses how much it will cost in base currency to buy 100 units of the order currency.
grossAmount number The total sales document amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
id integer A reference number for the sales document.
isArchived boolean Boolean indication of whether the sales document is archived.
isSent boolean Boolean indication of whether the sales document is sent.
layout object The layout used for the document.
layout.deleted boolean A boolean indicating the deletion status of the layout.
layout.isDefault boolean True if the layout is the default selected by the user. This property is read only.
layout.layoutNumber integer The unique identifier of the layout.
layout.name string The descriptive name of the layout.
lines object An array containing the specific sales document lines.
lines.accruals object The start and end date of accruals
lines.deliveredQuantity number The delivered quantity.
lines.deliveryDate string full-date The delivery date.
lines.departmentalDistribution object The departmental distribution used by the line.
lines.departmentalDistribution.distributionType object Distribution, Department
lines.description string The description of the line.
lines.discountPercentage number The discount percentage.
lines.lineNumber integer The line number.
lines.manuallyEditedSalesPrice boolean Indicated if sales price on line was manually edited
lines.marginInBaseCurrency number The margin in the base currency of the agreement.
lines.marginPercentage number The margin percentage.
lines.product object The product.
lines.quantity number The quantity.
lines.sortKey integer The sort key.
lines.totalNetAmount number The total net amount.
lines.unit object The unit.
lines.unitCostPrice number The unit cost price.
lines.unitNetPrice number The unit net price.
locks object Locks that does not allow document to be modified
locks.description string Description of lock
locks.lockType integer Type number of the lock
locks.salesDocumentDraftNumber integer Sales Document number which is locked by this lock
marginInBaseCurrency number The difference between the net price and the cost price on the sales document line in base currency.
marginPercentage number The margin on the sales document line expressed as a percentage.
netAmount number The total sales document amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total sales document amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the sales document.
notes.heading string The order heading. Usually displayed at the top of the order.
notes.text1 string The first line of supplementary text on the order. This is usually displayed right under the heading in a smaller font.
notes.text2 string The second line of supplementary text in the notes on the order. This is usually displayed as a footer on the order.
number integer The number of the workflow - quotation - order - draft invoice
numberSeries object The number series used for the sales document.
numberSeries.allowGaps boolean A boolean value, indicating if gaps are allowed between the entry numbers.
numberSeries.entrySubtype object The entry sub type of the number series.
numberSeries.entrySubtype.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote Type of the entry.
numberSeries.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
numberSeries.isOrdered boolean A boolean value, indicating if the number series is an ordered number series. If left out, it means that the number series is not ordered
numberSeries.name string The name of the number series.
numberSeries.numberSeriesNumber integer The number of the number series
numberSeries.peeks object An array of peek values for the number series.
numberSeries.prefix string The prefix for the number series.
numberSeries.systemGenerated boolean A boolean value, indicating if the number series is generated by the system.
paymentLines object An array containing the payment lines splitting the payment into multiple due dates. These can only be used if you have the feature.
paymentLines.amount number
paymentLines.dueDate string full-date
paymentLines.lineNumber integer
paymentTerms object The terms of payment for the sales document.
paymentTerms.paymentTermsNumber integer A unique identifier of the payment term.
paymentType object A type description how the payment should be executed
paymentType.fields object List of the payment type’s fields.
paymentType.fields.dataType object String, Integer Data type of the payment type field.
paymentType.name string Payment type’s name.
paymentType.paymentTypeNumber integer Unique identifier of the payment type.
pdf object References a pdf representation of this sales document.
pdf.download object The unique reference of the pdf representation for this order.
priceList object A price list that is used for product prices
priceList.name string Price list’s name.
priceList.number integer Unique identifier of the price list.
project object References the project this sales document belongs to.
project.projectNumber integer A unique identifier of the project.
recipient object The actual recipient of the sales document. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
recipient.address string The street address of the actual recipient.
recipient.attention object The person to whom this order is addressed.
recipient.attention.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
recipient.city string The city of the actual recipient.
recipient.country string The country of the actual recipient.
recipient.county string The county of the actual recipient.
recipient.ean string The 'International Article Number’ of the actual recipient.
recipient.name string The name of the actual recipient.
recipient.publicEntryNumber string The public entry number of the actual recipient.
recipient.vatZone object Recipient vat zone.
recipient.zip string The zip code of the actual recipient.
references object Customer and company references related to this sales document.
references.customerContact object The customer contact is a reference to the employee at the customer to contact regarding the order.
references.customerContact.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
references.other string A text field that can be used to save any custom reference on the order.
references.primarySalesPerson object The sales person is a reference to the employee who sold the goods on the order. This is also the person who is credited with this sale in reports.
references.secondarySalesPerson object A reference to any second employee involved in the sale.
roundingAmount number The total rounding error, if any, on the sales document in base currency.
tenderContract object The tender contract used for the sales document.
tenderContract.cig string Public administration tender reference number.
tenderContract.cup string Public administration project reference.
tenderContract.customerNumber integer Customer’s reference.
tenderContract.description string Custom description.
tenderContract.documentNumber string Document number.
tenderContract.tenderContractNumber integer Unique identifier of the contract.
tenderContract.type object Contract, Convention
vatAccount object References the VAT account overriding VAT on all lines.
vatAccount.vatCode string The vat code of the vat account.
vatAmount number The total amount of VAT on the sales document in the currency. This will have the same sign as net amount.
vatIncluded boolean If VatMatrix is not enabled this flag will tell that vat should be calculated for this invoice. If VatMatrix is enabled this flag is readonly.
voucher object The voucher related to the invoice
voucher.booked boolean
voucher.date string full-date
voucher.externalDocumentId string
voucher.voucherId integer
voucher.voucherNumber object
voucher.voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote

Get specific Quotation

GET /quotations/:quotationNumber

Return type

This method returns a single object

Properties

Name Type Format Read-only Values Description
additionalExpenseLines object A list of additional expense lines
additionalExpenseLines.additionalExpense object The additional expense used on the line
additionalExpenseLines.amount number Additional expense amount
additionalExpenseLines.lineNumber integer Line number
additionalExpenseLines.vatAccount object VAT account (if different from additional expense)
additionalExpenseLines.vatAmount number VAT amount
bankAccount object Bank Account
bankAccount.accountNumber integer The number of the account
bankAccount.name string True The name of the account.
costPriceInBaseCurrency number True The total cost of the items on the sales document in the base currency of the agreement.
currency string The ISO 4217 currency code of the sales document.
customer object The customer on the sales document.
customer.customerNumber integer The unique identifier of the customer.
customer.name string The customer name.
date string full-date Sales document issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the sales document. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
delivery.address string Street address where the goods must be delivered to the customer.
delivery.city string The city of the place of delivery.
delivery.country string The country of the place of delivery.
delivery.county string The county of the place of delivery.
delivery.deliveryDate string full-date The date of delivery.
delivery.deliveryTerms string Details about the terms of delivery.
delivery.zip string The zip code of the place of delivery.
deliveryDetails object Details about the delivery. Used for printing delivery notes etc.
deliveryDetails.carrierInfo object Details about the carrier.
deliveryDetails.deliveryNoteNumber integer Delivery note number.
deliveryDetails.deliveryNoteNumberSeries object Delivery note number series.
deliveryDetails.deliveryNoteNumberSeries.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
deliveryDetails.deliveryStartDateTime string full-date Date and time (in UTC) the delivery started.
deliveryDetails.descriptionOfPackages string Verbal description of the packages.
deliveryDetails.numberOfPackages integer Number of packages in the delivery.
deliveryDetails.reasonForDelivery string The reason for delivery.
deliveryLocation object A reference to the place of delivery for the goods on the sales document.
deliveryLocation.address string The address of the delivery location.
deliveryLocation.barred boolean Whether the delivery location is barred.
deliveryLocation.city string The city of the delivery location.
deliveryLocation.country string The country of the delivery location.
deliveryLocation.county string The county of the delivery location.
deliveryLocation.deliveryLocationNumber integer A unique identifier for the delivery location.
deliveryLocation.electronicInvoicingOfficeCode string The office code used for electronic invoicing.
deliveryLocation.externalId string The external id.
deliveryLocation.postalCode string The zip code of the delivery location.
deliveryLocation.terms string The terms applying to the delivery location.
dueDate string full-date The date the sales document is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type 'duedate’.
exchangeRate number The exchange rate between the sales document currency and the base currency of the agreement. The exchange rate expresses how much it will cost in base currency to buy 100 units of the order currency.
grossAmount number The total sales document amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
id integer A reference number for the sales document.
isArchived boolean Boolean indication of whether the sales document is archived.
isSent boolean Boolean indication of whether the sales document is sent.
layout object The layout used for the document.
layout.deleted boolean A boolean indicating the deletion status of the layout.
layout.isDefault boolean True if the layout is the default selected by the user. This property is read only.
layout.layoutNumber integer The unique identifier of the layout.
layout.name string The descriptive name of the layout.
lines object An array containing the specific sales document lines.
lines.accruals object The start and end date of accruals
lines.deliveredQuantity number The delivered quantity.
lines.deliveryDate string full-date The delivery date.
lines.departmentalDistribution object The departmental distribution used by the line.
lines.departmentalDistribution.distributionType object Distribution, Department
lines.description string The description of the line.
lines.discountPercentage number The discount percentage.
lines.lineNumber integer The line number.
lines.manuallyEditedSalesPrice boolean Indicated if sales price on line was manually edited
lines.marginInBaseCurrency number The margin in the base currency of the agreement.
lines.marginPercentage number The margin percentage.
lines.product object The product.
lines.quantity number The quantity.
lines.sortKey integer The sort key.
lines.totalNetAmount number The total net amount.
lines.unit object The unit.
lines.unitCostPrice number The unit cost price.
lines.unitNetPrice number The unit net price.
locks object Locks that does not allow document to be modified
locks.description string Description of lock
locks.lockType integer Type number of the lock
locks.salesDocumentDraftNumber integer Sales Document number which is locked by this lock
marginInBaseCurrency number The difference between the net price and the cost price on the sales document line in base currency.
marginPercentage number The margin on the sales document line expressed as a percentage.
netAmount number The total sales document amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total sales document amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the sales document.
notes.heading string The order heading. Usually displayed at the top of the order.
notes.text1 string The first line of supplementary text on the order. This is usually displayed right under the heading in a smaller font.
notes.text2 string The second line of supplementary text in the notes on the order. This is usually displayed as a footer on the order.
number integer The number of the workflow - quotation - order - draft invoice
numberSeries object The number series used for the sales document.
numberSeries.allowGaps boolean A boolean value, indicating if gaps are allowed between the entry numbers.
numberSeries.entrySubtype object The entry sub type of the number series.
numberSeries.entrySubtype.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote Type of the entry.
numberSeries.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
numberSeries.isOrdered boolean A boolean value, indicating if the number series is an ordered number series. If left out, it means that the number series is not ordered
numberSeries.name string The name of the number series.
numberSeries.numberSeriesNumber integer The number of the number series
numberSeries.peeks object An array of peek values for the number series.
numberSeries.prefix string The prefix for the number series.
numberSeries.systemGenerated boolean A boolean value, indicating if the number series is generated by the system.
paymentLines object An array containing the payment lines splitting the payment into multiple due dates. These can only be used if you have the feature.
paymentLines.amount number
paymentLines.dueDate string full-date
paymentLines.lineNumber integer
paymentTerms object The terms of payment for the sales document.
paymentTerms.paymentTermsNumber integer A unique identifier of the payment term.
paymentType object A type description how the payment should be executed
paymentType.fields object List of the payment type’s fields.
paymentType.fields.dataType object String, Integer Data type of the payment type field.
paymentType.name string Payment type’s name.
paymentType.paymentTypeNumber integer Unique identifier of the payment type.
pdf object References a pdf representation of this sales document.
pdf.download object The unique reference of the pdf representation for this order.
priceList object A price list that is used for product prices
priceList.name string Price list’s name.
priceList.number integer Unique identifier of the price list.
project object References the project this sales document belongs to.
project.projectNumber integer A unique identifier of the project.
recipient object The actual recipient of the sales document. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
recipient.address string The street address of the actual recipient.
recipient.attention object The person to whom this order is addressed.
recipient.attention.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
recipient.city string The city of the actual recipient.
recipient.country string The country of the actual recipient.
recipient.county string The county of the actual recipient.
recipient.ean string The 'International Article Number’ of the actual recipient.
recipient.name string The name of the actual recipient.
recipient.publicEntryNumber string The public entry number of the actual recipient.
recipient.vatZone object Recipient vat zone.
recipient.zip string The zip code of the actual recipient.
references object Customer and company references related to this sales document.
references.customerContact object The customer contact is a reference to the employee at the customer to contact regarding the order.
references.customerContact.emailNotifications object This array specifies what events the contact person should recieve email notifications on. Note that limited plans only have access to invoice notifications.
references.other string A text field that can be used to save any custom reference on the order.
references.primarySalesPerson object The sales person is a reference to the employee who sold the goods on the order. This is also the person who is credited with this sale in reports.
references.secondarySalesPerson object A reference to any second employee involved in the sale.
roundingAmount number The total rounding error, if any, on the sales document in base currency.
tenderContract object The tender contract used for the sales document.
tenderContract.cig string Public administration tender reference number.
tenderContract.cup string Public administration project reference.
tenderContract.customerNumber integer Customer’s reference.
tenderContract.description string Custom description.
tenderContract.documentNumber string Document number.
tenderContract.tenderContractNumber integer Unique identifier of the contract.
tenderContract.type object Contract, Convention
vatAccount object References the VAT account overriding VAT on all lines.
vatAccount.vatCode string The vat code of the vat account.
vatAmount number The total amount of VAT on the sales document in the currency. This will have the same sign as net amount.
vatIncluded boolean If VatMatrix is not enabled this flag will tell that vat should be calculated for this invoice. If VatMatrix is enabled this flag is readonly.
voucher object The voucher related to the invoice
voucher.booked boolean
voucher.date string full-date
voucher.externalDocumentId string
voucher.voucherId integer
voucher.voucherNumber object
voucher.voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote

Create Quotation

POST /quotations

Return type

This method returns a single object

Properties

Name Type Format Description
additionalExpenseLines object A list of additional expense lines
bankAccount object Bank Account
currency string The ISO 4217 currency code of the sales document.
customer object The customer on the sales document.
customer.customerNumber integer The unique identifier of the customer.
date string full-date Sales document issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the sales document. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
deliveryDetails object Details about the delivery. Used for printing delivery notes etc.
deliveryLocation object A reference to the place of delivery for the goods on the sales document.
dueDate string full-date The date the sales document is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type 'duedate’.
exchangeRate number The exchange rate between the sales document currency and the base currency of the agreement. The exchange rate expresses how much it will cost in base currency to buy 100 units of the order currency.
grossAmount number The total sales document amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
id integer A reference number for the sales document.
isArchived boolean Boolean indication of whether the sales document is archived.
isSent boolean Boolean indication of whether the sales document is sent.
layout object The layout used for the document.
lines object An array containing the specific sales document lines.
locks object Locks that does not allow document to be modified
marginInBaseCurrency number The difference between the net price and the cost price on the sales document line in base currency.
marginPercentage number The margin on the sales document line expressed as a percentage.
netAmount number The total sales document amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total sales document amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the sales document.
number integer The number of the workflow - quotation - order - draft invoice
numberSeries object The number series used for the sales document.
paymentLines object An array containing the payment lines splitting the payment into multiple due dates. These can only be used if you have the feature.
paymentTerms object The terms of payment for the sales document.
paymentType object A type description how the payment should be executed
pdf object References a pdf representation of this sales document.
priceList object A price list that is used for product prices
project object References the project this sales document belongs to.
recipient object The actual recipient of the sales document. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
references object Customer and company references related to this sales document.
roundingAmount number The total rounding error, if any, on the sales document in base currency.
tenderContract object The tender contract used for the sales document.
vatAccount object References the VAT account overriding VAT on all lines.
vatAmount number The total amount of VAT on the sales document in the currency. This will have the same sign as net amount.
vatIncluded boolean If VatMatrix is not enabled this flag will tell that vat should be calculated for this invoice. If VatMatrix is enabled this flag is readonly.
voucher object The voucher related to the invoice

Update Quotation

PUT /quotations/:quotationNumber

Return type

This method returns a single object

Properties

Name Type Format Description
additionalExpenseLines object A list of additional expense lines
bankAccount object Bank Account
currency string The ISO 4217 currency code of the sales document.
customer object The customer on the sales document.
customer.customerNumber integer The unique identifier of the customer.
date string full-date Sales document issue date. The date is formatted according to ISO-8601.
delivery object The actual place of delivery for the goods on the sales document. This is usually the same place as the one referenced in the deliveryLocation property, but may be edited as required.
deliveryDetails object Details about the delivery. Used for printing delivery notes etc.
deliveryLocation object A reference to the place of delivery for the goods on the sales document.
dueDate string full-date The date the sales document is due for payment. Format: YYYY-MM-DD. This is only used if the terms of payment is of type 'duedate’.
exchangeRate number The exchange rate between the sales document currency and the base currency of the agreement. The exchange rate expresses how much it will cost in base currency to buy 100 units of the order currency.
grossAmount number The total sales document amount in the currency after all taxes and discounts have been applied. For a credit note this amount will be negative.
id integer A reference number for the sales document.
isArchived boolean Boolean indication of whether the sales document is archived.
isSent boolean Boolean indication of whether the sales document is sent.
layout object The layout used for the document.
lines object An array containing the specific sales document lines.
locks object Locks that does not allow document to be modified
marginInBaseCurrency number The difference between the net price and the cost price on the sales document line in base currency.
marginPercentage number The margin on the sales document line expressed as a percentage.
netAmount number The total sales document amount in the currency before all taxes and discounts have been applied. For a credit note this amount will be negative.
netAmountInBaseCurrency number The total sales document amount in the base currency of the agreement before all taxes and discounts have been applied. For a credit note this amount will be negative.
notes object Notes on the sales document.
number integer The number of the workflow - quotation - order - draft invoice
numberSeries object The number series used for the sales document.
paymentLines object An array containing the payment lines splitting the payment into multiple due dates. These can only be used if you have the feature.
paymentTerms object The terms of payment for the sales document.
paymentType object A type description how the payment should be executed
pdf object References a pdf representation of this sales document.
priceList object A price list that is used for product prices
project object References the project this sales document belongs to.
recipient object The actual recipient of the sales document. This may be the same info found on the customer (and will probably be so in most cases) but it may also be a different recipient. For instance, the customer placing the order may be ACME Headquarters, but the recipient of the order may be ACME IT.
references object Customer and company references related to this sales document.
roundingAmount number The total rounding error, if any, on the sales document in base currency.
tenderContract object The tender contract used for the sales document.
vatAccount object References the VAT account overriding VAT on all lines.
vatAmount number The total amount of VAT on the sales document in the currency. This will have the same sign as net amount.
vatIncluded boolean If VatMatrix is not enabled this flag will tell that vat should be calculated for this invoice. If VatMatrix is enabled this flag is readonly.
voucher object The voucher related to the invoice

Delete Quotation

DELETE /quotations

Return type

This method returns a single object

Properties

Name Type Description
id integer A reference number for the sales document.

Attach PDF to Quotation

POST /quotations/:quotationNumber/attachment

Notes
Example request
curl --request POST \
  --url https://rest.reviso.com/quotations/10/attachment \
  --header 'X-AgreementGrantToken: your_agreement_grant_token' \
  --header 'X-AppSecretToken: your_app_secret_token' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form '=@C:\path\to\your\file\file_name.pdf'

Delete PDF attachment

DELETE /quotations/:quotationNumber/attachment

Report Api

Report Api are data tailored for the generation of reports. To ensure faster response times, self links and other links to resources are not included in this Api.

As there is no paging in these Api endpoints, take care to scope queries accordingly.

All parameters are sent in the querystring of the request, and are optional.

Get Finance Entries

Retrieves a list of finance entries.

GET /report-api/v1/entries GET /report-api/v1/entries/booked

Properties

Name Type Description
FromDate Date Filter for the booking date
ToDate Date Filter for the booking date

View response example

Get Customer Entries

Retrieves a list of finance entries booked on customers.

GET /report-api/v1/customer-entries GET /report-api/v1/customer-entries/booked

Properties

Name Type Description
FromDate Date Filter for the booking date
ToDate Date Filter for the booking date
FromCustomerNumber int Filter for the customer number
ToCustomerNumber int Filter for the customer number
FromCustomerGroup int Filter for the customer group
ToCustomerGroup int Filter for the customer group

View response example

Get Supplier Entries

Retrieves a list of finance entries booked on suppliers.

GET /report-api/v1/supplier-entries GET /report-api/v1/supplier-entries/booked

Properties

Name Type Description
FromDate Date Filter for the booking date
ToDate Date Filter for the booking date
FromSupplierNumber int Filter for the supplier number
ToSupplierNumber int Filter for the supplier number
FromSupplierGroup int Filter for the supplier group
ToSupplierGroup int Filter for the supplier group

View response example

Get Finance Movements

For each finance account, returns the amount that has been debited and credited.

GET /report-api/v1/finance-movements GET /report-api/v1/finance-movements/booked

Properties

Name Type Description
FromDate Date Filter for the booking date
ToDate Date Filter for the booking date
FromAccount int Filter for the account number
ToAccount int Filter for the account number

View response example

Get Customer Movements

Returns the amount that has been debited and credited for each customer.

GET /report-api/v1/customer-movements GET /report-api/v1/customer-movements/booked

Properties

Name Type Description
FromDate Date Filter for the booking date
ToDate Date Filter for the booking date
FromCustomerNumber int Filter for the customer number
ToCustomerNumber int Filter for the customer number
FromCustomerGroup int Filter for the customer group
ToCustomerGroup int Filter for the customer group

View response example

Get Supplier Movements

Returns the amount that has been debited and credited for each supplier.

GET /report-api/v1/supplier-movements GET /report-api/v1/supplier-movements/booked

Properties

Name Type Description
FromDate Date Filter for the booking date
ToDate Date Filter for the booking date
FromSupplierNumber int Filter for the supplier number
ToSupplierNumber int Filter for the supplier number
FromSupplierGroup int Filter for the supplier group
ToSupplierGroup int Filter for the supplier group

View response example

Get Finance Balances

For each finance account, returns the balance on the account on a given date.

GET /report-api/v1/finance-balances GET /report-api/v1/finance-balances/booked

Properties

Name Type Description
AsOf Date The date for which to get the balance. Defaults to todays date.
ExcludeDate bool If true, entries on the AsOf date are not included in the balance.
FromAccount int Filter for the account number
ToAccount int Filter for the account number

View response example

Get Customer Balances

For each customer, returns the balance on a given date.

GET /report-api/v1/customer-balances GET /report-api/v1/customer-balances/booked

Properties

Name Type Description
AsOf Date The date for which to get the balance. Defaults to todays date.
ExcludeDate bool If true, entries on the AsOf date are not included in the balance.
FromCustomerNumber int Filter for the customer number
ToCustomerNumber int Filter for the customer number
FromCustomerGroup int Filter for the customer group
ToCustomerGroup int Filter for the customer group

View response example

Get Supplier Balances

For each supplier, returns the balance on a given date.

GET /report-api/v1/supplier-balances GET /report-api/v1/supplier-balances/booked

Properties

Name Type Description
AsOf Date The date for which to get the balance. Defaults to todays date.
ExcludeDate bool If true, entries on the AsOf date are not included in the balance.
FromSupplierNumber int Filter for the supplier number
ToSupplierNumber int Filter for the supplier number
FromSupplierGroup int Filter for the supplier group
ToSupplierGroup int Filter for the supplier group

View response example

Root

GET /

The entry point for the Reviso REST API. This is where the fun begins.

https://rest.reviso.com/?demo=true.

Self

Get information about current agreement

GET /self

Return type

This method returns a single object

Properties

Name Type Format Values Description
agreementNumber integer The agreement number.
agreementType object The agreement type.
agreementType.agreementTypeNumber integer
agreementType.name object Denmark, Norway, Sweden, COM, EU, UK, Germany, Spain, Poland, Finland, France, Italy, ItalyEasyfatt
application object The Reviso app bound to the agreement.
application.appNumber integer
application.appPublicToken string
application.name string
bankInformation object The company bank informations.
bankInformation.altinnEnterpriseSystemId string
bankInformation.amtsgericht string
bankInformation.aufsichtsratsvorsitzende string
bankInformation.bankAccountNumber string
bankInformation.bankGiroNumber string
bankInformation.bankgirotCustomerNumber string
bankInformation.bankName string
bankInformation.bankSortCode string
bankInformation.eanLocationNumber string
bankInformation.finanzAmt string
bankInformation.geschaftsfuhrer string
bankInformation.giro string
bankInformation.handelsRegisterEintrag string
bankInformation.ibanNumber string
bankInformation.pbsCustomerGroupNumber string
bankInformation.pbsFiSupplierNumber string
bankInformation.pbsNumber string
bankInformation.plusGiroNumber string
bankInformation.swiftCode string
company object The company bound to the agreement.
company.addressLine1 string The first line of the company address.
company.addressLine2 string The second line of the company address.
company.attention string The company contact name.
company.city string The company city.
company.companyIdentificationNumber string The company unique identifier.
company.country string The company country.
company.countryCode string The company country code.
company.county string The company county or province.
company.email string The company email.
company.faxNumber string The company fax number.
company.industrialClassification object The company industrial classification.
company.mobileNumber string The company mobile number.
company.name string The company name.
company.phoneNumber string The company phone number.
company.vatNumber string The company Vat number.
company.website string The company website.
company.zip string The company zip code.
companyAffiliation string The company affiliation.
creatorApplication string The name of the application that created this agreement
isAdminAgreement boolean Indicates whether the agreement is an admin agreement.
isAdminImpersonatingAgreement boolean Indicates whether the current agreement is being impersonated by an admin agreement.
modules object The list of modules available with the agreement.
modules.moduleNumber integer
modules.name string
name string
settings object The settings of the agreement.
settings.baseCurrency string
settings.internationalLedger boolean
settings.vatReportingFrequency object Monthly, Quarterly
setupId integer Agreement’s inner id that is used for storing accounting data
signupDate string full-date The signup date.
status object
status.deregistrationDate string full-date
status.isBarred boolean
status.isMarkedForDeletion boolean
status.isTrial boolean
status.trialExpiryDate string full-date
subscriptionInfo object The subscription information for the agreement
subscriptionInfo.packageId integer The id of the package.
subscriptionInfo.standardSetup integer Applied standard setup.
subscriptionInfo.trialMaster integer Applied trial master.
user object The current logged user.
user.dateFormat string
user.dateTimeFormat string
user.email string
user.employeeID integer
user.hasAccessToUI boolean
user.isSuperUser boolean
user.language object
user.loginId string
user.name string
user.numberFormat object
userName string The username of the current logged user.

View response example

View code example

Get Company data

GET /self/company

Return type

This method returns a single object

Properties

Name Type Description
addressLine1 string The first line of the company address.
addressLine2 string The second line of the company address.
attention string The company contact name.
city string The company city.
companyIdentificationNumber string The company unique identifier.
country string The company country.
countryCode string The company country code.
county string The company county or province.
email string The company email.
faxNumber string The company fax number.
industrialClassification object The company industrial classification.
industrialClassification.classification string
industrialClassification.classificationClass string
industrialClassification.classificationDivision string
industrialClassification.classificationGroup string
industrialClassification.classificationSection string
industrialClassification.countryCode string
industrialClassification.description string
industrialClassification.heading boolean
industrialClassification.industrialClassificationNumber integer
mobileNumber string The company mobile number.
name string The company name.
phoneNumber string The company phone number.
vatNumber string The company Vat number.
website string The company website.
zip string The company zip code.

View response example

Update Company data

PUT /self/company

Return type

This method returns a single object

Properties

Name Type Description
addressLine1 string The first line of the company address.
addressLine2 string The second line of the company address.
attention string The company contact name.
city string The company city.
companyIdentificationNumber string The company unique identifier.
country string The company country.
countryCode string The company country code.
county string The company county or province.
email string The company email.
faxNumber string The company fax number.
industrialClassification object The company industrial classification.
mobileNumber string The company mobile number.
name string The company name.
phoneNumber string The company phone number.
vatNumber string The company Vat number.
website string The company website.
zip string The company zip code.

Supplier groups

Suppliers are organized in Supplier groups.

You can read more on our Online Help.

Get Supplier groups

GET /supplier-groups

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Read-only Values Description
account object Posting account of the supplier group.
account.accountCategory object The category of the account.
account.accountCategory.accountCategoryType object BalanceSheet, ProfitAndLoss Category type.
account.accountingYears object A link to a list of accounting years for which the account is usable.
account.accountNumber integer The number of the account
account.accountsSummed object True An array of the account intervals used for calculating the total for this account.
account.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
account.balance number True The current balance of the account.
account.barred boolean Used to bar the account from being used - default is false.
account.blockDirectEntries boolean Determines if the account can be manually updated with entries.
account.contraAccount object The default contra account of the account.
account.contraAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
account.contraAccount.debitCredit object Debit, Credit Describes the default update type of the account.
account.debitCredit object Debit, Credit Describes the default update type of the account.
account.department object Department associated with the account.
account.departmentalDistribution object Departmental distribution, used to split on more than one department.
account.departmentalDistribution.distributionType object Distribution, Department
account.displayNumber string String representation of the Account number, for display and sorting purposes.
account.name string True The name of the account.
account.openingAccount object The associted opening account.
account.openingAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
account.openingAccount.debitCredit object Debit, Credit Describes the default update type of the account.
account.requireDepartmentalDistributionOnEntries boolean Whether or not the departmental distribution is required on entries.
account.totalFromAccount object The account from which the sum total for this account is calculated.
account.totalFromAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
account.totalFromAccount.debitCredit object Debit, Credit Describes the default update type of the account.
account.vatAccount object The default VAT code for this account.
deduction object The deduction settings for the supplier group.
deduction.account object
deduction.basedOnAmountIncludingVat boolean
deduction.basedOnItems boolean
deduction.entryText string
deduction.ratePercentage number
hasInventoryWithdrawal boolean Whether or not the supplier should be available in the inventory module.
name string Name of the supplier group.
numberSeriesForSupplierInvoice object Number series used in the supplier
numberSeriesForSupplierInvoice.allowGaps boolean A boolean value, indicating if gaps are allowed between the entry numbers.
numberSeriesForSupplierInvoice.entrySubtype object The entry sub type of the number series.
numberSeriesForSupplierInvoice.entrySubtype.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote Type of the entry.
numberSeriesForSupplierInvoice.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
numberSeriesForSupplierInvoice.isOrdered boolean A boolean value, indicating if the number series is an ordered number series. If left out, it means that the number series is not ordered
numberSeriesForSupplierInvoice.name string The name of the number series.
numberSeriesForSupplierInvoice.numberSeriesNumber integer The number of the number series
numberSeriesForSupplierInvoice.peeks object An array of peek values for the number series.
numberSeriesForSupplierInvoice.prefix string The prefix for the number series.
numberSeriesForSupplierInvoice.systemGenerated boolean A boolean value, indicating if the number series is generated by the system.
supplierGroupNumber integer Unique identifier of the supplier group.
supplierGroupType object Professionals, Rentals Specifies the different types of Spanish supplier group types

Get specific Supplier group

GET /supplier-groups/:supplierGroupId

Return type

This method returns a single object

Properties

Name Type Read-only Values Description
account object Posting account of the supplier group.
account.accountCategory object The category of the account.
account.accountCategory.accountCategoryType object BalanceSheet, ProfitAndLoss Category type.
account.accountingYears object A link to a list of accounting years for which the account is usable.
account.accountNumber integer The number of the account
account.accountsSummed object True An array of the account intervals used for calculating the total for this account.
account.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
account.balance number True The current balance of the account.
account.barred boolean Used to bar the account from being used - default is false.
account.blockDirectEntries boolean Determines if the account can be manually updated with entries.
account.contraAccount object The default contra account of the account.
account.contraAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
account.contraAccount.debitCredit object Debit, Credit Describes the default update type of the account.
account.debitCredit object Debit, Credit Describes the default update type of the account.
account.department object Department associated with the account.
account.departmentalDistribution object Departmental distribution, used to split on more than one department.
account.departmentalDistribution.distributionType object Distribution, Department
account.displayNumber string String representation of the Account number, for display and sorting purposes.
account.name string True The name of the account.
account.openingAccount object The associted opening account.
account.openingAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
account.openingAccount.debitCredit object Debit, Credit Describes the default update type of the account.
account.requireDepartmentalDistributionOnEntries boolean Whether or not the departmental distribution is required on entries.
account.totalFromAccount object The account from which the sum total for this account is calculated.
account.totalFromAccount.accountType object ProfitAndLoss, Status, TotalFrom, Heading, HeadingStart, SumInterval, SumAlpha The type of account in the chart of accounts.
account.totalFromAccount.debitCredit object Debit, Credit Describes the default update type of the account.
account.vatAccount object The default VAT code for this account.
deduction object The deduction settings for the supplier group.
deduction.account object
deduction.basedOnAmountIncludingVat boolean
deduction.basedOnItems boolean
deduction.entryText string
deduction.ratePercentage number
hasInventoryWithdrawal boolean Whether or not the supplier should be available in the inventory module.
name string Name of the supplier group.
numberSeriesForSupplierInvoice object Number series used in the supplier
numberSeriesForSupplierInvoice.allowGaps boolean A boolean value, indicating if gaps are allowed between the entry numbers.
numberSeriesForSupplierInvoice.entrySubtype object The entry sub type of the number series.
numberSeriesForSupplierInvoice.entrySubtype.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote Type of the entry.
numberSeriesForSupplierInvoice.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
numberSeriesForSupplierInvoice.isOrdered boolean A boolean value, indicating if the number series is an ordered number series. If left out, it means that the number series is not ordered
numberSeriesForSupplierInvoice.name string The name of the number series.
numberSeriesForSupplierInvoice.numberSeriesNumber integer The number of the number series
numberSeriesForSupplierInvoice.peeks object An array of peek values for the number series.
numberSeriesForSupplierInvoice.prefix string The prefix for the number series.
numberSeriesForSupplierInvoice.systemGenerated boolean A boolean value, indicating if the number series is generated by the system.
supplierGroupNumber integer Unique identifier of the supplier group.
supplierGroupType object Professionals, Rentals Specifies the different types of Spanish supplier group types

Create Supplier group

POST /supplier-groups

Return type

This method returns a single object

Required properties

account, name, supplierGroupNumber

Properties

Name Type Values Description
account object Posting account of the supplier group.
deduction object The deduction settings for the supplier group.
hasInventoryWithdrawal boolean Whether or not the supplier should be available in the inventory module.
name string Name of the supplier group.
numberSeriesForSupplierInvoice object Number series used in the supplier
supplierGroupNumber integer Unique identifier of the supplier group.
supplierGroupType object Professionals, Rentals Specifies the different types of Spanish supplier group types

Suppliers

Suppliers are the vendors from whom you buy your goods.

For more information please look at the Online Help.

Get Suppliers

GET /suppliers

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Read-only Values Description
address string Address for the supplier including street and number.
attention object Optional contact person at the supplier.
attention.supplierContactNumber integer
bankAccount string The suppliers bank account.
barred boolean Boolean indication of whether the supplier is barred.
city string The supplier’s city.
contacts object Links to the collect
corporateIdentificationNumber string Company Identification Number. For example CVR in Denmark.
costAccount object Cost account to be used for the supplier.
costAccount.accountNumber integer The number of the account
costAccount.name string True The name of the account.
country string The supplier’s country.
countryCode object The supplier’s country identification code.
countryCode.code string The 2 letter code for the country.
county string The supplier’s county. This property is only valid for UK agreements. It will be ignored for all other countries.
currency string Default currency used when purchasing from the supplier.
defaultInvoiceText string The supplier default invoice text.
defaultVoucherTemplate object The default voucher template for the supplier.
defaultVoucherTemplate.voucherTemplateNumber integer The unique identifier of the voucher template.
email string The supplier’s e-mail address. Note: you can specify multiple email addresses in this field, separated by a space.
layout object Layout that will be used for documents generated in relation to this supplier.
layout.deleted boolean A boolean indicating the deletion status of the layout.
layout.isDefault boolean True if the layout is the default selected by the user. This property is read only.
layout.layoutNumber integer The unique identifier of the layout.
layout.name string The descriptive name of the layout.
name string The supplier name.
paymentTerms object The default payment terms for the supplier.
paymentTerms.barred boolean If this payment term is accessible.
paymentTerms.cashDiscountAccount object The cash discount account.
paymentTerms.cashDiscountDayLimit integer The cash discount day limit.
paymentTerms.cashDiscountRate number The cash discount rate.
paymentTerms.contraAccountForPrepaidAmount object The contra account. Used for PaidInCash and Factoring only.
paymentTerms.contraAccountForRemainderAmount object The contra account for the remainder amount. Used for Factoring only.
paymentTerms.creditCardCompany object The credit card company. Used for type CreditCard only.
paymentTerms.creditCardCompany.italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
paymentTerms.daysOfCredit integer The number of days of credit on the order. This field is only valid if terms of payment is not of type ‘duedate’.
paymentTerms.description string The description of the payment term.
paymentTerms.name string The name of the payment terms.
paymentTerms.numberSeriesForCustomerPayment object The number series to use for creating customer payment vouchers. Used for paidInCash or creditcard type only.
paymentTerms.numberSeriesForCustomerPayment.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
paymentTerms.paymentTermsNumber integer A unique identifier of the payment term.
paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.percentageForPrepaidAmount number The percentage for prepaid amount. Used for Factoring only.
paymentTerms.percentageForRemainderAmount number The percentage for the remainder amount. Used for Factoring only.
paymentTerms.timetablePaymentTemplate object The timetable payment template. Used for Timetable only.
paymentTerms.timetablePaymentTemplate.lines object An array containing the timetable pament template lines.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms object The payment term for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.timetablePaymentTemplate.lines.percentage number The percentage to use for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.timetablePaymentTemplateLineNumber integer A unique identifier of the timetable payment template line.
paymentTerms.type string The type the payment term.
phone string The supplier phone number.
province object The supplier’s province.
province.countryCode object Country Code of the province’s country.
province.provinceNumber integer Numeric value that identifies the province within the country.
remittanceAdvice object Remittance advice for the supplier.
remittanceAdvice.creditorId string
remittanceAdvice.creditorInvoiceId string
remittanceAdvice.fieldValues object
remittanceAdvice.paymentType object
salesPerson object Reference to the employee responsible for contact with this supplier.
salesPerson.address string The Address of the employee.
salesPerson.barred boolean Shows if the employee is barred from being used.
salesPerson.bookedInvoices object A link to the collection of booked invoices which has the employee as a reference.
salesPerson.canApprove boolean Shows if the user can approve. Only for time logger profiles.
salesPerson.canInvoice boolean Shows if the user can invoice. Only for project managers and time logger profiles.
salesPerson.city string The City of the employee.
salesPerson.costPriceAfter number Employee cost price after the cut-off date.
salesPerson.costPriceBefore number Employee cost price before the cut-off date.
salesPerson.customers object A link to the collection of customers which has the employee as a reference.
salesPerson.cutoffDate string full-date The cut-off date for employee cost/sales prices.
salesPerson.draftInvoices object A link to the collection of draft invoices which has the employee as a reference.
salesPerson.email string The email address of the employee.
salesPerson.employeeGroup object The group to which the employee belongs.
salesPerson.employeeNumber integer The employee number is a unique numerical identifier with a maximum of 9 digits.
salesPerson.employeeType object Employee type.
salesPerson.initials string Userid of related user.
salesPerson.name string The name of the employee.
salesPerson.phone string The phone number of the employee.
salesPerson.postCode string The PostCode of the employee.
salesPerson.salesPriceAfter number Employee after price sales the cut-off date.
salesPerson.salesPriceBefore number Employee sales price before the cut-off date.
supplierContact object Reference to main contact employee at supplier.
supplierContact.supplierContactNumber integer
supplierGroup object In order to set up a new supplier it is necessary to specify a supplier group.
supplierGroup.supplierGroupNumber integer Unique identifier of the supplier group.
supplierNumber integer The supplier number is a unique numerical identifier.
vatNumber string The suppliers’s value added tax identification number.
vatZone object Indicates whether the supplier is located domestically, in Europe or elsewhere abroad.
vatZone.editionEnum string The edition to where the vat zone belongs.
vatZone.enabledForCustomer boolean A boolean value indicating if the vat zone is enabled for customers.
vatZone.enabledForSupplier boolean A boolean value indicating if the vat zone is enabled for suppliers.
vatZone.isDomestic boolean A boolean value indicating if the vat zone is domestic.
vatZone.isExemptVatZone boolean A boolean value indicating if the vat zone is exempt.
vatZone.isProjectAccount boolean
vatZone.name string The descriptive name of the vat zone.
vatZone.textId string The text id for the vat zone.
vatZone.vatZoneNumber integer The unique identifier of the vat zone.
zip string The suppliers zipcode.

Get specific Supplier

GET /suppliers/:supplierNumber

Return type

This method returns a single object

Properties

Name Type Format Read-only Values Description
address string Address for the supplier including street and number.
attention object Optional contact person at the supplier.
attention.supplierContactNumber integer
bankAccount string The suppliers bank account.
barred boolean Boolean indication of whether the supplier is barred.
city string The supplier’s city.
contacts object Links to the collect
corporateIdentificationNumber string Company Identification Number. For example CVR in Denmark.
costAccount object Cost account to be used for the supplier.
costAccount.accountNumber integer The number of the account
costAccount.name string True The name of the account.
country string The supplier’s country.
countryCode object The supplier’s country identification code.
countryCode.code string The 2 letter code for the country.
county string The supplier’s county. This property is only valid for UK agreements. It will be ignored for all other countries.
currency string Default currency used when purchasing from the supplier.
defaultInvoiceText string The supplier default invoice text.
defaultVoucherTemplate object The default voucher template for the supplier.
defaultVoucherTemplate.voucherTemplateNumber integer The unique identifier of the voucher template.
email string The supplier’s e-mail address. Note: you can specify multiple email addresses in this field, separated by a space.
layout object Layout that will be used for documents generated in relation to this supplier.
layout.deleted boolean A boolean indicating the deletion status of the layout.
layout.isDefault boolean True if the layout is the default selected by the user. This property is read only.
layout.layoutNumber integer The unique identifier of the layout.
layout.name string The descriptive name of the layout.
name string The supplier name.
paymentTerms object The default payment terms for the supplier.
paymentTerms.barred boolean If this payment term is accessible.
paymentTerms.cashDiscountAccount object The cash discount account.
paymentTerms.cashDiscountDayLimit integer The cash discount day limit.
paymentTerms.cashDiscountRate number The cash discount rate.
paymentTerms.contraAccountForPrepaidAmount object The contra account. Used for PaidInCash and Factoring only.
paymentTerms.contraAccountForRemainderAmount object The contra account for the remainder amount. Used for Factoring only.
paymentTerms.creditCardCompany object The credit card company. Used for type CreditCard only.
paymentTerms.creditCardCompany.italianCustomerType object None, PA, B2B, Consumer The customer’s Italian type.
paymentTerms.daysOfCredit integer The number of days of credit on the order. This field is only valid if terms of payment is not of type 'duedate’.
paymentTerms.description string The description of the payment term.
paymentTerms.name string The name of the payment terms.
paymentTerms.numberSeriesForCustomerPayment object The number series to use for creating customer payment vouchers. Used for paidInCash or creditcard type only.
paymentTerms.numberSeriesForCustomerPayment.entryType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The entry type of the number series.
paymentTerms.paymentTermsNumber integer A unique identifier of the payment term.
paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.percentageForPrepaidAmount number The percentage for prepaid amount. Used for Factoring only.
paymentTerms.percentageForRemainderAmount number The percentage for the remainder amount. Used for Factoring only.
paymentTerms.timetablePaymentTemplate object The timetable payment template. Used for Timetable only.
paymentTerms.timetablePaymentTemplate.lines object An array containing the timetable pament template lines.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms object The payment term for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.paymentTerms.paymentTermsType object Net, InvoiceMonth, PaidInCash, Prepaid, DueDate, Factoring, InvoiceWeekStartingSunday, InvoiceWeekStartingMonday, Creditcard, AvtaleGiro, Autogiro, TimeTable, EndOfMonth The type of the payment term.
paymentTerms.timetablePaymentTemplate.lines.percentage number The percentage to use for this timetable line.
paymentTerms.timetablePaymentTemplate.lines.timetablePaymentTemplateLineNumber integer A unique identifier of the timetable payment template line.
paymentTerms.type string The type the payment term.
phone string The supplier phone number.
province object The supplier’s province.
province.countryCode object Country Code of the province’s country.
province.provinceNumber integer Numeric value that identifies the province within the country.
remittanceAdvice object Remittance advice for the supplier.
remittanceAdvice.creditorId string
remittanceAdvice.creditorInvoiceId string
remittanceAdvice.fieldValues object
remittanceAdvice.paymentType object
salesPerson object Reference to the employee responsible for contact with this supplier.
salesPerson.address string The Address of the employee.
salesPerson.barred boolean Shows if the employee is barred from being used.
salesPerson.bookedInvoices object A link to the collection of booked invoices which has the employee as a reference.
salesPerson.canApprove boolean Shows if the user can approve. Only for time logger profiles.
salesPerson.canInvoice boolean Shows if the user can invoice. Only for project managers and time logger profiles.
salesPerson.city string The City of the employee.
salesPerson.costPriceAfter number Employee cost price after the cut-off date.
salesPerson.costPriceBefore number Employee cost price before the cut-off date.
salesPerson.customers object A link to the collection of customers which has the employee as a reference.
salesPerson.cutoffDate string full-date The cut-off date for employee cost/sales prices.
salesPerson.draftInvoices object A link to the collection of draft invoices which has the employee as a reference.
salesPerson.email string The email address of the employee.
salesPerson.employeeGroup object The group to which the employee belongs.
salesPerson.employeeNumber integer The employee number is a unique numerical identifier with a maximum of 9 digits.
salesPerson.employeeType object Employee type.
salesPerson.initials string Userid of related user.
salesPerson.name string The name of the employee.
salesPerson.phone string The phone number of the employee.
salesPerson.postCode string The PostCode of the employee.
salesPerson.salesPriceAfter number Employee after price sales the cut-off date.
salesPerson.salesPriceBefore number Employee sales price before the cut-off date.
supplierContact object Reference to main contact employee at supplier.
supplierContact.supplierContactNumber integer
supplierGroup object In order to set up a new supplier it is necessary to specify a supplier group.
supplierGroup.supplierGroupNumber integer Unique identifier of the supplier group.
supplierNumber integer The supplier number is a unique numerical identifier.
vatNumber string The suppliers’s value added tax identification number.
vatZone object Indicates whether the supplier is located domestically, in Europe or elsewhere abroad.
vatZone.editionEnum string The edition to where the vat zone belongs.
vatZone.enabledForCustomer boolean A boolean value indicating if the vat zone is enabled for customers.
vatZone.enabledForSupplier boolean A boolean value indicating if the vat zone is enabled for suppliers.
vatZone.isDomestic boolean A boolean value indicating if the vat zone is domestic.
vatZone.isExemptVatZone boolean A boolean value indicating if the vat zone is exempt.
vatZone.isProjectAccount boolean
vatZone.name string The descriptive name of the vat zone.
vatZone.textId string The text id for the vat zone.
vatZone.vatZoneNumber integer The unique identifier of the vat zone.
zip string The suppliers zipcode.

Create Supplier

POST /suppliers

Schema name

suppliers.post.schema.json

Return type

This method returns a single object

Required properties

currency, name, paymentTerms, supplierGroup, vatZone

Properties

Name Type Format Max length Min length Min value Description
address string 255 Address for the supplier including street and number.
attention object Optional contact person at the supplier.
bankAccount string 50 The suppliers bank account.
barred boolean Boolean indication of whether the supplier is barred.
city string 50 The supplier’s city.
corporateIdentificationNumber string 40 Company Identification Number. For example CVR in Denmark.
costAccount object Cost account to be used for the supplier.
country string 50 The supplier’s country.
county string 50 The supplier’s county. This property is only valid for UK agreements. It will be ignored for all other countries.
currency string 3 3 Default currency used when purchasing from the supplier.
email string 100 The supplier’s e-mail address. Note: you can specify multiple email addresses in this field, separated by a space.
layout object Layout that will be used for documents generated in relation to this supplier.
name string 255 1 The supplier name.
paymentTerms object 1 The default payment terms for the supplier.
remittanceAdvice object Remittance advice for the supplier.
remittanceAdvice.creditorId integer Unique number identifying the supplier.
remittanceAdvice.paymentType object The default payment terms for the supplier.
remittanceAdvice.paymentType.name string 50 The name of the payment type.
remittanceAdvice.paymentType.paymentTypeNumber integer Unique number identifying the payment type.
remittanceAdvice.paymentType.self string uri A unique reference to the payment type resource.
salesPerson object Reference to the employee responsible for contact with this supplier.
self string A unique self reference of the supplier.
supplierContact object Reference to main contact employee at supplier.
supplierGroup object 1 In order to set up a new supplier it is necessary to specify a supplier group.
supplierNumber integer The supplier number is a unique numerical identifier.
vatZone object Indicates whether the supplier is located domestically, in Europe or elsewhere abroad
zip string 10 The suppliers zipcode.

Update Supplier

PUT /suppliers/:supplierNumber

Return type

This method returns a single object

Required properties

currency, defaultVoucherTemplate.voucherTemplateNumber, name, paymentTerms, supplierGroup, vatZone

Properties

Name Type Description
address string Address for the supplier including street and number.
attention object Optional contact person at the supplier.
bankAccount string The suppliers bank account.
barred boolean Boolean indication of whether the supplier is barred.
city string The supplier’s city.
contacts object Links to the collect
corporateIdentificationNumber string Company Identification Number. For example CVR in Denmark.
costAccount object Cost account to be used for the supplier.
country string The supplier’s country.
countryCode object The supplier’s country identification code.
county string The supplier’s county. This property is only valid for UK agreements. It will be ignored for all other countries.
currency string Default currency used when purchasing from the supplier.
defaultInvoiceText string The supplier default invoice text.
defaultVoucherTemplate object The default voucher template for the supplier.
defaultVoucherTemplate.voucherTemplateNumber integer The unique identifier of the voucher template.
email string The supplier’s e-mail address. Note: you can specify multiple email addresses in this field, separated by a space.
layout object Layout that will be used for documents generated in relation to this supplier.
name string The supplier name.
paymentTerms object The default payment terms for the supplier.
phone string The supplier phone number.
province object The supplier’s province.
remittanceAdvice object Remittance advice for the supplier.
salesPerson object Reference to the employee responsible for contact with this supplier.
supplierContact object Reference to main contact employee at supplier.
supplierGroup object In order to set up a new supplier it is necessary to specify a supplier group.
supplierNumber integer The supplier number is a unique numerical identifier.
vatNumber string The suppliers’s value added tax identification number.
vatZone object Indicates whether the supplier is located domestically, in Europe or elsewhere abroad.
vatZone.vatZoneNumber integer The unique identifier of the vat zone.
zip string The suppliers zipcode.

Delete Supplier

DELETE /suppliers/:supplierNumber

Units

Units are the available units (‘kg’, 'cm’, etc.) that you can put on a product.

For more information please look at the Online Help.

Get Units

GET /units

View response example

Schema name

units.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Max length Description
name string 8 The name of the unit.
self string uri A unique link reference to the unit item.
unitNumber integer A unique identifier of the unit.

Get specific Unit

GET /units/:unitNumber

Schema name

units.unitNumber.get.schema.json

Return type

This method returns a single object

Properties

Name Type Format Max length Description
name string 8 The name of the unit.
products string uri A link to the products that reference this unit.
self string uri A unique link reference to the unit item.
unitNumber integer A unique identifier of the unit.

Create Unit

POST /units

Schema name

units.post.schema.json

Return type

This method returns a single object

Required property

name

Properties

Name Type Max length Description
name string 8 The name of the unit.

Update Unit

PUT /units/:unitNumber

Schema name

units.unitNumber.put.schema.json

Return type

This method returns a single object

Required property

name

Properties

Name Type Max length Description
name string 8 The new name of the unit.

Delete Unit

DELETE /units/:unitNumber

Please be adviced that you cannot delete a unit that is in use.

Get Products using this Unit

GET /units/:unitNumber/products

Vat Accounts

Get VAT Accounts

GET /vat-accounts

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Read-only Description
account object The account of the vat account.
account.accountNumber integer The number of the account
account.name string True The name of the account.
barred boolean A boolean indicating if the vat account is barred from being used.
contraAccount object The contra account of the vat account.
contraAccount.accountNumber integer The number of the account
contraAccount.name string True The name of the account.
exemptVatCode object The exempt vat code of the vat account.
exemptVatCode.code string The code of the exempt vat code.
exemptVatCode.name string The name of the exempt vat code.
extraRatePercentage number In some cases vat accounts has an extra rate that should be applied on top of the normal rate.
name string The name of the vat account.
nonDeductibleRate number Percentage of the vat rate that is not deductible.
ratePercentage number The vat rate of the vat account.
vatCode string The vat code of the vat account.
vatReportSetup object The VAT rate type used for reporting.
vatReportSetup.name string
vatReportSetup.vatReportSetupNumber integer
vatType object The type of the vat account.
vatType.name string
vatType.vatReportSetups object
vatType.vatTypeNumber integer

Get specific VAT Account

GET /vat-accounts/:vatCode

Return type

This method returns a single object

Properties

Name Type Read-only Description
account object The account of the vat account.
account.accountNumber integer The number of the account
account.name string True The name of the account.
barred boolean A boolean indicating if the vat account is barred from being used.
contraAccount object The contra account of the vat account.
contraAccount.accountNumber integer The number of the account
contraAccount.name string True The name of the account.
exemptVatCode object The exempt vat code of the vat account.
exemptVatCode.code string The code of the exempt vat code.
exemptVatCode.name string The name of the exempt vat code.
extraRatePercentage number In some cases vat accounts has an extra rate that should be applied on top of the normal rate.
name string The name of the vat account.
nonDeductibleRate number Percentage of the vat rate that is not deductible.
ratePercentage number The vat rate of the vat account.
vatCode string The vat code of the vat account.
vatReportSetup object The VAT rate type used for reporting.
vatReportSetup.name string
vatReportSetup.vatReportSetupNumber integer
vatType object The type of the vat account.
vatType.name string
vatType.vatReportSetups object
vatType.vatTypeNumber integer

Create VAT Account

POST /vat-accounts

Return type

This method returns a single object

Required properties

account, name, ratePercentage, vatReportSetup, vatType

Properties

Name Type Description
account object The account of the vat account.
barred boolean A boolean indicating if the vat account is barred from being used.
contraAccount object The contra account of the vat account.
exemptVatCode object The exempt vat code of the vat account.
extraRatePercentage number In some cases vat accounts has an extra rate that should be applied on top of the normal rate.
name string The name of the vat account.
nonDeductibleRate number Percentage of the vat rate that is not deductible.
ratePercentage number The vat rate of the vat account.
vatCode string The vat code of the vat account.
vatReportSetup object The VAT rate type used for reporting.
vatType object The type of the vat account.

Update VAT Account

PUT /vat-accounts/:vatCode

Return type

This method returns a single object

Required properties

account, name, ratePercentage, vatReportSetup, vatType

Properties

Name Type Description
account object The account of the vat account.
barred boolean A boolean indicating if the vat account is barred from being used.
contraAccount object The contra account of the vat account.
exemptVatCode object The exempt vat code of the vat account.
extraRatePercentage number In some cases vat accounts has an extra rate that should be applied on top of the normal rate.
name string The name of the vat account.
nonDeductibleRate number Percentage of the vat rate that is not deductible.
ratePercentage number The vat rate of the vat account.
vatCode string The vat code of the vat account.
vatReportSetup object The VAT rate type used for reporting.
vatType object The type of the vat account.

Delete VAT Account

DELETE /vat-accounts/:vatCode

Vat Statements

Get Reported Vat Statements

GET /vat-statements/reported

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Read-only Description
fromDate string full-date True The start date.
id integer Id of statement.
isReported boolean True Whether statement is reported.
isSettled boolean True Whether statement is settled.
lines object True The lines of the statement.
lines.fields object
reportedAmount number True The reported amount of the statement.
toDate string full-date True The end date.
vatSettlement object True The associated settlement, if any.
vatSettlement.createdOn string full-date True The date of creation.
vatSettlement.fromDate string full-date The settlement start date - must be start of a quarter.
vatSettlement.statements object List of statements.
vatSettlement.toDate string full-date The settlement end date - must be end of same quarter as start date.
vatSettlement.vatSettlementNumber integer True The number of settlements.
vatSettlement.xmlDocumentDownloadLink object The settlement Xml document reference.

Get specific reported Vat Statement

GET /vat-statements/reported/:statementId

Return type

This method returns a single object

Properties

Name Type Format Read-only Description
fromDate string full-date True The start date.
id integer Id of statement.
isReported boolean True Whether statement is reported.
isSettled boolean True Whether statement is settled.
lines object True The lines of the statement.
lines.fields object
reportedAmount number True The reported amount of the statement.
toDate string full-date True The end date.
vatSettlement object True The associated settlement, if any.
vatSettlement.createdOn string full-date True The date of creation.
vatSettlement.fromDate string full-date The settlement start date - must be start of a quarter.
vatSettlement.statements object List of statements.
vatSettlement.toDate string full-date The settlement end date - must be end of same quarter as start date.
vatSettlement.vatSettlementNumber integer True The number of settlements.
vatSettlement.xmlDocumentDownloadLink object The settlement Xml document reference.

Create a new Vat Settlement starting from a list of Vat Statements

POST /vat-statements/settled

Return type

This method returns a single object

Required properties

fromDate, statements, toDate, xmlDocument

Properties

Name Type Format Description
fromDate string full-date The settlement start date - must be start of a quarter.
statements object List of statements.
toDate string full-date The settlement end date - must be end of same quarter as start date.
xmlDocument string The provided Xml document to be settled.

Vat Types

Get VAT types

GET /vat-types

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type
name string
vatReportSetups object
vatTypeNumber integer

Get specific VAT type

GET /vat-types/:vatTypeId

Return type

This method returns a single object

Properties

Name Type
name string
vatReportSetups object
vatTypeNumber integer

Get VAT report setups

GET /vat-types/:vatTypeId/vat-report-setups

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type
name string
vatReportSetupNumber integer

Get specific VAT report setup

GET /vat-types/:vatTypeId/vat-report-setups/:vatReportSetupId

Return type

This method returns a single object

Properties

Name Type
name string
vatReportSetupNumber integer

Vat Zones

Get VAT Zones

GET /vat-zones

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Description
editionEnum string The edition to where the vat zone belongs.
enabledForCustomer boolean A boolean value indicating if the vat zone is enabled for customers.
enabledForSupplier boolean A boolean value indicating if the vat zone is enabled for suppliers.
isDomestic boolean A boolean value indicating if the vat zone is domestic.
isExemptVatZone boolean A boolean value indicating if the vat zone is exempt.
isProjectAccount boolean
name string The descriptive name of the vat zone.
textId string The text id for the vat zone.
vatZoneNumber integer The unique identifier of the vat zone.

Get specific VAT Zone

GET /vat-zones/:vatZoneNumber

Return type

This method returns a single object

Properties

Name Type Description
editionEnum string The edition to where the vat zone belongs.
enabledForCustomer boolean A boolean value indicating if the vat zone is enabled for customers.
enabledForSupplier boolean A boolean value indicating if the vat zone is enabled for suppliers.
isDomestic boolean A boolean value indicating if the vat zone is domestic.
isExemptVatZone boolean A boolean value indicating if the vat zone is exempt.
isProjectAccount boolean
name string The descriptive name of the vat zone.
textId string The text id for the vat zone.
vatZoneNumber integer The unique identifier of the vat zone.

Vouchers

Getting started

To create a simple finance voucher the following other objects are needed as a minimum.

  1. All lines need to reference an account (GET https://rest.reviso.com/accounts)
  2. The voucher needs to reference a number series that allows finance vouchers (GET https://rest.reviso.com/number-series?filter=entryType$eq:financeVoucher)
  3. The date of the voucher must be within a created and open accounting year: (GET https://rest.reviso.com/accounting-years)
  4. Currencies are not specified as objects, but as a string. None the less it needs to exist in (GET https://rest.reviso.com/currencies)

How to reference

When referencing another object, there are two ways to do it - either by…

Specifying only the number

{
    "account": {
        "accountNumber": 1011
    }
}

Allowed methods

POST to https://rest.reviso.com/vouchers/drafts/:type will create a voucher. :type can be * finance-vouchers * customer-payments * supplier-payments * supplier-invoices

PUT to https://rest.reviso.com/vouchers/drafts/:voucherId/ will update the specified voucher of any type

DELETE to https://rest.reviso.com/vouchers/drafts/:voucherId/ will delete the specified voucher

DELETE to https://rest.reviso.com/vouchers/drafts/ will delete all the vouchers

Get all Vouchers

GET /vouchers

Get Draft Vouchers

GET /vouchers/drafts

Get specific Voucher

GET /vouchers/drafts/:voucherId

Get Templates for Voucher

GET /vouchers/drafts/:voucherId/templates

Get template for copying a Voucher

GET /vouchers/drafts/:voucherId/templates/copy

Get template for reversing a Voucher

GET /vouchers/drafts/:voucherId/templates/reverse

Get template for turning a Voucher

GET /vouchers/drafts/:voucherId/templates/turn

Get draft Supplier Invoice Vouchers

GET /vouchers/drafts/supplier-invoices

Get draft Supplier Payment Vouchers

GET /vouchers/drafts/supplier-payments

Get draft Customer Payment Vouchers

GET /vouchers/drafts/customer-payments

Get draft Finance Vouchers

GET /vouchers/drafts/finance-vouchers

Get draft Manual Customer Invoice Vouchers

GET /vouchers/drafts/customer-invoices

Create Manual Customer Invoice Vouchers

POST /vouchers/drafts/customer-invoices

This endpoint supports input in array, collection and single item format.

Create Customer Payment Vouchers

POST /vouchers/drafts/customer-payments

This endpoint supports input in array, collection and single item format.

Create Finance Vouchers

POST /vouchers/drafts/finance-vouchers

This endpoint supports input in array, collection and single item format.

A POST of the following body to /vouchers/drafts/finance-voucher will create a new finance voucher:

{
    "date": "2014-09-17",
    "lines": [
        {
            "account": {
                "accountNumber": 1110,
                "self": "https://rest.reviso.com/accounts/1110"
            },
            "amount": 500.0,
            "currency": "DKK",
            "text": "My first line"
        },
        {
            "account": {
                "accountNumber": 1940,
                "self": "https://restapi.reviso.com/accounts/1940"
            },
            "amount": -500.0,
            "currency": "DKK",
            "text": "My second line"
        }
    ],
    "numberSeries": {
        "numberSeriesNumber": 5,
        "self": "https://rest.reviso.com/number-series/5"
    }
}

Create Supplier Invoice Vouchers

POST /vouchers/drafts/supplier-invoice

This endpoint supports input in array, collection and single item format. The following documents single item creation.

A supplier invoice requires more information than a finance voucher:

{
    "date": "2014-10-03",
    "duedate": "2014-10-17",
    "lines": [
        {
            "account": {
                "accountNumber": 1010,
                "self": "https://rest.reviso.com/accounts/1010"
            },
            "amount": 500,
            "currency": "DKK",
            "supplier": {
                "self": "https://rest.reviso.com/suppliers/1",
                "supplierNumber": 1
            },
            "text": "My first line"
        },
        {
            "account": {
                "accountNumber": 1018,
                "self": "https://rest.reviso.com/accounts/1018"
            },
            "amount": -500,
            "currency": "DKK",
            "supplier": {
                "self": "https://rest.reviso.com/suppliers/1",
                "supplierNumber": 1
            },
            "text": "My second line"
        }
    ],
    "numberSeries": {
        "numberSeriesNumber": 3,
        "self": "https://rest.reviso.com/number-series/3"
    }
}

A. Either a creditor, contra account or cost type must be supplied - in our example we will put in a supplier

B. A different number series is needed. You can obviously create your own by POSTing to /number-series, but in this example we will use the system generated number-series for supplier invoices. Note: reviso has two system generated number series for supplier invoices, one for the supplier invoices in the inventory module and one for supplier invoices in the journal. For this scenarioe, we will obviously take the latter.

C. The due date is not mandatory, but very common for supplier invoices

After locating the correct number series as being #3 and resolving supplier #1 a body for successfully creating a supplier invoice voucher with two lines would be:

Create Supplier Payment Vouchers

POST /vouchers/drafts/supplier-payments

This endpoint supports input in array, collection and single item format.

Update draft Voucher

PUT /vouchers/drafts/:voucherId

Delete all draft Vouchers

DELETE /vouchers/drafts

Delete specific draft Voucher

DELETE /vouchers/drafts/:voucherId

Get all booked Vouchers

GET /vouchers/booked

Get specific booked Voucher

GET /vouchers/booked/:voucherId

Get templates for booked Voucher

GET /vouchers/booked/:voucherId/templates

Get template for copying a booked Voucher

GET /vouchers/booked/:voucherId/templates/copy

Get template for reversing a booked Voucher

GET /vouchers/booked/:voucherId/templates/reverse

Get template for turning a booked Voucher

GET /vouchers/booked/:voucherId/templates/turn

Book Vouchers

POST /vouchers/booked

This endpoint supports input in array, collection and single item format.

Attachments

Attachments are the necessary documentation for transactions registered in the accounting books. A supplier invoice would for instance be documented with a copy of the received invoice as an attachment to the accounting entry.

Get draft Voucher Attachment

GET /vouchers/drafts/:voucherId/attachment

Returns a meta data document with info on the attachment. If no attachment exists, then the itemCount is 0.

Schema name

vouchers.drafts.voucherId.date.attachment.get.schema.json

Return type

This method returns a single object

Properties

Name Type Format Description
itemCount integer The number of items this attachment contains.
items string uri The GET link to this attachment items.
pdf string uri The GET link to this attachment as a pdf.
self string uri The unique self reference of the attachment.

Get Attachemnt Items for Voucher

GET /vouchers/drafts/:voucherId/attachment/items

Returns a collection envelope containing the items that make up the attachment. If no attachment exists, then an empty collection envelope is returned.

Schema name

vouchers.drafts.voucherId.date.attachment.items.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Description
image string uri The GET link to this attachment item as an image.
itemNumber integer An identifier of the attachment item and sorting order the item will be displayed in the attachment.
self string uri The unique self reference of the attachment item.
thumbnails array An array containing links to all thumbnails for this attachment item.
thumbnails.medium string uri The GET link to this attachment item as a medium thumbnail.

Get specific Attatchment Item for Voucher

GET /vouchers/drafts/:voucherId/attachment/items/:itemNumber

Returns a collection envelope containing the item with id {itemNumber} that make up part of the attachment.

Schema name

vouchers.drafts.voucherId.date.attachment.items.itemNumber.get.schema.json

Return type

This method returns a single object

Properties

Name Type Format Description
image string uri The GET link to this attachment item as an image.
itemNumber integer An identifier of the attachment item and sorting order the item will be displayed in the attachment.
self string uri The unique self reference of the attachment item.
thumbnails array An array containing links to all thumbnails for this attachment item.
thumbnails.medium string uri The GET link to this attachment item as a medium thumbnail.

Get PDF with Attachment Items for draft Voucher

GET /vouchers/drafts/:voucherId/attachment/pdf

Returns an aggregated PDF document with all items.

Get full size JPG of Attachment Item

GET /vouchers/drafts/:voucherId/attachment/items/:itemNumber/image

Returns an item in the attachment as a jpg.

Get thumbnail JPG of Attachment Item

GET /vouchers/drafts/:voucherId/attachment/items/:itemNumber/thumbnails/medium

Returns a thumbnail of an item in the attachment as a jpg.

Append Item to Voucher Attachment

POST /vouchers/drafts/:voucherId/attachment/items

Appends what is uploaded to the end of the attachment. Allowed filetypes: PDF, JPG, JPEG and PNG.

To upload files you need to set the content-type: multipart/form-data

Then add your files together with a key as form data.

Replace Attachment Item

PUT /vouchers/drafts/:voucherId/attachment/items/:itemNumber

Replaces an item from the attachment with what is uploaded. Allowed filetypes: PDF, JPG, JPEG and PNG.

To upload files you need to set the content-type: multipart/form-data

Then add your files together with a key as form data.

Delete Attachment

DELETE /vouchers/drafts/:voucherId/attachment/items

Deletes the entire attachment.

Delete Attachment Item

DELETE /vouchers/drafts/:voucherId/attachment/items/:itemNumber

Get booked Voucher Attachment

GET /vouchers/booked/:voucherId/attachment

Returns a meta data document with info on the attachment. If no attachment exists, then the itemCount is 0.

Schema name

vouchers.booked.voucherId.date.attachment.get.schema.json

Return type

This method returns a single object

Properties

Name Type Format Description
itemCount integer The number of items this attachment contains.
items string uri The GET link to this attachment items.
pdf string uri The GET link to this attachment as a pdf.
self string uri The unique self reference of the attachment.

Get booked Voucher Attachment Items

GET /vouchers/booked/:voucherId/attachment/items

Returns a collection envelope containing the items that make up the attachment. If no attachment exists, then an empty collection envelope is returned.

Schema name

vouchers.booked.voucherId.date.attachment.items.get.schema.json

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Format Description
image string uri The GET link to this attachment item as an image.
itemNumber integer An identifier of the attachment item and sorting order the item will be displayed in the attachment.
self string uri The unique self reference of the attachment item.
thumbnails array An array containing links to all thumbnails for this attachment item.
thumbnails.medium string uri The GET link to this attachment item as a medium thumbnail.

Get specific booked Voucher Attachment Item

GET /vouchers/booked/:voucherId/attachment/items/:itemNumber

Returns a collection envelope containing the item with id {itemNumber} that make up part of the attachment.

Schema name

vouchers.booked.voucherId.date.attachment.items.itemNumber.get.schema.json

Return type

This method returns a single object

Properties

Name Type Format Description
image string uri The GET link to this attachment item as an image.
itemNumber integer An identifier of the attachment item and sorting order the item will be displayed in the attachment.
self string uri The unique self reference of the attachment item.
thumbnails array An array containing links to all thumbnails for this attachment item.
thumbnails.medium string uri The GET link to this attachment item as a medium thumbnail.

Get PDF with Attachment Items for booked Voucher

GET /vouchers/booked/:voucherId/attachment/pdf

Returns an aggregated PDF document with all items.

Get JPG of booked Voucher Attachment Item

GET /vouchers/booked/:voucherId/attachment/items/:itemNumber/image

Returns an item in the attachment as a jpg.

Get thumbnail JPG of booked Voucher Attachment Item

GET /vouchers/booked/:voucherId/attachment/items/:itemNumber/thumbnails/medium

Returns a thumbnail of an item in the attachment as a jpg.

Append Attachment Item to booked Voucher

POST /vouchers/booked/:voucherId/attachment/items

Appends what is uploaded to the end of the attachment. Allowed filetypes: PDF, JPG, JPEG and PNG.

To upload files you need to set the content-type: multipart/form-data

Then add your files together with a key as form data.

Replace Attachment Item on booked Voucher

PUT /vouchers/booked/:voucherId/attachment/items/:itemNumber

Replaces an item from the attachment with what is uploaded. Allowed filetypes: PDF, JPG, JPEG and PNG.

To upload files you need to set the content-type: multipart/form-data

Then add your files together with a key as form data.

Delete Attachment on booked Voucher

DELETE /vouchers/booked/:voucherId/attachment/items

Deletes the entire attachment.

Delete Attachment Item from booked Voucher

DELETE /vouchers/booked/:voucherId/attachment/items/:itemNumber

Voucher Templates

A voucher template can be used as a starting point for generating a voucher with some data already filled in.

Certain behavior of the voucher user interface can also be controlled by the template - e.g. the selection of a different number series for the voucher that what is configured in the template can be restricted.

Get all voucher templates

GET /vouchers/templates

View response example

Return type

This method returns a collection of items. The containing items are described below.

Properties

Name Type Read-only Values Description
behavior object The behavior settings for the template controlling things like which sections should be visible etc.
behavior.hideNumberSeries boolean Should the template hide the number series selection in the UI.
behavior.hideProject boolean Should the template hide the ability to add and edit project lines in the UI.
behavior.hideTemplate boolean Should the template hide the template selection in the UI.
data object The data that will be applied to the voucher by the template.
data.considerInputAsGrossAmount boolean True if a finance voucher’s input should be taken in gross amount
data.lines object The list of voucher lines to apply to the voucher.
data.lines.isFixedSize boolean
data.lines.isReadOnly boolean
data.lines.isSynchronized boolean
data.lines.length integer
data.lines.longLength object
data.lines.rank integer
data.lines.syncRoot object
data.numberSeriesNumber integer The unique number series number to use by the voucher.
id object True The internal id of the current revision of the template. Will be used to reference a voucher to the revision of a template used for creation.
name string The name of the voucher template. Must be unique for each voucher type (case insensitive).
options object The list of options for what kind of data should be applied by the template.
options.applyAmounts boolean Should the template apply amounts to the voucher lines.
options.applyDepartments boolean Should the template apply department codes to the voucher lines.
options.applyNumberSeries boolean Should the template apply number series to the voucher.
options.applyTexts boolean Should the template apply the text to the voucher lines.
options.applyVatCodes boolean Should the template apply VAT codes to the voucher lines.
voucherTemplateNumber integer True The unique identifier of the voucher template. When creating or updating a voucher template, it will be ignored.
voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The type of voucher the template is to be used on.

Get specific voucher template

GET /vouchers/templates/:voucherTemplateNumber

Return type

This method returns a single object

Properties

Name Type Read-only Values Description
behavior object The behavior settings for the template controlling things like which sections should be visible etc.
behavior.hideNumberSeries boolean Should the template hide the number series selection in the UI.
behavior.hideProject boolean Should the template hide the ability to add and edit project lines in the UI.
behavior.hideTemplate boolean Should the template hide the template selection in the UI.
data object The data that will be applied to the voucher by the template.
data.considerInputAsGrossAmount boolean True if a finance voucher’s input should be taken in gross amount
data.lines object The list of voucher lines to apply to the voucher.
data.lines.isFixedSize boolean
data.lines.isReadOnly boolean
data.lines.isSynchronized boolean
data.lines.length integer
data.lines.longLength object
data.lines.rank integer
data.lines.syncRoot object
data.numberSeriesNumber integer The unique number series number to use by the voucher.
id object True The internal id of the current revision of the template. Will be used to reference a voucher to the revision of a template used for creation.
name string The name of the voucher template. Must be unique for each voucher type (case insensitive).
options object The list of options for what kind of data should be applied by the template.
options.applyAmounts boolean Should the template apply amounts to the voucher lines.
options.applyDepartments boolean Should the template apply department codes to the voucher lines.
options.applyNumberSeries boolean Should the template apply number series to the voucher.
options.applyTexts boolean Should the template apply the text to the voucher lines.
options.applyVatCodes boolean Should the template apply VAT codes to the voucher lines.
voucherTemplateNumber integer True The unique identifier of the voucher template. When creating or updating a voucher template, it will be ignored.
voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The type of voucher the template is to be used on.

Create voucher template

POST /vouchers/templates

Return type

This method returns a single object

Required properties

data, name, voucherType

Properties

Name Type Values Description
behavior object The behavior settings for the template controlling things like which sections should be visible etc.
data object The data that will be applied to the voucher by the template.
name string The name of the voucher template. Must be unique for each voucher type (case insensitive).
options object The list of options for what kind of data should be applied by the template.
voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The type of voucher the template is to be used on.

Update voucher template

PUT /vouchers/templates/:voucherTemplateNumber

Return type

This method returns a single object

Required properties

data, name, voucherType

Properties

Name Type Values Description
behavior object The behavior settings for the template controlling things like which sections should be visible etc.
data object The data that will be applied to the voucher by the template.
name string The name of the voucher template. Must be unique for each voucher type (case insensitive).
options object The list of options for what kind of data should be applied by the template.
voucherType object CustomerInvoice, CustomerPayment, SupplierInvoice, SupplierPayment, FinanceVoucher, Reminder, OpeningEntry, TransferredOpeningEntry, SystemEntry, ManualDebtorInvoice, OpeningBalance, DeliveryNote The type of voucher the template is to be used on.

Delete voucher template

DELETE /vouchers/templates/:voucherTemplateNumber