Journal entry templates

If using a creation rule for reconciliation, the rule needs to have a transaction template. Transaction templates define how to create new transactions in Sage Intacct based on bank data from an import file or bank feed.

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List journal entry templates

get/objects/cash-management/journal-entry-template

Returns a collection with a key, ID, and link for each journal entry template. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "vat-je-tmpl-ui1",
      • "href": "/objects/cash-management/journal-entry-template/1"
      },
    • {
      • "key": "3",
      • "id": "test-add-je-tmpl-ui-tax",
      • "href": "/objects/cash-management/journal-entry-template/3"
      },
    • {
      • "key": "4",
      • "id": "1",
      • "href": "/objects/cash-management/journal-entry-template/4"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Create a journal entry template

post/objects/cash-management/journal-entry-template

Creates a new journal entry template.

SecurityOAuth2
Request
Request Body schema: application/json
id
required
string

ID for the journal entry transaction template.

Example: "JE-tmpl-1"
name
required
string

Name of the journal entry transaction template.

Example: "JournalEntry-tmpl-1"
required
object

GL journal to which entries will post.

key
string

System-assigned key for the gl-journal.

Example: "3"
id
string

Symbol of the journal to which entries will post.

Example: "APJ"
required
Array of objects
Array
documentId
string

Document number of the transaction.

Example: "doc11"
memo
string

Memo

Example: "memo-created-by-rule"
numberOfUnits
integer

Number of units

Example: 100
object

Exchange rate details used to calculate the base amount.

txnType
string or null
Default: null

Transaction type; 1 for Debit, -1 for Credit.

Enum: "credit" "debit" null
Example: "debit"
isBillable
boolean
Default: false

Indicates whether the transaction is billable.

Example: true
object
object
object
object

Header level details for the journal entry template's lines.

description
string

Description of the journal entry transaction template.

Example: "GL template for banks"
postingState
string

Set the state in which to create the transaction, Draft or Posted.

Enum: "draft" "posted"
Example: "draft"
status
string
Default: "active"

Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.

Enum: "active" "inactive"
Example: "active"
taxImplication
string or null
Default: null

Tax implications to the transaction in tax enabled companies.

Enum: "inbound" "none" null "outbound"
Example: "none"
object

Tax solution. Different tax solutions are available for different countries, for example, Australia GST, South Africa VAT, UK Vat.

key
string

System-assigned key for the tax solution.

Example: "11"
id
string

ID for the tax solution.

Example: "Australia GST"
object

In tax enabled companies tax schedule used to capture tax details in the purchasng transaction.

key
string

System-assigned key for the tax schedule.

Example: "1"
id
string

Unique identifier of the tax schedule.

Example: "1"
object

In tax enabled companies tax schedule used to capture tax details in the sales transaction.

key
string

System-assigned key for the tax schedule.

Example: "7"
id
string

Unique identifier of the tax schedule.

Example: "7"
object

Tax customer.

key
string

System-assigned key for customer.

Example: "23"
id
string

Tax customer id.

Example: "Cust-1"
object

Tax vendor.

key
string

System-assigned key for vendor.

Example: "3"
id
string

Tax vendor id.

Example: "Vend-1"
Responses
201

Created

400

Bad Request

Request samples
application/json
{
  • "id": "GL-CreateRule-5",
  • "name": "GL-CreateRule-5",
  • "description": "GL-CreateRule-5",
  • "postingState": "draft",
  • "status": "active",
  • "glJournal": {
    • "id": "APJ"
    },
  • "lines": [
    • {
      • "dimensions": {
        },
      • "glAccount": {
        },
      • "documentId": null,
      • "memo": "GL-CreateRule-5"
      }
    ]
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "78",
    • "id": "GL-CreateRule-5",
    • "href": "/objects/cash-management/journal-entry-template/78"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Get a journal entry template

get/objects/cash-management/journal-entry-template/{key}

Returns detailed information for a specified journal entry template.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the journal entry template.

Example: 3
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "key": "3",
    • "name": "test-add-je-tmpl-ui-tax",
    • "description": null,
    • "glJournal": {
      • "id": "CCJ",
      • "key": "9",
      • "href": "/objects/general-ledger/journal/9"
      },
    • "postingState": "draft",
    • "status": "active",
    • "id": "test-add-je-tmpl-ui-tax",
    • "audit": {
      • "createdDateTime": "2022-11-29T21:27:09Z",
      • "modifiedDateTime": "2022-11-29T21:27:09Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "taxImplication": "inbound",
    • "taxSolution": {
      • "key": "2",
      • "id": "United Kingdom - VAT",
      • "href": "/objects/tax/tax-solution/2"
      },
    • "salesTaxSchedule": {
      • "name": null,
      • "key": null,
      • "id": null
      },
    • "purchasingTaxSchedule": {
      • "name": "EC Purchase Goods Exempt Rate",
      • "key": "76",
      • "id": "76",
      • "href": "/objects/tax/purchasing-tax-schedule/76"
      },
    • "vendor": {
      • "key": "48",
      • "id": "202",
      • "name": "Pac Bell",
      • "href": "/objects/accounts-payable/vendor/48"
      },
    • "customer": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "lines": [
      • {
        }
      ],
    • "href": "/objects/cash-management/journal-entry-template/3"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Update a journal entry template

patch/objects/cash-management/journal-entry-template/{key}

Updates an existing journal entry template by setting field values. Any fields not provided remain unchanged.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the journal entry template.

Example: 3
Request Body schema: application/json
name
string

Name of the journal entry transaction template.

Example: "JournalEntry-tmpl-1"
description
string

Description of the journal entry transaction template.

Example: "GL template for banks"
postingState
string

Set the state in which to create the transaction, Draft or Posted.

Enum: "draft" "posted"
Example: "draft"
object

GL journal to which entries will post.

key
string

System-assigned key for the gl-journal.

Example: "3"
id
string

Symbol of the journal to which entries will post.

Example: "APJ"
Array of objects
Array
documentId
string

Document number of the transaction.

Example: "doc11"
memo
string

Memo

Example: "memo-created-by-rule"
numberOfUnits
integer

Number of units

Example: 100
object

Exchange rate details used to calculate the base amount.

txnType
string or null
Default: null

Transaction type; 1 for Debit, -1 for Credit.

Enum: "credit" "debit" null
Example: "debit"
isBillable
boolean
Default: false

Indicates whether the transaction is billable.

Example: true
object
object
object
object

Header level details for the journal entry template's lines.

status
string
Default: "active"

Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.

Enum: "active" "inactive"
Example: "active"
taxImplication
string or null
Default: null

Tax implications to the transaction in tax enabled companies.

Enum: "inbound" "none" null "outbound"
Example: "none"
object

Tax solution. Different tax solutions are available for different countries, for example, Australia GST, South Africa VAT, UK Vat.

key
string

System-assigned key for the tax solution.

Example: "11"
id
string

ID for the tax solution.

Example: "Australia GST"
object

In tax enabled companies tax schedule used to capture tax details in the purchasng transaction.

key
string

System-assigned key for the tax schedule.

Example: "1"
id
string

Unique identifier of the tax schedule.

Example: "1"
object

In tax enabled companies tax schedule used to capture tax details in the sales transaction.

key
string

System-assigned key for the tax schedule.

Example: "7"
id
string

Unique identifier of the tax schedule.

Example: "7"
object

Tax customer.

key
string

System-assigned key for customer.

Example: "23"
id
string

Tax customer id.

Example: "Cust-1"
object

Tax vendor.

key
string

System-assigned key for vendor.

Example: "3"
id
string

Tax vendor id.

Example: "Vend-1"
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "postingState": "posted"
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "6",
    • "id": "3",
    • "href": "/objects/cash-management/journal-entry-template/6"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Delete a journal entry template

delete/objects/cash-management/journal-entry-template/{key}

Deletes a journal entry template.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the journal entry template.

Example: 3
Responses
204

No Content

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}

Query journal entry templates

post/services/core/query

Queries an object for filtered data.

SecurityOAuth2
Request
Request Body schema: application/json
object
string

Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.

Example: "cash-management/journal-entry-template"
fields
Array of strings

List of fields to include in the response. Can be any combination of these:

  • The name of a field in the object that you are querying, such as id.

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:

    • count
    • avg
    • sum
    • min
    • max
  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.

Example: ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)

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"}}]
Array
Any of:

Field value must be equal to this specified value.

For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:

  • today
  • currentWeek
  • currentMonth
  • currentQuarter
  • currentYear
  • yesterday
  • lastWeek
  • priorMonth
  • priorQuarter
  • priorYear

These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.

For example, {"eq":{"postingDate":"priorYear"}}.

object

The field name and value to be compared with object values.

Example: {"status":"active"}
filterExpression
string
Default: "and"

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.
Example: "(1 and 2) or 3"
object

Pre-defined filter options.

asOfDate
string <date>

The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".

The current date is used if asOfDate is not set.

Example: "2022-04-01"
includeHierarchyFields
boolean
Default: false

Set to true to include hierarchical structure information with each object in the response.

Example: false
caseSensitiveComparison
boolean
Default: true

Queries are case-sensitive by default. Set to false to ignore case in a query.

Example: true
includePrivate
boolean
Default: false

By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.

Example: false
Array of objects

Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.

Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
Array
property name*
additional property
string
Enum: "asc" "desc"
start
integer

First record of the result set to include in the response.

Example: 1
size
integer

Number of records to include in the response.

Example: 100
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "object": "accounts-payable/vendor",
  • "fields": [
    • "id",
    • "name",
    • "status",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "filterExpression": "1 and 2",
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples
application/json
{
  • "ia::result": [
    • {
      • "id": "Vend-00002",
      • "name": "Test vendor",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/85"
      },
    • {
      • "id": "VEND-00010",
      • "name": "Design Works",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/111"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}