Skip to main content
POST
Add case voucher to case

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

id
string
required

Id of the case to add the vouchers to

Body

application/json

New case voucher object

voucherTypeId
string<uuid>
required

An id for the voucher type.

amount
integer
required

Amount in base currency. For example 1.00 should be sent as 100. A negative amount (e.g. -100) represents a debt, while a positive amount (e.g. +100) represents a credit note or deposit.

currency
enum<string>
required

Currency

Available options:
DKK,
SEK,
NOK,
USD,
EUR,
GBP,
CHF
Example:

"DKK"

date
string
required
source
enum<string>
required

The source of the case voucher. "CREDITOR" if the case voucher is imposed by the creditor (typically from an ERP system). "COLLECTOR" if the case voucher is imposed by collector (debt collection agency). If it is a deposit it is a direct payment if set to "CREDITOR".

Available options:
CREDITOR,
COLLECTOR
Example:

"CREDITOR"

referenceId
string
interest
number

Used when the voucher is accumulating interest to specify the interest rate (yearly interest and compound interest). The number is in decimal, for example 0.1 would be an interest rate of 10%.

interestStartDate
string
interestEndDate
string
dueDate
string
bookingDate
string<date-time> | null

The date the deposit is booked in the accounts. date is when the money was received and is what interest is calculated from; the booking date is the accounting period it belongs to. Null means it follows date.

appendix
object

The appendix is for pdf copies or similar for a case voucher.

referenceCaseVoucherId
string<uuid>

The id of the voucher that this voucher is a child of.

contactId
string<uuid> | null

Required when the voucher type is set up to pay out to a contact: the contact (with a bank account) that receives the payout. Ignored for other voucher types.

billCreditor
boolean | null

Bills the amount to the creditor as a disbursement when the voucher type offers it. A voucher type that requires the disbursement bills it regardless.

referenceVouchers
array
properties
object

Case voucher properties. You can create property types under settings in the platform. Use the handle as object key like this: { "mySingleLineTextPropertyTypeHandle": "your value" }

distribute
object[]

Distribution of the case voucher. The sum of the distribution must be equal to the amount of the case voucher.

Response

Successful operation

caseVoucherId
string<uuid>

Id of the case voucher