Customers

A customer is any company to which you sell goods and services. Sage Intacct applications use the customer information for record-keeping purposes, printing the names and addresses on forms, such as invoices, and for determining the ship-to contact so tax can be computed.

List customers

get/objects/accounts-receivable/customer

Returns a collection with a key, ID, and link for each customer. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionAccounts Receivable
User ypeBusiness
PermissionsList, View Customers
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "68",
      • "id": "CUST-100",
      • "href": "/objects/accounts-receivable/customer/68"
      },
    • {
      • "key": "69",
      • "id": "CUST-200",
      • "href": "/objects/accounts-receivable/customer/69"
      },
    • {
      • "key": "73",
      • "id": "CUST-300",
      • "href": "/objects/accounts-receivable/customer/73"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Create a customer
post/objects/accounts-receivable/customer
Creates a new customer.



Permissions and other requirements



SubscriptionAccounts Receivable


User ypeBusiness


PermissionsList, View, Add Customers







SecurityOAuth2 
Request 
Request Body schema: application/json
name
required
string
Name of the customer, which is usually the company name.


 
 Example:  "Gomez Manufacturers"
id
string
Unique identifier for the customer.


 
 Example:  "C-00003"
status
string
Status of the dimension object:


    

  • active - Transactions can be posted to this dimension member and it can be used in reports.
    • 

  • activeNonPosting - Transactions cannot be posted to the dimension member but it can be used in reports.
    • 

  • inactive - The dimension member cannot be used for transactions or reports.
    • 



 Enum: "active" "activeNonPosting" "inactive"  
 Example:  "active"
object
The category assigned to the customer (for example, Consultants, Subcontractors, or Equipment).


 
key
string
System-assigned key for the customer type.


 
 Example:  "1"
id
string
ID for the customer type.


 
 Example:  "Customer - Direct"
object
Parent customer, which creates a customer hierarchy.


 
key
string
System-assigned key for the parent customer.


 
 Example:  "10"
id
string
ID of the parent customer.


 
 Example:  "C-00014"
object
Name of the employee responsible for this customer account.


 
key
string
System-assigned key for the employee.


 
 Example:  "39"
id
string
ID of the employee.


 
 Example:  "awong"
taxId
string
Tax identification number for the customer.


 
 Example:  "12-3434900"
object
GL account for customer revenue.


 
key
string
System-assigned key for the GL account.


 
 Example:  "41"
id
string
ID of the GL account.


 
 Example:  "1001"
object
How goods are shipped to the customer.


 
key
string
System-assigned key for the shipping method.


 
 Example:  "3"
id
string
ID of the shipping method.


 
 Example:  "Fedex"
creditLimit
number
Credit limit extended to the customer.


 
 Example:  10000
isOnHold
boolean
 Default:  false
Indicates whether customer is on credit hold.


 
 Example:  true
object
Contacts for the customer.


 
object
Display contact for this customer.
Used as the default for other customer contacts, such as shipTo, that are not defined.


 
id
string
Contact ID


 
 Example:  "jsmith"
lastName
string
Last name


 
 Example:  "Smith"
firstName
string
First name


 
 Example:  "John"
middleName
string
Middle name


 
 Example:  "Archibald"
prefix
string
Prefix


 
 Example:  "Mr"
printAs
string
Print as


 
 Example:  "John Smith"
email1
string
Primary email


 
 Example:  "[email protected]"
email2
string
Secondary email


 
 Example:  "[email protected]"
phone1
string
Primary phone


 
 Example:  "14085551212"
phone2
string
Secondary phone


 
 Example:  "14085559876"
mobile
string
Mobile phone


 
 Example:  "14085554420"
pager
string
Pager


 
 Example:  "14085559987"
fax
string
Fax


 
 Example:  "14085555309"
URL1
string
Primary URL


 
 Example:  "https://mycompany.com"
URL2
string
Secondary URL


 
 Example:  "https://anothercompany.com"
companyName
string
Company name


 
 Example:  "AlcoSoft Inc"
object
Mailing Address


 
hideContactList
boolean
 Default:  false
Set to true to exclude from the company contact list.


 
 Example:  true
object
 
object
Primary contact for the customer.


 
key
string
System-assigned key for the contact.


 
 Example:  "87"
id
string
ID of the contact.


 
 Example:  "Ben Jones"
object
Customer contact for company activity such as sales transactions, invoice creation, and manual deposits.


 
key
string
System-assigned key for the contact.


 
 Example:  "63"
id
string
ID of the contact.


 
 Example:  "Rose Garcia"
object
Customer contact for company activity such as sales transactions, invoice creation, and tax calculations.


 
key
string
System-assigned key for the contact.


 
 Example:  "29"
id
string
ID of the contact.


 
 Example:  "Veronica Clark"
Array of objects
List of contacts for the customer.


 
 Array 
categoryName
string
User-defined category for grouping and sorting contacts.


 
 Example:  "Billing contact"
object
Contact to associate with the customer.


 
object
Customer that has the contactList where this contact appears.


 
object
 
restrictionType
string or null
 Default:  null
Restrict customers to only the top-level company or for specific locations and departments.
These restriction options are valid only for multi-entity companies that are configured for restrictions.
Learn more about restricting customers.
The following values specify who can view and post transactions against this customer.


Valid values:


    

  • unrestricted - The top level and all entities within the multi-entity structure.
    • 

  • rootOnly - Only the top level of the multi-entity structure.
    • 

  • restricted - Only the chosen locations, location groups, departments, or department groups within the multi-entity structure.
    • 



 Enum: null "restricted" "rootOnly" "unrestricted"  
 Example:  "restricted"
locations
Array of strings
Locations to which the customer can be restricted.


 
 Example:  ["Dallas","Santa Fe","Las Vegas"]
departments
Array of strings
Departments to which the customer can be restricted.


 
 Example:  ["Sales","RDA","BD"]
Array of objects
Email templates for the customer.


 
 Array 
object
Customer associated with the email template.


 
object
Transaction definition, which is the template that contains accounting settings, workflow rules, and other configuration settings for a transaction.


 
object
Associated email template.


 
discountPercent
string
Discount percentage for the customer.


 
 Example:  "10"
object
AR term for the customer, which are the rules for extending credit to the customer.


 
key
string
System-assigned key for the term.


 
 Example:  "20"
id
string
Name of the term.


 
 Example:  "Net 15"
advanceBillBy
string
Bill in advance setting, which instructs Sage Intacct to create billing schedules that automatically start before a contract line starts.


 
 Example:  "7"
advanceBillByType
string
Bill in advance type to indicate whether the advance value is number of days or months.


 Enum: "" "days" "months"  
 Example:  "days"
resaleNumber
number
Resale number, which applies to customers who are resellers of your company's products or services.


 
 Example:  1534
deliveryOptions
string
Delivery option for the customer's statements.


 Enum: "both" "email" "print"  
 Example:  "both"
overridePriceList
string
 Default:  "Customer"
By default, the customer price list is assigned to the entire customer, including the customer contacts. But, you can override the customer price list with the corresponding options for either the billing or shipping contact.


 Enum: "Billing contact" "Customer" "Shipping contact"  
 Example:  "Billing contact"
customerMessageId
string
ID of the default message to print on the customer's invoices.


 
 Example:  "StndMsg1"
currency
string
Currency for the customer.


 
 Example:  "CAD"
emailOptIn
boolean
 Default:  false
Indicates whether the customer accepts emailed invoices.


 
 Example:  true
object
The sales territory to which the customer is assigned.


 
key
string
Territory key.


 
 Example:  "6"
id
string
Territory ID.


 
 Example:  "NE"
name
string
Territory name.


 
 Example:  "Northeast"
enableOnlineACHPayment
boolean
 Default:  true
Set to true to enable automation of customer payments using ACH.


 
 Example:  true
enableOnlineCardPayment
boolean
 Default:  true
Set to true to automate customer payments using a credit card.


 
 Example:  true
isOneTimeUse
boolean
 Default:  false
Set to true to designate the customer as a one-time use customer that should not be included in standard look-up lists.


 
 Example:  false
object
Customer GL group to control the GL account that transactions with the customer should post to.


 
key
string
System-assigned key for the customer GL group.


 
 Example:  "41"
id
string
ID for the customer GL group.


 
 Example:  "Direct"
object
Label for the AR account associated with the customer.


 
key
string
System-assigned key for the AR account label.


 
 Example:  "38"
id
string
ID for the account label.


 
 Example:  "SW Sales"
object
Attachment that serves as a supporting document for the customer.


 
key
string
System-assigned key for the attachment.


 
 Example:  "51"
id
string
ID for the attachment.


 
 Example:  "123"
retainagePercentage
number
Default retainage percentage for the customer. Retainage must be enabled for a customer and a Construction subscription is required to enable this capability.


 
 Example:  25
notes
string
Notes or comments about the customer.


 
 Example:  "Service tier 1"
object
Price list associated with the customer.


 
key
string
System-assigned key for the price list.


 
 Example:  "7"
id
string
ID for the price list.


 
 Example:  "Base Price List"
object
Price schedule associated with the customer.


 
key
string
System-assigned key for the price schedule.


 
 Example:  "4"
id
string
ID for the price schedule.


 
 Example:  "PREF"
object
Default AR override offset account for this customer.


 
key
string
System-assigned key for the GL account.


 
 Example:  "12"
id
string
ID for the GL account.


 
 Example:  "134"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "CUST-002",
  • "name": "Starluck",
  • "taxId": "12-3456789",
  • "creditLimit": 50000,
  • "status": "active"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "32",
    • "id": "CUST-200",
    • "href": "/objects/accounts-receivable/customer/32"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a customer
get/objects/accounts-receivable/customer/{key}
Returns detailed information for a specified customer.



Permissions and other requirements



SubscriptionAccounts Receivable


User ypeBusiness


PermissionsList, View Customers







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the customer.


 
 Example:  81
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "PAMats",
    • "name": "Power Aerospace Materials",
    • "parent": {
      • "key": "2055",
      • "id": "12",
      • "name": "12",
      • "href": "/objects/accounts-receivable/customer/2055"
      },
    • "contacts": {
      • "default": {
        },
      • "primary": {
        },
      • "shipTo": {
        },
      • "billTo": {
        }
      },
    • "term": {
      • "id": "15DaysExtToEOM",
      • "key": "26",
      • "href": "/objects/accounts-receivable/term/26"
      },
    • "salesRepresentative": {
      • "id": "EM M",
      • "name": "Aaron",
      • "key": "89",
      • "href": "/objects/company-config/employee/89"
      },
    • "resaleNumber": 123456789,
    • "taxId": "123456803",
    • "creditLimit": 20000,
    • "totalDue": "99999.99",
    • "notes": "Sample Notes",
    • "accountLabel": {
      • "id": "Pledges",
      • "key": "9"
      },
    • "defaultRevenueGLAccount": {
      • "id": "2080.06",
      • "name": "Germany(France) - Inter Entity Payable",
      • "key": "136",
      • "href": "/objects/general-ledger/account/136"
      },
    • "lastInvoiceCreatedDate": "2021-10-12",
    • "lastStatementGeneratedDate": "2023-02-28",
    • "deliveryOptions": "print",
    • "territory": {
      • "id": "23456",
      • "name": "North East",
      • "key": "23456"
      },
    • "shippingMethod": {
      • "id": "Fedex",
      • "key": "3",
      • "href": "/objects/accounts-receivable/shipping-method/3"
      },
    • "customerType": {
      • "id": "DOCS",
      • "key": "13",
      • "href": "/objects/accounts-receivable/customer-type/13"
      },
    • "accountGroup": {
      • "key": "10",
      • "id": "Auto CGL Group",
      • "href": "/objects/accounts-receivable/customer-account-group/10"
      },
    • "priceSchedule": {
      • "id": "101",
      • "key": "101",
      • "href": "/objects/purchasing/price-schedule/101"
      },
    • "discountPercent": "10",
    • "priceList": {
      • "id": "Base Price List",
      • "key": "1",
      • "href": "/objects/order-entry/price-list/1"
      },
    • "currency": "USD",
    • "status": "active",
    • "isOneTimeUse": false,
    • "customerMessageId": "test abhi",
    • "isOnHold": false,
    • "overridePriceList": "Customer",
    • "enableOnlineCardPayment": true,
    • "enableOnlineACHPayment": true,
    • "audit": {
      • "modifiedDateTime": "2023-12-14T11:31:06Z",
      • "createdDateTime": "2018-07-28T19:22:31Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "restrictions": {
      • "restrictionType": "restricted",
      • "locations": [
        ],
      • "departments": [
        ]
      },
    • "overrideOffsetGLAccount": {
      • "id": "1120",
      • "name": "Pledges Receivable"
      },
    • "emailOptIn": false,
    • "contactList": [
      • {
        }
      ],
    • "customerEmailTemplates": [
      • {
        }
      ],
    • "href": "/objects/accounts-receivable/customer/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a customer
patch/objects/accounts-receivable/customer/{key}
Updates an existing customer by setting field values. Any fields not provided remain unchanged. Customers included in posted transactions will not be updated. Only new transactions and records will refer to the updated customer information.



Permissions and other requirements



SubscriptionAccounts Receivable


User ypeBusiness


PermissionsList, View, Edit Customers







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the customer.


 
 Example:  81
Request Body schema: application/json
name
string
Name of the customer, which is usually the company name.


 
 Example:  "Gomez Manufacturers"
status
string
Status of the dimension object:


    

  • active - Transactions can be posted to this dimension member and it can be used in reports.
    • 

  • activeNonPosting - Transactions cannot be posted to the dimension member but it can be used in reports.
    • 

  • inactive - The dimension member cannot be used for transactions or reports.
    • 



 Enum: "active" "activeNonPosting" "inactive"  
 Example:  "active"
object
The category assigned to the customer (for example, Consultants, Subcontractors, or Equipment).


 
key
string
System-assigned key for the customer type.


 
 Example:  "1"
id
string
ID for the customer type.


 
 Example:  "Customer - Direct"
object
Parent customer, which creates a customer hierarchy.


 
key
string
System-assigned key for the parent customer.


 
 Example:  "10"
id
string
ID of the parent customer.


 
 Example:  "C-00014"
object
Name of the employee responsible for this customer account.


 
key
string
System-assigned key for the employee.


 
 Example:  "39"
id
string
ID of the employee.


 
 Example:  "awong"
taxId
string
Tax identification number for the customer.


 
 Example:  "12-3434900"
object
GL account for customer revenue.


 
key
string
System-assigned key for the GL account.


 
 Example:  "41"
id
string
ID of the GL account.


 
 Example:  "1001"
object
How goods are shipped to the customer.


 
key
string
System-assigned key for the shipping method.


 
 Example:  "3"
id
string
ID of the shipping method.


 
 Example:  "Fedex"
creditLimit
number
Credit limit extended to the customer.


 
 Example:  10000
isOnHold
boolean
 Default:  false
Indicates whether customer is on credit hold.


 
 Example:  true
object
Contacts for the customer.


 
object
Display contact for this customer.
Used as the default for other customer contacts, such as shipTo, that are not defined.


 
id
string
Contact ID


 
 Example:  "jsmith"
lastName
string
Last name


 
 Example:  "Smith"
firstName
string
First name


 
 Example:  "John"
middleName
string
Middle name


 
 Example:  "Archibald"
prefix
string
Prefix


 
 Example:  "Mr"
printAs
string
Print as


 
 Example:  "John Smith"
email1
string
Primary email


 
 Example:  "[email protected]"
email2
string
Secondary email


 
 Example:  "[email protected]"
phone1
string
Primary phone


 
 Example:  "14085551212"
phone2
string
Secondary phone


 
 Example:  "14085559876"
mobile
string
Mobile phone


 
 Example:  "14085554420"
pager
string
Pager


 
 Example:  "14085559987"
fax
string
Fax


 
 Example:  "14085555309"
URL1
string
Primary URL


 
 Example:  "https://mycompany.com"
URL2
string
Secondary URL


 
 Example:  "https://anothercompany.com"
companyName
string
Company name


 
 Example:  "AlcoSoft Inc"
object
Mailing Address


 
hideContactList
boolean
 Default:  false
Set to true to exclude from the company contact list.


 
 Example:  true
object
 
object
Primary contact for the customer.


 
key
string
System-assigned key for the contact.


 
 Example:  "87"
id
string
ID of the contact.


 
 Example:  "Ben Jones"
object
Customer contact for company activity such as sales transactions, invoice creation, and manual deposits.


 
key
string
System-assigned key for the contact.


 
 Example:  "63"
id
string
ID of the contact.


 
 Example:  "Rose Garcia"
object
Customer contact for company activity such as sales transactions, invoice creation, and tax calculations.


 
key
string
System-assigned key for the contact.


 
 Example:  "29"
id
string
ID of the contact.


 
 Example:  "Veronica Clark"
Array of objects
List of contacts for the customer.


 
 Array 
categoryName
string
User-defined category for grouping and sorting contacts.


 
 Example:  "Billing contact"
object
Contact to associate with the customer.


 
object
Customer that has the contactList where this contact appears.


 
object
 
restrictionType
string or null
 Default:  null
Restrict customers to only the top-level company or for specific locations and departments.
These restriction options are valid only for multi-entity companies that are configured for restrictions.
Learn more about restricting customers.
The following values specify who can view and post transactions against this customer.


Valid values:


    

  • unrestricted - The top level and all entities within the multi-entity structure.
    • 

  • rootOnly - Only the top level of the multi-entity structure.
    • 

  • restricted - Only the chosen locations, location groups, departments, or department groups within the multi-entity structure.
    • 



 Enum: null "restricted" "rootOnly" "unrestricted"  
 Example:  "restricted"
locations
Array of strings
Locations to which the customer can be restricted.


 
 Example:  ["Dallas","Santa Fe","Las Vegas"]
departments
Array of strings
Departments to which the customer can be restricted.


 
 Example:  ["Sales","RDA","BD"]
Array of objects
Email templates for the customer.


 
 Array 
object
Customer associated with the email template.


 
object
Transaction definition, which is the template that contains accounting settings, workflow rules, and other configuration settings for a transaction.


 
object
Associated email template.


 
discountPercent
string
Discount percentage for the customer.


 
 Example:  "10"
object
AR term for the customer, which are the rules for extending credit to the customer.


 
key
string
System-assigned key for the term.


 
 Example:  "20"
id
string
Name of the term.


 
 Example:  "Net 15"
advanceBillBy
string
Bill in advance setting, which instructs Sage Intacct to create billing schedules that automatically start before a contract line starts.


 
 Example:  "7"
advanceBillByType
string
Bill in advance type to indicate whether the advance value is number of days or months.


 Enum: "" "days" "months"  
 Example:  "days"
resaleNumber
number
Resale number, which applies to customers who are resellers of your company's products or services.


 
 Example:  1534
deliveryOptions
string
Delivery option for the customer's statements.


 Enum: "both" "email" "print"  
 Example:  "both"
overridePriceList
string
 Default:  "Customer"
By default, the customer price list is assigned to the entire customer, including the customer contacts. But, you can override the customer price list with the corresponding options for either the billing or shipping contact.


 Enum: "Billing contact" "Customer" "Shipping contact"  
 Example:  "Billing contact"
customerMessageId
string
ID of the default message to print on the customer's invoices.


 
 Example:  "StndMsg1"
currency
string
Currency for the customer.


 
 Example:  "CAD"
emailOptIn
boolean
 Default:  false
Indicates whether the customer accepts emailed invoices.


 
 Example:  true
object
The sales territory to which the customer is assigned.


 
key
string
Territory key.


 
 Example:  "6"
id
string
Territory ID.


 
 Example:  "NE"
name
string
Territory name.


 
 Example:  "Northeast"
enableOnlineACHPayment
boolean
 Default:  true
Set to true to enable automation of customer payments using ACH.


 
 Example:  true
enableOnlineCardPayment
boolean
 Default:  true
Set to true to automate customer payments using a credit card.


 
 Example:  true
isOneTimeUse
boolean
 Default:  false
Set to true to designate the customer as a one-time use customer that should not be included in standard look-up lists.


 
 Example:  false
object
Customer GL group to control the GL account that transactions with the customer should post to.


 
key
string
System-assigned key for the customer GL group.


 
 Example:  "41"
id
string
ID for the customer GL group.


 
 Example:  "Direct"
object
Label for the AR account associated with the customer.


 
key
string
System-assigned key for the AR account label.


 
 Example:  "38"
id
string
ID for the account label.


 
 Example:  "SW Sales"
object
Attachment that serves as a supporting document for the customer.


 
key
string
System-assigned key for the attachment.


 
 Example:  "51"
id
string
ID for the attachment.


 
 Example:  "123"
retainagePercentage
number
Default retainage percentage for the customer. Retainage must be enabled for a customer and a Construction subscription is required to enable this capability.


 
 Example:  25
notes
string
Notes or comments about the customer.


 
 Example:  "Service tier 1"
object
Price list associated with the customer.


 
key
string
System-assigned key for the price list.


 
 Example:  "7"
id
string
ID for the price list.


 
 Example:  "Base Price List"
object
Price schedule associated with the customer.


 
key
string
System-assigned key for the price schedule.


 
 Example:  "4"
id
string
ID for the price schedule.


 
 Example:  "PREF"
object
Default AR override offset account for this customer.


 
key
string
System-assigned key for the GL account.


 
 Example:  "12"
id
string
ID for the GL account.


 
 Example:  "134"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "creditLimit": 10000
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "34",
    • "id": "CUST-100",
    • "href": "/objects/accounts-receivable/payment/34"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a customer
delete/objects/accounts-receivable/customer/{key}
Deletes a customer. Customers that have already been used in a transaction cannot be deleted. Instead, you can update customers that have already been used to make them inactive.



Permissions and other requirements



SubscriptionAccounts Receivable


User ypeBusiness


PermissionsList, View, Delete Customers







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the customer.


 
 Example:  81
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::error": {
    • "code": "invalidRequest",
    • "message": "Malformed URL",
    • "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
    • "details": [
      • {
        }
      ]
    }
}
Query customers
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "accounts-receivable/customer"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-receivable/customer",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "name",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "14",
      • "id": "C-00003",
      • "name": "Burns Textiles Corp of America",
      • "href": "/objects/accounts-receivable/customer/14"
      },
    • {
      • "key": "4",
      • "id": "C-00004",
      • "name": "Pinto Construction Inc.",
      • "href": "/objects/accounts-receivable/customer/4"
      },
    • {
      • "key": "5",
      • "id": "C-00005",
      • "name": "Dickenson plc",
      • "href": "/objects/accounts-receivable/customer/5"
      },
    • {
      • "key": "6",
      • "id": "C-00006",
      • "name": "Grand Isle Hotels & Resorts Ltd",
      • "href": "/objects/accounts-receivable/customer/6"
      },
    • {
      • "key": "8",
      • "id": "C-00012",
      • "name": "University of Midland",
      • "href": "/objects/accounts-receivable/customer/8"
      },
    • {
      • "key": "9",
      • "id": "C-00013",
      • "name": "Copper Head Oil & Gas Corp.",
      • "href": "/objects/accounts-receivable/customer/9"
      },
    • {
      • "key": "10",
      • "id": "C-00014",
      • "name": "Copper Head Oil & Gas, UK",
      • "href": "/objects/accounts-receivable/customer/10"
      }
    ],
  • "ia::meta": {
    • "totalCount": 7,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}