BObookingexperts
Todo UsedMaterials

GET used_materials

Changed on

Returns all used materials for the specified todo

get/v3/administrations/{administration_id}/todos/{todo_id}/used_materials

Request

Path parameters

todo_idstring required

Todo ID

administration_idstring required

Administration ID

Query parameters

page[number]integer

Page number

page[size]integer

Page size

sortstring

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id, created_at, updated_at

fields[used_material]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

filter[id]string

Filter on ID

filter[quantity]string

Filter on quantity

filter[description]string

Filter on description

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[task_cost]string

Filter on task_cost. Specify a comma separated list of IDs to filter on.

filter[todo]string

Filter on todo. Specify a comma separated list of IDs to filter on.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Response

UsedMaterialCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "used_material",
      "relationships": {
        "task_cost": {
          "data": {
            "type": "task_cost"
          }
        },
        "todo": {
          "data": {
            "type": "todo"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "task_cost",
      "relationships": {
        "account": {
          "data": {
            "type": "ledger_account"
          }
        },
        "used_materials": {
          "data": [
            {
              "type": "used_material"
            }
          ]
        }
      }
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status