openapi: 3.0.0
info:
title: Company and Configuration
description: >
This section deals with providing information about a company or setting
configurations. These objects are mainly for system administrators, but end
users do interact with some of these.
version: '1.0'
servers:
- url: https://api.intacct.com/ia/api/v1-beta2
description: Open Beta
tags:
- name: Attachments
description: >-
An attachment object contains an array of one more or more files that are
stored in Sage Intacct. You can attach multiple files of any type to a
transaction using an attachment, such as scanned images, spreadsheets, and
word-processor documents. For example, you might add ten scanned images to
a single attachment for a bill.
It's important to note that each transaction or record can only have one
attachment assigned to it. After you add an attachment, you can add or
delete individual files to and from the attachment, ensuring your
supporting documents are always up-to-date.
All attachments are stored in attachment
[folders](/openapi/co/company-config.folder/tag/Attachment-folders).Please be aware that this object is currently "Uncertified"
in our open beta, signifying that it has not undergone the complete review
process and the design may change during ongoing refinement. Users are
advised to exercise discretion in using this object and are encouraged to
provide feedback.
x-displayName: Attachments
- name: Attachment folders
description: >-
Folder are used to store
[attachments](/openapi/co/company-config.attachment/tag/Attachments) for
easy grouping. For example, you can create an attachment folder for a
project and store every supporting document for the project in that
folder.
Attachment folders can be nested. The folder hierarchy can be as broad or
deep as needed.Please be aware that this object is
currently "Uncertified" in our open beta, signifying that it has not
undergone the complete review process and the design may change during
ongoing refinement. Users are advised to exercise discretion in using this
object and are encouraged to provide feedback.
x-displayName: Attachment folders
- name: Classes
description: >-
[Class](https://www.intacct.com/ia/docs/en_US/help_action/Reporting/Setup/Dimensions/Managing_classes/class-information.htm)
is a flexible
[dimension](https://www.intacct.com/ia/docs/en_US/help_action/Reporting/Setup/Dimensions/dimensions-overview-ns.htm)
that can be defined in a company and used to track just about anything.
You can rename the class dimension and add custom fields if needed, and
then select a class and provide values for the fields in applicable
transactions. You can use the data to create custom reports that provide
important business insights.
Note that renaming the class dimension in the UI does not change the name
of this object in the API. You still use `class` in API requests.
x-displayName: Classes
- name: Contacts
description: >-
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.
Please be aware that this object is currently
"Uncertified" in our open beta, signifying that it has not undergone the
complete review process and the design may change during ongoing
refinement. Users are advised to exercise discretion in using this object
and are encouraged to provide feedback.
x-displayName: Contacts
- name: Departments
description: >-
Department is an optional
[dimension](https://www.intacct.com/ia/docs/en_US/help_action/Reporting/Setup/Dimensions/dimensions-overview-ns.htm)
that can be used for tagging, filtering, and categorizing data in many
areas of Sage Intacct.
The list of departments is shared by all entities in a company. Users can
be restricted to only work with and see specific departments, which might
affect what data they can see in reports, transactions, and other data
records.
You can create a hierarchy of departments to reflect how departments are
organized within a company. To set up a hierarchy, create the parent
departments first and then specify a parent department when adding child
departments.
x-displayName: Departments
- name: Entities
description: >-
In a multi-entity shared company, entities represent a separate tax
identification or a separately secured, fully balancing set of books.
Entities typically represent divisions, franchises, affiliates,
associations, locations, chapters, self-balancing funds or subsidiaries,
with a shared chart of accounts.Please be aware that
this object is currently "Uncertified" in our open beta, signifying that
it has not undergone the complete review process and the design may change
during ongoing refinement. Users are advised to exercise discretion in
using this object and are encouraged to provide feedback.
x-displayName: Entities
- name: Locations
description: >
Location is a
[dimension](https://www.intacct.com/ia/docs/en_US/help_action/Reporting/Setup/Dimensions/dimensions-overview-ns.htm)
that is used to represent the geographic locations of offices or
facilities, or to represent divisions in a company. Once you have defined
some locations, you can set locations on transactions, and that
information can be used to provide new insights in reports.
You can create a hierarchy of locations to reflect how locations are
organized within your company.
x-displayName: Locations
- name: Document sequences
description: >-
Use document sequencing to generate new IDs automatically for common
transactions and records, such as new customers, vendors, invoices, and
more. For example, you can create a document sequence for invoices. This
new sequence automatically creates a new ID, such as 'INV-0100' and
increments the number each time a new invoice is created.
x-displayName: Document sequences
- name: Email templates
description: >-
Use email templates to organize email content and add style to make emails
stand out to your customers and vendors. Create a variety of email
templates to use for different types of transactions, different vendors,
or different customers. You can add merge fields to populate emails with
dynamic data from Sage Intacct, such as the vendor name, contact
information, and so on.Please be aware that this object
is currently "Uncertified" in our open beta, signifying that it has not
undergone the complete review process and the design may change during
ongoing refinement. Users are advised to exercise discretion in using this
object and are encouraged to provide feedback.
x-displayName: Email templates
- name: Users
description: >-
Users are individuals who have access to some part of Sage Intacct. Most
users are employees, but users might also be outside the company, such as
accountants, attorneys, bankers, vendors, customers, or auditors.Please be aware that this object is currently "Uncertified"
in our open beta, signifying that it has not undergone the complete review
process and the design may change during ongoing refinement. Users are
advised to exercise discretion in using this object and are encouraged to
provide feedback.
x-displayName: Users
- name: Roles
description: >-
Roles can be defined for various job functions.
Permissions to perform certain tasks can be assigned to specific roles,
and roles can then be assigned to users or user groups.
Please be aware that this object is currently
"Uncertified" in our open beta, signifying that it has not undergone the
complete review process and the design may change during ongoing
refinement. Users are advised to exercise discretion in using this object
and are encouraged to provide feedback.
x-displayName: Roles
- name: Permissions
description: >-
Each specific role is associated with particular modules, and each module
contain multiple permissions.
When assigning a permission to a specific role there will be a validation
that ensures that the specified permissions are allowed for the role.
Please be aware that this object is currently
"Uncertified" in our open beta, signifying that it has not undergone the
complete review process and the design may change during ongoing
refinement. Users are advised to exercise discretion in using this object
and are encouraged to provide feedback.
x-displayName: Permissions
- name: Role permission assignments
description: >-
This object shows a permission-to-role relationship and the access rights
on that specific permission.Please be aware that this
object is currently "Uncertified" in our open beta, signifying that it has
not undergone the complete review process and the design may change during
ongoing refinement. Users are advised to exercise discretion in using this
object and are encouraged to provide feedback.
x-displayName: Role permission assignments
paths:
/objects/company-config/attachment:
get:
summary: List attachments
description: >+
Returns up to 100 attachments from the collection with a key, ID, and
link for each attachment. This operation is mostly for use in testing;
use the query service to find attachments that meet certain criteria and
specify the properties that are returned.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business, Employee, Project Manager,
Platform, and Warehouse |
|---|
| Permissions | List Attachments |
|---|
tags:
- Attachments
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of attachment objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of attachments:
value:
ia::result:
- key: '8'
id: PROJ-159
href: /objects/company-config/attachment/8
- key: '1'
id: INVOICES
href: /objects/company-config/attachment/1
- key: '2'
id: 2022 Taxes
href: /objects/company-config/attachment/2
ia::meta:
totalCount: 3
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
operationId: list-company-config-attachment
security:
- OAuth2: []
post:
summary: Create an attachment
description: >+
Creates a new attachment in a specified folder. You can add files when
you create an attachment, or use a PATCH request to add files later.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business |
|---|
| Permissions | Add Attachments |
|---|
tags:
- Attachments
operationId: create-company-config-attachment
requestBody:
description: Attachment to create
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-attachment'
- $ref: '#/components/schemas/company-config-attachmentRequiredProperties'
examples:
Create an empty attachment:
value:
id: 2022 Tax
name: 2022 Tax Forms
folder:
key: '27'
Create an attachment that contains a file:
value:
id: attach-02
name: Short text file
folder:
key: '1'
files:
- name: short file.txt
data: aGVsbG8gd29ybGQhIHRoaXMgaXMgYmFzZTY0IGVuY29kZWQgZGF0YQ==
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: Reference to new attachment
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Reference to new attachment:
value:
ia::result:
key: '17'
id: 2022 Tax
href: /objects/company-config/attachment/17
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/attachment/{key}:
parameters:
- name: key
description: System-assigned key for the attachment.
in: path
required: true
example: '43'
schema:
type: string
get:
summary: Get an attachment
description: >+
Returns detailed information for a specified attachment, including
Base64-encoded versions of all files in the attachment.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business, Employee, Project Manager,
Platform, and Warehouse |
|---|
| Permissions | List Attachments |
|---|
tags:
- Attachments
operationId: get-company-config-attachment-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the attachment
properties:
ia::result:
$ref: '#/components/schemas/company-config-attachment'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Attachment details:
value:
ia::result:
key: '17'
id: INV-V1
name: Vendor 1 Invoices
folder:
id: Invoices
key: '1'
href: /objects/company-config/folder/1
description: null
audit:
createdBy: matthew.mikawber
modifiedBy: matthew.mikawber
modifiedDate: '2023-05-25'
createdDate: '2023-05-25'
files:
- id: '29'
key: '29'
attachment:
key: '17'
data: >-
aGVsbG8gd29ybGQhIHRoaXMgaXMgYmFzZTY0IGVuY29kZWQgZGF0YQ==
name: short file.txt
size: 40
href: /objects/company-config/attachment/17
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update an attachment
description: >+
Updates an existing attachment by setting field values. Any fields not
provided remain unchanged. Use this operation to add, update, and delete
files in attachments.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business |
|---|
| Permissions | Edit Attachments |
|---|
tags:
- Attachments
operationId: update-company-config-attachment-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-attachment'
- type: object
properties:
id:
readOnly: true
examples:
Add a file to an attachment:
value:
files:
- name: short file 2.txt
data: aGVsbG8gd29ybGQhIHRoaXMgaXMgYmFzZTY0IGVuY29kZWQgZGF0YQ==
Delete a file from an attachment:
value:
files:
- key: '29'
ia::operation: delete
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Reference to updated attachment
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Reference to updated attachment:
value:
ia::result:
key: '17'
id: attach-02
href: /objects/company-config/attachment/17
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete an attachment
description: >+
Deletes a attachment and all files that it contains. You must first
remove the attachment from any records or transactions.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business, Employee, Project Manager,
Platform, and Warehouse |
|---|
| Permissions | List Attachments |
|---|
tags:
- Attachments
operationId: delete-company-config-attachment-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/folder:
get:
summary: List folders
description: >+
Returns up to 100 folders from the collection with a key, ID, and link
for each folder. This operation is mostly for use in testing; use the
query service to find folders that meet certain criteria and specify the
properties that are returned.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business, Employee, Project Manager,
and Warehouse |
|---|
| Permissions | List Attachment Folders |
|---|
tags:
- Attachment folders
operationId: list-company-config-folder
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of folder objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
Folder list:
value:
ia::result:
- key: '1'
id: Bills
href: /objects/company-config/folder/1
- key: '2'
id: Credits
href: /objects/company-config/folder/2
ia::meta:
totalCount: 2
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a folder
description: |+
Creates a new folder for attachments.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business |
|---|
| Permissions | Add Attachment Folders |
|---|
tags:
- Attachment folders
operationId: create-company-config-folder
requestBody:
description: Folder to create
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-folder'
- $ref: '#/components/schemas/company-config-folderRequiredProperties'
examples:
Create a folder:
value:
id: 2022 Bills
description: Annual bills folder
status: active
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New folder
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New folder:
value:
ia::result:
key: '28'
id: 2022 Bills
href: /objects/company-config/folder/28
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/folder/{key}:
parameters:
- name: key
description: System-assigned key for the attachment folder.
in: path
required: true
example: '28'
schema:
type: string
get:
summary: Get a folder
description: >+
Returns detailed information for a specified folder.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business, Employee, Project Manager,
and Warehouse |
|---|
| Permissions | View Attachment Folders |
|---|
tags:
- Attachment folders
operationId: get-company-config-folder-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the folder
properties:
ia::result:
$ref: '#/components/schemas/company-config-folder'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Folder details:
value:
ia::result:
key: '28'
id: 2022 Bills
parent:
id: Bills
key: '2'
href: /objects/company-config/folder/2
description: Annual bills folder
audit:
createdDate: '2023-04-01'
createdBy: Admin
modifiedBy: Admin
modifiedDate: '2023-04-01'
status: active
href: /objects/company-config/folder/28
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a folder
description: >+
Updates an existing folder by setting field values. Any fields not
provided remain unchanged.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business |
|---|
| Permissions | Edit Attachment Folders |
|---|
tags:
- Attachment folders
operationId: update-company-config-folder-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-folder'
- type: object
properties:
id:
readOnly: true
examples:
Change folder description:
value:
description: 2022 bills and dunning notices
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Folder updated
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Folder updated:
value:
ia::result:
key: '1'
id: Bills
href: /objects/company-config/folder/1
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a folder
description: >+
Deletes a folder and all of its subfolders and attachments. You must
first remove the attachments from any records or transactions.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business |
|---|
| Permissions | Delete Attachment
Folders |
|---|
tags:
- Attachment folders
operationId: delete-company-config-folder-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/class:
get:
summary: List classes
description: >+
Returns up to 100 object references from the collection with a key, ID,
and link for each object. This operation is mostly for use in testing;
use the query service to find objects that meet certain criteria and
specify the properties that are returned.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business, Employee, Payment
Approver |
|---|
| Permissions | List, View Classes |
|---|
tags:
- Classes
operationId: list-company-config-class
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of class objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
list classes:
value:
ia::result:
- key: '1'
id: Class_1
href: /objects/company-config/class/1
- key: '2'
id: Class_2
href: /objects/company-config/class/2
ia::meta:
totalCount: 2
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a class
description: >+
Creates a new class. You can think of this as adding a new value to the
dimension that you can use to tag transactions for reporting.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business user with admin
privileges |
|---|
| Permissions | Add Classes |
|---|
tags:
- Classes
operationId: create-company-config-class
requestBody:
description: Class object to create
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-class'
- $ref: '#/components/schemas/company-config-classRequiredProperties'
examples:
Create a single class:
value:
id: SW
name: Software
description: All software titles
status: active
Create a child class:
value:
id: SW-Office
name: Office Software
description: Office productivity software
status: active
parent:
key: '1'
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New class
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New class created:
value:
ia::result:
key: '1'
id: SW
href: /objects/company-config/class/1
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/class/{key}:
parameters:
- name: key
description: System-assigned key for the class.
in: path
required: true
example: '43'
schema:
type: string
get:
summary: Get a class
description: >+
Returns detailed information for a specified class.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business, Employee, Payment
Approver |
|---|
| Permissions | List, View Classes |
|---|
tags:
- Classes
operationId: get-company-config-class-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the class
properties:
ia::result:
$ref: '#/components/schemas/company-config-class'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get a class:
value:
ia::result:
key: '9'
id: SW-Office
name: Office Software
description: Office productivity software
status: active
parent:
key: '8'
id: SW
name: Software
audit:
createdDateTime: '2022-06-28T23:41:44Z'
modifiedDateTime: '2022-06-29T15:52:18Z'
createdBy: '68'
modifiedBy: '68'
href: /objects/company-config/class/9
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a class
description: >+
Updates an existing class by setting field values. Any fields not
provided remain unchanged.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business user with admin
privileges |
|---|
| Permissions | Edit Classes |
|---|
tags:
- Classes
operationId: update-company-config-class-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-class'
- type: object
properties:
id:
readOnly: true
examples:
Update a single value:
value:
name: Root one
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated class
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Update a single value:
value:
ia::result:
key: '1'
id: Class1
href: /objects/company-config/class/1
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a class
description: >+
Deletes a class. You can delete a class if it is not being used or
referenced. Deleted classes cannot be recovered.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business user with admin
privileges |
|---|
| Permissions | Delete Classes |
|---|
tags:
- Classes
operationId: delete-company-config-class-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/contact:
get:
summary: List contacts
description: >+
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
| Subscription | Company |
|---|
| User type | Business, Employee, Payment
Approver |
|---|
| Permissions | List, View Contacts |
|---|
tags:
- Contacts
operationId: list-company-config-contact
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of contact objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List contacts:
value:
ia::result:
- key: '265'
id: Mary Cooper
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
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a contact
description: >+
Creates a new contact.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business user with admin
privileges |
|---|
| Permissions | Add Contacts |
|---|
tags:
- Contacts
operationId: create-company-config-contact
requestBody:
description: Contact object to create
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-contact'
- $ref: '#/components/schemas/company-config-contactRequiredProperties'
examples:
Create a contact:
value:
id: AMoore
prefix: Mr
firstName: Andy
lastName: Moore
middleName: Robert
printAs: Andy Moore
companyName: Sage
phone1: '9134598676'
mobile: '9133132299'
fax: '9134598677'
email1: andy.moore@mycompany.com
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
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New contact
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New contact created:
value:
ia::result:
key: '312'
id: AMoore
href: /objects/company-config/contact/312
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/contact/{key}:
parameters:
- name: key
description: System-assigned key for the contact.
in: path
required: true
example: '65'
schema:
type: string
get:
summary: Get a contact
description: >+
Returns detailed information for a specified contact.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business, Employee, Payment
Approver |
|---|
| Permissions | List, View Contacts |
|---|
tags:
- Contacts
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the contact
properties:
ia::result:
$ref: '#/components/schemas/company-config-contact'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get a contact:
value:
ia::result:
key: '1257'
id: AMoore
companyName: Sage
prefix: Mr
firstName: Andy
lastName: Moore
middleName: Robert
printAs: Andy Moore
tax:
isTaxable: true
group:
id: New York
key: '6'
href: /objects/company-config/contact-tax-group/6
taxId: 123-12-1234
phone1: '9134598676'
phone2: null
mobile: '9133132299'
pager: null
fax: '9134598677'
email1: andy.moore@mycompany.com
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
entity:
key: '54'
id: Western Region
name: Western Region
href: /objects/company-config/entity/54
priceSchedule:
id: null
key: null
discount: null
priceList:
id: null
key: null
href: /objects/company-config/contact/1257
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
operationId: get-company-config-contact-key
security:
- OAuth2: []
patch:
summary: Update a contact
description: >+
Updates an existing contact by setting field values. Any fields not
provided remain unchanged.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business user with admin
privileges |
|---|
| Permissions | Edit Contacts |
|---|
tags:
- Contacts
operationId: update-company-config-contact-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-contact'
- type: object
properties:
id:
readOnly: true
examples:
Change contact's company name:
value:
companyName: Google
Set a contact as non-taxable:
value:
tax:
isTaxable: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated contact
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Contact updated:
value:
ia::result:
key: '312'
id: John
href: /objects/company-config/contact/312
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a contact
description: >+
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
| Subscription | Company |
|---|
| User type | Business user with admin
privileges |
|---|
| Permissions | Delete Contacts |
|---|
tags:
- Contacts
operationId: delete-company-config-contact-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/department:
get:
summary: List departments
description: >+
Returns up to 100 department references from the collection with a key,
ID, and link for each department. This operation is mostly for use in
testing; use the query service to find departments that meet certain
criteria and to specify the properties that are returned.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business, Employee, Payment
Approver |
|---|
| Permissions | List, View Departments |
|---|
tags:
- Departments
operationId: list-company-config-department
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of departments
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of departments:
value:
ia::result:
- key: '11'
id: Eng
href: /objects/company-config/department/1
- key: '2'
id: Fin
href: /objects/company-config/department/2
- key: '3'
id: HR
href: /objects/company-config/department/3
ia::meta:
totalCount: 3
start: 1
pageSize: 100
next: null
previous: null
'201':
description: Created
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a department
description: >+
Creates a new department.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business user with admin
privileges |
|---|
| Permissions | Add Department |
|---|
tags:
- Departments
operationId: create-company-config-department
requestBody:
description: Department to create
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-department'
- $ref: '#/components/schemas/company-config-departmentRequiredProperties'
examples:
Create a department:
value:
id: ENG
name: Engineering
reportTitle: Engineering
status: active
supervisor:
key: '16'
Create a child department:
value:
id: SW
name: Software
reportTitle: Software Development
status: active
parent:
key: '28'
supervisor:
key: '5'
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New department
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New department created:
value:
ia::result:
key: '12'
id: ENG
href: /objects/company-config/department/12
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/department/{key}:
parameters:
- name: key
description: System-assigned key for the department.
in: path
required: true
example: '28'
schema:
type: string
get:
summary: Get a department
description: >+
Returns detailed information for a specified department.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business, Employee, Payment
Approver |
|---|
| Permissions | List, View Departments |
|---|
tags:
- Departments
operationId: get-company-config-department-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the department
properties:
ia::result:
$ref: '#/components/schemas/company-config-department'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Department details:
value:
ia::result:
id: PS
key: '28'
name: Professional Services
parent:
key: '7'
id: CS--Client Services
name: Client Services
href: /objects/company-config/department/7
supervisor:
key: '5'
id: MGR1--PS Dept - Manager
name: PS Dept - Manager
href: /objects/company-config/employee/5
audit:
createdDateTime: '2023-01-08T11:28:12Z'
modifiedDateTime: '2023-01-08T11:28:12Z'
createdBy: '1'
modifiedBy: '95'
status: active
reportTitle: Professional Services
href: /objects/company-config/department/28
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a department
description: >+
Updates an existing department by setting field values. Any fields not
provided remain unchanged.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business user with admin
privileges |
|---|
| Permissions | Edit Departments |
|---|
tags:
- Departments
operationId: update-company-config-department-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-department'
- type: object
properties:
id:
readOnly: true
examples:
Change department supervisor:
value:
supervisor:
key: '99'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated department
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Department updated:
value:
ia::result:
key: '1'
id: SW
href: /objects/company-config/department/1
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a department
description: >+
Deletes a department. You can delete a department if it is not being
used or referenced. Deleted departments cannot be recovered.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business user with admin
privileges |
|---|
| Permissions | Delete Departments |
|---|
tags:
- Departments
operationId: delete-company-config-department-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/entity:
get:
summary: List entities
description: >-
Returns up to 100 entities from the collection with a key, ID, and link
for each entity. This operation is mostly for use in testing; use the
query service to find entities that meet specific criteria and to
specify the properties that you want in the response.
tags:
- Entities
operationId: list-company-config-entity
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of entity objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of entities:
value:
ia::result:
- key: '195'
id: entity1692705208
href: /objects/company-config/entity/195
- key: '196'
id: entity21692704288
href: /objects/company-config/entity/196
- key: '197'
id: entity11692704288
href: /objects/company-config/entity/196
ia::meta:
totalCount: 3
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create an entity
description: Creates a new entity.
tags:
- Entities
operationId: create-company-config-entity
requestBody:
description: Create entity object
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-entity'
- $ref: '#/components/schemas/company-config-entityRequiredProperties'
examples:
Create an entity:
value:
id: Hungary
name: Hungary
federalId: '123456789'
defaultCountryForAddresses: hungary
operatingCountry: hungary
reportPrintAs: Hungary
weekStart: monday
contacts:
primary:
id: '-1-13S(V1-13S)'
shipTo:
id: 0000-1S(V0000-1S)
manager:
key: '14'
texts:
message: >-
Superior financial Applications. Real-time business
visibility. Open, on-demand platform.
marketing: Intacct. A Better Way to Run Your Business
footnote: Hungary
customTitle: Hungary
isRoot: true
businessDays:
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
weekends:
- SATURDAY
- SUNDAY
taxId: '192354308'
startDate: '2023-01-12'
openBooksStartDate: '2023-10-01'
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New entity
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New entity created:
value:
ia::result:
key: '184'
id: Hungary
href: /objects/company-config/entity/184
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/entity/{key}:
parameters:
- name: key
in: path
description: System-assigned unique key for the entity.
required: true
schema:
type: string
get:
summary: Get an entity
description: Returns detailed information for a specified entity.
tags:
- Entities
operationId: get-company-config-entity-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the entity
properties:
ia::result:
$ref: '#/components/schemas/company-config-entity'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Entity details:
value:
ia::result:
id: entity1693567215
key: '601'
name: entity1693567215
manager:
name: Supervisor
id: b.ruth
key: '81'
href: /objects/company-config/employee/81
contacts:
primary:
mailingAddress:
addressLine1: 744 Edgewater Blvd
addressLine2: Suite 10
addressLine3: Industrial area
city: Kansas City
state: KS
postCode: '66104'
country: United States
id: AMoore
lastName: Moore
firstName: Andy
middleName: Robert
prefix: Mr.
printAs: Andy Moore
email1: andy.moore@mycompany.com
email2: andy.moore@personal.com
phone1: '9134598676'
phone2: '9133459867'
mobile: '9133132299'
pager: '9133132299'
fax: '9134598677'
URL1: http://andy.exampledomain.com
URL2: http://andy.exampledomainsecond.com
companyName: Ecology Corp
key: '237'
href: /objects/company-config/contact/237
shipTo:
mailingAddress:
addressLine1: 300 Park Avenue
addressLine2: Suite 1400
addressLine3: Western industrial area
city: San Jose
state: California
postCode: '95110'
country: United States
id: Vendor_A0000001
lastName: Smith
firstName: Sara
middleName: Sue
prefix: Ms.
printAs: Sara Smith
email1: ssmith@example.com
email2: sara@home.com
phone1: '14085551212'
phone2: '14123321255'
mobile: '14085554420'
pager: '14085559987'
fax: '14085555309'
URL1: https://smith.example.com
URL2: https://sarasue.example.com
companyName: null
key: '198'
href: /objects/company-config/contact/198
startDate: '2020-01-01'
endDate: null
status: active
audit:
createdDateTime: '2023-09-01T11:20:19Z'
modifiedDateTime: '2023-09-01T11:20:19Z'
createdBy: '99'
modifiedBy: '99'
federalId: '123456789'
firstFiscalMonth: april
weekStart: monday
interEntityPayableGLAccount:
id: null
accountNumber: null
key: null
interEntityReceivableGLAccount:
id: '1'
accountNumber: 123436
key: '1'
texts:
message: >-
Superior financial Applications. Real-time business
visibility. Open, on-demand platform.
marketing: Intacct. A Better Way to Run Your Business
footnote: Net 30 days
reportPrintAs: California
isRoot: false
vendor:
name: Pac bell
id: V-00014
customer:
id: '15'
name: Logic Solutions
enableInterEntityRelationships: false
customTitle: California
businessDays:
- SUNDAY
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
weekends:
- FRIDAY
- SATURDAY
firstTaxMonth: january
taxId: '192354308'
businessId: null
defaultCountryForAddresses: westernSahara
openBooksStartDate: '1990-01-01'
legalContact:
enableOnTaxForms: false
name: Expert Sage Intacct LTD
address:
address1: 300 Park Avenue
address2: Suite 1400
address3: Western industrial area
city: San Jose
state: California
zipCode: '95110'
country: United States
countryCode: us
tpar:
contact:
name: John Doe
phone: '1022223333'
fax: '1009288888'
email: contact@example.com
branchNumber: '001'
enableOnTPAR: false
operatingCountry: unitedState
taxSolution:
key: '23'
id: '23'
taxMethod: Advanced tax
href: /objects/tax/tax-solution/23
isPartialExempt: false
isDefaultPartialExempt: false
unrecoverableTaxAccount:
id: null
accountingType: entity
statutoryReportingPeriodDate: '2021-01-01'
href: /objects/company-config/entity/601
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update an entity
description: >-
Updates an existing entity by setting field values. Any fields not
provided remain unchanged.
tags:
- Entities
operationId: update-company-config-entity-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-entity'
- type: object
properties:
id:
readOnly: true
examples:
Mark an entity as out of operation:
value:
endDate: '2023-12-31'
status: inactive
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Reference to updated entity
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated entity reference:
value:
ia::result:
key: '1'
id: entity1693567215
href: /objects/company-config/entity/1
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete an entity
description: >-
Sage Intacct strongly cautions against deleting an entity, because doing
so can be damaging to your historical data and reports. You're better
off inactivating the entity instead by using PATCH to set `status` to
`inactive`. Read [Inactivate or delete an
entity](https://www.intacct.com/ia/docs/en_US/help_action/Multi-entity/Manage_entities/inactivate-an-entity.htm)
for more information.
tags:
- Entities
operationId: delete-company-config-entity-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/location:
get:
summary: List locations
description: >+
Returns up to 100 locations from the collection with a key, ID, and link
for each location. This operation is mostly for use in testing; use the
query service to find locations that meet certain criteria and specify
the properties that are returned.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business, Employee, Payment
Approver |
|---|
| Permissions | List, View Locations |
|---|
tags:
- Locations
operationId: list-company-config-location
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of location objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List locations:
value:
ia::result:
- key: '1'
id: US-PNW
href: /objects/company-config/location/1
- key: '96'
id: US-EAST
href: /objects/company-config/location/96
- key: '21'
id: US-SOUTH
href: /objects/company-config/location/21
ia::meta:
totalCount: 3
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a location
description: >+
Creates a new location. You can think of this as adding a new value to
the dimension that you can use to tag transactions for reporting.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business user with admin
privileges |
|---|
| Permissions | Add Location |
|---|
tags:
- Locations
operationId: create-company-config-location
requestBody:
description: Create location object
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-location'
- $ref: '#/components/schemas/company-config-locationRequiredProperties'
examples:
Create a single location:
value:
id: loc22
name: 22-India
description: All India offices
status: active
Create a child location:
value:
id: loc227
name: Bangalore
description: Bangalore sales office
status: active
parent:
id: loc22
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New location
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New location created:
value:
ia::result:
key: '234'
id: 22-India
href: /objects/company-config/location/234
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/location/{key}:
parameters:
- name: key
description: System-assigned key for the location.
in: path
required: true
example: '92'
schema:
type: string
get:
summary: Get a location
description: >+
Returns detailed information for a specified location.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business, Employee, Payment
Approver |
|---|
| Permissions | List, View Locations |
|---|
tags:
- Locations
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the location
properties:
ia::result:
$ref: '#/components/schemas/company-config-location'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get a location:
value:
ia::result:
id: WEN
key: '6'
name: Wenatchee
parent:
id: PNW--Pacific Northwest
key: '5'
href: /objects/company-config/location/5
manager:
name: miller, dan
id: EE-0000123--miller, dan
key: '2'
href: /objects/company-config/employee/2
contacts:
primary:
mailingAddress:
addressLine1: '900 Cherry Avenue, #300'
addressLine2: null
addressLine3: null
city: Seattle
country: United States
postCode: '98066'
state: WA
URL1: null
URL2: null
companyName: InsideOut Technologies, Inc
email1: null
email2: null
fax: null
firstName: null
id: InsideOut Technologies, Inc
lastName: null
middleName: null
mobile: null
pager: null
phone1: null
phone2: null
prefix: null
printAs: InsideOut Technologies, Inc
key: '984'
href: /objects/company-config/contact/984
shipTo:
mailingAddress:
addressLine1: null
addressLine2: null
addressLine3: null
city: null
country: null
postCode: null
state: null
URL1: null
URL2: null
companyName: null
email1: null
email2: null
fax: null
firstName: null
id: null
lastName: null
middleName: null
mobile: null
pager: null
phone1: null
phone2: null
prefix: null
printAs: null
key: null
startDate: null
endDate: null
status: active
audit:
createdDateTime: '2022-02-11T09:07:07Z'
modifiedDateTime: '2022-02-11T09:07:07Z'
createdBy: '110'
modifiedBy: '110'
locationReportingTitle: Seattle Sales Office
taxId: null
href: /objects/company-config/location/102
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
operationId: get-company-config-location-key
security:
- OAuth2: []
patch:
summary: Update a location
description: >+
Updates an existing location by setting field values. Any fields not
provided remain unchanged.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business user with admin
privileges |
|---|
| Permissions | Edit Locations |
|---|
tags:
- Locations
operationId: update-company-config-location-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-location'
- type: object
properties:
id:
readOnly: true
examples:
Update location contacts:
value:
manager:
key: '12'
contacts:
primary:
id: john.doe
shipTo:
id: jane.daw
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated location
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Location updated:
value:
ia::result:
key: '12'
id: SW
href: /objects/company-config/location/12
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a location
description: >+
Deletes a location. You can delete a location if it is not being used or
referenced. Deleted locations cannot be recovered.
Permissions and other requirements
| Subscription | Company |
|---|
| User type | Business user with admin
privileges |
|---|
| Permissions | Delete Locations |
|---|
tags:
- Locations
operationId: delete-company-config-location-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/document-sequence:
get:
summary: List document sequences
description: >
Returns up to 100 document sequences from the collection with a key, ID,
and link for each sequence. This operation is mostly for use in testing;
use the query service to find document sequences that meet certain
criteria and to specify the properties that are returned.
tags:
- Document sequences
operationId: list-company-config-document-sequence
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of document-sequence objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of document sequences:
value:
ia::result:
- key: '37'
id: BOA_ACH_BatchNo
href: /objects/company-config/document-sequence/37
- key: '27'
id: Purchase Order
href: /objects/company-config/document-sequence/27
ia::meta:
totalCount: 2
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a document sequence
description: Creates a new document sequence.
tags:
- Document sequences
operationId: create-company-config-document-sequence
requestBody:
description: Document sequence to create
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-document-sequence'
- $ref: '#/components/schemas/company-config-document-sequenceRequiredProperties'
examples:
Creates a numeric document sequence:
value:
id: Vendor Invoice
printTitle: Vendor Invoice
type: numeric
fixedPrefix: P
fixedSuffix: S
prefixSeparator: '-'
suffixSeparator: '-'
startingNumber: 1
endingNumber: null
nextNumber: 1
fixedLength: '4'
rollover:
isEnabled: true
fiscalYearAffixPosition: prefix
separator: '-'
fiscalYears:
- fiscalYear: 2025
nextNumber: 2025
- fiscalYear: 2026
nextNumber: 2026
Creates an alphabetic document sequence:
value:
id: Vendor Invoice
printTitle: Vendor Invoice
type: alpha
fixedPrefix: P
fixedSuffix: S
prefixSeparator: '-'
suffixSeparator: '-'
startingSequence: a
endingSequence: c
nextSequence: a
rollover:
isEnabled: true
fiscalYears:
- fiscalYear: 2023
nextSequence: a
- fiscalYear: 2024
nextSequence: a
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New document-sequence
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New document sequence:
value:
ia::result:
key: '107'
id: Vendor Invoice
href: /objects/company-config/document-sequence/107
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/document-sequence/{key}:
parameters:
- name: key
description: System-assigned key for the document sequence.
in: path
required: true
schema:
type: string
get:
summary: Get a document sequence
description: Returns detailed information for a particular document sequence.
tags:
- Document sequences
operationId: get-company-config-document-sequence-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the document-sequence
properties:
ia::result:
$ref: '#/components/schemas/company-config-document-sequence'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the document sequence:
value:
ia::result:
key: '107'
id: BOA_ACH_BatchNo
printTitle: BOA_ACH_BatchNo
fixedPrefix: P
fixedSuffix: S
prefixSeparator: '-'
suffixSeparator: '-'
startingNumber: 1
endingNumber: null
nextNumber: 1
whenModified: '2014-01-08T11:28:12Z'
fixedLength: null
status: active
type: numeric
startingSequence: null
endingSequence: null
nextSequence: null
rollover:
isEnabled: true
enabledDate: '2024-02-14'
fiscalYearAffixPosition: prefix
separator: '-'
audit:
createdDateTime: '2014-01-08T11:28:12Z'
modifiedDateTime: '2014-01-08T11:28:12Z'
createdBy: '109'
modifiedBy: '109'
fiscalYears:
- id: '646'
key: '646'
documentSequence:
key: '405'
fiscalYear: 2026
nextNumber: 2026
nextSequence: null
audit:
createdDateTime: '2024-02-14T12:34:02Z'
modifiedDateTime: '2024-02-14T12:34:02Z'
createdBy: '109'
modifiedBy: '109'
- id: '645'
key: '645'
documentSequence:
key: '405'
fiscalYear: 2025
nextNumber: 2025
nextSequence: null
audit:
createdDateTime: '2024-02-14T12:34:02Z'
modifiedDateTime: '2024-02-14T12:34:02Z'
createdBy: '109'
modifiedBy: '109'
href: /objects/company-config/document-sequence/107
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a document sequence
description: >-
Updates an existing document sequence by setting field values. Any
fields not provided remain unchanged.
tags:
- Document sequences
operationId: update-company-config-document-sequence-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-document-sequence'
- type: object
properties:
id:
readOnly: true
examples:
Change the prefix separator:
value:
prefixSeparator: '-'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated document-sequence
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated document sequence:
value:
ia::result:
key: '107'
id: BOA_ACH_BatchNo
href: /objects/company-config/document-sequence/107
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a document sequence
description: Deletes a document sequence.
tags:
- Document sequences
operationId: delete-company-config-document-sequence-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/email-template:
get:
summary: List email templates
description: Returns a collection with a key, ID, and link for each email template.
tags:
- Email templates
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of email-template objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of email templates:
value:
ia::result:
- key: '1'
id: '1'
href: /objects/company-config/email-template/1
- key: '2'
id: '2'
href: /objects/company-config/email-template/2
ia::meta:
totalCount: 2
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
operationId: list-company-config-email-template
security:
- OAuth2: []
post:
summary: Create an email template
description: Creates a new email template.
tags:
- Email templates
operationId: create-company-config-email-template
requestBody:
description: Email template to create
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-email-template'
- $ref: '#/components/schemas/company-config-email-templateRequiredProperties'
examples:
example-1:
value:
name: New Email Template
description: Test for New Email Template
templateType: purchasingTxn
email:
replyTo: someEmail@co.com
to: someEmail@co.com
subject: test subject
body: test message for all to see
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: Reference to new email template
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Reference to new email template:
value:
ia::result:
id: '12'
key: '12'
href: /objects/company-config/email-template/12
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/email-template/{key}:
parameters:
- name: key
description: System-assigned key for the email-template.
in: path
required: true
schema:
type: string
get:
summary: Get an email template
description: Returns detailed information for a specified email-template.
tags:
- Email templates
operationId: get-company-config-email-template-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the email template
properties:
ia::result:
$ref: '#/components/schemas/company-config-email-template'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Email template details:
value:
id: 23
key: 23
audit:
createdDateTime: '2023-10-20T11:31:45Z'
modifiedDateTime: '2023-10-20T11:31:45Z'
createdBy: '1'
modifiedBy: '1'
status: active
name: New Email Template
description: Test for New Email Template
templateType: purchasingTxn
email:
replyTo: someEmail@co.com
to: someEmail@co.com
cc: someEmail@co.com
bcc: someEmail@co.com
subject: test subject
body: test message for all to see
logo:
isLogoIncluded: true
verticalPosition: bottom
horizontalPosition: left
includeTxnAttachments: false
includeProjectInvoiceTxnAttachments: false
useSendersPreferredDateFormat: true
href: /objects/company-config/email-template/6
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete an email template
description: Deletes an email template.
tags:
- Email templates
operationId: delete-company-config-email-template-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update an email template
description: >-
Updates an existing email-template by setting field values. Any fields
not provided remain unchanged.
tags:
- Email templates
operationId: update-company-config-email-template-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated email-template
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated email-template:
value:
ia::result:
id: '6'
key: '6'
href: /objects/company-config/email-template/6
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-email-template'
- type: object
properties:
id:
readOnly: true
examples:
example-1:
value:
name: New Email Template patched
email:
to: someEmail@co.com
includeTxnAttachments: true
security:
- OAuth2: []
/objects/company-config/user:
get:
summary: List users
description: >-
Returns up to 100 locations from the collection with a key, ID, and link
for each user. This operation is mostly for use in testing; use the
query service to find users that meet certain criteria and specify the
properties that are returned.
tags:
- Users
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of user objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
example-1:
value:
ia::result:
- key: '1'
id: Admin
href: /objects/company-config/user/1
- key: '2'
id: Jane Doe
href: /objects/company-config/user/2
- key: '4'
id: Larry Smith
href: /objects/company-config/user/4
ia::meta:
totalCount: 3
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
operationId: list-company-config-user
security:
- OAuth2: []
post:
summary: Create a user
description: Creates a new user.
tags:
- Users
operationId: create-company-config-user
requestBody:
description: User to create
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-user'
- $ref: '#/components/schemas/company-config-userRequiredProperties'
examples:
New admin user:
value:
id: Admin
userName: Admin
userType: business
status: active
accountEmail: user_17@sage.com
adminPrivileges: 'off'
contact:
id: Smith
lastName: Smith
firstName: Alex
email1: smith.alex@example.com
mailingAddress:
addressLine1: 300 Park Avenue
city: San Jose
state: California
postCode: '95110'
country: United States
disableChatter: true
permissionAssignments:
- permission:
key: '404'
accessRights:
- list
- delete
- permission:
key: '253'
accessRights:
- list
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New user
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
example-1:
value:
ia::result:
key: '1'
id: Admin
href: /objects/company-config/user/1
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/user/{key}:
parameters:
- name: key
in: path
required: true
description: System-assigned key for the user.
schema:
type: string
example: '65'
get:
summary: Get a user
description: Returns detailed information for a specified user.
tags:
- Users
operationId: get-company-config-user-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the user
properties:
ia::result:
$ref: '#/components/schemas/company-config-user'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
User details:
value:
ia::result:
key: '65'
id: Admin
userName: Admin
href: /objects/company-config/user/65
accountEmail: user_17@sage.com
isChatterDisabled: false
hideOtherDepartmentTransactions: false
trustedDevices: never
adminPrivileges: 'off'
userType: business
status: active
contact:
mailingAddress:
addressLine1: 744 Edgewater Blvd
addressLine2: Apt 104
addressLine3: Western industrial area
city: San Jose
state: CA
postCode: '95110'
country: United States
id: contact01650967341
lastName: John
firstName: E.
middleName: Doe
prefix: Mr
printAs: John E. Doe
email1: john.doe@example.com
email2: john.e.doe@example.com
phone1: '6692248123'
phone2: '1222455566'
mobile: '1222455566'
pager: '12566'
fax: '1222455566'
URL1: http://john.example.com
URL2: http://john.doe.example.com
companyName: Sage Inc
key: '3446'
href: /objects/company-config/contact/3446
webServices:
isEnabled: true
isRestricted: false
password:
neverExpires: true
requiresReset: false
disablePassword: false
sso:
isSSOEnabled: true
federatedSSOId: john.doe
entityAccess:
allowUnrestrictedAccess: true
allowToplevelAccess: false
audit:
createdDateTime: '2022-04-26T10:17:12Z'
modifiedDateTime: '2022-04-26T11:05:26Z'
createdBy: '110'
modifiedBy: '109'
disableChatter: true
locations:
- id: '87'
name: London
href: /objects/company-config/location/87
- id: '92'
name: Paris
href: /objects/company-config/location/92
roles:
- key: '2'
id: '::SYS::Multi Entity Shared-ROLE-FOR - Admin'
href: /objects/company-config/role/2
- key: '23'
id: '::SYS::Multi Entity Shared-ROLE-FOR - User'
href: /objects/company-config/role/23
departments:
- id: '55'
name: Sales
href: /objects/company-config/department/55
- id: '65'
name: Accounting
href: /objects/company-config/department/65
territories:
- id: '22'
name: South
href: /objects/accounts-receivable/territory/22
- id: '32'
name: West
href: /objects/accounts-receivable/territory/32
permissionAssignments:
- permission:
id: '404'
key: '404'
href: /objects/company-config/permission/404
accessRights:
- list
- delete
- permission:
id: '253'
key: '253'
href: /objects/company-config/permission/253
accessRights:
- list
- delete
entity:
key: '54'
id: '313131'
name: Central Region
herf: /objects/company-config/entity/54
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a user
description: >-
Updates an existing user by setting field values. Any fields not
provided remain unchanged.
tags:
- Users
operationId: update-company-config-user-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-user'
- type: object
properties:
id:
readOnly: true
example: '1'
adminPrivileges:
readOnly: true
example: 'off'
examples:
Update user:
value:
userName: Admin
status: inactive
permissionAssignments:
- permission:
key: '404'
accessRights:
- list
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated user
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
example-1:
value:
ia::result:
key: '65'
id: Admin
href: /objects/company-config/user/65
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a user
description: Deletes a user.
tags:
- Users
operationId: delete-company-config-user-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/role:
get:
summary: List roles
description: >-
Returns a collection with a key, ID, and link for each role. This
operation is mostly for use in testing; use the query service to find
roles that meet certain criteria and specify the properties that are
returned.
tags:
- Roles
operationId: list-company-config-role
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of role objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of roles:
value:
ia::result:
- key: '470'
id: '::SYS::Multi Entity Shared-ROLE-FOR - Admin'
href: /objects/company-config/role/470
- key: '471'
id: '::SYS::Multi Entity Shared-ROLE-FOR - BTI'
href: /objects/company-config/role/471
ia::meta:
totalCount: 2
start: 1
pageSize: 100
next: 101
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a role
description: Creates a new role.
tags:
- Roles
operationId: create-company-config-role
requestBody:
description: Role to create
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-role'
- $ref: '#/components/schemas/company-config-roleRequiredProperties'
examples:
Creates a role:
value:
id: '::SYS::Multi Entity Shared-ROLE-FOR - Admin'
description: Administrator role with permissions
roleType: enterprise
applyTo: loginAndSlideIn
rolePermissionAssignments:
- permission:
id: '253'
accessRights:
- list
- readonly
- permission:
id: '207'
accessRights:
- list
- readonly
- add
- modify
- delete
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New role
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New role:
value:
ia::result:
key: '470'
id: '::SYS::Multi Entity Shared-ROLE-FOR - Admin'
href: /objects/company-config/role/470
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/role/{key}:
parameters:
- name: key
description: System-assigned unique key for the role.
in: path
required: true
schema:
type: string
get:
summary: Get a role
description: Returns detailed information for a specified role.
tags:
- Roles
operationId: get-company-config-role-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the role
properties:
ia::result:
$ref: '#/components/schemas/company-config-role'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the role:
value:
ia::result:
key: '470'
id: '::SYS::Multi Entity Shared-ROLE-FOR - Admin'
description: Administrator role with permissions
roleType: enterprise
applyTo: loginAndSlideIn
audit:
createdDateTime: '2020-11-16T14:27:51Z'
modifiedDateTime: '2020-11-16T14:28:11Z'
createdBy: '1'
modifiedBy: '1'
rolePermissionAssignments:
- key: '30'
id: '30'
role:
key: '470'
id: '470'
href: /objects/company-config/role/470
permission:
key: '253'
id: '253'
name: taxScheduleMap
module: purchasing
href: /objects/company-config/permission/253
accessRights:
- list
- readonly
- add
- modify
- delete
audit:
createdDateTime: '2020-11-16T14:27:51Z'
modifiedDateTime: '2020-11-16T14:28:11Z'
createdBy: '1'
modifiedBy: '1'
href: /objects/company-config/role-policy-assignment/30
roleUsers:
- key: '472'
id: '472'
role:
key: '470'
id: '::SYS::Multi Entity Shared-ROLE-FOR - Admin'
href: /objects/company-config/role/470
user:
key: '189'
id: Admin
href: /objects/company-config/user/189
audit:
createdDateTime: '2020-11-16T14:27:51Z'
modifiedDateTime: '2020-11-16T14:28:11Z'
createdBy: '1'
modifiedBy: '1'
href: /objects/company-config/role-user-map/472
roleGroups:
- key: '761'
id: '761'
role:
key: '470'
id: '::SYS::Multi Entity Shared-ROLE-FOR - Admin'
href: /objects/company-config/role/470
userGroup:
key: '1'
id: Bypass group
href: /objects/company-config/user-group/1
audit:
createdDateTime: '2020-11-16T14:27:51Z'
modifiedDateTime: '2020-11-16T14:28:11Z'
createdBy: '1'
modifiedBy: '1'
href: /objects/company-config/role-user-group-map/761
href: /objects/company-config/role/470
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a role
description: >-
Updates an existing role by setting field values. Any fields not
provided remain unchanged.
tags:
- Roles
operationId: update-company-config-role-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/company-config-role'
- type: object
properties:
id:
readOnly: true
examples:
Updates a role:
value:
description: Administrator role with permissions
rolePermissionAssignments:
- key: '30'
accessRights:
- list
- permission:
key: '274'
accessRights:
- add
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated role
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated role:
value:
ia::result:
key: '470'
id: '::SYS::Multi Entity Shared-ROLE-FOR - Admin'
href: /objects/company-config/role/470
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a role
description: Deletes a role.
tags:
- Roles
operationId: delete-company-config-role-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/permission:
get:
summary: List permissions
description: >-
Returns up to 100 object references from the collection with a key, ID,
and link for each object. This operation is mostly for use in testing;
use the query service to find objects that meet certain criteria and
specify the properties that are returned.
tags:
- Permissions
operationId: list-company-config-permission
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of permission objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of permissions:
value:
ia::result:
- key: '1'
id: '1'
href: /objects/company-config/permission/1
- key: '2'
id: '2'
href: /objects/company-config/permission/2
ia::meta:
totalCount: 2
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/permission/{key}:
parameters:
- name: key
description: System-assigned unique key for the permission.
in: path
required: true
schema:
type: string
get:
summary: Get a permission
description: Returns detailed information for a specified permission.
tags:
- Permissions
operationId: get-company-config-permission-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the permission
properties:
ia::result:
$ref: '#/components/schemas/company-config-permission'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the permission:
value:
ia::result:
key: '1'
id: '1'
module: myAccounting
name: switchToMyAccounting
permissionGroup: activitiesAndLists
allowedAccessRights:
- list
href: /objects/company-config/permission/1
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/role-permission-assignment:
get:
summary: List role permission assignments
description: >-
Returns a collection with a key, ID, and link for each role permission
assignment.
tags:
- Role permission assignments
operationId: list-company-config-role-permission-assignment
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of role-permission-assignment objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of role permission assignments:
value:
ia::result:
- key: '156434'
id: '156434'
href: '/objects/company-config/role-permission-assignment/156434'
- key: '156435'
id: '156435'
href: '/objects/company-config/role-permission-assignment/156435'
ia::meta:
totalCount: 2
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/company-config/role-permission-assignment/{key}:
parameters:
- name: key
description: system-assigned unique key for the role permission assignment.
in: path
required: true
schema:
type: string
get:
summary: Get a role permission assignment
description: >-
Returns detailed information for a particular role permission
assignment.
tags:
- Role permission assignments
operationId: get-company-config-role-permission-assignment-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the role-permission-assignment
properties:
ia::result:
$ref: '#/components/schemas/company-config-role-permission-assignment'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the role permission assignment:
value:
ia::result:
key: '177748'
id: '177748'
role:
key: '528'
id: '::SYS::Multi Entity Shared-ROLE-FOR - EMP4-US'
href: /objects/company-config/role/528
permission:
key: '3295'
id: '3295'
name: coverLetters
module: company
href: /objects/company-config/permission/3295
accessRights:
- list
- readonly
- add
- modify
- delete
audit:
createdDateTime: '2023-08-18T09:43:13Z'
modifiedDateTime: '2023-08-18T09:43:13Z'
createdBy: '1'
modifiedBy: '1'
href: '/objects/company-config/role-permission-assignment/177748'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a role permission assignment
description: Deletes a role permission assignment.
tags:
- Role permission assignments
operationId: delete-company-config-role-permission-assignment-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
components:
schemas:
company-config-attachmentRequiredProperties:
type: object
required:
- id
object-reference:
type: object
description: Reference to created or updated object
properties:
key:
type: string
example: '12345'
id:
type: string
example: ID123
href:
type: string
readOnly: true
example: /objects///12345
metadata-pages:
description: Metadata for collection response
type: object
properties:
totalCount:
type: integer
description: Total count
readOnly: true
example: 3
start:
type: integer
description: Start element number
readOnly: true
example: 1
pageSize:
type: integer
description: Page size
readOnly: true
example: 100
next:
type: integer
description: Next element number
readOnly: true
nullable: true
example: 101
previous:
type: integer
description: Previous element number
readOnly: true
nullable: true
example: null
metadata:
description: Metadata for response
type: object
properties:
totalCount:
type: integer
description: Total count
readOnly: true
example: 3
totalSuccess:
type: integer
description: Total success
readOnly: true
example: 2
totalError:
type: integer
description: Total errors
readOnly: true
example: 1
error-response:
type: object
description: Error response
properties:
ia::result:
type: object
properties:
ia::error:
type: object
properties:
code:
type: string
example: invalidRequest
message:
type: string
example: Payload contains errors
supportId:
type: string
example: sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ
errorId:
type: string
example: REST-1064
additionalInfo:
type: object
properties:
messageId:
type: string
example: IA.PAYLOAD_CONTAINS_ERRORS
placeholders:
type: string
propertySet:
type: string
details:
type: array
items:
type: object
properties:
code:
type: string
example: invalidRequest
message:
type: string
example: /testDate is not a valid field
errorId:
type: string
example: REST-1043
target:
type: string
example: /testDate
additionalInfo:
type: object
properties:
messageId:
type: string
example: IA.NOT_A_VALID_FIELD
placeholders:
type: string
example:
FIELD: /testDate
propertySet:
type: string
ia::meta:
$ref: '#/components/schemas/metadata'
company-config-file:
type: object
description: A file in an attachment.
properties:
key:
type: string
description: System-assigned unique key for the file.
example: '962'
readOnly: true
id:
type: string
description: Unique ID for the file. Same as `key` for this object.
example: '962'
readOnly: true
href:
type: string
description: Endpoint for the file.
example: /objects/company-config/file/962
readOnly: true
data:
type: string
description: Attached file data, Base64 encoded.
format: base64zip
example: Y2V2YSwgYWx0Y2V2YQ0Kc2kgaW5jYSBjZXZh
size:
type: integer
description: Size of the attachment in bytes.
example: 27449
name:
type: string
description: File name with extension
example: 02-28-2022-invoice.txt
attachment:
description: Attachment object that this file belongs to.
type: object
properties:
id:
type: string
description: Unique ID of the attachment.
example: 2022 February invoices
key:
type: string
description: Unique key of the attachment.
example: '123'
href:
type: string
description: Endpoint for the attachment.
example: /objects/company-config/attachment/1
readOnly: true
company-config-attachment:
type: object
description: Container to hold one or more files.
properties:
key:
type: string
description: System-assigned unique key for the attachment.
readOnly: true
example: '123'
id:
type: string
description: Unique ID for the attachment container.
example: 2022 Taxes
name:
type: string
description: Brief name for the attachment container.
example: 2022 tax forms
href:
type: string
description: Endpoint for the attachment container.
readOnly: true
example: /objects/company-config/attachment/123
folder:
type: object
description: Folder that this attachment is in.
properties:
key:
type: string
description: Unique key of the folder.
example: '4'
id:
type: string
description: Unique name of the folder.
example: SupDocFolder1
href:
type: string
description: Endpoint for the folder.
readOnly: true
example: /objects/company-config/folder/4
description:
type: string
description: Description of the attachment container.
example: February invoices
entity:
type: object
properties:
key:
type: string
example: '30'
id:
type: string
example: Seattle
name:
type: string
readOnly: true
example: Seattle
href:
type: string
description: URL for the entity.
readOnly: true
example: /objects/company-config/entity/30
files:
type: array
description: Files contained in the attachment.
items:
$ref: '#/components/schemas/company-config-file'
audit:
type: object
properties:
createdDate:
description: Date of the submission
type: string
format: date
example: '2022-04-20'
readOnly: true
modifiedDate:
description: Date of the modification
type: string
format: date
example: '2022-04-20'
readOnly: true
createdBy:
description: User who created this
type: string
example: '1'
readOnly: true
modifiedBy:
description: User who modified this
type: string
example: User2
readOnly: true
company-config-folderRequiredProperties:
type: object
required:
- id
status:
type: string
description: >-
Object status. Active objects are fully functional. Inactive objects are
essentially hidden and cannot be used or referenced.
enum:
- active
- inactive
default: active
example: active
audit:
type: object
properties:
createdDateTime:
description: Time of the submission
type: string
format: date-time
example: '2022-04-20T16:20:00Z'
readOnly: true
modifiedDateTime:
description: Time of the modification
type: string
format: date-time
example: '2022-04-20T16:20:00Z'
readOnly: true
createdBy:
description: User who created this
type: string
example: '1'
readOnly: true
nullable: true
modifiedBy:
description: User who modified this
type: string
example: '95'
readOnly: true
nullable: true
readOnly: true
company-config-folder:
type: object
description: Folder for holding one or more attachments.
properties:
key:
type: string
description: >-
System-assigned unique key for the folder. Used to identify the
folder in URLs or JSON bodies for all operations on the folder.
readOnly: true
example: '88'
id:
type: string
description: >-
Unique name for the folder. Cannot be changed after the folder is
created.
example: 2022 Tax forms
description:
type: string
description: Description of the folder
example: 2022 tax forms
parent:
type: object
description: Parent folder, for folder hierarchies.
properties:
key:
type: string
description: Unique key of the parent folder.
example: '3'
id:
type: string
description: Name of the parent folder.
example: fld3
href:
type: string
description: Endpoint for the parent folder.
readOnly: true
example: /objects/company-config/folder/3
entity:
type: object
properties:
key:
type: string
example: '30'
id:
type: string
example: Seattle
name:
type: string
readOnly: true
example: Seattle
href:
type: string
description: URL endpoint for the entity.
readOnly: true
example: /objects/company-config/entity/30
href:
type: string
description: Endpoint for the folder.
readOnly: true
example: /objects/company-config/folder/1
status:
$ref: '#/components/schemas/status'
audit:
type: object
allOf:
- $ref: '#/components/schemas/audit'
- type: object
properties:
createdDateTime:
description: Date-time of the submission
type: string
format: date-time
example: '2022-04-20T16:20:00Z'
readOnly: true
modifiedDateTime:
description: Date-time of the modification
type: string
format: date-time
example: '2022-04-20T17:40:00Z'
readOnly: true
modifiedBy:
description: User who modified this
type: string
example: User2
readOnly: true
company-config-classRequiredProperties:
type: object
required:
- id
- name
dimension-status:
description: >
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.
type: string
enum:
- active
- activeNonPosting
- inactive
example: active
company-config-class:
type: object
description: >-
Class is a customizable dimension that can be defined in a company and
set on transactions to expand report functionality and insight.
properties:
key:
description: >-
System-assigned unique key for the class. Used to identify the class
in URLs or JSON bodies for all operations on the class.
type: string
readOnly: true
example: '42'
id:
description: Unique ID for the class.
type: string
example: 1-Goods
href:
description: URL endpoint for this class.
type: string
readOnly: true
example: /objects/company-config/class/21
name:
description: Name of this class.
type: string
example: Goods
description:
description: Description of the class.
type: string
example: Goods available for donations
status:
$ref: '#/components/schemas/dimension-status'
example: active
locationKey:
type: string
description: >-
System-assigned unique key for the entity. Used to identify the
entity in URLs or JSON bodies for all operations involving the
entity.
readOnly: true
example: '3345'
parent:
type: object
description: Parent class, for class hierarchies.
properties:
id:
description: Parent class ID.
type: string
example: 23-Donations
key:
description: Parent class key.
type: string
example: '4'
href:
description: URL endpoint for the parent class.
type: string
readOnly: true
example: /objects/company-config/class/3
name:
description: Name of parent class.
type: string
readOnly: true
example: Donations
audit:
$ref: '#/components/schemas/audit'
company-config-contactRequiredProperties:
type: object
required:
- id
- printAs
company-config-contact:
type: object
description: >-
A contact hold all the information needed to contact an individual or
business, including name, email address, phone number, mailing address,
and more.
properties:
key:
type: string
description: System-assigned unique key for the contact.
readOnly: true
example: '21'
id:
type: string
description: Unique identifier for the contact.
example: rkincaid
href:
type: string
readOnly: true
description: URL endpoint for the contact.
example: /objects/company-config/contact/21
lastName:
type: string
description: Last name
example: Kincaid
firstName:
type: string
description: First name
example: Reuben
middleName:
type: string
description: Middle name or initial
example: X
prefix:
type: string
description: Prefix, such as Mr., Mrs., or Ms.
example: Mr.
email1:
type: string
description: Primary email address
example: reuben@mycompany.com
email2:
type: string
description: Secondary email address
example: robert@mycompany.com
phone1:
type: string
description: Primary phone number
example: '4151231234'
phone2:
type: string
description: Secondary phone number
example: '4158661823'
mobile:
type: string
description: Mobile phone number
example: '4159879876'
pager:
type: string
description: Pager number
example: '4151112222'
fax:
type: string
description: Fax number
example: '4152221111'
URL1:
type: string
description: Web page address for this contact.
example: https://mycompany.com
URL2:
type: string
description: Secondary web page address.
example: https://whitehouse.gov
companyName:
type: string
description: Name of the company associated with this contact.
example: AlcoSoft Inc
printAs:
type: string
description: >-
The contact name as you want it to appear on bills, invoices, AR
statements, advances, adjustments, checks, expense reports, expense
reimbursements, and 1099s.
example: Reuben Kincaid
showInContactList:
type: boolean
description: Set to `true` to display the contact in the contact list.
default: true
example: true
discount:
type: string
description: >-
Default discount percentage to be applied to order entry
transactions involving this contact.
example: '33'
status:
$ref: '#/components/schemas/status'
entity:
type: object
description: >-
System-assigned the entity. Used to identify the entity in URLs or
JSON bodies for all operations involving the entity.
readOnly: true
properties:
key:
type: string
description: Entity Key.
readOnly: true
example: '54'
id:
type: string
description: Entity ID.
readOnly: true
example: Western Region
name:
type: string
description: Entity Name.
readOnly: true
example: Western Region
href:
type: string
description: URL for the entity.
readOnly: true
example: /objects/company-config/entity/54
mailingAddress:
type: object
description: The mailing address of the contact.
properties:
addressLine1:
type: string
description: The first address line for shipping, billing, etc.
example: 300 Park Avenue
addressLine2:
type: string
description: The second address line for shipping, billing, etc.
example: Suite 1400
addressLine3:
type: string
description: >-
The third address line for shipping, billing, etc. which
provides additional geographical information.
example: Western industrial area
city:
type: string
description: City
example: San Jose
state:
type: string
description: State
example: California
postCode:
type: string
description: Zip or Postal Code
example: '95110'
country:
type: string
description: Country
example: unitedStates
isoCountryCode:
type: string
description: >-
ISO country code. When ISO country codes are enabled in a
company, both COUNTRY and ISOCOUNTRYCODE must be provided.
example: US
priceList:
type: object
description: >-
Default price list used in order entry when this contact places
orders. Read [the notes in the Help
Center](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/Price_lists/assign-OE-price-list-to-objects.htm#Assignapricelisttoacontact)
for requirements and additional information.
properties:
key:
type: string
description: Price list key
example: '7'
id:
type: string
description: Price list ID
example: Custom-Pricelist
href:
type: string
description: URL for the price list.
readOnly: true
example: /objects/order-entry/price-list/7
priceSchedule:
type: object
description: Price schedule used in order entry when this contact places orders.
properties:
key:
type: string
description: Price schedule key
example: '7'
id:
type: string
description: Price schedule ID
example: Discount-Premium
href:
type: string
description: URL for the price schedule.
readOnly: true
example: /objects/order-entry/price-schedule/7
tax:
type: object
description: >-
Tax settings needed for Intacct to calculate taxes on transactions
for this contact.
properties:
isTaxable:
type: boolean
description: Set to `true` to enable tax calculation.
default: true
example: true
taxId:
type: string
description: State tax ID or VAT registration number for this contact.
example: US2333
group:
type: object
description: The contact tax group to be used with this contact.
properties:
key:
type: string
description: Contact tax group key
example: '7'
id:
type: string
description: Contact tax group ID
example: Taxes-for-residents
href:
type: string
description: URL endpoint of the contact tax group.
readOnly: true
example: /objects/company-config/contact-tax-group/7
company-config-departmentRequiredProperties:
type: object
required:
- id
- name
company-config-department:
type: object
description: Information about a department.
properties:
key:
type: string
description: System-assigned unique key for the department.
example: '28'
readOnly: true
id:
type: string
description: Unique identifier for the department.
nullable: false
example: SW
name:
type: string
description: Department name
nullable: false
example: Software Dev
number:
type: string
description: Department number
example: '10'
reportTitle:
type: string
description: Department title displayed in reports
example: Software Engineering
nullable: true
default: null
parent:
type: object
description: Parent department, for department hierarchies.
properties:
key:
type: string
description: Parent department key
example: '7'
nullable: true
default: null
id:
type: string
example: Dev
description: Parent department ID
name:
type: string
description: Parent department Name
example: Development
readOnly: true
href:
type: string
example: /objects/company-config/department/7
description: Parent department URL endpoint
readOnly: true
readOnly: true
supervisor:
type: object
description: >-
A reference to the employee object of the supervisor for the
department. Used for routing purchase approvals.
properties:
key:
type: string
example: '5'
description: Supervisor key
nullable: true
default: null
id:
type: string
example: EMP-0192
description: Supervisor ID
name:
type: string
description: Supervisor name
example: rjmiller
readOnly: true
href:
type: string
example: /objects/company-config/employee/5
description: URL endpoint of the supervisor employee.
readOnly: true
readOnly: true
status:
$ref: '#/components/schemas/dimension-status'
audit:
$ref: '#/components/schemas/audit'
href:
type: string
example: /objects/company-config/department/28
description: URL endpoint for the department.
readOnly: true
company-config-entityRequiredProperties:
type: object
required:
- id
- name
- federalId
month:
type: string
enum:
- null
- january
- february
- march
- april
- may
- june
- july
- august
- september
- october
- november
- december
example: may
nullable: true
weekdays:
type: string
enum:
- null
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
example: monday
nullable: true
contact-ref:
type: object
properties:
key:
type: string
description: System-assigned unique key for the contact
readOnly: true
example: '21'
id:
type: string
description: Contact ID
example: jsmith
href:
type: string
description: URL endpoint for the contact
readOnly: true
example: /objects/company-config/contact/21
lastName:
type: string
description: Last name
example: Smith
firstName:
type: string
description: First name
example: John
middleName:
type: string
description: Middle name
example: Archibald
prefix:
type: string
description: Prefix
example: Mr
printAs:
type: string
description: Print as
example: John Smith
email1:
type: string
description: Primary email
example: jsmith@company.com
email2:
type: string
description: Secondary email
example: john@aol.com
phone1:
type: string
description: Primary phone
example: '14085551212'
phone2:
type: string
description: Secondary phone
example: '14085559876'
mobile:
type: string
description: Mobile phone
example: '14085554420'
pager:
type: string
description: Pager
example: '14085559987'
fax:
type: string
description: Fax
example: '14085555309'
URL1:
type: string
description: Primary URL
example: https://mycompany.com
URL2:
type: string
description: Secondary URL
example: https://anothercompany.com
companyName:
type: string
description: Company name
example: AlcoSoft Inc
mailingAddress:
type: object
description: Mailing Address
properties:
addressLine1:
type: string
description: Address 1
example: 300 Park Avenue
addressLine2:
type: string
description: Address 2
example: Suite 1400
addressLine3:
type: string
description: Address 3
example: Western industrial area
city:
type: string
description: City
example: San Jose
state:
type: string
description: State
example: California
postCode:
type: string
description: Zip or Postal Code
example: '95110'
country:
type: string
description: Country
example: USA
country:
type: string
enum:
- null
- unitedStates
- afghanistan
- alandIslands
- albania
- algeria
- americanSamoa
- andorra
- angola
- anguilla
- antarctica
- antiguaAndBarbuda
- argentina
- armenia
- aruba
- australia
- austria
- azerbaijan
- bahamas
- bahrain
- bangladesh
- barbados
- belarus
- belgium
- belize
- benin
- bermuda
- bhutan
- bolivia
- bonaire,SintEustatiusAndSaba
- bosniaAndHerzegovina
- botswana
- bouvetIsland
- brazil
- britishIndianOceanTerritory
- bruneiDarussalam
- bulgaria
- burkinaFaso
- burundi
- cambodia
- cameroon
- canada
- capeVerde
- caymanIslands
- centralAfricanRepublic
- chad
- chile
- china
- christmasIsland
- cocos(Keeling)Islands
- colombia
- comoros
- congo
- congo,DemocraticRepublic
- cookIslands
- costaRica
- côteD'Ivoire
- croatia
- cuba
- curaçao
- cyprus
- czechRepublic
- denmark
- djibouti
- dominica
- dominicanRepublic
- ecuador
- egypt
- elSalvador
- equatorialGuinea
- eritrea
- estonia
- eswatini
- ethiopia
- falklandIslands(Malvinas)
- faroeIslands
- fiji
- finland
- france
- frenchGuiana
- frenchPolynesia
- frenchSouthernTerritories
- gabon
- gambia
- georgia
- germany
- ghana
- gibraltar
- greece
- greenland
- grenada
- guadeloupe
- guam
- guatemala
- guernsey
- guinea
- guineaBissau
- guyana
- haiti
- heardIs.&McdonaldIslands
- honduras
- hongKong
- hungary
- iceland
- india
- indonesia
- iran,IslamicRepublicOf
- iraq
- ireland
- isleOfMan
- israel
- italy
- jamaica
- japan
- jersey
- jordan
- kazakhstan
- kenya
- kiribati
- korea,RepublicOf
- korea,Demo.People'sRep.
- kosovo
- kuwait
- kyrgyzstan
- lao
- latvia
- lebanon
- lesotho
- liberia
- libyanArabJamahiriya
- liechtenstein
- lithuania
- luxembourg
- macao
- macedonia
- madagascar
- malawi
- malaysia
- maldives
- mali
- malta
- marshallIslands
- martinique
- mauritania
- mauritius
- mayotte
- mexico
- micronesia
- moldova,RepublicOf
- monaco
- mongolia
- montenegro
- montserrat
- morocco
- mozambique
- myanmar
- namibia
- nauru
- nepal
- netherlands
- netherlandsAntilles
- newCaledonia
- newZealand
- nicaragua
- niger
- nigeria
- niue
- norfolkIsland
- northernMarianaIslands
- norway
- oman
- pakistan
- palau
- palestinianTerritory,Occupied
- panama
- papuaNewGuinea
- paraguay
- peru
- philippines
- pitcairn
- poland
- portugal
- puertoRico
- qatar
- reunion
- romania
- russianFederation
- rwanda
- saintBarthelemy
- saintHelena
- saintKittsAndNevis
- saintLucia
- saintMartin
- saintPierreAndMiquelon
- saintVincentAndTheGrenadines
- samoa
- sanMarino
- saoTomeAndPrincipe
- saudiArabia
- senegal
- serbia
- seychelles
- sierraLeone
- singapore
- sintMaarten
- slovakia
- slovenia
- solomonIslands
- somalia
- southAfrica
- s.Georgia&S.SandwichIs.
- spain
- sriLanka
- sudan
- southSudan
- suriname
- svalbardAndJanMayen
- sweden
- switzerland
- syrianArabRepublic
- taiwan
- tajikistan
- tanzania,UnitedRepublicOf
- thailand
- timorLeste
- togo
- tokelau
- tonga
- trinidadAndTobago
- tunisia
- turkey
- turkmenistan
- turksAndCaicosIslands
- tuvalu
- uganda
- ukraine
- unitedArabEmirates
- unitedKingdom
- uSMinorOutlyingIslands
- uruguay
- uzbekistan
- vanuatu
- vaticanCityState
- venezuela
- vietnam
- virginIslands,British
- virginIslands,U.S.
- wallisAndFutuna
- westernSahara
- yemen
- zambia
- zimbabwe
example: france
nullable: true
country-code:
type: string
enum:
- null
- us
- af
- ax
- al
- dz
- as
- ad
- ao
- ai
- aq
- ag
- ar
- am
- aw
- au
- at
- az
- bs
- bh
- bd
- bb
- by
- be
- bz
- bj
- bm
- bt
- bo
- bq
- ba
- bw
- bv
- br
- io
- bn
- bg
- bf
- bi
- kh
- cm
- ca
- cv
- ky
- cf
- td
- cl
- cn
- cx
- cc
- co
- km
- cg
- cd
- ck
- cr
- ci
- hr
- cu
- cw
- cy
- cz
- dk
- dj
- dm
- do
- ec
- eg
- sv
- gq
- er
- ee
- sz
- et
- fk
- fo
- fj
- fi
- fr
- gf
- pf
- tf
- ga
- gm
- ge
- de
- gh
- gi
- gr
- gl
- gd
- gp
- gu
- gt
- gg
- gn
- gw
- gy
- ht
- hm
- hn
- hk
- hu
- is
- in
- id
- ir
- iq
- ie
- im
- il
- it
- jm
- jp
- je
- jo
- kz
- ke
- ki
- kr
- kp
- xk
- kw
- kg
- la
- lv
- lb
- ls
- lr
- ly
- li
- lt
- lu
- mo
- mk
- mg
- mw
- my
- mv
- ml
- mt
- mh
- mq
- mr
- mu
- yt
- mx
- fm
- md
- mc
- mn
- me
- ms
- ma
- mz
- mm
- na
- nr
- np
- nl
- an
- nc
- nz
- ni
- ne
- ng
- nu
- nf
- mp
- 'no'
- om
- pk
- pw
- ps
- pa
- pg
- py
- pe
- ph
- pn
- pl
- pt
- pr
- qa
- re
- ro
- ru
- rw
- bl
- sh
- kn
- lc
- mf
- pm
- vc
- ws
- sm
- st
- sa
- sn
- rs
- sc
- sl
- sg
- sx
- sk
- si
- sb
- so
- za
- gs
- es
- lk
- sd
- ss
- sr
- sj
- se
- ch
- sy
- tw
- tj
- tz
- th
- tl
- tg
- tk
- to
- tt
- tn
- tr
- tm
- tc
- tv
- ug
- ua
- ae
- gb
- um
- uy
- uz
- vu
- va
- ve
- vn
- vg
- vi
- wf
- eh
- ye
- zm
- zw
example: us
nullable: true
company-config-entity:
type: object
description: Entity configuration.
properties:
key:
type: string
description: System-assigned unique key for the entity.
readOnly: true
example: '2'
id:
type: string
description: >-
Unique identifier of the entity. 20 characters max. The ID cannot be
changed after the entity has been created.
example: Lyon
href:
type: string
description: URL endpoint for the entity.
readOnly: true
example: /objects/company-config/entity/2
name:
type: string
description: Name of the entity.
example: California
startDate:
type: string
format: date
description: The date when the entity became operational.
nullable: true
example: '2022-02-02'
endDate:
type: string
format: date
description: The date when the entity was taken out of operation.
nullable: true
example: '2023-03-03'
federalId:
type: string
description: >-
The federal tax ID for the entity. This value is required but is
only used if the company is configured to issue a separate 1099 for
each US entity.
nullable: true
example: '123456789'
firstFiscalMonth:
type: string
description: First fiscal month
nullable: true
allOf:
- $ref: '#/components/schemas/month'
default: null
firstTaxMonth:
type: string
description: First tax month
nullable: true
allOf:
- $ref: '#/components/schemas/month'
default: null
weekStart:
type: string
description: >-
The first day of each week. This enables the system to provide
accurate data for reports that begin on the first day of a week.
nullable: true
allOf:
- $ref: '#/components/schemas/weekdays'
default: null
contacts:
type: object
description: Contact information for the entity.
properties:
primary:
type: object
description: >-
Primary contact information. This could be for the entity itself
and not for an individual.
allOf:
- $ref: '#/components/schemas/contact-ref'
- type: object
shipTo:
type: object
description: >-
Contact information to use for shipping, if the entity uses a
different address for receiving goods and services.
allOf:
- $ref: '#/components/schemas/contact-ref'
- type: object
texts:
type: object
description: Texts used in invoices and reports.
properties:
message:
type: string
description: Message text
nullable: true
example: >-
Superior financial Applications. Real-time business visibility.
Open, on-demand platform.
marketing:
type: string
description: Marketing text
nullable: true
example: Intacct. A Better Way to Run Your Business
footnote:
type: string
description: >-
Footnote text that will appear on reports and invoices that are
printed for the entity.
nullable: true
example: All sales final.
reportPrintAs:
type: string
description: >-
The name of the entity as it will appear on reports and invoices
that are printed for the entity.
example: My Company LLC
customTitle:
type: string
description: >-
Entity information displayed in reports, in addition to the
entity name. For example, an entity title might include the
address and manager name.
nullable: true
example: San Jose, California
isRoot:
type: boolean
description: Indicates whether this is the top-level entity.
default: false
readOnly: true
enum:
- true
- false
example: false
businessDays:
type: array
description: Work days in each week.
example:
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
default: []
items:
type: string
weekends:
type: array
description: Weekend days.
example:
- SATURDAY
- SUNDAY
default: []
items:
type: string
taxId:
type: string
description: The state or territory tax ID, or VAT ID.
nullable: true
example: '192354308'
defaultCountryForAddresses:
type: string
description: Default country for addresses
allOf:
- $ref: '#/components/schemas/country'
default: unitedStates
businessId:
type: string
description: >-
A company's Business ID (SIRET) is a 14-digit number that starts
with the SIREN (a 9-digit number that identifies the company itself)
followed by 5 digits that identifies the company's physical location
or branch.
nullable: true
example: 453 983 245 12345
openBooksStartDate:
type: string
format: date
description: Open books from
nullable: true
example: '2024-01-01'
operatingCountry:
type: string
description: The country in which the entity operates.
nullable: true
allOf:
- $ref: '#/components/schemas/country'
default: null
legalContact:
type: object
description: >-
Legal contact to be used on 1099 form, 1096 form, and taxable
payments annual report (TPAR).
properties:
enableOnTaxForms:
type: boolean
description: >-
Indicates whether the legal name and address should be included
on forms 1099 and 1096 for this entity.
example: false
default: false
enableOnTPAR:
type: boolean
description: >-
Indicates whether the legal name and address should be included
on taxable payments annual report (TPAR) for Australian
companies and entities.
example: false
default: false
name:
type: string
description: >-
Legal name, to be printed on 1099 form, 1096 form and taxable
payments annual report (TPAR).
nullable: true
example: Expert Sage Intacct LTD
address:
type: object
description: >-
Legal address to be used on 1099 form, 1096 form and taxable
payments annual report (TPAR).
properties:
address1:
type: string
description: Legal address line 1
nullable: true
example: 300 Park Avenue
address2:
type: string
description: Legal address line 2
nullable: true
example: Suite 1400
address3:
type: string
description: Legal address line 3
nullable: true
example: Western industrial area
city:
type: string
description: Legal city
nullable: true
example: San Jose
state:
type: string
description: Legal state or territory
nullable: true
example: California
zipCode:
type: string
description: Legal ZIP or postal code
nullable: true
example: '95110'
country:
type: string
description: Legal country
nullable: true
example: United States
countryCode:
type: string
description: Legal country code
nullable: true
allOf:
- $ref: '#/components/schemas/country-code'
default: null
tpar:
type: object
description: Taxable payments annual report (TPAR) form elements.
properties:
contact:
type: object
description: Legal contact for taxable payments annual report (TPAR).
properties:
name:
type: string
description: Legal contact name.
nullable: true
example: John Doe
phone:
type: string
description: Legal contact phone.
nullable: true
example: '1022223333'
fax:
type: string
description: >-
Legal contact fax on taxable payments annual report
(TPAR).
nullable: true
example: '1009288888'
email:
type: string
description: >-
Legal contact email on taxable payments annual report
(TPAR).
nullable: true
example: contact@example.com
branchNumber:
type: string
description: >-
Legal branch number on taxable payments annual report
(TPAR).
nullable: true
example: '001'
isPartialExempt:
type: boolean
description: >-
Whether items can be marked for partial exemption. When set to
`true`, users can enter bills with items that are eligible for
partial exemption in agreement with the HMRC. Requires that tax
solution is United Kingdom - VAT.
example: true
default: false
isDefaultPartialExempt:
type: boolean
description: >-
Whether items are marked as partial exempt by default. When set to
`true`, items are marked as partial exempt by default on bills and
invoices for Accounts Payable and Purchasing with the following tax
solutions - Australia GST (RITC), Canadian Sales Tax (ITC), UK VAT.
example: true
default: false
accountingType:
type: string
description: >-
Accounting type
- `null` - All for-profit companies.
- `entity` - A taxable entity in a nonprofit organization.
- `fund` - A fund in a nonprofit organization that has the
Accounting practice set to Traditional fund accounting.
example: entity
nullable: true
enum:
- null
- entity
- fund
default: entity
statutoryReportingPeriodDate:
type: string
format: date
description: >-
Max lock date for the given entity, used for GL Setup Approval
Configuration.
nullable: true
example: '2021-01-01'
customer:
type: object
description: Customer associated with the entity.
properties:
key:
type: string
description: Unique key of the associated customer.
nullable: true
example: '15'
href:
type: string
description: URL endpoint for the customer.
readOnly: true
nullable: true
example: /objects/accounts-receivable/customer/23
id:
type: string
description: Unique identifier for the customer.
example: C-00003
name:
type: string
description: Customer name.
readOnly: true
nullable: true
example: Logic Solutions
vendor:
type: object
description: Vendor associated with the entity.
properties:
key:
type: string
description: Unique key of the vendor.
example: '15'
href:
type: string
description: URL endpoint for the vendor.
readOnly: true
example: /objects/accounts-payable/vendor/15
id:
type: string
description: Vendor ID.
example: V-00014
name:
type: string
description: Vendor name
readOnly: true
nullable: true
example: Pac bell
unrecoverableTaxAccount:
type: object
description: >-
Unrecoverable tax account for this entity. Used with partial
exemptions in some countries.
properties:
key:
type: string
description: Unrecoverable tax account key
nullable: true
example: '23'
id:
type: string
description: Unrecoverable tax account ID
nullable: true
example: '123.45'
href:
type: string
description: URL endpoint for the unrecoverable tax account.
readOnly: true
example: /objects/general-ledger/account/23
enableInterEntityRelationships:
type: boolean
description: >-
Set to `true` to enable different accounts based on the target
entity.
default: false
example: true
interEntityPayableGLAccount:
type: object
description: >-
Inter-entity payable account that this entity is associated with.
Only applicable if `enableInterEntityRelationships` = `true`.
properties:
key:
type: string
description: >-
System-assigned unique key of the account for payable
inter-entity transactions.
nullable: true
example: '89'
id:
type: string
description: Inter-entity payable account ID.
nullable: true
example: '555.99'
accountNumber:
type: string
description: Inter-entity payable account number.
readOnly: true
nullable: true
example: '123436'
href:
type: string
description: URL endpoint for the account.
readOnly: true
example: /objects/general-ledger/account/89
interEntityReceivableGLAccount:
type: object
description: >-
Inter-entity receivable account that this entity is associated with.
Only applicable if `enableInterEntityRelationships` = `true`.
properties:
key:
type: string
description: >-
System-assigned unique key of the account for receivable
inter-entity transactions.
nullable: true
example: '876'
id:
type: string
description: Inter-entity receivable account ID.
nullable: true
example: '555.98'
accountNumber:
type: string
description: Inter-entity receivable account number.
readOnly: true
nullable: true
example: '123436'
href:
type: string
description: URL endpoint for the account.
readOnly: true
example: /objects/general-ledger/account/876
manager:
type: object
description: The [employee](company-config-employee) who manages the entity.
properties:
href:
type: string
description: URL endpoint for the manager employee.
readOnly: true
example: /objects/company-config/employee/81
id:
type: string
description: Manager employee ID.
example: jsmith
key:
type: string
description: System-assigned unique key of the manager employee.
example: '81'
name:
type: string
description: Name of the manager.
readOnly: true
nullable: true
example: John Smith
email1:
type: string
description: Manager's primary email address.
readOnly: true
nullable: true
example: supervisor1@example.com
email2:
type: string
description: Manager's secondary email address.
readOnly: true
nullable: true
example: supervisor2@example.com
taxSolution:
type: object
description: >-
The tax solution to be used by this entity. Only for companies
subscribed to the Taxes application.
properties:
key:
type: string
description: Tax solution
example: '23'
href:
type: string
description: URL endpoint for the tax solution.
readOnly: true
example: /objects/tax/tax-solution/23
id:
type: string
description: Tax solution
example: Australia - GST
taxMethod:
type: string
description: Tax solution method
readOnly: true
nullable: true
example: Advanced tax
status:
$ref: '#/components/schemas/status'
audit:
$ref: '#/components/schemas/audit'
company-config-locationRequiredProperties:
type: object
required:
- id
- name
company-config-location:
type: object
description: >-
Location is a dimension that is used to represent the geographic
locations of offices or facilities. It can also be used for divisions in
a company, if that is more significant than geographic locations. Once
defined, locations can be set on transactions, and that information can
be used to provide new insights in reports.
properties:
key:
type: string
description: >-
System-assigned unique key for the location. Used to identify the
location in URLs or JSON bodies for all operations on the location.
readOnly: true
example: 3345
id:
type: string
description: Unique identifier for the location.
example: 1-Lyon
href:
type: string
readOnly: true
description: URL endpoint for this location.
example: /objects/company-config/location/21
name:
type: string
description: Name of the location.
example: Lyon-France
status:
$ref: '#/components/schemas/dimension-status'
taxId:
type: string
description: State tax ID or VAT registration number.
example: US4321112
startDate:
type: string
description: Start date of operation at this location.
format: date
example: '2021-01-01'
endDate:
type: string
description: End date of operation at this location.
format: date
example: '2022-04-01'
contacts:
type: object
description: The list of contacts for the location.
properties:
primary:
type: object
description: >-
The primary location contact specifies the company name,
address, and other details as they should appear on invoices,
bills, and other forms.
allOf:
- $ref: '#/components/schemas/contact-ref'
- type: object
shipTo:
type: object
description: >-
The address for receiving goods and services, if different from
the primary contact address.
allOf:
- $ref: '#/components/schemas/contact-ref'
- type: object
locationReportingTitle:
type: string
description: >-
Location information displayed in reports, in addition to the
location name. For example, a location title might include the
address and manager name.
parent:
type: object
description: Parent location, for location hierarchies.
properties:
key:
description: Parent location key.
type: string
example: 65
id:
description: Parent location ID.
type: string
example: 1-France
href:
description: URL endpoint of parent location.
type: string
readOnly: true
example: /objects/company-config/location/65
name:
description: Name of the parent location.
type: string
readOnly: true
example: California
manager:
type: object
description: The employee that manages the location.
properties:
key:
description: Manager's employee key.
type: string
example: 81
id:
description: ID of the manager employee.
type: string
example: anne.jason
href:
description: URL endpoint of the manager employee.
type: string
readOnly: true
example: /objects/company-config/employee/81
name:
description: Name of the manager.
type: string
readOnly: true
example: Donations
audit:
$ref: '#/components/schemas/audit'
company-config-document-sequenceRequiredProperties:
type: object
required:
- id
company-config-document-sequence-rollover:
type: object
description: >
The rollover configuration holds the next number or alpha values used to
generate sequences for the fiscal years.
When rollover is enabled for a document sequence then a restart of the
document sequence is initiated for each fiscal year.
If the configuration for a fiscal year is missing then it is
automatically generated by the system when the first sequence is
generated.
When the system generates a configuration the next number or alpha
values are taken over from the base start values.
properties:
key:
type: string
description: System-assigned key for the fiscal year rollover configuration.
readOnly: true
example: '100'
id:
type: string
description: Fiscal year rollover configuration ID.
readOnly: true
example: '100'
href:
type: string
description: Endpoint for the fiscal year rollover configuration.
readOnly: true
example: /objects/company-config/document-sequence-rollover/100
documentSequence:
type: object
readOnly: true
properties:
key:
type: string
description: System-assigned key for the document sequence.
readOnly: true
example: '107'
id:
type: string
description: Identifier for the document sequence.
readOnly: true
example: BOA_ACH_BatchNo
href:
type: string
description: URL for the document sequence.
readOnly: true
example: /objects/company-config/document-sequence/107
fiscalYear:
type: integer
description: Fiscal year
example: 2024
nextNumber:
type: integer
description: >-
Next number used to generate sequences for the fiscal year when the
sequence type is `numeric`
example: 1
nextSequence:
type: string
description: >-
Next sequence used to generate sequences for the fiscal year when
the sequence type is `alpha`
example: a
audit:
$ref: '#/components/schemas/audit'
company-config-document-sequence:
type: object
description: Document sequencing
properties:
key:
type: string
description: Document sequence Key
readOnly: true
example: '61'
id:
type: string
description: Document sequence ID
example: Vendors
printTitle:
type: string
description: Print title
example: Vendors
type:
type: string
description: >-
Numeric or alpha sequence. Alpha sequences are currently only
available for use with Cash Management, or French companies.
enum:
- numeric
- alpha
example: numeric
default: numeric
fixedLength:
type: string
description: >-
Fixed length, up to 16 characters (numeric sequence will be padded
with zeros and alpha sequence will be padded with a's)
example: '16'
fixedPrefix:
type: string
description: Fixed prefix
example: INV
prefixSeparator:
type: string
description: Prefix separator
example: '-'
fixedSuffix:
type: string
description: Fixed suffix
example: COMPANY
suffixSeparator:
type: string
description: Suffix separator
example: '-'
startingNumber:
type: integer
description: Starting number
example: 1
endingNumber:
type: integer
description: Ending number
example: 100
nextNumber:
type: integer
description: Next number
example: 1
startingSequence:
type: string
description: Starting sequence
example: a
endingSequence:
type: string
description: Ending sequence
example: zzz
nextSequence:
type: string
description: Next sequence
example: a
whenModified:
type: string
format: date-time
description: When updated
example: '2014-01-08T11:28:12Z'
rollover:
type: object
description: >-
Use the roollover configuration to generate IDs for documents meant
to take effect in a specific fiscal year.
properties:
isEnabled:
type: boolean
description: >
Set to `true` in order to enable the sequence rollover by fiscal
years.
When rollover is enabled for a document sequence then a restart
of the document sequence is initiated for each fiscal year.
Use the `fiscalYears` to configure the next number or alpha
values used to generate sequences for the fiscal years.
If the configuration for a fiscal year is missing then it is
automatically generated by the system when the first sequence is
generated.
When the system generates a configuration the next number or
alpha values are taken over from the base start values.
example: false
default: false
enabledDate:
type: string
format: date
description: >-
Read only value indicating the date when the rollover
configuration was enabled for the first time.
example: '2021-01-23'
fiscalYearAffixPosition:
type: string
description: >
Configures the option that the fiscal year is appended to the
document sequence generated by the function service for that
fiscal year.
** Valid values **
- `none` Do not append the fiscal year nor the rollover separator to the document sequence.
- `prefix` Append the fiscal year togetwher with the rollover prefix separator as a prefix to the document sequence.
- `suffix` Append the fiscal year togetwher with the rollover suffix separator as a suffix to the document sequence.
example: prefix
enum:
- none
- prefix
- suffix
default: none
separator:
type: string
description: >-
Rollover separator used when the rollover affix mode is set to
`prefix` or `suffix`
example: '-'
fiscalYears:
type: array
description: >-
Fiscal years rollover configuration holds the next number or
alpha values used to generate sequences for the fiscal years.
items:
$ref: '#/components/schemas/company-config-document-sequence-rollover'
status:
$ref: '#/components/schemas/status'
href:
type: string
readOnly: true
description: URL endpoint of the document-sequence
example: /objects/company-config/document-sequence/61
audit:
$ref: '#/components/schemas/audit'
company-config-email-templateRequiredProperties:
type: object
properties:
email:
required:
- replyTo
required:
- name
- subject
- body
company-config-email-template:
type: object
description: >-
Listing of the templates for sending out any electronic order entry
transaction with the person who created it. (Legacy)
properties:
key:
type: string
description: Email Template Key
readOnly: true
example: '23'
id:
type: string
description: Email Template ID
readOnly: true
example: '23'
href:
type: string
description: URL of the email-template.
readOnly: true
example: /objects/company-config/email-template/23
status:
$ref: '#/components/schemas/dimension-status'
name:
type: string
description: name for the email template.
example: New Email Template
description:
type: string
description: Description
example: Test for New Email Template
email:
type: object
properties:
replyTo:
type: string
description: >-
Enter an email address you want the recipient to reply to. This
corresponds to the From email address the user sees in the
Print/Email dialog box when they send an email from a
transaction.
example: someEmail@co.com
to:
type: string
description: >-
To The recipients of the email. You can enter one or more merge
fields in each field.
example: someEmail@co.com
cc:
type: string
description: >-
Carbon Copy the recipients of the email. You can enter one or
more merge fields in each field.
example: someEmail@co.com
bcc:
type: string
description: >-
Blind Carbon Copy the recipients of the email. You can enter one
or more merge fields in each field.
example: someEmail@co.com
subject:
type: string
description: >-
Subject Enter a combination of text and merge fields as desired to
create an informative subject line. This field is required
example: Testing New Email Template
body:
type: string
description: >-
Message Enter a combination of text, merge fields, and HTML markup
as desired to create and customize your message. This field is
required.
example: test message for all to see
logo:
type: object
properties:
isLogoIncluded:
type: boolean
description: >-
Include logo Select this checkbox to include the logo image file
identified on the Company Information page in the email
template.
default: false
example: true
verticalPosition:
type: string
enum:
- top
- bottom
description: >-
Vertical logo position Select whether the logo should appear at
the top or bottom of the email.
default: bottom
example: bottom
horizontalPosition:
type: string
enum:
- left
- right
description: >-
Horizontal logo position Select whether the logo should appear
on the left or right side of the email.
default: left
example: left
includeTxnAttachments:
type: boolean
description: >-
Select this checkbox to include documents attached to the
transaction, such as receipts, in the email you send from a
transaction. Attachments are emailed in the format in which they
were attached to the transaction. For example, if you attached a TXT
file, the file is sent as a TXT file.
default: false
example: true
includeProjectInvoiceTxnAttachments:
type: boolean
description: >-
Select this checkbox to include all source document attachments
linked to a project invoice when emailing the invoice. Attachments
are emailed in the format in which they were attached to the
transaction. For example, if you attached a TXT file, the file is
sent as a TXT file.
default: false
example: true
templateType:
type: string
enum:
- arInvoice
- arStatement
- Contract
- orderEntryTxn
- purchasingTxn
description: Application
default: arInvoice
example: arInvoice
useSendersPreferredDateFormat:
type: boolean
description: Display dates in the user preference setting
default: false
example: true
audit:
$ref: '#/components/schemas/audit'
company-config-userRequiredProperties:
type: object
properties:
contact:
type: object
required:
- lastName
- firstName
- email1
required:
- id
- userName
- userType
- accountEmail
- adminPrivileges
permission-access-rights:
type: string
enum:
- ach
- achSetup
- add
- addExpense
- apiProxy
- approvalLevel1
- approvalLevel2
- approvalLevel3
- approvalLevel4
- approvalLevel5
- approvalLevel6
- authorize
- cancel
- calendar
- clone
- close
- config
- confirm
- delete
- deleteExpense
- edit
- editExpense
- enable
- export
- final
- financial
- group
- ignore
- import
- impersonate
- level1
- level2
- level3
- level4
- level5
- level6
- list
- listExpenses
- manualMatch
- mapAccount
- menu
- modify
- offsetAccount
- open
- overrideException
- permission
- post
- print
- readonly
- readonlyExpense
- receipts
- reclass
- reclassExpense
- reconcile
- refresh
- release
- reopen
- report
- resend
- reversalEdit
- reverse
- reverseExpense
- run
- statutoryReportingPeriod
- submit
- subscribe
- template
- uncancel
- unmask
- upload
- view
- viewAll
- void
example: edit
company-config-user:
description: User information
type: object
properties:
key:
description: >-
System-assigned unique key for the user. Used to identify the user
in URLs or JSON bodies for all operations on the user.
type: string
example: '29'
readOnly: true
id:
description: User login ID
type: string
example: john.doe
userName:
description: User name
type: string
example: John Doe
accountEmail:
description: User email id
type: string
example: john.doe@company.com
adminPrivileges:
description: >
User admin privileges. Setting to `full` or `limited` requires that
the `userType` is `business`.
* `off` - No admin privileges
* `full` - Complete administration privileges including the ability
to create other full administrators and use Platform Services
features.
* `limited` - All administration privileges, except for the
previously mentioned items.
type: string
enum:
- 'off'
- limited
- full
example: 'off'
userType:
description: >
[User
type](https://www.intacct.com/ia/docs/en_US/help_action/Administration/Users/user-types.htm)
type: string
enum:
- business
- employee
- viewOnly
- dashboard
- projectManager
- paymentApprover
- platform
- crm
- warehouse
- constructionManager
example: employee
status:
type: string
description: User status.
enum:
- active
- inactive
- lockedOut
default: active
example: active
webServices:
type: object
description: Web Services / API properties
properties:
isEnabled:
description: Set to `true` to allow the user to use web services (API).
type: boolean
default: true
example: true
isRestricted:
description: >-
Set to `true` to restrict the user to Web Services only. That
is, the user cannot log in to the Sage Intacct.
type: boolean
default: false
example: true
password:
type: object
description: Password properties
properties:
neverExpires:
type: boolean
description: Set to `true` to prevent the user's password from expiring.
example: true
default: false
requiresReset:
type: boolean
description: Set to `true` to trigger the password reset flow for the user.
example: false
default: false
disablePassword:
type: boolean
description: Disable password requirements
default: false
example: false
sso:
type: object
description: SSO settings
properties:
isSSOEnabled:
type: boolean
description: Set to `true` to enable single sign-on for the user.
example: true
default: false
federatedSSOId:
type: string
description: Federated SSO user ID.
example: john.doe
entityAccess:
type: object
description: Entity level restrictions
properties:
allowUnrestrictedAccess:
description: >-
Set to `true` to allow the user to access all entities in the
company.
type: boolean
default: true
example: true
allowToplevelAccess:
description: >-
Set to `true` to enable access to the top-level. It's a best
practice to enable access to the top level for all users who are
restricted to a single entity in a multi-entity shared company.
type: boolean
default: false
example: false
contact:
description: User contact information
allOf:
- $ref: '#/components/schemas/contact-ref'
- type: object
type: object
trustedDevices:
type: string
description: >-
Allow trusted devices. The user can specify whether to use the
company setting or have it enforced.
enum:
- companyDefault
- always
- never
default: companyDefault
example: always
isChatterDisabled:
type: boolean
description: >-
Set to `true` to prevent this user from accessing the Intacct
Collaborate feature.
default: false
example: false
hideOtherDepartmentTransactions:
type: boolean
description: >-
Set to `true` to hide transactions that do not belong to the
departments listed in the `departments` array.
default: false
example: false
locations:
type: array
description: >-
Locations that the user is allowed to view and work with. Leave
empty to allow the user to work with all locations.
items:
type: object
properties:
key:
type: string
description: Location key
example: '42'
id:
type: string
description: Location ID
example: PNW
href:
type: string
description: Endpoint URL for the location.
readOnly: true
example: /objects/company-config/location/21
departments:
type: array
description: >-
Departments that the user is allowed to view and work with. Leave
empty to allow the user to work with all departments.
items:
type: object
properties:
key:
type: string
description: Department key
example: '79'
id:
type: string
description: Department ID
example: Sales
href:
type: string
description: URL endpoint for the department.
readOnly: true
example: /objects/company-config/department/7
territories:
type: array
description: List of territories that the user is assigned to.
items:
type: object
properties:
key:
type: string
description: Territory key
example: '9'
id:
type: string
description: Territory ID
example: T1
href:
type: string
description: Territory URL endpoint
readOnly: true
example: /objects/accounts-receivable/territory/9
roles:
type: array
description: List of roles assigned to the user.
items:
type: object
properties:
key:
type: string
description: Unique key for the role
example: '7'
id:
type: string
description: Role ID
example: Employee
href:
type: string
readOnly: true
example: /objects/company-config/role/7
permissionAssignments:
type: array
items:
type: object
properties:
permission:
type: object
properties:
key:
type: string
description: Permission key
example: '404'
id:
type: string
description: Permission id
example: '404'
href:
type: string
readOnly: true
example: /objects/company-config/permission/404
accessRights:
type: array
description: Permission access rights
example:
- list
- readonly
- add
- modify
- delete
items:
$ref: '#/components/schemas/permission-access-rights'
audit:
$ref: '#/components/schemas/audit'
entity:
type: object
properties:
key:
type: string
description: Entity Key.
example: '54'
id:
type: string
description: Entity ID.
example: '313131'
name:
type: string
description: Entity Name.
readOnly: true
example: Central Region
href:
type: string
description: URL for the entity.
readOnly: true
example: /objects/company-config/entity/54
href:
type: string
readOnly: true
description: URL endpoint for user.
example: /objects/company-config/user/21
company-config-roleRequiredProperties:
type: object
required:
- id
module:
type: string
description: Permission module
readOnly: true
enum:
- accountsPayable
- accountsReceivable
- administration
- advancedAuditTrail
- aiMachineLearning
- avalaraTax
- budgets
- cashManagement
- company
- console
- consolidation
- construction
- constructionPayroll
- contracts
- customizationServices
- dataDeliveryService
- dataImport
- digitalBoardBook
- digitalNetworkSync
- dimensionSync
- dynamicAllocations
- externalServicesProvider
- fixedAssets
- generalLedger
- globalTransactionSecurity
- intacctCollaborate
- intacctSalesforceIntegration
- intacctSalesforceIntegrationV2
- interactiveCustomReportWriter
- interactiveVisualExplorer
- inventoryControl
- managementConsole
- managementConsoleConsolidation
- msTeamsIntegration
- multiEntity
- myAccounting
- myClients
- myPractice
- orderEntry
- outboundPaymentServices
- outsourcedPaymentServices
- paymentServices
- projects
- purchasing
- quickbooksMigration
- realEstate
- revenueManagement
- saasMetrics
- sageCloudServices
- sageIntacctBudgetingAndPlanningConnector
- sagePeople
- siCollaboration
- siFundRaising
- smartTransaction
- spendManagement
- taxExport
- taxes
- timeAndExpenses
- vendorCompliance
- webServices
- wellsFargoPaymentManager
- loanManagement
example: accountsPayable
permission-name:
type: string
description: Permission name
readOnly: true
enum:
- 1099Reports
- aatrix
- accessLog
- accountAllocationDefinitions
- accountAllocationGroups
- accountGroups
- accountMappingStatus
- accountTitleByEntity
- accountingEntriesFile
- accountingPeriods
- accounts
- accumulationTypes
- achBankConfigurations
- achFileGenerator
- achPaymentFile
- addToCheckRun
- adjustAccount
- adjustedAvailableCash
- adjustmentJournals
- adjustingJournalEntries
- adjustments
- aisle
- analysisAndReporting
- apAccountLabels
- apAdvances
- apBillsApprovalLevels
- apLedger
- apOpenItemsRevaluationReport
- apReleaseRetainage
- apTerms
- applicationAdministration
- applicationSetup
- applicationSubscriptions
- applyPenalties
- approveBills
- approveExpenses
- approveJournalEntries
- approvePayments
- approvePurchaseTransaction
- approveReimbursements
- approveTimesheets
- approveVendors
- arAccountLabelTaxGroups
- arAccountLabels
- arLedger
- arOpenItemsRevaluationReport
- arReleaseRetainage
- arTerms
- archive
- assignmentCategories
- assignmentConstraints
- assignmentDependents
- assignmentStatus
- assignments
- assuranceDocuments
- attachmentFolders
- attachments
- auditLog
- automatedTransactions
- bankAccounts
- bankCheckRegister
- bankFeeds
- bankFile
- bankFileGenerator
- bankInterestAndCharges
- bankTransactionAssignmentRules
- bankTransactionRuleSets
- bankTransactionRules
- bankTransactions
- billBackTemplates
- billingTemplate
- bills
- bin
- binFace
- binSize
- books
- budgets
- buildAndDisassembleKits
- bulkActionRuns
- caDe542Report
- calculationMethods
- cancelService
- cashAnalysis
- cashBalances
- changeRequestStatus
- changeRequestTypes
- changeRequests
- chargeCardAccounts
- chargeCardRegister
- chargeCardTransactions
- chargePayoffs
- checkReconciliation
- checkRegister
- checkRun
- checkRunDetail
- checkingAccounts
- checklistCategories
- checklistItem
- checklistOptions
- checklistStatus
- checklists
- checks
- class
- classGroups
- clearCompanyData
- clients
- cloudStorage
- cmRevaluationReport
- companyInformationMyPractice
- companySetupChecklist
- compensationTables
- complianceRecords
- complianceSetup
- consolidateStructure
- consolidateSubsidiaryData
- constructionReporting
- contactTaxGroup
- contacts
- contract
- contracts
- contractBillingTemplate
- contractComplianceChecklist
- contractComplianceTaskItem
- contractExpenseTemplate
- contractGroups
- contractMEAPriceList
- contractPriceList
- contractRevenueTemplate
- contractTypes
- contributions
- costCodeOverrides
- costTypeGroups
- costTypes
- costingChanges
- coverLetters
- creditCardChargesAndOtherFees
- customApplicationsWithUserDefinedDimensions
- customReports
- customerAgingReportsGraphs
- customerBacklog
- customerBankAccounts
- customerCardAccounts
- customerGLGroups
- customerGroups
- customerListReport
- customerReconciliation
- customerTypes
- customers
- cycleCounts
- dashboard
- dataDeliveryService
- datevDataExport
- deferredRevenueDetails
- deferredRevenueForecast
- deferredRevenueForecastGraph
- deferredRevenueRevaluationReport
- departmentActivityReport
- departmentGroups
- departmentMappingStatus
- departments
- deposits
- depositsRegister
- documentNumbering
- drillDownToAllTransactionsFromReports
- dunningLevels
- earningTypes
- electronicReceipts
- emailDeliveryLog
- emailTemplates
- employeeAgingReportsGraphs
- employeeGroups
- employeeOutOfOffice
- employeePositions
- employeeRates
- employeeTypes
- employees
- entities
- entity
- estimateTypes
- evergreenTemplates
- exchangeRate
- exchangeRateTypes
- executiveSummary
- expenseAdjustments
- expenseApprovalLevels
- expenseLedger
- expensePaymentTypes
- expenseSummaries
- expenseTypes
- exportClientTaxData
- extendedGeneralLedger
- externalAuthorizations
- fairValuePriceListEntry
- fairValuePriceLists
- financialInstitution
- financials
- form1099
- fulfillment
- fundsTransfers
- gaapAdjustingEntries
- gaapAdjustmentJournals
- ganttChart
- generalLedger
- generalLedgerRevaluationReport
- generateAllocation
- generateInvoices
- generateLateCharges
- generateReceipt
- generateScheduledCharges
- goBDDataExport
- glAccountId
- grantAdminRights
- graphs
- hourTypes
- imports
- initialOpenItems
- interEntityAccountMapping
- interactiveAccountGroups
- interactiveCustomReports
- interactiveDataVisualizationReports
- interactiveReportAreas
- interactiveReportsMasterConsumerRole
- interEntityTransactions
- inventoryAnalysis
- inventoryControlSetup
- inventoryCosting
- inventoryCycles
- inventoryFulfillment
- inventoryJournal
- inventoryRecurring
- inventoryRegister
- inventoryReorders
- inventorySelfHelp
- inventoryStatus
- inventoryTotals
- inventoryTransactionDefinitions
- inventoryTransactions
- inventoryValuation
- invoicePolicies
- invoices
- itemActivity
- itemGLGroups
- itemGroups
- itemProfitability
- itemTaxGroups
- items
- jobs
- journalActivityReport
- journalEntries
- journalEntryMappingLink
- journals
- kitAnalysis
- laborClasses
- laborShifts
- laborUnions
- landedCostAdjustment
- landedCostsCategory
- leases
- linkSubsidiaries
- loanTypes
- loans
- locationActivityReport
- locationGroups
- locationMappingStatus
- locations
- lotCategory
- lotTracking
- maintainInventoryValuation
- manageBooks
- manageContributions
- managementFees
- managePayments
- managePlan
- manageResourceSchedules
- manageSchedules
- manageSupplies
- manageTimesheets
- managersAndBrokers
- manualPayment
- meaAllocation
- memorizedReportGroups
- memorizedReports
- messages
- multiCurrencyProcessing
- myExpenses
- myTimesheets
- notes
- offlineJobQueue
- opsbidBills
- orderAnalysis
- orderEntrySetup
- orderEntryStatus
- orderEntryTransactionDefinitions
- orderEntryTransactions
- otherReceipts
- ownerDistribution
- ownerInformation
- ownershipStructure
- partnerSyncEvents
- payBills
- payGroups
- payInAdvance
- paymentAccountInformation
- paymentDefaults
- paymentExchangeRateInformation
- paymentManagerPayments
- paymentRequests
- payments
- payrollReportCheck
- payrollReportCheckSummary
- payrollReportGrossPay
- payrollReportPayModifier
- payrollReportPtoActivity
- payrollReportTax
- payrollReportTaxSetup
- payrollReportTimecard
- payrollReportTimecardReport
- pendingReimbursements
- period
- periodMappingStatus
- physicalInventory
- pickEngagements
- pickList
- pickingList
- planStatement
- poTransactionDefinitions
- positionsAndSkills
- postExpenseReports
- postScheduledTransactions
- postTemplates
- postedAdvances
- postedPayments
- postedReimbursements
- preparerSignoff
- priceListEntry
- priceLists
- priceSchedules
- printChecks
- printEMailDocuments
- printEMailDunningNotice
- printEMailInvoices
- printEMailStatements
- printPaymentCopies
- printedDocumentTemplates
- priorPeriodCogsAdjustments
- processContractSchedules
- productLine
- productLines
- projectChangeOrders
- projectContractRateTables
- projectContractTypes
- projectContracts
- projectDetailReporting
- projectEstimates
- projectGroups
- projectResources
- projectStatus
- projectTransactions
- projectTypes
- projects
- properties
- ptoAccrualSchedules
- ptoTypes
- purchasePriceVarianceInvoicePriceVariance
- purchasingAnalysis
- purchasingApprovalLevels
- purchasingRecurring
- purchasingSetup
- purchasingTransaction
- purchasingTransactions
- quickCheckEntry
- quickDeposits
- receiptHistory
- receiptsRegister
- receiveAdvances
- reclassificationReport
- reconcileBank
- reconcileCreditCard
- recoveryTemplates
- recurringAllocations
- recurringBills
- recurringInvoices
- recurringJournalEntries
- recurringSchedules
- recurringStatisticalJournalEntries
- recurringTransactionForecast
- recurringTransactionStatus
- recurringTransactions
- releaseToPay
- renewalTemplates
- renewalsForecast
- replenishInventory
- replenishmentFluctuatingForecasts
- reporting
- reportingAccounts
- reportingAccountsMappingReport
- reportingPeriods
- requestSupplies
- restrictionRelease
- revenueRecognitionCategory
- revenueRecognitionSchedule
- revenueRecognitionTemplate
- reverseConversions
- reviewNote
- reviewerSignoff
- row
- ruleSetPerformanceLog
- runConsolidations
- saasChangeType
- saasSchedule
- saasScheduleEntry
- salesAnalysis
- salesRecurring
- salesTaxReport
- salesforceSyncJobs
- salesforceSynchronizationReport
- salesforceSynchronizationStatus
- sandbox
- savingsAccounts
- selectToReimburse
- sendgridEmailDeliveryLog
- serialMask
- serialTracking
- serviceAuthorizations
- sharedLimits
- shipmentHistory
- shippingMethods
- smartEventJobs
- spendInsight
- staffTimesheets
- standardCostTypes
- standardTasks
- statisticalAccountId
- statisticalAccountMappingStatus
- statisticalAccounts
- statisticalAdjustingJournals
- statisticalAdjustingJournalEntries
- statisticalJournalEntries
- statisticalJournals
- subledgerAndScmCombinedObjects
- subledgerDocument
- subscriptionUsage
- subsidiaryAccounts
- subsidiaryDepartments
- subsidiaryLocations
- subsidiaryReportingPeriods
- subsidiaryStatisticalAccounts
- summaries
- switchToConsole
- switchToManagementConsole
- switchToMyAccounting
- systemPayModifiers
- t5018ReportForCanada
- taskGroups
- taskResources
- taskTypes
- tasks
- taxAdjustingEntries
- taxAdjustmentJournals
- taxAuthority
- taxDetail
- taxReciprocity
- taxRecords
- taxSchedule
- taxScheduleMap
- taxSolutions
- taxSubmissions
- taxablePaymentsAnnualReport
- taxes
- taxesLink
- templates
- tenants
- tenantConfiguration
- territories
- territoryGroups
- timePreferences
- timeSources
- timeTypes
- timeCards
- timesheetRules
- trades
- transactionAllocations
- transactionCurrencies
- transactionRule
- transactionTemplates
- trialBalance
- triggerLogs
- unions
- units
- unitsOfMeasure
- usageAndMetrics
- userDefinedBooks
- userDefinedJournalEntries
- userDefinedJournals
- users
- vendorAgingReportsGraphs
- vendorException
- vendorGLGroups
- vendorGroups
- vendorInsuranceReport
- vendorReconciliation
- vendorTypes
- vendors
- viewAllocationLog
- viewMyClients
- viewMyServiceAuthorizations
- warehouseGroups
- warehouseTransfer
- wipManagement
- warehouses
- zone
- preferences
- managementCompanies
- billPercentageRent
- salesEntry
- leaseRenewal
- expenseRecovery
- reconcileCharges
- reports
- configuration
example: postedPayments
company-config-role-permission-assignment:
type: object
description: List of permissions assigned to the roles for standard objects.
properties:
key:
type: string
description: System-assigned key for the role-permission-assignment.
readOnly: true
example: '177748'
id:
type: string
readOnly: true
description: Role permission assignment ID. Same as `key` for this object.
example: '177748'
href:
type: string
description: URL endpoint for the role permission assignment.
readOnly: true
example: /objects/company-config/role-permission-assignment/177748
role:
type: object
description: Role object
readOnly: true
properties:
key:
type: string
description: Role key.
readOnly: true
example: '528'
id:
type: string
description: Role id.
readOnly: true
example: '::SYS::Multi Entity Shared-ROLE-FOR - EMP4-US'
href:
type: string
description: URL for the roles.
readOnly: true
example: /objects/roles/528
permission:
type: object
description: Permission object
properties:
key:
type: string
description: Permission key.
example: '3295'
id:
type: string
description: Permission id.
example: '3295'
module:
$ref: '#/components/schemas/module'
name:
type: string
allOf:
- $ref: '#/components/schemas/permission-name'
href:
type: string
description: URL for the permission.
readOnly: true
example: /objects/company-config/permission/3295
accessRights:
type: array
description: Permission access rights.
example:
- list
- readonly
- add
- modify
- delete
items:
$ref: '#/components/schemas/permission-access-rights'
audit:
$ref: '#/components/schemas/audit'
company-config-role-user-map:
type: object
description: Map of roles assigned to users.
properties:
key:
type: string
description: System-assigned key for the role-user-map.
readOnly: true
example: '23'
id:
type: string
description: Role users map ID.
readOnly: true
example: '23'
href:
type: string
description: Endpoint for the role-user-map.
readOnly: true
example: /objects/company-config/role-user-map/23
role:
type: object
description: Role object
readOnly: true
properties:
key:
type: string
description: Role key.
readOnly: true
example: '469'
id:
type: string
description: Role name
readOnly: true
example: Admin role
href:
type: string
description: Endpoint for the roles.
readOnly: true
example: /objects/company-config/role/469
user:
type: object
description: User object
readOnly: true
properties:
key:
type: string
description: User key.
readOnly: true
example: '189'
id:
type: string
description: User login ID.
readOnly: true
example: Admin
href:
type: string
description: Endpoint for the user.
readOnly: true
example: /objects/company-config/user/189
audit:
$ref: '#/components/schemas/audit'
company-config-role-user-group-map:
type: object
description: Map of roles assigned to user groups.
properties:
key:
type: string
description: Role group key.
readOnly: true
example: '761'
id:
type: string
description: Role group id.
readOnly: true
example: '761'
href:
type: string
description: Endpoint for the role user group map.
readOnly: true
example: /objects/company-config/role-user-group-map/761
role:
type: object
description: Role object
readOnly: true
properties:
key:
type: string
description: Role key.
readOnly: true
example: '805'
id:
type: string
description: Role name.
readOnly: true
example: '::SYS::Multi Entity Shared-ROLE-FOR - Aaron'
href:
type: string
description: Endpoint for the roles.
readOnly: true
example: /objects/company-config/role/805
userGroup:
type: object
description: User object
readOnly: true
properties:
key:
type: string
description: User group key.
readOnly: true
example: '1'
id:
type: string
description: User group name.
readOnly: true
example: Bypass group
href:
type: string
description: Endpoint for the user group.
readOnly: true
example: /objects/company-config/user-group/1
audit:
$ref: '#/components/schemas/audit'
company-config-role:
type: object
description: List of roles.
properties:
key:
type: string
description: Role key
readOnly: true
example: '24'
id:
type: string
description: Role Id
example: Employee
href:
type: string
description: URL for the role
readOnly: true
example: /objects/company-config/role/24
description:
type: string
description: Description
example: Full employee permissions including approvals
roleType:
type: string
description: Role type
example: enterprise
enum:
- enterprise
- eConsole
- multiEntityDistributed
- multiEntityShared
default: enterprise
applyTo:
type: string
description: Role is applicable to users with specified access method.
example: loginAndSlideIn
enum:
- loginAndSlideIn
- loginOnly
- slideInOnly
default: loginAndSlideIn
rolePermissionAssignments:
type: array
description: List of permission assignments for a specific role
items:
$ref: '#/components/schemas/company-config-role-permission-assignment'
roleUsers:
type: array
description: Map of roles assigned to users
readOnly: true
items:
$ref: '#/components/schemas/company-config-role-user-map'
roleGroups:
type: array
description: Map of roles assigned to user groups
readOnly: true
items:
$ref: '#/components/schemas/company-config-role-user-group-map'
audit:
$ref: '#/components/schemas/audit'
company-config-permission:
type: object
description: List of permissions.
properties:
key:
type: string
description: Permission key
readOnly: true
example: '24'
id:
type: string
description: Permission Id
readOnly: true
example: '24'
href:
type: string
readOnly: true
example: /objects/company-config/permission/24
module:
$ref: '#/components/schemas/module'
name:
$ref: '#/components/schemas/permission-name'
permissionGroup:
type: string
description: The group a standard or custom permission belongs to
readOnly: true
nullable: true
enum:
- null
- actions
- activitiesAndLists
- objects
- objectIds
- menus
- reports
example: activitiesAndLists
allowedAccessRights:
type: array
description: Allowed access rights for this permission
readOnly: true
example:
- list
- readonly
- void
items:
$ref: '#/components/schemas/permission-access-rights'
responses:
400error:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error-response'
securitySchemes:
OAuth2:
description: Sage Intacct OAuth 2.0 authorization code flow
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://api.intacct.com/ia/api/v1-beta2/oauth2/authorize
tokenUrl: https://api.intacct.com/ia/api/v1-beta2/oauth2/token
refreshUrl: https://api.intacct.com/ia/api/v1-beta2/oauth2/token
scopes: {}