Fees Taxes

Overview

This resource represents Fees Taxes - the taxes for a fee, which can be either configured to be included in fee's rate or not.

Parameters

OAuth Scopes:

public

Name	Type	Read/Write	Description
account	Integer	Read	Account's ID related to the Fees Tax
fee	Integer	Read	Fee's ID related to the Fees Tax
tax	Integer	Read	Tax's ID related to the Fees Tax
id	Integer	Read	Fees Tax's id.
tax_included_in_rate	Boolean	Read	Whether Tax amount is already included in fee's rate or not. If fee's rate is 100 and there is a tax with a percentage of 10% assigned to it, that tax would already be included in 100 if it the value was set to true. However, if set to false, the "total" amount (in the context of Bookings) would be 100 + 10% from 100 which is 110.
created_at	Time	Read	Fees Tax's create time.
updated_at	Time	Read	Fees Tax's update time.

rates_write

Name	Type	Read/Write	Description	Constraints
account	Integer	Read	Account's ID related to the Fees Tax
fee	Integer	Read	Fee's ID related to the Fees Tax
tax	Integer	Read	Tax's ID related to the Fees Tax
id	Integer	Read	Fees Tax's ID.
tax_id	Integer	Write	Tax's ID.	Required
tax_included_in_rate	Boolean	Read/Write	Whether Tax amount is already included in fee's rate or not. If fee's rate is 100 and there is a tax with a percentage of 10% assigned to it, that tax would already be included in 100 if it the value was set to true. However, if set to false, the "total" amount (in the context of Bookings) would be 100 + 10% from 100 which is 110.	Required
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

OAuth Scopes:

rates_write

response.json

{
  "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": [
    {
      "links": {
        "fee": 2,
        "tax": 2
      },
      "id": 3,
      "tax_included_in_rate": true,
      "created_at": "2015-08-04T15:23:57Z",
      "updated_at": "2015-08-04T15:23:57Z"
    }
  ],
  "meta": {}
}

Get a single fees tax

Returns a single fees tax identified by ID.

GET /fees_taxes/:fees_tax_id

OAuth Scopes:

rates_write

response.json

{
  "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": [
    {
      "links": {
        "fee": 2,
        "tax": 2
      },
      "id": 3,
      "tax_included_in_rate": true,
      "created_at": "2015-08-04T15:23:57Z",
      "updated_at": "2015-08-04T15:23:57Z"
    }
  ],
  "meta": {}
}

Create a new fees tax

Returns a newly created fees tax.

POST /fees/:fee_id/fees_taxes

OAuth Scopes:

rates_write

request.json

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

response.json

{
  "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": [
    {
      "links": {
        "fee": 2,
        "tax": 2
      },
      "id": 3,
      "tax_included_in_rate": true,
      "created_at": "2015-08-04T15:23:57Z",
      "updated_at": "2015-08-04T15:23:57Z"
    }
  ],
  "meta": {}
}

Update a fees tax

Returns an updated fees tax identified by ID.

PUT /fees_taxes/:fees_tax_id

OAuth Scopes:

rates_write

request.json

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

response.json

{
  "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": [
    {
      "links": {
        "fee": 2,
        "tax": 2
      },
      "id": 3,
      "tax_included_in_rate": true,
      "created_at": "2015-08-04T15:23:57Z",
      "updated_at": "2015-08-04T15:23:57Z"
    }
  ],
  "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