Retrieve A Call

Authorizations

Authorization

string

header

required

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

Path Parameters

call_id

string

required

Response

Successful response

direction

enum<string>

required

Available options:

inbound,

outbound

Maximum string length: 8

object

string

required

to_number

string

required

The number to call

string

Maximum string length: 32

agent_id

string | null

approver

object

Show child attributes

approver.email

string

required

Maximum string length: 255

approver.family_name

string

required

approver.given_name

string

required

approver.object

string

required

approver.organization_id

string

required

Maximum string length: 32

approver.id

string

Maximum string length: 32

approver.created_at

string<date-time>

approver.dashboard_settings

object

Show child attributes

approver.dashboard_settings.thread_emails_sort_order

string

default:asc

approver.default_email_sender_id

string | null

Maximum string length: 32

approver.invited_by_user_id

string | null

Maximum string length: 32

approver.is_access_approved

boolean

approver.is_org_admin

boolean

approver.modified_at

string<date-time> | null

approver.name

string

approver.onboarding_required

boolean

approver.profile_picture

string

approver.selected

boolean

approver_id

string | null

Maximum string length: 32

call_agent_id

string | null

Maximum string length: 32

call_reason

string | null

classifications

object[]

Show child attributes

classifications.agent_reply_reason

string

required

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

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

classifications.is_action_required

boolean

required

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

classifications.is_reply_required

boolean

required

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

classifications.object

string

required

classifications.reason

string

required

The reason for the classifications of the interaction

classifications.action_recommendation

string | null

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

classifications.agent_confidence_reason

string | null

The justification for the agent's confidence score.

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.

classifications.agent_error_code

string | null

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

classifications.agent_uncertainties

string[]

A list of uncertainties we have regarding the result.

classifications.created_at

string<date-time>

classifications.language

string

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

Maximum string length: 2

classifications.modified_at

string<date-time> | null

classifications.tasks

object[]

Show child attributes

classifications.tasks.label

string

required

The blurb or label for the task.

classifications.tasks.object

string

required

classifications.tasks.organization_id

string

required

The ID of the organization this task belongs to.

Maximum string length: 32

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

classifications.tasks.id

string

Maximum string length: 32

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

classifications.tasks.assignee

object

Show child attributes

classifications.tasks.assignee.email

string

required

Maximum string length: 255

classifications.tasks.assignee.family_name

string

required

classifications.tasks.assignee.given_name

string

required

classifications.tasks.assignee.object

string

required

classifications.tasks.assignee.organization_id

string

required

Maximum string length: 32

classifications.tasks.assignee.id

string

Maximum string length: 32

classifications.tasks.assignee.created_at

string<date-time>

classifications.tasks.assignee.dashboard_settings

object

Show child attributes

classifications.tasks.assignee.dashboard_settings.thread_emails_sort_order

string

default:asc

classifications.tasks.assignee.default_email_sender_id

string | null

Maximum string length: 32

classifications.tasks.assignee.invited_by_user_id

string | null

Maximum string length: 32

classifications.tasks.assignee.is_access_approved

boolean

classifications.tasks.assignee.is_org_admin

boolean

classifications.tasks.assignee.modified_at

string<date-time> | null

classifications.tasks.assignee.name

string

classifications.tasks.assignee.onboarding_required

boolean

classifications.tasks.assignee.profile_picture

string

classifications.tasks.assignee.selected

boolean

classifications.tasks.assignee_id

string | null

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

Maximum string length: 32

classifications.tasks.close_reason

string | null

The reason for closing the task, if not completed.

classifications.tasks.completed_action

object

Option 1
Option 2

classifications.tasks.created_at

string<date-time>

classifications.tasks.data

object[]

Show child attributes

classifications.tasks.data.object

string

required

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

classifications.tasks.data.task_id

string

required

The ID of the task this data belongs to.

Maximum string length: 32

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

classifications.tasks.data.id

string

Maximum string length: 32

classifications.tasks.data.created_at

string<date-time>

classifications.tasks.data.data

any | null

Task data.

classifications.tasks.data.modified_at

string<date-time> | null

classifications.tasks.description

string | null

The contextual description of the task.

classifications.tasks.error_reason

string | null

The reason for task failing, if an error occurred.

classifications.tasks.modified_at

string<date-time> | null

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

classifications.tasks.trigger_event

object

Show child attributes

classifications.tasks.trigger_event.name

string

required

classifications.tasks.trigger_event.object

string

required

classifications.tasks.trigger_event.id

string

Maximum string length: 32

classifications.tasks.trigger_event.actor_id

string | null

Maximum string length: 32

classifications.tasks.trigger_event.created_at

string<date-time>

classifications.tasks.trigger_event.data

unknown

classifications.tasks.trigger_event.entity

any

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

classifications.tasks.trigger_event.message

string

classifications.tasks.trigger_event.modified_at

string<date-time> | null

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.

classifications.tasks.trigger_event_id

string | null

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

Maximum string length: 32

created_at

string<date-time>

custom_classifications

string[] | null

Custom classifications for the call.

disconnection_reason

string | null

end_time

string<date-time> | null

from_number

string | null

The calling number.

in_voicemail

boolean

Whether the call is entered voicemail.

invoices

object[]

Show child attributes

invoices.amount_due

integer

required

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

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

invoices.object

string

required

invoices.remote_id

string

required

The invoice's third party API ID.

invoices.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)

invoices.id

string

Maximum string length: 32

invoices.amount_paid

integer

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

invoices.assignee

object

Show child attributes

invoices.assignee.email

string

required

Maximum string length: 255

invoices.assignee.family_name

string

required

invoices.assignee.given_name

string

required

invoices.assignee.object

string

required

invoices.assignee.organization_id

string

required

Maximum string length: 32

invoices.assignee.id

string

Maximum string length: 32

invoices.assignee.created_at

string<date-time>

invoices.assignee.dashboard_settings

object

Show child attributes

invoices.assignee.dashboard_settings.thread_emails_sort_order

string

default:asc

invoices.assignee.default_email_sender_id

string | null

Maximum string length: 32

invoices.assignee.invited_by_user_id

string | null

Maximum string length: 32

invoices.assignee.is_access_approved

boolean

invoices.assignee.is_org_admin

boolean

invoices.assignee.modified_at

string<date-time> | null

invoices.assignee.name

string

invoices.assignee.onboarding_required

boolean

invoices.assignee.profile_picture

string

invoices.assignee.selected

boolean

invoices.billing_address

object

Show child attributes

invoices.billing_address.object

string

required

invoices.billing_address.city

string | null

City, district, suburb, town, or village.

invoices.billing_address.coordinates

object

Option 1
Option 2

invoices.billing_address.country

string | null

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

Maximum string length: 3

invoices.billing_address.created_at

string<date-time>

invoices.billing_address.description

string | null

invoices.billing_address.line1

string | null

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

invoices.billing_address.line2

string | null

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

invoices.billing_address.modified_at

string<date-time> | null

invoices.billing_address.name

string | null

invoices.billing_address.phone

string | null

Maximum string length: 20

invoices.billing_address.postal_code

string | null

ZIP or postal code.

invoices.billing_address.remote_id

string | null

The address' third party API ID.

invoices.billing_address.state

string | null

State, county, province, or region.

invoices.billing_address.type

string

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

invoices.billing_address_id

integer | null

invoices.billing_email

string | null

Maximum string length: 255

invoices.calls

array

invoices.created_at

string<date-time>

invoices.custom_fields

any

invoices.due_date

string<date-time> | null

The invoice's due date.

invoices.emails

object[]

Show child attributes

invoices.emails.object

string

required

invoices.emails.thread_id

string

required

Maximum string length: 32

invoices.emails.id

string

Maximum string length: 32

invoices.emails.attachments

object[]

Show child attributes

invoices.emails.attachments.file_type

enum<string>

required

Available options:

audio,

document,

gif,

image,

video

Maximum string length: 8

invoices.emails.attachments.mime_type

string

required

invoices.emails.attachments.name

string

required

invoices.emails.attachments.object

string

required

invoices.emails.attachments.organization_id

string

required

Maximum string length: 32

invoices.emails.attachments.id

string

Maximum string length: 32

invoices.emails.attachments.content_id

string | null

invoices.emails.attachments.created_at

string<date-time>

invoices.emails.attachments.disposition

string

invoices.emails.attachments.is_verified

boolean

invoices.emails.attachments.modified_at

string<date-time> | null

invoices.emails.attachments.presigned_url

string | null

invoices.emails.attachments.presigned_url_expires_at

string<date-time> | null

invoices.emails.attachments.purpose

string | null

The use case for this attachment

invoices.emails.attachments.remote_id

string | null

The address' third party API ID.

invoices.emails.attachments.size

integer | null

invoices.emails.attachments.src

any

invoices.emails.attachments.user_id

string | null

Maximum string length: 32

invoices.emails.author

object

Show child attributes

invoices.emails.author.email

string

required

Maximum string length: 255

invoices.emails.author.family_name

string

required

invoices.emails.author.given_name

string

required

invoices.emails.author.object

string

required

invoices.emails.author.organization_id

string

required

Maximum string length: 32

invoices.emails.author.id

string

Maximum string length: 32

invoices.emails.author.created_at

string<date-time>

invoices.emails.author.dashboard_settings

object

Show child attributes

invoices.emails.author.dashboard_settings.thread_emails_sort_order

string

default:asc

invoices.emails.author.default_email_sender_id

string | null

Maximum string length: 32

invoices.emails.author.invited_by_user_id

string | null

Maximum string length: 32

invoices.emails.author.is_access_approved

boolean

invoices.emails.author.is_org_admin

boolean

invoices.emails.author.modified_at

string<date-time> | null

invoices.emails.author.name

string

invoices.emails.author.onboarding_required

boolean

invoices.emails.author.profile_picture

string

invoices.emails.author.selected

boolean

invoices.emails.author_id

string | null

Maximum string length: 32

invoices.emails.bcc

string[]

invoices.emails.body

string | null

The HTML body of the email.

invoices.emails.bounced_addresses

string[]

List of email addresses that bounced for this email

invoices.emails.bulk_email_request_id

string | null

Maximum string length: 32

invoices.emails.cc

string[]

invoices.emails.created_at

string<date-time>

invoices.emails.custom_headers

any | null

Custom email headers

invoices.emails.direction

enum<string>

The request direction of the email. Either inbound or outbound

Available options:

inbound,

outbound

Maximum string length: 8

invoices.emails.email_reason

string | null

The reason the email was sent.

invoices.emails.email_sender

object

Show child attributes

invoices.emails.email_sender.email

string

required

The account's email.

Maximum string length: 255

invoices.emails.email_sender.object

string

required

invoices.emails.email_sender.reply_to

string

required

This account's default reply-to

Maximum string length: 255

invoices.emails.email_sender.user_id

string

required

Maximum string length: 32

invoices.emails.email_sender.id

string

Maximum string length: 32

invoices.emails.email_sender.created_at

string<date-time>

invoices.emails.email_sender.expired_at

string<date-time> | null

The time the email sender grant expired.

invoices.emails.email_sender.is_nylas_connection

boolean

invoices.emails.email_sender.is_nylas_grant_expired

boolean

Whether the Nylas grant for this email sender has expired

invoices.emails.email_sender.is_shared

boolean

Whether this email sender should be shared with the entire organization

invoices.emails.email_sender.modified_at

string<date-time> | null

invoices.emails.email_sender.name

string | null

Email owner's name.

invoices.emails.email_sender.provider

string | null

invoices.emails.email_sender.reply_to_name

string | null

This account's default reply-to

invoices.emails.email_sender.signature_html

string | null

Email signature html.

invoices.emails.email_sender_id

string | null

Maximum string length: 32

invoices.emails.error_message

string | null

The error message if the email failed to send.

invoices.emails.from_email

string

invoices.emails.generated_body

string | null

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

invoices.emails.is_automated

boolean

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

invoices.emails.is_generated

boolean

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

invoices.emails.is_originated_in_stuut

boolean

Whether the email originated (was sent through) Stuut.

invoices.emails.is_unread

boolean

invoices.emails.modified_at

string<date-time> | null

invoices.emails.parent_email_id

string | null

Maximum string length: 32

invoices.emails.participants

string<email>[]

invoices.emails.remote_id

string | null

The Nylas ID of the email

invoices.emails.remote_links

object[]

Show child attributes

invoices.emails.remote_links.email_id

string

required

Maximum string length: 32

invoices.emails.remote_links.email_sender_id

string

required

Maximum string length: 32

invoices.emails.remote_links.object

string

required

invoices.emails.remote_links.remote_id

string

required

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

invoices.emails.remote_links.remote_thread_id

string

required

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

invoices.emails.remote_links.created_at

string<date-time>

invoices.emails.remote_links.modified_at

string<date-time> | null

invoices.emails.reply_to

string[]

invoices.emails.send_separately

boolean

invoices.emails.sent_at

string<date-time> | null

When the email was sent.

invoices.emails.sent_by_id

string | null

Maximum string length: 32

invoices.emails.snippet

string | null

invoices.emails.status

enum<string>

Available options:

draft,

pending,

sending,

sent,

error

Maximum string length: 7

invoices.emails.subject

string | null

invoices.emails.to

string[]

invoices.in_dispute

boolean

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

invoices.is_issued_email_sent

boolean

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

invoices.issued_at

string<date-time> | null

The invoice's issue date.

invoices.last_outreach_at

string<date-time> | null

The last date outreach was sent for this invoice.

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

invoices.last_outreach_to

string | null

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

invoices.last_synced_at

string<date-time> | null

invoices.line_items

object[]

Show child attributes

invoices.line_items.invoice_id

string

required

Maximum string length: 32

invoices.line_items.object

string

required

invoices.line_items.remote_id

string

required

The line item's third party API ID.

invoices.line_items.created_at

string<date-time>

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

invoices.line_items.custom_fields

any

invoices.line_items.description

string | null

Descriptor of the line item.

invoices.line_items.line_number

integer | null

Line item number

invoices.line_items.modified_at

string<date-time> | null

invoices.line_items.name

string | null

The line item's name.

invoices.line_items.period_end_date

string<date-time> | null

End of the usage period.

invoices.line_items.period_start_date

string<date-time> | null

Start of the usage period.

invoices.line_items.product_type

string | null

invoices.line_items.quantity

integer

The line item's quantity.

invoices.line_items.remote_created_at

string<date-time> | null

When the third party's entry was created.

invoices.line_items.remote_metadata

unknown

invoices.line_items.remote_modified_at

string<date-time> | null

When the third party's entry was updated.

invoices.line_items.total_amount

integer

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

invoices.line_items.total_discount

integer

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

invoices.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)

invoices.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)

invoices.linked_integration

object

Show child attributes

invoices.linked_integration.integration_name

string

required

invoices.linked_integration.is_configured

boolean

required

invoices.linked_integration.object

string

required

invoices.linked_integration.settings

object

required

Show child attributes

invoices.linked_integration.settings.{key}

any

invoices.linked_integration.id

string

Maximum string length: 32

invoices.linked_integration.api_subdomain

string | null

invoices.linked_integration.api_url

string | null

invoices.linked_integration.connection_info

unknown

invoices.linked_integration.created_at

string<date-time>

invoices.linked_integration.credentials_expire_at

string<date-time> | null

The time at which the credentials expire.

invoices.linked_integration.health

object

Show child attributes

invoices.linked_integration.health.status

enum<string>

required

Available options:

incomplete,

relink_required,

unhealthy,

healthy

invoices.linked_integration.health.details

object

Show child attributes

invoices.linked_integration.health.details.{key}

unknown

invoices.linked_integration.health.message

string | null

invoices.linked_integration.health.reason

any | null

Available options:

invalid_credentials,

missing_permission,

missing_settings,

unknown_error,

connection_issue,

timeout,

invoices.linked_integration.identity_info

unknown

invoices.linked_integration.integration

object

Show child attributes

invoices.linked_integration.integration.display_name

string

required

invoices.linked_integration.integration.name

string

required

invoices.linked_integration.integration.object

string

required

invoices.linked_integration.integration.api_base_url

string

invoices.linked_integration.integration.api_documentation_url

string | null

invoices.linked_integration.integration.api_requires_subdomain

boolean

default:false

invoices.linked_integration.integration.auth_type

any | null

Available options:

api_key,

basic,

custom,

oauth1,

oauth2,

oauth2_cc,

invoices.linked_integration.integration.categories

enum<string>[]

Available options:

accounting,

banking,

crm,

file-storage,

communication

invoices.linked_integration.integration.color

string | null

invoices.linked_integration.integration.connection_guide_url

string | null

invoices.linked_integration.integration.connection_instructions

string[] | null

invoices.linked_integration.integration.connection_steps

object[]

Show child attributes

invoices.linked_integration.integration.connection_steps.type

enum<string>

required

Available options:

fetch,

form,

quickbooks-desktop

invoices.linked_integration.integration.connection_steps.title

string

required

invoices.linked_integration.integration.connection_steps.description

string | null

invoices.linked_integration.integration.connection_steps.endpoint

string | null

invoices.linked_integration.integration.connection_steps.fields

object[] | null

Show child attributes

invoices.linked_integration.integration.connection_steps.fields.setting

string | null

invoices.linked_integration.integration.connection_steps.post_auth

boolean

default:false

invoices.linked_integration.integration.created_at

string<date-time>

invoices.linked_integration.integration.description

string | null

invoices.linked_integration.integration.is_enabled

boolean

default:true

invoices.linked_integration.integration.logo

string | null

invoices.linked_integration.integration.logo_square

string | null

invoices.linked_integration.integration.modified_at

string<date-time> | null

invoices.linked_integration.integration.settings

object[]

Show child attributes

invoices.linked_integration.integration.settings.key

string

required

invoices.linked_integration.integration.settings.type

enum<string>

required

Available options:

any,

array,

boolean,

integer,

number,

object,

string

invoices.linked_integration.integration.settings.choices

object[] | null

Show child attributes

invoices.linked_integration.integration.settings.choices.label

string

required

The label of the choice.

invoices.linked_integration.integration.settings.choices.value

any

required

The value of the choice.

invoices.linked_integration.integration.settings.description

string | null

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

invoices.linked_integration.integration.settings.group

string | null

invoices.linked_integration.integration.settings.guide_url

string | null

invoices.linked_integration.integration.settings.is_editable

boolean

default:false

invoices.linked_integration.integration.settings.is_required

boolean

default:true

invoices.linked_integration.integration.settings.is_select

boolean

default:false

invoices.linked_integration.integration.settings.label

string | null

invoices.linked_integration.integration.settings.post_auth

boolean

default:false

invoices.linked_integration.integration.settings.requires_load

boolean

default:false

invoices.linked_integration.integration.short_description

string | null

invoices.linked_integration.is_running_setup

boolean

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

invoices.linked_integration.is_webhooks_enabled

boolean

invoices.linked_integration.models

object[]

Show child attributes

invoices.linked_integration.models.integration_schema_id

string

required

Maximum string length: 32

invoices.linked_integration.models.linked_integration_id

string

required

Maximum string length: 32

invoices.linked_integration.models.name

string

required

invoices.linked_integration.models.object

string

required

invoices.linked_integration.models.id

string

Maximum string length: 32

invoices.linked_integration.models.created_at

string<date-time>

invoices.linked_integration.models.exclude_rule

object

invoices.linked_integration.models.field_mappings

unknown

invoices.linked_integration.models.health

object

Show child attributes

invoices.linked_integration.models.health.status

enum<string>

required

Available options:

incomplete,

unhealthy,

healthy

invoices.linked_integration.models.health.details

object

Show child attributes

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

unknown

invoices.linked_integration.models.health.message

string | null

invoices.linked_integration.models.health.reason

any | null

Available options:

incomplete_field_mappings,

missing_integration_schema,

missing_permission,

unknown_error,

connection_issue,

timeout,

invoices.linked_integration.models.is_read_enabled

boolean

invoices.linked_integration.models.is_webhooks_setup

boolean

invoices.linked_integration.models.is_write_enabled

boolean

invoices.linked_integration.models.last_sync

object

Show child attributes

invoices.linked_integration.models.last_sync.linked_model_id

string

required

Maximum string length: 32

invoices.linked_integration.models.last_sync.object

string

required

invoices.linked_integration.models.last_sync.run_id

string

required

Maximum string length: 32

invoices.linked_integration.models.last_sync.id

string

Maximum string length: 32

invoices.linked_integration.models.last_sync.created_at

string<date-time>

invoices.linked_integration.models.last_sync.entity_id

string | null

invoices.linked_integration.models.last_sync.is_initial_sync

boolean

invoices.linked_integration.models.last_sync.is_one_off

boolean

Whether or not this is a one off sync

invoices.linked_integration.models.last_sync.modified_at

string<date-time> | null

invoices.linked_integration.models.last_sync.pagination

unknown

invoices.linked_integration.models.last_sync.run

object

Show child attributes

invoices.linked_integration.models.last_sync.run.object

string

required

invoices.linked_integration.models.last_sync.run.id

string

Maximum string length: 32

invoices.linked_integration.models.last_sync.run.completed_at

string<date-time> | null

invoices.linked_integration.models.last_sync.run.created_at

string<date-time>

invoices.linked_integration.models.last_sync.run.data

unknown

invoices.linked_integration.models.last_sync.run.event_id

string | null

Maximum string length: 32

invoices.linked_integration.models.last_sync.run.modified_at

string<date-time> | null

invoices.linked_integration.models.last_sync.run.output

unknown

invoices.linked_integration.models.last_sync.run.remote_id

string | null

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

invoices.linked_integration.models.last_sync.run.stacktrace

string | null

invoices.linked_integration.models.last_sync.run.started_at

string<date-time> | null

invoices.linked_integration.models.last_sync.run.status

enum<string>

Available options:

scheduled,

queued,

skipped,

running,

cancelled,

failed,

pending_retry,

complete

Maximum string length: 13

invoices.linked_integration.models.last_sync.timerange_end

string<date-time> | null

invoices.linked_integration.models.last_sync.timerange_start

string<date-time> | null

invoices.linked_integration.models.last_sync_id

string | null

Maximum string length: 32

invoices.linked_integration.models.modified_at

string<date-time> | null

invoices.linked_integration.models.next_sync_at

string<date-time> | null

invoices.linked_integration.models.sync_requested

boolean

invoices.linked_integration.modified_at

string<date-time> | null

invoices.linked_integration.name

string | null

User defined name of the linked integration.

invoices.linked_integration.owner_id

string | null

Maximum string length: 32

invoices.linked_integration.requires_setup

boolean

invoices.linked_integration.username

string | null

invoices.linked_integration.webhook_listener_url

string | null

invoices.linked_integration.webhook_setup_error

string | null

invoices.marked_uncollectible_at

string<date-time> | null

The date the invoice was marked uncollectible.

invoices.memo

string | null

A memo visible to the invoice's end user.

invoices.modified_at

string<date-time> | null

invoices.number

string | null

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

invoices.order_number

string | null

Unique identifier assigned to a purchase by a seller.

invoices.paid_at

string<date-time> | null

The date the invoice was paid.

invoices.partner

object

Show child attributes

invoices.partner.id

string

Maximum string length: 32

invoices.partner.account_number

string | null

The customer's account number.

invoices.partner.ap_portals

object[]

Show child attributes

invoices.partner.ap_portals.object

string

required

invoices.partner.ap_portals.partner_id

string

required

Reference to the Partner

Maximum string length: 32

invoices.partner.ap_portals.id

string

Maximum string length: 32

invoices.partner.ap_portals.account

object

Show child attributes

invoices.partner.ap_portals.account.object

string

required

invoices.partner.ap_portals.account.organization_id

string

required

Organization associated with this account

Maximum string length: 32

invoices.partner.ap_portals.account.provider

enum<string>

required

The AP Portal provider

Available options:

coupa,

ariba,

taulia

Maximum string length: 6

invoices.partner.ap_portals.account.id

string

Maximum string length: 32

invoices.partner.ap_portals.account.available_operations

any

invoices.partner.ap_portals.account.created_at

string<date-time>

invoices.partner.ap_portals.account.modified_at

string<date-time> | null

invoices.partner.ap_portals.account_id

string | null

Reference to the ap portal account

Maximum string length: 32

invoices.partner.ap_portals.account_key

string | null

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

invoices.partner.ap_portals.created_at

string<date-time>

invoices.partner.ap_portals.customer_identifier

string | null

Customer identifier on the portal, if exists.

invoices.partner.ap_portals.customer_name

string | null

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

invoices.partner.ap_portals.invoice_submission_guidelines

string | null

Natural language guidelines for processing invoice submissions.

invoices.partner.ap_portals.is_enabled

boolean

Whether this AP portal configuration is enabled

invoices.partner.ap_portals.is_invoice_submission_enabled

boolean

Whether invoice submission is enabled

invoices.partner.ap_portals.is_report_download_enabled

boolean

Whether report download is enabled

invoices.partner.ap_portals.modified_at

string<date-time> | null

invoices.partner.ap_portals.name

string | null

Name of the AP Portal

invoices.partner.ap_portals.provider

enum<string> | null

The AP Portal provider

Available options:

coupa,

ariba,

taulia,

Maximum string length: 6

invoices.partner.ap_portals.report_email

string | null

Email address to send downloaded reports to

invoices.partner.ap_portals.report_frequency

enum<string> | null

Frequency for report downloads

Available options:

daily,

weekly,

monthly,

Maximum string length: 7

invoices.partner.assignee

object

Show child attributes

invoices.partner.assignee.email

string

required

Maximum string length: 255

invoices.partner.assignee.family_name

string

required

invoices.partner.assignee.given_name

string

required

invoices.partner.assignee.object

string

required

invoices.partner.assignee.organization_id

string

required

Maximum string length: 32

invoices.partner.assignee.id

string

Maximum string length: 32

invoices.partner.assignee.created_at

string<date-time>

invoices.partner.assignee.dashboard_settings

object

Show child attributes

invoices.partner.assignee.dashboard_settings.thread_emails_sort_order

string

default:asc

invoices.partner.assignee.default_email_sender_id

string | null

Maximum string length: 32

invoices.partner.assignee.invited_by_user_id

string | null

Maximum string length: 32

invoices.partner.assignee.is_access_approved

boolean

invoices.partner.assignee.is_org_admin

boolean

invoices.partner.assignee.modified_at

string<date-time> | null

invoices.partner.assignee.name

string

invoices.partner.assignee.onboarding_required

boolean

invoices.partner.assignee.profile_picture

string

invoices.partner.assignee.selected

boolean

invoices.partner.assignee_id

string | null

Maximum string length: 32

invoices.partner.billing_address

object

Show child attributes

invoices.partner.billing_address.object

string

required

invoices.partner.billing_address.city

string | null

City, district, suburb, town, or village.

invoices.partner.billing_address.coordinates

object

Option 1
Option 2

invoices.partner.billing_address.country

string | null

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

Maximum string length: 3

invoices.partner.billing_address.created_at

string<date-time>

invoices.partner.billing_address.description

string | null

invoices.partner.billing_address.line1

string | null

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

invoices.partner.billing_address.line2

string | null

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

invoices.partner.billing_address.modified_at

string<date-time> | null

invoices.partner.billing_address.name

string | null

invoices.partner.billing_address.phone

string | null

Maximum string length: 20

invoices.partner.billing_address.postal_code

string | null

ZIP or postal code.

invoices.partner.billing_address.remote_id

string | null

The address' third party API ID.

invoices.partner.billing_address.state

string | null

State, county, province, or region.

invoices.partner.billing_address.type

string

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

invoices.partner.billing_address_id

integer | null

invoices.partner.contacts

object[]

Show child attributes

invoices.partner.contacts.email

string

required

The contact's email address.

Maximum string length: 255

invoices.partner.contacts.object

string

required

invoices.partner.contacts.partner_id

string

required

Maximum string length: 32

invoices.partner.contacts.id

string

Maximum string length: 32

invoices.partner.contacts.address

object

Show child attributes

invoices.partner.contacts.address.object

string

required

invoices.partner.contacts.address.city

string | null

City, district, suburb, town, or village.

invoices.partner.contacts.address.coordinates

object

Option 1
Option 2

invoices.partner.contacts.address.country

string | null

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

Maximum string length: 3

invoices.partner.contacts.address.created_at

string<date-time>

invoices.partner.contacts.address.description

string | null

invoices.partner.contacts.address.line1

string | null

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

invoices.partner.contacts.address.line2

string | null

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

invoices.partner.contacts.address.modified_at

string<date-time> | null

invoices.partner.contacts.address.name

string | null

invoices.partner.contacts.address.phone

string | null

Maximum string length: 20

invoices.partner.contacts.address.postal_code

string | null

ZIP or postal code.

invoices.partner.contacts.address.remote_id

string | null

The address' third party API ID.

invoices.partner.contacts.address.state

string | null

State, county, province, or region.

invoices.partner.contacts.address.type

string

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

invoices.partner.contacts.address_id

integer | null

invoices.partner.contacts.addresses

object[]

Show child attributes

invoices.partner.contacts.addresses.object

string

required

invoices.partner.contacts.addresses.id

string

Maximum string length: 32

invoices.partner.contacts.addresses.city

string | null

City, district, suburb, town, or village.

invoices.partner.contacts.addresses.coordinates

object

Option 1
Option 2

invoices.partner.contacts.addresses.country

string | null

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

Maximum string length: 3

invoices.partner.contacts.addresses.created_at

string<date-time>

invoices.partner.contacts.addresses.description

string | null

invoices.partner.contacts.addresses.is_primary

boolean

invoices.partner.contacts.addresses.line1

string | null

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

invoices.partner.contacts.addresses.line2

string | null

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

invoices.partner.contacts.addresses.modified_at

string<date-time> | null

invoices.partner.contacts.addresses.name

string | null

invoices.partner.contacts.addresses.postal_code

string | null

ZIP or postal code.

invoices.partner.contacts.addresses.state

string | null

State, county, province, or region.

invoices.partner.contacts.addresses.type

string

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

invoices.partner.contacts.created_at

string<date-time>

invoices.partner.contacts.custom_fields

any

invoices.partner.contacts.external_role

enum<string> | null

The external contact's role.

Available options:

billing_contact,

executive,

economic_user,

Maximum string length: 15

invoices.partner.contacts.family_name

string | null

If an individual, the contact's family name.

invoices.partner.contacts.given_name

string | null

If an individual, the contact's given name.

invoices.partner.contacts.internal_role

enum<string> | null

The internal contact's role.

Available options:

account_manager,

account_executive,

csm,

Maximum string length: 17

invoices.partner.contacts.is_email_disabled

boolean

Whether the contact's email has been deemed invalid.

invoices.partner.contacts.is_phone_disabled

boolean

Whether the contact's email has been deemed invalid.

invoices.partner.contacts.is_primary

boolean

Whether the contact is a primary contact for the partner.

invoices.partner.contacts.is_primary_email

boolean

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

invoices.partner.contacts.is_primary_phone

boolean

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

invoices.partner.contacts.job_title

string | null

The contact's job at their company.

invoices.partner.contacts.modified_at

string<date-time> | null

invoices.partner.contacts.name

string | null

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

invoices.partner.contacts.phone

string | null

The contact's phone number.

Maximum string length: 32

invoices.partner.contacts.remote_created_at

string<date-time> | null

When the third party's entry was created.

invoices.partner.contacts.remote_id

string | null

The contact's third party API ID.

invoices.partner.contacts.remote_metadata

unknown

invoices.partner.contacts.remote_modified_at

string<date-time> | null

When the third party's entry was updated.

invoices.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}})

invoices.partner.created_at

string<date-time>

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

invoices.partner.custom_fields

any

invoices.partner.description

string | null

A description of the partner.

invoices.partner.email

string | null

The partner's company email address.

Maximum string length: 255

invoices.partner.family_name

string | null

The partner's family name.

invoices.partner.finix_identity_id

string | null

invoices.partner.given_name

string | null

The partner's given name.

invoices.partner.invoice_prefix

string | null

The prefix for this partner's invoice numbers.

invoices.partner.is_active

boolean

Whether the partner is active.

invoices.partner.is_call_outreach_manually_paused

boolean

invoices.partner.is_company

boolean

Whether the partner is a company or individual.

invoices.partner.is_email_disabled

boolean

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

invoices.partner.is_email_outreach_manually_paused

boolean

invoices.partner.is_phone_disabled

boolean

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

invoices.partner.is_primary_email

boolean

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

invoices.partner.is_primary_phone

boolean

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

invoices.partner.last_outreach_at

string<date-time> | null

The last date outreach was sent for this partner.

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

invoices.partner.last_outreach_to

string | null

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

invoices.partner.last_synced_at

string<date-time> | null

invoices.partner.legal_name

string | null

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

invoices.partner.linked_integration

object

Show child attributes

invoices.partner.linked_integration.integration_name

string

required

invoices.partner.linked_integration.is_configured

boolean

required

invoices.partner.linked_integration.object

string

required

invoices.partner.linked_integration.settings

object

required

Show child attributes

invoices.partner.linked_integration.settings.{key}

any

invoices.partner.linked_integration.id

string

Maximum string length: 32

invoices.partner.linked_integration.api_subdomain

string | null

invoices.partner.linked_integration.api_url

string | null

invoices.partner.linked_integration.connection_info

unknown

invoices.partner.linked_integration.created_at

string<date-time>

invoices.partner.linked_integration.credentials_expire_at

string<date-time> | null

The time at which the credentials expire.

invoices.partner.linked_integration.health

object

Show child attributes

invoices.partner.linked_integration.health.status

enum<string>

required

Available options:

incomplete,

relink_required,

unhealthy,

healthy

invoices.partner.linked_integration.health.details

object

Show child attributes

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

unknown

invoices.partner.linked_integration.health.message

string | null

invoices.partner.linked_integration.health.reason

any | null

Available options:

invalid_credentials,

missing_permission,

missing_settings,

unknown_error,

connection_issue,

timeout,

invoices.partner.linked_integration.identity_info

unknown

invoices.partner.linked_integration.integration

object

Show child attributes

invoices.partner.linked_integration.integration.display_name

string

required

invoices.partner.linked_integration.integration.name

string

required

invoices.partner.linked_integration.integration.object

string

required

invoices.partner.linked_integration.integration.api_base_url

string

invoices.partner.linked_integration.integration.api_documentation_url

string | null

invoices.partner.linked_integration.integration.api_requires_subdomain

boolean

default:false

invoices.partner.linked_integration.integration.auth_type

any | null

Available options:

api_key,

basic,

custom,

oauth1,

oauth2,

oauth2_cc,

invoices.partner.linked_integration.integration.categories

enum<string>[]

Available options:

accounting,

banking,

crm,

file-storage,

communication

invoices.partner.linked_integration.integration.color

string | null

invoices.partner.linked_integration.integration.connection_guide_url

string | null

invoices.partner.linked_integration.integration.connection_instructions

string[] | null

invoices.partner.linked_integration.integration.connection_steps

object[]

Show child attributes

invoices.partner.linked_integration.integration.connection_steps.type

enum<string>

required

Available options:

fetch,

form,

quickbooks-desktop

invoices.partner.linked_integration.integration.connection_steps.title

string

required

invoices.partner.linked_integration.integration.connection_steps.description

string | null

invoices.partner.linked_integration.integration.connection_steps.endpoint

string | null

invoices.partner.linked_integration.integration.connection_steps.fields

object[] | null

Show child attributes

invoices.partner.linked_integration.integration.connection_steps.fields.setting

string | null

invoices.partner.linked_integration.integration.connection_steps.post_auth

boolean

default:false

invoices.partner.linked_integration.integration.created_at

string<date-time>

invoices.partner.linked_integration.integration.description

string | null

invoices.partner.linked_integration.integration.is_enabled

boolean

default:true

invoices.partner.linked_integration.integration.logo

string | null

invoices.partner.linked_integration.integration.logo_square

string | null

invoices.partner.linked_integration.integration.modified_at

string<date-time> | null

invoices.partner.linked_integration.integration.settings

object[]

Show child attributes

invoices.partner.linked_integration.integration.settings.key

string

required

invoices.partner.linked_integration.integration.settings.type

enum<string>

required

Available options:

any,

array,

boolean,

integer,

number,

object,

string

invoices.partner.linked_integration.integration.settings.choices

object[] | null

Show child attributes

invoices.partner.linked_integration.integration.settings.choices.label

string

required

The label of the choice.

invoices.partner.linked_integration.integration.settings.choices.value

any

required

The value of the choice.

invoices.partner.linked_integration.integration.settings.description

string | null

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

invoices.partner.linked_integration.integration.settings.group

string | null

invoices.partner.linked_integration.integration.settings.guide_url

string | null

invoices.partner.linked_integration.integration.settings.is_editable

boolean

default:false

invoices.partner.linked_integration.integration.settings.is_required

boolean

default:true

invoices.partner.linked_integration.integration.settings.is_select

boolean

default:false

invoices.partner.linked_integration.integration.settings.label

string | null

invoices.partner.linked_integration.integration.settings.post_auth

boolean

default:false

invoices.partner.linked_integration.integration.settings.requires_load

boolean

default:false

invoices.partner.linked_integration.integration.short_description

string | null

invoices.partner.linked_integration.is_running_setup

boolean

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

invoices.partner.linked_integration.is_webhooks_enabled

boolean

invoices.partner.linked_integration.models

object[]

Show child attributes

invoices.partner.linked_integration.models.integration_schema_id

string

required

Maximum string length: 32

invoices.partner.linked_integration.models.linked_integration_id

string

required

Maximum string length: 32

invoices.partner.linked_integration.models.name

string

required

invoices.partner.linked_integration.models.object

string

required

invoices.partner.linked_integration.models.id

string

Maximum string length: 32

invoices.partner.linked_integration.models.created_at

string<date-time>

invoices.partner.linked_integration.models.exclude_rule

object

invoices.partner.linked_integration.models.field_mappings

unknown

invoices.partner.linked_integration.models.health

object

Show child attributes

invoices.partner.linked_integration.models.health.status

enum<string>

required

Available options:

incomplete,

unhealthy,

healthy

invoices.partner.linked_integration.models.health.details

object

Show child attributes

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

unknown

invoices.partner.linked_integration.models.health.message

string | null

invoices.partner.linked_integration.models.health.reason

any | null

Available options:

incomplete_field_mappings,

missing_integration_schema,

missing_permission,

unknown_error,

connection_issue,

timeout,

invoices.partner.linked_integration.models.is_read_enabled

boolean

invoices.partner.linked_integration.models.is_webhooks_setup

boolean

invoices.partner.linked_integration.models.is_write_enabled

boolean

invoices.partner.linked_integration.models.last_sync

object

Show child attributes

invoices.partner.linked_integration.models.last_sync.linked_model_id

string

required

Maximum string length: 32

invoices.partner.linked_integration.models.last_sync.object

string

required

invoices.partner.linked_integration.models.last_sync.run_id

string

required

Maximum string length: 32

invoices.partner.linked_integration.models.last_sync.id

string

Maximum string length: 32

invoices.partner.linked_integration.models.last_sync.created_at

string<date-time>

invoices.partner.linked_integration.models.last_sync.entity_id

string | null

invoices.partner.linked_integration.models.last_sync.is_initial_sync

boolean

invoices.partner.linked_integration.models.last_sync.is_one_off

boolean

Whether or not this is a one off sync

invoices.partner.linked_integration.models.last_sync.modified_at

string<date-time> | null

invoices.partner.linked_integration.models.last_sync.pagination

unknown

invoices.partner.linked_integration.models.last_sync.run

object

Show child attributes

invoices.partner.linked_integration.models.last_sync.run.object

string

required

invoices.partner.linked_integration.models.last_sync.run.id

string

Maximum string length: 32

invoices.partner.linked_integration.models.last_sync.run.completed_at

string<date-time> | null

invoices.partner.linked_integration.models.last_sync.run.created_at

string<date-time>

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

unknown

invoices.partner.linked_integration.models.last_sync.run.event_id

string | null

Maximum string length: 32

invoices.partner.linked_integration.models.last_sync.run.modified_at

string<date-time> | null

invoices.partner.linked_integration.models.last_sync.run.output

unknown

invoices.partner.linked_integration.models.last_sync.run.remote_id

string | null

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

invoices.partner.linked_integration.models.last_sync.run.stacktrace

string | null

invoices.partner.linked_integration.models.last_sync.run.started_at

string<date-time> | null

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

invoices.partner.linked_integration.models.last_sync.timerange_end

string<date-time> | null

invoices.partner.linked_integration.models.last_sync.timerange_start

string<date-time> | null

invoices.partner.linked_integration.models.last_sync_id

string | null

Maximum string length: 32

invoices.partner.linked_integration.models.modified_at

string<date-time> | null

invoices.partner.linked_integration.models.next_sync_at

string<date-time> | null

invoices.partner.linked_integration.models.sync_requested

boolean

invoices.partner.linked_integration.modified_at

string<date-time> | null

invoices.partner.linked_integration.name

string | null

User defined name of the linked integration.

invoices.partner.linked_integration.owner_id

string | null

Maximum string length: 32

invoices.partner.linked_integration.requires_setup

boolean

invoices.partner.linked_integration.username

string | null

invoices.partner.linked_integration.webhook_listener_url

string | null

invoices.partner.linked_integration.webhook_setup_error

string | null

invoices.partner.modified_at

string<date-time> | null

invoices.partner.name

string | null

The full name of the partner.

invoices.partner.object

string

invoices.partner.on_behalf_of

string | null

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

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

invoices.partner.organization_id

string

Maximum string length: 32

invoices.partner.parent_id

string | null

Maximum string length: 32

invoices.partner.phone

string | null

The partner's default phone number.

Maximum string length: 32

invoices.partner.remote_created_at

string<date-time> | null

When the third party's entry was created.

invoices.partner.remote_id

string

The partner's third party id.

invoices.partner.remote_metadata

unknown

invoices.partner.remote_modified_at

string<date-time> | null

When the third party's entry was updated.

invoices.partner.remote_parent_id

string | null

The partner's third party parent partner id.

invoices.partner.remote_payment_portal_url

string | null

The partner's third party payment portal url.

invoices.partner.shipping_address

object

Show child attributes

invoices.partner.shipping_address.object

string

required

invoices.partner.shipping_address.city

string | null

City, district, suburb, town, or village.

invoices.partner.shipping_address.coordinates

object

Option 1
Option 2

invoices.partner.shipping_address.country

string | null

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

Maximum string length: 3

invoices.partner.shipping_address.created_at

string<date-time>

invoices.partner.shipping_address.description

string | null

invoices.partner.shipping_address.line1

string | null

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

invoices.partner.shipping_address.line2

string | null

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

invoices.partner.shipping_address.modified_at

string<date-time> | null

invoices.partner.shipping_address.name

string | null

invoices.partner.shipping_address.phone

string | null

Maximum string length: 20

invoices.partner.shipping_address.postal_code

string | null

ZIP or postal code.

invoices.partner.shipping_address.remote_id

string | null

The address' third party API ID.

invoices.partner.shipping_address.state

string | null

State, county, province, or region.

invoices.partner.shipping_address.type

string

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

invoices.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}})

invoices.partner.sync_status

enum<string>

The sync status for this entity.

Available options:

partial,

syncing,

synced,

failed

Maximum string length: 7

invoices.partner.tags

object[]

Show child attributes

invoices.partner.tags.object

string

required

invoices.partner.tags.partner_id

string

required

Maximum string length: 32

invoices.partner.tags.tag_id

string

required

Maximum string length: 32

invoices.partner.tags.created_at

string<date-time>

invoices.partner.tags.is_manual

boolean

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

invoices.partner.tags.modified_at

string<date-time> | null

invoices.partner.tags.tag

object

Show child attributes

invoices.partner.tags.tag.name

string

required

The name of the tag.

invoices.partner.tags.tag.object

string

required

invoices.partner.tags.tag.id

string

Maximum string length: 32

invoices.partner.tags.tag.color

string

The hex color code of the tag, if any.

Maximum string length: 20

invoices.partner.tags.tag.created_at

string<date-time>

invoices.partner.tags.tag.modified_at

string<date-time> | null

invoices.partner.tags.tag.rule_condition

object

invoices.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).

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

invoices.partner_id

string | null

The id of the customer this invoice is issued to.

Maximum string length: 32

invoices.payments

object[]

Show child attributes

invoices.payments.amount

integer

required

The amount applied to the invoice.

invoices.payments.invoice_id

string

required

Maximum string length: 32

invoices.payments.object

string

required

invoices.payments.payment_id

string

required

Maximum string length: 32

invoices.payments.strategy

enum<string>

required

Available options:

automatic,

expected,

manual,

suggested

Maximum string length: 9

invoices.payments.id

string

Maximum string length: 32

invoices.payments.agent_confidence_reason

string | null

The justification for the agent's confidence score.

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

invoices.payments.agent_error_code

string | null

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

invoices.payments.agent_uncertainties

string[]

A list of uncertainties we have regarding the result.

invoices.payments.approved

boolean

Whether the allocation is approved.

invoices.payments.approved_at

string<date-time> | null

The time the payment allocation was approved.

invoices.payments.approver_id

string | null

Maximum string length: 32

invoices.payments.created_at

string<date-time>

invoices.payments.modified_at

string<date-time> | null

invoices.payments.payment

object

Show child attributes

invoices.payments.payment.id

string

Maximum string length: 32

invoices.payments.payment.agent_confidence_reason

string | null

The justification for the agent's confidence score.

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

invoices.payments.payment.agent_error_code

string | null

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

invoices.payments.payment.agent_uncertainties

string[]

A list of uncertainties we have regarding the result.

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

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

invoices.payments.payment.bank_transaction_id

string | null

The bank_transaction this payment was reconciled to.

Maximum string length: 32

invoices.payments.payment.billing_email

string | null

The billing email address of the payment

Maximum string length: 255

invoices.payments.payment.created_at

string<date-time>

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

invoices.payments.payment.currency_rate

integer | null

invoices.payments.payment.custom_fields

any

invoices.payments.payment.description

string | null

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

invoices.payments.payment.expected_at

string<date-time> | null

When the payment is expected to post.

invoices.payments.payment.finix_transfer_id

string | null

Maximum string length: 32

invoices.payments.payment.initiated_at

string<date-time> | null

The time at which the payment was initiated.

invoices.payments.payment.last_exported_at

string<date-time> | null

The time at which the payment was last exported.

invoices.payments.payment.last_synced_at

string<date-time> | null

invoices.payments.payment.linked_integration_id

string | null

The linked_integration this payment was originated from, if any.

Maximum string length: 32

invoices.payments.payment.modified_at

string<date-time> | null

invoices.payments.payment.object

string

invoices.payments.payment.partner_id

string

The id of the partner that made this payment.

Maximum string length: 32

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

invoices.payments.payment.receipt_url

string | null

invoices.payments.payment.reference_number

string | null

A unique identifier for the payment.

invoices.payments.payment.remittance_id

string | null

The id of the remittance this payment originated from.

Maximum string length: 32

invoices.payments.payment.remote_created_at

string<date-time> | null

When the third party's entry was created.

invoices.payments.payment.remote_id

string | null

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

invoices.payments.payment.remote_metadata

unknown

invoices.payments.payment.remote_modified_at

string<date-time> | null

When the third party's entry was updated.

invoices.payments.payment.statement_descriptor

string | null

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

invoices.payments.payment.status

enum<string>

The status of the payment.

Available options:

pending_match,

pending_approval,

approved,

finalized

Maximum string length: 16

invoices.payments.payment.stripe_session_id

string | null

Maximum string length: 32

invoices.payments.payment.sync_status

enum<string>

The sync status for this entity.

Available options:

partial,

syncing,

synced,

failed

Maximum string length: 7

invoices.payments.payment.timestamp

string<date-time>

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

invoices.payments.payment.transaction_match_approved_at

string<date-time> | null

The time at which the transaction match was approved.

invoices.payments.payment.transaction_match_approver_id

string | null

Maximum string length: 32

invoices.payments.remote_id

string | null

The identifier of the allocation in the remote system.

invoices.pdf

any

invoices.pdf_id

string | null

Maximum string length: 32

invoices.period_end_date

string<date-time> | null

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

invoices.period_start_date

string<date-time> | null

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

invoices.private_note

string | null

The invoice's organization-private note.

invoices.promised_to_pay_date

string<date> | null

The date the customer has promised to pay the invoice.

invoices.purchase_order_number

string | null

Unique identifier assigned to a purchase order by a buyer.

invoices.remote_created_at

string<date-time> | null

When the third party's entry was created.

invoices.remote_invoice_pdf

string | null

The url to the invoice's third party pdf.

invoices.remote_metadata

unknown

invoices.remote_modified_at

string<date-time> | null

When the third party's entry was updated.

invoices.remote_partner_id

string | null

The invoice's partner's third party id.

invoices.remote_payment_portal_url

string | null

The invoice's third party payment url.

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

invoices.remote_status

string | null

The invoice's third party status.

invoices.requires_line_item_sync

boolean

invoices.shipping_address

object

Show child attributes

invoices.shipping_address.object

string

required

invoices.shipping_address.city

string | null

City, district, suburb, town, or village.

invoices.shipping_address.coordinates

object

Option 1
Option 2

invoices.shipping_address.country

string | null

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

Maximum string length: 3

invoices.shipping_address.created_at

string<date-time>

invoices.shipping_address.description

string | null

invoices.shipping_address.line1

string | null

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

invoices.shipping_address.line2

string | null

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

invoices.shipping_address.modified_at

string<date-time> | null

invoices.shipping_address.name

string | null

invoices.shipping_address.phone

string | null

Maximum string length: 20

invoices.shipping_address.postal_code

string | null

ZIP or postal code.

invoices.shipping_address.remote_id

string | null

The address' third party API ID.

invoices.shipping_address.state

string | null

State, county, province, or region.

invoices.shipping_address.type

string

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

invoices.shipping_address_id

integer | null

invoices.status

any

invoices.subtotal

integer

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

invoices.sync_status

enum<string>

The sync status for this entity.

Available options:

partial,

syncing,

synced,

failed

Maximum string length: 7

invoices.total_discount

integer

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

invoices.total_tax

integer

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

invoices.type

enum<string>

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

Available options:

payable,

receivable

Maximum string length: 10

invoices.voided_at

string<date-time> | null

The date the invoice was voided.

is_automated

boolean

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

modified_at

string<date-time> | null

partner

object

Show child attributes

partner.id

string

Maximum string length: 32

partner.account_number

string | null

The customer's account number.

partner.ap_portals

object[]

Show child attributes

partner.ap_portals.object

string

required

partner.ap_portals.partner_id

string

required

Reference to the Partner

Maximum string length: 32

partner.ap_portals.id

string

Maximum string length: 32

partner.ap_portals.account

object

Show child attributes

partner.ap_portals.account.object

string

required

partner.ap_portals.account.organization_id

string

required

Organization associated with this account

Maximum string length: 32

partner.ap_portals.account.provider

enum<string>

required

The AP Portal provider

Available options:

coupa,

ariba,

taulia

Maximum string length: 6

partner.ap_portals.account.id

string

Maximum string length: 32

partner.ap_portals.account.available_operations

any

partner.ap_portals.account.created_at

string<date-time>

partner.ap_portals.account.modified_at

string<date-time> | null

partner.ap_portals.account_id

string | null

Reference to the ap portal account

Maximum string length: 32

partner.ap_portals.account_key

string | null

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

partner.ap_portals.created_at

string<date-time>

partner.ap_portals.customer_identifier

string | null

Customer identifier on the portal, if exists.

partner.ap_portals.customer_name

string | null

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

partner.ap_portals.invoice_submission_guidelines

string | null

Natural language guidelines for processing invoice submissions.

partner.ap_portals.is_enabled

boolean

Whether this AP portal configuration is enabled

partner.ap_portals.is_invoice_submission_enabled

boolean

Whether invoice submission is enabled

partner.ap_portals.is_report_download_enabled

boolean

Whether report download is enabled

partner.ap_portals.modified_at

string<date-time> | null

partner.ap_portals.name

string | null

Name of the AP Portal

partner.ap_portals.provider

enum<string> | null

The AP Portal provider

Available options:

coupa,

ariba,

taulia,

Maximum string length: 6

partner.ap_portals.report_email

string | null

Email address to send downloaded reports to

partner.ap_portals.report_frequency

enum<string> | null

Frequency for report downloads

Available options:

daily,

weekly,

monthly,

Maximum string length: 7

partner.assignee

object

Show child attributes

partner.assignee.email

string

required

Maximum string length: 255

partner.assignee.family_name

string

required

partner.assignee.given_name

string

required

partner.assignee.object

string

required

partner.assignee.organization_id

string

required

Maximum string length: 32

partner.assignee.id

string

Maximum string length: 32

partner.assignee.created_at

string<date-time>

partner.assignee.dashboard_settings

object

Show child attributes

partner.assignee.dashboard_settings.thread_emails_sort_order

string

default:asc

partner.assignee.default_email_sender_id

string | null

Maximum string length: 32

partner.assignee.invited_by_user_id

string | null

Maximum string length: 32

partner.assignee.is_access_approved

boolean

partner.assignee.is_org_admin

boolean

partner.assignee.modified_at

string<date-time> | null

partner.assignee.name

string

partner.assignee.onboarding_required

boolean

partner.assignee.profile_picture

string

partner.assignee.selected

boolean

partner.assignee_id

string | null

Maximum string length: 32

partner.billing_address

object

Show child attributes

partner.billing_address.object

string

required

partner.billing_address.city

string | null

City, district, suburb, town, or village.

partner.billing_address.coordinates

object

Option 1
Option 2

partner.billing_address.country

string | null

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

Maximum string length: 3

partner.billing_address.created_at

string<date-time>

partner.billing_address.description

string | null

partner.billing_address.line1

string | null

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

partner.billing_address.line2

string | null

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

partner.billing_address.modified_at

string<date-time> | null

partner.billing_address.name

string | null

partner.billing_address.phone

string | null

Maximum string length: 20

partner.billing_address.postal_code

string | null

ZIP or postal code.

partner.billing_address.remote_id

string | null

The address' third party API ID.

partner.billing_address.state

string | null

State, county, province, or region.

partner.billing_address.type

string

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

partner.billing_address_id

integer | null

partner.contacts

object[]

Show child attributes

partner.contacts.email

string

required

The contact's email address.

Maximum string length: 255

partner.contacts.object

string

required

partner.contacts.partner_id

string

required

Maximum string length: 32

partner.contacts.id

string

Maximum string length: 32

partner.contacts.address

object

Show child attributes

partner.contacts.address.object

string

required

partner.contacts.address.city

string | null

City, district, suburb, town, or village.

partner.contacts.address.coordinates

object

Option 1
Option 2

partner.contacts.address.country

string | null

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

Maximum string length: 3

partner.contacts.address.created_at

string<date-time>

partner.contacts.address.description

string | null

partner.contacts.address.line1

string | null

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

partner.contacts.address.line2

string | null

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

partner.contacts.address.modified_at

string<date-time> | null

partner.contacts.address.name

string | null

partner.contacts.address.phone

string | null

Maximum string length: 20

partner.contacts.address.postal_code

string | null

ZIP or postal code.

partner.contacts.address.remote_id

string | null

The address' third party API ID.

partner.contacts.address.state

string | null

State, county, province, or region.

partner.contacts.address.type

string

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

partner.contacts.address_id

integer | null

partner.contacts.addresses

object[]

Show child attributes

partner.contacts.addresses.object

string

required

partner.contacts.addresses.id

string

Maximum string length: 32

partner.contacts.addresses.city

string | null

City, district, suburb, town, or village.

partner.contacts.addresses.coordinates

object

Option 1
Option 2

partner.contacts.addresses.country

string | null

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

Maximum string length: 3

partner.contacts.addresses.created_at

string<date-time>

partner.contacts.addresses.description

string | null

partner.contacts.addresses.is_primary

boolean

partner.contacts.addresses.line1

string | null

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

partner.contacts.addresses.line2

string | null

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

partner.contacts.addresses.modified_at

string<date-time> | null

partner.contacts.addresses.name

string | null

partner.contacts.addresses.postal_code

string | null

ZIP or postal code.

partner.contacts.addresses.state

string | null

State, county, province, or region.

partner.contacts.addresses.type

string

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

partner.contacts.created_at

string<date-time>

partner.contacts.custom_fields

any

partner.contacts.external_role

enum<string> | null

The external contact's role.

Available options:

billing_contact,

executive,

economic_user,

Maximum string length: 15

partner.contacts.family_name

string | null

If an individual, the contact's family name.

partner.contacts.given_name

string | null

If an individual, the contact's given name.

partner.contacts.internal_role

enum<string> | null

The internal contact's role.

Available options:

account_manager,

account_executive,

csm,

Maximum string length: 17

partner.contacts.is_email_disabled

boolean

Whether the contact's email has been deemed invalid.

partner.contacts.is_phone_disabled

boolean

Whether the contact's email has been deemed invalid.

partner.contacts.is_primary

boolean

Whether the contact is a primary contact for the partner.

partner.contacts.is_primary_email

boolean

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

partner.contacts.is_primary_phone

boolean

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

partner.contacts.job_title

string | null

The contact's job at their company.

partner.contacts.modified_at

string<date-time> | null

partner.contacts.name

string | null

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

partner.contacts.phone

string | null

The contact's phone number.

Maximum string length: 32

partner.contacts.remote_created_at

string<date-time> | null

When the third party's entry was created.

partner.contacts.remote_id

string | null

The contact's third party API ID.

partner.contacts.remote_metadata

unknown

partner.contacts.remote_modified_at

string<date-time> | null

When the third party's entry was updated.

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}})

partner.created_at

string<date-time>

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

partner.custom_fields

any

partner.description

string | null

A description of the partner.

partner.email

string | null

The partner's company email address.

Maximum string length: 255

partner.family_name

string | null

The partner's family name.

partner.finix_identity_id

string | null

partner.given_name

string | null

The partner's given name.

partner.invoice_prefix

string | null

The prefix for this partner's invoice numbers.

partner.is_active

boolean

Whether the partner is active.

partner.is_company

boolean

Whether the partner is a company or individual.

partner.is_email_disabled

boolean

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

partner.is_phone_disabled

boolean

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

partner.is_primary_email

boolean

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

partner.is_primary_phone

boolean

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

partner.last_outreach_at

string<date-time> | null

The last date outreach was sent for this partner.

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

partner.last_outreach_to

string | null

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

partner.last_synced_at

string<date-time> | null

partner.legal_name

string | null

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

partner.linked_integration

object

Show child attributes

partner.linked_integration.integration_name

string

required

partner.linked_integration.is_configured

boolean

required

partner.linked_integration.object

string

required

partner.linked_integration.settings

object

required

Show child attributes

partner.linked_integration.settings.{key}

any

partner.linked_integration.id

string

Maximum string length: 32

partner.linked_integration.api_subdomain

string | null

partner.linked_integration.api_url

string | null

partner.linked_integration.connection_info

unknown

partner.linked_integration.created_at

string<date-time>

partner.linked_integration.credentials_expire_at

string<date-time> | null

The time at which the credentials expire.

partner.linked_integration.health

object

Show child attributes

partner.linked_integration.health.status

enum<string>

required

Available options:

incomplete,

relink_required,

unhealthy,

healthy

partner.linked_integration.health.details

object

Show child attributes

partner.linked_integration.health.details.{key}

unknown

partner.linked_integration.health.message

string | null

partner.linked_integration.health.reason

any | null

Available options:

invalid_credentials,

missing_permission,

missing_settings,

unknown_error,

connection_issue,

timeout,

partner.linked_integration.identity_info

unknown

partner.linked_integration.integration

object

Show child attributes

partner.linked_integration.integration.display_name

string

required

partner.linked_integration.integration.name

string

required

partner.linked_integration.integration.object

string

required

partner.linked_integration.integration.api_base_url

string

partner.linked_integration.integration.api_documentation_url

string | null

partner.linked_integration.integration.api_requires_subdomain

boolean

default:false

partner.linked_integration.integration.auth_type

any | null

Available options:

api_key,

basic,

custom,

oauth1,

oauth2,

oauth2_cc,

partner.linked_integration.integration.categories

enum<string>[]

Available options:

accounting,

banking,

crm,

file-storage,

communication

partner.linked_integration.integration.color

string | null

partner.linked_integration.integration.connection_guide_url

string | null

partner.linked_integration.integration.connection_instructions

string[] | null

partner.linked_integration.integration.connection_steps

object[]

Show child attributes

partner.linked_integration.integration.connection_steps.type

enum<string>

required

Available options:

fetch,

form,

quickbooks-desktop

partner.linked_integration.integration.connection_steps.title

string

required

partner.linked_integration.integration.connection_steps.description

string | null

partner.linked_integration.integration.connection_steps.endpoint

string | null

partner.linked_integration.integration.connection_steps.fields

object[] | null

Show child attributes

partner.linked_integration.integration.connection_steps.fields.setting

string | null

partner.linked_integration.integration.connection_steps.post_auth

boolean

default:false

partner.linked_integration.integration.created_at

string<date-time>

partner.linked_integration.integration.description

string | null

partner.linked_integration.integration.is_enabled

boolean

default:true

partner.linked_integration.integration.logo

string | null

partner.linked_integration.integration.logo_square

string | null

partner.linked_integration.integration.modified_at

string<date-time> | null

partner.linked_integration.integration.settings

object[]

Show child attributes

partner.linked_integration.integration.settings.key

string

required

partner.linked_integration.integration.settings.type

enum<string>

required

Available options:

any,

array,

boolean,

integer,

number,

object,

string

partner.linked_integration.integration.settings.choices

object[] | null

Show child attributes

partner.linked_integration.integration.settings.choices.label

string

required

The label of the choice.

partner.linked_integration.integration.settings.choices.value

any

required

The value of the choice.

partner.linked_integration.integration.settings.description

string | null

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

partner.linked_integration.integration.settings.group

string | null

partner.linked_integration.integration.settings.guide_url

string | null

partner.linked_integration.integration.settings.is_editable

boolean

default:false

partner.linked_integration.integration.settings.is_required

boolean

default:true

partner.linked_integration.integration.settings.is_select

boolean

default:false

partner.linked_integration.integration.settings.label

string | null

partner.linked_integration.integration.settings.post_auth

boolean

default:false

partner.linked_integration.integration.settings.requires_load

boolean

default:false

partner.linked_integration.integration.short_description

string | null

partner.linked_integration.is_running_setup

boolean

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.

partner.linked_integration.is_webhooks_enabled

boolean

partner.linked_integration.models

object[]

Show child attributes

partner.linked_integration.models.integration_schema_id

string

required

Maximum string length: 32

partner.linked_integration.models.linked_integration_id

string

required

Maximum string length: 32

partner.linked_integration.models.name

string

required

partner.linked_integration.models.object

string

required

partner.linked_integration.models.id

string

Maximum string length: 32

partner.linked_integration.models.created_at

string<date-time>

partner.linked_integration.models.exclude_rule

object

partner.linked_integration.models.field_mappings

unknown

partner.linked_integration.models.health

object

Show child attributes

partner.linked_integration.models.health.status

enum<string>

required

Available options:

incomplete,

unhealthy,

healthy

partner.linked_integration.models.health.details

object

Show child attributes

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

unknown

partner.linked_integration.models.health.message

string | null

partner.linked_integration.models.health.reason

any | null

Available options:

incomplete_field_mappings,

missing_integration_schema,

missing_permission,

unknown_error,

connection_issue,

timeout,

partner.linked_integration.models.is_read_enabled

boolean

partner.linked_integration.models.is_webhooks_setup

boolean

partner.linked_integration.models.is_write_enabled

boolean

partner.linked_integration.models.last_sync

object

Show child attributes

partner.linked_integration.models.last_sync.linked_model_id

string

required

Maximum string length: 32

partner.linked_integration.models.last_sync.object

string

required

partner.linked_integration.models.last_sync.run_id

string

required

Maximum string length: 32

partner.linked_integration.models.last_sync.id

string

Maximum string length: 32

partner.linked_integration.models.last_sync.created_at

string<date-time>

partner.linked_integration.models.last_sync.entity_id

string | null

partner.linked_integration.models.last_sync.is_initial_sync

boolean

partner.linked_integration.models.last_sync.is_one_off

boolean

Whether or not this is a one off sync

partner.linked_integration.models.last_sync.modified_at

string<date-time> | null

partner.linked_integration.models.last_sync.pagination

unknown

partner.linked_integration.models.last_sync.run

object

Show child attributes

partner.linked_integration.models.last_sync.run.object

string

required

partner.linked_integration.models.last_sync.run.id

string

Maximum string length: 32

partner.linked_integration.models.last_sync.run.completed_at

string<date-time> | null

partner.linked_integration.models.last_sync.run.created_at

string<date-time>

partner.linked_integration.models.last_sync.run.data

unknown

partner.linked_integration.models.last_sync.run.event_id

string | null

Maximum string length: 32

partner.linked_integration.models.last_sync.run.modified_at

string<date-time> | null

partner.linked_integration.models.last_sync.run.output

unknown

partner.linked_integration.models.last_sync.run.remote_id

string | null

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

partner.linked_integration.models.last_sync.run.stacktrace

string | null

partner.linked_integration.models.last_sync.run.started_at

string<date-time> | null

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

partner.linked_integration.models.last_sync.timerange_end

string<date-time> | null

partner.linked_integration.models.last_sync.timerange_start

string<date-time> | null

partner.linked_integration.models.last_sync_id

string | null

Maximum string length: 32

partner.linked_integration.models.modified_at

string<date-time> | null

partner.linked_integration.models.next_sync_at

string<date-time> | null

partner.linked_integration.models.sync_requested

boolean

partner.linked_integration.modified_at

string<date-time> | null

partner.linked_integration.name

string | null

User defined name of the linked integration.

partner.linked_integration.owner_id

string | null

Maximum string length: 32

partner.linked_integration.requires_setup

boolean

partner.linked_integration.username

string | null

partner.linked_integration.webhook_listener_url

string | null

partner.linked_integration.webhook_setup_error

string | null

partner.modified_at

string<date-time> | null

partner.name

string | null

The full name of the partner.

partner.object

string

partner.on_behalf_of

string | null

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

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

partner.organization_id

string

Maximum string length: 32

partner.parent_id

string | null

Maximum string length: 32

partner.phone

string | null

The partner's default phone number.

Maximum string length: 32

partner.remote_created_at

string<date-time> | null

When the third party's entry was created.

partner.remote_id

string

The partner's third party id.

partner.remote_metadata

unknown

partner.remote_modified_at

string<date-time> | null

When the third party's entry was updated.

partner.remote_parent_id

string | null

The partner's third party parent partner id.

partner.remote_payment_portal_url

string | null

The partner's third party payment portal url.

partner.shipping_address

object

Show child attributes

partner.shipping_address.object

string

required

partner.shipping_address.city

string | null

City, district, suburb, town, or village.

partner.shipping_address.coordinates

object

Option 1
Option 2

partner.shipping_address.country

string | null

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

Maximum string length: 3

partner.shipping_address.created_at

string<date-time>

partner.shipping_address.description

string | null

partner.shipping_address.line1

string | null

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

partner.shipping_address.line2

string | null

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

partner.shipping_address.modified_at

string<date-time> | null

partner.shipping_address.name

string | null

partner.shipping_address.phone

string | null

Maximum string length: 20

partner.shipping_address.postal_code

string | null

ZIP or postal code.

partner.shipping_address.remote_id

string | null

The address' third party API ID.

partner.shipping_address.state

string | null

State, county, province, or region.

partner.shipping_address.type

string

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

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}})

partner.sync_status

enum<string>

The sync status for this entity.

Available options:

partial,

syncing,

synced,

failed

Maximum string length: 7

partner.tags

object[]

Show child attributes

partner.tags.object

string

required

partner.tags.partner_id

string

required

Maximum string length: 32

partner.tags.tag_id

string

required

Maximum string length: 32

partner.tags.created_at

string<date-time>

partner.tags.is_manual

boolean

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

partner.tags.modified_at

string<date-time> | null

partner.tags.tag

object

Show child attributes

partner.tags.tag.name

string

required

The name of the tag.

partner.tags.tag.object

string

required

partner.tags.tag.id

string

Maximum string length: 32

partner.tags.tag.color

string

The hex color code of the tag, if any.

Maximum string length: 20

partner.tags.tag.created_at

string<date-time>

partner.tags.tag.modified_at

string<date-time> | null

partner.tags.tag.rule_condition

object

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

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

partner_id

string | null

Maximum string length: 32

recording_url

any

retell_id

string | null

sentiment

enum<string> | null

Sentiment of the user in the call.

Available options:

positive,

negative,

neutral,

unknown,

Maximum string length: 8

start_time

string<date-time> | null

status

enum<string>

Available options:

pending_approval,

queued,

registered,

initiated,

ringing,

canceled,

in_progress,

completed,

busy,

no_answer,

failed

Maximum string length: 16

summary

string | null

The summary of the call.

transcript

any

transcript_str

string | null

The transcript of the call.

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

workflow

object

Show child attributes

workflow.id

string

Maximum string length: 32

workflow.active_days

integer[]

The days of the week to run the workflow on

workflow.created_at

string<date-time>

workflow.email_sender_id

string | null

Maximum string length: 32

workflow.is_active

boolean

workflow.is_call_on_weekend_enabled

boolean

Whether to allow calls on weekends

workflow.modified_at

string<date-time> | null

workflow.name

string

The name of the workflow

workflow.object

string

workflow.outreach_window_end

string

The end time of the outreach window

workflow.outreach_window_start

string

The start time of the outreach window

workflow.pending_run_strategy

enum<string>

Available options:

send_all,

send_first,

send_latest

Maximum string length: 11

workflow.test_email

string | null

workflow.test_phone_number

string | null

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

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

Path Parameters

Response