RErecruitwithatlas
Fees

Get fee details

Changed on

Use this endpoint to retrieve the full details of a single fee by its ID.

A fee represents a financial charge tied to a project — typically a placement fee earned when a candidate is successfully hired. Fees progress through four statuses: projected (expected but not yet confirmed), earned (confirmed/won), invoiced (invoice sent to client), and paid (payment received).

Each fee may have one or more splits, which define how the fee revenue is distributed among individual fee earners (users) within the agency. Each split specifies a percentage share and can carry its own fee type and notes. If no splits have been defined for a fee, the splits array will be empty.

All monetary amounts (amount, defaultAmount, and split share) are returned as decimal strings to preserve precision.

What you need to provide:

  • The fee's ID in the URL path

What you get back: The fee record with all of its splits.

get/api/v1/fees/{id}

Request

Path parameters

idstring uuid required

Fee ID

Example:550e8400-e29b-41d4-a716-446655440000

Response

Fee details

status'ok' required

Example response

{
  "data": {
    "feeType": {
      "name": "Placement Fee"
    },
    "feeDate": "2025-06-15",
    "amount": "15000.00",
    "defaultAmount": "15000.00",
    "currency": "GBP",
    "defaultCurrency": "GBP",
    "projectFeeStatus": "earned",
    "splits": [
      {
        "feeEarner": {
          "name": "Jane Smith",
          "email": "jane@agency.com"
        },
        "feeType": {
          "name": "Placement Fee"
        },
        "share": "60.00"
      }
    ]
  }
}

Changes