Billing Tasks
Billing tasks are the background jobs the platform runs to generate invoices, import call data, send emails, and collect payments. The API exposes them read-only, so you can monitor progress and troubleshoot from your own systems. The platform creates and runs these tasks itself; they cannot be created or triggered through the API.
Methods
Section titled “Methods”Retrieve Single Billing Task
Section titled “Retrieve Single Billing Task”/backend/api/v1/billingTasks/ID - fetch the billing task with the specified ID.
List Billing Tasks
Section titled “List Billing Tasks”/backend/api/v1/billingTasks/ - list all billing tasks.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include tasks with a higher ID |
createdSince | datetime | No | Only include tasks added to the queue since the given time |
updatedSince | datetime | No | Only include tasks updated since the given time |
See Endpoints for the standard listing, pagination and timestamp-filter behaviour.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| billingTaskType | Billing Task Type | Preset Value | The billing task type name for this task |
| status | Billing Task Status | Preset Value | Status name of the billing task |
| customerID | Customer | Text | The ID of the customer this billing task is for |
| attached | Task For | HTML | ID of the specific object this task is attached to |
| parameters | Parameters | Text | JSON parameters for the billing task execution |
| priority | Priority | Text | Processing priority of this billing task |
| retryCount | Retry Count | Text | Number of times this task has been retried |
| addedTime | Added Date | Date | Date when this billing task was added to the queue |
| delayTime | Delay Date | Date | Date when this billing task should be processed (if delayed) |
| startedTime | Started Date | Date | Date when processing of this billing task began |
| endedTime | Ended Date | Date | Date when processing of this billing task completed |
| testMode | Test Mode | Text | Whether this task is running in test mode |
| activityLog | Activity Log | Text (Multiline) | Log of processing activities for this billing task |
| id | Billing Task ID | Text | The unique identifier for this billing task |