BObookingexperts
Agreements

PATCH agreement

Changed on

Updates an agreement

patch/v3/administrations/{administration_id}/agreements/{id}

Request

Path parameters

administration_idstring required

Administration ID

idstring required

Resource ID

Query parameters

fields[agreement]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": "agreement",
    "relationships": {
      "owner": {
        "data": {
          "type": "owner"
        }
      },
      "inventory_object": {
        "data": {
          "type": "inventory_object"
        }
      },
      "owners_profile": {
        "data": {
          "type": "owners_profile"
        }
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "owner",
      "attributes": {
        "title": "mr",
        "locale": "cs",
        "country_code": "NL"
      },
      "relationships": {
        "primary_contact": {
          "data": {
            "type": "contact"
          }
        },
        "contacts": {
          "data": [
            {
              "type": "contact"
            }
          ]
        },
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "active_inventory_objects": {
          "data": [
            {
              "type": "inventory_object"
            }
          ]
        },
        "owner_guests": {
          "data": [
            {
              "type": "owner_guest"
            }
          ]
        },
        "active_rentable_identities": {
          "data": {
            "type": "rentable_identity"
          }
        },
        "labels": {
          "data": [
            {
              "type": "label"
            }
          ]
        }
      }
    }
  ]
}

Response

AgreementResponse

Example response

{
  "data": {
    "id": "1",
    "type": "agreement",
    "relationships": {
      "owner": {
        "data": {
          "type": "owner"
        }
      },
      "inventory_object": {
        "data": {
          "type": "inventory_object"
        }
      },
      "owners_profile": {
        "data": {
          "type": "owners_profile"
        }
      },
      "administration": {
        "data": {
          "type": "administration"
        }
      },
      "commission_agreement": {
        "data": {
          "type": "commission_agreement"
        }
      },
      "poule_based_discounts": {
        "data": [
          {
            "type": "poule_based_discount"
          }
        ]
      },
      "rentable_identity": {
        "data": {
          "type": "rentable_identity"
        }
      },
      "rent_earned_account": {
        "data": {
          "type": "ledger_account"
        }
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "owner",
      "attributes": {
        "title": "mr",
        "locale": "cs",
        "country_code": "NL"
      },
      "relationships": {
        "primary_contact": {
          "data": {
            "type": "contact"
          }
        },
        "contacts": {
          "data": [
            {
              "type": "contact"
            }
          ]
        },
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "active_inventory_objects": {
          "data": [
            {
              "type": "inventory_object"
            }
          ]
        },
        "owner_guests": {
          "data": [
            {
              "type": "owner_guest"
            }
          ]
        },
        "active_rentable_identities": {
          "data": {
            "type": "rentable_identity"
          }
        },
        "labels": {
          "data": [
            {
              "type": "label"
            }
          ]
        }
      }
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • warning

      added the new da-DK enum value to the /////// response property for the response status

    • warning

      added the new en-GB enum value to the /////// response property for the response status

    • warning

      added the new en-US enum value to the /////// response property for the response status

    • info

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

    • info

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

    • info

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

    • info

      added the new da-DK enum value to the request property ///////

    • info

      added the new en-GB enum value to the request property ///////

    • info

      added the new en-US enum value to the 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

    • 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

    • info

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

    • info

      added to the / response property anyOf list for the response status