Usage Reports
Automatically collect usage information.
Received's usage API collects usage data from customer software.
Don't forget! APIs must include:
Bearer Token - return from the login call
API version - {"Version": "V0"}
Reporting Customer Usage
The usage API is built out of a main API (Default) and an API add-on (Formatted):
Default Usage API - This is the main API used to collect usage data. When a user does not have a customized usage format, this API will be used with no add-ons. In this scenario, the usage data will be formatted according to Received's default format.
Formatted Usage API - This API is used as an add-on when the user has created a customized usage format in the system. In this scenario, the data will be formatted according to the user's bespoke format.
Report Default Usage
Response
Schema
Term | Type | Description | Example |
---|---|---|---|
| String | Date and time. Standard time format "ISO 8601" | 2024-02-05T19:03:39.784Z |
| String | The ID of the related customer | eaa65954-9eb7-4246-a96c-7f6bc3aac42f |
| String | The ID of the related usage product | 94434ff8-8537-4f72-a5df-a45cca271544 |
| String | Usage quantity | 10 |
| String | Key-value set for the usage report use. Will added as a new column in the report. | |
| String | Validate the usage event match the related document properties: Currency, Entity reference | USD 27db2a0c-a11f-4b2e-bfab-8032d0a5a7a1 |
Response Schema
Term | Type | Description | Example |
---|---|---|---|
event_ref | String | Event reference | d1d3416c-0b33-479e-a42f-dbb74effd290 |
related_document_ref | String | The ID of the related document (Invoice, Credit, Debit) | fffb529d-e5ad-4d87-b1e5-fa5085a675b5 |
related_document_numbers | String | Related document numbers | US-INV-1234 |
Report Formatted Usage
Response
Request Schema
Term | Type | Description | Example |
---|---|---|---|
format_name* | String | Look for the relevant format if ref is undefined | Default Format |
event* | String | Any key value pair that will be processed by the format |
Response Schema
Term | Type | Description | Example |
---|---|---|---|
| String | Event reference | d1d3416c-0b33-479e-a42f-dbb74effd290 |
| String | Related document reference | fffb529d-e5ad-4d87-b1e5-fa5085a675b5 |
| String | Related document numbers | US-INV-1234 |
| String | Related parent document reference ( In case of 'Due upon usage' return also the parent invoice) | cb88774f-fbdd-42ef-b9eb-822e6c581ee1 |
| String | Related parent document numbers ( In case of 'Due upon usage' return also the parent invoice) | US-INV-12345 |
| String | Date and time | ($date-time) |
| String | Customer reference | eaa65954-9eb7-4246-a96c-7f6bc3aac42f |
| String | Customer name | Acme |
| String | Usage product reference | 94434ff8-8537-4f72-a5df-a45cca271544 |
| String | Usage product type (Look for the relevant usage product if ref is undefined | Units |
| Number | Quantity | 10 |
| String | Additional data (User-specific note) | OrderedMap |
Explore More APIs
Edit Usage Event
Updating usage events via API by specifying date, quantity, or additional information allows for real-time adjustments to consumption records, ensuring accurate billing and a transparent overview of service utilization for both providers and clients.
Response
Updated usage event
Edit Formatted Usage Event
Applying changes to usage events via API according to some format, by adjusting attributes like date, quantity, or ancillary data, enables dynamic updates to loosely defined entities, fostering flexibility in managing and reflecting real-world variations in service or product usage.
Response
Updated usage event
Delete Usage Event
Last updated