Register payment
Overview
If the total amount paid and credited on the invoice equals or exceeds the total of the invoice (excluding dunning fees and interest) the invoice will be marked as paid as part of the payment registration.
If the originator has automatic reallocation enabled (this is the default) and the payment causes the balance (total + dunning fees and interest - payments) of the invoice to become less than zero, the excess credit will automatically be transferred to any unpaid invoices to the same recipient, starting with the oldest.
Register payment
1 | POST /invoices/{invoiceNumber}/payments
|
Request
1 2 3 4 | { "date": "2014-05-05", "amount": 20.5 } |
Response
HTTP/1.1 200 OK
Detailed property description
Name | Description | Required | Type | Limitation |
---|---|---|---|---|
date |
Payment date (Bokføringsdato). If not provided, current date will be used | String | Valid ISO date | |
amount |
Payment amount in NOK | Yes | Decimal | 2 decimals |
Payment for international invoices
If you want to register a payment for an international invoice, you have to add two additional fields - currencyAmount
and bankFee
.
currencyAmount
is the amount in the foreign currency while the bankFee
is the bank fee in NOK.
Request
1 2 3 4 5 6 | { "date": "2014-05-05", "amount": 20.5, "currencyAmount": 2.5, "bankFee": 1.0 } |
Response
HTTP/1.1 200 OK
Detailed property description
Name | Description | Required | Type | Limitation |
---|---|---|---|---|
date | Payment date (Bokføringsdato). If not provided, current date will be used. | String | Valid ISO date | |
amount | Payment amount in NOK. | yes | Number | |
currencyAmount | Payment amount in foreign currency. | yes | Number | |
bankFee | Bank fee in NOK. | yes | Number |