To connect to and automate Sage Intacct® as part of a chain, add a step that includes a Sage Intacct connection command. Some commands require basic knowledge of the Sage Intacct application programming interface (API).
Connection Properties
To enable these commands, an IT admin first creates a Sage Intacct connection and configures its credentials and properties. The connection interacts with Sage Intacct via its API.
| Input |
Detail |
| Company ID |
Enter the company ID to connect to |
| User ID |
Enter the username for the user the connection will make requests on behalf of |
| Password |
Enter the password for the User ID input |
| Sender ID |
Enter the ID of the integration user to connect to the Sage Intacct API |
| Sender Password |
Enter the password for the Sender ID input |
Note: All sensitive credentials are automatically encrypted and stored at 2,048-bit encryption.
Create Object
Creates an object given a specified type and extensible markup language (XML) payload
Inputs
| Input |
Detail |
| Object Type |
Enter the type of object to create, such as glbactch or glbudget |
| Parameters |
Enter the XML payload for the object. For the structure of the object's XML, refer to the Sage Intacct API. |
Outputs
| Output |
Output Type |
| Object |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing command |
| 2 |
Error |
Error authenticating with the server |
Delete Object
Deletes an object given its type and RECORDNO ID
Inputs
| Input |
Detail |
| Object Type |
Enter the type of object to delete, such as glbactch or glbudget |
| Record ID |
Enter the unique RECORDNO identifier of the object to delete |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing command |
| 2 |
Error |
Error authenticating with the server |
Get Custom Report Details
Returns the details of a custom report
Inputs
| Input |
Detail |
| Name |
Enter the name of the custom report to return details of |
| Interactive |
If the report is interactive, check this box |
Outputs
| Output |
Output Type |
| Report Definition |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing command |
| 2 |
Error |
Error authenticating with the server |
Get Object
Returns an object given its type and RECORDNO ID
Inputs
| Input |
Detail |
| Object Type |
Enter the type of object to return, such as glbatch or glbudget |
| Fields |
Enter a comma-separated list of the object's fields to return, such as RECORDNO,CREATEDBY. To return all fields, leave blank. |
| Record ID |
Enter the unique RECORDNO identifier of the object to return |
Outputs
| Output |
Output Type |
| Object |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing command |
| 2 |
Error |
Error authenticating with the server |
Get Trial Balances
Returns a list of trial balances
Inputs
| Input |
Detail |
| Reporting Period |
Enter the reporting period to filter by. If set, the command ignores the Start Date and End Date inputs. |
| Start Date |
Enter the start date parameter to filter by, as numbers only. Used only if the Reporting Period input is blank. |
| End Date |
Enter the end date parameter to filter by, as numbers only. Used only if the Reporting Period input is blank. |
| Preview Results |
To preview the results of the report, check this box |
| Other Options |
Add any additional parameters to customize the list of returned balances |
Outputs
| Output |
Output Type |
| Balances (CSV) |
File |
| Total Records |
Integer |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing command |
| 2 |
Error |
Error authenticating with the server |
List Dimension Relationships
Returns a list of all dimensional relationships
Inputs
| Input |
Detail |
| Preview Results |
To preview the results of the report, check this box |
Outputs
| Output |
Output Type |
| Relationships (CSV) |
File |
| Relationship Count |
Integer |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing command |
| 2 |
Error |
Error authenticating with the server |
List Dimensions
Returns a list of all dimensions
Inputs
| Input |
Detail |
| Preview Results |
To preview the results of the report, check this box |
Outputs
| Output |
Output Type |
| Dimensions (CSV) |
File |
| Dimension Count |
Integer |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing command |
| 2 |
Error |
Error authenticating with the server |
List Objects
Returns a list of objects given an object type, and—optionally—specified fields and a query filter
Inputs
| Input |
Detail |
| Object Type |
Enter the type of objects to return, such as glbatch or glbudget |
| Fields |
Enter a comma-separated list of the fields to return for each object, such as RECORDNO,CREATEDBY. To return all fields, leave blank. |
| Query |
To return only objects of the type, enter the filter criteria similar to structured query language (SQL):
- To match multiple fields, use
AND and OR operators.
- Operators
, >, >=, , =, like, not like, in, not in are supported. Joins are not.
- If doing
NULL comparisons, use IS NULL or IS NOT NULL.
|
| Preview Results |
To preview the results of the report, check this box |
Outputs
| Output |
Output Type |
| Objects (CSV) |
File |
| Object Count |
Integer |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing command |
| 2 |
Error |
Error authenticating with the server |
Run Custom Report
Runs a custom report and returns its results
Inputs
| Input |
Detail |
| Name |
Enter the name of the custom report to run |
| Interactive |
If the report is interactive, check this box |
| Preview Results |
To preview the results of the report, check this box |
Outputs
| Output |
Output Type |
| Report Data (CSV) |
File |
| Total Records |
Integer |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing command |
| 2 |
Error |
Error authenticating with the server |
Update Object
Updates an object given a specified type and XML payload
Inputs
| Input |
Detail |
| Object Type |
Enter the type of object to update, such as glbatch or glbudget |
| Parameters |
Enter the XML payload for the object. For the structure of the object's XML, refer to the Sage Intacct API. |
Outputs
| Output |
Output Type |
| Object |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing command |
| 2 |
Error |
Error authenticating with the server |