BigChange

BigChange Reference Data API

The Reference Data API from BigChange — 8 operation(s) for reference data.

Documentation GitHub OpenAPI

Operations 8

GET /v1/departmentCodes Get a list of department codes #

GET /v1/departmentCodes/{departmentCodeId} Retrieves the details of a single department code #

GET /v1/flags Get a list of flags by entity type #

GET /v1/nominalCodes Get a list of nominal codes #

GET /v1/nominalCodes/{nominalCodeId} Get a nominal code by its id #

GET /v1/vatCodes Get a list of VAT codes #

GET /v1/vatCodes/{vatCodeId} Get a VAT code by its id #

GET /v1/vehicleGroups Get a list of vehicle groups #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/bigchange:bigchange-reference-data-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: BigChange DX Reference Data API
  description: Developer Experience API
  version: '1.0'
servers:
- url: https://api.bigchange.com
security:
- bearer: []
tags:
- name: Reference Data
paths:
  /v1/departmentCodes:
    get:
      tags:
      - Reference Data
      summary: Get a list of department codes
      description: Retrieves a paged collection of department codes (required scope stock:read)
      parameters:
      - name: Customer-Id
        in: header
        description: The customer identifier
        required: true
        schema:
          type: integer
          format: int64
      - name: sortBy
        in: query
        description: The field to sort items in the page by
        schema:
          $ref: '#/components/schemas/DepartmentCodeSortOptions'
      - name: direction
        in: query
        description: The direction to apply the sort
        schema:
          $ref: '#/components/schemas/SortDirection'
      - name: id
        in: query
        description: 'Only return department codes where ''id'' matches the value(s) provided (Max items: 50)'
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: pageNumber
        in: query
        description: 'The page number being requested (minimum: 1, maximum: 2147483)'
        schema:
          maximum: 2147483
          minimum: 1
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: 'The page size being requested (minimum: 1, maximum: 1000)'
        schema:
          maximum: 1000
          minimum: 1
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResponseReadDepartmentCodeModel'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
      operationId: getV1DepartmentCodes
      x-operation-id-source: derived
  /v1/departmentCodes/{departmentCodeId}:
    get:
      tags:
      - Reference Data
      summary: Retrieves the details of a single department code
      description: Retrieve the details of a single department code (required scope stock:read)
      parameters:
      - name: Customer-Id
        in: header
        description: The customer identifier
        required: true
        schema:
          type: integer
          format: int64
      - name: departmentCodeId
        in: path
        description: The unique identifier of the department code
        required: true
        schema:
          maximum: 9223372036854776000
          minimum: 1
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadDepartmentCodeModel'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
      operationId: getV1DepartmentCodesByDepartmentCodeId
      x-operation-id-source: derived
  /v1/flags:
    get:
      tags:
      - Reference Data
      summary: Get a list of flags by entity type
      description: Retrieves a collection of flags filtered by entity type (required scope flags:read)
      parameters:
      - name: Customer-Id
        in: header
        description: The customer identifier
        required: true
        schema:
          type: integer
          format: int64
      - name: entityType
        in: query
        description: The entity type to filter flags by
        schema:
          $ref: '#/components/schemas/FlagEntityType'
        example: ContactNote
      - name: sortBy
        in: query
        description: The field to sort items by
        schema:
          $ref: '#/components/schemas/FlagSortOptions'
      - name: direction
        in: query
        description: The direction to apply the sort
        schema:
          $ref: '#/components/schemas/SortDirection'
      - name: pageNumber
        in: query
        description: 'The page number being requested (minimum: 1, maximum: 2147483)'
        schema:
          maximum: 2147483
          minimum: 1
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: 'The page size being requested (minimum: 1, maximum: 1000)'
        schema:
          maximum: 1000
          minimum: 1
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResponseReadFlagModel'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
      operationId: getV1Flags
      x-operation-id-source: derived
  /v1/nominalCodes:
    get:
      tags:
      - Reference Data
      summary: Get a list of nominal codes
      description: Retrieves a paged collection of nominal codes (required scope stock:read)
      parameters:
      - name: Customer-Id
        in: header
        description: The customer identifier
        required: true
        schema:
          type: integer
          format: int64
      - name: sortBy
        in: query
        description: The field to sort items in the page by
        schema:
          $ref: '#/components/schemas/NominalCodeSortOptions'
      - name: direction
        in: query
        description: The direction to apply the sort
        schema:
          $ref: '#/components/schemas/SortDirection'
      - name: id
        in: query
        description: 'Only return nominal codes where ''id'' matches the value(s) provided (Max items: 50)'
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: pageNumber
        in: query
        description: 'The page number being requested (minimum: 1, maximum: 2147483)'
        schema:
          maximum: 2147483
          minimum: 1
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: 'The page size being requested (minimum: 1, maximum: 1000)'
        schema:
          maximum: 1000
          minimum: 1
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResponseReadNominalCodeModel'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
      operationId: getV1NominalCodes
      x-operation-id-source: derived
  /v1/nominalCodes/{nominalCodeId}:
    get:
      tags:
      - Reference Data
      summary: Get a nominal code by its id
      description: Get a nominal code by its id (required scope stock:read)
      parameters:
      - name: Customer-Id
        in: header
        description: The customer identifier
        required: true
        schema:
          type: integer
          format: int64
      - name: nominalCodeId
        in: path
        description: The unique identifer of the nominal code
        required: true
        schema:
          maximum: 9223372036854776000
          minimum: 1
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadNominalCodeModel'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
      operationId: getV1NominalCodesByNominalCodeId
      x-operation-id-source: derived
  /v1/vatCodes:
    get:
      tags:
      - Reference Data
      summary: Get a list of VAT codes
      description: Retrieves a paged collection of VAT codes (required scope stock:read)
      parameters:
      - name: Customer-Id
        in: header
        description: The customer identifier
        required: true
        schema:
          type: integer
          format: int64
      - name: sortBy
        in: query
        description: The field to sort items in the page by
        schema:
          $ref: '#/components/schemas/VatCodeSortOptions'
      - name: direction
        in: query
        description: The direction to apply the sort
        schema:
          $ref: '#/components/schemas/SortDirection'
      - name: id
        in: query
        description: 'Only return nominal codes where ''id'' matches the value(s) provided (Max items: 50)'
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: pageNumber
        in: query
        description: 'The page number being requested (minimum: 1, maximum: 2147483)'
        schema:
          maximum: 2147483
          minimum: 1
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: 'The page size being requested (minimum: 1, maximum: 1000)'
        schema:
          maximum: 1000
          minimum: 1
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResponseReadVatCodeModel'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
      operationId: getV1VatCodes
      x-operation-id-source: derived
  /v1/vatCodes/{vatCodeId}:
    get:
      tags:
      - Reference Data
      summary: Get a VAT code by its id
      description: Get a VAT code by its id (required scope stock:read)
      parameters:
      - name: Customer-Id
        in: header
        description: The customer identifier
        required: true
        schema:
          type: integer
          format: int64
      - name: vatCodeId
        in: path
        description: The unique identifer of the VAT code
        required: true
        schema:
          maximum: 9223372036854776000
          minimum: 1
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadVatCodeModel'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
      operationId: getV1VatCodesByVatCodeId
      x-operation-id-source: derived
  /v1/vehicleGroups:
    get:
      tags:
      - Reference Data
      summary: Get a list of vehicle groups
      description: Retrieves a paged collection of vehicle groups belonging to the authenticated customer (required scope vehicles:read)
      parameters:
      - name: Customer-Id
        in: header
        description: The customer identifier
        required: true
        schema:
          type: integer
          format: int64
      - name: pageNumber
        in: query
        description: 'The page number being requested (minimum: 1, maximum: 2147483)'
        schema:
          maximum: 2147483
          minimum: 1
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: 'The page size being requested (minimum: 1, maximum: 1000)'
        schema:
          maximum: 1000
          minimum: 1
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResponseReadVehicleGroupModel'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemDetails'
                - $ref: '#/components/schemas/HttpValidationProblemDetails'
      operationId: getV1VehicleGroups
      x-operation-id-source: derived
components:
  schemas:
    HttpValidationProblemDetails:
      type: object
      allOf:
      - $ref: '#/components/schemas/ProblemDetails'
      properties:
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      additionalProperties: {}
    PagedResponseReadDepartmentCodeModel:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ReadDepartmentCodeModel'
          description: The items returned for the requested page
        pageNumber:
          type: integer
          description: The page number of the response where 1 is the first page
          format: int32
          example: 2
        pageSize:
          type: integer
          description: The number of items requested for the current page
          format: int32
          example: 100
        pageItemCount:
          type: integer
          description: The number of items returned in the current page
          format: int32
          readOnly: true
          example: 55
      additionalProperties: false
      description: A paged collection of items
    FlagEntityType:
      enum:
      - contactNote
      - job
      - defInvoiceItem
      - contactUser
      - salesOpportunity
      - contactNotePriority
      - assetDefect
      - quote
      - proforma
      - invoice
      - purchaseOrder
      - creditNote
      - deliveryNote
      - appPayment
      - salesOrder
      - jobGroup
      type: string
      description: 'Enumeration representing the types of entities that can have flags<p>Possible values:</p><ul><li><b>contactNote</b>: Flag for contact notes</li><li><b>job</b>: Flag for jobs</li><li><b>defInvoiceItem</b>: Flag for default invoice items</li><li><b>contactUser</b>: Flag for contact users</li><li><b>salesOpportunity</b>: Flag for sales opportunities</li><li><b>contactNotePriority</b>: Flag for contact note priorities</li><li><b>assetDefect</b>: Flag for asset defects</li><li><b>quote</b>: Flag for quotes</li><li><b>proforma</b>: Flag for proformas</li><li><b>invoice</b>: Flag for invoices</li><li><b>purchaseOrder</b>: Flag for purchase orders</li><li><b>creditNote</b>: Flag for credit notes</li><li><b>deliveryNote</b>: Flag for delivery notes</li><li><b>appPayment</b>: Flag for app payments</li><li><b>salesOrder</b>: Flag for sales orders</li><li><b>jobGroup</b>: Flag for job groups</li></ul>'
      example: contactNote
    PagedResponseReadVehicleGroupModel:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ReadVehicleGroupModel'
          description: The items returned for the requested page
        pageNumber:
          type: integer
          description: The page number of the response where 1 is the first page
          format: int32
          example: 2
        pageSize:
          type: integer
          description: The number of items requested for the current page
          format: int32
          example: 100
        pageItemCount:
          type: integer
          description: The number of items returned in the current page
          format: int32
          readOnly: true
          example: 55
      additionalProperties: false
      description: A paged collection of items
    PagedResponseReadNominalCodeModel:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ReadNominalCodeModel'
          description: The items returned for the requested page
        pageNumber:
          type: integer
          description: The page number of the response where 1 is the first page
          format: int32
          example: 2
        pageSize:
          type: integer
          description: The number of items requested for the current page
          format: int32
          example: 100
        pageItemCount:
          type: integer
          description: The number of items returned in the current page
          format: int32
          readOnly: true
          example: 55
      additionalProperties: false
      description: A paged collection of items
    ReadRatePeriodModel:
      type: object
      properties:
        id:
          type: integer
          description: The unique identifier of the rate period
          format: int64
        rate:
          type: number
          description: The VAT rate
          format: double
        startsAt:
          type: string
          description: The start of the period
          format: date-time
      additionalProperties: false
      description: Read rate period model
    PagedResponseReadVatCodeModel:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ReadVatCodeModel'
          description: The items returned for the requested page
        pageNumber:
          type: integer
          description: The page number of the response where 1 is the first page
          format: int32
          example: 2
        pageSize:
          type: integer
          description: The number of items requested for the current page
          format: int32
          example: 100
        pageItemCount:
          type: integer
          description: The number of items returned in the current page
          format: int32
          readOnly: true
          example: 55
      additionalProperties: false
      description: A paged collection of items
    ReadVehicleGroupModel:
      type: object
      properties:
        vehicleGroupId:
          type: integer
          description: The unique identifier of the vehicle group
          format: int64
          example: 5514123
        name:
          type: string
          description: The name of the vehicle group
          example: South East Fleet
      additionalProperties: false
      description: Represents a model that holds information about a vehicle group
    SortDirection:
      enum:
      - ascending
      - descending
      type: string
      description: 'Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>'
      example: ascending
    DepartmentCodeSortOptions:
      enum:
      - code
      - description
      type: string
      description: 'Represents the fields that can be used to sort department codes<p>Possible values:</p><ul><li><b>code</b>: The code</li><li><b>description</b>: The description</li></ul>'
      example: code
    ReadNominalCodeModel:
      type: object
      properties:
        id:
          type: integer
          description: The unique identifier of the nominal code
          format: int64
          example: 5514123
        code:
          type: string
          description: The nominal code
          example: T01
        description:
          type: string
          description: Description of the code
          example: Nominal code for roofing work
        createdAt:
          type: string
          description: The UTC timestamp of when this nominal code was created
          format: date-time
          example: '2022-11-29T16:50:16.0000000+00:00'
      additionalProperties: false
      description: Read nominal code model
    ReadVatCodeModel:
      type: object
      properties:
        id:
          type: integer
          description: The unique identifier of the VAT code
          format: int64
          example: 5514123
        code:
          type: string
          description: The VAT code
          example: T01
        rate:
          type: number
          description: The VAT tax rate of the current period
          format: double
        ratePeriods:
          type: array
          items:
            $ref: '#/components/schemas/ReadRatePeriodModel'
          description: The VAT tax rate periods, if applicable
        isDomesticReverseCharged:
          type: boolean
          description: Is domestic reverse-charge applied
        description:
          type: string
          description: Description of the code
          example: Nominal code for roofing work
        endsAt:
          type:
          - string
          - 'null'
          description: The date the VAT code period ends, null if there is no future period
          format: date-time
        createdAt:
          type: string
          description: The UTC timestamp of when this nominal code was created
          format: date-time
          example: '2022-11-29T16:50:16.0000000+00:00'
      additionalProperties: false
      description: Read VAT code model
    ReadDepartmentCodeModel:
      type: object
      properties:
        id:
          type: integer
          description: The unique identifier of the department code
          format: int64
          example: 123456
        code:
          type: string
          description: The department code the identifies departments within the organisation
          example: C1234
        description:
          type: string
          description: Description of the department code
          example: Finance
        createdAt:
          type: string
          description: The date and time when the record was created
          format: date-time
          example: '2021-07-01T00:00:00.0000000+00:00'
      additionalProperties: false
      description: Represents a model for reading department code information
    FlagSortOptions:
      enum:
      - name
      - createdAt
      type: string
      description: 'Represents the fields that can be used to sort flags<p>Possible values:</p><ul><li><b>name</b>: The name</li><li><b>createdAt</b>: The description</li></ul>'
      example: name
    PagedResponseReadFlagModel:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ReadFlagModel'
        pageNumber:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
        totalItemCount:
          type: integer
          format: int32
      additionalProperties: false
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
          description: A URI reference [RFC3986] that identifies the problem type
          example: https://example.com/probs/out-of-credit
        title:
          type:
          - string
          - 'null'
          description: A short, human-readable summary of the problem type
          example: You do not have enough credit
        status:
          type:
          - integer
          - 'null'
          description: The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
          format: int32
          example: 403
        detail:
          type:
          - string
          - 'null'
          description: A human-readable explanation specific to this occurrence of the problem
          example: Your current balance is 30, but that costs 50
        instance:
          type:
          - string
          - 'null'
          description: A URI reference that identifies the specific occurrence of the problem
          example: /account/12345/msgs/abc
      additionalProperties: {}
    ReadFlagModel:
      type: object
      properties:
        id:
          type: integer
          description: The unique identifier of the flag
          format: int64
          example: 12345
        name:
          type: string
          description: The name of the flag
          example: Urgent
        description:
          type: string
          description: The description of the flag
          example: This flag indicates urgent items
        color:
          type: string
          description: The color associated with the flag
          example: '#FF0000'
        createdAt:
          type: string
          description: The UTC timestamp of when this flag was created
          format: date-time
          example: '2022-11-29T16:50:16.0000000+00:00'
      additionalProperties: false
      description: Read flag model
    NominalCodeSortOptions:
      enum:
      - code
      - description
      type: string
      description: 'Represents the fields that can be used to sort nominal codes<p>Possible values:</p><ul><li><b>code</b>: The code</li><li><b>description</b>: The description</li></ul>'
      example: code
    VatCodeSortOptions:
      enum:
      - code
      - description
      type: string
      description: 'Represents the fields that can be used to sort vat codes<p>Possible values:</p><ul><li><b>code</b>: The code</li><li><b>description</b>: The description</li></ul>'
      example: code
  securitySchemes:
    bearer:
      type: http
      description: Enter the access token only.
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: harvested
  publisher: BigChange
  source: https://api.bigchange.com/swagger/v1/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)