addCostContracts request

 addCostContracts request fields

To add new cost contract entries for multiple account keys, pass the following fields:

Name Type Required Description Notes
accountKeys List (tick)
A list holding account key value strings

Each string in the list holds an account key value.

Account key:

Unique reference to identify an account.
  • Company account key format: Company.COMPANY_CODE
  • Merchant account key format: Merchant.MERCHANT_CODE

 
billable Boolean (error)

  • true: the cost contract is billable.
  • false: the cost contract is not billable.

If the specified account key refers to a merchant account, leave this field empty/do not assign a value to this field.
costContractName String (tick)

The name identifying the cost contract.
The specified name needs to be a valid one, i.e. it needs to be on the cost contract list assigned to the company or merchant.

 
minimumAmount int
(Long)
(error)
The minimum chargeable amount per invoice.
The value is represented using the euro currency and minor units (i.e. 1000 = 10 EUR).

If the specified account key refers to a merchant account, leave this field empty/do not assign a value to this field.
minimumTxs int (error)
The minimum number of transactions per month.

If the specified account key refers to a merchant account, leave this field empty/do not assign a value to this field.
remark String (error)
Free text comment or remark about the cost contract.

If the specified account key refers to a merchant account, leave this field empty/do not assign a value to this field.
startYear int (tick) The starting year when the cost contract becomes effective.
Start date = startMonth + startYear
The starting date needs to be set not earlier than a month, and not later than two years in the future.
startMonth int (tick) The starting month when the cost contract becomes effective.
Start date = startMonth + startYear
The starting date needs to be set not earlier than a month, and not later than two years in the future.