Transaction types categorise charges and credits. Use this endpoint to read and maintain them programmatically. For a plain-English explanation of how transaction types work, see the Transaction Types user guide.
Methods
GET
Retrieve Single Transaction Type
/backend/api/v1/transactionTypes/ID: fetch transaction type with specified ID.
List Transaction Types
/backend/api/v1/transactionTypes/: list all transaction types.
Additional Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
limit |
integer | No | Maximum items to return |
offset |
integer | No | Number of items to skip |
createdSince |
datetime | No | Only include items created since |
updatedSince |
datetime | No | Only include items updated since |
Example:
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://example.com/backend/api/v1/transactionTypes/"
POST
/backend/api/v1/transactionTypes/: create a new transaction type. The newly-created transaction type is returned.
The platform blocks duplicate names (case-insensitive).
PATCH
/backend/api/v1/transactionTypes/ID: update transaction type with specified ID. The modified transaction type is returned.
DELETE
/backend/api/v1/transactionTypes/ID: delete transaction type with specified ID.
A transaction type cannot be deleted if any transactions still reference it. Set its availability to Historic instead to retire it.
Fields
| Field | Name | Type | Description |
|---|---|---|---|
| transactionTypeName | Transaction Type | Text | Name of the transaction type as it appears in the system |
| availability | Transaction Type Availability | Preset Value | Availability of this transaction type (Headline, Standard, or Historic) |
| transactionTypeDisplayClass | Transaction Type Display Class | Text | CSS class used for display formatting of this transaction type |
| transactionTypeDisplayPosition | Transaction Type Display Position | Number | Numeric position for ordering this transaction type in displays |
| defaultTransactionCode | Default Transaction Code | Text | Default transaction code used for transactions of this type, typically used for accounting packages |
| customerProducts | Customer Products | Text | Array of customer product names that can use this transaction type |
| isSeat | Is Seat | Preset Value | Whether this transaction type represents a seat-based service |
| defaultTransactionCarrier | Default Transaction Carrier | Preset Value | Default carrier for transactions of this type when no carrier is set on the feature/standard feature (or when the transaction has no feature) |
| addDiscountPlanAllowances | Add Discount Plan Allowances | Preset Value | Whether to add discount plan allowances for transactions of this type |
| transactionTypeDisplayName | Transaction Invoice Name | Text | Name displayed for this transaction type on customer invoices |
| transactionTypeGroup | Transaction Type Group Name | Text | Group name for organising related transaction types on invoices |
| transactionTypeGroupPosition | Transaction Type Group Position | Number | Position within the transaction type group for invoice ordering |
| transactionTypePlatformCommission | Transaction Type Platform Commission | Number |
Related Endpoints
- Transactions: individual transactions that reference a transaction type.
- Feature Types: feature types use transaction types as defaults for one-off and recurring charges.
- Fixed Fee Tariffs: tariff rates can filter by transaction type.