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.
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.
OK
Bad Request
{- "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
}
}
Creates a new journal entry template.
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. | ||||||||||||||||||||
| |||||||||||||||||||||
required | Array of objects | ||||||||||||||||||||
Array
| |||||||||||||||||||||
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, Example: "draft" | ||||||||||||||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||||||||||||||||||
taxImplication | string or null Default: null Tax implications to the transaction in tax enabled companies. Example: "none" | ||||||||||||||||||||
object Tax solution. Different tax solutions are available for different countries, for example, Australia GST, South Africa VAT, UK Vat. | |||||||||||||||||||||
| |||||||||||||||||||||
object In tax enabled companies tax schedule used to capture tax details in the purchasng transaction. | |||||||||||||||||||||
| |||||||||||||||||||||
object In tax enabled companies tax schedule used to capture tax details in the sales transaction. | |||||||||||||||||||||
| |||||||||||||||||||||
object Tax customer. | |||||||||||||||||||||
| |||||||||||||||||||||
object Tax vendor. | |||||||||||||||||||||
|
Created
Bad Request
{- "id": "GL-CreateRule-5",
- "name": "GL-CreateRule-5",
- "description": "GL-CreateRule-5",
- "postingState": "draft",
- "status": "active",
- "glJournal": {
- "id": "APJ"
}, - "lines": [
- {
- "dimensions": {
- "location": {
- "id": "1"
}
}, - "glAccount": {
- "key": "316"
}, - "documentId": null,
- "memo": "GL-CreateRule-5"
}
]
}
{- "ia::result": {
- "key": "78",
- "id": "GL-CreateRule-5",
- "href": "/objects/cash-management/journal-entry-template/78"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified journal entry template.
key required | string System-assigned key for the journal entry template. Example: 3 |
OK
Bad Request
{- "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": [
- {
- "key": "3",
- "id": "3",
- "journalEntryTemplate": {
- "id": "3",
- "key": "3",
- "href": "/objects/cash-management/journal-entry-template/3"
}, - "dimensions": {
- "location": {
- "key": null,
- "id": null,
- "name": null
}, - "department": {
- "id": null
}, - "project": {
- "key": null,
- "id": null,
- "name": null
}, - "customer": {
- "key": null,
- "id": null,
- "name": null
}, - "vendor": {
- "key": null,
- "id": null,
- "name": null
}, - "employee": {
- "key": null,
- "id": null,
- "name": null
}, - "item": {
- "key": null,
- "id": null,
- "name": null
}, - "class": {
- "key": null,
- "id": null,
- "name": null
}, - "warehouse": {
- "key": null,
- "id": null,
- "name": null
}
}, - "glAccount": {
- "key": "334",
- "id": "7500",
- "name": "Penalties",
- "href": "/objects/general-ledger/account/334"
}, - "documentId": null,
- "txnType": null,
- "memo": null,
- "allocation": {
- "key": null,
- "id": null
}, - "numberOfUnits": null,
- "exchangeRate": {
- "date": null,
- "typeId": null,
- "rate": null
}, - "isBillable": false,
- "href": "/objects/cash-management/journal-entry-line-template/3"
}
], - "href": "/objects/cash-management/journal-entry-template/3"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing journal entry template by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned key for the journal entry template. Example: 3 |
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, Example: "draft" | ||||||||||||||||||||
object GL journal to which entries will post. | |||||||||||||||||||||
| |||||||||||||||||||||
Array of objects | |||||||||||||||||||||
Array
| |||||||||||||||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||||||||||||||||||
taxImplication | string or null Default: null Tax implications to the transaction in tax enabled companies. Example: "none" | ||||||||||||||||||||
object Tax solution. Different tax solutions are available for different countries, for example, Australia GST, South Africa VAT, UK Vat. | |||||||||||||||||||||
| |||||||||||||||||||||
object In tax enabled companies tax schedule used to capture tax details in the purchasng transaction. | |||||||||||||||||||||
| |||||||||||||||||||||
object In tax enabled companies tax schedule used to capture tax details in the sales transaction. | |||||||||||||||||||||
| |||||||||||||||||||||
object Tax customer. | |||||||||||||||||||||
| |||||||||||||||||||||
object Tax vendor. | |||||||||||||||||||||
|
OK
Bad Request
{- "postingState": "posted"
}
{- "ia::result": {
- "key": "6",
- "id": "3",
- "href": "/objects/cash-management/journal-entry-template/6"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes a journal entry template.
key required | string System-assigned key for the journal entry template. Example: 3 |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "A POST request requires a payload",
- "errorId": "REST-1028",
- "additionalInfo": {
- "messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
- "placeholders": {
- "OPERATION": "POST"
}, - "propertySet": { }
}, - "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 0,
- "totalError": 1
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "cash-management/journal-entry-template" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
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 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
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
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
| |||||||||
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 |
OK
Bad Request
{- "object": "accounts-payable/vendor",
- "fields": [
- "id",
- "name",
- "status",
- "href"
], - "filters": [
- {
- "$eq": {
- "status": "active"
}
}, - {
- "$eq": {
- "billingType": "openItem"
}
}
], - "filterExpression": "1 and 2",
- "orderBy": [
- {
- "id": "asc"
}
]
}
{- "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
}
}