GET a list of customers

GET

/clients/{clientno}/customers

Get a list with details of one or more customers based on criteria given in query parameters. Default and upper limit maximumCount (maximum total number of records returned per query) = 10000; pageSize (maximum number of records per page) default = 100, pageSize (maximum number of records per page) upper limit = 1000.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Path Params

Query Params

Header Params

Responses

🟢200OK

application/json

OK. The request succeeded

Headers

Body

🟠400Bad Request

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/clients//customers?customerno&accountno&organizationno&name&customercategory&expand&maximumcount&query&pageno&pagesize&options&userid' \
--header 'Accept-Language;' \
--header 'Authorization: Bearer <token>'

Response Example

200 - List of customers

{
    "summary": {
        "pageNo": 1,
        "currentPageSize": 2,
        "pageSizeLimit": 2,
        "totalPages": 14,
        "totalCount": 28,
        "maximumCount": 10000,
        "nextPage": "https://api.staging.amili.no/arm/v1/clients/2218/customers?query=8NlwdOIM1YLVFApvQFONTw&pageno=2",
        "lastPage": "https://api.staging.amili.no/arm/v1/clients/2218/customers?query=8NlwdOIM1YLVFApvQFONTw&pageno=14",
        "queryId": "8NlwdOIM1YLVFApvQFONTw"
    },
    "customers": [
        {
            "clientNo": 2218,
            "accountNo": 500002,
            "customerNo": "543210",
            "name": "Owe Armstrong",
            "postalReturnStatus": 100,
            "postalReturnDate": "2025-01-10",
            "customerCategory": "CONS",
            "phoneNo": "99887766",
            "secondaryPhoneNo": "99775533",
            "organizationNo": "984842252",
            "organizationNoScheme": "0192",
            "dateOfBirth": "1999-01-01",
            "yearOfBirth": 1999,
            "ssn": "01019921717",
            "ssnCountry": "NO",
            "informalName": "Oa",
            "customerGroupCode": "VIP",
            "priceNetOrGross": "B",
            "language": "no",
            "currency": "NOK",
            "sellerReference": "VAA",
            "buyerReference": "OA",
            "bankAccountNo": "81501757329",
            "stopReminderUntil": "2026-12-31",
            "stopDebtCollectionUntil": "2026-12-31",
            "stopInterestCalcUntil": "2026-12-31",
            "dueDays": 10,
            "vatLiable": true,
            "discountRate": 5.5,
            "activeStatusWeb": "Passive",
            "customerMessage": "Keep it up!",
            "limitAmount": 2000,
            "registrationStatusCode": "FICTITIOUS",
            "registrationStatusDate": "2025-03-06",
            "postalAddressChanged": "2014-11-13",
            "postalAddress": {
                "addressLine1": "C/O ARMchair industries",
                "addressLine2": "707 Arm street",
                "addressLine3": "Appartment 8",
                "postalCode": "1234",
                "cityName": "Oslo",
                "countryText": "Norway",
                "countryCode": "NO"
            },
            "emailAddressDocument": [
                "amili@testarmrest.no"
            ],
            "secondaryEmailAddress": [
                "amili@testarmrest.no"
            ],
            "distribution": {
                "type": "H",
                "einvoiceCode": 90
            },
            "efakturaBlockIds": [
                "12345678",
                "23456789",
                "34567890"
            ],
            "peppolBlockIds": [
                "987654321",
                "876543210",
                "976543210"
            ],
            "digipostBlockIds": [
                "owe.armstrong#6UY",
                "bill.lossius#8HM"
            ]
        },
        {
            "clientNo": 2218,
            "accountNo": 500029,
            "customerNo": "765432",
            "name": "Bill Lossius",
            "postalReturnStatus": 0,
            "customerCategory": "CONS",
            "phoneNo": "98989898",
            "secondaryPhoneNo": "97979797",
            "organizationNo": "987654321",
            "organizationNoScheme": "0192",
            "dateOfBirth": "1980-03-01",
            "yearOfBirth": 0,
            "ssn": "",
            "ssnCountry": "",
            "informalName": "",
            "customerGroupCode": "",
            "priceNetOrGross": "B",
            "language": "no",
            "usingLanguage": "no",
            "currency": "NOK",
            "sellerReference": "VAB",
            "buyerReference": "BL",
            "bankAccountNo": "",
            "stopReminderUntil": "2026-01-01",
            "stopDebtCollectionUntil": "2026-01-01",
            "stopInterestCalcUntil": "2026-01-01",
            "dueDays": 14,
            "vatLiable": true,
            "discountRate": 0,
            "activeStatusWeb": "",
            "customerMessage": "",
            "limitAmount": 0,
            "registrationStatusCode": "FICTITIOUS",
            "registrationStatusDate": "2022-02-02",
            "postalAddressChanged": "2025-02-02",
            "postalAddress": {
                "addressLine1": "Farm alley 9",
                "addressLine2": "Birchwood neighborhood",
                "addressLine3": "Building 17",
                "postalCode": "5432",
                "cityName": "Bergen",
                "countryText": "Norway",
                "countryCode": "NO"
            },
            "emailAddressDocument": [
                "bill@testarmrest.no"
            ],
            "secondaryEmailAddress": [
                "billy@testarmrest.no"
            ],
            "distribution": {
                "type": "H",
                "einvoiceCode": 2
            },
            "efakturaBlockIds": [],
            "peppolBlockIds": [],
            "digipostBlockIds": []
        }
    ]
}

Modified at 2025-09-29 16:08:55

PUT (update) one customer

POST (create) one customer