For the complete documentation index, see llms.txt. This page is also available as Markdown.

Account

Attributes of the Account type

An account record is used to represent a customer or trialist

Name
Type
Description

accountType

The type of account

accountTypeId

ID

Type of account

addressValidated

Boolean

Address validated status

ancestorAccounts

List (Account)

Account hierarchy path from immediate parent up to the root

annualRevenue

Int

Annual revenue

arr

Float

ARR (Annual Recurring Revenue) amount

balances

billingCity

String

City for billing

billingContact

Contact for billing correspondence

billingContactId

ID

Contact for billing correspondence

billingCountry

String

Country for billing

billingDay

Int

Day of the month to process billing

billingState

String

State for billing

billingStreet

String

Street address for billing

billingZip

String

Zip/PostalCode for billing

childAccounts

List (Account)

Direct child accounts in the hierarchy

code

String

Custom unique identifier for the account

consolidatedBilling

Boolean

Enable consolidated billing for this account

contacts

List (Contact)

List of contacts for the account

createdAt

ISO8601DateTime

Datetime the account was created

currency

Primary currency for billing

currencyId

ID

Primary currency for billing

customFieldDefinitions

Custom field definitions for this object type

customFieldsData

JSON

All custom field values for this object as a JSON object

dealDefaults

Default values for a new deal

deals

List (Deal)

List of deals for the account

descendantAccounts

List (Account)

All descendant accounts in the hierarchy (full subtree, excludes self)

description

String

Description of the account

disableDunning

Boolean

Indicates if dunning is disabled for this account

draftInvoices

Boolean

Send new invoices to draft state

duns

String

Dun & Bradstreet Number

effectiveBillingDate

ISO8601Date

Next effective billing date calculated from billing_day

emailsEnabled

Boolean

Enable sending emails to account contacts

employees

Int

Number of employees

entity

The entity this account belongs to

entityId

ID

The ID of the entity this account belongs to

entityUseCode

String

Tax entity use code

fax

String

Primary fax number for the account

groupId

ID

Group that the account belongs to

hasChildAccounts

Boolean

Whether this account has at least one direct child account

hasCustomFields

Boolean

Whether this object type has any custom fields defined

id

ID

Unique identifier for the account

inHierarchy

Boolean

Whether this account participates in a hierarchy (has a parent or any child)

industry

The industry the account belongs to

industryId

ID

Industry the account belongs to

invoiceTemplate

Invoice template to be used for invoice generation

invoiceTemplateId

ID

Invoice template to be used for invoice generation

invoicedAccount

Account that receives invoices; resolves to self when no delegation is set

invoicedAccountId

ID

Account that receives invoices generated by this account (NULL means self)

invoices

List (Invoice)

Invoices for the account

linkedinUrl

String

Link to the account's LinkedIn profile

mrr

Float

MRR (Monthly Recurring Revenue) amount

mur

Float

MUR (Monthly Usage Revenue) amount

name

String

Name of the account

netPaymentDays

Int

Payment terms in days

newQuoteBuilder

Boolean

Use the new quote builder to create quotes and invoices

nextRenewal

ISO8601Date

Next renewal date from active evergreen subscriptions

owner

Account owner

ownerUserId

ID

Account owner

parentAccount

Parent account in the account hierarchy

parentAccountId

ID

Parent account in the account hierarchy

payingAccount

Account whose payment method is used; resolves through invoiced_account when not set

payingAccountId

ID

Account whose payment method pays invoices generated by this account (NULL means same as invoiced)

payingStatus

Paying status

paymentMethods

Payment methods associated with this account

phone

String

Primary phone number for the account

recurringRevenues

Recurring revenues for the account

revenueMovements

revenueToDate

Float

Total revenue recognized to date

rootAncestorAccount

The topmost ancestor in the hierarchy (the account with no parent); resolves to self when this account has no parent

secondaryBillingContactIds

List (ID)

Secondary billing contact IDs

secondaryBillingContacts

List (Contact)

Secondary billing contact IDs

shippingCity

String

City for shipping

shippingCountry

String

Country for shipping

shippingState

String

State for shipping

shippingStreet

String

Street address for shipping

shippingZip

String

Zip/PostalCode for shipping

subscriptions

List of subscriptions

taxNumber

String

Tax number

taxNumberValidated

Boolean

The tax number supplied has been validated with an official source

timezone

String

Time zone for the account

transactions

upcomingBillingDates

List (ISO8601Date)

Upcoming account billing dates based on the current subscrptions

updatedAt

ISO8601DateTime

Datetime the account was last updated

validInvoicedCandidates

List (Account)

Accounts that may be assigned as this account's invoiced_account (self and ancestor chain)

validParentCandidates

List (Account)

Accounts that may be assigned as this account's parent (same warren and entity, excluding self and its descendants)

validPayingCandidates

List (Account)

Accounts that may be assigned as this account's paying_account given the currently saved invoiced_account (invoiced + its ancestors)

website

String

Website of the account

Last updated

Was this helpful?