Skip to main content
business_id
string<biz_string>
required

The ID of the Business associated with the External Account

Example:

"biz_Pk2fNFDd8wj7EFeLWJywc7"

type
enum<string>
required

The type of the External Account

Available options:
business,
personal
Examples:

"business"

"personal"

source
enum<string>
required

The source of the External Account

Available options:
manual,
plaid,
statements,
gusto
Examples:

"manual"

"plaid"

external_id
string | null
required

The external ID of the External Account

Maximum string length: 255
Example:

"1234567890"

disconnected_at
string<date-time> | null
required

Datetime when the external account was disconnected

last_synced_at
string<date-time> | null
required

Datetime when the external account was last synced

last_balanced_at
string<date-time> | null
required

Datetime when the external account was last balanced

external_balance
number | null
required

The current balance of the External Account

Example:

3512.85

last_statement_end_date
string<date-time> | null
required

Datetime when the external account balance was last updated

id
string<eac_string>
required

The ID of the External Account

Example:

"eac_Ns6rRRLYVZPh4cVB7MDby5"

ledger_id
string<ldg_string> | null

The ID of the Bank Ledger associated with the Business External Account

Example:

"ldg_Ns6rRRLYVZPh4cVB7MDby5"

contribution_ledger_id
string<ldg_string> | null

The ID of the Contribution Ledger associated with the Personal External Account

Example:

"ldg_Ns6rRRLYVZPh4cVB7MDby5"

distribution_ledger_id
string<ldg_string> | null

The ID of the Distribution Ledger associated with the Personal External Account

Example:

"ldg_Ns6rRRLYVZPh4cVB7MDby5"

metadata_
Metadata · object
name
string | null

The name of the External Account

Maximum string length: 255
Example:

"ABC Business Checking"

mask
string | null

The mask of the External Account

Maximum string length: 255
Example:

"1234"

linked_item_id
string<lni_string> | null

The ID of the Linked Item associated with the External Account

Example:

"lni_R2fAXCjqJPdpYata112zyW"

status
enum<string>
default:connected

The status of the External Account

Available options:
connected,
disconnected,
untracked
Examples:

"connected"

"disconnected"