Fees Taxes

  1. List fees taxes
  2. Get a single fees tax
  3. Create a new fees tax
  4. Update a fees tax
  5. Delete fees tax

Parameters

Name Type Read/Write Description
id Integer Read Fees Tax’s id.
tax_included_in_rate Boolean Read Tax amount already included in fee if set to true.
created_at Time Read Fees Tax’s create time.
updated_at Time Read Fees Tax’s update time.
Name Type Read/Write Description
id Integer Read Fees Tax’s id.
tax_id Integer Write Tax’s id.
tax_included_in_rate Boolean Read/Write Tax amount already included in fee if set to true.
created_at Time Read Fees Tax’s create time.
updated_at Time Read Fees Tax’s update time.

List fees taxes

List all fees taxes for a given account(s).

GET /fees_taxes

Response

{
  "links": {
    "fees_taxes.fee": "https://www.bookingsync.com/api/v3/fees/{fees_taxes.fee}",
    "fees_taxes.tax": "https://www.bookingsync.com/api/v3/taxes/{fees_taxes.tax}"
  },
  "fees_taxes": [
    {
      "id": 3,
      "tax_included_in_rate": true,
      "created_at": "2015-08-04T15:23:57Z",
      "updated_at": "2015-08-04T15:23:57Z",
      "links": {
        "fee": 2,
        "tax": 2
      }
    }
  ],
  "meta": {
  }
}

Get a single fees tax

Returns a single fees tax identified by ID.

GET /fees_taxes/:fees_tax_id

Response

{
  "links": {
    "fees_taxes.fee": "https://www.bookingsync.com/api/v3/fees/{fees_taxes.fee}",
    "fees_taxes.tax": "https://www.bookingsync.com/api/v3/taxes/{fees_taxes.tax}"
  },
  "fees_taxes": [
    {
      "id": 3,
      "tax_included_in_rate": true,
      "created_at": "2015-08-04T15:23:57Z",
      "updated_at": "2015-08-04T15:23:57Z",
      "links": {
        "fee": 2,
        "tax": 2
      }
    }
  ],
  "meta": {
  }
}

Create a new fees tax

Returns a newly created fees tax.

POST /fees/:fee_id/fees_taxes

Example JSON request

{
  "fees_taxes": [
    {
      "tax_id": 2,
      "tax_included_in_rate": true
    }
  ]
}

Response

{
  "links": {
    "fees_taxes.fee": "https://www.bookingsync.com/api/v3/fees/{fees_taxes.fee}",
    "fees_taxes.tax": "https://www.bookingsync.com/api/v3/taxes/{fees_taxes.tax}"
  },
  "fees_taxes": [
    {
      "id": 3,
      "tax_included_in_rate": true,
      "created_at": "2015-08-04T15:23:57Z",
      "updated_at": "2015-08-04T15:23:57Z",
      "links": {
        "fee": 2,
        "tax": 2
      }
    }
  ],
  "meta": {
  }
}

Update a fees tax

Returns an updated fees tax identified by ID.

PUT /fees_taxes/:fees_tax_id

Example JSON request

{
  "fees_taxes": [
    {
      "tax_id": 2,
      "tax_included_in_rate": true
    }
  ]
}

Response

{
  "links": {
    "fees_taxes.fee": "https://www.bookingsync.com/api/v3/fees/{fees_taxes.fee}",
    "fees_taxes.tax": "https://www.bookingsync.com/api/v3/taxes/{fees_taxes.tax}"
  },
  "fees_taxes": [
    {
      "id": 3,
      "tax_included_in_rate": true,
      "created_at": "2015-08-04T15:23:57Z",
      "updated_at": "2015-08-04T15:23:57Z",
      "links": {
        "fee": 2,
        "tax": 2
      }
    }
  ],
  "meta": {
  }
}

Delete fees tax

Required OAuth scope: :rates_write

Returns empty response with ‘204 No Content’ status code on success.

DELETE /fees_taxes/:fees_tax_id