GET
/
v3
/
{id}
curl --request GET \
  --url https://integration-api-cat2./%7B{environment}%7D.ext.%7B{realm}%7D.cia.enfuce.com/account/v3/{id}
{
  "id": 1234567890,
  "parentId": 9876543210,
  "status": "ACCOUNT_BLOCKED",
  "available": 1000,
  "balance": 1000,
  "creditLimit": 10000,
  "currency": "EUR",
  "customerId": 55667788990,
  "number": 123456789,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "accountTemplate": "CREDIT",
  "invoiceDeliveryMethod": "REGULAR_MAIL",
  "minimumToPay": {
    "amount": 123,
    "percentage": 50
  },
  "address": {
    "address1": "Kings street 12",
    "address2": "<string>",
    "address3": "<string>",
    "address4": "<string>",
    "city": "Mariehamn",
    "country": "FIN",
    "region": "Åland Islands",
    "zipCode": 22100
  },
  "reason": "<string>",
  "segment": "SEGMENT_A",
  "eInvoice": {
    "address": "FI7165429021331431",
    "operator": "NDEAFIHH",
    "paymentInstruction": "AA"
  },
  "usageLimits": [
    {
      "code": "24H",
      "values": [
        {
          "code": "ATM",
          "reset": true,
          "singleAmount": 1000,
          "count": 5,
          "sumAmount": 1200
        }
      ]
    }
  ]
}
Deprecated: This API endpoint is no longer supported.

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
​
id
string

Unique account id for given account

Example:

1234567890

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

Accounts's available amount

Example:

1000

​
balance
number

Account's balance

Example:

1000

​
creditLimit
number

Credit limit of the account

Example:

10000

​
currency
string

A valid ISO 4217 currency code

Example:

"EUR"

​
customerId
string

Customer id for account owner

Example:

55667788990

​
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

​
paymentReference
object

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

​
accountTemplate
string

Template name for which the account is connected to

Example:

"CREDIT"

​
invoiceDeliveryMethod
enum<string>
Available options:
REGULAR_MAIL,
EMAIL,
E_INVOICE,
CUSTOM_1,
CUSTOM_2,
CUSTOM_3,
CUSTOM_4,
CUSTOM_5
​
minimumToPay
object
​
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

​
reason
string

Reason for account 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
​
eInvoice
object
​
usageLimits
object[]