Carrier Transaction Types
A carrier transaction type categorises the charges a carrier raises against you. See the Carrier Transaction Types guide for how they are used.
Methods
Section titled “Methods”Retrieve Single Carrier Transaction Type
Section titled “Retrieve Single Carrier Transaction Type”/backend/api/v1/carrierTransactionTypes/ID - fetch the carrier transaction type with the specified ID.
List Carrier Transaction Types
Section titled “List Carrier Transaction Types”/backend/api/v1/carrierTransactionTypes/ - list all carrier transaction types.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include carrier transaction types with a higher ID |
createdSince | datetime | No | Only include carrier transaction types created since the given time |
updatedSince | datetime | No | Only include carrier transaction types updated since the given time |
/backend/api/v1/carrierTransactionTypes/ - add a new carrier transaction type. The newly-added carrier transaction type will be returned.
/backend/api/v1/carrierTransactionTypes/ID - update the carrier transaction type with the specified ID. The modified carrier transaction type will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/carrierTransactionTypes/ID - delete the carrier transaction type with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| carrier | Carrier | Preset Value | The carrier this transaction type mapping applies to |
| transactionType | Transaction Type | Preset Value | The internal transaction type to map to |
| product | Charge Band | Text | The carrier product or charge band name |
| id | Carrier Transaction Type ID | Text | The unique identifier for this carrier transaction type |
| revisionNumber | Revision | Text | Internal version tracking number for this carrier transaction type |