List Bank Transactions

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

integer

default:0

Page number, 0 indexed.

Required range: x >= 0

limit

integer

default:50

The page size

Required range: 1 <= x <= 200

bank_account

string

The BankAccount identifier, (e.g. bnka_abc123).

string

Search for transactions by description, reference number, or counterparty name.

drafts

boolean

default:false

posted

boolean

Filter for only posted invoices.

reference_number

string

The transaction reference number.

timerange_start

string<date-time>

Filter bank transactions created after this time.

timerange_end

string<date-time>

Filter bank transactions created before this time.

type

enum<string>

A withdrawal indicates funds flowing out of your account (negative amount). A deposit indicates funds flowing into your account (positive amount).

Available options:

deposit,

withdrawal

Response

Successful response

data

object[]

Show child attributes

data.account_id

string

required

The id of the bank_account associated with the transaction.

Maximum string length: 32

data.amount

integer

required

The gross amount (less any fees) in the currency's smallest unit, e.g. $10 USD would be represented as 1000. amount must be >= 0

data.object

string

required

data.posted

boolean

required

Whether the transaction was posted. If false, the transaction hasn't been settled yet.

data.reference_number

string

required

The transaction reference number.

data.timestamp

string<date-time>

required

If posted, the time the transaction posted. Otherwise the time the transaction was initiated/authorized.

data.type

enum<string>

required

A withdrawal indicates funds flowing out of your account (negative amount). A deposit indicates funds flowing into your account (positive amount).

Available options:

deposit,

withdrawal

Maximum string length: 10

data.id

string

Maximum string length: 32

data.account_mask

any

data.authorized_at

string<date-time> | null

The datetime this transaction was initiated/authorized.

data.check_number

string | null

The check number of the transaction. This field is only populated for check transactions.

data.counterparty_email

string | null

The email of the counterparty associated with this transaction.

data.counterparty_logo

string | null

The logo of the counterparty associated with this transaction.

data.counterparty_name

string | null

The name of the counterparty associated with this transaction.

data.created_at

string<date-time>

data.currency

enum<string> | null

The ISO-4217 currency code of the transaction.

Available options:

ADP,

AED,

AFA,

AFN,

ALK,

ALL,

AMD,

ANG,

AOA,

AOK,

AON,

AOR,

ARA,

ARL,

ARM,

ARP,

ARS,

ATS,

AUD,

AWG,

AZM,

AZN,

BAD,

BAM,

BAN,

BBD,

BDT,

BEC,

BEF,

BEL,

BGL,

BGM,

BGN,

BGO,

BHD,

BIF,

BMD,

BND,

BOB,

BOL,

BOP,

BOV,

BRB,

BRC,

BRE,

BRL,

BRN,

BRR,

BRZ,

BSD,

BTN,

BUK,

BWP,

BYB,

BYN,

BYR,

BZD,

CAD,

CDF,

CHE,

CHF,

CHW,

CLE,

CLF,

CLP,

CNH,

CNX,

CNY,

COP,

COU,

CRC,

CSD,

CSK,

CUC,

CUP,

CVE,

CYP,

CZK,

DDM,

DEM,

DJF,

DKK,

DOP,

DZD,

ECS,

ECV,

EEK,

EGP,

ERN,

ESA,

ESB,

ESP,

ETB,

EUR,

FIM,

FJD,

FKP,

FRF,

GBP,

GEK,

GEL,

GHC,

GHS,

GIP,

GMD,

GNF,

GNS,

GQE,

GRD,

GTQ,

GWE,

GWP,

GYD,

HKD,

HNL,

HRD,

HRK,

HTG,

HUF,

IDR,

IEP,

ILP,

ILR,

ILS,

INR,

IQD,

IRR,

ISJ,

ISK,

ITL,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRH,

KRO,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LTL,

LTT,

LUC,

LUF,

LUL,

LVL,

LVR,

LYD,

MAD,

MAF,

MCF,

MDC,

MDL,

MGA,

MGF,

MKD,

MKN,

MLF,

MMK,

MNT,

MOP,

MRO,

MRU,

MTL,

MTP,

MUR,

MVP,

MVR,

MWK,

MXN,

MXP,

MXV,

MYR,

MZE,

MZM,

MZN,

NAD,

NGN,

NIC,

NIO,

NLG,

NOK,

NPR,

NZD,

OMR,

PAB,

PEI,

PEN,

PES,

PGK,

PHP,

PKR,

PLN,

PLZ,

PTE,

PYG,

QAR,

RHD,

ROL,

RON,

RSD,

RUB,

RUR,

RWF,

SAR,

SBD,

SCR,

SDD,

SDG,

SDP,

SEK,

SGD,

SHP,

SIT,

SKK,

SLE,

SLL,

SOS,

SRD,

SRG,

SSP,

STD,

STN,

SUR,

SVC,

SYP,

SZL,

THB,

TJR,

TJS,

TMM,

TMT,

TND,

TOP,

TPE,

TRL,

TRY,

TTD,

TWD,

TZS,

UAH,

UAK,

UGS,

UGX,

USD,

USN,

USS,

UYI,

UYP,

UYU,

UYW,

UZS,

VEB,

VED,

VEF,

VES,

VND,

VNN,

VUV,

WST,

XAF,

XAG,

XAU,

XBA,

XBB,

XBC,

XBD,

XCD,

XCG,

XDR,

XEU,

XFO,

XFU,

XOF,

XPD,

XPF,

XPT,

XRE,

XSU,

XTS,

XUA,

XXX,

YDD,

YER,

YUD,

YUM,

YUN,

YUR,

ZAL,

ZAR,

ZMK,

ZMW,

ZRN,

ZRZ,

ZWD,

ZWL,

ZWR,

Maximum string length: 3

data.currency_rate

integer | null

The currency exchange rate at the time of the transaction.

data.custom_fields

any

data.description

string | null

The transaction's detail that often appears on your statement and portal. It can contain remittance information or descriptions about the payment.

data.description_details

any | null

The transaction's detail that often appears on your statement and portal. It can contain remittance information or descriptions about the payment.

data.invoice_numbers

string[]

A list of invoice numbers associated with this transaction.

data.is_draft

boolean

Whether this transaction is a draft that was created from a bank statement upload that is pending approval.

data.last_synced_at

string<date-time> | null

data.modified_at

string<date-time> | null

data.partner

object

Show child attributes

data.partner.id

string

Maximum string length: 32

data.partner.account_number

string | null

The customer's account number.

data.partner.ap_portals

object[]

Show child attributes

data.partner.ap_portals.object

string

required

data.partner.ap_portals.partner_id

string

required

Reference to the Partner

Maximum string length: 32

data.partner.ap_portals.id

string

Maximum string length: 32

data.partner.ap_portals.account

object

Show child attributes

data.partner.ap_portals.account.object

string

required

data.partner.ap_portals.account.organization_id

string

required

Organization associated with this account

Maximum string length: 32

data.partner.ap_portals.account.provider

enum<string>

required

The AP Portal provider

Available options:

coupa,

ariba,

taulia

Maximum string length: 6

data.partner.ap_portals.account.id

string

Maximum string length: 32

data.partner.ap_portals.account.available_operations

any

data.partner.ap_portals.account.created_at

string<date-time>

data.partner.ap_portals.account.modified_at

string<date-time> | null

data.partner.ap_portals.account_id

string | null

Reference to the ap portal account

Maximum string length: 32

data.partner.ap_portals.account_key

string | null

Identifier to scope an AP Portal (e.g. region, division, department).

data.partner.ap_portals.created_at

string<date-time>

data.partner.ap_portals.customer_identifier

string | null

Customer identifier on the portal, if exists.

data.partner.ap_portals.customer_name

string | null

Customer name on the portal. Used instead of the partner name if set.

data.partner.ap_portals.invoice_submission_guidelines

string | null

Natural language guidelines for processing invoice submissions.

data.partner.ap_portals.is_enabled

boolean

Whether this AP portal configuration is enabled

data.partner.ap_portals.is_invoice_submission_enabled

boolean

Whether invoice submission is enabled

data.partner.ap_portals.is_report_download_enabled

boolean

Whether report download is enabled

data.partner.ap_portals.modified_at

string<date-time> | null

data.partner.ap_portals.name

string | null

Name of the AP Portal

data.partner.ap_portals.provider

enum<string> | null

The AP Portal provider

Available options:

coupa,

ariba,

taulia,

Maximum string length: 6

data.partner.ap_portals.report_email

string | null

Email address to send downloaded reports to

data.partner.ap_portals.report_frequency

enum<string> | null

Frequency for report downloads

Available options:

daily,

weekly,

monthly,

Maximum string length: 7

data.partner.assignee

object

Show child attributes

data.partner.assignee.email

string

required

Maximum string length: 255

data.partner.assignee.family_name

string

required

data.partner.assignee.given_name

string

required

data.partner.assignee.object

string

required

data.partner.assignee.organization_id

string

required

Maximum string length: 32

data.partner.assignee.id

string

Maximum string length: 32

data.partner.assignee.created_at

string<date-time>

data.partner.assignee.dashboard_settings

object

Show child attributes

data.partner.assignee.dashboard_settings.thread_emails_sort_order

string

default:asc

data.partner.assignee.default_email_sender_id

string | null

Maximum string length: 32

data.partner.assignee.invited_by_user_id

string | null

Maximum string length: 32

data.partner.assignee.is_access_approved

boolean

data.partner.assignee.is_org_admin

boolean

data.partner.assignee.modified_at

string<date-time> | null

data.partner.assignee.name

string

data.partner.assignee.onboarding_required

boolean

data.partner.assignee.profile_picture

string

data.partner.assignee.selected

boolean

data.partner.assignee_id

string | null

Maximum string length: 32

data.partner.billing_address

object

Show child attributes

data.partner.billing_address.object

string

required

data.partner.billing_address.city

string | null

City, district, suburb, town, or village.

data.partner.billing_address.coordinates

object

Option 1
Option 2

data.partner.billing_address.country

string | null

Two-letter country code. (ISO 3166 alpha-2)

Maximum string length: 3

data.partner.billing_address.created_at

string<date-time>

data.partner.billing_address.description

string | null

data.partner.billing_address.line1

string | null

Address line 1 (e.g., street, PO Box, or company name).

data.partner.billing_address.line2

string | null

Address line 2 (e.g., apartment, suite, unit, or building).

data.partner.billing_address.modified_at

string<date-time> | null

data.partner.billing_address.name

string | null

data.partner.billing_address.phone

string | null

Maximum string length: 20

data.partner.billing_address.postal_code

string | null

ZIP or postal code.

data.partner.billing_address.remote_id

string | null

The address' third party API ID.

data.partner.billing_address.state

string | null

State, county, province, or region.

data.partner.billing_address.type

string

Whether the address is a shipping, billing, or other type of address.

data.partner.billing_address_id

integer | null

data.partner.contacts

object[]

Show child attributes

data.partner.contacts.email

string

required

The contact's email address.

Maximum string length: 255

data.partner.contacts.object

string

required

data.partner.contacts.partner_id

string

required

Maximum string length: 32

data.partner.contacts.id

string

Maximum string length: 32

data.partner.contacts.address

object

Show child attributes

data.partner.contacts.address.object

string

required

data.partner.contacts.address.city

string | null

City, district, suburb, town, or village.

data.partner.contacts.address.coordinates

object

Option 1
Option 2

data.partner.contacts.address.country

string | null

Two-letter country code. (ISO 3166 alpha-2)

Maximum string length: 3

data.partner.contacts.address.created_at

string<date-time>

data.partner.contacts.address.description

string | null

data.partner.contacts.address.line1

string | null

Address line 1 (e.g., street, PO Box, or company name).

data.partner.contacts.address.line2

string | null

Address line 2 (e.g., apartment, suite, unit, or building).

data.partner.contacts.address.modified_at

string<date-time> | null

data.partner.contacts.address.name

string | null

data.partner.contacts.address.phone

string | null

Maximum string length: 20

data.partner.contacts.address.postal_code

string | null

ZIP or postal code.

data.partner.contacts.address.remote_id

string | null

The address' third party API ID.

data.partner.contacts.address.state

string | null

State, county, province, or region.

data.partner.contacts.address.type

string

Whether the address is a shipping, billing, or other type of address.

data.partner.contacts.address_id

integer | null

data.partner.contacts.addresses

object[]

Show child attributes

data.partner.contacts.addresses.object

string

required

data.partner.contacts.addresses.id

string

Maximum string length: 32

data.partner.contacts.addresses.city

string | null

City, district, suburb, town, or village.

data.partner.contacts.addresses.coordinates

object

Option 1
Option 2

data.partner.contacts.addresses.country

string | null

Two-letter country code. (ISO 3166 alpha-2)

Maximum string length: 3

data.partner.contacts.addresses.created_at

string<date-time>

data.partner.contacts.addresses.description

string | null

data.partner.contacts.addresses.is_primary

boolean

data.partner.contacts.addresses.line1

string | null

Address line 1 (e.g., street, PO Box, or company name).

data.partner.contacts.addresses.line2

string | null

Address line 2 (e.g., apartment, suite, unit, or building).

data.partner.contacts.addresses.modified_at

string<date-time> | null

data.partner.contacts.addresses.name

string | null

data.partner.contacts.addresses.postal_code

string | null

ZIP or postal code.

data.partner.contacts.addresses.state

string | null

State, county, province, or region.

data.partner.contacts.addresses.type

string

Whether the address is a shipping, billing, or other type of address.

data.partner.contacts.created_at

string<date-time>

data.partner.contacts.custom_fields

any

data.partner.contacts.external_role

enum<string> | null

The external contact's role.

Available options:

billing_contact,

executive,

economic_user,

Maximum string length: 15

data.partner.contacts.family_name

string | null

If an individual, the contact's family name.

data.partner.contacts.given_name

string | null

If an individual, the contact's given name.

data.partner.contacts.internal_role

enum<string> | null

The internal contact's role.

Available options:

account_manager,

account_executive,

csm,

Maximum string length: 17

data.partner.contacts.is_email_disabled

boolean

Whether the contact's email has been deemed invalid.

data.partner.contacts.is_phone_disabled

boolean

Whether the contact's email has been deemed invalid.

data.partner.contacts.is_primary

boolean

Whether the contact is a primary contact for the partner.

data.partner.contacts.is_primary_email

boolean

Whether the contact is the primary email contact for the partner.

data.partner.contacts.is_primary_phone

boolean

Whether the contact is the primary phone contact for the partner.

data.partner.contacts.job_title

string | null

The contact's job at their company.

data.partner.contacts.modified_at

string<date-time> | null

data.partner.contacts.name

string | null

The contact's name, if no given/family name.

data.partner.contacts.phone

string | null

The contact's phone number.

Maximum string length: 32

data.partner.contacts.remote_created_at

string<date-time> | null

When the third party's entry was created.

data.partner.contacts.remote_id

string | null

The contact's third party API ID.

data.partner.contacts.remote_metadata

unknown

data.partner.contacts.remote_modified_at

string<date-time> | null

When the third party's entry was updated.

data.partner.contacts.status_metadata

any

Holds metadata about why contact channel statuses changed, has source (email or call) as key values (e.g. {'email'|'call': {status: 'enabled'|'disabled', reason: str, timestamp: datetime}})

data.partner.created_at

string<date-time>

data.partner.currency

enum<string> | null

The partner's default currency code (e.g. USD).

Available options:

ADP,

AED,

AFA,

AFN,

ALK,

ALL,

AMD,

ANG,

AOA,

AOK,

AON,

AOR,

ARA,

ARL,

ARM,

ARP,

ARS,

ATS,

AUD,

AWG,

AZM,

AZN,

BAD,

BAM,

BAN,

BBD,

BDT,

BEC,

BEF,

BEL,

BGL,

BGM,

BGN,

BGO,

BHD,

BIF,

BMD,

BND,

BOB,

BOL,

BOP,

BOV,

BRB,

BRC,

BRE,

BRL,

BRN,

BRR,

BRZ,

BSD,

BTN,

BUK,

BWP,

BYB,

BYN,

BYR,

BZD,

CAD,

CDF,

CHE,

CHF,

CHW,

CLE,

CLF,

CLP,

CNH,

CNX,

CNY,

COP,

COU,

CRC,

CSD,

CSK,

CUC,

CUP,

CVE,

CYP,

CZK,

DDM,

DEM,

DJF,

DKK,

DOP,

DZD,

ECS,

ECV,

EEK,

EGP,

ERN,

ESA,

ESB,

ESP,

ETB,

EUR,

FIM,

FJD,

FKP,

FRF,

GBP,

GEK,

GEL,

GHC,

GHS,

GIP,

GMD,

GNF,

GNS,

GQE,

GRD,

GTQ,

GWE,

GWP,

GYD,

HKD,

HNL,

HRD,

HRK,

HTG,

HUF,

IDR,

IEP,

ILP,

ILR,

ILS,

INR,

IQD,

IRR,

ISJ,

ISK,

ITL,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRH,

KRO,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LTL,

LTT,

LUC,

LUF,

LUL,

LVL,

LVR,

LYD,

MAD,

MAF,

MCF,

MDC,

MDL,

MGA,

MGF,

MKD,

MKN,

MLF,

MMK,

MNT,

MOP,

MRO,

MRU,

MTL,

MTP,

MUR,

MVP,

MVR,

MWK,

MXN,

MXP,

MXV,

MYR,

MZE,

MZM,

MZN,

NAD,

NGN,

NIC,

NIO,

NLG,

NOK,

NPR,

NZD,

OMR,

PAB,

PEI,

PEN,

PES,

PGK,

PHP,

PKR,

PLN,

PLZ,

PTE,

PYG,

QAR,

RHD,

ROL,

RON,

RSD,

RUB,

RUR,

RWF,

SAR,

SBD,

SCR,

SDD,

SDG,

SDP,

SEK,

SGD,

SHP,

SIT,

SKK,

SLE,

SLL,

SOS,

SRD,

SRG,

SSP,

STD,

STN,

SUR,

SVC,

SYP,

SZL,

THB,

TJR,

TJS,

TMM,

TMT,

TND,

TOP,

TPE,

TRL,

TRY,

TTD,

TWD,

TZS,

UAH,

UAK,

UGS,

UGX,

USD,

USN,

USS,

UYI,

UYP,

UYU,

UYW,

UZS,

VEB,

VED,

VEF,

VES,

VND,

VNN,

VUV,

WST,

XAF,

XAG,

XAU,

XBA,

XBB,

XBC,

XBD,

XCD,

XCG,

XDR,

XEU,

XFO,

XFU,

XOF,

XPD,

XPF,

XPT,

XRE,

XSU,

XTS,

XUA,

XXX,

YDD,

YER,

YUD,

YUM,

YUN,

YUR,

ZAL,

ZAR,

ZMK,

ZMW,

ZRN,

ZRZ,

ZWD,

ZWL,

ZWR,

Maximum string length: 3

data.partner.custom_fields

any

data.partner.description

string | null

A description of the partner.

data.partner.email

string | null

The partner's company email address.

Maximum string length: 255

data.partner.family_name

string | null

The partner's family name.

data.partner.finix_identity_id

string | null

data.partner.given_name

string | null

The partner's given name.

data.partner.invoice_prefix

string | null

The prefix for this partner's invoice numbers.

data.partner.is_active

boolean

Whether the partner is active.

data.partner.is_company

boolean

Whether the partner is a company or individual.

data.partner.is_email_disabled

boolean

Whether the partner's email address is no longer valid.

data.partner.is_phone_disabled

boolean

Whether the partner's email address is no longer valid.

data.partner.is_primary_email

boolean

Whether the partner's email is the primary email contact.

data.partner.is_primary_phone

boolean

Whether the partner's phone number is the primary phone contact.

data.partner.last_outreach_at

string<date-time> | null

The last date outreach was sent for this partner.

data.partner.last_outreach_channel

enum<string> | null

The last channel outreach was sent in for this partner (phone or email).

Available options:

email,

call,

Maximum string length: 5

data.partner.last_outreach_to

string | null

The last recipient of outreach that was sent for this partner (email address or phone number).

data.partner.last_synced_at

string<date-time> | null

data.partner.legal_name

string | null

The legal name of this partner, typically applies to businesses.

data.partner.linked_integration

object

Show child attributes

data.partner.linked_integration.integration_name

string

required

data.partner.linked_integration.is_configured

boolean

required

data.partner.linked_integration.object

string

required

data.partner.linked_integration.settings

object

required

Show child attributes

data.partner.linked_integration.settings.{key}

any

data.partner.linked_integration.id

string

Maximum string length: 32

data.partner.linked_integration.api_subdomain

string | null

data.partner.linked_integration.api_url

string | null

data.partner.linked_integration.connection_info

unknown

data.partner.linked_integration.created_at

string<date-time>

data.partner.linked_integration.credentials_expire_at

string<date-time> | null

The time at which the credentials expire.

data.partner.linked_integration.health

object

Show child attributes

data.partner.linked_integration.health.status

enum<string>

required

Available options:

incomplete,

relink_required,

unhealthy,

healthy

data.partner.linked_integration.health.details

object

Show child attributes

data.partner.linked_integration.health.details.{key}

unknown

data.partner.linked_integration.health.message

string | null

data.partner.linked_integration.health.reason

any | null

Available options:

invalid_credentials,

missing_permission,

missing_settings,

unknown_error,

connection_issue,

timeout,

data.partner.linked_integration.identity_info

unknown

data.partner.linked_integration.integration

object

Show child attributes

data.partner.linked_integration.integration.display_name

string

required

data.partner.linked_integration.integration.name

string

required

data.partner.linked_integration.integration.object

string

required

data.partner.linked_integration.integration.api_base_url

string

data.partner.linked_integration.integration.api_documentation_url

string | null

data.partner.linked_integration.integration.api_requires_subdomain

boolean

default:false

data.partner.linked_integration.integration.auth_type

any | null

Available options:

api_key,

basic,

custom,

oauth1,

oauth2,

oauth2_cc,

data.partner.linked_integration.integration.categories

enum<string>[]

Available options:

accounting,

banking,

crm,

file-storage,

communication

data.partner.linked_integration.integration.color

string | null

data.partner.linked_integration.integration.connection_guide_url

string | null

data.partner.linked_integration.integration.connection_instructions

string[] | null

data.partner.linked_integration.integration.connection_steps

object[]

Show child attributes

data.partner.linked_integration.integration.connection_steps.type

enum<string>

required

Available options:

fetch,

form,

quickbooks-desktop

data.partner.linked_integration.integration.connection_steps.title

string

required

data.partner.linked_integration.integration.connection_steps.description

string | null

data.partner.linked_integration.integration.connection_steps.endpoint

string | null

data.partner.linked_integration.integration.connection_steps.fields

object[] | null

Show child attributes

data.partner.linked_integration.integration.connection_steps.fields.setting

string | null

data.partner.linked_integration.integration.connection_steps.post_auth

boolean

default:false

data.partner.linked_integration.integration.created_at

string<date-time>

data.partner.linked_integration.integration.description

string | null

data.partner.linked_integration.integration.is_enabled

boolean

default:true

data.partner.linked_integration.integration.logo

string | null

data.partner.linked_integration.integration.logo_square

string | null

data.partner.linked_integration.integration.modified_at

string<date-time> | null

data.partner.linked_integration.integration.settings

object[]

Show child attributes

data.partner.linked_integration.integration.settings.key

string

required

data.partner.linked_integration.integration.settings.type

enum<string>

required

Available options:

any,

array,

boolean,

integer,

number,

object,

string

data.partner.linked_integration.integration.settings.choices

object[] | null

Show child attributes

data.partner.linked_integration.integration.settings.choices.label

string

required

The label of the choice.

data.partner.linked_integration.integration.settings.choices.value

any

required

The value of the choice.

data.partner.linked_integration.integration.settings.description

string | null

data.partner.linked_integration.integration.settings.format

enum<string>

default:text

The format of the choice.

Available options:

binary,

byte,

color,

date,

datetime,

date-time,

decimal,

double,

email,

enum,

float,

hostname,

password,

tel,

text,

time,

timestamp,

uri,

uuid

data.partner.linked_integration.integration.settings.group

string | null

data.partner.linked_integration.integration.settings.guide_url

string | null

data.partner.linked_integration.integration.settings.is_editable

boolean

default:false

data.partner.linked_integration.integration.settings.is_required

boolean

default:true

data.partner.linked_integration.integration.settings.is_select

boolean

default:false

data.partner.linked_integration.integration.settings.label

string | null

data.partner.linked_integration.integration.settings.post_auth

boolean

default:false

data.partner.linked_integration.integration.settings.requires_load

boolean

default:false

data.partner.linked_integration.integration.short_description

string | null

data.partner.linked_integration.is_running_setup

boolean

data.partner.linked_integration.is_sync_disabled

boolean

Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc.

data.partner.linked_integration.is_webhooks_enabled

boolean

data.partner.linked_integration.models

object[]

Show child attributes

data.partner.linked_integration.models.integration_schema_id

string

required

Maximum string length: 32

data.partner.linked_integration.models.linked_integration_id

string

required

Maximum string length: 32

data.partner.linked_integration.models.name

string

required

data.partner.linked_integration.models.object

string

required

data.partner.linked_integration.models.id

string

Maximum string length: 32

data.partner.linked_integration.models.created_at

string<date-time>

data.partner.linked_integration.models.exclude_rule

object

data.partner.linked_integration.models.field_mappings

unknown

data.partner.linked_integration.models.health

object

Show child attributes

data.partner.linked_integration.models.health.status

enum<string>

required

Available options:

incomplete,

unhealthy,

healthy

data.partner.linked_integration.models.health.details

object

Show child attributes

data.partner.linked_integration.models.health.details.{key}

unknown

data.partner.linked_integration.models.health.message

string | null

data.partner.linked_integration.models.health.reason

any | null

Available options:

incomplete_field_mappings,

missing_integration_schema,

missing_permission,

unknown_error,

connection_issue,

timeout,

data.partner.linked_integration.models.is_read_enabled

boolean

data.partner.linked_integration.models.is_webhooks_setup

boolean

data.partner.linked_integration.models.is_write_enabled

boolean

data.partner.linked_integration.models.last_sync

object

Show child attributes

data.partner.linked_integration.models.last_sync.linked_model_id

string

required

Maximum string length: 32

data.partner.linked_integration.models.last_sync.object

string

required

data.partner.linked_integration.models.last_sync.run_id

string

required

Maximum string length: 32

data.partner.linked_integration.models.last_sync.id

string

Maximum string length: 32

data.partner.linked_integration.models.last_sync.created_at

string<date-time>

data.partner.linked_integration.models.last_sync.entity_id

string | null

data.partner.linked_integration.models.last_sync.is_initial_sync

boolean

data.partner.linked_integration.models.last_sync.is_one_off

boolean

Whether or not this is a one off sync

data.partner.linked_integration.models.last_sync.modified_at

string<date-time> | null

data.partner.linked_integration.models.last_sync.pagination

unknown

data.partner.linked_integration.models.last_sync.run

object

Show child attributes

data.partner.linked_integration.models.last_sync.run.object

string

required

data.partner.linked_integration.models.last_sync.run.id

string

Maximum string length: 32

data.partner.linked_integration.models.last_sync.run.completed_at

string<date-time> | null

data.partner.linked_integration.models.last_sync.run.created_at

string<date-time>

data.partner.linked_integration.models.last_sync.run.data

unknown

data.partner.linked_integration.models.last_sync.run.event_id

string | null

Maximum string length: 32

data.partner.linked_integration.models.last_sync.run.modified_at

string<date-time> | null

data.partner.linked_integration.models.last_sync.run.output

unknown

data.partner.linked_integration.models.last_sync.run.remote_id

string | null

The external id of the function run (e.g. inngest function run id)

data.partner.linked_integration.models.last_sync.run.stacktrace

string | null

data.partner.linked_integration.models.last_sync.run.started_at

string<date-time> | null

data.partner.linked_integration.models.last_sync.run.status

enum<string>

Available options:

scheduled,

queued,

skipped,

running,

cancelled,

failed,

pending_retry,

complete

Maximum string length: 13

data.partner.linked_integration.models.last_sync.timerange_end

string<date-time> | null

data.partner.linked_integration.models.last_sync.timerange_start

string<date-time> | null

data.partner.linked_integration.models.last_sync_id

string | null

Maximum string length: 32

data.partner.linked_integration.models.modified_at

string<date-time> | null

data.partner.linked_integration.models.next_sync_at

string<date-time> | null

data.partner.linked_integration.models.sync_requested

boolean

data.partner.linked_integration.modified_at

string<date-time> | null

data.partner.linked_integration.name

string | null

User defined name of the linked integration.

data.partner.linked_integration.owner_id

string | null

Maximum string length: 32

data.partner.linked_integration.requires_setup

boolean

data.partner.linked_integration.username

string | null

data.partner.linked_integration.webhook_listener_url

string | null

data.partner.linked_integration.webhook_setup_error

string | null

data.partner.modified_at

string<date-time> | null

data.partner.name

string | null

The full name of the partner.

data.partner.object

string

data.partner.on_behalf_of

string | null

The name of the person or entity your organization is contacting this customer for.

data.partner.on_behalf_of_phone

string | null

The number of the person or entity your organization is contacting this customer for.

Maximum string length: 32

data.partner.organization_id

string

Maximum string length: 32

data.partner.parent_id

string | null

Maximum string length: 32

data.partner.phone

string | null

The partner's default phone number.

Maximum string length: 32

data.partner.remote_created_at

string<date-time> | null

When the third party's entry was created.

data.partner.remote_id

string

The partner's third party id.

data.partner.remote_metadata

unknown

data.partner.remote_modified_at

string<date-time> | null

When the third party's entry was updated.

data.partner.remote_parent_id

string | null

The partner's third party parent partner id.

data.partner.remote_payment_portal_url

string | null

The partner's third party payment portal url.

data.partner.shipping_address

object

Show child attributes

data.partner.shipping_address.object

string

required

data.partner.shipping_address.city

string | null

City, district, suburb, town, or village.

data.partner.shipping_address.coordinates

object

Option 1
Option 2

data.partner.shipping_address.country

string | null

Two-letter country code. (ISO 3166 alpha-2)

Maximum string length: 3

data.partner.shipping_address.created_at

string<date-time>

data.partner.shipping_address.description

string | null

data.partner.shipping_address.line1

string | null

Address line 1 (e.g., street, PO Box, or company name).

data.partner.shipping_address.line2

string | null

Address line 2 (e.g., apartment, suite, unit, or building).

data.partner.shipping_address.modified_at

string<date-time> | null

data.partner.shipping_address.name

string | null

data.partner.shipping_address.phone

string | null

Maximum string length: 20

data.partner.shipping_address.postal_code

string | null

ZIP or postal code.

data.partner.shipping_address.remote_id

string | null

The address' third party API ID.

data.partner.shipping_address.state

string | null

State, county, province, or region.

data.partner.shipping_address.type

string

Whether the address is a shipping, billing, or other type of address.

data.partner.status_metadata

any

Holds metadata about why contact channel statuses changed,, has source (email or call) as key values (e.g. {'email'|'phone': {status: 'enabled'|'disabled', reason: str, timestamp: datetime}})

data.partner.sync_status

enum<string>

The sync status for this entity.

Available options:

partial,

syncing,

synced,

failed

Maximum string length: 7

data.partner.tags

object[]

Show child attributes

data.partner.tags.object

string

required

data.partner.tags.partner_id

string

required

Maximum string length: 32

data.partner.tags.tag_id

string

required

Maximum string length: 32

data.partner.tags.created_at

string<date-time>

data.partner.tags.is_manual

boolean

Whether the tag was manually assigned to the partner or automatically matched using rules

data.partner.tags.modified_at

string<date-time> | null

data.partner.tags.tag

object

Show child attributes

data.partner.tags.tag.name

string

required

The name of the tag.

data.partner.tags.tag.object

string

required

data.partner.tags.tag.id

string

Maximum string length: 32

data.partner.tags.tag.color

string

The hex color code of the tag, if any.

Maximum string length: 20

data.partner.tags.tag.created_at

string<date-time>

data.partner.tags.tag.modified_at

string<date-time> | null

data.partner.tags.tag.rule_condition

object

data.partner.tax_number

string | null

Tax number - this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global).

data.partner.timezone

enum<string>

Available options:

Africa/Abidjan,

Africa/Accra,

Africa/Addis_Ababa,

Africa/Algiers,

Africa/Asmara,

Africa/Asmera,

Africa/Bamako,

Africa/Bangui,

Africa/Banjul,

Africa/Bissau,

Africa/Blantyre,

Africa/Brazzaville,

Africa/Bujumbura,

Africa/Cairo,

Africa/Casablanca,

Africa/Ceuta,

Africa/Conakry,

Africa/Dakar,

Africa/Dar_es_Salaam,

Africa/Djibouti,

Africa/Douala,

Africa/El_Aaiun,

Africa/Freetown,

Africa/Gaborone,

Africa/Harare,

Africa/Johannesburg,

Africa/Juba,

Africa/Kampala,

Africa/Khartoum,

Africa/Kigali,

Africa/Kinshasa,

Africa/Lagos,

Africa/Libreville,

Africa/Lome,

Africa/Luanda,

Africa/Lubumbashi,

Africa/Lusaka,

Africa/Malabo,

Africa/Maputo,

Africa/Maseru,

Africa/Mbabane,

Africa/Mogadishu,

Africa/Monrovia,

Africa/Nairobi,

Africa/Ndjamena,

Africa/Niamey,

Africa/Nouakchott,

Africa/Ouagadougou,

Africa/Porto-Novo,

Africa/Sao_Tome,

Africa/Timbuktu,

Africa/Tripoli,

Africa/Tunis,

Africa/Windhoek,

America/Adak,

America/Anchorage,

America/Anguilla,

America/Antigua,

America/Araguaina,

America/Argentina/Buenos_Aires,

America/Argentina/Catamarca,

America/Argentina/ComodRivadavia,

America/Argentina/Cordoba,

America/Argentina/Jujuy,

America/Argentina/La_Rioja,

America/Argentina/Mendoza,

America/Argentina/Rio_Gallegos,

America/Argentina/Salta,

America/Argentina/San_Juan,

America/Argentina/San_Luis,

America/Argentina/Tucuman,

America/Argentina/Ushuaia,

America/Aruba,

America/Asuncion,

America/Atikokan,

America/Atka,

America/Bahia,

America/Bahia_Banderas,

America/Barbados,

America/Belem,

America/Belize,

America/Blanc-Sablon,

America/Boa_Vista,

America/Bogota,

America/Boise,

America/Buenos_Aires,

America/Cambridge_Bay,

America/Campo_Grande,

America/Cancun,

America/Caracas,

America/Catamarca,

America/Cayenne,

America/Cayman,

America/Chicago,

America/Chihuahua,

America/Ciudad_Juarez,

America/Coral_Harbour,

America/Cordoba,

America/Costa_Rica,

America/Creston,

America/Cuiaba,

America/Curacao,

America/Danmarkshavn,

America/Dawson,

America/Dawson_Creek,

America/Denver,

America/Detroit,

America/Dominica,

America/Edmonton,

America/Eirunepe,

America/El_Salvador,

America/Ensenada,

America/Fort_Nelson,

America/Fort_Wayne,

America/Fortaleza,

America/Glace_Bay,

America/Godthab,

America/Goose_Bay,

America/Grand_Turk,

America/Grenada,

America/Guadeloupe,

America/Guatemala,

America/Guayaquil,

America/Guyana,

America/Halifax,

America/Havana,

America/Hermosillo,

America/Indiana/Indianapolis,

America/Indiana/Knox,

America/Indiana/Marengo,

America/Indiana/Petersburg,

America/Indiana/Tell_City,

America/Indiana/Vevay,

America/Indiana/Vincennes,

America/Indiana/Winamac,

America/Indianapolis,

America/Inuvik,

America/Iqaluit,

America/Jamaica,

America/Jujuy,

America/Juneau,

America/Kentucky/Louisville,

America/Kentucky/Monticello,

America/Knox_IN,

America/Kralendijk,

America/La_Paz,

America/Lima,

America/Los_Angeles,

America/Louisville,

America/Lower_Princes,

America/Maceio,

America/Managua,

America/Manaus,

America/Marigot,

America/Martinique,

America/Matamoros,

America/Mazatlan,

America/Mendoza,

America/Menominee,

America/Merida,

America/Metlakatla,

America/Mexico_City,

America/Miquelon,

America/Moncton,

America/Monterrey,

America/Montevideo,

America/Montreal,

America/Montserrat,

America/Nassau,

America/New_York,

America/Nipigon,

America/Nome,

America/Noronha,

America/North_Dakota/Beulah,

America/North_Dakota/Center,

America/North_Dakota/New_Salem,

America/Nuuk,

America/Ojinaga,

America/Panama,

America/Pangnirtung,

America/Paramaribo,

America/Phoenix,

America/Port-au-Prince,

America/Port_of_Spain,

America/Porto_Acre,

America/Porto_Velho,

America/Puerto_Rico,

America/Punta_Arenas,

America/Rainy_River,

America/Rankin_Inlet,

America/Recife,

America/Regina,

America/Resolute,

America/Rio_Branco,

America/Rosario,

America/Santa_Isabel,

America/Santarem,

America/Santiago,

America/Santo_Domingo,

America/Sao_Paulo,

America/Scoresbysund,

America/Shiprock,

America/Sitka,

America/St_Barthelemy,

America/St_Johns,

America/St_Kitts,

America/St_Lucia,

America/St_Thomas,

America/St_Vincent,

America/Swift_Current,

America/Tegucigalpa,

America/Thule,

America/Thunder_Bay,

America/Tijuana,

America/Toronto,

America/Tortola,

America/Vancouver,

America/Virgin,

America/Whitehorse,

America/Winnipeg,

America/Yakutat,

America/Yellowknife,

Antarctica/Casey,

Antarctica/Davis,

Antarctica/DumontDUrville,

Antarctica/Macquarie,

Antarctica/Mawson,

Antarctica/McMurdo,

Antarctica/Palmer,

Antarctica/Rothera,

Antarctica/South_Pole,

Antarctica/Syowa,

Antarctica/Troll,

Antarctica/Vostok,

Arctic/Longyearbyen,

Asia/Aden,

Asia/Almaty,

Asia/Amman,

Asia/Anadyr,

Asia/Aqtau,

Asia/Aqtobe,

Asia/Ashgabat,

Asia/Ashkhabad,

Asia/Atyrau,

Asia/Baghdad,

Asia/Bahrain,

Asia/Baku,

Asia/Bangkok,

Asia/Barnaul,

Asia/Beirut,

Asia/Bishkek,

Asia/Brunei,

Asia/Calcutta,

Asia/Chita,

Asia/Choibalsan,

Asia/Chongqing,

Asia/Chungking,

Asia/Colombo,

Asia/Dacca,

Asia/Damascus,

Asia/Dhaka,

Asia/Dili,

Asia/Dubai,

Asia/Dushanbe,

Asia/Famagusta,

Asia/Gaza,

Asia/Harbin,

Asia/Hebron,

Asia/Ho_Chi_Minh,

Asia/Hong_Kong,

Asia/Hovd,

Asia/Irkutsk,

Asia/Istanbul,

Asia/Jakarta,

Asia/Jayapura,

Asia/Jerusalem,

Asia/Kabul,

Asia/Kamchatka,

Asia/Karachi,

Asia/Kashgar,

Asia/Kathmandu,

Asia/Katmandu,

Asia/Khandyga,

Asia/Kolkata,

Asia/Krasnoyarsk,

Asia/Kuala_Lumpur,

Asia/Kuching,

Asia/Kuwait,

Asia/Macao,

Asia/Macau,

Asia/Magadan,

Asia/Makassar,

Asia/Manila,

Asia/Muscat,

Asia/Nicosia,

Asia/Novokuznetsk,

Asia/Novosibirsk,

Asia/Omsk,

Asia/Oral,

Asia/Phnom_Penh,

Asia/Pontianak,

Asia/Pyongyang,

Asia/Qatar,

Asia/Qostanay,

Asia/Qyzylorda,

Asia/Rangoon,

Asia/Riyadh,

Asia/Saigon,

Asia/Sakhalin,

Asia/Samarkand,

Asia/Seoul,

Asia/Shanghai,

Asia/Singapore,

Asia/Srednekolymsk,

Asia/Taipei,

Asia/Tashkent,

Asia/Tbilisi,

Asia/Tehran,

Asia/Tel_Aviv,

Asia/Thimbu,

Asia/Thimphu,

Asia/Tokyo,

Asia/Tomsk,

Asia/Ujung_Pandang,

Asia/Ulaanbaatar,

Asia/Ulan_Bator,

Asia/Urumqi,

Asia/Ust-Nera,

Asia/Vientiane,

Asia/Vladivostok,

Asia/Yakutsk,

Asia/Yangon,

Asia/Yekaterinburg,

Asia/Yerevan,

Atlantic/Azores,

Atlantic/Bermuda,

Atlantic/Canary,

Atlantic/Cape_Verde,

Atlantic/Faeroe,

Atlantic/Faroe,

Atlantic/Jan_Mayen,

Atlantic/Madeira,

Atlantic/Reykjavik,

Atlantic/South_Georgia,

Atlantic/St_Helena,

Atlantic/Stanley,

Australia/ACT,

Australia/Adelaide,

Australia/Brisbane,

Australia/Broken_Hill,

Australia/Canberra,

Australia/Currie,

Australia/Darwin,

Australia/Eucla,

Australia/Hobart,

Australia/LHI,

Australia/Lindeman,

Australia/Lord_Howe,

Australia/Melbourne,

Australia/NSW,

Australia/North,

Australia/Perth,

Australia/Queensland,

Australia/South,

Australia/Sydney,

Australia/Tasmania,

Australia/Victoria,

Australia/West,

Australia/Yancowinna,

Brazil/Acre,

Brazil/DeNoronha,

Brazil/East,

Brazil/West,

CET,

CST6CDT,

Canada/Atlantic,

Canada/Central,

Canada/Eastern,

Canada/Mountain,

Canada/Newfoundland,

Canada/Pacific,

Canada/Saskatchewan,

Canada/Yukon,

Chile/Continental,

Chile/EasterIsland,

Cuba,

EET,

EST,

EST5EDT,

Egypt,

Eire,

Etc/GMT,

Etc/GMT+0,

Etc/GMT+1,

Etc/GMT+10,

Etc/GMT+11,

Etc/GMT+12,

Etc/GMT+2,

Etc/GMT+3,

Etc/GMT+4,

Etc/GMT+5,

Etc/GMT+6,

Etc/GMT+7,

Etc/GMT+8,

Etc/GMT+9,

Etc/GMT-0,

Etc/GMT-1,

Etc/GMT-10,

Etc/GMT-11,

Etc/GMT-12,

Etc/GMT-13,

Etc/GMT-14,

Etc/GMT-2,

Etc/GMT-3,

Etc/GMT-4,

Etc/GMT-5,

Etc/GMT-6,

Etc/GMT-7,

Etc/GMT-8,

Etc/GMT-9,

Etc/GMT0,

Etc/Greenwich,

Etc/UCT,

Etc/UTC,

Etc/Universal,

Etc/Zulu,

Europe/Amsterdam,

Europe/Andorra,

Europe/Astrakhan,

Europe/Athens,

Europe/Belfast,

Europe/Belgrade,

Europe/Berlin,

Europe/Bratislava,

Europe/Brussels,

Europe/Bucharest,

Europe/Budapest,

Europe/Busingen,

Europe/Chisinau,

Europe/Copenhagen,

Europe/Dublin,

Europe/Gibraltar,

Europe/Guernsey,

Europe/Helsinki,

Europe/Isle_of_Man,

Europe/Istanbul,

Europe/Jersey,

Europe/Kaliningrad,

Europe/Kiev,

Europe/Kirov,

Europe/Kyiv,

Europe/Lisbon,

Europe/Ljubljana,

Europe/London,

Europe/Luxembourg,

Europe/Madrid,

Europe/Malta,

Europe/Mariehamn,

Europe/Minsk,

Europe/Monaco,

Europe/Moscow,

Europe/Nicosia,

Europe/Oslo,

Europe/Paris,

Europe/Podgorica,

Europe/Prague,

Europe/Riga,

Europe/Rome,

Europe/Samara,

Europe/San_Marino,

Europe/Sarajevo,

Europe/Saratov,

Europe/Simferopol,

Europe/Skopje,

Europe/Sofia,

Europe/Stockholm,

Europe/Tallinn,

Europe/Tirane,

Europe/Tiraspol,

Europe/Ulyanovsk,

Europe/Uzhgorod,

Europe/Vaduz,

Europe/Vatican,

Europe/Vienna,

Europe/Vilnius,

Europe/Volgograd,

Europe/Warsaw,

Europe/Zagreb,

Europe/Zaporozhye,

Europe/Zurich,

GB,

GB-Eire,

GMT,

GMT+0,

GMT-0,

GMT0,

Greenwich,

HST,

Hongkong,

Iceland,

Indian/Antananarivo,

Indian/Chagos,

Indian/Christmas,

Indian/Cocos,

Indian/Comoro,

Indian/Kerguelen,

Indian/Mahe,

Indian/Maldives,

Indian/Mauritius,

Indian/Mayotte,

Indian/Reunion,

Iran,

Israel,

Jamaica,

Japan,

Kwajalein,

Libya,

MET,

MST,

MST7MDT,

Mexico/BajaNorte,

Mexico/BajaSur,

Mexico/General,

NZ,

NZ-CHAT,

Navajo,

PRC,

PST8PDT,

Pacific/Apia,

Pacific/Auckland,

Pacific/Bougainville,

Pacific/Chatham,

Pacific/Chuuk,

Pacific/Easter,

Pacific/Efate,

Pacific/Enderbury,

Pacific/Fakaofo,

Pacific/Fiji,

Pacific/Funafuti,

Pacific/Galapagos,

Pacific/Gambier,

Pacific/Guadalcanal,

Pacific/Guam,

Pacific/Honolulu,

Pacific/Johnston,

Pacific/Kanton,

Pacific/Kiritimati,

Pacific/Kosrae,

Pacific/Kwajalein,

Pacific/Majuro,

Pacific/Marquesas,

Pacific/Midway,

Pacific/Nauru,

Pacific/Niue,

Pacific/Norfolk,

Pacific/Noumea,

Pacific/Pago_Pago,

Pacific/Palau,

Pacific/Pitcairn,

Pacific/Pohnpei,

Pacific/Ponape,

Pacific/Port_Moresby,

Pacific/Rarotonga,

Pacific/Saipan,

Pacific/Samoa,

Pacific/Tahiti,

Pacific/Tarawa,

Pacific/Tongatapu,

Pacific/Truk,

Pacific/Wake,

Pacific/Wallis,

Pacific/Yap,

Poland,

Portugal,

ROC,

ROK,

Singapore,

Turkey,

UCT,

US/Alaska,

US/Aleutian,

US/Arizona,

US/Central,

US/East-Indiana,

US/Eastern,

US/Hawaii,

US/Indiana-Starke,

US/Michigan,

US/Mountain,

US/Pacific,

US/Samoa,

UTC,

Universal,

W-SU,

WET,

Zulu

Maximum string length: 50

data.partner_id

string | null

The id of the partner associated with the transaction.

Maximum string length: 32

data.payment_method

enum<string> | null

The method of the transaction.

Available options:

ach,

alipay,

au_becs,

bacs,

card,

cash,

check,

ideal,

interac,

eft,

eps,

giropay,

klarna,

sepa,

wechat,

wire,

other,

Maximum string length: 7

data.remote_created_at

string<date-time> | null

When the third party's entry was created.

data.remote_id

string | null

The external ID of the bank transaction. Only exists if the transaction belongs to an account that is related to a bank feed connection.

data.remote_metadata

unknown

data.remote_modified_at

string<date-time> | null

When the third party's entry was updated.

data.statement_id

string | null

Maximum string length: 32

data.sync_status

enum<string> | null

The sync status for the bank transaction.

Available options:

partial,

syncing,

synced,

failed,

Maximum string length: 7

data.transaction_code

string | null

current_page

integer

default:0

The current page.

total_records

integer

default:0

Total number of records.

next_page

integer | null

The next page, if one exists.

Analytics

Bank Accounts

Bank Statements

Bank Transactions

Call Agent Scenarios

Call Agents

Calls

Contact Suggestions

Email Senders

Email Template Folders

Email Templates

Email Threads

Emails

Files

Invoices

Notes

Organizations

Outreach Workflows

Partners

Partner Contacts

Payments

Phone Numbers

Profile

Remittances

Tags

Tasks

User Invites

Users

List Bank Transactions

Authorizations

Query Parameters

Response