TaskCosts

Archive a task cost

post/v3/administrations/{administration_id}/task_costs/{id}/archive

Request

  • Base URL
    https://api.bookingexperts.com
  • Auth
    • API key in header X-API-KEY
    • or OAuth 2
      Authorization code/oauth/authorize
      Token URL/oauth/token

Path parameters

administration_idstring required

Administration ID

idstring required

Resource ID

Query parameters

fields[task_cost]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": {
    "id": "1",
    "type": "task_cost",
    "relationships": {
      "account": {
        "data": {
          "type": "ledger_account"
        }
      },
      "used_materials": {
        "data": [
          {
            "type": "used_material"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "ledger_account",
      "attributes": {
        "current_vat_rate": 25
      },
      "relationships": {
        "vat_code": {
          "data": {
            "type": "vat_code"
          }
        }
      }
    }
  ]
}

Response

TaskCostResponse

Example response

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

Changes

    • info

      added the new optional request property data/attributes/description/da-DK

    • info

      added the new optional request property data/attributes/description/en-GB

    • info

      added the new optional request property data/attributes/description/en-US

    3 more changes in this revision