GET
/
v4
/
{id}
curl --request GET \
  --url https://integration-api-cat2./%7B{environment}%7D.ext.%7B{realm}%7D.cia.enfuce.com/account/v4/{id}
{
  "InvoicePaymentMethod": "DIRECT_DEBIT",
  "accountCardBlocks": {
    "hardblock": true,
    "softblock": true
  },
  "accountsCardStatuses": "OK",
  "additionalValues": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "address": {
    "address1": "Kings street 12",
    "address2": "string",
    "address3": "string",
    "address4": "string",
    "city": "Mariehamn",
    "country": "FIN",
    "region": "Åland Islands",
    "zipCode": 22100
  },
  "available": 1000,
  "balance": 1000,
  "closureReason": "CLOSED1",
  "creditLimit": 10000,
  "currency": "EUR",
  "customerId": 55667788990,
  "dueDate": "2024-04-14",
  "eInvoice": {
    "address": "FI7165429021331431",
    "operator": "NDEAFIHH",
    "paymentInstruction": "AA"
  },
  "id": 1234567890,
  "interestPostingEnabled": true,
  "interestRates": [
    {
      "interestRate": 0,
      "interestType": "string"
    }
  ],
  "invoiceDayOfMonth": 21,
  "invoiceDeliveryMethod": "REGULAR_MAIL",
  "invoicedBalance": 200.5,
  "minimumToPay": {
    "amount": 0,
    "percentage": 0
  },
  "minimumToPayBalance": 25,
  "name": "My example account name",
  "number": 123456789,
  "overdueBalance": 300.5,
  "parentId": 9876543210,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "paymentTerms": 10,
  "productCode": "CREDIT_EUR_FI",
  "reason": "string",
  "reminders": {
    "collectionTriggerDate": "2019-11-27",
    "disableReminderProcess": true,
    "reminder1TriggerDate": "2019-11-27",
    "reminder2TriggerDate": "2019-11-27",
    "reminder3TriggerDate": "2019-11-27",
    "reminder4TriggerDate": "2019-11-27",
    "reminder5TriggerDate": "2019-11-27",
    "reminder6TriggerDate": "2019-11-27",
    "reminder7TriggerDate": "2019-11-27",
    "reminderStatus": "WAIT"
  },
  "segment": "SEGMENT_A",
  "status": "ACCOUNT_BLOCKED",
  "template": "string",
  "underInvestigation": true,
  "usageLimits": [
    {
      "code": "24H",
      "values": [
        {
          "availableAmount": 1200,
          "availableCount": 1200,
          "code": "ATM",
          "count": 5,
          "reset": true,
          "singleAmount": 12.5,
          "sumAmount": 1200,
          "usedAmount": 1200,
          "usedCount": 1200
        }
      ]
    }
  ]
}

{
  "InvoicePaymentMethod": "DIRECT_DEBIT",
  "accountCardBlocks": {
    "hardblock": true,
    "softblock": true
  },
  "accountsCardStatuses": "OK",
  "additionalValues": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "address": {
    "address1": "Kings street 12",
    "address2": "string",
    "address3": "string",
    "address4": "string",
    "city": "Mariehamn",
    "country": "FIN",
    "region": "Åland Islands",
    "zipCode": 22100
  },
  "available": 1000,
  "balance": 1000,
  "closureReason": "CLOSED1",
  "creditLimit": 10000,
  "currency": "EUR",
  "customerId": 55667788990,
  "dueDate": "2024-04-14",
  "eInvoice": {
    "address": "FI7165429021331431",
    "operator": "NDEAFIHH",
    "paymentInstruction": "AA"
  },
  "id": 1234567890,
  "interestPostingEnabled": true,
  "interestRates": [
    {
      "interestRate": 0,
      "interestType": "string"
    }
  ],
  "invoiceDayOfMonth": 21,
  "invoiceDeliveryMethod": "REGULAR_MAIL",
  "invoicedBalance": 200.5,
  "minimumToPay": {
    "amount": 0,
    "percentage": 0
  },
  "minimumToPayBalance": 25,
  "name": "My example account name",
  "number": 123456789,
  "overdueBalance": 300.5,
  "parentId": 9876543210,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "paymentTerms": 10,
  "productCode": "CREDIT_EUR_FI",
  "reason": "string",
  "reminders": {
    "collectionTriggerDate": "2019-11-27",
    "disableReminderProcess": true,
    "reminder1TriggerDate": "2019-11-27",
    "reminder2TriggerDate": "2019-11-27",
    "reminder3TriggerDate": "2019-11-27",
    "reminder4TriggerDate": "2019-11-27",
    "reminder5TriggerDate": "2019-11-27",
    "reminder6TriggerDate": "2019-11-27",
    "reminder7TriggerDate": "2019-11-27",
    "reminderStatus": "WAIT"
  },
  "segment": "SEGMENT_A",
  "status": "ACCOUNT_BLOCKED",
  "template": "string",
  "underInvestigation": true,
  "usageLimits": [
    {
      "code": "24H",
      "values": [
        {
          "availableAmount": 1200,
          "availableCount": 1200,
          "code": "ATM",
          "count": 5,
          "reset": true,
          "singleAmount": 12.5,
          "sumAmount": 1200,
          "usedAmount": 1200,
          "usedCount": 1200
        }
      ]
    }
  ]
}

Path Parameters

​
id
string
required

The account id for given account

Query Parameters

​
auditUser
string
required

The audit user to log the request

Response

200
application/json
Successful lookup of the account
​
available
number

Accounts's available amount

Example:

1000

​
balance
number

Account's balance

Example:

1000

​
currency
string

A valid ISO 4217 currency code

Example:

"EUR"

​
customerId
string

Customer id for account owner

Example:

55667788990

​
id
string

Unique account id for given account

Example:

1234567890

​
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: 32
Example:

123456789

​
parentId
string

Account id of parent account. If empty then this is parent contract.

Example:

9876543210

​
status
enum<string>
Available options:
ACCOUNT_BLOCKED,
ACCOUNT_COLLECTION,
ACCOUNT_OK,
ACCOUNT_TO_CLOSE,
ACCOUNT_CLOSED,
ACCOUNT_AUTO_CLOSED
​
paymentReference
object

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

​
template
string

Template name for which the account is connected to

​
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)
​
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
​
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

​
creditLimit
number

Credit limit of the account

Example:

10000

​
dueDate
string

Due date for the latest invoice

Example:

"2024-04-14"

​
productCode
string

The productCode is used to determine the specific account product. Values of the field are dependent on institution setup.

Example:

"CARD_EUR_FI"

​
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
​
invoicedBalance
number

This amount represents the due payment expected from the customer. Please note that it does not include any potential overdue balances.

Example:

200.5

​
minimumToPay
object
​
minimumToPayBalance
number

Invoiced minimum payment balance.

Example:

25

​
overdueBalance
number

The balance that remains unpaid after the due date has passed.

Example:

300.5

​
reason
string

Reason for account status change

Maximum length: 32
​
usageLimits
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
​
interestRates
object[]

Revolving or overdue Interest rate percentages that is effective for the account.

​
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.

​
reminders
object

Reminder details