Journal entry templates

Journal entry templates store predefined information used to populate journal entries generated from them. They include journal entry line templates, which define the individual lines of a journal entry created from the template, specifying information such as account details and amounts.

If using a creation rule for reconciliation, the rule must reference a journal entry template.

List journal entry templates

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

Returns a collection of journal entry templates with a key, ID, and link for each template. This operation is mostly for use in testing; use the query service 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": "JET_BANK_IMPORT_001",
      • "href": "/objects/cash-management/journal-entry-template/1"
      },
    • {
      • "key": "3",
      • "id": "JET_MONTHLY_ACCRUAL_003",
      • "href": "/objects/cash-management/journal-entry-template/3"
      },
    • {
      • "key": "4",
      • "id": "JET_YE_ADJ_2025",
      • "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
Unique identifier for the journal entry template.


 
 Example:  "MONTHLY_ACCRUALS_TMPL_001"
name
required
string
Name for the journal entry template.


 
 Example:  "Monthly Accruals Template"
required
object
General ledger journal where entries based on this template will be posted.


 
key
string
Unique key for the journal.


 
 Example:  "3"
id
string
Identifier for the journal.


 
 Example:  "APJ"
required
Array of objects
Line items included in this journal entry template.


 
 Array 
documentId
string
Document number of this journal entry line template.


 
 Example:  "JE-2025-0345"
memo
string
Brief notes providing additional context for the journal entry line template.


 
 Example:  "Monthly Accrual - Utilities Expense"
numberOfUnits
integer
Number of units associated with the journal entry line template.


 
 Example:  100
object
Exchange rate details used to calculate the base amount for journal entry lines created from this template.


 
txnType
string or null
 Default:  null
Specifies whether the journal entry line created from this template is a debit or a credit.


 Enum: "credit" "debit" null  
 Example:  "debit"
isBillable
boolean
 Default:  false
Indicates whether the journal entry line created from this template is billable.


 
 Example:  true
object
Automatically distributes the journal line created from this template across multiple dimensions such as departments, locations, projects, or classes.


 
object
 
object
 
object
Journal entry template that contains this journal entry line template.


 
description
string
Description for the template.


 
 Example:  "Template for recording standard monthly accruals."
postingState
string
Specify the state in which to create journal entries based on this template:


draft - The journal entry is created in a draft state. A draft match for reconciliation is also created.
posted - Posted directly to the general ledger when the journal entry is created.


 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 for journal entries based on this template. Only applies to companies subscribed to the Taxes application.


none - journal entries based on this template will not include tax.
inbound (purchases inclusive of tax) - journal entries based on this template will record taxes on purchases.
outbound (sales inclusive of tax ) - journal entries based on this template will record taxes on sales.


 Enum: "inbound" "none" null "outbound"  
 Example:  "none"
object
Tax solution to use for journal entries based on this template. Different tax solutions are available for different countries, for example, Australia GST, South Africa VAT, UK VAT. Only applies to companies subscribed to the Taxes application.


 
key
string
Unique key for the tax solution.


 
 Example:  "11"
id
string
Identifier for the tax solution.


 
 Example:  "Australia GST"
object
Specify the Purchasing tax schedule when the taxImplication is set to inbound. Only applies to companies subscribed to the Taxes application.


 
key
string
Unique key for the purchasing tax schedule.


 
 Example:  "1"
id
string
Identifier for the tax schedule.


 
 Example:  "1"
object
Specify the Sales tax schedule when the taxImplication is set to outbound. Only applies to companies subscribed to the Taxes application.


 
key
string
Unique key for the sales tax schedule.


 
 Example:  "7"
id
string
Identifier for the tax schedule.


 
 Example:  "7"
object
Specify the customer when the taxImplication is set to outbound. Only applies to companies subscribed to the Taxes application.


 
key
string
Unique key for customer.


 
 Example:  "23"
id
string
Identifier for the customer.


 
 Example:  "GLOBALTECH-0023"
object
Specify the vendor when the taxImplication is set to inbound. Only applies to companies subscribed to the Taxes application.


 
key
string
Unique key for the vendor.


 
 Example:  "3"
id
string
Identifier for the vendor.


 
 Example:  "PACIFIC-003"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "JET_PAYROLL",
  • "name": "Payroll Accrual Entry",
  • "description": "Template to record monthly payroll accruals for salaries and wages.",
  • "postingState": "draft",
  • "status": "active",
  • "glJournal": {
    • "id": "APJ"
    },
  • "lines": [
    • {
      • "dimensions": {
        },
      • "glAccount": {
        },
      • "documentId": null,
      • "memo": "Accrual of payroll expenses for month-end closing"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "5",
    • "id": "JET_PAYROLL",
    • "href": "/objects/cash-management/journal-entry-template/5"
    },
  • "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:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "6",
    • "name": "UK Office Purchases Journal Entry",
    • "description": "Purchases for UK Office Supplies inclusive of UK VAT",
    • "glJournal": {
      • "id": "POJ",
      • "key": "1",
      • "href": "/objects/general-ledger/journal/1"
      },
    • "postingState": "draft",
    • "status": "active",
    • "numberOfRulesUsingTemplate": 0,
    • "id": "JET_UK_OFFICE_PURCHASES",
    • "audit": {
      • "createdDateTime": "2025-04-29T15:26:00Z",
      • "modifiedDateTime": "2025-04-29T15:26:00Z",
      • "createdByUser": {
        },
      • "createdBy": "159",
      • "modifiedByUser": {
        },
      • "modifiedBy": "159"
      },
    • "taxImplication": "inbound",
    • "taxSolution": {
      • "key": "4",
      • "id": "United Kingdom - VAT",
      • "href": "/objects/tax/tax-solution/4"
      },
    • "salesTaxSchedule": {
      • "name": null,
      • "key": null,
      • "id": null
      },
    • "purchasingTaxSchedule": {
      • "name": "UK Purchase Goods Standard Rate",
      • "id": "41",
      • "key": "41",
      • "href": "/objects/tax/purchasing-tax-schedule/41"
      },
    • "vendor": {
      • "key": "56",
      • "id": "210",
      • "name": "Office Supply and Copier Co.",
      • "href": "/objects/accounts-payable/vendor/56"
      },
    • "customer": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "entity": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "lines": [
      • {
        }
      ],
    • "href": "/objects/cash-management/journal-entry-template/6"
    },
  • "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:  99
Request Body schema: application/json
name
string
Name for the journal entry template.


 
 Example:  "Monthly Accruals Template"
description
string
Description for the template.


 
 Example:  "Template for recording standard monthly accruals."
postingState
string
Specify the state in which to create journal entries based on this template:


draft - The journal entry is created in a draft state. A draft match for reconciliation is also created.
posted - Posted directly to the general ledger when the journal entry is created.


 Enum: "draft" "posted"  
 Example:  "draft"
object
General ledger journal where entries based on this template will be posted.


 
key
string
Unique key for the journal.


 
 Example:  "3"
id
string
Identifier for the journal.


 
 Example:  "APJ"
Array of objects
Line items included in this journal entry template.


 
 Array 
documentId
string
Document number of this journal entry line template.


 
 Example:  "JE-2025-0345"
memo
string
Brief notes providing additional context for the journal entry line template.


 
 Example:  "Monthly Accrual - Utilities Expense"
numberOfUnits
integer
Number of units associated with the journal entry line template.


 
 Example:  100
object
Exchange rate details used to calculate the base amount for journal entry lines created from this template.


 
txnType
string or null
 Default:  null
Specifies whether the journal entry line created from this template is a debit or a credit.


 Enum: "credit" "debit" null  
 Example:  "debit"
isBillable
boolean
 Default:  false
Indicates whether the journal entry line created from this template is billable.


 
 Example:  true
object
Automatically distributes the journal line created from this template across multiple dimensions such as departments, locations, projects, or classes.


 
object
 
object
 
object
Journal entry template that contains this journal entry line template.


 
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 for journal entries based on this template. Only applies to companies subscribed to the Taxes application.


none - journal entries based on this template will not include tax.
inbound (purchases inclusive of tax) - journal entries based on this template will record taxes on purchases.
outbound (sales inclusive of tax ) - journal entries based on this template will record taxes on sales.


 Enum: "inbound" "none" null "outbound"  
 Example:  "none"
object
Tax solution to use for journal entries based on this template. Different tax solutions are available for different countries, for example, Australia GST, South Africa VAT, UK VAT. Only applies to companies subscribed to the Taxes application.


 
key
string
Unique key for the tax solution.


 
 Example:  "11"
id
string
Identifier for the tax solution.


 
 Example:  "Australia GST"
object
Specify the Purchasing tax schedule when the taxImplication is set to inbound. Only applies to companies subscribed to the Taxes application.


 
key
string
Unique key for the purchasing tax schedule.


 
 Example:  "1"
id
string
Identifier for the tax schedule.


 
 Example:  "1"
object
Specify the Sales tax schedule when the taxImplication is set to outbound. Only applies to companies subscribed to the Taxes application.


 
key
string
Unique key for the sales tax schedule.


 
 Example:  "7"
id
string
Identifier for the tax schedule.


 
 Example:  "7"
object
Specify the customer when the taxImplication is set to outbound. Only applies to companies subscribed to the Taxes application.


 
key
string
Unique key for customer.


 
 Example:  "23"
id
string
Identifier for the customer.


 
 Example:  "GLOBALTECH-0023"
object
Specify the vendor when the taxImplication is set to inbound. Only applies to companies subscribed to the Taxes application.


 
key
string
Unique key for the vendor.


 
 Example:  "3"
id
string
Identifier for the vendor.


 
 Example:  "PACIFIC-003"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "postingState": "posted"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "6",
    • "id": "6",
    • "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:  99
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
    }
}