Pick the Get Accounts Receivable Customer Key action (under Sage Intacct).
Fill in the fields below, then reference the result from later steps as {{getAccountsReceivableCustomerKey.response.data}}.
Request
Path parameters
keystringrequired
System-assigned key for the customer.
Response
Returns 200 with an object. Read it in later steps with {{getAccountsReceivableCustomerKey.response.data.<field>}}.
ia::resultobject
A customer is any company to which you sell goods and services.
keystring
System-assigned key for the customer.
idstring
Unique identifier for the customer.
namestring
Name of the customer, which is usually the company name.
hrefstring
URL for the customer.
statusstring
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.
One ofnullactiveactiveNonPostinginactiveDefault "active"
customerTypeobject3 fields
The category assigned to the customer (for example, Consultants, Subcontractors, or Equipment).
parentobject4 fields
Parent customer, which creates a customer hierarchy.
salesRepresentativeobject4 fields
Name of the employee responsible for this customer account.
taxIdstring
Tax identification number for the customer.
electronicAddressstring
Electronic address is used for E-invoicing. This field is required for customers in France to comply with local E-invoicing regulations.
defaultRevenueGLAccountobject4 fields
GL account for customer revenue.
shippingMethodobject3 fields
How goods are shipped to the customer.
creditLimitnumber
Credit limit extended to the customer.
isOnHoldboolean
Indicates whether customer is on credit hold.
Default false
contactsobject4 fields
Contacts for the customer.
contactListarray<object>7 fields
List of contacts for the customer.
auditobject6 fields
restrictionsobject1 fields
customerEmailTemplatesarray<object>7 fields
Email templates for the customer.
discountPercentstring
Discount percentage for the customer.
termobject3 fields
AR term for the customer, which are the rules for extending credit to the customer.
advanceBillBystring
Bill in advance setting, which instructs Sage Intacct to create billing schedules that automatically start before a contract line starts.
advanceBillByTypestring
Bill in advance type to indicate whether the advance value is number of days or months.
One ofdaysmonths
totalDuestring (decimal-precision-2)
Total amount currently due from the customer.
lastInvoiceCreatedDatestring (date)
Date the most recent invoice was created.
lastStatementGeneratedDatestring (date)
Date the most recent statement was generated.
resaleNumbernumber
This field has been deprecated. Use the customerResaleNumber field instead.
customerResaleNumberstring
Resale number, which applies to customers who are resellers of your company's products or services.
deliveryOptionsstring
Delivery option for the customer's statements.
One ofprintemailbothDefault "print"
overridePriceListstring
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.
One ofcustomerbillingContactshippingContactDefault "customer"
customerMessageobject4 fields
Message to include on the customer's invoice.
currencystring
Currency for the customer.
emailOptInboolean
Indicates whether the customer accepts emailed invoices.
Default false
activationDatestring (date)
Monthly recurring revenue activation date.
subscriptionEndDatestring (date)
Monthly recurring revenue end date.
territoryobject4 fields
The sales territory to which the customer is assigned.
enableOnlineACHPaymentboolean
Set to `true` to enable automation of customer payments using ACH.
Default true
enableOnlineCardPaymentboolean
Set to `true` to automate customer payments using a credit card.
Default true
isOneTimeUseboolean
Set to `true` to designate the customer as a one-time use customer that should not be included in standard look-up lists.
Default false
disableRefundboolean
Set to `true` to disable refunds for the customer.
Default false
ia::metaobject
Metadata for the response.
totalCountinteger
Total count.
totalSuccessinteger
Total success.
totalErrorinteger
Total errors.
json
{"ia::result":{"key":"24","id":"C-00003","name":"Gomez Manufacturers","href":"/objects/accounts-receivable/customer/24","status":"active","customerType":{"key":"1","id":"Customer - Direct","href":"/objects/accounts-receivable/customer-type/1"},"parent":{"key":"10","id":"C-00014","name":"Pan American Global Partners","href":"/objects/accounts-receivable/customer/10"},"salesRepresentative":{"key":"39","id":"awong","name":"Anna Wong","href":"/objects/company-config/employee/39"},"taxId":"12-3434900","electronicAddress":"123456789-Emp_001-Dept_001","defaultRevenueGLAccount":{"key":"41","id":"1001","name":"Sterling Bank Operating","href":"/objects/general-ledger/account/41"},"shippingMethod":{"key":"3","id":"Fedex","href":"/objects/accounts-receivable/shipping-method/3"}},"ia::meta":{"totalCount":3,"totalSuccess":2,"totalError":1}}
Need more? See the Sage Intacct guide for connection setup and behaviour shared by every action.
