POST (create) a new payment reservation

POST

/clients/{clientno}/paymentreservations

Creates a new payment reservation connected to an existing document's AR item or to an existing customer. There are alternative ways to identify this document or customer, you must fulfill at least one of them.

Ways to identify a document:

arItemId (The AR item ID of the document's AR posting)

documentNo

documentUuid

referenceNo

kid (document KID)

Ways to identify a customer:

accountNo (AR account number)

customerNo

kid (customer KID)

The payment reservation must also have a unique paymentId to identify the transaction for later settlement/posting to GL/AR. (The settlement data must contain a reference to the same paymentId.)

The paid amount (currencyAmountPaid) must be a positive amount.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

OK. The request succeeded

Body

🟢201

🟠422

🟠400BadRequest

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/clients//paymentreservations' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "metadata": {
        "userId": "TestUser"
    },
    "paymentreservation": {
        "arItemId": "2218-500002-35078-0",
        "paymentId": "PM285000350786",
        "currency": "NOK",
        "currencyAmountPaid": 120.5,
        "transactionText": "Prepaid membership fee",
        "paidTime": "2025-04-27T06:08:37.227Z",
        "unstructuredData": [
            {
                "name": "SalesRep",
                "value": "John Doe"
            }
        ]
    }
}'

Response Example

200 - Payment reservation validated

{
    "status": "PROCESSED",
    "result": "VALIDATED",
    "message": "Payment reservation validated",
    "clientNo": 2218,
    "accountNo": 500002,
    "customerNo": "543210"
}

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

GET a list of log items

Check API health