BObookingexperts
Todo UsedMaterials

POST used_material

Changed on

Add a new used material for a Todo

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

Request

Path parameters

todo_idstring required

Todo ID

administration_idstring required

Administration ID

Query parameters

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.

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'.

Request body

Example request

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

Response

UsedMaterialResponse

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 new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • 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