PHphorest
Tax

Retrieve a tax rate

Get a tax rate for the specified business id, branch id and tax rate id

get/api/business/{businessId}/branch/{branchId}/taxrate/{taxId}

Request

  • Base URL
    http://api-gateway-eu.phorest.com/third-party-api-server
  • Auth
    HTTP basic

Path parameters

businessIdstring required
branchIdstring required
taxIdstring required

Response

Specified tax rate retrieved

taxIdstring

Unique id for the taxRate

namestring

The customTypeName given to the tax rate.

ratenumber

The total tax amount.

type'SERVICE' | 'PRODUCT'

The type of item this tax applies to. Can be either SERVICE or PRODUCT

Example response

{
  "taxId": "mWkA6EjdLDyTGL7APWsPxw",
  "name": "VAT 12.5% rate",
  "rate": 12.35,
  "type": "SERVICE"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.