Invoice Usage Report Profiles
An invoice usage report profile is a template that controls what usage detail accompanies a customer’s invoice, from a simple summary to a full per-number breakdown. See the Invoice Usage Reports guide for how profiles are used.
Methods
Section titled “Methods”Retrieve Single Invoice Usage Report Profile
Section titled “Retrieve Single Invoice Usage Report Profile”/backend/api/v1/invoiceUsageReportCustomerProfiles/ID - fetch the profile with the specified ID.
List Invoice Usage Report Profiles
Section titled “List Invoice Usage Report Profiles”/backend/api/v1/invoiceUsageReportCustomerProfiles/ - list all profiles.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include profiles with a higher ID |
createdSince | datetime | No | Only include profiles created since the given time |
updatedSince | datetime | No | Only include profiles updated since the given time |
/backend/api/v1/invoiceUsageReportCustomerProfiles/ - add a new profile. The newly-added profile will be returned.
/backend/api/v1/invoiceUsageReportCustomerProfiles/ID - update the profile with the specified ID. The modified profile will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/invoiceUsageReportCustomerProfiles/ID - delete the profile with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| name | Invoice Usage Report Profile Name | Text | Descriptive name for this invoice usage report profile |
| description | Description | Text | Optional detailed description of what this profile includes and when it should be used |
| availability | Availability | Preset Value | The availability of this invoice usage report profile |
| customerID | Customer | Text | The ID of the customer this profile is restricted to |
| customerGroups | Customer Groups | Text | Array of customer group names who can use this profile |
| customerUsageReports | Customer Usage Reports | Preset Value(s) | Array of customer usage report types to include |
| siteUsageReports | Site Usage Reports | Preset Value(s) | Array of site usage report types to include |
| campaignUsageReports | Campaign Usage Reports | Preset Value(s) | Array of campaign usage report types to include |
| numberUsageReports | Number Usage Reports | Preset Value(s) | Array of number usage report types to include |
| includeTransactionColumns | Include Transaction Columns | Preset Value(s) | Array of transaction column types to include |
| includeCallColumns | Include Call Columns | Preset Value(s) | Array of call column types to include |
| id | Invoice Usage Report Profile ID | Text | The unique identifier for this invoice usage report profile |
| callDetails | Call Details | Preset Value(s) | Array of call detail report types to include |