POST (create) one document

POST

/clients/{clientno}/documents

Create one document.

There are two ways to create new documents:

Use POST /clients/{clientno}/documents to create one new document; input one document object. The data will be validated and document created immediately and you will get a response describing the status and result. The new document is immediately active and ready to be posted etc. Or:

Use POST /clients/{clientno}/documents/batches to create a batch of new documents; input an array of document objects. The data will be stored, but not processed immediately. The output will present a batchUuid that you must keep track of. Processing is done asynchronously (later) and the bathcUuid can be used to retrieve the batch processing status and result using GET /clients/{clientno}/batches/{batchuuid}

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢201Created

application/json

Document created

Headers

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠422Unprocessable Entity

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/clients//documents' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "metadata": {
        "userId": "TestUser"
    },
    "document": {
        "documentType": "IN",
        "customerNo": "543210",
        "documentNo": "88776655",
        "documentDate": "2025-02-27",
        "dueDate": "2025-03-11",
        "currency": "NOK",
        "language": "en",
        "kid": "500221850000200350786",
        "marketingMessageCode": "0203",
        "customerMessage": "Happy holidays!",
        "salesOrderId": "B-0564311",
        "purchaseOrderId": "",
        "sellerReference": "C333",
        "buyerReference": "A1982",
        "additionalReference": "X99887",
        "subCustomerNo": "654655",
        "ledgerNote": "This is a note for the AR ledger",
        "currencyAmounts": {
            "exclVat": 5200,
            "vat": 1300,
            "inclVat": 6500
        },
        "distribution": {
            "type": "M",
            "einvoiceCode": 0
        },
        "einvoiceAddress": {
            "address": "test@armresttest.no",
            "addressScheme": "",
            "operator": ""
        },
        "emailAddress": [
            "test@armresttest.no"
        ],
        "attachmentFiles": [],
        "attachmentCodes": [],
        "customCodes": [],
        "documentLines": [
            {
                "lineNo": 1,
                "lineType": "PLH",
                "articleNo": "1300",
                "articleName": "Comb",
                "lineText": "Red comb",
                "quantityUnit": "pcs",
                "quantity": 1,
                "volumeUnit": "",
                "volume": 0,
                "price": 200,
                "itemGroup1": "500",
                "itemGroup2": "",
                "itemGroup3": "",
                "currencyAmounts": {
                    "exclVat": 200,
                    "vat": 50,
                    "inclVat": 250
                }
            },
            {
                "lineNo": 2,
                "lineType": "PLH",
                "articleNo": "1500",
                "articleName": "Pill",
                "lineText": "Purple pill",
                "quantityUnit": "dozen",
                "quantity": 1,
                "volumeUnit": "",
                "volume": 0,
                "price": 5000,
                "itemGroup1": "600",
                "itemGroup2": "",
                "itemGroup3": "",
                "currencyAmounts": {
                    "exclVat": 5000,
                    "vat": 150,
                    "inclVat": 6250
                }
            },
            {
                "lineNo": 3,
                "lineType": "TXT",
                "articleNo": "",
                "articleName": "",
                "lineText": "This is a text line with no amounts",
                "quantityUnit": "",
                "quantity": 0,
                "volumeUnit": "",
                "volume": 0,
                "price": 0,
                "itemGroup1": "",
                "itemGroup2": "",
                "itemGroup3": "",
                "currencyAmounts": {
                    "exclVat": 0,
                    "vat": 0,
                    "inclVat": 0
                }
            }
        ]
    }
}'

Response Example

201 - Document created

{
    "status": "PROCESSED",
    "result": "CREATED",
    "message": "CREATED",
    "clientNo": 2218,
    "accountNo": 500002,
    "referenceNo": 35078,
    "documentBundleId": 432795,
    "customerNo": "543210",
    "documentNo": "88776655",
    "warnings": [
        {
            "field": "EmailAddressDocument",
            "message": "Email address owea@ testarmrest.no was sanitized: owea@testarmrest.no was s"
        }
    ]
}

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

POST (create) a batch of documents

Get a list of documents