Skip to main content
POST
Register direct payment

Authorizations

Authorization
string
header
required

Authentication can be done by using a bearer token in the Authorization header. This is done using the following format Authorization: Bearer {token}.

Path Parameters

tenantId
string<uuid>
required

Id of the tenant

Query Parameters

creditorId
string<uuid>
required

Id of the creditor the case voucher belongs to

Body

application/json

The payment

Exactly one of caseVoucherId and caseVoucherReferenceId must be given; the other may be left out or null. A body with both or neither is rejected with Give exactly one of caseVoucherId and caseVoucherReferenceId.

amount
integer
required

The amount paid, positive, in the minor unit. 1,200.00 is sent as 120000. It cannot exceed what is still outstanding on the referenced case voucher.

caseVoucherId
string<uuid>

Debbie's id of the case voucher the money paid off, as returned when the voucher was created. It must belong to the creditor. Give either this or caseVoucherReferenceId, not both.

caseVoucherReferenceId
string

The creditor's reference for the case voucher the money paid off — normally the invoice number. It is looked up within the creditor given in creditorId, and must match exactly one case voucher. Give either this or caseVoucherId, not both.

date
string

The date the money was received. Defaults to now.

currency
enum<string>

Optional. When given, it must match the currency of the referenced case voucher — it is a check, not a conversion.

Available options:
DKK,
SEK,
NOK,
USD,
EUR,
GBP,
CHF
text
string

Free text shown on the payment.

Response

The payment was registered

caseId
string<uuid>

Id of the case the payment was registered on

caseVoucherId
string<uuid>

Id of the created deposit

amount
integer
currency
enum<string>

Currency

Available options:
DKK,
SEK,
NOK,
USD,
EUR,
GBP,
CHF
date
string
paidCaseVoucher
object

The case voucher the payment was applied to