Skip to main content
GET
Get clients

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

businessId
string
default:""
lastUpdatedDate
string

Response

200 - application/json

Successful operation

id
string
business
object
isDefault
boolean
companyId
string
customerPartnerId
integer<int64>
name
string
additionalContactName
string
showName
boolean
businessName
string
showBusinessName
boolean
status
enum<string>
Available options:
OPEN,
COMPLETED,
CANCELED,
ARCHIVED
budgetAmount
number
type
enum<string>
Available options:
TIME_BASED,
FIXED_PRICE,
BUYER,
SELLER,
TENANT,
REA_OTHER
apiName
enum<string>
Available options:
GOOGLELOGIN,
LINKEDINLOGIN,
DROPBOX,
BOX,
SKYDRIVE,
CLOVER,
STRIPE,
GOOGLESTORAGE,
GOOGLECONTACTS,
GOOGLEEMAIL,
LINKEDINCONTACTS,
PLAID,
KNOX,
UBER,
FACEBOOKLOGIN,
FRESHBOOKS,
HARVEST,
KW,
FRESHBOOKS2,
CAPITAL_ONE,
SQUARE,
S3,
DOTLOOP,
XERO_DEPRECATED,
REALOGY,
UPWORK,
SHOPIFY,
DEDUCTR,
ENTERPRISE,
MOXIWORKS,
STRIPE_EXPRESS,
APPLELOGIN,
APPDIRECT,
LONEWOLF,
USER_IMPORTED,
LONEWOLF_TRANSACTIONDESK,
SAMPLE_BANK,
TAXBOT,
THIRD_PARTY_BANK,
GUSTO,
THIRD_PARTY_PAYMENTS,
XERO,
UNIT,
USER_ENTRY,
MOOV,
QBO,
COLUMN,
QUALPAY,
BENCH,
PARTNER_IMPLEMENTATION,
CHECK,
RUTTER,
WAVE,
ADYEN,
APRIL,
PAYABLI
apiClientId
string
email
string
showEmail
boolean
phoneWork
string
showPhoneWork
boolean
clientAddress1
string
clientAddress2
string
clientCity
string
clientState
string
clientZip
string
showAddress
boolean
invoicePrefix
string
createdDate
string<date-time>
ccemails
string
bccemails
string
idPrefix
enum<string>
Available options:
COMPANY,
EMPLOYEE,
DIMENSION_VALUE,
CLASS_LABEL,
CUSTOMER,
BANK_ACCOUNT,
GL_ACCOUNT,
TRANSACTION_CATEGORY,
BANK_TRANSACTION,
PROCESSOR_TRANSACTION,
TRANSACTION_LINE_ITEM,
VENDOR,
TRANSACTION_RULE,
REVENUE_RULE,
INVOICE,
INVOICE_LINE_ITEM,
BILL,
BILL_LINE_ITEM,
PAYROLL,
PAYROLL_LINE_ITEM,
FINANCIAL_SUMMARY,
TASK,
CONVERSATION,
MESSAGE,
REACTION,
BUSINESS_TYPE,
TEMPLATE_DIMENSION,
TEMPLATE_COA,
TEMPLATE_GL_ACCOUNT,
TEMPLATE_TRANSACTION_RULES,
MANUAL_JOURNAL_ENTRY,
GL_TRANSACTION,
ATTACHMENT,
CAR,
MILEAGE,
INTEGRATION,
TIME,
TIME_TYPE,
TAX_RETURN
nameForPagination
string
invoiceRecipientInfoDefaults
object

Defaults for client information on invoices

nameColumnNameForPagination
string
externalId
string