Deposits

Get a deposit

Retrieve a single deposit by ID.

get/v1/deposits/{depositId}

Request

  • Base URL: https://api.frihet.io
  • URL: https://api.frihet.io/v1/deposits/{depositId}
  • Auth: API key in header X-API-Key

Path parameters

depositIdstring required

Deposit unique identifier

Query parameters

fieldsstring
Example:id,name,total

Comma-separated list of fields to include in the response. The id field is always included. Example: fields=id,name,total

Response

Deposit details

idstring

Unique identifier

createdAtstring date-time
updatedAtstring date-time
clientIdstring required

ID of the client who made the deposit

clientNamestring required

Client name (denormalized for display)

amountnumber required

Deposit amount (must be positive)

currencystring

Currency code (ISO 4217)

descriptionstring required

Description of the deposit

receivedDatestring date required

Date the deposit was received (YYYY-MM-DD)

paymentMethodstring

Payment method used

paymentReferencestring

Payment reference or transaction ID

status'active' | 'partially_applied' | 'fully_applied' | 'refunded'
appliedAmountnumber

Total amount already applied to invoices

remainingBalancenumber

Remaining balance available for application or refund

refundedAmountnumber

Total amount refunded to the client

Example response

{
  "id": "dep_abc123",
  "clientId": "client_abc123",
  "clientName": "Acme Corp",
  "amount": 750,
  "currency": "EUR",
  "description": "Prepayment for Q2 project",
  "receivedDate": "2026-04-01",
  "paymentMethod": "bank_transfer",
  "paymentReference": "TRF-2026-0042",
  "appliedAmount": 250,
  "remainingBalance": 500
}

Changes

No recorded changes to this operation across all 1 revision of this API.