Credit card transaction templates

Credit card transaction templates provide a predefined structure to standardize credit card transactions. By applying a transaction template to each credit card transaction, you ensure the transaction is recorded consistently, with fields such as payee and tax implications automatically populated.

List credit card transaction templates

get/objects/cash-management/credit-card-txn-template

Returns a collection of credit card transaction 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": "2",
      • "id": "CC-TXN-002 Travel",
      • "href": "/objects/cash-management/credit-card-txn-template/2"
      },
    • {
      • "key": "3",
      • "id": "CC-TXN-003 Accommodation",
      • "href": "/objects/cash-management/credit-card-txn-template/3"
      },
    • {
      • "key": "4",
      • "id": "CC-TXN-004 Meals",
      • "href": "/objects/cash-management/credit-card-txn-template/4"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a credit card transaction template
post/objects/cash-management/credit-card-txn-template
Creates a new credit card transaction template.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string
Unique identifier for the credit card transaction template.


 
 Example:  "CC-TXN-001"
name
required
string
Name for the credit card transaction template.


 
 Example:  "CC-TXN-001 - Business Purchases - Office Supplies"
description
string
Description for the credit card transaction template.


 
 Example:  "Credit card transaction template for purchasing business office supplies"
payee
string
Payee associated with the credit card transactions using this template.


 
 Example:  "Office Solutions"
taxImplication
string or null
 Default:  null
Defines how tax-related details are handled for credit card transactions using this template. Only applies to companies using the Taxes application.


 Enum: "inbound" "none" null  
 Example:  "inbound"
object
Defines the tax structure to be applied to credit card transactions using this template. Only applies to companies using the Taxes application.


 
key
string
Unique key for the tax schedule.


 
 Example:  "11"
id
string
Unique identifier of the tax schedule.


 
 Example:  "11"
object
Specifies the tax solution used to calculate or manage taxes for credit card transactions using this template. Only applies to companies using the Taxes application.


 
key
string
Unique key for the tax solution.


 
 Example:  "2"
id
string
Unique identifier for the tax solution.


 
 Example:  "Australia - GST"
Array of objects
Line items for the credit card transactions using this template.


 
 Array 
memo
string
Memo


 
 Example:  "memo-created-by-rule"
lineNumber
integer
Line number for the line items that use this template.


 
 Example:  1
isBillable
boolean
 Default:  false
Indicates whether the line item is billable.


 
 Example:  true
object
Exchange rate used to calculate the base amount for line items using this template.


 
object
Label for the accounts payable account associated with the line item using this template.


 
object
General ledger account the line item is assigned to.


 
object
 
object
Credit card transaction template that contains the line items.


 
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"
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"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "CC-TXN-005 Software NA",
  • "name": "Software NA - CC TXNs",
  • "description": "Template for North American software credit card transactions.",
  • "lines": [
    • {
      • "lineNumber": 1,
      • "isBillable": true,
      • "glAccount": {
        },
      • "dimensions": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "78",
    • "id": "CC-TXN-078",
    • "href": "/objects/cash-management/credit-card-txn-template/78"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a credit card transaction template
get/objects/cash-management/credit-card-txn-template/{key}
Returns detailed information for a specified credit card transaction template.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the credit card transaction template.


 
 Example:  3
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "3",
    • "id": "CC-TXN-VAT-003",
    • "name": "VAT Payment - CC TXNs",
    • "description": "Template for VAT payments using a credit card.",
    • "payee": "Revenue Service",
    • "numberOfRulesUsingTemplate": 0,
    • "status": "active",
    • "audit": {
      • "createdDateTime": "2025-04-11T12:56:46Z",
      • "modifiedDateTime": "2025-04-11T12:56:46Z",
      • "createdByUser": {
        },
      • "createdBy": "159",
      • "modifiedByUser": {
        }
      },
    • "taxImplication": "inbound",
    • "taxSolution": {
      • "key": "1",
      • "id": "Australia - GST",
      • "href": "/objects/tax/tax-solution/1"
      },
    • "taxSchedule": {
      • "name": "G11 Other Acquisition",
      • "key": "10",
      • "id": "10",
      • "href": "/objects/tax/purchasing-tax-schedule/10"
      },
    • "isInclusiveTax": true,
    • "lines": [
      • {
        }
      ],
    • "href": "/objects/cash-management/credit-card-txn-template/3"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a credit card transaction template
patch/objects/cash-management/credit-card-txn-template/{key}
Updates an existing credit card transaction template by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the credit card transaction template.


 
 Example:  3
Request Body schema: application/json
name
string
Name for the credit card transaction template.


 
 Example:  "CC-TXN-001 - Business Purchases - Office Supplies"
description
string
Description for the credit card transaction template.


 
 Example:  "Credit card transaction template for purchasing business office supplies"
payee
string
Payee associated with the credit card transactions using this template.


 
 Example:  "Office Solutions"
taxImplication
string or null
 Default:  null
Defines how tax-related details are handled for credit card transactions using this template. Only applies to companies using the Taxes application.


 Enum: "inbound" "none" null  
 Example:  "inbound"
object
Defines the tax structure to be applied to credit card transactions using this template. Only applies to companies using the Taxes application.


 
key
string
Unique key for the tax schedule.


 
 Example:  "11"
id
string
Unique identifier of the tax schedule.


 
 Example:  "11"
object
Specifies the tax solution used to calculate or manage taxes for credit card transactions using this template. Only applies to companies using the Taxes application.


 
key
string
Unique key for the tax solution.


 
 Example:  "2"
id
string
Unique identifier for the tax solution.


 
 Example:  "Australia - GST"
Array of objects
Line items for the credit card transactions using this template.


 
 Array 
memo
string
Memo


 
 Example:  "memo-created-by-rule"
lineNumber
integer
Line number for the line items that use this template.


 
 Example:  1
isBillable
boolean
 Default:  false
Indicates whether the line item is billable.


 
 Example:  true
object
Exchange rate used to calculate the base amount for line items using this template.


 
object
Label for the accounts payable account associated with the line item using this template.


 
object
General ledger account the line item is assigned to.


 
object
 
object
Credit card transaction template that contains the line items.


 
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"
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"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "189",
  • "lines": [
    • {
      • "key": "160",
      • "lineNumber": 1,
      • "isBillable": false
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "189",
    • "id": "CC-TXN-189",
    • "href": "/objects/cash-management/credit-card-txn-template/189"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a credit card transaction template
delete/objects/cash-management/credit-card-txn-template/{key}
Deletes a credit card transaction template.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the credit card transaction 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
    }
}