Contacts

Contacts serve as a common, shared address book that's used across a company by many people for a variety of purposes. Contacts hold all the information needed to contact an individual or business, including name, email address, phone number, mailing address, and more.

Contacts are almost always used with other Sage Intacct objects, such as vendors, customers, or locations. For example, you specify a contact in Order Entry and Purchasing transactions to set a ship-to, bill-to, pay-to, or return-to addresses, and to determine tax on transactions.

List contacts

get/objects/company-config/contact

Returns up to 100 contacts from the collection with a key, ID, and link for each contact. This operation is mostly for use in testing; use the query service to find contacts that meet certain criteria and specify the properties that are returned.

Permissions and other requirements
SubscriptionCompany
User typeBusiness, Employee, Payment Approver
PermissionsList, View Contacts
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "265",
      • "id": "Larry Spencer",
      • "href": "/objects/company-config/contact/265"
      },
    • {
      • "key": "263",
      • "id": "John Doe",
      • "href": "/objects/company-config/contact/263"
      },
    • {
      • "key": "264",
      • "id": "Alfred Mike",
      • "href": "/objects/company-config/contact/264"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a contact
post/objects/company-config/contact
Creates a new contact. The contact's entity fields will be set to the entity that the OAuth access token is associated with when the contact is created.



Permissions and other requirements



SubscriptionCompany


User typeBusiness user with admin privileges


PermissionsAdd Contacts







SecurityOAuth2 
Request 
Request Body schema: application/json
required
Contact object to create


id
required
string
Unique identifier for the contact.


 
 Example:  "rkincaid"
printAs
required
string
The contact's name as it will appear on bills, invoices, AR statements, advances, adjustments, checks, expense reports, expense reimbursements, and 1099s.


 
 Example:  "Reuben Kincaid"
lastName
string or null
Last name.


 
 Example:  "Kincaid"
firstName
string or null
First name.


 
 Example:  "Reuben"
middleName
string or null
Middle name or initial.


 
 Example:  "X"
prefix
string or null
Prefix, such as Mr., Mrs., or Ms.


 
 Example:  "Mr."
email1
string or null
Primary email address.


 
 Example:  "[email protected]"
email2
string or null
Secondary email address.


 
 Example:  "[email protected]"
phone1
string or null
Primary phone number.


 
 Example:  "4151231234"
phone2
string or null
Secondary phone number.


 
 Example:  "4158661823"
mobile
string or null
Mobile phone number.


 
 Example:  "4159879876"
pager
string or null
Pager number.


 
 Example:  "4151112222"
fax
string or null
Fax number.


 
 Example:  "4152221111"
URL1
string or null
Web page address for this contact.


 
 Example:  "https://mycompany.com"
URL2
string or null
Secondary web page address.


 
 Example:  "https://whitehouse.gov"
companyName
string or null
Name of the company associated with this contact.


 
 Example:  "AlcoSoft Inc"
showInContactList
boolean
 Default:  true
Set to true to display the contact in the contact list.


 
 Example:  true
discount
string or null
Default discount percentage to be applied to order entry transactions involving this contact.


 
 Example:  "33"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
object
The mailing address of the contact.


 
addressLine1
string or null
The first address line for shipping, billing, etc.


 
 Example:  "300 Park Avenue"
addressLine2
string or null
The second address line for shipping, billing, etc.


 
 Example:  "Suite 1400"
addressLine3
string or null
The third address line for shipping, billing, etc. which provides additional geographical information.


 
 Example:  "Western industrial area"
city
string or null
City.


 
 Example:  "San Jose"
state
string or null
State.


 
 Example:  "California"
postCode
string or null
Zip or Postal Code.


 
 Example:  "95110"
country
string or null
 Deprecated 
 Default:  "United States"
Country. This field is deprecated, please use isoCountryCode.


 
 Example:  "United States"
isoCountryCode
string or null
 Default:  "US"
ISO country code. This field takes prevalence over country which is now deprecated.


 
 Example:  "US"
object
Default price list used in order entry when this contact places orders. Read the notes in the Help Center for requirements and additional information.


 
key
string or null
Price list key.


 
 Example:  "7"
id
string or null
Price list ID.


 
 Example:  "Custom-Pricelist"
object
Price schedule used in order entry when this contact places orders.


 
key
string or null
Price schedule key.


 
 Example:  "7"
id
string or null
Price schedule ID.


 
 Example:  "Discount-Premium"
object
Tax settings needed for Intacct to calculate taxes on transactions for this contact.


 
isTaxable
boolean
 Default:  true
Set to true to enable tax calculation.


 
 Example:  true
taxId
string or null
State tax ID or VAT registration number for this contact.


 
 Example:  "US2333"
object
The contact tax group to be used with this contact.


 
key
string or null
Contact tax group key.


 
 Example:  "7"
id
string or null
Contact tax group ID.


 
 Example:  "Taxes-for-residents"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "AMoore",
  • "prefix": "Mr",
  • "firstName": "Andy",
  • "lastName": "Moore",
  • "middleName": "Robert",
  • "printAs": "Andy Moore",
  • "companyName": "Sage",
  • "phone1": "9134598676",
  • "mobile": "9133132299",
  • "fax": "9134598677",
  • "email1": "[email protected]",
  • "URL1": "http://andy.exampledomain.com",
  • "mailingAddress": {
    • "addressLine1": "744 Edgewater Blvd",
    • "city": "Kansas City",
    • "state": "KS",
    • "postCode": "66104",
    • "country": "United States"
    },
  • "tax": {
    • "isTaxable": true,
    • "taxId": "123-12-1234",
    • "group": {
      • "id": "New York"
      }
    },
  • "status": "active"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "312",
    • "id": "AMoore",
    • "href": "/objects/company-config/contact/312"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a contact
get/objects/company-config/contact/{key}
Returns detailed information for a specified contact.



Permissions and other requirements



SubscriptionCompany


User typeBusiness, Employee, Payment Approver


PermissionsList, View Contacts







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for a contact.


 
 Example:  65
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1257",
    • "id": "AMoore",
    • "companyName": "Sage",
    • "prefix": "Mr",
    • "firstName": "Andy",
    • "lastName": "Moore",
    • "middleName": "Robert",
    • "printAs": "Andy Moore",
    • "tax": {
      • "isTaxable": true,
      • "group": {
        },
      • "taxId": "123-12-1234"
      },
    • "phone1": "9134598676",
    • "phone2": null,
    • "mobile": "9133132299",
    • "pager": null,
    • "fax": "9134598677",
    • "email1": "[email protected]",
    • "email2": null,
    • "URL1": "http://andy.exampledomain.com",
    • "URL2": null,
    • "showInContactList": true,
    • "mailingAddress": {
      • "addressLine1": "744 Edgewater Blvd",
      • "addressLine2": null,
      • "addressLine3": null,
      • "city": "Kansas City",
      • "country": "United States",
      • "isoCountryCode": "US",
      • "postCode": "66104",
      • "state": "KS"
      },
    • "status": "active",
    • "priceSchedule": {
      • "id": null,
      • "key": null
      },
    • "discount": null,
    • "priceList": {
      • "id": null,
      • "key": null
      },
    • "entity": {
      • "key": "54",
      • "id": "Western Region",
      • "name": "Western Region",
      • "href": "/objects/company-config/entity/54"
      },
    • "href": "/objects/company-config/contact/1257"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a contact
patch/objects/company-config/contact/{key}
Updates an existing contact by setting field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionCompany


User typeBusiness user with admin privileges


PermissionsEdit Contacts







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for a contact.


 
 Example:  65
Request Body schema: application/json
lastName
string or null
Last name.


 
 Example:  "Kincaid"
firstName
string or null
First name.


 
 Example:  "Reuben"
middleName
string or null
Middle name or initial.


 
 Example:  "X"
prefix
string or null
Prefix, such as Mr., Mrs., or Ms.


 
 Example:  "Mr."
email1
string or null
Primary email address.


 
 Example:  "[email protected]"
email2
string or null
Secondary email address.


 
 Example:  "[email protected]"
phone1
string or null
Primary phone number.


 
 Example:  "4151231234"
phone2
string or null
Secondary phone number.


 
 Example:  "4158661823"
mobile
string or null
Mobile phone number.


 
 Example:  "4159879876"
pager
string or null
Pager number.


 
 Example:  "4151112222"
fax
string or null
Fax number.


 
 Example:  "4152221111"
URL1
string or null
Web page address for this contact.


 
 Example:  "https://mycompany.com"
URL2
string or null
Secondary web page address.


 
 Example:  "https://whitehouse.gov"
companyName
string or null
Name of the company associated with this contact.


 
 Example:  "AlcoSoft Inc"
printAs
string
The contact's name as it will appear on bills, invoices, AR statements, advances, adjustments, checks, expense reports, expense reimbursements, and 1099s.


 
 Example:  "Reuben Kincaid"
showInContactList
boolean
 Default:  true
Set to true to display the contact in the contact list.


 
 Example:  true
discount
string or null
Default discount percentage to be applied to order entry transactions involving this contact.


 
 Example:  "33"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
object
The mailing address of the contact.


 
addressLine1
string or null
The first address line for shipping, billing, etc.


 
 Example:  "300 Park Avenue"
addressLine2
string or null
The second address line for shipping, billing, etc.


 
 Example:  "Suite 1400"
addressLine3
string or null
The third address line for shipping, billing, etc. which provides additional geographical information.


 
 Example:  "Western industrial area"
city
string or null
City.


 
 Example:  "San Jose"
state
string or null
State.


 
 Example:  "California"
postCode
string or null
Zip or Postal Code.


 
 Example:  "95110"
country
string or null
 Deprecated 
 Default:  "United States"
Country. This field is deprecated, please use isoCountryCode.


 
 Example:  "United States"
isoCountryCode
string or null
 Default:  "US"
ISO country code. This field takes prevalence over country which is now deprecated.


 
 Example:  "US"
object
Default price list used in order entry when this contact places orders. Read the notes in the Help Center for requirements and additional information.


 
key
string or null
Price list key.


 
 Example:  "7"
id
string or null
Price list ID.


 
 Example:  "Custom-Pricelist"
object
Price schedule used in order entry when this contact places orders.


 
key
string or null
Price schedule key.


 
 Example:  "7"
id
string or null
Price schedule ID.


 
 Example:  "Discount-Premium"
object
Tax settings needed for Intacct to calculate taxes on transactions for this contact.


 
isTaxable
boolean
 Default:  true
Set to true to enable tax calculation.


 
 Example:  true
taxId
string or null
State tax ID or VAT registration number for this contact.


 
 Example:  "US2333"
object
The contact tax group to be used with this contact.


 
key
string or null
Contact tax group key.


 
 Example:  "7"
id
string or null
Contact tax group ID.


 
 Example:  "Taxes-for-residents"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "priceList": {
    • "id": "Best customer pricing"
    },
  • "tax": {
    • "isTaxable": false
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "312",
    • "id": "JohnD",
    • "href": "/objects/company-config/contact/312"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a contact
delete/objects/company-config/contact/{key}
Deletes a contact. You can delete a contact if it is not being used or referenced. Deleted contacts cannot be recovered.



Permissions and other requirements



SubscriptionCompany


User typeBusiness user with admin privileges


PermissionsDelete Contacts







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for a contact.


 
 Example:  65
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query contacts
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:  "company-config/contact"
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 has (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 result set, 4000 maximum.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "company-config/contact",
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "printAs"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1257",
      • "printAs": "Andy Moore"
      },
    • {
      • "key": "1359",
      • "printAs": "Lester Bestertester"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}