Table of Contents

Connections

Commands

Connections

Sage Intacct

Sage Intacct connector that uses the REST API.

Inputs

Input

Type

Detail

Notes

Company ID

TextField

The company ID you are connecting to.

User ID

TextField

The username for the user that the connection will make requests on behalf of.

Password

TextField

The password for the user.

Sender ID

TextField

The ID of the integration user to connect to the API

Sender Password

TextField

The password for the sender ID specified

Commands

Create Object

Create an object by specifying the type and the XML payload.

Inputs

Input

Type

Detail

Notes

Object Type

TextField

The type of object to create. Examples are glbatch, glbudget, etc.

Parameters

TextField

The XML payload for the object. This can be text or a file. Please refer to the Sage Intacct API for the structure of the XML for the object being created.

Outputs

Output

Output Type

Notes

Object

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error executing command

2

Error

Error authenticating with the server.

Delete Object

Delete an object by specifying the type and the ID (RECORDNO)

Inputs

Input

Type

Detail

Notes

Object Type

TextField

The type of object to delete. Examples are glbatch, glbudget, etc.

Record ID

TextField

The record ID.

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

Get the details of a Custom Report

Inputs

Input

Type

Detail

Notes

Name

TextField

The name of the report

Interactive

BooleanField

Check this if the report is interactive.

Outputs

Output

Output Type

Notes

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

Get an object by specifying the type and the ID (RECORDNO)

Inputs

Input

Type

Detail

Notes

Object Type

TextField

The type of object to retrieve. Examples are glbatch, glbudget, etc.

Fields

TextField

A comma separated list of fields to retrieve on each object. If left blank or the value is '*' all fields will be retrieved. e.g. RECORDNO,CREATEDBY

Record ID

TextField

The record ID.

Outputs

Output

Output Type

Notes

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

Get a list of Trial Balances

Inputs

Input

Type

Detail

Notes

Reporting Period

TextField

The reporting period to filter by. If this is set Start Date and End Date will be ignored

Start Date

GroupField

The start date parameters to filter by. All inputs should be represented as numbers. This will only be used if the reporting period name is not set.

End Date

GroupField

The end date parameters to filter by. All inputs should be represented as numbers. This will only be used if the reporting period name is not set.

Preview Results

BooleanField

Preview the results of the report.

Other Options

GroupField

Additional parameters to customize the list of returned balances.

Outputs

Output

Output Type

Notes

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

Get a list of all dimension relationships.

Inputs

Input

Type

Detail

Notes

Preview results

BooleanField

Preview the results.

Outputs

Output

Output Type

Notes

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

Get a list of all dimensions.

Inputs

Input

Type

Detail

Notes

Preview results

BooleanField

Preview the results.

Outputs

Output

Output Type

Notes

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

Get a list of objects by specifying the object type, and optionally the fields you would like to retrieve and a query filter.

Inputs

Input

Type

Detail

Notes

Object Type

TextField

The type of object to retrieve. Examples are glbatch, glbudget, etc.

Fields

TextField

A comma separated list of fields to retrieve on each object. If left blank or the value is '*' all fields will be retrieved. e.g. RECORDNO,CREATEDBY

Query

TextField

SQL-like query based on fields on the object. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported.

Preview results

BooleanField

Preview the results.

Outputs

Output

Output Type

Notes

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

Run a custom report and get the result.

Inputs

Input

Type

Detail

Notes

Name

TextField

The name of the report

Interactive

BooleanField

Check this if the report is interactive.

Preview Results

BooleanField

Preview the results of the report.

Arguments

TextField

Additional arguments to pass to the report. The arguments should be specified in XML format. e.g. <REPORTINGPERIOD>Current Year</REPORTINGPERIOD>

Outputs

Output

Output Type

Notes

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

Update an object by specifying the type and the XML payload.

Inputs

Input

Type

Detail

Notes

Object Type

TextField

The type of object to update. Examples are glbatch, glbudget, etc.

Parameters

TextField

The XML payload for the object. This can be text or a file. Please refer to the Sage Intacct API for the structure of the XML for the object being created.

Outputs

Output

Output Type

Notes

Object

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error executing command

2

Error

Error authenticating with the server.

Did this answer your question?