Whitespace APIs
  1. Contracts
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
        GET
      • Create Contract
        POST
      • get single contract
        GET
      • Ends a specific contract
        PATCH
      • Cancels a specific contract
        DELETE
      • Assign site services
        POST
      • Get all contract documents
        GET
      • Get all Collections by Contract
        GET
      • Upload a document for a given contract
        POST
      • Get Collection by id
        GET
      • Get the next available actions for a contract
        GET
      • Progress workflow associated with contract
        POST
    • 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
      • 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. Contracts

get single contract

GET
/v1/contracts/{id}
Contracts
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/contracts/'
Response Response Example
200 - Example 1
{
    "id": 1,
    "site": {
        "id": 0,
        "organisationName": "string",
        "fullAddress": "string"
    },
    "status": {
        "code": "Q",
        "name": "Quotation"
    },
    "classification": {
        "id": 1,
        "name": "Commercial Refuse"
    },
    "classificationSubtype": {
        "id": 3,
        "name": "Place of Worship"
    },
    "paymentFrequency": {
        "id": 51,
        "name": "Monthly"
    },
    "paymentMethod": {
        "id": 1,
        "name": "BACS"
    },
    "tradingClassification": {
        "id": 1,
        "name": "Sole Trader"
    },
    "reference": "COM-123",
    "purchaseOrderNumber": "PO-CW-001",
    "notes": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. In eget massa sagittis, sollicitudin tortor feugiat, elementum nulla. Suspendisse a quam quis neque interdum sagittis. Sed rutrum ex ante. In cursus pulvinar gravida.",
    "startDate": "2020-04-01T00:00:00Z",
    "endDate": "2021-03-31T23:59:59Z",
    "workflow": {
        "id": 0,
        "state": "Awaiting Confirmation",
        "nextActions": [
            "Confirm"
        ]
    }
}

Request

Path Params
id
integer 
required

Responses

🟢200OK
application/json
Body
Represents a contract at a site, with its associated details.
id
integer 
contract ID
read-onlyrequired
The unique identifier for the contract. This is an integer field.
Example:
1
site
object 
required
The site to which the contract pertains.
id
integer 
required
The unique identifier of the Sites table. This is an auto-incrementing integer field.
organisationName
string  | null 
optional
The business name of the property identified by this site entry, e.g. "Whitespace Work Software". This field has a maximum length of 60 characters.
<= 60 characters
fullAddress
string  | null 
optional
A comma-separated concatenation of the site fields, e.g. "Riverside Court, Douglas Drive, Godalming, Surrey, GU7 1JX".
status
object (ContractStatus) 
required
The status of the contract e.g. "Q - Quotation", "L - Live".
code
string 
read-onlyrequired
The shortened code for the contract status. This is a one-character string.
<= 1 characters
Example:
Q
name
string 
read-onlyrequired
The full name for the contract status. This has a maximum length of 50 characters.
<= 50 characters
Example:
Quotation
classification
object 
required
The classification of the contract 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
classificationSubtype
object 
required
The sub-classification of the contract 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
paymentFrequency
object 
required
The frequency of which payments are made for the services provided by the contract 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 
required
The method of which payments are made for the services provided by the contract 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
tradingClassification
object  | null 
optional
The trading classification recorded against the contract
id
integer 
read-onlyrequired
The unique identifier for the trading classification. This is an integer field.
Example:
1
name
string 
required
The short name for the trading classification. This has a maximum length of 50 characters.
<= 50 characters
Example:
Sole Trader
reference
string  | null 
optional
The reference for the contract. This has a maximum length of 20 characters.
<= 20 characters
Example:
COM-123
purchaseOrderNumber
string  | null 
optional
The purchase order number held against the contract. This has a maximum length of 20 characters.
<= 20 characters
Example:
PO-CW-001
notes
string  | null 
optional
The notes for the contract. This has a maximum length of 1000 characters.
<= 1000 characters
Example:
Lorem ipsum dolor sit amet, consectetur adipiscing elit. In eget massa sagittis, sollicitudin tortor feugiat, elementum nulla. Suspendisse a quam quis neque interdum sagittis. Sed rutrum ex ante. In cursus pulvinar gravida.
startDate
string <date-time>
read-onlyrequired
The date on which the contract starts.
Example:
2020-04-01T00:00:00Z
endDate
string <date-time> | null 
required
The date on which the contract ends. This can be null for open-ended contracts.
Example:
2021-03-31T23:59:59Z
workflow
object (Workflow) 
required
The workflow associated with the contract. The workflow is only active whilst the contract is in quotation status.
id
integer 
workflow instance ID
read-onlyrequired
The unique identifier for a particular instance of the workflow engine. This is an auto-incremented integer field.
state
string 
read-onlyoptional
The current state of the workflow. This has a maximum length of 50 characters.
<= 50 characters
Example:
Awaiting Confirmation
nextActions
array[string]
optional
A list of possible next actions from the current state of the workflow.
>= 0 items
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
Modified at 2025-06-18 14:15:55
Previous
Create Contract
Next
Ends a specific contract
Built with