EntityAttributes

Attributes of the EntityAttributes type

{
  "name": "",
  "abbreviation": "",
  "billingStreet": "",
  "billingCity": "",
  "billingState": "",
  "billingZip": "",
  "billingCountry": "",
  "phone": "",
  "fax": "",
  "website": "",
  "quoteNumberSeq": 123,
  "quoteNumberPrefix": "",
  "invoiceNumberSeq": 123,
  "invoiceNumberPrefix": "",
  "brandColor": "",
  "accentColor": "",
  "emailTemplate": "",
  "emailSenderName": "",
  "termsUrl": "",
  "privacyUrl": "",
  "refundPolicyUrl": "",
  "customerServiceEmail": "",
  "taxType": "TaxType",
  "taxId": "",
  "timezone": "",
  "fiscalYearStartMonth": 123,
  "isDefault": true,
  "baseCurrencyId": "456123"
}
Name
Type
Description

name

String

Name of the entity

abbreviation

String

Short name of the entity

billingStreet

String

Street address for billing

billingCity

String

City for billing

billingState

String

State for billing

billingZip

String

Zip/PostalCode for billing

billingCountry

String

Country for billing

phone

String

Primary phone number for the company

fax

String

Primary fax number for the company

website

String

Company website address

quoteNumberSeq

Int

Number to start quote numbers from

quoteNumberPrefix

String

Prefix value for all quote numbers. e.g. ABC

invoiceNumberSeq

Int

Number to start invoice numbers from

invoiceNumberPrefix

String

Prefix value for all invoice numbers. e.g. INV

brandColor

String

Brand color used for the customer portal

accentColor

String

Accent color used for the customer portal

emailTemplate

String

Email template

emailSenderName

String

The name that will appear as sender in the inbox

termsUrl

String

Link to the company's terms of service

privacyUrl

String

Link to the company's privacy policfy

refundPolicyUrl

String

Link to the company's refund policy

customerServiceEmail

String

Email address for customer service

taxType

Tax type to display on invoices

taxId

String

Tax ID to display on invoices

timezone

String

Timezone for the company

fiscalYearStartMonth

Int

The first month of the fiscal year (0-11)

isDefault

Boolean

New accounts will automatically be assigned to the default entity if none is specified

baseCurrencyId

ID

Base currency for the entity

Last updated

Was this helpful?