Data Delivery Service (DDS) enables you to export your data from Sage Intacct to a cloud destination.


List DDS Jobs

readByQuery

<readByQuery>
    <object>DDSJOB</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
</readByQuery>

Parameter

Name Required Type Description
object Required string Use DDSJOB
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. 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. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

Get DDS Job

read

<read>
    <object>DDSJOB</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use DDSJOB
keys Required string Job RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Create DDS Job

Release Changes
2019 Release 2 Added additional_parameters

runDdsJob

Create job to get all vendors:

<runDdsJob>
    <object>VENDOR</object>
    <cloudDelivery>AWS-S3-DDS</cloudDelivery>
    <jobType>all</jobType>
</runDdsJob>

Create job to get changed customers:

<runDdsJob>
    <object>CUSTOMER</object>
    <cloudDelivery>AWS-S3-DDS</cloudDelivery>
    <jobType>change</jobType>
</runDdsJob>

Create job to get GL account balances for the reporting periods January 2018 to April 2019:

<runDdsJob>
    <object>GLACCOUNTBALANCE</object>
    <cloudDelivery>AWS-S3-DDS</cloudDelivery>
    <jobType>all</jobType>
    <additional_parameters>
        <parameter>
            <name>PERIODSTARTDATE</name>
            <value>01/01/2018</value>
        </parameter>
        <parameter>
            <name>PERIODENDDATE</name>
            <value>04/30/2019</value>
        </parameter>
    </additional_parameters>
</runDdsJob>

Parameters

Name Required Type Description
object Required string Object integration name
cloudDelivery Required string Name of a cloud storage destination set up for your company in the Sage Intacct UI.
jobType Optional string Job type. Use change for all changes since the last delivery, otherwise use all for all data.
additional_parameters Optional parameter[1...2] Periods for which to calculate balances when using the GLACCOUNTBALANCE object. If you don’t provide these parameters, historical reporting periods are used and this can generate a great deal of unneeded data.
timeStamp Optional string Timestamp to get data from if jobType is change. The time zone is UTC, and future dates are not supported. Format YYYY-MM-DDThh:mm:ss.
fileConfiguration Optional object File attributes

parameter

Available for use only if the object is GLACCOUNTBALANCE.

Name Required Type Description
name Optional string Parameter name. Use PERIODSTARTDATE and PERIODENDDATE together, or PERIOD.
value Optional string For PERIODSTARTDATE and PERIODENDDATE, provide both the period start and end date in the format mm/dd/yyyy. For PERIOD, provide the name of a budgetable reporting period (Ex: Month Ended April 2019) or a system reporting period (Ex: Current Month). Partial periods are not supported, and the system reports full period ranges. For example, the whole April period will be used if you enter a start date of 04/15/2019 and an end date of 04/29/2019.

fileConfiguration

Name Required Type Description
delimiter Optional string Value delimiter. Use . for Period, ; for Semicolon, or , for Comma (Default: , Comma)
enclosure Optional string Text qualifier. Use " for Double quote, ' for Single quote, [ for Left bracket, or / for Forward Slash (Default: " Double quote)
includeHeaders Optional boolean Include column headers. Use true for Yes otherwise false for No (Default: false)
fileFormat Optional string File format. Use windows, mac, or unix (Default: unix)
splitSize Optional integer Split files after this many records. Minimum is 10000 and maximum is 100000.
compress Optional boolean Compress file. Use true for Yes otherwise false for No (Default: false).

Provide feedback