PATCH
/
v4
/
CREDIT
/
{id}
{
  "description": "<string>",
  "id": "<string>"
}

Path Parameters

​
id
string<biginteger>
required

The account id for given account

Query Parameters

​
auditUser
string
required

The audit user to log the request

Body

application/json

The fields that you want to apply to your newly cr, these values will override the predefined template values

Updating set values

​
status
enum<string>

If account status is updated to ACCOUNT_COLLECTION, it is not allowed to be updated back to any other status.

Available options:
ACCOUNT_BLOCKED,
ACCOUNT_OK,
ACCOUNT_TO_CLOSE,
ACCOUNT_COLLECTION
​
creditLimit
number

Credit limit of the account

Example:

10000

​
eInvoice
object
​
interestPostingEnabled
boolean

Indicates if interest posting enabled or disabled. With a boolean type of False, interest accrual is blocked, and with a boolean type of True, interest accrual will continue

Example:

true

​
invoiceDayOfMonth
integer

This will set the last day of the billing period. An invoice will be created and sent on the next day. If the day of the month day is exceeding the number of days in a given month then it will be the end of the month.

Required range: 1 <= x <= 31
Example:

21

​
invoiceDeliveryMethod
enum<string>
Available options:
REGULAR_MAIL,
EMAIL,
E_INVOICE,
CUSTOM_1,
CUSTOM_2,
CUSTOM_3,
CUSTOM_4,
CUSTOM_5
​
minimumToPay
object
​
paymentTerms
integer

Number of days to allow for invoice to be paid before it goes overdue.

Use of this field as well as the values of the field, is dependent on institution setup and should be aligned with Enfuce before taking into use.

Required range: 1 <= x <= 30
Example:

10

​
invoicePaymentMethod
enum<string>

Use of this field as well as the values of the field, is dependent on institution setup and should be aligned with Enfuce prior to use. Also, it is only a value, there is no functionality behind it.

Available options:
DIRECT_DEBIT,
PLUS_GIROT,
BANK_GIROT
​
underInvestigation
boolean

If account is under investigation

Example:

true

​
accountsCardStatuses
enum<string>

Indicates the current value for card statuses. Should not be used, use accountCardBlocks value instead. Will be deprecated

Available options:
OK,
SOFT_BLOCK,
HARD_BLOCK
​
accountCardBlocks
object

Indicates which blocks are set for the account cards. Current values are SoftBlock and HardBlock true / false. In case either of the softblock or hardblock is true the account card usage is blocked, so to enable card usage both of the blocks must be set to false. To block the accounts card usage setting either value (sofblock or hardblock to true) is enough to block account card usage.

​
address
object

Address connected to an account that will override the address set on customer level. This is for example used when sending out statements. Full address object is expected to be set when updating.

​
additionalValues
object[]

List of additional key-value pairs that can be associated with the account. Known keys:

  • BALC: Balance check configuration. Possible values: true (Shadow Balancing Disabled) or false (Shadow Balancing Enabled)
Maximum length: 4
​
customerId
string

Customer id for account owner

Example:

55667788990

​
name
string

Human readable name of an account

Maximum length: 64
Example:

"My example account name"

​
number
string

Unique account number for given account. Must be numeric if paymentRefence.type defined as MOD10 or FINNISH_7_3_1! Note that selected account numbers might be reserved by Enfuce for internal usage.

Maximum length: 64
Example:

123456789

​
reason
string

Reason for contract status change

Maximum length: 32
​
segment
enum<string>

Field enables to group an entity into a segment. This field will be exported but no logic is applied to this in Enfuce API

Available options:
SEGMENT_A,
SEGMENT_B,
SEGMENT_C,
SEGMENT_D,
SEGMENT_E,
SEGMENT_F
​
closureReason
enum<string>

Field enables to define entity's closure reason. This field will be exported but no logic is applied to this in Enfuce API

Available options:
CLOSED1,
CLOSED2,
CLOSED3,
CLOSED4,
CLOSED5
​
usageLimits
usageLimit · object[]
​
paymentReference
object

Number connected to account that will be used to map incoming payments to

​
parentId
string<biginteger>

This field is used when the institution is setting up an account liability hierarchy. The parentId is used to determine the top account of the account hierarchy. Consult Enfuce before using this field.

Example:

9876543210

Response

200
application/json

Successful update of the account

​
description
string

Short description of the result of the action

​
id
string

Will contain the ID of the resource that has been created or updated