Carrier Transactions
A carrier transaction is a charge a carrier raises against you, used to reconcile carrier costs against customer billing. See the Carrier Transactions guide for how they are used.
Methods
Section titled “Methods”Retrieve Single Carrier Transaction
Section titled “Retrieve Single Carrier Transaction”/backend/api/v1/carrierTransactions/ID - fetch the carrier transaction with the specified ID.
List Carrier Transactions
Section titled “List Carrier Transactions”/backend/api/v1/carrierTransactions/ - list all carrier transactions.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include carrier transactions with a higher ID |
createdSince | datetime | No | Only include carrier transactions created since the given time |
updatedSince | datetime | No | Only include carrier transactions updated since the given time |
/backend/api/v1/carrierTransactions/ - add a new carrier transaction. The newly-added carrier transaction will be returned.
/backend/api/v1/carrierTransactions/ID - update the carrier transaction with the specified ID. The modified carrier transaction will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/carrierTransactions/ID - delete the carrier transaction with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| carrier | Carrier | Preset Value | The carrier that generated this transaction |
| carrierTransactionProduct | Carrier Product | Text | Product code or identifier from the carrier |
| carrierTransactionDescription | Carrier Description | Text | Description of the service or transaction from the carrier |
| carrierTransactionReference | Carrier Reference | Text | Carrier internal reference number for this transaction |
| carrierTransactionStatus | Carrier Status | Text | Status of the transaction as reported by the carrier |
| customerReference | Customer Reference | Text | Customer reference provided by the carrier |
| numberReference | Number Reference | Text | Number or service identifier from the carrier |
| carrierTransactionSubaccount | Subaccount | Text | Carrier subaccount or division for this transaction |
| customerID | Customer | Number | The ID of the customer this carrier transaction is for |
| numberID | Number | Number | The ID of the number this carrier transaction is for |
| featureID | Feature | Number | The ID of the feature this carrier transaction is for |
| carrierTransactionDate | Carrier Transaction Date | Date | Date the transaction occurred according to the carrier |
| carrierTransactionBillDate | Carrier Transaction Bill Date | Date | Date the carrier billed for this transaction |
| carrierTransactionStartDate | Carrier Transaction Start Date | Date | Start date of the service period for this transaction |
| carrierTransactionEndDate | Carrier Transaction End Date | Date | End date of the service period for this transaction |
| transactionType | Transaction Type | Preset Value | Type of transaction for billing classification |
| carrierTransactionValue | Carrier Transaction Value | Currency | Cost charged by the carrier for this transaction |
| featureCount | Carrier Feature Count | Number | Number of features or units this transaction covers |
| carrierTransactionValueSuggestedRetail | Suggested Retail Value | Currency | Suggested retail price for this transaction |
| file | Fixed Fee File | Preset Value | File this transaction was imported from |
| lineNumber | Line Number | Text | Line number within the import file |
| allocationSource | Allocated | Preset Value | How this transaction was allocated to a customer/number/feature |
| id | Carrier Transaction ID | Text | The unique identifier for this carrier transaction |
| transactionID | Transaction ID | Text | Internal transaction record created from this carrier transaction |