List Customers

get

https://secure.fusebill.com/v1/Customers/

This function is used to retrieve a list of customer objects.

In order to manage the size of the data returned it is strongly recommended that pagination is used.

More information:

Currencies
NetsuiteEntityType is 1 for “Customer – Individual” and 2 for “Customer – Company”.
This call supports Pagination. Example: &pageSize=100&pageNumber=0.
This call supports Sorting. Use &sortOrder=Ascending or &sortOrder=Descending with &sortExpression=expression.

Customer query string parameters

This call supports String Filtering and DateTime/Numeric Filtering.

Query Params

query

string

This call supports String Filtering and DateTime/Numeric Filtering.

id

int32

Customer ID, also called Stax Bill ID on customers in the Admin UI.

reference

string

Customer Reference. This field can be renamed by an administrator in the Admin UI. Defaults as Customer ID in the Admin UI.

parentId

int32

Customer ID of a parent customer. Used in a query to list all children of a customer.

companyName

string

Customers with company name that contains this value.

firstName

string

enum

Customers with first name that contains this value.

Allowed:

lastName

string

enum

Customers with last name that contains this value.

Allowed:

primaryEmail

string

Contact email address. Use to find a customer based on communication target.

salesforceId

string

Salesforce customer account ID. Use to find which Stax Bill customer or customers are linked to a specific Salesforce account.

QuickBooks ID

string

Find customers in Stax Bill linked to a specific QuickBooks Online customer.

secondaryEmail

string

Contact secondary email address. Used as reference-only on customers and not for sending messages.

primaryPhone

string

Contact primary phone number. Used for text message notifications.

secondaryPhone

string

Contact secondary phone. Reference only; use primary phone for text message notifications.

customerReference.reference1

string

Reference field. Can be renamed in the Admin UI.

customerReference.reference2

string

Reference field. Can be renamed in the Admin UI.

customerReference.reference3

string

Reference field. Can be renamed in the Admin UI.

customerAcquisition.adContent

string

Reference field. Can be renamed in the Admin UI.

customerAcquisition.campaign

string

Reference field. Can be renamed in the Admin UI.

customerAcquisition.keyword

string

Reference field. Can be renamed in the Admin UI.

customerAcquisition.landingPage

string

Reference field. Can be renamed in the Admin UI.

customerAcquisition.medium

string

Reference field. Can be renamed in the Admin UI.

customerAcquisition.source

string

Reference field. Can be renamed in the Admin UI.

customerBillingSetting.term

array of strings

Customers with a specific default due date. Values include Net, MFI1, and DayOfMonth. Net is the number of days after invoice generated. MFI1 is the first day of the month following invoice. DayOfMonth is a specific day of the month, closest after invoice posted.

customerBillingSetting.term

Allowed:

status

array of integers

Customer status. Takes a list of numbers representing customer statuses. Draft: 1. Active: 2. Cancelled: 3. Hold: 4. Suspended: 5. Admin UI examples: All is blank; Current is 2,4,5; Active is 2; Draft is 1; Cancelled is 3; Hold is 4; Suspended is 5.

status

Allowed:

accountStatus

array of strings

Customer accounting status. Good means no overdue invoices. PoorStanding means the customer has any invoices with status=Overdue. Collection means the customer has been manually flagged as collection.

accountStatus

Allowed:

failedInBilling

integer

enum

Use the value 12 to surface all customers that are running into issues in Billing.

Allowed:

SalesTrackingCode1Code

string

Sales tracking code. Admin UI name and possible values are set in the Admin UI.

SalesTrackingCode2Code

string

Sales tracking code. Admin UI name and possible values are set in the Admin UI.

SalesTrackingCode3Code

string

Sales tracking code. Admin UI name and possible values are set in the Admin UI.

SalesTrackingCode4Code

string

Sales tracking code. Admin UI name and possible values are set in the Admin UI.

SalesTrackingCode5Code

string

Sales tracking code. Admin UI name and possible values are set in the Admin UI.

pageSize

int32

This call supports Pagination. Example: &pageSize=100&pageNumber=0.

pageNumber

int32

This call supports Pagination. Example: &pageSize=100&pageNumber=0.

MaxCount

int32

Maximum number of results. Limits search significantly for accounts with many results.

SortExpression

string

This call supports Sorting. Example: &sortExpression=expression.

SortOrder

string

enum

This call supports Sorting. Use Ascending or Descending.

Allowed:

QuickSearch

string

Vague search across common fields: Company Name, First Name, Last Name, Primary Email, Customer Reference, and Customer (Stax Bill) ID.

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json