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 with a key, ID, and link for each credit card transaction template.

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
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
System-assigned 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
System-assigned key for the tax solution.


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


 
 Example:  "Australia - GST"
Array of objects
 
 Array 
memo
string
Memo


 
 Example:  "memo-created-by-rule"
lineNumber
integer
Line number


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


 
 Example:  true
object
Exchange rate details used to calculate the base amount.


 
object
Meaningful name of AP account.


 
object
GL account the line item is assigned to.


 
object
 
object
Header level details for the credit card transaction 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"
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 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": {
      • "createdBy": "1",
      • "modifiedBy": "1",
      • "modifiedDateTime": "2022-11-29T21:45:22Z"
      },
    • "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 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
System-assigned 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
System-assigned key for the tax solution.


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


 
 Example:  "Australia - GST"
Array of objects
 
 Array 
memo
string
Memo


 
 Example:  "memo-created-by-rule"
lineNumber
integer
Line number


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


 
 Example:  true
object
Exchange rate details used to calculate the base amount.


 
object
Meaningful name of AP account.


 
object
GL account the line item is assigned to.


 
object
 
object
Header level details for the credit card transaction 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"
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 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
    }
}
Query credit card transaction 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/credit-card-txn-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 result set, 4000 maximum.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "cash-management/credit-card-txn-template",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "name",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "123",
      • "id": "CC-TXN-123 Software GST",
      • "name": "Canadian Software Subscriptions - GST",
      • "href": "/objects/cash-management/credit-card-txn-template/123"
      },
    • {
      • "key": "256",
      • "id": "CC-TXN-256 Marketing GST",
      • "name": "Canadian Marketing Expenses - GST",
      • "href": "/objects/cash-management/credit-card-txn-template/256"
      },
    • {
      • "key": "283",
      • "id": "CC-TXN-283 Travel GST",
      • "name": "Canadian Travel Expenses - GST",
      • "href": "/objects/cash-management/credit-card-txn-template/283"
      },
    • {
      • "key": "378",
      • "id": "CC-TXN-378 Professional GST",
      • "name": "Canadian Professional Services - GST",
      • "href": "/objects/cash-management/credit-card-txn-template/378"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}