logo
Powered by Redocly

Billing

Endpoints for reporting on practice spend.

Get a list of billing item's for an organisation

Gets a list of billing item details for the organisation

Securityapi_key or azure_auth
Request
path Parameters
OrganisationSlug
required
string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$

The organisation slug to retrieve billing records for

Example: s8n6EzC
query Parameters
dateFrom
string <date-time>

The date to retrieve letters from

Example: dateFrom=2024-10-24T14:30:15+02:00
dateTo
string <date-time>

The date to retrieve letters to

Example: dateTo=2024-10-24T14:30:15+02:00
pageSize
integer <int32> [ 1 .. 250 ]

The page number to retrieve

Example: pageSize=50
nextPageToken
string

A token retrieved from a previous request, used to retrieve the next page of results

Responses
200

The billing item details for this organisation

400

Malformed Request (ProblemDetails)

401

Unauthorized - Provide proof of identity (ProblemDetails)

403

Forbidden - Insufficient permissions (ProblemDetails)

404

Not Found - Could not find a matching entity (ProblemDetails)

409

ProblemDetails

412

ProblemDetails

422

Unprocessable - Request was well formed but could not be actioned (ProblemDetails)

429

Too many requests - Chill out (ProblemDetails)

4XX

User Error (ProblemDetails)

5XX

Server Error (ProblemDetails)

get/management/organisations/{OrganisationSlug}/billing
Request samples 
Response samples 
application/json
{
  • "Items": [
    ],
  • "NextPageToken": "eyJ0eXAiOi"
}
Get a summary of billing for an organisation
Gets a summary of billing for an organisation


Securityapi_key or azure_auth 
Request 
path Parameters
OrganisationSlug
required
string <slug>  (Slug) ^[osl][a-zA-Z0-9]{3,}$
The organisation slug to retrieve the billing summary for


 
 Example:  s8n6EzC
query Parameters
dateFrom
string <date-time> 
The start of the date range of the billing summary (inclusive)


 
 Example:  dateFrom=2024-10-24T14:30:15+02:00
dateTo
string <date-time> 
The end of the date range of the billing summary (inclusive)


 
 Example:  dateTo=2024-10-24T14:30:15+02:00
Responses 
200
The billing summary


400
Malformed Request (ProblemDetails)


401
Unauthorized - Provide proof of identity (ProblemDetails)


403
Forbidden - Insufficient permissions (ProblemDetails)


404
Not Found - Could not find a matching entity (ProblemDetails)


409
ProblemDetails


412
ProblemDetails


422
Unprocessable - Request was well formed but could not be actioned (ProblemDetails)


429
Too many requests - Chill out (ProblemDetails)


4XX
User Error (ProblemDetails)


5XX
Server Error (ProblemDetails)


get/management/organisations/{OrganisationSlug}/billing/summary
Request samples 
Response samples 
application/json
{
  • "DateFrom": "2019-08-24",
  • "DateTo": "2019-08-24",
  • "Items": [
    ]
}
Get a specific billing item's details
Gets a specific billing item's details


Securityapi_key or azure_auth 
Request 
path Parameters
OrganisationSlug
required
string <slug>  (Slug) ^[osl][a-zA-Z0-9]{3,}$
The organisation slug to retrieve billing records for


 
 Example:  s8n6EzC
ItemId
required
string <uuid> 
The unique identifier of the billing item


 
 Example:  44088399-d916-4de5-9f0a-dca7b3d07df2
Responses 
200
The billing item's details


400
Malformed Request (ProblemDetails)


401
Unauthorized - Provide proof of identity (ProblemDetails)


403
Forbidden - Insufficient permissions (ProblemDetails)


404
Not Found - Could not find a matching entity (ProblemDetails)


409
ProblemDetails


412
ProblemDetails


422
Unprocessable - Request was well formed but could not be actioned (ProblemDetails)


429
Too many requests - Chill out (ProblemDetails)


4XX
User Error (ProblemDetails)


5XX
Server Error (ProblemDetails)


get/management/organisations/{OrganisationSlug}/billing/{ItemId}
Request samples 
Response samples 
application/json
{
  • "Id": "38a5a5bb-dc30-49a2-b175-1de0d1488c43",
  • "EventId": "string",
  • "RelatedItemId": "string",
  • "Sku": "POST.LETTER.A4",
  • "SkuDescription": "POST - LETTER (A4)",
  • "Pax": 0,
  • "SiteSlug": "s8n6EzC",
  • "BillingOrganisationSlug": "s8n6EzC",
  • "Timestamp": "2024-10-24T14:30:15+02:00"
}
➔ Next to Site Details