Whitespace APIs
  1. Lookups
Whitespace APIs
  • Home
    • Welcome to the Whitespace API Developer Portal
  • Municipal REST
    • Municipal
      • Get resources for this service.
      • call the AddAoMRoundLogs operation.
      • call the AddAoMWorksheetLogs operation.
      • call the AddSiteAttachment operation.
      • call the AddSiteContact operation.
      • call the AddSiteLog operation.
      • call the AddSiteServiceItem operation.
      • call the AddSiteServiceItemRoundSchedule operation.
      • call the AddSiteServiceNotification operation.
      • call the AddWorksheetAttachment operation.
      • call the AddWorksheetNotes operation.
      • call the CancelWorksheet operation.
      • call the CreateWorksheet operation.
      • call the DeleteSiteContact operation.
      • call the DeleteSiteServiceItem operation.
      • call the DeleteSiteServiceItemRoundSchedule operation.
      • call the GetAccountSiteId operation.
      • call the GetActiveAddresses operation.
      • call the GetAddresses operation.
      • call the GetAddressesByCoordinatesRadius operation.
      • call the GetCollectionByUprnAndDate operation.
      • call the GetCollectionByUprnAndDatePlus operation.
      • call the GetCollectionSlots operation.
      • call the GetFullSiteCollections operation.
      • call the GetFullWorksheetDetails operation.
      • call the GetInCabLogs operation.
      • call the GetLogsSearch operation.
      • call the GetNotifications operation.
      • call the GetServices operation.
      • call the GetServiceItems operation.
      • call the GetSites operation.
      • call the GetSiteAttachments operation.
      • call the GetSiteAvailableRounds operation.
      • call the GetSiteCollections operation.
      • call the GetSiteCollectionExtraDetails operation.
      • call the GetSiteContacts operation.
      • call the GetSiteContracts operation.
      • call the GetSiteFlags operation.
      • call the GetSiteId operation.
      • call the GetSiteIncidents operation.
      • call the GetSiteInfo operation.
      • call the GetSiteLogs operation.
      • call the GetSiteNotifications operation.
      • call the GetSiteServiceItemRoundSchedules operation.
      • call the GetSiteWorksheets operation.
      • call the GetStreets operation.
      • call the GetWalkNumbers operation.
      • call the GetWorkflowStatusAndEvents operation.
      • call the GetWorksheetsByReference operation.
      • call the GetWorksheetAttachments operation.
      • call the GetWorksheetChargeMatrix operation.
      • call the GetWorksheetDetails operation.
      • call the GetWorksheetDetailEvents operation.
      • call the GetWorksheetDetailExtraInfoFields operation.
      • call the GetWorksheetDetailNotes operation.
      • call the GetWorksheetDetailServiceItems operation.
      • call the GetWorksheetExtraInfoFields operation.
      • call the GetWorksheetRoles operation.
      • call the GetWorksheetServiceItems operation.
      • call the HelloWorld operation.
      • call the ProgressWorkflow operation.
      • call the RaiseCancelWorksheetRequest operation.
      • call the UpdateSiteContact operation.
      • call the UpdateSiteServiceItem operation.
      • call the UpdateSiteServiceNotification operation.
      • call the UpdateWorkflowEventDate operation.
      • call the UpdateWorksheet operation.
  • Commercial REST
    • Contracts
      • get all contracts
      • Create Contract
      • get single contract
      • Ends a specific contract
      • Cancels a specific contract
      • Assign site services
      • Get all contract documents
      • Get all Collections by Contract
      • Upload a document for a given contract
      • Get Collection by id
      • Get the next available actions for a contract
      • Progress workflow associated with contract
    • Accounts
      • Get accounts - TBC
      • Create Account
      • Get account by Id
      • Update Account
      • Get all Sites belonging to account
      • Get all adhoc requests at account
      • Get all documents for an account
      • Get all Contracts by Account
    • Lookups
      • Get addresses
        GET
      • Get all SIC codes
        GET
      • Get all trading classifications
        GET
      • Gets all valid unit prices
        GET
      • Gets all valid adhoc unit prices
        GET
      • Get all Authorities
        GET
    • Sites
      • Get Site by id
      • Update Site
      • Get all adhoc requests at Site
      • Get all Contracts by Site
      • Get available collections days by site and waste stream
      • Get Site Contacts
      • Get Site Contact
      • Update Site Contacts
      • Create Site
      • Create Site Contact
      • Delete Site Contact
      • Get all contract discounts at the given site
      • Create a discount
      • Get a specific contract discount
      • Set end date for a contract discount
      • Delete a discount
      • Get specific adhoc discount at the given site
      • Get all adhoc discounts at the site
      • Create an adhoc discount
      • Set end date for an adhoc discount
      • Delete an adhoc discount
    • Worksheets
      • Create adhoc request
      • Get adhoc request by Id
      • Get adhoc request actions
      • Get all ad hoc request documents
      • Progress adhoc request actions
      • Upload a document for a given adhoc request
    • Waste Streams
      • Get all contract classification subtypes
      • Get all waste streams
      • Get all waste stream unit prices
      • Get all waste stream adhoc prices
      • Get all waste stream adhoc prices
      • Get all contract classifications
      • Get all payment methods
      • Get all collection items
      • Get all collection items
      • Get all payment frequencies
    • Adhoc Services
      • Gets all adhoc price classifications
      • Gets all adhoc services
      • Gets all adhoc items for a service
    • Collections
      • Assign site services
      • Get Collection by id
    • Discounts
      • Gets all contracts where a discount is applied
    • Documents
      • Gets a document
      • Delete a document Copy
      • Update a document
  1. Lookups

Gets all valid unit prices

GET
/v1/unit-prices
Lookups
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/unit-prices'
Response Response Example
200 - Example 1
[
    {
        "id": 1,
        "contractClassification": {
            "id": 1,
            "name": "Commercial Refuse"
        },
        "contractClassificationSubtype": {
            "id": 3,
            "name": "Place of Worship"
        },
        "wasteStream": {
            "id": 1,
            "name": "Clinical Collection Service"
        },
        "wasteStreamItem": {
            "id": 1,
            "name": "FW-240"
        },
        "paymentFrequency": {
            "id": 51,
            "name": "Monthly"
        },
        "paymentMethod": {
            "id": 1,
            "name": "BACS"
        },
        "price": 1.25,
        "validFromDate": "2020-04-01",
        "validToDate": "2021-03-31",
        "vatRate": 0.2
    }
]

Request

None

Responses

🟢200OK
application/json
Body
array of:
id
integer 
read-onlyrequired
The primary identifier for this price record. This is an auto-incremented integer field
Example:
1
contractClassification
object 
read-onlyrequired
The contract classification the unit price pertains to e.g. "Commercial waste".
id
integer <int32>
read-onlyrequired
The unique identifier for the contract classification. This is an auto-incremented integer value.
Example:
1
name
string 
required
The short name of the contract classification. This has a maximum length of 50 characters.
<= 50 characters
Example:
Commercial Refuse
contractClassificationSubtype
object 
read-onlyrequired
The sub-classification the unit price pertains to e.g. "Internal".
id
integer <int32>
read-onlyrequired
The unique identifier for the contract classification subtype. This is an auto-incremented integer field.
Example:
3
name
string 
required
The name of the contract classification subtype. This field has a maximum length of 50 characters.
<= 50 characters
Example:
Place of Worship
wasteStream
object 
read-onlyrequired
The waste stream the unit price pertains to e.g. "Recycling".
id
integer <int32>
read-onlyrequired
The unique identifier for the waste stream as stored in the Whitespace database. This is an auto-incremented integer field.
Example:
1
name
string 
required
The short name for the waste stream as stored in the Whitespace database. This has a maximum length of 50 characters.
<= 50 characters
Example:
Clinical Collection Service
wasteStreamItem
object 
read-onlyrequired
The waste stream item the unit price pertains to e.g. "140L wheelie bin".
id
integer 
read-onlyrequired
The unique identifier for the waste stream item as stored in the Whitespace database. This is an auto-incremented integer field.
Example:
1
name
string 
required
The short name for the waste stream item as stored in the Whitespace database. This has a maximum length of 50 characters.
<= 50 characters
Example:
FW-240
paymentFrequency
object 
read-onlyrequired
The payment frequency the unit price pertains to e.g. "Quaterly".
id
integer <int32>
read-onlyrequired
The unique identifier for the payment frequency as stored in the Whitespace database. This is an integer field.
Example:
51
name
string 
required
The short name for the payment frequency as stored in the Whitespace database. This has a maximum length of 50 characters.
<= 50 characters
Example:
Monthly
paymentMethod
object 
read-onlyrequired
The payment method the unit price pertains to e.g. "Invoice".
id
integer <int32>
read-onlyrequired
The unique identifier for the payment method as stored in the Whitespace database. This is an auto-incremented integer field.
Example:
1
name
string 
required
The short name for the payment method. This field has a maximum length of 25 characters.
<= 25 characters
Example:
BACS
price
number 
read-onlyrequired
The monetary value of the price entry per individual unit
>= 0
Example:
1.25
validFromDate
string <date>
read-onlyrequired
The starting date of the valid period for this price entry
Example:
2020-04-01
validToDate
string <date> | null 
read-onlyrequired
The ending date of the valid period for this price entry. This is an optional date field; entries without a validToDate are valid for any period after the validFromDate
Example:
2021-03-31
vatRate
number 
read-onlyrequired
The VAT rate for this charge, recorded as a floating-point number
>= 0
Example:
0.2
🟠401Unauthorized
🟠403Forbidden
Modified at 2025-06-18 14:15:55
Previous
Get all trading classifications
Next
Gets all valid adhoc unit prices
Built with