About - Amili Docs

Amili Collection AS's ARM (Accounts Receivable Management) REST API, colloquially referred to as the ARMrest API.

General notes

The ARMrest API is provided and maintained by Amili Collection AS (Norwegian organization number 984842252), in this documentation referred to as Amili

Names of parameters, key-value pairs, objects and arrays are case-sensitive

Path and query parameters (all names used in URLs) are always lower case only

Request/response body key-value pairs, objects and arrays are camelCase (with lower case first letter)

Data values are not case-sensitive, with the notable exception of UUIDs

Words used in names of parameters, key-value pairs, objects and arrays are usually not abbreviated; however a few frequently used words are, e.g.:

adb: Age Distributed Balance (aldersfordelt saldo)

ar: Accounts Receivable, sometimes called sales ledger (Norwegian: kundereskontro); a subledger for receivables. Example: arItem = Accounts Receivable item

excl: Excluding. Example: exclVat = excluding VAT (Value Added Tax)

gl: General Ledger. Example: glYear = General Ledger year

id: Identifier. Examples: documentId = document identifier, documentBundleId = document bundle identifier

incl: Including. Example: inclVat = including VAT (Value Added Tax)

kid: KundeIDentifikasjonsnummer, a Norwegian unique payment identifier construct with specific rules

no: Number. Examples: ducumentNo = document number, customerNo = customer number

ytd: Year-To-Date

With GET methods you can control how many records to retrieve and how many records you want per response page by using the query parameters maximumCount (maximum total number of records returned per query) and pageSize (maximum number of records per page). However, each entity will have an upper limit (cap) that cannot be exceeded. This limit and the default limit will vary between entities; please refer to the documentation of the relevant resource. You cannot use pageSize < 5, an attempt to do so will result in pageSize defaulting to 10. Note that maximumCount must be divisible by pageSize; if it is not, maximumCount will be rounded up to the nearest valid value.

Example: The Customers entity has a default and upper limit maximumCount = 10000; pageSize default = 100, pageSize upper limit = 1000

Privacy statement (GDPR): https://amili.no/privacy-statement

Acceptable use policy (AUP)

Use of the ARMrest API will be subject to Amili's Acceptable Use Policy (AUP). The AUP states rate limiting requirements for different ARM client sizes, as summarized below. Sliding window month/hour, figures are comma delimited for client sizes: S, M, L, XL:

Monthly maximum:

Requests: 20 000, 100 000, 500 000, 2 000 000

Database records read: 100 000, 500 000, 2 500 000, 10 000 000

Database records write: 20 000, 100 000, 500 000, 2 000 000

Peak hour maximum:

Requests: 500, 1 000, 5 000, 10 000

Database records read: 10 000, 20 000, 100 000, 200 000

Database records write: 5 000, 10 000, 50 000, 100 000

Client size codes are based on ARM client's average total annual invoice count:

XL: >= 1 000 000

L: >= 100 000

M: >= 10 000

S: < 10 000

The AUP and required rate limits can be changed by Amili at any time.