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.

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 
/**
 * Requires libcurl
 */

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <YOUR_TOKEN_HERE>"
  ],
  CURLOPT_PORT => "",
  CURLOPT_URL => "https://api.intacct.com/ia/api/v1/objects/cash-management/journal-entry-template",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
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
required
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 
/**
 * Requires libcurl
 */

$curl = curl_init();

$payload = array(
  "id" => "GL-CreateRule-5",
  "name" => "GL-CreateRule-5",
  "description" => "GL-CreateRule-5",
  "postingState" => "draft",
  "status" => "active",
  "glJournal" => array(
    "id" => "APJ"
  ),
  "lines" => array(
    array(
      "dimensions" => array(
        "location" => array(
          "id" => "1"
        )
      ),
      "glAccount" => array(
        "key" => "316"
      ),
      "documentId" => NULL,
      "memo" => "GL-CreateRule-5"
    )
  )
);

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <YOUR_TOKEN_HERE>",
    "Content-Type: application/json"
  ],
  CURLOPT_POSTFIELDS => json_encode($payload),
  CURLOPT_PORT => "",
  CURLOPT_URL => "https://api.intacct.com/ia/api/v1/objects/cash-management/journal-entry-template",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
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: 134
Responses
200

OK

400

Bad Request

Request samples 
/**
 * Requires libcurl
 */

const key = "YOUR_key_PARAMETER";
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <YOUR_TOKEN_HERE>"
  ],
  CURLOPT_PORT => "",
  CURLOPT_URL => "https://api.intacct.com/ia/api/v1/objects/cash-management/journal-entry-template/" . key,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
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: 134
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 
/**
 * Requires libcurl
 */

const key = "YOUR_key_PARAMETER";
$curl = curl_init();

$payload = array(
  "postingState" => "posted"
);

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <YOUR_TOKEN_HERE>",
    "Content-Type: application/json"
  ],
  CURLOPT_POSTFIELDS => json_encode($payload),
  CURLOPT_PORT => "",
  CURLOPT_URL => "https://api.intacct.com/ia/api/v1/objects/cash-management/journal-entry-template/" . key,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "PATCH",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
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: 134
Responses
204

No Content

400

Bad Request

Request samples 
/**
 * Requires libcurl
 */

const key = "YOUR_key_PARAMETER";
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <YOUR_TOKEN_HERE>"
  ],
  CURLOPT_PORT => "",
  CURLOPT_URL => "https://api.intacct.com/ia/api/v1/objects/cash-management/journal-entry-template/" . key,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "DELETE",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
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

Use the query service to find journal entry templates that meet certain criteria and to specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
/**
 * Requires libcurl
 */

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <YOUR_TOKEN_HERE>"
  ],
  CURLOPT_PORT => "",
  CURLOPT_URL => "https://api.intacct.com/ia/api/v1/services/core/query",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
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
    }
}

Feedback