openapi: 3.0.3 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 tags: - name: Affiliate entity groups description: >- A collection of associated entities that form a reporting group. For example, entities E200 and E500 may be associated with the parent entity E100. x-displayName: Affiliate entity groups - name: Affiliate entities description: >- Affiliate entities are associated entities defined within your Sage Intacct company. Use an affiliate entity to tag the related entity in a transaction. Tagging affiliate entities in transactions enables more detailed reporting. Affiliate entity is a standard dimension based on the list of entities in your Sage Intacct company. Because it's based on the entities in your company, the affiliate entity dimension is read-only. x-displayName: Affiliate entities - name: Attachments description: >- An attachment object contains an array of one 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. You can also add attachments to some other objects, such as customers, vendors, and employees. It's important to note that each transaction or object 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/). The folder to hold an attachment must exist before you create the attachment. You can also move an attachment to a different folder after it's created. x-displayName: Attachments - 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. x-displayName: Contacts - name: Department group members description: Department group member represents a department in a department group. x-displayName: Department group members - name: Department groups description: >- A department group is a specified set of departments, or a set of departments that meet certain criteria. You can use groups to filter or display information in multiple ways, for instance by showing data from only certain departments. x-displayName: Department groups - 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: Document sequence rollovers description: > The document sequence rollover configuration holds the next number or alpha values used to generate sequences for each fiscal year. When rollover is enabled for a document sequence, a restart of the document sequence is initiated for each fiscal year. If the configuration for a fiscal year is missing, 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 from the base start values are used. x-displayName: Document sequence rollovers - 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. Note: Document sequences are called "accounting sequences" in the General Ledger. x-displayName: Document sequences - name: Earning types description: >- Earning types are a key component in configuring the system to post project labor costs to one or more General Ledger journals. After creating earning types, they must be assigned to employees before the system can begin posting labor costs to a General Ledger journal. x-displayName: Earning types - 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. x-displayName: Email templates - name: Employee bank file setups description: >- A bank file enables electronic payments to be made to employees using a local bank file format. Bank files are standard files used by banks to make multiple payments. x-displayName: Employee bank file setups - name: Employee rates description: >- The employee rate object provides information about compensation for a specified employee and date range. The rate can be either hourly or annual. x-displayName: Employee rates - name: Employee types description: > An employee type is a user-defined or default type for an employee, usually related to payroll requirements. Examples include full time, part time, intern, and so forth. x-displayName: Employee types - name: Employees description: >- An employee object represents someone who executes work for a company and is associated with financial transactions such as timesheet entries or expenses. If the employee is also a user in Sage Intacct (which is required if they will be entering time or expenses), the employee and user must be associated with the same Sage Intacct contact. x-displayName: Employees - 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. x-displayName: Entities - name: Exchange rate lines description: Exchange rate line items represent entries in an exchange rate object. x-displayName: Exchange rate lines - name: Exchange rate types description: >- An exchange rate type enables an organization to process foreign currency transactions, such as foreign currency invoices and bills, using exchange rates specific to the business requirements. You can use a custom exchange rate type for global consolidation, or to override the standard Intacct daily rate type. See [Exchange rate types](https://www.intacct.com/ia/docs/en_US/help_action/Company/Currencies_and_exchange_rates/Exchange_rate_types/exchange-rate-types.htm) for more information. x-displayName: Exchange rate types - name: Exchange rates description: >- A custom exchange rate to convert one currency to another, if a company does not want to use the Intacct Daily Rate. An exchange rate contains an array of lines that each contain an effective start date, rate, and reciprocal rate to be used for transactions. x-displayName: Exchange rates - name: Attachment folders description: >- Folders 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. x-displayName: Attachment folders - name: Get next value x-displayName: Get next value - name: Dimensions description: >- Dimensions are a classification system used to organize, sort, and report on company information in meaningful ways. You can think of each dimension as a category with a set of values that you can apply to transactions and entries. Every transaction can be tagged with multiple dimension values to identify and report on it. For example, you can tag transactions with pre-defined locations, and then generate reports to show sales by each location. x-displayName: Dimensions - name: Location group members description: Location group member represents a location in a location group. x-displayName: Location group members - name: Location groups description: >- A location group is a specified set of locations, or a set of locations that meet certain criteria. You can use groups to filter or display information in multiple ways, for instance by showing data from only certain locations. x-displayName: Location groups - 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: Permissions description: > Each specific role is associated with particular modules, and each module contains multiple permissions. When assigning a permission to a specific role, there is validation that ensures that the specified permissions are allowed for the role. x-displayName: Permissions - name: Role permission assignments description: >- This object shows permission-to-role relationships and access rights for each specific permission. x-displayName: Role permission assignments - name: Role user group maps description: This object provides information about the roles assigned to user groups. x-displayName: Role user group maps - name: Role user maps description: This object provides information about the roles assigned to users. x-displayName: Role user maps - 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. x-displayName: Roles - name: User groups description: >- User groups help you manage the permissions and access of users that have the same roles or responsibilities. After you add a user to a user group, they automatically inherit all permissions and access assigned to that user group. x-displayName: User groups - 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. Any person that wants to log in through the UI or API must have a unique user record. x-displayName: Users paths: /objects/company-config/affiliate-entity-group: get: summary: List affiliate entity groups description: >+ Returns a collection with a key, ID, and link for each affiliate entity group. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View Affiliate Entity Groups
tags: - Affiliate entity groups operationId: list-company-config-affiliate-entity-group responses: '200': description: OK content: application/json: schema: type: object title: List of affiliate entity group objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List affiliate entity groups: value: ia::result: - key: '3' id: u href: /objects/company-config/affiliate-entity-group/3 - key: '1' id: Aff_Grp_USA href: /objects/company-config/affiliate-entity-group/1 - key: '2' id: Aff_Group_Other href: /objects/company-config/affiliate-entity-group/2 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an affiliate entity group description: >+ Creates a new affiliate entity group.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View, Add Affiliate Entity Groups
tags: - Affiliate entity groups operationId: create-company-config-affiliate-entity-group requestBody: description: Creates a new affiliate entity group. required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-affiliate-entity-group' - $ref: '#/components/schemas/company-config-affiliate-entity-groupRequiredProperties' examples: Create an affiliate entity group: value: id: Aff_3M name: Aff_Grp_specific description: affiliate group with 3 members groupType: specific groupMembers: - id: '2' - id: '1' - id: GM responses: '201': description: Created content: application/json: schema: type: object title: New affiliate-entity-group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new affiliate entity group: value: ia::result: key: '9' id: Aff_3M href: /objects/company-config/affiliate-entity-group/9 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/affiliate-entity-group/{key}: parameters: - name: key description: System-assigned unique key for the affiliate entity group. in: path required: true schema: type: string example: '172' get: summary: Get an affiliate entity group description: >+ Returns detailed information for a specified affiliate entity group.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View Affiliate Entity Groups
tags: - Affiliate entity groups operationId: get-company-config-affiliate-entity-group-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the affiliate entity group properties: ia::result: $ref: '#/components/schemas/company-config-affiliate-entity-group' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an affiliate entity group: value: ia::result: key: '9' id: Aff_3M name: Aff_Grp_specific description: affiliate group with 3 members groupType: specific memberFilter: object: company-config/affiliate-entity filterExpression: and orderBy: - name: asc audit: createdDateTime: '2024-08-07T11:44:26Z' modifiedDateTime: '2024-08-07T11:44:26Z' createdBy: '1' modifiedBy: '1' groupMembers: - key: '2' id: '2' name: India href: /objects/company-config/affiliate-entity/2 - key: '1' id: '1' name: United States of America href: /objects/company-config/affiliate-entity/1 - key: '11' id: GM name: Gulf of Mexico href: /objects/company-config/affiliate-entity/11 href: /objects/company-config/affiliate-entity-group/9 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an affiliate entity group description: >+ Updates an existing affiliate entity group by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View, Edit Affiliate Entity Group
tags: - Affiliate entity groups operationId: update-company-config-affiliate-entity-group-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-affiliate-entity-group' - type: object properties: id: readOnly: true examples: Update an affiliate entity group: value: name: Aff_Grp_specific description: Affiliate entity group udpated to member 1 only groupType: specific groupMembers: - key: '1' id: '1' description: Updates an affiliate entity group responses: '200': description: OK content: application/json: schema: type: object title: Updated affiliate entity group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated affiliate entity group: value: ia::result: key: '9' id: Aff_3M href: /objects/company-config/affiliate-entity-group/9 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an affiliate entity group description: >+ Deletes an affiliate entity group.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View, Delete Affiliate Entity Group
tags: - Affiliate entity groups operationId: delete-company-config-affiliate-entity-group-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/affiliate-entity: get: summary: List affiliate entities description: >+ Returns a collection with a key, ID, and link for each affiliate entity. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View Affiliate Entities
tags: - Affiliate entities operationId: list-company-config-affiliate-entity responses: '200': description: OK content: application/json: schema: type: object title: List of affiliate entity objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List affiliate entities: value: ia::result: - key: '1' id: '1' href: /objects/company-config/affiliate-entity/1 - key: '2' id: '2' href: /objects/company-config/affiliate-entity/2 - key: '3' id: '3' href: /objects/company-config/affiliate-entity/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/affiliate-entity/{key}: parameters: - name: key description: System-assigned unique key for the affiliate entity. in: path required: true schema: type: string example: '23' get: summary: Get an affiliate entity description: >+ Returns detailed information for a specified affiliate entity.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View Affiliate Entities
tags: - Affiliate entities operationId: get-company-config-affiliate-entity-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the affiliate entity properties: ia::result: $ref: '#/components/schemas/company-config-affiliate-entity' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an affiliate entity: value: ia::result: key: '1' id: '1' name: United States of America status: active audit: createdDateTime: '2016-06-27T00:00:00Z' modifiedDateTime: '2024-06-14T00:00:00Z' createdBy: '1' modifiedBy: '1' href: /objects/company-config/affiliate-entity/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/attachment: get: summary: List attachments description: >+ Returns a 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
SubscriptionCompany
User typeBusiness, Employee, Project Manager, Platform, and Warehouse
PermissionsList Attachments
tags: - Attachments operationId: list-company-config-attachment 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 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: 2024 Taxes href: /objects/company-config/attachment/2 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an attachment description: >+ Creates a new attachment in a specified folder. The folder must exist before you create the attachment. You can add files when you create an attachment, or use a PATCH request to add files later.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsAdd 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: 2024 Tax name: 2024 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
SubscriptionCompany
User typeBusiness, Employee, Project Manager, Platform, and Warehouse
PermissionsList 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: Get an attachment: value: ia::result: key: '17' id: INV-V1 name: Vendor 1 Invoices folder: id: Invoices key: '1' href: /objects/company-config/folder/1 description: Invoices for Vendor 1 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
SubscriptionCompany
User typeBusiness
PermissionsEdit 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 an attachment and all files that it contains. You must first remove the attachment from any objects or transactions.
Permissions and other requirements
SubscriptionCompany
User typeBusiness, Employee, Project Manager, Platform, and Warehouse
PermissionsList Attachments
tags: - Attachments operationId: delete-company-config-attachment-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
SubscriptionCompany
User typeBusiness, Employee, Payment Approver
PermissionsList, 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
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsAdd 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
SubscriptionCompany
User typeBusiness, Employee, Payment Approver
PermissionsList, 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
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsEdit 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
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsDelete 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
SubscriptionCompany
User typeBusiness, Employee, Payment Approver
PermissionsList, 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: Larry Spencer href: /objects/company-config/contact/265 - key: '263' id: John Doe href: /objects/company-config/contact/263 - key: '264' id: Alfred Mike href: /objects/company-config/contact/264 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a contact description: >+ Creates a new contact. The contact's `entity` fields will be set to the entity that the OAuth access token is associated with when the contact is created.
Permissions and other requirements
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsAdd Contacts
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 reference properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new contact: 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 a 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
SubscriptionCompany
User typeBusiness, Employee, Payment Approver
PermissionsList, 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: Contact details: 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 priceSchedule: id: null key: null discount: null priceList: id: null key: null entity: key: '54' id: Western Region name: Western Region href: /objects/company-config/entity/54 href: /objects/company-config/contact/1257 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '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
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsEdit 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: Assign a price list and set a contact as non-taxable: value: priceList: id: Best customer pricing tax: isTaxable: false responses: '200': description: OK content: application/json: schema: type: object title: Updated contact reference properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated contact: value: ia::result: key: '312' id: JohnD 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
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsDelete 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-group-member: get: summary: List department group members description: >- Returns a collection with a key, ID, and link for each department group member. tags: - Department group members operationId: list-company-config-department-group-member responses: '200': description: OK content: application/json: schema: type: object title: List of department-group-member objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of Department group Members: value: ia::result: - key: '1' id: '1' href: /objects/company-config/department-group-member/1 - key: '3' id: '3' href: /objects/company-config/department-group-member/3 - key: '13' id: '13' href: /objects/company-config/department-group-member/13 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/department-group-member/{key}: parameters: - name: key description: System-assigned unique key for the department group member. in: path required: true example: '42' schema: type: string get: summary: Get a department group member description: Returns detailed information for a specified department group member. tags: - Department group members operationId: get-company-config-department-group-member-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the department-group-member properties: ia::result: $ref: '#/components/schemas/company-config-department-group-member' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the department group member: value: ia::result: key: '1' id: '1' departmentGroup: key: '1' href: /objects/company-config/department-group/1 department: id: '8' key: '8' name: Finance href: /objects/company-config/department/8 sortOrder: 0 audit: createdDateTime: '2016-10-26T17:28:33Z' modifiedDateTime: '2016-10-26T17:28:33Z' createdBy: '1' modifiedBy: '1' href: /objects/company-config/department-group-member/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/department-group: get: summary: List department groups description: > Returns up to 100 department groups from the collection with a key, ID, and link for each group. This operation is mostly for use in testing; use the query service to find department groups that meet certain criteria and specify the properties that are returned. tags: - Department groups operationId: list-company-config-department-group responses: '200': description: OK content: application/json: schema: type: object title: List of department groups properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of department groups: value: ia::result: - key: '3' id: Accounting href: /objects/company-config/department-group/3 - key: '1' id: Finance href: /objects/company-config/department-group/1 - key: '2' id: HR href: /objects/company-config/department-group/2 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a department group description: Creates a new department group. tags: - Department groups operationId: create-company-config-department-group requestBody: description: Creates a new department group. required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-department-group' - $ref: '#/components/schemas/company-config-department-groupRequiredProperties' examples: Create a department group type all: value: id: HR name: Human Resources groupType: all memberFilter: object: company-config/department filterExpression: and filters: - $eq: name: Accounting orderBy: - name: asc responses: '201': description: Created content: application/json: schema: type: object title: New department group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new department group: value: ia::result: key: '19' id: HR href: /objects/company-config/department-group/19 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/department-group/{key}: parameters: - name: key description: System-assigned key for the department group. in: path required: true example: '18' schema: type: string get: summary: Get a department group description: Returns detailed information for a specified department group. tags: - Department groups operationId: get-company-config-department-group-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the department group properties: ia::result: $ref: '#/components/schemas/company-config-department-group' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the department group: value: ia::result: key: '1' id: Top Departments name: Top Level Departments description: Top Level Departments groupType: specific memberFilter: object: company-config/department filterExpression: and orderBy: - name: asc audit: createdDateTime: '2023-10-26T00:00:00Z' modifiedDateTime: '2023-10-26T00:00:00Z' createdBy: '1' modifiedBy: '1' groupMembers: - key: '1' id: '1' departmentGroup: key: '1' href: /objects/company-config/department-group/1 department: id: FI key: '8' name: Finance href: /objects/company-config/department/1 audit: createdDateTime: '2024-10-26T17:28:33Z' modifiedDateTime: '2024-10-26T17:28:33Z' createdBy: '1' modifiedBy: '1' href: /objects/company-config/department-group-member/1 href: /objects/company-config/department-group/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a department group description: >- Updates an existing department group by setting field values. Any fields not provided remain unchanged. New values for any arrays will replace the existing array. tags: - Department groups operationId: update-company-config-department-group-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-department-group' - type: object properties: id: readOnly: true examples: Update a department group: value: description: My Top departments America memberFilter: object: company-config/department filterExpression: and filters: - $eq: name: Accounting orderBy: - name: asc responses: '200': description: OK content: application/json: schema: type: object title: Updated department group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated department group: value: ia::result: key: '12' id: my top department href: /objects/company-config/department-group/12 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a department group description: Deletes a department group. tags: - Department groups operationId: delete-company-config-department-group-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
SubscriptionCompany
User typeBusiness, Employee, Payment Approver
PermissionsList, 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
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsAdd 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
SubscriptionCompany
User typeBusiness, Employee, Payment Approver
PermissionsList, 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
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsEdit 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
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsDelete Departments
tags: - Departments operationId: delete-company-config-department-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/document-sequence-rollover: get: summary: List document sequence rollovers description: >- Returns a collection with a key, ID, and link for each document sequence rollover object. tags: - Document sequence rollovers operationId: list-company-config-document-sequence-rollover responses: '200': description: OK content: application/json: schema: type: object title: List of fiscal year configuration objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List document sequence rollover objects: value: ia::result: - key: '651' id: '651' href: /objects/company-config/document-sequence-rollover/651 - key: '652' id: '652' href: /objects/company-config/document-sequence-rollover/652 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/document-sequence-rollover/{key}: parameters: - name: key description: System-assigned unique key for the document sequence rollover object. in: path required: true schema: type: string example: '28' get: summary: Get a document sequence rollover description: >- Returns detailed information for a specified document sequence rollover object. tags: - Document sequence rollovers operationId: get-company-config-document-sequence-rollover-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the fiscal year configuration properties: ia::result: $ref: '#/components/schemas/company-config-document-sequence-rollover' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a document sequence rollover: value: ia::result: id: '651' key: '651' documentSequence: key: '107' id: BOA_ACH_BatchNo href: /objects/company-config/document-sequence/107 fiscalYear: 2026 nextNumber: 2026 nextSequence: null audit: createdDateTime: '2024-02-14T12:55:25Z' modifiedDateTime: '2024-02-14T12:55:25Z' createdBy: '109' modifiedBy: '109' href: /objects/company-config/document-sequence-rollover/651 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '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 example: '139' 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 entity: key: '54' id: Western Region name: Western Region href: /objects/company-config/entity/54 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/earning-type: get: summary: List earning types description: Returns a collection with a key, ID, and link for each earning type. tags: - Earning types operationId: get-objects-company-config-earning-type responses: '200': description: OK content: application/json: schema: type: object title: List of Earning types properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List earning types: value: ia::result: - key: '46' id: Overtime name: Overtime href: /objects/time/earning-type/46 - key: '44' id: Part time name: Part time href: /objects/time/earning-type/44 - key: '40' id: Full time name: Full time href: /objects/time/earning-type/40 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an earning type description: Creates a new earning type. tags: - Earning types operationId: create-objects-company-config-earning-type-key requestBody: description: '' required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-earning-type' - $ref: '#/components/schemas/company-config-earning-typeRequiredProperties' examples: Create an earning type: value: id: Over time billableGLAccount: key: '158' nonBillableGLAccount: key: '159' rateMultiplier: '2' calculationMethod: hourly responses: '201': description: Created content: application/json: schema: type: object title: New earning-type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new earning type: value: ia::result: key: '10' id: '10' href: /objects/time/earning-type/10 ia::meta: totalCount: 3 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/earning-type/{key}: parameters: - schema: type: string name: key in: path required: true description: System-assigned key for the earning type. example: '100' get: summary: Get an earning type description: Returns detailed information for a specified earning type. tags: - Earning types responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/company-config-earning-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an earning type: value: ia::result: key: '1' id: Over time billableGLAccount: key: '158' id: '6775.30' name: Travel href: /objects/general-ledger/account/23 nonBillableGLAccount: key: '158' id: '6774.30' name: Expense href: /objects/general-ledger/account/23 rateMultiplier: '2' calculationMethod: hourly audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': description: Bad Request operationId: get-company-config-earning-type-key security: - OAuth2: [] patch: summary: Update an earning type description: >- Updates an existing earning type by setting field values. Any fields not provided remain unchanged. tags: - Earning types operationId: patch-objects-company-config-earning-type-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-earning-type' - type: object properties: id: readOnly: true examples: Update an earning type: value: rateMultiplier: '20' responses: '200': description: OK content: application/json: schema: type: object title: Updated earning-type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated earning type: value: ia::result: key: '10' id: Overtime href: /objects/time/earning-type/10 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an earning type operationId: delete-objects-company-config-earning-type-key description: Deletes an earning type. tags: - Earning types 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 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: Create an email template: value: name: New Customer Email Template description: Email template for new customers templateType: purchasingTxn email: replyTo: someEmail@co.com to: someEmail@co.com subject: Welcome! body: >- New customers receive a 10% discount on their first subscription order. 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 example: '90' 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: Get an email template: value: id: 12 key: 12 audit: createdDateTime: '2023-10-20T11:31:45Z' modifiedDateTime: '2023-10-20T11:31:45Z' createdBy: '1' modifiedBy: '1' status: active name: New Customer 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: Welcome! body: >- New customers receive a 10% discount on their first subscription order. logo: isLogoIncluded: true verticalPosition: bottom horizontalPosition: left includeTxnAttachments: false includeProjectInvoiceTxnAttachments: false useSendersPreferredDateFormat: true href: /objects/company-config/email-template/12 '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: Reference to 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: Update an email template: value: name: New Customer Email SW email: to: someEmail@co.com includeTxnAttachments: true 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: [] /objects/company-config/employee-bank-file-setup: get: summary: List employee bank file setups description: >- Returns a collection with a key, ID, and link for each employee bank file setup. tags: - Employee bank file setups operationId: list-company-config-employee-bank-file-setup responses: '200': description: OK content: application/json: schema: type: object title: List of employee-bank-file-setup objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List employee bank file setups: value: ia::result: - key: '25' id: '25' href: /objects/company-config/employee-bank-file-setup/25 - key: '85' id: '85' href: /objects/company-config/employee-bank-file-setup/85 - key: '60' id: '60' href: /objects/company-config/employee-bank-file-setup/60 ia::meta: totalCount: 3 start: 1 pageSize: 100 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/employee-bank-file-setup/{key}: parameters: - name: key description: System-assigned key for the employee bank file setup. in: path required: true schema: type: string example: '120' get: summary: Get an employee bank file setup description: Returns detailed information for a specified employee bank file setup. tags: - Employee bank file setups operationId: get-company-config-employee-bank-file-setup-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the employee-bank-file-setup properties: ia::result: $ref: '#/components/schemas/company-config-employee-bank-file-setup' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a bank file setup for South Africa (ZA): value: ia::result: key: '25' id: '25' employee: key: '202' id: SAEmployee href: /objects/company-config/employee/202 paymentReference: Supplier Inc branchCode: '123433' bankAccountType: '1' bankAccountCode: '345678' proofOfPayment: true bankAccountNumber: '87402896' bankAccountName: Jane Blogs Corp href: /objects/company-config/employee-bank-file-setup/25 ia::meta: totalCount: 1 Get a bank file setup for Australia (AU): value: ia::result: key: '2' id: '2' employee: key: '162' id: AUEmployee href: /objects/company-config/employee/162 bsbNumber: 163-821 paymentReference: Supplier Inc bankAccountNumber: '87402896' bankAccountName: Au Bank Corp href: /objects/company-config/employee-bank-file-setup/2 ia::meta: totalCount: 1 Get a bank file setup for United Kingdom (GB): value: ia::result: key: '26' id: '26' employee: key: '203' id: UKEmployee href: /objects/company-config/employee/203 bsbNumber: null paymentReference: BACS HSBC corp sortCode: '849571' bankAccountNumber: '87402896' bankAccountName: UK Bank Corp. href: /objects/company-config/employee-bank-file-setup/26 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/employee-rate: get: summary: List employee rates description: >+ Returns a collection with a key, ID, and link for each employee rate. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionCompany
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Employees
tags: - Employee rates operationId: list-projects-employee-rate responses: '200': description: OK content: application/json: schema: type: object title: List of employee rate objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List employee rates: value: ia::result: - key: '1' id: '1' href: /objects/company-config/employee-rate/1 - key: '3' id: '3' href: /objects/company-config/employee-rate/3 - key: '5' id: '5' href: /objects/company-config/employee-rate/5 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/employee-rate/{key}: parameters: - name: key description: System-assigned unique key for the employee rate. in: path required: true schema: type: string example: '135' get: summary: Get an employee rate description: >+ Returns detailed information for a specified employee rate.
Permissions and other requirements
SubscriptionCompany
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Employees
tags: - Employee rates operationId: get-projects-employee-rate-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the employee rate properties: ia::result: $ref: '#/components/schemas/company-config-employee-rate' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an employee rate: value: ia::result: id: '111' key: '111' employee: key: '1' id: '1' name: 1099 Int href: /objects/company-config/employee/1 hourlyRate: '50001' annualSalary: null startDate: '2023-01-01' endDate: '2023-12-31' href: /objects/company-config/employee-rate/111 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee rate description: >+ Deletes an employee rate.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View, Delete Employees
tags: - Employee rates operationId: delete-company-config-employee-rate-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/employee-type: get: summary: List employee types description: >+ Returns a collection with a key, ID, and link for each employee type. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionTime and Expenses
User typeBusiness, Employee, Project Manager, and Warehouse
PermissionsList, View Employee Type
tags: - Employee types operationId: list-company-config-employee-type responses: '200': description: OK content: application/json: schema: type: object title: List of employee type objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List employee types: value: ia::result: - key: '100' id: Part-time href: /objects/company-config/employee-type/100 - key: '101' id: Full-time href: /objects/company-config/employee-type/101 - key: '102' id: Contractor href: /objects/company-config/employee-type/102 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an employee type description: >+ Creates a new employee type.
Permissions and other requirements
SubscriptionCompany, Projects, Time and Expenses
User typeBusiness
PermissionsList, View, Add Employee Type
tags: - Employee types operationId: create-company-config-employee-type requestBody: description: Employee type to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-employee-type' - $ref: '#/components/schemas/company-config-employee-typeRequiredProperties' examples: Create an employee type: value: id: Internal parent: key: '12' status: active responses: '201': description: Created content: application/json: schema: type: object title: New employee type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new employee type: value: ia::result: key: '1' id: Internal href: /objects/company-config/employee-type/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/employee-type/{key}: parameters: - name: key description: System-assigned unique key for the employee type. in: path required: true schema: type: string example: '88' get: summary: Get an employee type description: |+ Returns detailed information for a specified employee type.
Permissions and other requirements
SubscriptionTime and Expenses
User typeBusiness
PermissionsList, View Employee type
tags: - Employee types operationId: get-company-config-employee-type-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the employee type properties: ia::result: $ref: '#/components/schemas/company-config-employee-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the employee type: value: ia::result: key: '23' id: Part-time Overseas contractor href: /objects/company-config/employee-type/23 parent: href: /objects/company-config/employee-type/7 id: Contractor key: '7' form1099: type: MISC box: '3' status: active audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' entity: key: '46' id: Western Region name: Western Region href: /objects/company-config/entity/46 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an employee type description: >+ Updates an existing employee type by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionTime and Expenses
User typeBusiness
PermissionsList, View, Edit Employee Type
tags: - Employee types operationId: update-company-config-employee-type-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-employee-type' - type: object properties: id: readOnly: true examples: Set status to inactive: value: status: inactive responses: '200': description: OK content: application/json: schema: type: object title: Employee type updated properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated employee type: value: ia::result: key: '1' id: Internal href: /objects/company-config/employee-type/1 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee type description: >+ Deletes an employee type.
Permissions and other requirements
SubscriptionCompany or Projects
User typeBusiness, Employee, Approval, CRM
PermissionsList, View, Add, Edit Employees
tags: - Employee types operationId: delete-company-config-employee-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/employee: get: summary: List employees description: >+ Returns a collection with a key, ID, and link for each employee. This operation is mostly for use in testing; use query to find employees that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionCompany
User typeBusiness, Employee, Project Manager, and Warehouse
PermissionsList Employees
tags: - Employees operationId: list-company-config-employee responses: '200': description: OK content: application/json: schema: type: object title: List of employee objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List employees: value: ia::result: - key: '32' id: jsmith href: /objects/company-config/employee/32 - key: '52' id: rdas href: /objects/company-config/employee/52 - key: '17' id: ajones href: /objects/company-config/employee/17 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an employee description: >+ Creates a new employee. If the employee is also a user in Sage Intacct (which is required if they will be entering time or expenses), set the `primaryContact` to the same contact that is associated with the user.
Permissions and other requirements
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsAdd Employees
tags: - Employees operationId: create-company-config-employee requestBody: description: Employee to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-employee' - $ref: '#/components/schemas/company-config-employeeRequiredProperties' examples: Create a new employee: value: id: jSmith SSN: '650125930' jobTitle: Accountants startDate: '2021-04-30' birthDate: '1984-04-01' name: John Smith defaultCurrency: USD manager: id: rkincaid location: id: WA department: id: ACCT earningType: id: Salaried postActualCostWithVariance: false employeeType: id: Full Time primaryContact: id: rkincaid attachmentFolder: key: '232' preferredPaymentMethod: cash responses: '201': description: Created content: application/json: schema: type: object title: New employee reference properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new employee: value: ia::result: key: '52' id: Emp3 href: /objects/company-config/employee/52 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/employee/{key}: parameters: - name: key description: System-assigned key of an employee. in: path required: true schema: type: string example: '63' get: summary: Get an employee description: >+ Returns detailed information for a specified employee.
Permissions and other requirements
SubscriptionCompany
User typeBusiness, Employee, Project Manager, and Warehouse
PermissionsView Employees
tags: - Employees responses: '200': description: OK content: application/json: schema: type: object title: Details of the employee properties: ia::result: $ref: '#/components/schemas/company-config-employee' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an employee: value: ia::result: key: '63' id: jSmith SSN: '650125930' jobTitle: Accountant location: id: '1' key: '1' name: United States of America href: /objects/company-config/location/1 department: id: '3' key: '3' name: Engineering href: /objects/company-config/department/3 manager: key: '24' id: '11' name: jsmith href: /objects/company-config/employee/24 birthDate: '1984-04-13' startDate: '2021-04-30' endDate: null status: active employeeType: id: Full Time key: '6' href: /objects/company-config/employee-type/6 gender: male terminationType: null name: jsmith primaryContact: mailingAddress: addressLine1: 744 Edgewater Blvd addressLine2: 'null' city: Kansas City country: United States isoCountryCode: US postCode: '66104' state: KS URL1: http://smith.com URL2: null companyName: Sage email1: jsmith@mycompany.com email2: null fax: '9134598677' firstName: John id: jsmith lastName: Smith middleName: null mobile: '9133132299' pager: null phone1: '9134598676' phone2: null prefix: Mr printAs: John Smith key: '68' href: /objects/company-config/contact/68 attachmentFolder: id: Admin Default Folder key: '6' href: /objects/company-config/folder/6 defaultCurrency: USD form1099: name: John Smith type: A box: D earningType: key: '1' id: Salaries href: /objects/company-config/earning-type/1 postActualCostWithVariance: false audit: createdDateTime: '2022-04-01T16:20:00Z' modifiedDateTime: '2022-04-01T16:20:00Z' createdBy: '1' modifiedBy: '95' class: id: null name: null key: null preferredPaymentMethod: cash bankFile: paymentCurrency: EUR paymentCountryCode: gb filePaymentService: none ach: enabled: false bankRoutingNumber: null accountNumber: null accountType: null remittanceType: null sendAutomaticPaymentNotification: true isPlaceholderResource: false mergePaymentRequests: true employeePosition: key: '1' id: writer entity: key: '46' id: Western Region name: Western Region href: /objects/company-config/entity/46 employeeRates: [] positionSkills: [] bankFileSetup: [] href: /objects/company-config/employee/63 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' operationId: get-company-config-employee-key security: - OAuth2: [] patch: summary: Update an employee description: >+ Updates an existing employee by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsEdit Employees
tags: - Employees operationId: update-company-config-employee-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-employee' - type: object properties: id: readOnly: true examples: Update when an employee resigns: value: status: inactive endDate: '2023-04-01' terminationType: voluntary responses: '200': description: OK content: application/json: schema: type: object title: Updated employee properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated employee: value: ia::result: key: '52' id: Emp2 href: /objects/company-config/employee/52 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee description: >+ Deletes an employee.
Permissions and other requirements
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsDelete Employees
tags: - Employees operationId: delete-company-config-employee-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: Creates an entity: value: id: Hungary name: Hungary 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' isLimitedEntity: false 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 example: '56' 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: Get an entity: 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 legalCategory: 24 Fiduciary mainActivity: >- 10.3 Transformation and conservation of fruits and vegetables typeOfCompany: 03 Intermediate sized enterprises registeredCapital: 500 valueAddedTaxRegime: Monthly 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' siret: '01234567890123456789' 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: france 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' isLimitedEntity: false 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: Updated entity 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: 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: Deletes an entity. tags: - Entities operationId: delete-company-config-entity-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/exchange-rate-line: get: summary: List exchange rate lines description: >+ Returns a collection with a key, ID, and link for each exchange rate line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View Exchange Rates
tags: - Exchange rate lines operationId: list-company-config-exchange-rate-line responses: '200': description: OK content: application/json: schema: type: object title: List of exchange rate line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List exchange rate lines: value: ia::result: - key: '85' id: '85' href: /objects/company-config/exchange-rate-line/85 - key: '86' id: '86' href: /objects/company-config/exchange-rate-line/86 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an exchange rate line description: >+ Creates a new exchange rate line.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View, Add Exchange Rates
tags: - Exchange rate lines operationId: create-company-config-exchange-rate-line requestBody: description: Create an exchange rate line. required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-exchange-rate-line' - $ref: '#/components/schemas/company-config-exchange-rate-lineRequiredProperties' examples: Create an exchange rate line: value: exchangeRate: key: '40' effectiveStartDate: '2024-12-30' rate: 1.555 responses: '201': description: Created content: application/json: schema: type: object title: New exchange rate line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new exchange rate line: value: ia::result: key: '87' id: '87' href: /objects/company-config/exchange-rate-line/87 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/exchange-rate-line/{key}: parameters: - name: key description: System-assigned unique key for the exchange rate line. in: path required: true schema: type: string example: '87' get: summary: Get an exchange rate line description: >+ Returns detailed information for a specified exchange rate line.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View Exchange Rates
tags: - Exchange rate lines operationId: get-company-config-exchange-rate-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the exchange rate line properties: ia::result: $ref: '#/components/schemas/company-config-exchange-rate-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an exchange rate line: value: ia::result: id: '87' key: '87' exchangeRate: id: '40' key: '40' href: /objects/company-config/exchange-rate/40 effectiveStartDate: '2024-12-30' rate: 1.555 reciprocalRate: 0.64308682 audit: createdDateTime: '2023-11-08T13:02:58Z' modifiedDateTime: '2023-11-08T13:02:58Z' createdBy: '1' modifiedBy: '1' href: /objects/company-config/exchange-rate-line/87 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an exchange rate line description: >+ Updates an existing exchange rate line by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View, Edit Exchange Rates
tags: - Exchange rate lines operationId: update-company-config-exchange-rate-line-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-exchange-rate-line' - type: object properties: effectiveStartDate: type: string format: date readOnly: true exchangeRate: readOnly: true examples: Update an exchange rate line: value: rate: 1 reciprocalRate: 0.5 responses: '200': description: OK content: application/json: schema: type: object title: Updated exchange rate line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated exchange rate line: value: ia::result: key: '87' id: '87' href: /objects/company-config/exchange-rate-line/87 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an exchange rate line description: >+ Deletes an exchange rate line.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View, Delete Exchange Rates
tags: - Exchange rate lines operationId: delete-company-config-exchange-rate-line-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/exchange-rate-type: get: summary: List exchange rate types description: >+ Returns a collection with a key, ID, and link for each exchange rate type. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View Exchange Rate Types
tags: - Exchange rate types operationId: list-company-config-exchange-rate-type responses: '200': description: OK content: application/json: schema: type: object title: List of exchange rate type objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List exchange rate types: value: ia::result: - key: '1' id: '1' href: /objects/company-config/exchange-rate-type/1 - key: '2' id: '2' href: /objects/company-config/exchange-rate-type/2 - key: '3' id: '3' href: /objects/company-config/exchange-rate-type/3 - key: '4' id: '4' href: /objects/company-config/exchange-rate-type/4 ia::meta: totalCount: 4 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an exchange rate type description: >+ Creates a new exchange rate type.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View, Add Exchange Rate Types
tags: - Exchange rate types operationId: create-company-config-exchange-rate-type requestBody: description: Create an exchange rate type. required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-exchange-rate-type' - $ref: '#/components/schemas/company-config-exchange-rate-typeRequiredProperties' examples: Create an exchange rate type: value: name: CUS-Rate isDefault: true responses: '201': description: Created content: application/json: schema: type: object title: New exchange rate type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new exchange rate type: value: ia::result: key: '5' id: '5' href: /objects/company-config/exchange-rate-type/5 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/exchange-rate-type/{key}: parameters: - name: key description: System-assigned unique key for the exchange rate type. in: path required: true schema: type: string example: '5' get: summary: Get an exchange rate type description: >+ Returns detailed information for a specified exchange rate type.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View Exchange rate types
tags: - Exchange rate types operationId: get-company-config-exchange-rate-type-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the exchange rate type properties: ia::result: $ref: '#/components/schemas/company-config-exchange-rate-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an exchange rate type: value: ia::result: key: '5' id: '5' name: CUS-Rate isDefault: false audit: createdDateTime: '2023-09-28T13:27:58Z' modifiedDateTime: '2023-09-28T13:27:58Z' createdBy: '1' modifiedBy: '1' href: /objects/company-config/exchange-rate-type/5 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an exchange rate type description: >+ Updates an existing exchange rate type by setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View, Edit Exchange Rate Types
tags: - Exchange rate types operationId: update-company-config-exchange-rate-type-key requestBody: content: application/json: schema: $ref: '#/components/schemas/company-config-exchange-rate-type' examples: Set an exchange rate type as default: value: isDefault: true responses: '200': description: OK content: application/json: schema: type: object title: Updated exchange rate type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated exchange rate type: value: ia::result: key: '5' id: '5' href: /objects/company-config/exchange-rate-type/5 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an exchange rate type description: >+ Deletes an exchange rate type.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View, Delete Exchange Rate Types
tags: - Exchange rate types operationId: delete-company-config-exchange-rate-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/exchange-rate: get: summary: List exchange rates description: >- Returns a collection with a key, ID, and link for each exchange rate. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Exchange rates operationId: list-company-config-exchange-rate responses: '200': description: OK content: application/json: schema: type: object title: List of exchange rates properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List exchange rates: value: ia::result: - key: '40' id: '40' href: /objects/company-config/exchange-rate/40 - key: '41' id: '41' href: /objects/company-config/exchange-rate/41 - key: '42' id: '42' href: /objects/company-config/exchange-rate/42 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an exchange rate description: Creates a new exchange rate. tags: - Exchange rates operationId: create-company-config-exchange-rate requestBody: description: Exchange rate to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-exchange-rate' - $ref: '#/components/schemas/company-config-exchange-rateRequiredProperties' examples: Create an exchange rate with line items: value: exchangeRateType: key: '4' fromCurrency: USD toCurrency: CAD lines: - effectiveStartDate: '2023-08-15' rate: 2 - effectiveStartDate: '2021-09-16' rate: 3 reciprocalRate: 0.55 Create an exchange rate without line items: value: exchangeRateType: key: '3' fromCurrency: USD toCurrency: GBP responses: '201': description: Created content: application/json: schema: type: object title: New exchange-rate properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new exchange rate: value: ia::result: id: '40' key: '40' href: /objects/company-config/exchange-rate/40 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/exchange-rate/{key}: parameters: - name: key description: Key for an exchange rate. in: path required: true schema: type: string example: '40' get: summary: Get an exchange rate description: Returns detailed information for a specified exchange rate. tags: - Exchange rates operationId: get-company-config-exchange-rate-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the exchange-rate properties: ia::result: $ref: '#/components/schemas/company-config-exchange-rate' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an exchange rate: value: ia::result: id: '40' key: '40' exchangeRateType: key: '4' id: '4' name: GBP-Rate href: /objects/company-config/exchange-rate-type/4 fromCurrency: USD toCurrency: CAD audit: createdDateTime: '2023-11-08T12:30:38Z' modifiedDateTime: '2023-11-08T12:30:38Z' createdBy: '1' modifiedBy: '1' lines: - id: '84' key: '84' exchangeRate: id: '40' key: '40' href: /objects/company-config/exchange-rate/40 effectiveStartDate: '2023-08-15' rate: 2 reciprocalRate: 0.5 audit: createdDateTime: '2023-11-08T12:30:38Z' modifiedDateTime: '2023-11-08T12:30:38Z' createdBy: '1' modifiedBy: '1' href: /objects/company-config/exchange-rate-line/84 - id: '85' key: '85' exchangeRate: id: '40' key: '40' href: /objects/company-config/exchange-rate/40 effectiveStartDate: '2021-09-16' rate: 3 reciprocalRate: 0.55 audit: createdDateTime: '2023-11-08T12:30:38Z' modifiedDateTime: '2023-11-08T12:30:38Z' createdBy: '1' modifiedBy: '1' href: /objects/company-config/exchange-rate-line/85 href: /objects/company-config/exchange-rate/40 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an exchange rate description: >- Updates an existing exchange rate by setting field values. Any fields not provided remain unchanged. tags: - Exchange rates operationId: update-company-config-exchange-rate-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-exchange-rate' - type: object properties: exchangeRateType: readOnly: true toCurrency: readOnly: true examples: Update an exchange rate: value: fromCurrency: INR lines: - key: '85' rate: 4 reciprocalRate: 2.5555 - effectiveStartDate: '2023-11-18' rate: 5.5 responses: '200': description: OK content: application/json: schema: type: object title: Updated exchange-rate properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated exchange rate: value: ia::result: id: '40' key: '40' href: /objects/company-config/exchange-rate/40 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an exchange rate description: Deletes an exchange rate. tags: - Exchange rates operationId: delete-company-config-exchange-rate-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/folder: get: summary: List folders description: >+ Returns a 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
SubscriptionCompany
User typeBusiness, Employee, Project Manager, and Warehouse
PermissionsList 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: List folders: 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
SubscriptionCompany
User typeBusiness
PermissionsAdd 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: 2024 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: Reference to new folder: value: ia::result: key: '28' id: 2024 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 an 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
SubscriptionCompany
User typeBusiness, Employee, Project Manager, and Warehouse
PermissionsView 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: Get a folder: value: ia::result: key: '28' id: 2024 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
SubscriptionCompany
User typeBusiness
PermissionsEdit 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: Update folder description: value: description: 2024 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: Reference to updated folder: 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 sub-folders and attachments. You must first remove the attachments from any objects or transactions.
Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsDelete Attachment Folders
tags: - Attachment folders operationId: delete-company-config-folder-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /services/company-config/document-sequence/get-next-sequence: post: summary: Get next sequence value description: >- Increments and returns the next sequence value for a specified document sequence, optionally for a specified fiscal year. tags: - Get next value operationId: get-next-sequence-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/company-config-document-sequence-get-next-sequence-request' examples: Request next sequence value by ID: value: id: AR Inv Request next sequence value by ID for a fiscal year: value: id: AR Inv fiscalYear: 2024 Request next sequence value by key: value: key: '307' Request next sequence value by key for a fiscal year: value: key: '307' fiscalYear: 2024 responses: '200': description: Executed content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/company-config-document-sequence-get-next-sequence-response' ia::meta: $ref: '#/components/schemas/metadata' examples: Response for a request without fiscal year: value: ia::result: id: AR Inv nextSequence: INV-16 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 Response for a request with key and fiscal year: value: ia::result: key: '307' id: AR Inv nextSequence: P-0001-S-2024 fiscalYear: 2024 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /services/company-config/dimensions/list: get: summary: List dimensions description: >- Lists all standard and user-defined dimensions in a company along with integration information about each one. tags: - Dimensions operationId: get-company-config-dimensions-list responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: type: array items: $ref: '#/components/schemas/company-config-dimensions-list-response' ia::meta: $ref: '#/components/schemas/metadata' examples: Response: value: ia::result: - dimensionName: DEPARTMENT dimensionLabel: Department termName: Department isUserDefinedDimension: false isEnabledInGL: true dimensionEndpoint: /objects/company-config/department - dimensionName: LOCATION dimensionLabel: Location termName: Loc isUserDefinedDimension: false isEnabledInGL: true dimensionEndpoint: /objects/company-config/location - dimensionName: PROJECT dimensionLabel: Project termName: Project isUserDefinedDimension: false isEnabledInGL: true dimensionEndpoint: /objects/projects/project - dimensionName: CUSTOMER dimensionLabel: Customer termName: Customer isUserDefinedDimension: false isEnabledInGL: true dimensionEndpoint: /objects/accounts-receivable/customer - dimensionName: VENDOR dimensionLabel: Vendor termName: Vendor isUserDefinedDimension: false isEnabledInGL: true dimensionEndpoint: /objects/accounts-payable/vendor - dimensionName: EMPLOYEE dimensionLabel: Employee termName: Employee isUserDefinedDimension: false isEnabledInGL: true dimensionEndpoint: /objects/company-config/employee - dimensionName: ITEM dimensionLabel: Item termName: Item isUserDefinedDimension: false isEnabledInGL: true dimensionEndpoint: /objects/inventory-control/item - dimensionName: CLASS dimensionLabel: Class termName: Class isUserDefinedDimension: false isEnabledInGL: true dimensionEndpoint: /objects/company-config/class - dimensionName: CONTRACT dimensionLabel: Contract termName: Contract isUserDefinedDimension: false isEnabledInGL: false dimensionEndpoint: /objects/contracts/contract - dimensionName: TASK dimensionLabel: Task termName: Task isUserDefinedDimension: false isEnabledInGL: false dimensionEndpoint: /objects/projects/task - dimensionName: WAREHOUSE dimensionLabel: Warehouse termName: Warehouse isUserDefinedDimension: false isEnabledInGL: false dimensionEndpoint: /objects/inventory-control/warehouse - dimensionName: COSTTYPE dimensionLabel: Cost type termName: Cost type isUserDefinedDimension: false isEnabledInGL: false dimensionEndpoint: /objects/construction/cost-type - dimensionName: AFFILIATEENTITY dimensionLabel: Affiliate entity termName: Affiliate entity isUserDefinedDimension: false isEnabledInGL: false dimensionEndpoint: /objects/company-config/affiliate-entity - dimensionName: FIXEDASSET dimensionLabel: Asset termName: Asset isUserDefinedDimension: false isEnabledInGL: false dimensionEndpoint: /objects/fixed-assets/asset - dimensionName: CHANNEL dimensionLabel: Channel termName: Channel isUserDefinedDimension: true isEnabledInGL: true dimensionEndpoint: /objects/platform-apps/nsp::channel - dimensionName: DACIA dimensionLabel: dacia termName: dacia isUserDefinedDimension: true isEnabledInGL: true dimensionEndpoint: /objects/platform-apps/nsp::dacia ia::meta: totalCount: '15' totalSuccess: '15' totalError: '0' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/location-group-member: get: summary: List description: >- Returns a collection with a key, ID, and link for each location group member. tags: - Location group members operationId: list-company-config-location-group-member responses: '200': description: OK content: application/json: schema: type: object title: List of location group members properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of Location group Members: value: ia::result: - key: '1' id: '1' href: /objects/company-config/location-group-member/1 - key: '3' id: '3' href: /objects/company-config/location-group-member/3 - key: '13' id: '13' href: /objects/company-config/location-group-member/13 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/location-group-member/{key}: parameters: - name: key description: system-assigned unique key for the location group member. in: path required: true example: '13' schema: type: string get: summary: Get a location group member description: Returns detailed information for a particular location group member. tags: - Location group members operationId: get-company-config-location-group-member-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the location group member properties: ia::result: $ref: '#/components/schemas/company-config-location-group-member' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the location group member: value: ia::result: key: '13' id: '13' locationGroup: id: '6' key: '6' href: /objects/company-config/location-group/6 location: key: '1' id: '1' name: United States of America href: /objects/company-config/location/1 sortOrder: 0 audit: createdDateTime: '2018-05-01T22:37:18Z' modifiedDateTime: '2018-05-01T22:37:18Z' createdBy: '1' modifiedBy: '1' href: /objects/company-config/location-group-member/13 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/location-group: get: summary: List location groups description: > Returns up to 100 location groups from the collection with a key, ID, and link for each group. This operation is mostly for use in testing; use the query service to find location groups that meet certain criteria and specify the properties that are returned. tags: - Location groups operationId: list-company-config-location-group responses: '200': description: OK content: application/json: schema: type: object title: List of location groups properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of location groups: value: ia::result: - key: '1' id: CO href: /objects/company-config/location-group/1 - key: '2' id: CA href: /objects/company-config/location-group/2 - key: '3' id: CT href: /objects/company-config/location-group/3 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a Location group description: Creates a new Location group. tags: - Location groups operationId: create-company-config-location-group requestBody: description: Creates a new Location group. required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-location-group' - $ref: '#/components/schemas/company-config-location-groupRequiredProperties' examples: Creates a location group type all: value: id: WA name: Washington description: Washington State groupType: all memberFilter: object: company-config/location filterExpression: and filters: - $contains: id: WA orderBy: - name: asc Creates a location group type specific: value: id: IN name: India description: India offices groupType: specific groupMembers: - location: id: New Delhi responses: '201': description: Created content: application/json: schema: type: object title: New Location group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new location group: value: ia::result: key: '12' id: IN href: /objects/company-config/location-group/12 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/location-group/{key}: parameters: - name: key description: System-assigned key for the location group. in: path required: true example: '49' schema: type: string get: summary: Get a location group description: Returns detailed information for a specified location group. tags: - Location groups operationId: get-company-config-location-group-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the location group properties: ia::result: $ref: '#/components/schemas/company-config-location-group' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the location group: value: ia::result: key: '1' id: Top Locations name: Top Level Locations description: Top Level Locations groupType: specific primaryContact: key: '211' id: 1099 Int href: /objects/company-config/contact/211 memberFilter: object: company-config/location filterExpression: and orderBy: - name: asc audit: createdDateTime: '2023-08-16T13:26:56Z' modifiedDateTime: '2023-08-16T13:26:56Z' createdBy: '1' modifiedBy: '1' groupMembers: - key: '1' id: '1' locationGroup: key: '1' href: /objects/company-config/location-group/1 location: id: '1' key: '1' name: United States of America href: /objects/company-config/location/1 audit: createdDateTime: '2023-08-21T09:54:05Z' modifiedDateTime: '2023-08-21T09:54:05Z' createdBy: '1' modifiedBy: '1' href: /objects/company-config/location-group-member/1 - key: '2' id: '2' locationGroup: key: '2' href: /objects/company-config/location-group/2 location: id: '3' key: '3' name: United Kingdom href: /objects/company-config/location/3 audit: createdDateTime: '2023-08-21T09:54:05Z' modifiedDateTime: '2023-08-21T09:54:05Z' createdBy: '1' modifiedBy: '1' href: /objects/company-config/location-group-member/2 href: /objects/company-config/location-group/15 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a Location group description: >- Updates an existing Location group by setting field values. Any fields not provided remain unchanged. New values for any arrays will replace the existing array. tags: - Location groups operationId: update-company-config-location-group-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-location-group' - type: object properties: id: readOnly: true examples: Updates a Location group: value: description: My Top Locations america memberFilter: object: company-config/location filterExpression: and filters: - $eq: name: United States of America orderBy: - name: asc responses: '200': description: OK content: application/json: schema: type: object title: Updated Location group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated location group: value: ia::result: key: '12' id: My Locations new href: /objects/company-config/location-group/12 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a Location group description: Deletes a Location group. tags: - Location groups operationId: delete-company-config-location-group-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
SubscriptionCompany
User typeBusiness, Employee, Payment Approver
PermissionsList, 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
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsAdd 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
SubscriptionCompany
User typeBusiness, Employee, Payment Approver
PermissionsList, 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: Suite 1400 addressLine3: East industrial area city: Seattle country: United States postCode: '98066' state: WA URL1: https://myinsideoutcompany.com URL2: https://anotherinsideoutcompany.com companyName: InsideOut Technologies, Inc email1: smith.john@sage.com email2: smith@sage.com fax: '14085555309' firstName: John id: InsideOut Technologies, Inc lastName: Smith middleName: Archibald mobile: '14085554420' pager: '14085559987' phone1: '14085551212' phone2: '14085559876' prefix: Mr printAs: InsideOut Technologies, Inc key: '984' href: /objects/company-config/contact/984 shipTo: mailingAddress: addressLine1: Rose Avenue addressLine2: Suite 1405 addressLine3: Western industrial area city: Seattle country: United States postCode: '98066' state: WA URL1: https://mycompany.com URL2: https://anothercompany.com companyName: AlcoSoft Inc email1: john.smith@sage.com email2: john@sage.com fax: '14085555309' firstName: John id: AlcoSoft Inc lastName: Smith middleName: Archibald mobile: '14085554420' pager: '14085559987' phone1: '14085551212' phone2: '14085559876' prefix: Mr printAs: AlcoSoft Inc key: '985' startDate: '2021-01-01' endDate: '2021-04-01' status: active audit: createdDateTime: '2022-02-11T09:07:07Z' modifiedDateTime: '2022-02-11T09:07:07Z' createdBy: '110' modifiedBy: '110' locationReportingTitle: Seattle Sales Office taxId: US4321112 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
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsEdit 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
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsDelete Locations
tags: - Locations operationId: delete-company-config-location-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/permission: get: summary: List permissions description: Returns a collection with a key, ID, and link for each permission. 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 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 example: '152' 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: Get a 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 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 example: '126' get: summary: Get a role permission assignment description: Returns detailed information for a specified 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: Get a 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: [] /objects/company-config/role-user-group-map: get: summary: List role user group maps description: >- Returns a collection with a key, ID, and link for each role user group map. tags: - Role user group maps operationId: list-company-config-role-user-group-map responses: '200': description: OK content: application/json: schema: type: object title: List of role-user-group-map objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List role user group maps: value: ia::result: - key: '761' id: '761' href: /objects/company-config/role-user-group-map/761 ia::meta: totalCount: 1 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/role-user-group-map/{key}: parameters: - name: key description: System-assigned unique key for the role user group map. in: path required: true schema: type: string example: '69' get: summary: Get a role user group map description: Returns detailed information for a specified role user group map. tags: - Role user group maps operationId: get-company-config-role-user-group-map-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the role-user-group-map properties: ia::result: $ref: '#/components/schemas/company-config-role-user-group-map' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a role user group map: value: ia::result: key: '761' id: '761' role: key: '805' id: '::SYS::Multi Entity Shared-ROLE-FOR - Aaron' href: /objects/company-config/role/805 userGroup: key: '1' id: Bypass group href: /objects/company-config/user-group/1 audit: createdDateTime: '2023-08-18T09:43:13Z' modifiedDateTime: '2023-08-18T09:43:13Z' createdBy: '1' modifiedBy: '1' href: /objects/company-config/role-user-group-map/761 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/role-user-map: get: summary: List role user maps description: Returns a collection with a key, ID, and link for each role user map. tags: - Role user maps operationId: list-company-config-role-user-map responses: '200': description: OK content: application/json: schema: type: object title: List of role-user-map objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List role user maps: value: ia::result: - key: '618' id: '618' href: /objects/company-config/role-user-map/618 - key: '621' id: '621' href: /objects/company-config/role-user-map/621 ia::meta: totalCount: 2 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/role-user-map/{key}: parameters: - name: key description: System-assigned unique key for the role user map. in: path required: true schema: type: string example: '86' get: summary: Get a role user map description: Returns detailed information for a specified role user map. tags: - Role user maps operationId: get-company-config-role-user-map-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the role-user-map properties: ia::result: $ref: '#/components/schemas/company-config-role-user-map' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a role user map: value: ia::result: key: '618' id: '618' role: key: '740' id: '::SYS::Multi Entity Shared-ROLE-FOR - BTI' href: /objects/company-config/role/740 user: key: '4' id: BTI href: /objects/company-config/user/4 audit: createdDateTime: '2023-08-18T09:43:13Z' modifiedDateTime: '2023-08-18T09:43:13Z' createdBy: '1' modifiedBy: '1' href: /objects/company-config/role-user-map/618 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '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 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: Create 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: Reference to 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 example: '122' 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: Get a 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: Update 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: Reference to 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/user-group: get: summary: List user groups description: >- Returns a collection with a key, ID, and link for each user group. This operation is mostly for use in testing; use the query service to find user groups that meet certain criteria and specify the properties that are returned. tags: - User groups operationId: list-company-config-user-group responses: '200': description: OK content: application/json: schema: type: object title: List of user-group objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List user groups: value: ia::result: - key: '1' id: Warehouse users href: /objects/company-config/user-group/1 - key: '96' id: AP users href: /objects/company-config/user-group/96 - key: '21' id: Administrators href: /objects/company-config/user-group/21 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: null previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create a user group description: Creates a new user group. tags: - User groups operationId: create-company-config-user-group requestBody: description: User group to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-user-group' - $ref: '#/components/schemas/company-config-user-groupRequiredProperties' examples: Create a user group: value: id: GL users description: Who can manage General Ledger accounts responses: '201': description: Created content: application/json: schema: type: object title: New user group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new user group: value: ia::result: key: '41' id: GL users href: /objects/company-config/user-group/41 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/user-group/{key}: parameters: - name: key description: System-assigned unique key for the user group. in: path required: true schema: type: string example: '181' get: summary: Get a user group description: Returns detailed information for a specified user group. tags: - User groups operationId: get-company-config-user-group-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the user group properties: ia::result: $ref: '#/components/schemas/company-config-user-group' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a user group: value: ia::result: key: '41' id: GL users description: Who can manage General Ledger accounts audit: createdDateTime: '2024-02-15T11:39:04Z' modifiedDateTime: '2024-02-15T11:39:04Z' createdBy: '51' modifiedBy: '51' roles: [] href: /objects/company-config/user-group/41 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update a user group description: >- Updates an existing user group by setting field values. Any fields not provided remain unchanged. tags: - User groups operationId: update-company-config-user-group-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/company-config-user-group' - type: object properties: id: readOnly: true examples: Update a user group: value: description: Who can manage GL accounts responses: '200': description: OK content: application/json: schema: type: object title: Updated user group properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated user group: value: ia::result: key: '41' id: GL users href: /objects/company-config/user-group/41 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete a user group description: Deletes a user group. tags: - User groups operationId: delete-company-config-user-group-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/company-config/user: get: summary: List users description: >+ Returns a 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.
Permissions and other requirements
SubscriptionAdministration
User typeBusiness user with admin privileges
PermissionsList Users
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: List users: 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. The user must be associated with a new or existing contact. * To use an existing contact, provide a value for either the contact `key` or `id`. The contact must have values for the first and last name. * To create a new contact when you create a user, provide the contact `id`, `printAs`, `firstName`, and `lastName`, plus any other contact fields you want to set.
Permissions and other requirements
SubscriptionAdministration
User typeBusiness, Employee, Project Manager, and Warehouse
PermissionsAdd Users
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: Create a new admin user: value: id: Admin userName: Admin userType: business accountEmail: user_17@sage.com adminPrivileges: full contact: id: jsmith 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 reference properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new user: value: ia::result: key: '102' id: Admin href: /objects/company-config/user/102 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.
Permissions and other requirements
SubscriptionAdministration
User typeBusiness, Employee, Project Manager, and Warehouse
PermissionsView Users
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: Get a user: value: ia::result: id: Admin userName: Admin accountEmail: user_17@sage.com 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: null phone1: '6692248123' phone2: null mobile: '1222455566' pager: null fax: '1222455566' URL1: http://john.example.com URL2: null companyName: Sage Inc key: '3446' href: /objects/company-config/contact/3446 adminPrivileges: 'off' userType: business webServices: isEnabled: true isRestricted: false status: active entityAccess: allowUnrestrictedAccess: true allowToplevelAccess: false password: neverExpires: true requiresReset: false disablePassword: false audit: createdDateTime: '2022-04-26T10:17:12Z' modifiedDateTime: '2022-04-26T11:05:26Z' createdBy: '110' modifiedBy: '109' key: '65' isChatterDisabled: false hideOtherDepartmentTransactions: false entity: key: '54' id: '313131' name: Central Region href: /objects/company-config/entity/54 locations: - key: '87' id: London href: /objects/company-config/location/87 - key: '92' id: Paris href: /objects/company-config/location/92 departments: - key: '55' id: Sales href: /objects/company-config/department/55 - key: '65' id: Accounting href: /objects/company-config/department/65 territories: - key: '22' id: South href: /objects/accounts-receivable/territory/22 - key: '32' id: West href: /objects/accounts-receivable/territory/32 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 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 sso: isSSOEnabled: true federatedSSOId: john.doe trustedDevices: never href: /objects/company-config/user/65 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.
Permissions and other requirements
SubscriptionAdministration
User typeBusiness user with admin privileges
PermissionsEdit Users
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 examples: Update a 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: Reference to updated user: 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: >- After a user logs in to Sage Intacct, they cannot be deleted. Users are preserved to maintain the audit trail throughout Intacct. tags: - Users operationId: delete-company-config-user-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] components: schemas: company-config-affiliate-entity-groupRequiredProperties: type: object required: - id - name 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 example: {} propertySet: type: string example: {} details: type: array items: type: object properties: code: type: string example: invalidRequest message: type: string example: /newDate is not a valid field errorId: type: string example: REST-1043 target: type: string example: /newDate additionalInfo: type: object properties: messageId: type: string example: IA.NOT_A_VALID_FIELD placeholders: type: string example: FIELD: /newDate propertySet: type: string example: {} ia::meta: $ref: '#/components/schemas/metadata' example: ia::result: ia::error: code: invalidRequest message: A POST request requires a payload errorId: REST-1028 additionalInfo: messageId: IA.REQUEST_REQUIRES_A_PAYLOAD placeholders: OPERATION: POST propertySet: {} supportId: Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo ia::meta: totalCount: 1 totalSuccess: 0 totalError: 1 member-filter: description: Member filter when `groupType` = `all`. type: object properties: object: type: string description: Object type to filter on. example: accounts-payable/vendor filters: type: array description: >- Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as `{"$eq":{"status":"active"}}` to select objects in which `status` is equal to "active". example: - $eq: status: active - $gt: totalDue: '1000' - $contains: name: Acme items: anyOf: - title: equal type: object description: Field value must be equal to this specified value. properties: $eq: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string nullable: true - type: integer nullable: true - type: number nullable: true - type: boolean example: $eq: status: active - title: not equal type: object description: Field value must not be equal to this specified value. properties: $ne: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string nullable: true - type: integer nullable: true - type: number nullable: true - type: boolean example: $ne: status: inactive - title: less than type: object description: Field value must be less than this specified value. properties: $lt: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number example: $lt: totalDue: '100' - title: less than or equal type: object description: >- Field value must be less than or equal to this specified value. properties: $lte: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number - type: boolean example: $lte: totalDue: '500' - title: greater than type: object description: Field value must be greater than this specified value. properties: $gt: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number example: $gt: totalDue: '1000' - title: greater than or equal type: object description: >- Field value must be greater than or equal to this specified value. properties: $gte: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number - type: boolean example: $gte: totalDue: '999' - title: in type: object description: Field value is one of the specified values. properties: $in: type: object description: >- The field name and list of values to be compared with object values. additionalProperties: type: array items: oneOf: - type: string - type: integer - type: number - type: boolean example: $in: firstName: - Tim - Anjali - Gabriel - title: not in type: object description: Field value is not one of the specified values. properties: $notIn: type: object description: >- The field name and list of values to be compared with object values. additionalProperties: type: array items: oneOf: - type: string - type: integer - type: number - type: boolean example: $notIn: country: - United States - Canada - title: contains type: object description: >- Field value contains the given string or number. Cannot be used with date fields. properties: $contains: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number example: $contains: name: Acme - title: does not contain type: object description: >- Field value does not contain the given string or number. Cannot be used with date fields. properties: $notContains: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number example: $notContains: name: llc - title: starts with type: object description: >- Field value starts with this string or number. Cannot be used with date fields. properties: $startsWith: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number example: $startsWith: name: A - title: does not start with type: object description: >- Field value does not start with this string or number. Cannot be used with date fields. properties: $notStartsWith: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number example: $notStartsWith: name: Q - title: ends with type: object description: >- Field value ends with this string or number. Cannot be used with date fields. properties: $endsWith: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number example: $endsWith: name: inc - title: does not end with type: object description: >- Field value does not end with this string or number. Cannot be used with date fields. properties: $notEndsWith: type: object description: >- The field name and value to be compared with object values. additionalProperties: oneOf: - type: string - type: integer - type: number example: $notEndsWith: name: llc filterExpression: description: > Logical operators to apply when there are multiple filter conditions. The conditions in the `filters` array are implicitly numbered starting at 1. Supports `and`, `or`, and grouping with parentheses. Shortcuts: + `and` by itself means that all conditions must be true. + `or` by itself means that at least one condition must be true. type: string example: (1 and 2) or 3 default: and orderBy: description: >- Sort order for the results that match the `filters` when the group is displayed in reports. Each entry consists of a field name to sort by and whether it should be sorted in ascending or descending order. type: array maxItems: 1 items: type: object title: field name and sort order additionalProperties: type: string enum: - asc - desc example: - id: asc size: description: >- The maximum number of records that match the `filters` to include in the group when it is displayed in reports. type: integer example: 100 audit: type: object readOnly: true properties: createdDateTime: description: Date-time when this record was created. type: string format: date-time readOnly: true example: '2023-05-16T15:34:35Z' modifiedDateTime: description: Date-time when this record was modified. type: string format: date-time readOnly: true example: '2024-09-14T21:23:42Z' createdBy: description: Key for the user who created this object. type: string readOnly: true nullable: true example: '436' modifiedBy: description: Key for the user who last modified this object. type: string readOnly: true nullable: true example: '3086' company-config-affiliate-entity-group: type: object description: >- A collection of associated entities. For example, parent entity E100 is associated with entities E200 and E500. Together, these affiliate entities are a reporting group. properties: key: type: string description: System-assigned unique key for the affiliate entity group. readOnly: true example: '23' id: type: string description: Unique identifier for the affiliate entity group. example: AF href: type: string description: URL endpoint for the affiliate entity group. readOnly: true example: /objects/company-config/affiliate-entity-group/23 name: type: string description: Name for the affiliate entity group. example: MariposaBusinessEntities description: type: string description: Description for the affiliate entity group. example: E100 E200 E500 affiliate entity group groupType: type: string description: > Group membership type. The group type and related fields determine which affiliate entities are included in the group. If you are creating reports that use affiliate entities in rows or columns, these fields also determine the column headings and row headings that will appear, and the order in which they will be listed. * `specific` - Specify the affiliate entities to include and their order in the `groupMembers` array. You can optionally filter the array with the `memberFilter` settings. * `all` - All affiliate entities that match the `memberFilter` criteria. example: specific enum: - all - specific default: all memberFilter: type: object description: >- One or more filters to select the affiliate entities to include in the group. Can be used in addition to the `groupMembers` array to filter from a selected list of affiliate entities. allOf: - $ref: '#/components/schemas/member-filter' - type: object groupMembers: type: array description: >- Members of the affiliate entity group. Only applicable when `groupType` = `specific`. items: type: object properties: key: type: string description: Unique key for the affiliate entity. example: '23' id: type: string description: Unique identifier for the affiliate entity. example: E200 href: type: string description: URL endpoint for the affiliate entity. readOnly: true example: /objects/company-config/affiliate-entity/23 name: type: string description: Name for the affiliate entity. readOnly: true example: Mariposa isDimensionStructure: type: boolean description: >- Indicates whether a dimension structure is created from the group. If true, the group can be added to the rows or columns of a financial report. default: false example: false audit: $ref: '#/components/schemas/audit' 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 company-config-affiliate-entity: type: object description: >- Affiliate entities are associated entities defined within your Intacct company. You use an affiliate entity to tag the related entity in a transaction. Tagging affiliate entities in transactions enables more detailed and rich reporting. Affiliate entity is a standard dimension based on the list of entities in your Intacct company. Because it's based on the entities in your company, the affiliate entity dimension is read-only. properties: key: type: string description: System-assigned unique key for the affiliate entity. readOnly: true example: '23' id: type: string description: Unique identifier for the affiliate entity. readOnly: true example: E200 href: type: string description: URL endpoint for the affiliate entity. readOnly: true example: /objects/company-config/affiliate-entity/23 name: type: string description: The name for the affiliate entity. example: Mariposa status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' company-config-attachmentRequiredProperties: type: object required: - id 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: URL endpoint for the file example: /objects/company-config/file/962 readOnly: true name: type: string description: File name with extension example: 02-28-2022-invoice.txt size: type: integer description: Size of the attachment in bytes example: 27449 data: type: string description: Attached file data, Base64 encoded format: base64zip example: Y2V2YSwgYWx0Y2V2YQ0Kc2kgaW5jYSBjZXZh 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: System-assigned key of the attachment example: '123' href: type: string description: URL 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: 2024 Taxes name: type: string description: Brief name for the attachment container example: 2022 tax forms description: type: string description: Description of the attachment container example: February invoices href: type: string description: URL 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: URL endpoint for the folder readOnly: true example: /objects/company-config/folder/4 entity: type: object description: >- The entity that the attachment is associated with. Attachments created at the top level do not have an entity reference so the `key`, `id`, and `name` properties will be `null`. properties: key: description: Entity key type: string example: '30' id: description: Entity ID type: string example: SEA name: description: Entity name type: string readOnly: true example: Seattle href: type: string description: URL endpoint 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-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 default: 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's name as it will 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: >- The entity that the contact is associated with. Contacts created at the top level do not have an entity reference so the `key`, `id`, and `name` properties will be `null`. 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 endpoint 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: United States 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 endpoint 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 endpoint 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-department-group-member: type: object description: Department group member represents the members in the department group properties: key: type: string description: System-assigned key for the department group member. readOnly: true example: '23' id: type: string description: Department group member ID. Same as `key` for this object. readOnly: true example: '23' href: type: string description: URL endpoint for the department group member. readOnly: true example: /objects/company-config/department-group-member/23 department: type: object description: Department that this member represents. properties: key: type: string description: Department key. example: '24' id: type: string description: Department ID. example: DES name: type: string description: Department name. readOnly: true example: Designing href: type: string description: URL endpoint for the department. readOnly: true example: /objects/company-config/department/24 departmentGroup: description: Department group that this member belongs to. type: object readOnly: true properties: key: type: string description: Department group key. readOnly: true example: '33' id: type: string description: Identifier for the department group. readOnly: true example: SA01 href: type: string description: URL endpoint for the department group. readOnly: true example: /objects/company-config/department-group/33 sortOrder: type: integer description: >- Sort order of the department when the department group is displayed in reports. example: 2 audit: $ref: '#/components/schemas/audit' company-config-department-groupRequiredProperties: type: object required: - id - name company-config-department-group: type: object description: >- A specified set of departments, or a set of departments that meet certain criteria. properties: key: type: string description: System-assigned unique key for the department group. readOnly: true example: '46' id: type: string description: >- Department group ID. Displayed together with the group name in Sage Intacct (_ID_--_Name_). Department group IDs cannot be changed after the group has been created. example: SA01 href: type: string description: URL endpoint for the department group. readOnly: true example: /objects/company-config/department-group/46 name: type: string description: >- Department group name. Displayed together with the group ID in Sage Intacct (_ID_--_Name_). example: Sales description: type: string description: Description of the department group. example: All sales groups groupType: type: string description: > Group membership type. The group type and related fields determine which departments are included in the group. If you are creating reports that use departments in rows or columns, these fields also determine the column headings and row headings that will appear, and the order in which they will be listed. * `specific` - Specify the departments to include and their order in the `groupMembers` array. You can optionally filter the array with the `memberFilter` settings. * `all` - All departments that match the `memberFilter` criteria. example: specific enum: - all - specific default: all memberFilter: type: object description: >- One or more filters to select the departments to include in the department group. Can be used in addition to the `groupMembers` array to filter from a selected list of departments. allOf: - $ref: '#/components/schemas/member-filter' - type: object groupMembers: type: array description: >- Members of the department group and their sort order. Only applicable when `groupType` = `specific`. items: $ref: '#/components/schemas/company-config-department-group-member' isDimensionStructure: type: boolean description: >- Indicates whether a dimension structure is created from the group. If true, the group can be added to the rows or columns of a financial report. default: false example: false audit: $ref: '#/components/schemas/audit' 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-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 unique key for the document sequence rollover. readOnly: true example: '100' id: type: string description: >- Unique identifier for the document sequence rollover. This value is the same as the `key` for this object. readOnly: true example: '100' href: type: string description: URL endpoint for the fiscal year rollover. readOnly: true example: /objects/company-config/document-sequence-rollover/100 documentSequence: type: object description: Document sequence that the rollover configuration applies to. 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 endpoint for the document sequence. readOnly: true example: /objects/company-config/document-sequence/107 fiscalYear: type: integer description: Fiscal year during which this rollover configuration is used. example: 2024 nextNumber: type: integer description: >- Next number used to generate sequences for the fiscal year when the document-sequence `type` is `numeric`. Must be within the limits set by the `startingNumber` and `endingNumber` fields in the document-sequence. example: 1 nextSequence: type: string description: >- Next sequence used to generate sequences for the fiscal year when the document-sequence `type` is `alpha`. Must be within the limits set by the `startingSequence` and `endingSequence` fields in the document-sequence. example: a audit: $ref: '#/components/schemas/audit' company-config-document-sequenceRequiredProperties: type: object required: - id company-config-document-sequence: type: object description: Document sequencing properties: key: type: string description: System-assigned unique key for the document sequence. readOnly: true example: '61' id: type: string description: Unique name for the document sequence. example: Vendors printTitle: type: string description: The sequence name that prints on invoice PDFs. 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: >- The total length of the primary sequence, includingn any padding characters, up to 16 characters. Numeric sequences will be padded with zeroes and alpha sequence will be padded with a's. example: '16' fixedPrefix: type: string description: Characters that appear before the primary sequence. example: INV prefixSeparator: type: string description: >- Characters to use between the prefix and the auto-generated sequence. example: '-' fixedSuffix: type: string description: Characters that appear after the primary sequence. example: COMPANY suffixSeparator: type: string description: >- Characters to use between the auto-generated sequence and the suffix. example: '-' startingNumber: type: integer description: Starting number for `numeric` sequences. example: 1 endingNumber: type: integer description: Ending number for `numeric` sequences. 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: Date and time when the document sequence was last modified. example: '2024-04-01T11:28:12Z' entity: type: object description: Entity that the document sequence can be used in. readOnly: true properties: key: type: string description: Entity Key. example: '54' id: type: string description: Entity ID. example: Western Region name: type: string description: Entity Name. example: Western Region href: type: string description: URL endpoint for the entity. example: /objects/company-config/entity/54 rollover: type: object description: >- Fiscal year rollover configuration for the document sequence, which will automatically restart the document sequence 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 will be generated by the system when the first sequence is generated. The next number or alpha values will be taken from the base start values. properties: isEnabled: type: boolean description: Set to `true` to enable sequence rollover by fiscal years. example: false default: false enabledDate: type: string format: date description: >- The date the rollover configuration was enabled for the first time. example: '2021-01-23' fiscalYearAffixPosition: type: string description: | Where to insert the fiscal year in document sequence values. ** Valid values ** - `none` Do not automatically insert the fiscal year into the document sequence. - `prefix` Use the fiscal year and the rollover `separator`` as a prefix to the document sequence. - `suffix` Append the rollover `separator`` and the fiscal year as a suffix to the document sequence. example: prefix enum: - none - prefix - suffix default: none separator: type: string description: >- Rollover separator used when the `fiscalYearAffixPosition` is set to `prefix` or `suffix` example: '-' fiscalYears: type: array description: >- Array of document-sequence-rollover objects that define the next number or alpha values to use to generate sequences for specific 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-earning-typeRequiredProperties: type: object required: - id company-config-earning-type: type: object description: Earning types for employee labor costs. properties: key: type: string description: Earning Type Key readOnly: true example: '1' id: type: string description: Earning Type Name example: Over time billableGLAccount: type: object description: General ledger account associated with the earning-type. properties: key: type: string description: System-assigned key for the GL account. example: '158' nullable: true id: type: string description: User-assigned number for the GL account. example: '6775.30' nullable: true name: type: string description: Name of the GL account. readOnly: true nullable: true example: Travel href: type: string description: Endpoint for the GL account object. readOnly: true example: /objects/general-ledger/account/23 nonBillableGLAccount: type: object description: General ledger account associated with the earning-type. properties: key: type: string description: System-assigned key for the GL account. nullable: true example: '158' id: type: string description: User-assigned number for the GL account. nullable: true example: '6774.30' name: type: string description: Name of the GL account. readOnly: true nullable: true example: Expense href: type: string description: Endpoint for the GL account object. readOnly: true example: /objects/general-ledger/account/23 rateMultiplier: type: string description: Earning Type Name nullable: true example: '2' calculationMethod: type: string description: calculation method enum: - hourly - salary example: hourly default: salary 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/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-employee-bank-file-setup: type: object description: >- A bank file enables electronic payments to be made to employees using a local bank file format. Bank files are standard files used by banks to make multiple payments. properties: key: type: string description: System-assigned key for the employee bank file setup. readOnly: true example: '1' id: type: string description: >- Identifier for the employee bank file setup. This value is the same as `key` for this object and can be ignored. Use `key` for all references to this object. readOnly: true example: '1' bankAccountNumber: type: string description: Bank account number for the bank file payment. nullable: false example: IE26SCT666666 bankAccountName: type: string description: Bank account name for the bank file payment. nullable: false example: Jane Blogs Corp. bsbNumber: type: string description: >- Bank branch number for the employee bank. Supported countries - Australia (AU). nullable: true example: 047-359 sortCode: type: string description: >- Sort code for the bank file payment. Supported countries - United Kingdom (GB). nullable: true example: '204718' paymentReference: type: string description: >- Payment reference number to connect the bank file and the expenses to be reimbursed. Supported countries - Australia (AU) and South Africa (ZA). nullable: true example: Supplier Inc branchCode: type: string description: >- Branch code for the employee bank account to which payments are made. Supported countries - South Africa (ZA). nullable: true example: '213456' bankAccountType: type: string description: >- Account type to which employee payments are made. The available account types are determined by the bank file format that was selected for the associated checking account. Supported countries - South Africa (ZA). nullable: true example: '4' bankAccountCode: type: string description: >- Account code for the employee bank account to which payments are made. Supported countries - South Africa (ZA). nullable: true example: ACME345624 printPaymentProof: type: boolean description: >- Specify whether to print the proof of payment when the bank file payment batch is authorized. Supported countries - South Africa (ZA). nullable: true default: true example: true businessIdCode: type: string description: >- Creditor bank identifier code for the bank account. Supported countries - All European countries where Generic-SEPA file format is supported. nullable: true example: AIBKIE2D491 creditorCode: type: string description: >- Creditor code for the bank account. Supported countries - Canada (CA). nullable: true example: '1234567891234567' secondaryIdentifier: type: string description: >- Bank number, as assigned by the account CAD financial institution. Supported countries - Canada (CA). nullable: true example: '00710423598' employee: type: object description: Employee to reimburse for expenses incurred. properties: key: type: string description: System-assigned key for the employee. example: '518' id: type: string description: Unique identifier of the employee. example: E-00014 href: type: string description: URL of the employee. readOnly: true example: /objects/company-config/employee/518 href: type: string description: URL for the employee bank file setup. readOnly: true example: /objects/company-config/employee-bank-file-setup/25 company-config-employee-rate: type: object description: List of employee rates, including history. properties: key: type: string description: System-assigned unique key for the employee rate. readOnly: true example: '23' id: type: string description: >- Unique identifier for the employee rate. This value is the same as the `key` for this object. readOnly: true example: '23' href: type: string description: URL endpoint for the employee rate. readOnly: true example: /objects/projects/employee-rate/23 hourlyRate: type: string description: Normal hourly rate amount. format: decimal-precision-2 example: '50' annualSalary: type: string description: Annual salary amount. nullable: true example: '100000' startDate: type: string format: date description: Start date of hourly rate or annual salary. example: '2023-04-01' endDate: type: string format: date description: End date of of hourly rate or annual salary. example: '2023-04-01' employee: type: object description: Details of an employee to whom the rate applies. readOnly: true properties: id: type: string description: Unique identifier for the employee. readOnly: true example: '111' key: type: string description: System-assigned unique key for the employee. example: '1' readOnly: true name: type: string description: Employee name. readOnly: true example: John Doe href: type: string description: URL endpoint for the employee. readOnly: true example: /objects/company-config/employee/23 audit: $ref: '#/components/schemas/audit' company-config-employee-typeRequiredProperties: type: object required: - id entity-ref: type: object description: >- The entity that the object is associated with. Objects created at the top level do not have an entity reference so the `key`, `id`, and `name` properties will be `null`. readOnly: true properties: key: type: string description: Entity key. readOnly: true nullable: true example: '46' id: type: string description: Entity ID. readOnly: true nullable: true example: CORP name: type: string description: Entity name. readOnly: true nullable: true example: Corp href: type: string description: URL endpoint for the entity. readOnly: true example: /objects/company-config/entity/46 company-config-employee-type: type: object description: >- Employee type is a customizable classification that can be defined in a company and assigned to employees to enhance reporting and insight into the value delivered by different employee categories, such as contractor, full-time, and part-time. properties: key: type: string description: System-assigned unique key for the employee type. readOnly: true example: '23' id: type: string description: Unique identifier for the employee type. example: Contractor href: type: string description: URL endpoint for this employee type. readOnly: true example: /objects/company-config/employee-type/23 parent: type: object description: Parent employee type, for employee type hierarchies. properties: href: type: string description: URL endpoint for the parent employee type. readOnly: true example: /objects/company-config/employee-type/7 id: type: string description: Unique identifier for the employee type of the parent reference. nullable: true example: Contractor key: type: string description: >- System-assigned unique key for the employee type of the parent reference. nullable: true example: '7' form1099: type: object description: Details related to the 1099 form for the employee type. readOnly: true properties: type: type: string description: The type of the 1099 form applicable to the employee type. readOnly: true nullable: true example: MISC box: type: string description: > Specifies the category box on the 1099 form where vendor payments are reported. This categorization helps in identifying the nature of payments made, such as royalties, non-employee compensation, or rent, corresponding to different IRS reporting requirements. readOnly: true nullable: true example: '3' status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' entity: $ref: '#/components/schemas/entity-ref' company-config-employeeRequiredProperties: type: object required: - primaryContact 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-employee: type: object description: Information about an employee. properties: key: type: string description: System-assigned unique key for the employee readOnly: true example: '3086' id: type: string description: Unique ID of the employee example: jsmith name: type: string description: Name of the employee example: John Smith startDate: type: string format: date example: '2021-04-30' description: Employment start date nullable: true jobTitle: type: string description: Job title nullable: true example: VP Sales status: $ref: '#/components/schemas/status' birthDate: type: string description: Employee date of birth format: date nullable: true example: '1984-04-13' endDate: type: string description: Employment termination date format: date nullable: true example: '2026-04-01' postActualCostWithVariance: type: boolean description: >- Set to `true` to indicate that the actual cost with variance is posted when earning type is salary. example: false default: false mergePaymentRequests: type: boolean description: >- Set to `true` to indicate that the system can merge payment requests. example: true default: true sendAutomaticPaymentNotification: type: boolean description: >- Set to `true` to indicate that the system can send automatic payment notifications when the employee is issued an expense reimbursement. example: true default: false manager: type: object description: Manager of the employee properties: key: type: string description: System-assigned unique key of the manager nullable: true example: '1' id: type: string description: Manager ID nullable: true example: jsmith name: type: string description: Manager name nullable: true example: johnsmith href: type: string description: Endpoint URL for the manager readOnly: true example: /objects/company-config/employee/1 gender: type: string description: Gender enum: - null - female - male nullable: true default: null example: female location: type: object description: >- Location where the employee works. Required when an employee is created at the top level in a multi-entity, multi-base-currency company. readOnly: true properties: key: type: string description: Location key nullable: true example: '5' id: type: string description: Location ID nullable: true example: US name: type: string description: Location name nullable: true readOnly: true example: USA href: type: string description: URL endpoint for the location readOnly: true example: /objects/company-config/location/1 department: type: object description: The department that the employee works for properties: key: type: string description: Department key nullable: true example: '1' id: type: string description: Department ID nullable: true example: HR name: type: string description: Department name readOnly: true nullable: true example: HR href: type: string description: URL endpoint for the department readOnly: true example: /objects/company-config/department/1 class: type: object description: Class that the employee is associated with properties: key: type: string description: Class key nullable: true example: '1' id: type: string description: Class ID nullable: true example: A name: type: string description: Class name readOnly: true nullable: true example: A href: type: string description: URL endpoint for the class readOnly: true example: /objects/company-config/class/1 defaultCurrency: nullable: true type: string description: >- Currency to use for the employee's expense reports and payments, if different from the company's base currency. Only used if the company uses multiple transaction currencies. example: USD primaryContact: type: object description: The contact object that represents the employee properties: key: type: string description: System-assigned unique key of the contact example: '12345' id: type: string description: Unique ID of the contact nullable: true example: rkincaid lastName: type: string readOnly: true description: Contact last name example: Kincaid firstName: type: string readOnly: true description: Contact first name example: Reuben middleName: type: string readOnly: true description: Contact middle name or initial example: X prefix: type: string readOnly: true description: Prefix, such as Mr., Mrs., or Ms. example: Mr. email1: type: string readOnly: true description: Primary email address example: reuben@mycompany.com email2: type: string readOnly: true description: Secondary email address example: robert@mycompany.com phone1: type: string readOnly: true description: Primary phone number example: '4151231234' phone2: type: string readOnly: true description: Secondary phone number example: '4158661823' mobile: type: string readOnly: true description: Mobile phone number example: '4159879876' pager: type: string readOnly: true description: Pager number example: '4151112222' fax: type: string readOnly: true description: Fax number example: '4152221111' URL1: type: string readOnly: true description: Web page address for this contact example: https://mycompany.com URL2: type: string readOnly: true description: Secondary web page address example: https://whitehouse.gov companyName: type: string readOnly: true description: Name of the company associated with this contact example: AlcoSoft Inc printAs: type: string readOnly: true description: The contact name as it appears on bills, invoices, etc. example: Reuben Kincaid mailingAddress: type: object title: mailingAddress description: The mailing address of the contact properties: addressLine1: type: string description: The first address line for shipping, billing, etc. nullable: true example: 300 Park Avenue readOnly: true addressLine2: type: string description: The second address line for shipping, billing, etc. nullable: true example: Suite 1400 readOnly: true city: type: string readOnly: true description: City example: San Jose state: type: string readOnly: true description: State example: California postCode: type: string readOnly: true description: Zip or Postal Code example: '95110' country: type: string readOnly: true description: Country example: United States isoCountryCode: type: string readOnly: true description: ISO country code. example: US href: type: string readOnly: true description: URL endpoint for the contact example: /objects/company-config/contact/12345 employeeType: type: object description: >- Defines the status of employee, such as full time, part time, or contractor properties: key: type: string description: Employee type key nullable: true example: '1' id: type: string description: Employee type name nullable: true example: hourly href: type: string description: URL endpoint for the employee type readOnly: true example: /objects/company-config/employee-type/1 earningType: type: object description: >- An earning type specifies the GL accounts that the employee's labor costs are posted to. properties: key: type: string description: Earning type key nullable: true example: '1' id: type: string description: Earning type name nullable: true example: Overtime pay href: type: string description: URL endpoint for the earning type example: /objects/company-config/earning-type/1 readOnly: true SSN: type: string nullable: true description: Employee social security number. Do not include dashes. example: '078051120' employeePosition: type: object description: Reference to an employee position. Only used for construction. properties: key: type: string description: Employee position key nullable: true example: '1' id: type: string description: Employee position ID nullable: true example: SV001 name: type: string description: Name of the employee position nullable: true readOnly: true example: permanent href: type: string description: URL endpoint for the employee position readOnly: true example: /objects/construction/employee-position/1 terminationType: type: string description: Termination status, if the employee has left the company enum: - null - voluntary - involuntary - deceased - disability - retired nullable: true default: null example: voluntary form1099: type: object description: Form 1099 information for the employee properties: name: type: string description: Employee name as it appears on the 1099 form nullable: true example: John Smith type: type: string description: Type of form 1099 nullable: true example: MISC box: type: string description: Box value of form 1099 nullable: true example: '3' ach: type: object description: ACH details if the employee is paid by ACH properties: enabled: type: boolean description: Enable ACH example: false bankRoutingNumber: type: string nullable: true description: ACH bank routing number example: '325070760' accountNumber: type: string nullable: true description: Account number example: '3123123456' accountType: type: string nullable: true description: Account type example: checkingAccount enum: - null - checkingAccount - savingsAccount remittanceType: type: string nullable: true description: Account classification example: personalPPD enum: - null - personalPPD - businessCCD - businessCTX isPlaceholderResource: type: boolean description: >- Set to `true` to mark this employee as a placeholder resource. Only used for the Projects application. example: false default: false filePaymentService: type: string nullable: true description: File payment service type example: ach enum: - null - ach - bankFile - none default: none bankFile: type: object properties: paymentCountryCode: type: string description: >- Bank file payment country code. Required when `filePaymentService` is `bankFile`. allOf: - $ref: '#/components/schemas/country-code' nullable: true example: gb paymentCurrency: type: string description: Bank file payment currency nullable: true example: EUR bankFileSetup: type: array description: Bank file setup for the employee items: $ref: '#/components/schemas/company-config-employee-bank-file-setup' preferredPaymentMethod: type: string description: Preferred payment method enum: - null - printedCheck - eft - cash - ach nullable: true default: null example: cash attachmentFolder: type: object description: Attachment folder for storing documents related to the employee. properties: key: type: string description: Folder key example: '1' id: type: string description: Folder ID nullable: true example: RK495 href: type: string description: URL endpoint for the folder example: /objects/company-config/folder/1 employeeRates: type: array description: Employee cost rates items: $ref: '#/components/schemas/company-config-employee-rate' positionSkills: description: Array of positions and skills associated with an employee. type: array items: type: object properties: key: type: string description: Position skill key example: '7' id: type: string description: Position skill ID example: Care giver href: type: string description: URL endpoint for the position skill example: /objects/projects/position-skill/7 readOnly: true audit: $ref: '#/components/schemas/audit' entity: $ref: '#/components/schemas/entity-ref' href: type: string example: /objects/company-config/employee/28 description: URL endpoint for the employee 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, such as Mr., Mrs., or Ms. example: Mr printAs: type: string description: The contact's name as it will appear on documents example: John Smith email1: type: string description: Primary email address example: jsmith@company.com email2: type: string description: Secondary email address example: john@aol.com phone1: type: string description: Primary phone number example: '14085551212' phone2: type: string description: Secondary phone number example: '14085559876' mobile: type: string description: Mobile phone number example: '14085554420' pager: type: string description: Pager number example: '14085559987' fax: type: string description: Fax number example: '14085555309' URL1: type: string description: Web page address for this contact example: https://mycompany.com URL2: type: string description: Secondary web page address example: https://anothercompany.com companyName: type: string description: Name of the company example: AlcoSoft Inc mailingAddress: type: object description: Mailing address 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: United States 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 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 legalCategory: type: string description: >- Identifies the type of organization under French law, encompassing various recognized forms for both private and public entities. example: 24 Fiduciary mainActivity: type: string description: >- Specifies the primary economic activities the business engages in, helping classify the nature of operations. example: 10.3 Transformation and conservation of fruits and vegetables typeOfCompany: type: string description: >- Classifies the business entity based on legal structure, size, activities, or other key characteristics. example: 03 Intermediate sized enterprises registeredCapital: type: integer description: >- Represents the total capital invested by shareholders upon the company's formation. example: 37 000 valueAddedTaxRegime: type: string description: >- Details the specific VAT rules and regulations applicable to the business, including requirements for VAT collection, application, and reporting within France. example: Monthly 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: >- Used in Cash Management (Checking Account) to indicate whether this entity is a working 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: '2021-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: >- Set to `true` to include the legal name and address on forms 1099 and 1096 for this entity. example: false default: false enableOnTPAR: type: boolean description: >- Set to `true` to include the legal name and address 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: >- Enable partial VAT 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: >- Set to `true` to mark items 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 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. 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 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 isLimitedEntity: type: boolean description: Set to 'true' to indicate that this entity is a limited entity. nullable: false default: false example: true status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' company-config-exchange-rate-lineRequiredProperties: type: object required: - effectiveStartDate - rate - exchangeRate company-config-exchange-rate-line: type: object description: >- Detailed information about exchange rates such as effective start date, exchange rate, and reciprocal rate. properties: key: type: string description: System-assigned unique key for the exchange rate line. readOnly: true example: '23' id: type: string description: >- Unique identifier for the exchange rate line. This value is the same as `key` for this object. readOnly: true example: '23' href: type: string description: URL endpoint for the exchange rate line. readOnly: true example: /objects/company-config/exchange-rate-line/23 effectiveStartDate: type: string format: date description: The date the exchange rate becomes effective. example: '2021-01-31' rate: type: number description: The conversion rate to use, beginning with the effective start date. nullable: false example: 2 reciprocalRate: type: number description: >- The reverse of the conversion rate (`rate`). For example, if you are establishing a `rate` to convert dollars to Euros, the `reciprocalRate` is used to convert Euros to dollars. example: 0.5 exchangeRate: type: object description: Reference to the exchange rate that this line belongs to. properties: key: type: string description: Unique key for the exchange rate. example: '23' id: type: string description: Unique identifier for the exchange rate. example: '23' href: type: string description: URL endpoint for the exchange rate. readOnly: true example: /objects/company-config/exchange-rate/23 audit: $ref: '#/components/schemas/audit' company-config-exchange-rate-typeRequiredProperties: type: object required: - name company-config-exchange-rate-type: type: object description: Exchange rate type definition. properties: key: type: string description: System-assigned unique key for the exchange rate type. readOnly: true example: '23' id: type: string description: Unique identifier for the exchange rate type. readOnly: true example: '23' href: type: string description: URL endpoint for the the exchange rate type. readOnly: true example: /objects/company-config/exchange-rate-type/23 name: type: string description: Name or other unique identifier for the exchange rate type. nullable: false example: GBP-Rate isDefault: type: boolean description: >- Indicates whether the system should use the exchange rate type as the default. Setting `isDefault` to `true` for an exchange rate type will automatically set it to `false` for the current default exchange rate type. example: false default: false audit: $ref: '#/components/schemas/audit' company-config-exchange-rateRequiredProperties: type: object required: - fromCurrency - toCurrency - exchangeRateType company-config-exchange-rate: type: object description: Exchange rate definition. properties: key: type: string description: System-assigned key for the exchange rate. readOnly: true example: '23' id: type: string description: >- Unique identifier for the exchange rate. Same as `key` for this object. readOnly: true example: '23' href: type: string description: URL endpoint for the exchange rate. readOnly: true example: /objects/company-config/exchange-rate/23 fromCurrency: type: string description: The transaction currency to convert from. nullable: false example: USD toCurrency: type: string description: The transaction currency to convert to. nullable: false example: GBP exchangeRateType: type: object description: Exchange rate type. properties: key: type: string description: Exchange rate type. example: '123' id: type: string description: Exchange rate type. example: '123' name: type: string description: Exchange rate type name. readOnly: true example: GBP-Rate href: type: string description: URL endpoint for the exchange rate type. readOnly: true example: /objects/company-config/exchange-rate-type/123 lines: description: >- Exchange rate lines in this exchange rate. Each line represents a rate and an effective starting date. type: array items: $ref: '#/components/schemas/company-config-exchange-rate-line' audit: $ref: '#/components/schemas/audit' company-config-folderRequiredProperties: type: object required: - id 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: 2024 Taxes description: type: string description: Description of the folder example: 2024 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 URL for the parent folder readOnly: true example: /objects/company-config/folder/3 entity: type: object description: >- The entity that the folder is associated with. Attachment folders created at the top level do not have an entity reference so the `key`, `id`, and `name` properties will be `null`. properties: key: description: Entity key type: string example: '30' id: description: Entity ID type: string example: SEA name: description: Entity 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: URL 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: '2024-04-20T16:20:00Z' readOnly: true modifiedDateTime: description: Date-time of the modification type: string format: date-time example: '2024-04-20T17:40:00Z' readOnly: true modifiedBy: description: User who modified this type: string example: User2 readOnly: true company-config-document-sequence-get-next-sequence-request: description: get-next-sequence request type: object oneOf: - required: - key - required: - id properties: key: type: string description: Document sequence key. example: '14' id: type: string description: Document sequence ID. example: AR Inv fiscalYear: type: integer description: >- Fiscal year. If fiscal year rollover is not enabled for the document sequence, this field has no effect. example: 2024 company-config-document-sequence-get-next-sequence-response: description: get-next-sequence response type: object properties: key: type: string description: Document sequence key. example: '14' id: type: string description: Document sequence ID. example: AR Inv nextSequence: type: string description: The next sequence value. example: INV-16 fiscalYear: type: integer description: The fiscal year that the sequence value belongs to. example: 2024 company-config-dimensions-list-response: description: Dimension information type: object properties: dimensionName: type: string description: Dimension name used for integrations. example: DEPARTMENT dimensionLabel: type: string description: Default dimension label as it appears in the UI. example: Department termName: type: string description: Dimension label as defined in company terminology. example: Department isUserDefinedDimension: type: boolean description: This is `true` for user-defined dimensions. example: true isEnabledInGL: type: boolean description: >- This is `true` if the dimension is enabled in the General Ledger module for this company. example: true dimensionEndpoint: type: string description: URL endpoint of the dimension. example: /objects/company-config/department company-config-location-group-member: type: object description: Location group member represents the members in the location group properties: key: type: string description: System-assigned key for the location group member. readOnly: true example: '23' id: type: string description: Location group members ID. Same as `key` for this object. readOnly: true example: '23' href: type: string description: URL endpoint for the location group member. readOnly: true example: /objects/company-config/location-group-member/23 location: type: object description: Location that this member represents. properties: key: type: string description: Location key. example: '1' id: type: string description: Location ID. example: '1' name: type: string description: Location name. readOnly: true example: United States of America href: type: string description: URL endpoint for the location. readOnly: true example: /objects/company-config/location/23 locationGroup: description: Location group that this member belongs to. type: object readOnly: true properties: key: type: string description: Location group key. readOnly: true example: '33' id: type: string description: Identifier for the Location group. readOnly: true example: WH1 href: type: string description: URTL endpoint for the Location group. readOnly: true example: /objects/company-config/location-group/33 sortOrder: type: integer description: >- Sort order of the location when the location group is displayed in reports. readOnly: true example: 2 audit: $ref: '#/components/schemas/audit' company-config-location-groupRequiredProperties: type: object required: - id - name company-config-location-group: type: object description: >- A specified set of locations, or a set of locations that meet certain criteria. properties: key: type: string description: System-assigned unique key for the location group. readOnly: true example: '33' id: type: string description: >- Location group ID. Displayed together with the group name in Sage Intacct (_ID_--_Name_). Location group IDs cannot be changed after the group has been created. example: WH1 href: type: string description: URL endpoint for the location group. readOnly: true example: /objects/company-config/location-group/33 name: type: string description: >- Location group name. Displayed together with the group ID in Sage Intacct (_ID_--_Name_). example: Western Region Warehouses description: type: string description: Description of the location group. example: Western Region Warehouses primaryContact: type: object description: Default contact for this group. properties: key: type: string description: System-assigned key for the contact. example: '7' id: type: string description: Contact ID. example: Jeff Pinkerton href: type: string description: URL endpoint for the contact. readOnly: true example: /objects/company-config/contact/7 groupType: type: string description: > Group membership type. The group type and related fields determine which locations are included in the group. If you are creating reports that use locations in rows or columns, these fields also determine the column headings and row headings that will appear, and the order in which they will be listed. * `specific` - Specify the locations to include and their order in the `groupMembers` array. You can optionally filter the array with the `memberFilter` settings. * `all` - All locations that match the `memberFilter` criteria. example: specific enum: - all - specific default: all memberFilter: type: object description: >- One or more filters to select the locations to include in the location group. Can be used in addition to the `groupMembers` array to filter from a selected list of locations. allOf: - $ref: '#/components/schemas/member-filter' - type: object groupMembers: type: array description: >- Members of the location group and their sort order. Only applicable when `groupType` = `specific`. items: $ref: '#/components/schemas/company-config-location-group-member' isDimensionStructure: type: boolean description: >- Indicates whether a dimension structure is created from the group. If true, the group can be added to the rows or columns of a financial report. default: false example: false 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. example: Seattle Sales Office 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' 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 - inventoryApplications - 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 - suppliesInventory - taxExport - taxes - timeAndExpenses - vendorCompliance - webServices - wellsFargoPaymentManager - loanManagement - budgetVsActual - depositoryManagement 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 - affiliateEntityGroups - 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 - glMatching - glMatchingActivity - 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 - taxDetailBox - taxReport - 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 - refunds - budgetVariance - revenueTxnEntries - payrollReportEmployee - payrollReportTrade - payrollReportPTOAccrualSchedule - glDynamicAccountReclassificationReport example: postedPayments 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-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' 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' role-user-group-map: $ref: '#/components/schemas/company-config-role-user-group-map' 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' role-user-map: $ref: '#/components/schemas/company-config-role-user-map' 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-roleRequiredProperties: type: object required: - id 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-user-groupRequiredProperties: type: object required: - id - description company-config-user-group: type: object description: List of users assigned to user groups. properties: key: type: string description: >- System-assigned unique key for the user group. Used to identify the group in URLs or JSON bodies for all operations on the user group. readOnly: true example: '21' id: type: string description: Name of the user group. example: AP href: type: string description: Endpoint for this user group. readOnly: true example: /objects/company-config/user-group/21 description: type: string description: Description of the user group. example: Accounts Payable roles: type: array description: >- List of roles assigned to the user group. All users in the group inherit the permissions defined by the roles. Only applies to companies that use role-based permissions instead of user-based permissions. items: type: object properties: key: type: string description: Unique key of the role. example: '7' id: type: string description: Name of the role. example: Warehouse users href: type: string description: Endpoint of the role. readOnly: true example: /objects/company-config/role/7 audit: $ref: '#/components/schemas/audit' company-config-userRequiredProperties: type: object required: - id - accountEmail - contact 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. This unique identifier cannot be changed after the user is created. type: string example: john.doe userName: description: >- The name that will be used to identify the user. This name is displayed in the user interface. type: string example: John Doe accountEmail: description: User email address. type: string example: john.doe@company.com userType: description: > The user type for this user. User types determines the _maximum_ set of features and activities that a user can access and perform in Intacct. The things a user can do also depend on the permissions that are assigned to the user. For more information see [User types](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 default: business example: employee adminPrivileges: description: > User admin privileges. * `off` - No admin privileges * `full` - Complete administration privileges including the ability to create other full administrators and use Platform Services features. Requires that `userType` is set to `business`. * `limited` - All administration privileges, except for the previously mentioned items. Requires that `userType` is set to `business`. type: string enum: - 'off' - limited - full default: 'off' example: 'off' status: type: string description: >- User status. - `active` - The user can log in and access Intacct. - `inactive` - Retains the user information in the system, but hides the user from lists throughout Intacct. Cannot be used when creating a new user. - `lockedOut` - Set by Intacct due to too many failed login attempts, or by an administrator to prevent the user from logging in. The user cannot log in until an administrator sets the status to `active`. enum: - active - inactive - lockedOut default: active example: active webServices: type: object description: Whether the user can use Sage Intacct Web Services (API). properties: isEnabled: description: Set to `true` to allow the user to use web services. 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 user interface. 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. Use this setting only for Web Services API users. 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 for the user. default: false example: false sso: type: object description: Single sign-on settings for the user. 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: type: object description: The contact associated with this user. allOf: - $ref: '#/components/schemas/contact-ref' - type: object trustedDevices: type: string description: >- Whether to recognize trusted devices for the user-- always, never, or use the company setting. 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: URL endpoint for the territory. readOnly: true example: /objects/accounts-receivable/territory/9 roles: type: array description: >- List of roles assigned to the user. The array will be empty for companies that have user-based permissions. items: type: object properties: key: type: string description: Role key. example: '7' id: type: string description: Role ID. example: Employee href: type: string description: URL endpoint for the role. readOnly: true example: /objects/company-config/role/7 permissionAssignments: type: array description: >- Array of objects that define the permissions and access rights assigned to the user. items: type: object properties: permission: type: object description: Reference to a permission that is assigned to the user. properties: key: type: string description: Permission key. example: '414' id: type: string description: Permission ID. example: '414' href: type: string description: Endpoint URL for the permission. readOnly: true example: /objects/company-config/permission/404 accessRights: type: array description: >- List of functions or tasks that the user can perform for the specified permission. example: - list - readonly - add - modify - delete items: $ref: '#/components/schemas/permission-access-rights' audit: $ref: '#/components/schemas/audit' entity: type: object description: >- The entity that the user is associated with. Users created at the top level do not have an entity reference so the `key`, `id`, and `name` properties will be `null`. 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 endpoint 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 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/oauth2/authorize tokenUrl: https://api.intacct.com/ia/api/v1/oauth2/token refreshUrl: https://api.intacct.com/ia/api/v1/oauth2/token scopes: {}