Whitespace APIs
  1. Sites
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 all SIC codes
      • Get all trading classifications
      • Gets all valid unit prices
      • Gets all valid adhoc unit prices
      • Get all Authorities
    • Sites
      • Get Site by id
        GET
      • Update Site
        PATCH
      • Get all adhoc requests at Site
        GET
      • Get all Contracts by Site
        GET
      • Get available collections days by site and waste stream
        GET
      • Get Site Contacts
        GET
      • Get Site Contact
        GET
      • Update Site Contacts
        PUT
      • Create Site
        POST
      • Create Site Contact
        POST
      • Delete Site Contact
        DELETE
      • Get all contract discounts at the given site
        GET
      • Create a discount
        POST
      • Get a specific contract discount
        GET
      • Set end date for a contract discount
        PATCH
      • Delete a discount
        DELETE
      • Get specific adhoc discount at the given site
        GET
      • Get all adhoc discounts at the site
        GET
      • Create an adhoc discount
        POST
      • Set end date for an adhoc discount
        PATCH
      • Delete an adhoc discount
        DELETE
    • 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. Sites

Get specific adhoc discount at the given site

GET
/v1/sites/{siteId}/adhoc-discounts/{adHocDiscountId}
Sites

Default to show valid discounts only - validFrom <= Today and (validTo >= Today or null)

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/sites//adhoc-discounts/'
Response Response Example
200 - Example 1
{
    "id": 0,
    "description": "string",
    "adhocService": {
        "id": 1,
        "name": "Sack Sales Pre-Paid"
    },
    "adHocItem": {
        "id": 1,
        "name": "SACK-50"
    },
    "amount": 0,
    "unitType": "1",
    "isAbsolute": true,
    "validFrom": "2019-08-24T14:15:22Z",
    "validTo": "2019-08-24T14:15:22Z"
}

Request

Path Params
siteId
integer 
required
site Id
adHocDiscountId
integer 
required
adhoc discount Id

Responses

🟢200OK
application/json
Body
Represents a discount applied to an ad hoc service and optionally an ad hoc item, with its associated details.
id
integer 
required
The unique identifier for the adhoc discount. This is an integer field.
description
string 
required
The description of the contract discount. This has a maximum length of 255 characters.
<= 255 characters
adhocService
object 
required
The adhoc service the discount applies to e.g. "Bin delivery".
id
integer <int32>
read-onlyrequired
The unique identifier for the ad hoc service as stored in the Whitespace database. This is an auto-incremented integer field.
Example:
1
name
string 
required
The short name for the ad hoc service as stored in the Whitespace database. This has a maximum length of 50 characters.
<= 50 characters
Example:
Sack Sales Pre-Paid
adHocItem
object 
optional
The adhoc item the discount applies to e.g. "140L wheelie bin". This field is optional
id
integer <int32>
read-onlyrequired
The unique identifier for the ad hoc item. This is an auto-incremented integer field.
Example:
1
name
string 
required
The short name of the ad hoc item. This has a maximum length of 50 characters.
<= 50 characters
Example:
SACK-50
amount
number 
required
The amount of discount to be applied.
>= 0
unitType
enum<string> 
required
Enum for available unit types.
Allowed values:
12
isAbsolute
boolean 
required
Identifies whether the discount is applied as an absolute or percentage amount. This is a boolean field.
validFrom
string <date-time>
required
The date the adhoc discount is valid from.
validTo
string <date-time> | null 
optional
The date the adhoc discount is valid to. This can be null.
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
Modified at 2025-06-19 07:13:40
Previous
Delete a discount
Next
Get all adhoc discounts at the site
Built with