BIbigchange
ReferenceData

Retrieves the details of a single department code

Retrieve the details of a single department code (required scope stock:read)

get/v1/departmentCodes/{departmentCodeId}

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/departmentCodes/{departmentCodeId}
  • Auth
    HTTP bearer

Path parameters

departmentCodeIdinteger required

The unique identifier of the department code

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier of the department code

codestring

The department code the identifies departments within the organisation

descriptionstring

Description of the department code

createdAtstring date-time

The date and time when the record was created

Example response

{
  "id": 123456,
  "code": "C1234",
  "description": "Finance",
  "createdAt": "2021-07-01T00:00:00.0000000+00:00"
}

Changes

No recorded changes to this operation across all 13 revisions of this API.