---
title: "List sale fees"
method: GET
path: "/api/business/{businessId}/branch/{branchId}/salefee"
tags: ["SaleFee"]
---

# List sale fees

`GET /api/business/{businessId}/branch/{branchId}/salefee`

## Request

- Base URL: `http://api-gateway-eu.phorest.com/third-party-api-server`
- URL: `http://api-gateway-eu.phorest.com/third-party-api-server/api/business/{businessId}/branch/{branchId}/salefee`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/phorest/apis/third-party-api/docs/api/business/:businessId/branch/:branchId/salefee/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a list of sale fees for the specified business id and branch id. There is an option to include archived sale fees in the list

## Path parameters

- `businessId` string, required
- `branchId` string, required

## Query parameters

- `fetch_archived` boolean

## Response `200`

Sale fees listed

- DataPagedModelSaleFee
  - `_embedded` object
    - `saleFees` SaleFee[]
      - `saleFeeId` string
      - `name` string
      - `type` 'PERCENT' | 'AMOUNT': The type of fee. Can be either PERCENT or AMOUNT
      - `value` number
      - `taxRateId` string
      - `automatic` boolean: Is the fee automatically applied to sales
      - `servicesOnly` boolean: Does the fee only apply to services
      - `archived` boolean
      - `active` boolean
      - `deleted` boolean
      - `createTime` string, date-time
      - `updateTime` string, date-time
      - `restrictedServiceIds` string[]: List of service ids the sale fee does not apply to
  - `page` PageMetadata
    - `size` integer
    - `totalElements` integer
    - `totalPages` integer
    - `number` integer

## Other responses

- `400`: Bad Request
- `404`: Business or branch with the specified ids don't exist
- `429`: Request rate limit exceeded. Current limit set to 100 rps.
- `500`: Internal Server Error

---

[API](https://skmtc.dev/phorest/apis/third-party-api.md) - [All operations](https://skmtc.dev/phorest/apis/third-party-api/llms.txt) - [OpenAPI document](https://skmtc.dev/phorest/apis/third-party-api/revisions/beea6ef29634?raw)