GET a list of documents

GET

/clients/{clientno}/documents

Get a list of documents based on criteria given in query parameters. Default and upper limit of maximumcount = 10000; pageSize default = 100, pageSize upper limit = 1000. (maximumcount = maximum total number of records returned per query, pagesize = maximum number of records per page)

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Query Params

Header Params

Responses

🟢200

application/json

Document(s) found. See different response output examples for different document types and expand parameter options under /clients/{clientno}/documents/{documentno} (GET one document), response code 200

Headers

Body

🟠400BadRequest

🟠403Forbidden

🟠404NotFound

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/clients//documents?customerno&documentno&accountno&referenceno&documentid&documentuuid&kid&documentbundleid&documentdatefrom&documentdateto&documentbundledatefrom&documentbundledateto&documenttype&aritemtype&mostrecent&glyear&glperiod&lineno&expand&query&pageno&pagesize&maximumcount&userid' \
--header 'Accept-Language;' \
--header 'Authorization: Bearer <token>'

Response Example

200 - List of documents

{
    "summary": {
        "pageNo": 1,
        "currentPageSize": 2,
        "pageSizeLimit": 2,
        "totalPages": 8,
        "totalCount": 15,
        "maximumCount": 1000,
        "nextPage": "https://api.staging.amili.no/arm/v1/clients/2218/documents?query=8NlwdOIM1YLVFApvQUxiDw&pageno=2",
        "lastPage": "https://api.staging.amili.no/arm/v1/clients/2218/documents?query=8NlwdOIM1YLVFApvQUxiDw&pageno=8",
        "queryId": "8NlwdOIM1YLVFApvQUxiDw"
    },
    "documents": [
        {
            "clientNo": 2218,
            "accountNo": 500002,
            "referenceNo": 35078,
            "customerNo": "543210",
            "documentStatusCode": 9,
            "documentStatusDescription": "Doc distributed",
            "documentNo": "88776655",
            "documentDate": "2025-02-27",
            "dueDate": "2025-03-11",
            "documentId": "2010022183000350782",
            "documentUuid": "waG0vjD244OiFCxPYMAEvQ",
            "documentBundleId": 432735,
            "documentBundleDate": "2025-02-27",
            "currency": "NOK",
            "kid": "500221850000200350786",
            "documentType": "IN",
            "documentTypeDescription": "Invoice",
            "distribution": {
                "type": "H",
                "einvoiceCode": 2,
                "typeDescription": "E-fakt.B2C"
            },
            "einvoiceAddress": {
                "address": "87654321",
                "addressScheme": "",
                "operator": ""
            },
            "currencyAmounts": {
                "exclVat": 5200,
                "vat": 1300,
                "inclVat": 6500
            },
            "directDebit": 0,
            "emailAddress": [
                "test@armresttest.no"
            ],
            "marketingMessageCode": "0203",
            "customerMessage": "Happy holidays!",
            "attachmentFiles": [],
            "attachmentCodes": [],
            "customCodes": [],
            "language": "en",
            "usingLanguage": "en",
            "salesOrderId": "B-0564311",
            "sellerReference": "C333",
            "buyerReference": "A1982",
            "additionalReference": "X99887",
            "purchaseOrderId": "",
            "subCustomerNo": "654655",
            "arItemId": "2218-500002-35078-0",
            "createdTime": "2025-02-23T16:06:46.557+01:00",
            "documentLines": [
                {
                    "lineNo": 1,
                    "lineType": "PLH",
                    "articleNo": "1300",
                    "articleName": "Comb",
                    "lineText": "Red comb",
                    "quantityUnit": "kg",
                    "quantity": 1,
                    "volumeUnit": "",
                    "volume": 0,
                    "price": 200,
                    "currencyAmounts": {
                        "exclVat": 200,
                        "vat": 50,
                        "inclVat": 250
                    },
                    "itemGroup1": "500",
                    "itemGroup2": "",
                    "itemGroup3": ""
                },
                {
                    "lineNo": 2,
                    "lineType": "PLH",
                    "articleNo": "1500",
                    "articleName": "Pill",
                    "lineText": "Purple pill",
                    "quantityUnit": "dozen",
                    "quantity": 1,
                    "volumeUnit": "",
                    "volume": 0,
                    "price": 5000,
                    "currencyAmounts": {
                        "exclVat": 5000,
                        "vat": 150,
                        "inclVat": 6250
                    },
                    "itemGroup1": "600",
                    "itemGroup2": "",
                    "itemGroup3": ""
                },
                {
                    "lineNo": 3,
                    "lineType": "TXT",
                    "articleNo": "",
                    "articleName": "",
                    "lineText": "This is a text line with no amounts",
                    "quantityUnit": "",
                    "quantity": 0,
                    "volumeUnit": "",
                    "volume": 0,
                    "price": 0,
                    "currencyAmounts": {
                        "exclVat": 0,
                        "vat": 0,
                        "inclVat": 0
                    },
                    "itemGroup1": "",
                    "itemGroup2": "",
                    "itemGroup3": ""
                }
            ]
        },
        {
            "clientNo": 2218,
            "accountNo": 500029,
            "referenceNo": 35093,
            "customerNo": "765432",
            "documentStatusCode": 9,
            "documentStatusDescription": "Doc distributed",
            "documentNo": "88776656",
            "documentDate": "2025-02-24T00:00:00.000Z",
            "dueDate": "2025-03-06T00:00:00.000Z",
            "documentId": "201002218000350937",
            "documentUuid": "waG0vjD244OiFCxPYMAsYQ",
            "documentBundleId": 432734,
            "documentBundleDate": "2025-02-24T00:00:00.000Z",
            "currency": "NOK",
            "kid": "50022180000200350962",
            "documentType": "IN",
            "documentTypeDescription": "Invoice",
            "distribution": {
                "type": "M",
                "einvoiceCode": 0,
                "typeDescription": "Email"
            },
            "einvoiceAddress": {
                "address": "billy@testarmrest.no",
                "addressScheme": "",
                "operator": ""
            },
            "currencyAmounts": {
                "exclVat": 5000,
                "vat": 1250,
                "inclVat": 6250
            },
            "directDebit": 1,
            "emailAddress": [
                "billy@testarmrest.no"
            ],
            "marketingMessageCode": "",
            "customerMessage": "",
            "attachmentFiles": [],
            "attachmentCodes": [],
            "customCodes": [],
            "language": "en",
            "usingLanguage": "en",
            "salesOrderId": "",
            "sellerReference": "",
            "buyerReference": "BL",
            "additionalReference": "XY",
            "purchaseOrderId": "",
            "subCustomerNo": "",
            "arItemId": "2218-500002-35093-0",
            "createdTime": "2025-02-23T16:06:46.557+01:00",
            "documentLines": [
                {
                    "lineNo": 0,
                    "lineType": "PLH",
                    "articleNo": "1102",
                    "articleName": "Stapler",
                    "lineText": "Premium electric stapler",
                    "quantityUnit": "Pcs",
                    "quantity": 1,
                    "volumeUnit": "",
                    "volume": 0,
                    "price": 5000,
                    "currencyAmounts": {
                        "exclVat": 5000,
                        "vat": 1250,
                        "inclVat": 6250
                    },
                    "discountPercent": 0,
                    "glAccountNo": 0,
                    "clientGlAccountNo": "",
                    "glDim1": 321,
                    "glDim2": 0,
                    "glDim3": "Appliance",
                    "glDim4": "",
                    "bookkeepingCode": 0,
                    "itemGroup1": "300",
                    "itemGroup2": "",
                    "itemGroup3": ""
                }
            ]
        }
    ]
}

Modified at 2026-04-14 09:49:15

POST (create) one document

GET one document