FreshBooks - Get clients

Important: This connector and its actions have been removed from Nintex Workflow and can now be found in Nintex Gallery.

Use the FreshBooks - Get clients action A tool for building the processes, logic, and direction within workflows. Actions are the steps the workflow performs to complete a process. to retrieve a list of clients from FreshBooks.

For more information about FreshBooks, go to FreshBooks.

Before you begin: 

Jump to:

Configure the FreshBooks - Get clients action

  1. Add the action to the workflow and open the action configuration panel. For more information, see Add an action to the workflow.

  1. Select a Connection. If you do not have a connection, see Add a connection.
  1. Select the Account role.

  2. Specify paging options if needed.

  3. Create or select a variable for the output.

For more information on all the required and optional configuration fields, go to FreshBooks - Get clients action fields and settings.

FreshBooks - Get clients action fields and settings

Section

Field

Description

Variable types

(Unlabeled)

Connection Credentials and other settings that enables workflows to communicate with external systems, services, or applications. It's required to pass data between the workflow and the indicated service, which could be a cloud service, business application, or content store.

The FreshBooks connection to use to retrieve a list of clients.

To refresh the available connections, click .

(n/a)
  Account role Accounting system identifier. Text, Decimal, Integer, Boolean, DateTime, Collection
  Page The page number of results to return. Used with Items per page. The Page, Pages, and Total values from a previous Get clients action can be used for paging logic. Text, Decimal, Integer, Boolean, DateTime, Collection
  Items per page The number of clients to retrieve per page. Used with Page. Text, Decimal, Integer, Boolean, DateTime, Collection
Output Client

Stores the result of the action as an object. See FreshBooks - Client API for information on these values.

The following values are returned:

  • Response: (Object)
    • Result: (Object)
      • Clients: (Collection)
        • ID: (Text)
        • Email address: (Text)
        • Accounting system ID: (Text)
        • Allow late fees: (Boolean)
        • Allow late notifications: (Boolean)
        • Business phone number: (Text)
        • Company industry: (Text)
        • Company size: (Integer)
        • Currency code: (Text)
        • Fax number: (Text)
        • Full name: (Text)
        • Last name: (Text)
        • Has retainer: (Text)
        • Home phone: (Text)
        • Language: (Text)
        • Last client activity action: (Text)
        • Last login time: (Text)
        • Level: (Integer)
        • Mobile phone: (Text)
        • Note: (Text)
        • Notified: (Boolean)
        • Number of logins: (Integer)
        • Organization: (Text)
        • Billing city: (Text)
        • Billing code: (Text)
        • Billing country: (Text)
        • Billing province: (Text)
        • Billing address line 1: (Text)
        • Billing address line 2: (Text)
        • Prefer email address: (Boolean)
        • Prefer ground mail address: (Boolean)
        • Retainer ID: (Text)
        • Role: (Text)
        • Shipping city: (Text)
        • Shipping code: (Text)
        • Shipping country: (Text)
        • Shipping province: (Text)
        • Shipping address line 1: (Text)
        • Shipping address line 2: (Text)
        • Sign up date: (Date)
        • Statement token: (Text)
        • Subdomain: (Text)
        • Update: (Date)
        • User ID: (Integer)
        • Username: (Text)
        • Tax name: (Text)
        • Tax number: (Text)
        • Visibility state: (Integer)
      • Page: (Integer)
      • Pages: (Integer)
      • Per page: (Integer)
      • Total: (Integer)
 Object