ConnectCloud Developers

Active articles for the flat-rate article picker (desk:write, desk:admin or hr:work:billing)

GET /api/desk/v1/directory/articles

Module: Desk · operationId: searchArticles · Tag: Configuration · Auth: access token (Authorization: Bearer <accessToken>)

Active masterdata articles matching q by number or name (at most 20) for the booking form of HR's work entries; the id is what a flat-rate work entry's article.id stores.

Parameters

Name In Type Required Description
q query string

Responses

  • 200 Articles (application/json)
  • 403 Error (application/json)
  • 503 Masterdata is not configured or not reachable (application/json)

Fields of the 200 answer:

  • items (array of ArticleOption, required)
    • articleNumber (string, required): Article number in masterdata
    • id (string (uuid), required): Masterdata article id – the article.id of flat-rate work entries in HR
    • name (string, required): Article name
    • unit (string): Sales unit of the article

Example 200 answer:

{
  "items": [
    {
      "articleNumber": "WA-9104",
      "id": "4f6a8c0e-2b4d-4f6a-8c0e-2b4d6f8a0c01",
      "name": "Wartungspauschale Server monatlich",
      "unit": "Monat"
    }
  ]
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/desk/v1/directory/articles' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI