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.

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.


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; use isoCountryCode instead.


 
 Example:  "United States"
isoCountryCode
string or null
 Default:  "US"
ISO country code.


 
 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",
    • "isoCountryCode": "us"
    },
  • "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.


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.


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; use isoCountryCode instead.


 
 Example:  "United States"
isoCountryCode
string or null
 Default:  "US"
ISO country code.


 
 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.


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
    }
}