User - Sage Intacct REST Data Target Requirements
DataBlend supports the standard API calls to Create, Update, and Delete User records within Sage Intacct leveraging the Sage Intacct API. In addition, a target entity can be specified for multi-entity environments.
| DataBlend Query Object (SDK) | Sage Intacct Object (API) | Required | Notes |
| jsmith | id | Yes — Create | User-defined unique login ID for the user. |
| jsmith@example.com | accountemail | Yes — Create | Email address for the user's Sage Intacct account. Used for login and notifications. |
| full | adminprivileges | Yes — Create | Administrator privilege level for the user (e.g. full, limited, none). |
| 9901 | key | Yes — Update, Delete | System-assigned key of the user record. Required to identify the record for Update or Delete operations. |
| jsmith | username | No | Username for the user. Typically matches id. |
| BusinessUser | usertype | No | Type of user (e.g. BusinessUser, Employee). |
| active | status | No | Status of the user. |
| FALSE | ischatterdisabled | No | Whether Chatter is disabled for this user. Use true or false. |
| FALSE | hideotherdepartmenttransactions | No | Whether the user can only see transactions from their own department. Use true or false. |
| FALSE | webservicesisrestricted | No | Whether this user's web services access is restricted. Use true or false. |
| Columbus | target_entity | No | Target entity ID for multi-entity Sage Intacct environments. |
| CONTACT-001 | contactid | Yes — Create | ID of the contact record associated with this user. Use contactid or contactkey — not both. |
| 7701 | contactkey | No | Key of the contact record. |
| John | contactfirstname | Yes — Create | First name of the user. |
| Smith | contactlastname | Yes — Create | Last name of the user. |
| Mr. | contactprefix | No | Name prefix (e.g. Mr., Ms., Dr.). |
| A. | contactmiddlename | No | Middle name of the user. |
| John A. Smith | contactprintas | No | Name to print on documents for this user. |
| Acme Corp | contactcompanyname | No | Company name for the contact. |
| jsmith@example.com | contactemail1 | No | Primary email address for the contact. |
| jsmith.alt@example.com | contactemail2 | No | Secondary email address for the contact. |
| 212-555-0100 | contactphone1 | No | Primary phone number. |
| 212-555-0101 | contactphone2 | No | Secondary phone number. |
| 212-555-0102 | contactmobile | No | Mobile phone number. |
| 212-555-0103 | contactpager | No | Pager number. |
| 212-555-0104 | contactfax | No | Fax number. |
| https://example.com | contacturl1 | No | Primary website URL. |
| https://alt.example.com | contacturl2 | No | Secondary website URL. |
| 500 Main St | contactmailingaddressaddressline1 | No | Mailing address line 1. |
| Suite 100 | contactmailingaddressaddressline2 | No | Mailing address line 2. |
| Floor 3 | contactmailingaddressaddressline3 | No | Mailing address line 3. |
| New York | contactmailingaddresscity | No | City for the mailing address. |
| NY | contactmailingaddressstate | No | State or province for the mailing address. |
| 10001 | contactmailingaddresspostcode | No | Postal/zip code for the mailing address. |
| United States | contactmailingaddresscountry | No | Country name for the mailing address. |
| US | contactmailingaddressisocountrycode | No | ISO 3166 Alpha-2 country code (e.g. US). |
| TRUE | passwordrequiresreset | No | Whether the user must reset their password on next login. Use true or false. |
| FALSE | passwordneverexpires | No | Whether the user's password never expires. Use true or false. |
| FALSE | passworddisablepassword | No | Whether password login is disabled for this user (e.g. for SSO-only accounts). Use true or false. |
| TRUE | ssoisssoenabled | No | Whether SSO is enabled for this user. Use true or false. |
| SSO-ID-001 | ssofederatedssoid | No | Federated SSO identifier for this user. |
| all | trusteddevices | No | Trusted devices setting for multi-factor authentication. |
| ENTITY-B | entity_id | No | ID of an entity to grant this user access to. Use entity_id or entity_key — not both. |
| 8801 | entity_key | No | Key of the entity. |
| TRUE | entityaccessallowunrestrictedaccess | No | Whether the user has unrestricted access across all entities. Use true or false. |
| TRUE | entityaccessallowtoplevelaccess | No | Whether the user has top-level entity access. Use true or false. |
| ROLE-001 | role_id | No | ID of the role to assign to this user. Use role_id or role_key — not both. |
| 6601 | role_key | No | Key of the role. |
| DEPT-001 | department_id | No | ID of the department to associate with this user. Use department_id or department_key — not both. |
| 6701 | department_key | No | Key of the department. |
| LOC-001 | location_id | No | ID of the location to associate with this user. Use location_id or location_key — not both. |
| 6801 | location_key | No | Key of the location. |
| TERRITORY-001 | territory_id | No | ID of the territory to associate with this user. Use territory_id or territory_key — not both. |
| 6901 | territory_key | No | Key of the territory. |
| Permission Assignments | |||
| PERM-001 | permissionassignment_permissionid | No | ID of the permission to assign. Use permissionassignment_permissionid or permissionassignment_permissionkey — not both. |
| 7001 | permissionassignment_permissionkey | No | Key of the permission. |
| ReadWrite | permissionassignment_accessrights | No | Access rights for this permission assignment. |
| APP-001 | custompermissionassignment_applicationid | No | ID of the application for the custom permission. Use custompermissionassignment_applicationid or custompermissionassignment_applicationkey — not both. |
| 7101 | custompermissionassignment_applicationkey | No | Key of the application. |
| Reporting | custompermissionassignment_applicationpermissiongroup | No | Permission group within the application. |
| ViewReports | custompermissionassignment_applicationpermissionname | No | Name of the permission within the group. |
| ReadOnly | custompermissionassignment_accessrights | No | Access rights for this custom permission assignment. |
| Read | custompermissionassignment_allowedaccessrights | No | Allowed access rights for this custom permission assignment. |
| AGENT-001 | agentpermissionassignment_agentid | No | ID of the agent for the permission assignment. Use agentpermissionassignment_agentid or agentpermissionassignment_agentkey — not both. |
| 7201 | agentpermissionassignment_agentkey | No | Key of the agent. |
| Reporting | agentpermissionassignment_agentpermissiongroup | No | Permission group for the agent assignment. |
| RunReports | agentpermissionassignment_agentpermissionname | No | Name of the agent permission. |
| Execute | agentpermissionassignment_allowedaccessrights | No | Allowed access rights for this agent permission assignment. |
More questions about Sage Intacct API requirements? Please visit the Sage Intacct API site https://developer.sage.com/intacct/apis/intacct/1/intacct-openapi/groups/company-configuration/groups/users-roles-and-permissions/tags/company_configuration_users.