List Invoices

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

sort_order

enum<string>

Available options:

asc,

desc

sort_by

enum<string>

Available options:

amount_due,

amount_remaining,

due_date,

issued_at,

paid_at,

number,

last_inbound_at,

last_outreach_at,

total_amount

number

string[]

task

string

The Task identifier, (e.g. tsk_abc123).

string

amount_remaining

string

status

enum<string>[]

Available options:

draft,

open,

uncollectible,

paid,

void,

processing,

overdue

istatus

string

issued_at

string

has_outreach

boolean

customer_outreach_paused

boolean

Response

Successful response

data

object[]

Show child attributes

data.amount_due

integer

required

The amount to be paid on invoice, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

data.currency

enum<string>

required

The invoice's 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.object

string

required

data.remote_id

string

required

The invoice's third party API ID.

data.total_amount

integer

required

The total amount of the invoice, including tax and allowances, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

data.id

string

Maximum string length: 32

data.amount_paid

integer

The invoice's total amount paid, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

data.assignee

object

Show child attributes

data.assignee.email

string

required

Maximum string length: 255

data.assignee.family_name

string

required

data.assignee.given_name

string

required

data.assignee.object

string

required

data.assignee.organization_id

string

required

Maximum string length: 32

data.assignee.id

string

Maximum string length: 32

data.assignee.created_at

string<date-time>

data.assignee.dashboard_settings

object

Show child attributes

data.assignee.dashboard_settings.thread_emails_sort_order

string

default:asc

data.assignee.default_email_sender_id

string | null

Maximum string length: 32

data.assignee.invited_by_user_id

string | null

Maximum string length: 32

data.assignee.is_access_approved

boolean

data.assignee.is_org_admin

boolean

data.assignee.modified_at

string<date-time> | null

data.assignee.name

string

data.assignee.onboarding_required

boolean

data.assignee.profile_picture

string

data.assignee.selected

boolean

data.billing_address

object

Show child attributes

data.billing_address.object

string

required

data.billing_address.city

string | null

City, district, suburb, town, or village.

data.billing_address.coordinates

object

Option 1
Option 2

data.billing_address.country

string | null

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

Maximum string length: 3

data.billing_address.created_at

string<date-time>

data.billing_address.description

string | null

data.billing_address.line1

string | null

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

data.billing_address.line2

string | null

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

data.billing_address.modified_at

string<date-time> | null

data.billing_address.name

string | null

data.billing_address.phone

string | null

Maximum string length: 20

data.billing_address.postal_code

string | null

ZIP or postal code.

data.billing_address.remote_id

string | null

The address' third party API ID.

data.billing_address.state

string | null

State, county, province, or region.

data.billing_address.type

string

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

data.billing_address_id

integer | null

data.billing_email

string | null

Maximum string length: 255

data.calls

object[]

Show child attributes

data.calls.direction

enum<string>

required

Available options:

inbound,

outbound

Maximum string length: 8

data.calls.object

string

required

data.calls.to_number

string

required

The number to call

data.calls.id

string

Maximum string length: 32

data.calls.agent_id

string | null

data.calls.approver

object

Show child attributes

data.calls.approver.email

string

required

Maximum string length: 255

data.calls.approver.family_name

string

required

data.calls.approver.given_name

string

required

data.calls.approver.object

string

required

data.calls.approver.organization_id

string

required

Maximum string length: 32

data.calls.approver.id

string

Maximum string length: 32

data.calls.approver.created_at

string<date-time>

data.calls.approver.dashboard_settings

object

Show child attributes

data.calls.approver.dashboard_settings.thread_emails_sort_order

string

default:asc

data.calls.approver.default_email_sender_id

string | null

Maximum string length: 32

data.calls.approver.invited_by_user_id

string | null

Maximum string length: 32

data.calls.approver.is_access_approved

boolean

data.calls.approver.is_org_admin

boolean

data.calls.approver.modified_at

string<date-time> | null

data.calls.approver.name

string

data.calls.approver.onboarding_required

boolean

data.calls.approver.profile_picture

string

data.calls.approver.selected

boolean

data.calls.approver_id

string | null

Maximum string length: 32

data.calls.call_agent_id

string | null

Maximum string length: 32

data.calls.call_reason

string | null

data.calls.classifications

object[]

Show child attributes

data.calls.classifications.agent_reply_reason

string

required

Very short reason for LLM's chain of thought for setting is_response_required to True or False.

data.calls.classifications.classification

enum<string>

required

The type of this interaction

Available options:

payment_inquiry,

payment_promise,

account_inquiry,

invoice_inquiry,

refund_request,

cancellation_request,

support_request,

complaint,

feedback,

wrong_contact,

message_forwarding_request,

cc_inclusion_request,

not_available,

contact_inquiry,

other

Maximum string length: 26

data.calls.classifications.is_action_required

boolean

required

Whether an action or actions need to be taken as a result of this interaction

data.calls.classifications.is_reply_required

boolean

required

Whether an email needs to be sent as a reply to this interaction

data.calls.classifications.object

string

required

data.calls.classifications.reason

string

required

The reason for the classifications of the interaction

data.calls.classifications.action_recommendation

string | null

Necessary actions that need to be taken in response to this interaction

data.calls.classifications.agent_confidence_reason

string | null

The justification for the agent's confidence score.

data.calls.classifications.agent_confidence_score

integer | null

The confidence score of the result on a scale of 0-100, where 0 indicates no confidence in the accuracy of the result and 100 indicates full confidence in the accuracy of the result.

data.calls.classifications.agent_error_code

string | null

The code for why an error occurred when processing the statement.

data.calls.classifications.agent_uncertainties

string[]

A list of uncertainties we have regarding the result.

data.calls.classifications.created_at

string<date-time>

data.calls.classifications.language

string

The detected language of the interaction using ISO 639-1 alpha-2 code.

Maximum string length: 2

data.calls.classifications.modified_at

string<date-time> | null

data.calls.classifications.tasks

object[]

Show child attributes

data.calls.classifications.tasks.label

string

required

The blurb or label for the task.

data.calls.classifications.tasks.object

string

required

data.calls.classifications.tasks.organization_id

string

required

The ID of the organization this task belongs to.

Maximum string length: 32

data.calls.classifications.tasks.type

enum<string>

required

The type of the task.

Available options:

activity_summary_outreach,

activity_summary_payments,

auto_response_email,

auto_response_call,

call_analysis,

disable_contact,

recommendation_new_contact,

scheduled_email_approval,

scheduled_call_approval

Maximum string length: 26

data.calls.classifications.tasks.id

string

Maximum string length: 32

data.calls.classifications.tasks.action_taken

enum<string> | null

The action taken on the task that affected its current state.

Available options:

complete,

complete_with_action,

close,

Maximum string length: 20

data.calls.classifications.tasks.assignee

object

Show child attributes

data.calls.classifications.tasks.assignee.email

string

required

Maximum string length: 255

data.calls.classifications.tasks.assignee.family_name

string

required

data.calls.classifications.tasks.assignee.given_name

string

required

data.calls.classifications.tasks.assignee.object

string

required

data.calls.classifications.tasks.assignee.organization_id

string

required

Maximum string length: 32

data.calls.classifications.tasks.assignee.id

string

Maximum string length: 32

data.calls.classifications.tasks.assignee.created_at

string<date-time>

data.calls.classifications.tasks.assignee.dashboard_settings

object

Show child attributes

data.calls.classifications.tasks.assignee.dashboard_settings.thread_emails_sort_order

string

default:asc

data.calls.classifications.tasks.assignee.default_email_sender_id

string | null

Maximum string length: 32

data.calls.classifications.tasks.assignee.invited_by_user_id

string | null

Maximum string length: 32

data.calls.classifications.tasks.assignee.is_access_approved

boolean

data.calls.classifications.tasks.assignee.is_org_admin

boolean

data.calls.classifications.tasks.assignee.modified_at

string<date-time> | null

data.calls.classifications.tasks.assignee.name

string

data.calls.classifications.tasks.assignee.onboarding_required

boolean

data.calls.classifications.tasks.assignee.profile_picture

string

data.calls.classifications.tasks.assignee.selected

boolean

data.calls.classifications.tasks.assignee_id

string | null

The ID of the user assigned to this task, if any.

Maximum string length: 32

data.calls.classifications.tasks.close_reason

string | null

The reason for closing the task, if not completed.

data.calls.classifications.tasks.completed_action

object

Option 1
Option 2

data.calls.classifications.tasks.created_at

string<date-time>

data.calls.classifications.tasks.data

object[]

Show child attributes

data.calls.classifications.tasks.data.object

string

required

data.calls.classifications.tasks.data.source

enum<string>

required

The source of the task data (e.g., 'email', 'phone', 'slack', 'invoice', 'account').

Available options:

email,

phone,

slack,

invoice,

account

Maximum string length: 7

data.calls.classifications.tasks.data.task_id

string

required

The ID of the task this data belongs to.

Maximum string length: 32

data.calls.classifications.tasks.data.type

enum<string>

required

The type of task data (e.g., 'response', 'classification', 'analysis', 'summary').

Available options:

response,

classification,

context,

analysis,

summary,

contact,

acknowledge

Maximum string length: 14

data.calls.classifications.tasks.data.id

string

Maximum string length: 32

data.calls.classifications.tasks.data.created_at

string<date-time>

data.calls.classifications.tasks.data.data

any | null

Task data.

data.calls.classifications.tasks.data.modified_at

string<date-time> | null

data.calls.classifications.tasks.description

string | null

The contextual description of the task.

data.calls.classifications.tasks.error_reason

string | null

The reason for task failing, if an error occurred.

data.calls.classifications.tasks.modified_at

string<date-time> | null

data.calls.classifications.tasks.status

enum<string>

The current status of the task.

Available options:

open,

completed,

closed,

archived,

failed,

processing,

assigned_to_agent

Maximum string length: 17

data.calls.classifications.tasks.trigger_event

object

Show child attributes

data.calls.classifications.tasks.trigger_event.name

string

required

data.calls.classifications.tasks.trigger_event.object

string

required

data.calls.classifications.tasks.trigger_event.id

string

Maximum string length: 32

data.calls.classifications.tasks.trigger_event.actor_id

string | null

Maximum string length: 32

data.calls.classifications.tasks.trigger_event.created_at

string<date-time>

data.calls.classifications.tasks.trigger_event.data

unknown

data.calls.classifications.tasks.trigger_event.entity

any

data.calls.classifications.tasks.trigger_event.entity_id

string | null

The primary key of the entity that this event is related to, e.g. inv_123 for invoice.created

data.calls.classifications.tasks.trigger_event.message

string

data.calls.classifications.tasks.trigger_event.modified_at

string<date-time> | null

data.calls.classifications.tasks.trigger_event.timestamp

string<date-time>

The time the event occurred (or should occur). This can be set to a future time if the event should be scheduled.

data.calls.classifications.tasks.trigger_event_id

string | null

The ID of the event that triggered this task, if any.

Maximum string length: 32

data.calls.created_at

string<date-time>

data.calls.custom_classifications

string[] | null

Custom classifications for the call.

data.calls.disconnection_reason

string | null

data.calls.end_time

string<date-time> | null

data.calls.from_number

string | null

The calling number.

data.calls.in_voicemail

boolean

Whether the call is entered voicemail.

data.calls.invoices

array

data.calls.is_automated

boolean

Whether the call was automatically initiated by a workflow or an AI agent.

data.calls.modified_at

string<date-time> | null

data.calls.partner

object

Show child attributes

data.calls.partner.id

string

Maximum string length: 32

data.calls.partner.account_number

string | null

The customer's account number.

data.calls.partner.ap_portals

object[]

Show child attributes

data.calls.partner.ap_portals.object

string

required

data.calls.partner.ap_portals.partner_id

string

required

Reference to the Partner

Maximum string length: 32

data.calls.partner.ap_portals.id

string

Maximum string length: 32

data.calls.partner.ap_portals.account

object

Show child attributes

data.calls.partner.ap_portals.account.object

string

required

data.calls.partner.ap_portals.account.organization_id

string

required

Organization associated with this account

Maximum string length: 32

data.calls.partner.ap_portals.account.provider

enum<string>

required

The AP Portal provider

Available options:

coupa,

ariba,

taulia

Maximum string length: 6

data.calls.partner.ap_portals.account.id

string

Maximum string length: 32

data.calls.partner.ap_portals.account.available_operations

any

data.calls.partner.ap_portals.account.created_at

string<date-time>

data.calls.partner.ap_portals.account.modified_at

string<date-time> | null

data.calls.partner.ap_portals.account_id

string | null

Reference to the ap portal account

Maximum string length: 32

data.calls.partner.ap_portals.account_key

string | null

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

data.calls.partner.ap_portals.created_at

string<date-time>

data.calls.partner.ap_portals.customer_identifier

string | null

Customer identifier on the portal, if exists.

data.calls.partner.ap_portals.customer_name

string | null

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

data.calls.partner.ap_portals.invoice_submission_guidelines

string | null

Natural language guidelines for processing invoice submissions.

data.calls.partner.ap_portals.is_enabled

boolean

Whether this AP portal configuration is enabled

data.calls.partner.ap_portals.is_invoice_submission_enabled

boolean

Whether invoice submission is enabled

data.calls.partner.ap_portals.is_report_download_enabled

boolean

Whether report download is enabled

data.calls.partner.ap_portals.modified_at

string<date-time> | null

data.calls.partner.ap_portals.name

string | null

Name of the AP Portal

data.calls.partner.ap_portals.provider

enum<string> | null

The AP Portal provider

Available options:

coupa,

ariba,

taulia,

Maximum string length: 6

data.calls.partner.ap_portals.report_email

string | null

Email address to send downloaded reports to

data.calls.partner.ap_portals.report_frequency

enum<string> | null

Frequency for report downloads

Available options:

daily,

weekly,

monthly,

Maximum string length: 7

data.calls.partner.assignee

object

Show child attributes

data.calls.partner.assignee.email

string

required

Maximum string length: 255

data.calls.partner.assignee.family_name

string

required

data.calls.partner.assignee.given_name

string

required

data.calls.partner.assignee.object

string

required

data.calls.partner.assignee.organization_id

string

required

Maximum string length: 32

data.calls.partner.assignee.id

string

Maximum string length: 32

data.calls.partner.assignee.created_at

string<date-time>

data.calls.partner.assignee.dashboard_settings

object

Show child attributes

data.calls.partner.assignee.dashboard_settings.thread_emails_sort_order

string

default:asc

data.calls.partner.assignee.default_email_sender_id

string | null

Maximum string length: 32

data.calls.partner.assignee.invited_by_user_id

string | null

Maximum string length: 32

data.calls.partner.assignee.is_access_approved

boolean

data.calls.partner.assignee.is_org_admin

boolean

data.calls.partner.assignee.modified_at

string<date-time> | null

data.calls.partner.assignee.name

string

data.calls.partner.assignee.onboarding_required

boolean

data.calls.partner.assignee.profile_picture

string

data.calls.partner.assignee.selected

boolean

data.calls.partner.assignee_id

string | null

Maximum string length: 32

data.calls.partner.billing_address

object

Show child attributes

data.calls.partner.billing_address.object

string

required

data.calls.partner.billing_address.city

string | null

City, district, suburb, town, or village.

data.calls.partner.billing_address.coordinates

object

Option 1
Option 2

data.calls.partner.billing_address.country

string | null

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

Maximum string length: 3

data.calls.partner.billing_address.created_at

string<date-time>

data.calls.partner.billing_address.description

string | null

data.calls.partner.billing_address.line1

string | null

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

data.calls.partner.billing_address.line2

string | null

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

data.calls.partner.billing_address.modified_at

string<date-time> | null

data.calls.partner.billing_address.name

string | null

data.calls.partner.billing_address.phone

string | null

Maximum string length: 20

data.calls.partner.billing_address.postal_code

string | null

ZIP or postal code.

data.calls.partner.billing_address.remote_id

string | null

The address' third party API ID.

data.calls.partner.billing_address.state

string | null

State, county, province, or region.

data.calls.partner.billing_address.type

string

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

data.calls.partner.billing_address_id

integer | null

data.calls.partner.contacts

object[]

Show child attributes

data.calls.partner.contacts.email

string

required

The contact's email address.

Maximum string length: 255

data.calls.partner.contacts.object

string

required

data.calls.partner.contacts.partner_id

string

required

Maximum string length: 32

data.calls.partner.contacts.id

string

Maximum string length: 32

data.calls.partner.contacts.address

object

Show child attributes

data.calls.partner.contacts.address.object

string

required

data.calls.partner.contacts.address.city

string | null

City, district, suburb, town, or village.

data.calls.partner.contacts.address.coordinates

object

Option 1
Option 2

data.calls.partner.contacts.address.country

string | null

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

Maximum string length: 3

data.calls.partner.contacts.address.created_at

string<date-time>

data.calls.partner.contacts.address.description

string | null

data.calls.partner.contacts.address.line1

string | null

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

data.calls.partner.contacts.address.line2

string | null

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

data.calls.partner.contacts.address.modified_at

string<date-time> | null

data.calls.partner.contacts.address.name

string | null

data.calls.partner.contacts.address.phone

string | null

Maximum string length: 20

data.calls.partner.contacts.address.postal_code

string | null

ZIP or postal code.

data.calls.partner.contacts.address.remote_id

string | null

The address' third party API ID.

data.calls.partner.contacts.address.state

string | null

State, county, province, or region.

data.calls.partner.contacts.address.type

string

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

data.calls.partner.contacts.address_id

integer | null

data.calls.partner.contacts.addresses

object[]

Show child attributes

data.calls.partner.contacts.addresses.object

string

required

data.calls.partner.contacts.addresses.id

string

Maximum string length: 32

data.calls.partner.contacts.addresses.city

string | null

City, district, suburb, town, or village.

data.calls.partner.contacts.addresses.coordinates

object

Option 1
Option 2

data.calls.partner.contacts.addresses.country

string | null

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

Maximum string length: 3

data.calls.partner.contacts.addresses.created_at

string<date-time>

data.calls.partner.contacts.addresses.description

string | null

data.calls.partner.contacts.addresses.is_primary

boolean

data.calls.partner.contacts.addresses.line1

string | null

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

data.calls.partner.contacts.addresses.line2

string | null

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

data.calls.partner.contacts.addresses.modified_at

string<date-time> | null

data.calls.partner.contacts.addresses.name

string | null

data.calls.partner.contacts.addresses.postal_code

string | null

ZIP or postal code.

data.calls.partner.contacts.addresses.state

string | null

State, county, province, or region.

data.calls.partner.contacts.addresses.type

string

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

data.calls.partner.contacts.created_at

string<date-time>

data.calls.partner.contacts.custom_fields

any

data.calls.partner.contacts.external_role

enum<string> | null

The external contact's role.

Available options:

billing_contact,

executive,

economic_user,

Maximum string length: 15

data.calls.partner.contacts.family_name

string | null

If an individual, the contact's family name.

data.calls.partner.contacts.given_name

string | null

If an individual, the contact's given name.

data.calls.partner.contacts.internal_role

enum<string> | null

The internal contact's role.

Available options:

account_manager,

account_executive,

csm,

Maximum string length: 17

data.calls.partner.contacts.is_email_disabled

boolean

Whether the contact's email has been deemed invalid.

data.calls.partner.contacts.is_phone_disabled

boolean

Whether the contact's email has been deemed invalid.

data.calls.partner.contacts.is_primary

boolean

Whether the contact is a primary contact for the partner.

data.calls.partner.contacts.is_primary_email

boolean

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

data.calls.partner.contacts.is_primary_phone

boolean

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

data.calls.partner.contacts.job_title

string | null

The contact's job at their company.

data.calls.partner.contacts.modified_at

string<date-time> | null

data.calls.partner.contacts.name

string | null

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

data.calls.partner.contacts.phone

string | null

The contact's phone number.

Maximum string length: 32

data.calls.partner.contacts.remote_created_at

string<date-time> | null

When the third party's entry was created.

data.calls.partner.contacts.remote_id

string | null

The contact's third party API ID.

data.calls.partner.contacts.remote_metadata

unknown

data.calls.partner.contacts.remote_modified_at

string<date-time> | null

When the third party's entry was updated.

data.calls.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.calls.partner.created_at

string<date-time>

data.calls.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.calls.partner.custom_fields

any

data.calls.partner.description

string | null

A description of the partner.

data.calls.partner.email

string | null

The partner's company email address.

Maximum string length: 255

data.calls.partner.family_name

string | null

The partner's family name.

data.calls.partner.finix_identity_id

string | null

data.calls.partner.given_name

string | null

The partner's given name.

data.calls.partner.invoice_prefix

string | null

The prefix for this partner's invoice numbers.

data.calls.partner.is_active

boolean

Whether the partner is active.

data.calls.partner.is_company

boolean

Whether the partner is a company or individual.

data.calls.partner.is_email_disabled

boolean

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

data.calls.partner.is_phone_disabled

boolean

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

data.calls.partner.is_primary_email

boolean

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

data.calls.partner.is_primary_phone

boolean

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

data.calls.partner.last_outreach_at

string<date-time> | null

The last date outreach was sent for this partner.

data.calls.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.calls.partner.last_outreach_to

string | null

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

data.calls.partner.last_synced_at

string<date-time> | null

data.calls.partner.legal_name

string | null

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

data.calls.partner.linked_integration

object

Show child attributes

data.calls.partner.linked_integration.integration_name

string

required

data.calls.partner.linked_integration.is_configured

boolean

required

data.calls.partner.linked_integration.object

string

required

data.calls.partner.linked_integration.settings

object

required

Show child attributes

data.calls.partner.linked_integration.settings.{key}

any

data.calls.partner.linked_integration.id

string

Maximum string length: 32

data.calls.partner.linked_integration.api_subdomain

string | null

data.calls.partner.linked_integration.api_url

string | null

data.calls.partner.linked_integration.connection_info

unknown

data.calls.partner.linked_integration.created_at

string<date-time>

data.calls.partner.linked_integration.credentials_expire_at

string<date-time> | null

The time at which the credentials expire.

data.calls.partner.linked_integration.health

object

Show child attributes

data.calls.partner.linked_integration.health.status

enum<string>

required

Available options:

incomplete,

relink_required,

unhealthy,

healthy

data.calls.partner.linked_integration.health.details

object

Show child attributes

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

unknown

data.calls.partner.linked_integration.health.message

string | null

data.calls.partner.linked_integration.health.reason

any | null

Available options:

invalid_credentials,

missing_permission,

missing_settings,

unknown_error,

connection_issue,

timeout,

data.calls.partner.linked_integration.identity_info

unknown

data.calls.partner.linked_integration.integration

object

Show child attributes

data.calls.partner.linked_integration.integration.display_name

string

required

data.calls.partner.linked_integration.integration.name

string

required

data.calls.partner.linked_integration.integration.object

string

required

data.calls.partner.linked_integration.integration.api_base_url

string

data.calls.partner.linked_integration.integration.api_documentation_url

string | null

data.calls.partner.linked_integration.integration.api_requires_subdomain

boolean

default:false

data.calls.partner.linked_integration.integration.auth_type

any | null

Available options:

api_key,

basic,

custom,

oauth1,

oauth2,

oauth2_cc,

data.calls.partner.linked_integration.integration.categories

enum<string>[]

Available options:

accounting,

banking,

crm,

file-storage,

communication

data.calls.partner.linked_integration.integration.color

string | null

data.calls.partner.linked_integration.integration.connection_guide_url

string | null

data.calls.partner.linked_integration.integration.connection_instructions

string[] | null

data.calls.partner.linked_integration.integration.connection_steps

object[]

Show child attributes

data.calls.partner.linked_integration.integration.connection_steps.type

enum<string>

required

Available options:

fetch,

form,

quickbooks-desktop

data.calls.partner.linked_integration.integration.connection_steps.title

string

required

data.calls.partner.linked_integration.integration.connection_steps.description

string | null

data.calls.partner.linked_integration.integration.connection_steps.endpoint

string | null

data.calls.partner.linked_integration.integration.connection_steps.fields

object[] | null

Show child attributes

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

string | null

data.calls.partner.linked_integration.integration.connection_steps.post_auth

boolean

default:false

data.calls.partner.linked_integration.integration.created_at

string<date-time>

data.calls.partner.linked_integration.integration.description

string | null

data.calls.partner.linked_integration.integration.is_enabled

boolean

default:true

data.calls.partner.linked_integration.integration.logo

string | null

data.calls.partner.linked_integration.integration.logo_square

string | null

data.calls.partner.linked_integration.integration.modified_at

string<date-time> | null

data.calls.partner.linked_integration.integration.settings

object[]

Show child attributes

data.calls.partner.linked_integration.integration.settings.key

string

required

data.calls.partner.linked_integration.integration.settings.type

enum<string>

required

Available options:

any,

array,

boolean,

integer,

number,

object,

string

data.calls.partner.linked_integration.integration.settings.choices

object[] | null

Show child attributes

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

string

required

The label of the choice.

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

any

required

The value of the choice.

data.calls.partner.linked_integration.integration.settings.description

string | null

data.calls.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.calls.partner.linked_integration.integration.settings.group

string | null

data.calls.partner.linked_integration.integration.settings.guide_url

string | null

data.calls.partner.linked_integration.integration.settings.is_editable

boolean

default:false

data.calls.partner.linked_integration.integration.settings.is_required

boolean

default:true

data.calls.partner.linked_integration.integration.settings.is_select

boolean

default:false

data.calls.partner.linked_integration.integration.settings.label

string | null

data.calls.partner.linked_integration.integration.settings.post_auth

boolean

default:false

data.calls.partner.linked_integration.integration.settings.requires_load

boolean

default:false

data.calls.partner.linked_integration.integration.short_description

string | null

data.calls.partner.linked_integration.is_running_setup

boolean

data.calls.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.calls.partner.linked_integration.is_webhooks_enabled

boolean

data.calls.partner.linked_integration.models

object[]

Show child attributes

data.calls.partner.linked_integration.models.integration_schema_id

string

required

Maximum string length: 32

data.calls.partner.linked_integration.models.linked_integration_id

string

required

Maximum string length: 32

data.calls.partner.linked_integration.models.name

string

required

data.calls.partner.linked_integration.models.object

string

required

data.calls.partner.linked_integration.models.id

string

Maximum string length: 32

data.calls.partner.linked_integration.models.created_at

string<date-time>

data.calls.partner.linked_integration.models.exclude_rule

object

data.calls.partner.linked_integration.models.field_mappings

unknown

data.calls.partner.linked_integration.models.health

object

Show child attributes

data.calls.partner.linked_integration.models.health.status

enum<string>

required

Available options:

incomplete,

unhealthy,

healthy

data.calls.partner.linked_integration.models.health.details

object

Show child attributes

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

unknown

data.calls.partner.linked_integration.models.health.message

string | null

data.calls.partner.linked_integration.models.health.reason

any | null

Available options:

incomplete_field_mappings,

missing_integration_schema,

missing_permission,

unknown_error,

connection_issue,

timeout,

data.calls.partner.linked_integration.models.is_read_enabled

boolean

data.calls.partner.linked_integration.models.is_webhooks_setup

boolean

data.calls.partner.linked_integration.models.is_write_enabled

boolean

data.calls.partner.linked_integration.models.last_sync

object

Show child attributes

data.calls.partner.linked_integration.models.last_sync.linked_model_id

string

required

Maximum string length: 32

data.calls.partner.linked_integration.models.last_sync.object

string

required

data.calls.partner.linked_integration.models.last_sync.run_id

string

required

Maximum string length: 32

data.calls.partner.linked_integration.models.last_sync.id

string

Maximum string length: 32

data.calls.partner.linked_integration.models.last_sync.created_at

string<date-time>

data.calls.partner.linked_integration.models.last_sync.entity_id

string | null

data.calls.partner.linked_integration.models.last_sync.is_initial_sync

boolean

data.calls.partner.linked_integration.models.last_sync.is_one_off

boolean

Whether or not this is a one off sync

data.calls.partner.linked_integration.models.last_sync.modified_at

string<date-time> | null

data.calls.partner.linked_integration.models.last_sync.pagination

unknown

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

object

Show child attributes

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

string

required

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

string

Maximum string length: 32

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

string<date-time> | null

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

string<date-time>

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

unknown

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

string | null

Maximum string length: 32

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

string<date-time> | null

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

unknown

data.calls.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.calls.partner.linked_integration.models.last_sync.run.stacktrace

string | null

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

string<date-time> | null

data.calls.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.calls.partner.linked_integration.models.last_sync.timerange_end

string<date-time> | null

data.calls.partner.linked_integration.models.last_sync.timerange_start

string<date-time> | null

data.calls.partner.linked_integration.models.last_sync_id

string | null

Maximum string length: 32

data.calls.partner.linked_integration.models.modified_at

string<date-time> | null

data.calls.partner.linked_integration.models.next_sync_at

string<date-time> | null

data.calls.partner.linked_integration.models.sync_requested

boolean

data.calls.partner.linked_integration.modified_at

string<date-time> | null

data.calls.partner.linked_integration.name

string | null

User defined name of the linked integration.

data.calls.partner.linked_integration.owner_id

string | null

Maximum string length: 32

data.calls.partner.linked_integration.requires_setup

boolean

data.calls.partner.linked_integration.username

string | null

data.calls.partner.linked_integration.webhook_listener_url

string | null

data.calls.partner.linked_integration.webhook_setup_error

string | null

data.calls.partner.modified_at

string<date-time> | null

data.calls.partner.name

string | null

The full name of the partner.

data.calls.partner.object

string

data.calls.partner.on_behalf_of

string | null

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

data.calls.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.calls.partner.organization_id

string

Maximum string length: 32

data.calls.partner.parent_id

string | null

Maximum string length: 32

data.calls.partner.phone

string | null

The partner's default phone number.

Maximum string length: 32

data.calls.partner.remote_created_at

string<date-time> | null

When the third party's entry was created.

data.calls.partner.remote_id

string

The partner's third party id.

data.calls.partner.remote_metadata

unknown

data.calls.partner.remote_modified_at

string<date-time> | null

When the third party's entry was updated.

data.calls.partner.remote_parent_id

string | null

The partner's third party parent partner id.

data.calls.partner.remote_payment_portal_url

string | null

The partner's third party payment portal url.

data.calls.partner.shipping_address

object

Show child attributes

data.calls.partner.shipping_address.object

string

required

data.calls.partner.shipping_address.city

string | null

City, district, suburb, town, or village.

data.calls.partner.shipping_address.coordinates

object

Option 1
Option 2

data.calls.partner.shipping_address.country

string | null

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

Maximum string length: 3

data.calls.partner.shipping_address.created_at

string<date-time>

data.calls.partner.shipping_address.description

string | null

data.calls.partner.shipping_address.line1

string | null

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

data.calls.partner.shipping_address.line2

string | null

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

data.calls.partner.shipping_address.modified_at

string<date-time> | null

data.calls.partner.shipping_address.name

string | null

data.calls.partner.shipping_address.phone

string | null

Maximum string length: 20

data.calls.partner.shipping_address.postal_code

string | null

ZIP or postal code.

data.calls.partner.shipping_address.remote_id

string | null

The address' third party API ID.

data.calls.partner.shipping_address.state

string | null

State, county, province, or region.

data.calls.partner.shipping_address.type

string

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

data.calls.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.calls.partner.sync_status

enum<string>

The sync status for this entity.

Available options:

partial,

syncing,

synced,

failed

Maximum string length: 7

data.calls.partner.tags

object[]

Show child attributes

data.calls.partner.tags.object

string

required

data.calls.partner.tags.partner_id

string

required

Maximum string length: 32

data.calls.partner.tags.tag_id

string

required

Maximum string length: 32

data.calls.partner.tags.created_at

string<date-time>

data.calls.partner.tags.is_manual

boolean

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

data.calls.partner.tags.modified_at

string<date-time> | null

data.calls.partner.tags.tag

object

Show child attributes

data.calls.partner.tags.tag.name

string

required

The name of the tag.

data.calls.partner.tags.tag.object

string

required

data.calls.partner.tags.tag.id

string

Maximum string length: 32

data.calls.partner.tags.tag.color

string

The hex color code of the tag, if any.

Maximum string length: 20

data.calls.partner.tags.tag.created_at

string<date-time>

data.calls.partner.tags.tag.modified_at

string<date-time> | null

data.calls.partner.tags.tag.rule_condition

object

data.calls.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.calls.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.calls.partner_id

string | null

Maximum string length: 32

data.calls.recording_url

any

data.calls.retell_id

string | null

data.calls.sentiment

enum<string> | null

Sentiment of the user in the call.

Available options:

positive,

negative,

neutral,

unknown,

Maximum string length: 8

data.calls.start_time

string<date-time> | null

data.calls.status

enum<string>

Available options:

pending_approval,

queued,

registered,

initiated,

ringing,

canceled,

in_progress,

completed,

busy,

no_answer,

failed

Maximum string length: 16

data.calls.summary

string | null

The summary of the call.

data.calls.transcript

any

data.calls.transcript_str

string | null

The transcript of the call.

data.calls.transferred_to

string | null

The number the call was transferred to, if any. This is typically used for inbound calls where the call was transferred to a different number.

Maximum string length: 32

data.calls.workflow

object

Show child attributes

data.calls.workflow.id

string

Maximum string length: 32

data.calls.workflow.active_days

integer[]

The days of the week to run the workflow on

data.calls.workflow.created_at

string<date-time>

data.calls.workflow.email_sender_id

string | null

Maximum string length: 32

data.calls.workflow.is_active

boolean

data.calls.workflow.is_call_on_weekend_enabled

boolean

Whether to allow calls on weekends

data.calls.workflow.modified_at

string<date-time> | null

data.calls.workflow.name

string

The name of the workflow

data.calls.workflow.object

string

data.calls.workflow.outreach_window_end

string

The end time of the outreach window

data.calls.workflow.outreach_window_start

string

The start time of the outreach window

data.calls.workflow.pending_run_strategy

enum<string>

Available options:

send_all,

send_first,

send_latest

Maximum string length: 11

data.calls.workflow.test_email

string | null

data.calls.workflow.test_phone_number

string | null

data.calls.workflow.timezone

enum<string>

The timezone to run the workflow on

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

string<date-time>

data.custom_fields

any

data.due_date

string<date-time> | null

The invoice's due date.

data.emails

object[]

Show child attributes

data.emails.object

string

required

data.emails.thread_id

string

required

Maximum string length: 32

data.emails.id

string

Maximum string length: 32

data.emails.attachments

object[]

Show child attributes

data.emails.attachments.file_type

enum<string>

required

Available options:

audio,

document,

gif,

image,

video

Maximum string length: 8

data.emails.attachments.mime_type

string

required

data.emails.attachments.name

string

required

data.emails.attachments.object

string

required

data.emails.attachments.organization_id

string

required

Maximum string length: 32

data.emails.attachments.id

string

Maximum string length: 32

data.emails.attachments.content_id

string | null

data.emails.attachments.created_at

string<date-time>

data.emails.attachments.disposition

string

data.emails.attachments.is_verified

boolean

data.emails.attachments.modified_at

string<date-time> | null

data.emails.attachments.presigned_url

string | null

data.emails.attachments.presigned_url_expires_at

string<date-time> | null

data.emails.attachments.purpose

string | null

The use case for this attachment

data.emails.attachments.remote_id

string | null

The address' third party API ID.

data.emails.attachments.size

integer | null

data.emails.attachments.src

any

data.emails.attachments.user_id

string | null

Maximum string length: 32

data.emails.author

object

Show child attributes

data.emails.author.email

string

required

Maximum string length: 255

data.emails.author.family_name

string

required

data.emails.author.given_name

string

required

data.emails.author.object

string

required

data.emails.author.organization_id

string

required

Maximum string length: 32

data.emails.author.id

string

Maximum string length: 32

data.emails.author.created_at

string<date-time>

data.emails.author.dashboard_settings

object

Show child attributes

data.emails.author.dashboard_settings.thread_emails_sort_order

string

default:asc

data.emails.author.default_email_sender_id

string | null

Maximum string length: 32

data.emails.author.invited_by_user_id

string | null

Maximum string length: 32

data.emails.author.is_access_approved

boolean

data.emails.author.is_org_admin

boolean

data.emails.author.modified_at

string<date-time> | null

data.emails.author.name

string

data.emails.author.onboarding_required

boolean

data.emails.author.profile_picture

string

data.emails.author.selected

boolean

data.emails.author_id

string | null

Maximum string length: 32

data.emails.bcc

string[]

data.emails.body

string | null

The HTML body of the email.

data.emails.bounced_addresses

string[]

List of email addresses that bounced for this email

data.emails.bulk_email_request_id

string | null

Maximum string length: 32

data.emails.cc

string[]

data.emails.created_at

string<date-time>

data.emails.custom_headers

any | null

Custom email headers

data.emails.direction

enum<string>

The request direction of the email. Either inbound or outbound

Available options:

inbound,

outbound

Maximum string length: 8

data.emails.email_reason

string | null

The reason the email was sent.

data.emails.email_sender

object

Show child attributes

data.emails.email_sender.email

string

required

The account's email.

Maximum string length: 255

data.emails.email_sender.object

string

required

data.emails.email_sender.reply_to

string

required

This account's default reply-to

Maximum string length: 255

data.emails.email_sender.user_id

string

required

Maximum string length: 32

data.emails.email_sender.id

string

Maximum string length: 32

data.emails.email_sender.created_at

string<date-time>

data.emails.email_sender.expired_at

string<date-time> | null

The time the email sender grant expired.

data.emails.email_sender.is_nylas_connection

boolean

data.emails.email_sender.is_nylas_grant_expired

boolean

Whether the Nylas grant for this email sender has expired

data.emails.email_sender.is_shared

boolean

Whether this email sender should be shared with the entire organization

data.emails.email_sender.modified_at

string<date-time> | null

data.emails.email_sender.name

string | null

Email owner's name.

data.emails.email_sender.provider

string | null

data.emails.email_sender.reply_to_name

string | null

This account's default reply-to

data.emails.email_sender.signature_html

string | null

Email signature html.

data.emails.email_sender_id

string | null

Maximum string length: 32

data.emails.error_message

string | null

The error message if the email failed to send.

data.emails.from_email

string

data.emails.generated_body

string | null

Saves LLM-generated body of the email. Diffed against email body when email is sent to get user changes.

data.emails.is_automated

boolean

Whether the email was automatically sent by a workflow or an AI agent.

data.emails.is_generated

boolean

Whether the email was automatically generated by a workflow or an AI agent.

data.emails.is_originated_in_stuut

boolean

Whether the email originated (was sent through) Stuut.

data.emails.is_unread

boolean

data.emails.modified_at

string<date-time> | null

data.emails.parent_email_id

string | null

Maximum string length: 32

data.emails.participants

string<email>[]

data.emails.remote_id

string | null

The Nylas ID of the email

data.emails.remote_links

object[]

Show child attributes

data.emails.remote_links.email_id

string

required

Maximum string length: 32

data.emails.remote_links.email_sender_id

string

required

Maximum string length: 32

data.emails.remote_links.object

string

required

data.emails.remote_links.remote_id

string

required

The ID of the email in a remote system, e.g. Nylas

data.emails.remote_links.remote_thread_id

string

required

The ID of the email thread in a remote system, e.g. Nylas

data.emails.remote_links.created_at

string<date-time>

data.emails.remote_links.modified_at

string<date-time> | null

data.emails.reply_to

string[]

data.emails.send_separately

boolean

data.emails.sent_at

string<date-time> | null

When the email was sent.

data.emails.sent_by_id

string | null

Maximum string length: 32

data.emails.snippet

string | null

data.emails.status

enum<string>

Available options:

draft,

pending,

sending,

sent,

error

Maximum string length: 7

data.emails.subject

string | null

data.emails.to

string[]

data.in_dispute

boolean

Whether an invoice is in dispute. If it is, we exclude it from any outreach.

data.is_issued_email_sent

boolean

Whether the email to notify the customer that the invoice has been issued was sent.

data.issued_at

string<date-time> | null

The invoice's issue date.

data.last_outreach_at

string<date-time> | null

The last date outreach was sent for this invoice.

data.last_outreach_channel

enum<string> | null

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

Available options:

email,

call,

Maximum string length: 5

data.last_outreach_to

string | null

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

data.last_synced_at

string<date-time> | null

data.line_items

object[]

Show child attributes

data.line_items.invoice_id

string

required

Maximum string length: 32

data.line_items.object

string

required

data.line_items.remote_id

string

required

The line item's third party API ID.

data.line_items.created_at

string<date-time>

data.line_items.currency

enum<string> | null

The line item's 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.line_items.custom_fields

any

data.line_items.description

string | null

Descriptor of the line item.

data.line_items.line_number

integer | null

Line item number

data.line_items.modified_at

string<date-time> | null

data.line_items.name

string | null

The line item's name.

data.line_items.period_end_date

string<date-time> | null

End of the usage period.

data.line_items.period_start_date

string<date-time> | null

Start of the usage period.

data.line_items.product_type

string | null

data.line_items.quantity

integer

The line item's quantity.

data.line_items.remote_created_at

string<date-time> | null

When the third party's entry was created.

data.line_items.remote_metadata

unknown

data.line_items.remote_modified_at

string<date-time> | null

When the third party's entry was updated.

data.line_items.total_amount

integer

The line item's total amount, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

data.line_items.total_discount

integer

The line item's total discount amount, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

data.line_items.total_tax

integer

The total tax applied to the line item, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

data.line_items.unit_amount

integer | null

Unit price for a single line item, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

data.linked_integration

object

Show child attributes

data.linked_integration.integration_name

string

required

data.linked_integration.is_configured

boolean

required

data.linked_integration.object

string

required

data.linked_integration.settings

object

required

Show child attributes

data.linked_integration.settings.{key}

any

data.linked_integration.id

string

Maximum string length: 32

data.linked_integration.api_subdomain

string | null

data.linked_integration.api_url

string | null

data.linked_integration.connection_info

unknown

data.linked_integration.created_at

string<date-time>

data.linked_integration.credentials_expire_at

string<date-time> | null

The time at which the credentials expire.

data.linked_integration.health

object

Show child attributes

data.linked_integration.health.status

enum<string>

required

Available options:

incomplete,

relink_required,

unhealthy,

healthy

data.linked_integration.health.details

object

Show child attributes

data.linked_integration.health.details.{key}

unknown

data.linked_integration.health.message

string | null

data.linked_integration.health.reason

any | null

Available options:

invalid_credentials,

missing_permission,

missing_settings,

unknown_error,

connection_issue,

timeout,

data.linked_integration.identity_info

unknown

data.linked_integration.integration

object

Show child attributes

data.linked_integration.integration.display_name

string

required

data.linked_integration.integration.name

string

required

data.linked_integration.integration.object

string

required

data.linked_integration.integration.api_base_url

string

data.linked_integration.integration.api_documentation_url

string | null

data.linked_integration.integration.api_requires_subdomain

boolean

default:false

data.linked_integration.integration.auth_type

any | null

Available options:

api_key,

basic,

custom,

oauth1,

oauth2,

oauth2_cc,

data.linked_integration.integration.categories

enum<string>[]

Available options:

accounting,

banking,

crm,

file-storage,

communication

data.linked_integration.integration.color

string | null

data.linked_integration.integration.connection_guide_url

string | null

data.linked_integration.integration.connection_instructions

string[] | null

data.linked_integration.integration.connection_steps

object[]

Show child attributes

data.linked_integration.integration.connection_steps.type

enum<string>

required

Available options:

fetch,

form,

quickbooks-desktop

data.linked_integration.integration.connection_steps.title

string

required

data.linked_integration.integration.connection_steps.description

string | null

data.linked_integration.integration.connection_steps.endpoint

string | null

data.linked_integration.integration.connection_steps.fields

object[] | null

Show child attributes

data.linked_integration.integration.connection_steps.fields.setting

string | null

data.linked_integration.integration.connection_steps.post_auth

boolean

default:false

data.linked_integration.integration.created_at

string<date-time>

data.linked_integration.integration.description

string | null

data.linked_integration.integration.is_enabled

boolean

default:true

data.linked_integration.integration.logo

string | null

data.linked_integration.integration.logo_square

string | null

data.linked_integration.integration.modified_at

string<date-time> | null

data.linked_integration.integration.settings

object[]

Show child attributes

data.linked_integration.integration.settings.key

string

required

data.linked_integration.integration.settings.type

enum<string>

required

Available options:

any,

array,

boolean,

integer,

number,

object,

string

data.linked_integration.integration.settings.choices

object[] | null

Show child attributes

data.linked_integration.integration.settings.choices.label

string

required

The label of the choice.

data.linked_integration.integration.settings.choices.value

any

required

The value of the choice.

data.linked_integration.integration.settings.description

string | null

data.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.linked_integration.integration.settings.group

string | null

data.linked_integration.integration.settings.guide_url

string | null

data.linked_integration.integration.settings.is_editable

boolean

default:false

data.linked_integration.integration.settings.is_required

boolean

default:true

data.linked_integration.integration.settings.is_select

boolean

default:false

data.linked_integration.integration.settings.label

string | null

data.linked_integration.integration.settings.post_auth

boolean

default:false

data.linked_integration.integration.settings.requires_load

boolean

default:false

data.linked_integration.integration.short_description

string | null

data.linked_integration.is_running_setup

boolean

data.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.linked_integration.is_webhooks_enabled

boolean

data.linked_integration.models

object[]

Show child attributes

data.linked_integration.models.integration_schema_id

string

required

Maximum string length: 32

data.linked_integration.models.linked_integration_id

string

required

Maximum string length: 32

data.linked_integration.models.name

string

required

data.linked_integration.models.object

string

required

data.linked_integration.models.id

string

Maximum string length: 32

data.linked_integration.models.created_at

string<date-time>

data.linked_integration.models.exclude_rule

object

data.linked_integration.models.field_mappings

unknown

data.linked_integration.models.health

object

Show child attributes

data.linked_integration.models.health.status

enum<string>

required

Available options:

incomplete,

unhealthy,

healthy

data.linked_integration.models.health.details

object

Show child attributes

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

unknown

data.linked_integration.models.health.message

string | null

data.linked_integration.models.health.reason

any | null

Available options:

incomplete_field_mappings,

missing_integration_schema,

missing_permission,

unknown_error,

connection_issue,

timeout,

data.linked_integration.models.is_read_enabled

boolean

data.linked_integration.models.is_webhooks_setup

boolean

data.linked_integration.models.is_write_enabled

boolean

data.linked_integration.models.last_sync

object

Show child attributes

data.linked_integration.models.last_sync.linked_model_id

string

required

Maximum string length: 32

data.linked_integration.models.last_sync.object

string

required

data.linked_integration.models.last_sync.run_id

string

required

Maximum string length: 32

data.linked_integration.models.last_sync.id

string

Maximum string length: 32

data.linked_integration.models.last_sync.created_at

string<date-time>

data.linked_integration.models.last_sync.entity_id

string | null

data.linked_integration.models.last_sync.is_initial_sync

boolean

data.linked_integration.models.last_sync.is_one_off

boolean

Whether or not this is a one off sync

data.linked_integration.models.last_sync.modified_at

string<date-time> | null

data.linked_integration.models.last_sync.pagination

unknown

data.linked_integration.models.last_sync.run

object

Show child attributes

data.linked_integration.models.last_sync.run.object

string

required

data.linked_integration.models.last_sync.run.id

string

Maximum string length: 32

data.linked_integration.models.last_sync.run.completed_at

string<date-time> | null

data.linked_integration.models.last_sync.run.created_at

string<date-time>

data.linked_integration.models.last_sync.run.data

unknown

data.linked_integration.models.last_sync.run.event_id

string | null

Maximum string length: 32

data.linked_integration.models.last_sync.run.modified_at

string<date-time> | null

data.linked_integration.models.last_sync.run.output

unknown

data.linked_integration.models.last_sync.run.remote_id

string | null

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

data.linked_integration.models.last_sync.run.stacktrace

string | null

data.linked_integration.models.last_sync.run.started_at

string<date-time> | null

data.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.linked_integration.models.last_sync.timerange_end

string<date-time> | null

data.linked_integration.models.last_sync.timerange_start

string<date-time> | null

data.linked_integration.models.last_sync_id

string | null

Maximum string length: 32

data.linked_integration.models.modified_at

string<date-time> | null

data.linked_integration.models.next_sync_at

string<date-time> | null

data.linked_integration.models.sync_requested

boolean

data.linked_integration.modified_at

string<date-time> | null

data.linked_integration.name

string | null

User defined name of the linked integration.

data.linked_integration.owner_id

string | null

Maximum string length: 32

data.linked_integration.requires_setup

boolean

data.linked_integration.username

string | null

data.linked_integration.webhook_listener_url

string | null

data.linked_integration.webhook_setup_error

string | null

data.marked_uncollectible_at

string<date-time> | null

The date the invoice was marked uncollectible.

data.memo

string | null

A memo visible to the invoice's end user.

data.modified_at

string<date-time> | null

data.number

string | null

A unique, identifying string that appears on emails sent to the customer for this invoice.

data.order_number

string | null

Unique identifier assigned to a purchase by a seller.

data.paid_at

string<date-time> | null

The date the invoice was paid.

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_call_outreach_manually_paused

boolean

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_email_outreach_manually_paused

boolean

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 customer this invoice is issued to.

Maximum string length: 32

data.payments

object[]

Show child attributes

data.payments.amount

integer

required

The amount applied to the invoice.

data.payments.invoice_id

string

required

Maximum string length: 32

data.payments.object

string

required

data.payments.payment_id

string

required

Maximum string length: 32

data.payments.strategy

enum<string>

required

Available options:

automatic,

expected,

manual,

suggested

Maximum string length: 9

data.payments.id

string

Maximum string length: 32

data.payments.agent_confidence_reason

string | null

The justification for the agent's confidence score.

data.payments.agent_confidence_score

integer | null

The confidence score of the result on a scale of 0-100, where 0 indicates no confidence in the accuracy of the result and 100 indicates full confidence in the accuracy of the result.

data.payments.agent_error_code

string | null

The code for why an error occurred when processing the statement.

data.payments.agent_uncertainties

string[]

A list of uncertainties we have regarding the result.

data.payments.approved

boolean

Whether the allocation is approved.

data.payments.approved_at

string<date-time> | null

The time the payment allocation was approved.

data.payments.approver_id

string | null

Maximum string length: 32

data.payments.created_at

string<date-time>

data.payments.modified_at

string<date-time> | null

data.payments.payment

object

Show child attributes

data.payments.payment.id

string

Maximum string length: 32

data.payments.payment.agent_confidence_reason

string | null

The justification for the agent's confidence score.

data.payments.payment.agent_confidence_score

integer | null

The confidence score of the result on a scale of 0-100, where 0 indicates no confidence in the accuracy of the result and 100 indicates full confidence in the accuracy of the result.

data.payments.payment.agent_error_code

string | null

The code for why an error occurred when processing the statement.

data.payments.payment.agent_uncertainties

string[]

A list of uncertainties we have regarding the result.

data.payments.payment.amount

integer

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.payments.payment.amount_refunded

integer

The amount refunded in the currency's smallest unit, e.g. $10 USD would be represented as 1000. amount must be >= 0

data.payments.payment.bank_transaction_id

string | null

The bank_transaction this payment was reconciled to.

Maximum string length: 32

data.payments.payment.billing_email

string | null

The billing email address of the payment

Maximum string length: 255

data.payments.payment.created_at

string<date-time>

data.payments.payment.currency

enum<string>

The ISO-4217 currency code of the payment.

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.payments.payment.currency_rate

integer | null

data.payments.payment.custom_fields

any

data.payments.payment.description

string | null

The memo, remark, or description associated with the payment/transaction.

data.payments.payment.expected_at

string<date-time> | null

When the payment is expected to post.

data.payments.payment.finix_transfer_id

string | null

Maximum string length: 32

data.payments.payment.initiated_at

string<date-time> | null

The time at which the payment was initiated.

data.payments.payment.last_exported_at

string<date-time> | null

The time at which the payment was last exported.

data.payments.payment.last_synced_at

string<date-time> | null

data.payments.payment.linked_integration_id

string | null

The linked_integration this payment was originated from, if any.

Maximum string length: 32

data.payments.payment.modified_at

string<date-time> | null

data.payments.payment.object

string

data.payments.payment.partner_id

string

The id of the partner that made this payment.

Maximum string length: 32

data.payments.payment.payment_method

enum<string> | null

The payment method used to make the payment.

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.payments.payment.receipt_url

string | null

data.payments.payment.reference_number

string | null

A unique identifier for the payment.

data.payments.payment.remittance_id

string | null

The id of the remittance this payment originated from.

Maximum string length: 32

data.payments.payment.remote_created_at

string<date-time> | null

When the third party's entry was created.

data.payments.payment.remote_id

string | null

The unique identifier of the payment in the system it originated from, e.g. a stripe charge

data.payments.payment.remote_metadata

unknown

data.payments.payment.remote_modified_at

string<date-time> | null

When the third party's entry was updated.

data.payments.payment.statement_descriptor

string | null

The memo, remark, or description associated with the payment/transaction.

data.payments.payment.status

enum<string>

The status of the payment.

Available options:

pending_match,

pending_approval,

approved,

finalized

Maximum string length: 16

data.payments.payment.stripe_session_id

string | null

Maximum string length: 32

data.payments.payment.sync_status

enum<string>

The sync status for this entity.

Available options:

partial,

syncing,

synced,

failed

Maximum string length: 7

data.payments.payment.timestamp

string<date-time>

If posted, the time the payment posted. Otherwise the time the payment is expected or initiated.

data.payments.payment.transaction_match_approved_at

string<date-time> | null

The time at which the transaction match was approved.

data.payments.payment.transaction_match_approver_id

string | null

Maximum string length: 32

data.payments.remote_id

string | null

The identifier of the allocation in the remote system.

data.pdf

any

data.pdf_id

string | null

Maximum string length: 32

data.period_end_date

string<date-time> | null

End of the usage period during which invoice items were added to this invoice.

data.period_start_date

string<date-time> | null

Start of the usage period during which invoice items were added to this invoice.

data.private_note

string | null

The invoice's organization-private note.

data.promised_to_pay_date

string<date> | null

The date the customer has promised to pay the invoice.

data.purchase_order_number

string | null

Unique identifier assigned to a purchase order by a buyer.

data.remote_created_at

string<date-time> | null

When the third party's entry was created.

data.remote_invoice_pdf

string | null

The url to the invoice's third party pdf.

data.remote_metadata

unknown

data.remote_modified_at

string<date-time> | null

When the third party's entry was updated.

data.remote_partner_id

string | null

The invoice's partner's third party id.

data.remote_payment_portal_url

string | null

The invoice's third party payment url.

data.remote_payment_status

enum<string> | null

Status of payment on this invoice. NOTE: Source of this status could be different from the source of remote_status, and could be out of sync with it. It is currently controlled Stripe webhooks that receive partner portal session events. If payment was initiated and failed, remote_payment_status should be set to None.

Available options:

processing,

completed,

Maximum string length: 10

data.remote_status

string | null

The invoice's third party status.

data.requires_line_item_sync

boolean

data.shipping_address

object

Show child attributes

data.shipping_address.object

string

required

data.shipping_address.city

string | null

City, district, suburb, town, or village.

data.shipping_address.coordinates

object

Option 1
Option 2

data.shipping_address.country

string | null

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

Maximum string length: 3

data.shipping_address.created_at

string<date-time>

data.shipping_address.description

string | null

data.shipping_address.line1

string | null

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

data.shipping_address.line2

string | null

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

data.shipping_address.modified_at

string<date-time> | null

data.shipping_address.name

string | null

data.shipping_address.phone

string | null

Maximum string length: 20

data.shipping_address.postal_code

string | null

ZIP or postal code.

data.shipping_address.remote_id

string | null

The address' third party API ID.

data.shipping_address.state

string | null

State, county, province, or region.

data.shipping_address.type

string

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

data.shipping_address_id

integer | null

data.status

any

data.subtotal

integer

The total amount of the invoice, tax exclusive, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

data.sync_status

enum<string>

The sync status for this entity.

Available options:

partial,

syncing,

synced,

failed

Maximum string length: 7

data.total_discount

integer

The total discounts applied to the invoice, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

data.total_tax

integer

The total tax applied to the invoice, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

data.type

enum<string>

Whether the invoice is a PAYABLE (Accounts Payable) or RECEIVABLE (Accounts Receivable).

Available options:

payable,

receivable

Maximum string length: 10

data.voided_at

string<date-time> | null

The date the invoice was voided.

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

Authorizations

Query Parameters

Response