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).
To enable these commands, an IT admin first creates a Sage Intacct connector.
Create object
To create an object based on its type and extensible markup language (XML) payload, use a Create object command.
Properties
| 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
To delete an object based on its type and RECORDNO ID, use a Delete object command.
Properties
| 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
To retrieve the details of a custom report, use a Get custom report details command.
Properties
| 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
To retrieve an object given its type and RECORDNO ID, use a Get object command.
Properties
| 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
To retrieve a list of trial balances, use a Get trial balances command.
Properties
| Input |
Detail |
| Reporting period |
Enter the reporting period to filter by. If set, the command ignores Start date and End date. |
| Start date |
Enter the start date parameter to filter by, as numbers only. Used only if Reporting period is blank. |
| End date |
Enter the end date parameter to filter by, as numbers only. Used only if Reporting period 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
To retrieve a list of all dimensional relationships, use a List dimension relationships command.
Inputs
Properties
| 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
To retrieve a list of all dimensions, use a List dimensions command.
Properties
| 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
To retrieve a list of objects based on their type and a query filter, use a List objects command. You can also specify the fields to return for each object.
Properties
| 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 |
Note: Columns in the CSV output file are formatted alphanumerically and may be ordered differently than in Sage Intacct.
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing command |
| 2 |
Error |
Error authenticating with the server |
Run custom report
To run a custom report and returns its results as comma-separated values (CSV), use a Run custom report command.
Properties
| 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 |
Note: Columns in the CSV output file are formatted alphanumerically and may be ordered differently than in Sage Intacct.
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing command |
| 2 |
Error |
Error authenticating with the server |
Update object
To update an object with an XML payload, use an Update object command.
Properties
| 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 |