Get account dormancy

Retrieves an account dormancy configuration by the account external ID.

get/corporate/v1/account-dormancy/{externalAccountId}

Request

Base URL
https://sandbox.pismolabs.io
URL
https://sandbox.pismolabs.io/corporate/v1/account-dormancy/{externalAccountId}
Auth
HTTP bearer

Path parameters

externalAccountIdstring required

External account ID

Response

idstring uuid

Account dormancy control ID generated internally

external_account_idstring

Custom account ID. Used as the key for all operations (manage accounts, transactions, etc.) on the corporate layer.

This field is:

Unique within the Organization
Immutable: The field cannot be updated.
Not recyclable: You can't reuse an external account ID, even if the account that was using it has been canceled.

account_idinteger

Account ID

dormancy_config_idstring uuid

Dormancy configuration ID generated internally

inactive_sincestring

Date of the last time the account had any activities. Format = yyyy-mm-dd:hr:mm:ss.

inactivity_timeinteger

Number of days the account has been inactive.<br> inactivity_time is calculated as current_datetime - inactive_since in UTC timezone.

target_type'DIVISION' | 'PROGRAM'

Dormancy configuration target

target_idstring

Target ID. When target_type is DIVISION, this value is the division code. Likewise, when target_type is PROGRAM, the value is the program ID, and so on.

Example response

{
  "external_account_id": "b993ba96-b3e8-4ef7-9cf7-7eee5ddafdab",
  "account_id": 1234,
  "dormancy_config_id": "b993ba96-b3e8-4ef7-9cf7-7eee5ddafdab",
  "inactive_since": "2023-08-04T15:00:44.704Z",
  "inactivity_time": 10,
  "target_type": "DIVISION",
  "target_id": "my-division-code"
}

Changes

No recorded changes to this operation across all 1 revision of this API.