---
title: "List Charges"
method: GET
path: "/charges"
tags: ["Charges"]
---

# List Charges

`GET /charges`

## Request

- Base URL: `https://api.alto.zoopladev.co.uk`
- URL: `https://api.alto.zoopladev.co.uk/charges`
- Auth: `appAuth` (a scheme the document does not define)

Retrieves a paginated list of charges for a given AgencyRef and all permissible branches,
ordered by charge id. Returns any kind of charge, as GET /charges/{chargeId} does.

## Query parameters

- `next-token` string
- `max-results` integer
- `sort-order` 'Asc' | 'Desc'
- `raised` boolean

## Headers

- `AgencyRef` string, required

## Response `200`

Success

- AltoPropertyManagementApiModelsResponsesPagedResults1AltoPropertyManagementApiModelsResponsesChargeDetail
  - `meta` AltoPropertyManagementApiModelsResponsesMeta
    - `nextToken` string, nullable
    - `totalItems` integer
  - `items` AltoPropertyManagementApiModelsResponsesChargeDetail[], nullable
    - `id` string, nullable
    - `chargeToPostType` 'Unspecified' | 'Client' | 'LettingFee' | 'MgmtFee' | 'PropertyFee'
    - `lettingFee` AltoPropertyManagementApiModelsResponsesLettingFeeBasis: What a letting fee was calculated from, in place of an amount the agent typed. Present only when Alto.PropertyManagement.Api.Models.Responses.ChargeDetail.ChargeToPostType is LettingFee.
      - `rentalAmount` number, double
      - `rentalTermMonths` integer
      - `rentalFrequency` 'Unknown' | 'Weekly' | 'Monthly' | 'Quarterly' | 'Yearly' | 'AdHoc' | 'Daily' | 'Fortnightly' | 'FourWeekly' | 'MonthlyOnLastDay' | 'QuarterlyOnQuarterDays' | 'HalfYearly' | 'HalfYearlyOnQuarterDays'
      - `letPercent` number, double, nullable
    - `managementFee` AltoPropertyManagementApiModelsResponsesManagementFeeBasis: What a management fee was calculated from, in place of an amount the agent typed. Present only when Alto.PropertyManagement.Api.Models.Responses.ChargeDetail.ChargeToPostType is MgmtFee.
      - `mgmtPercent` number, double
      - `deductFromGross` boolean
      - `applyToChargeDate` boolean
      - `cancelledDate` string, date-time, nullable
    - `usageType` 'Charge' | 'RefundItem' | 'RefundCharge' | 'OpeningBalanceCharge' | 'ArrearsCharge'
    - `chargeType` string, nullable: Where the nominal code is one this API's POST endpoints model, this is the Alto.PropertyManagement.Api.Models.ChargeType member name — the same value those endpoints accept and return. Other codes (e.g. rent, management fees) fall back to the nominal code's display name.
    - `totalNet` number, double
    - `totalVat` number, double
    - `totalGross` number, double
    - `vatRateType` 'Exempt' | 'Standard' | 'Reduced' | 'Zero' | 'StandardROI'
    - `chargeDate` string, date-time
    - `frequency` 'Unknown' | 'Weekly' | 'Monthly' | 'Quarterly' | 'Yearly' | 'AdHoc' | 'Daily' | 'Fortnightly' | 'FourWeekly' | 'MonthlyOnLastDay' | 'QuarterlyOnQuarterDays' | 'HalfYearly' | 'HalfYearlyOnQuarterDays'
    - `tenancyId` string, nullable
    - `tenantId` string, nullable
    - `propertyId` string, nullable
    - `landlordId` string, nullable
    - `applicantId` string, nullable
    - `supplierId` string, nullable
    - `branchId` string, nullable
    - `description` string, nullable
    - `invoiceReference` string, nullable
    - `invoiceDocumentId` string, nullable
    - `workOrderId` string, nullable
    - `excludeFromArrears` boolean, nullable
    - `showInArrearsAfterDays` integer, nullable
    - `sendDocs` boolean
    - `paymentMethod` 'Unknown' | 'Bacs' | 'Cheque' | 'Cash' | 'StandingOrder' | 'DirectDebit' | 'Internet' | 'CreditCard' | 'DebitCard' | 'Transfer' | 'Journal' | 'ReceiptImport', nullable
    - `paymentReference` string, nullable
    - `raiseInAdvanceDays` integer, nullable
    - `raiseEndDate` string, date-time, nullable
    - `chargeTransactionId` string, nullable
    - `createdDate` string, date-time
    - `modifiedDate` string, date-time

## Other responses

- `400`: Bad request

---

[API](https://skmtc.dev/alto/apis/alto-api.md) - [All operations](https://skmtc.dev/alto/apis/alto-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alto/apis/alto-api/revisions/1b729d9b15a8?raw)