GET /businesses/current/reports/business

Provides a business report for the current business based upon the provided search criteria

Authentication and Authorisation

Requires API Access Token Requires Basic Authentication (Username/Password) Requires one of the following roles
True True BusinessReporter

Request Information

Parameters

Name Source Description
reportCriteria Part of the URI query string The report criteria.

Parameter Properties

  • reportCriteria
    • ActedAs
      Gets or sets the party role.
    • AreaGranularity
      Gets or sets the area granularity.
    • ReferenceIdKeyword
      Gets or sets the company reference id keyword.
    • DateGranularity
      Gets or sets the date granularity.
    • DateRange
      Gets or sets the date range.
      Remarks: Mandatory (both start and end). Accepted range is 2000-01-01T00:00:00Z to 2040-12-31T23:59:59Z.
      Example: dateRange.start=2000-01-01T00:00:00Z
      • End
        The end of the range.
      • Start
        The start of the range.
    • IncludeChildSites
      Gets or sets the include child sites.
    • LastKnownFate
      Gets or sets the last known fate.
    • LastKnownFateGranularity
      Gets or sets the last known fate granularity.
    • SicCode
      Gets or sets the transferor sic code.
    • SicCodeGranularity
      Gets or sets the sic code level.
    • SiteId
      Gets or sets the site id.
    • TransferTypes
      Gets or sets the transfer type.
    • TransferralTypes
      Gets or sets the transferral types.
    • WasteStreamCode
      Gets or sets the waste stream code.
    • WasteStreamCodeGranularity
      Gets or sets the waste stream code granularity.
    • WasteTransferNoteStates
      Gets or sets the waste transfer note state.