Charges

Gets a Charge by its Id.

Can retrieve any kind of charge, including those this API cannot itself create, such as rent, management fees and credit notes.

get/charges/{chargeId}

Request

  • Base URL: https://api.alto.zoopladev.co.uk
  • URL: https://api.alto.zoopladev.co.uk/charges/{chargeId}
  • Auth: appAuth (a scheme the document does not define)

Path parameters

chargeIdinteger required

Id of the charge

Headers

AgencyRefstring required

A GUID required in the header of all API requests that grants access to an agent's data

Response

Success

idstring nullable
chargeToPostType'Unspecified' | 'Client' | 'LettingFee' | 'MgmtFee' | 'PropertyFee'
usageType'Charge' | 'RefundItem' | 'RefundCharge' | 'OpeningBalanceCharge' | 'ArrearsCharge'
chargeTypestring 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.

totalNetnumber double
totalVatnumber double
totalGrossnumber double
vatRateType'Exempt' | 'Standard' | 'Reduced' | 'Zero' | 'StandardROI'
chargeDatestring date-time
frequency'Unknown' | 'Weekly' | 'Monthly' | 'Quarterly' | 'Yearly' | 'AdHoc' | 'Daily' | 'Fortnightly' | 'FourWeekly' | 'MonthlyOnLastDay' | 'QuarterlyOnQuarterDays' | 'HalfYearly' | 'HalfYearlyOnQuarterDays'
tenancyIdstring nullable
tenantIdstring nullable
propertyIdstring nullable
landlordIdstring nullable
applicantIdstring nullable
supplierIdstring nullable
branchIdstring nullable
descriptionstring nullable
invoiceReferencestring nullable
invoiceDocumentIdstring nullable
workOrderIdstring nullable
excludeFromArrearsboolean nullable
showInArrearsAfterDaysinteger nullable
sendDocsboolean
paymentMethod'Unknown' | 'Bacs' | 'Cheque' | 'Cash' | 'StandingOrder' | 'DirectDebit' | 'Internet' | 'CreditCard' | 'DebitCard' | 'Transfer' | 'Journal' | 'ReceiptImport' nullable
paymentReferencestring nullable
raiseInAdvanceDaysinteger nullable
raiseEndDatestring date-time nullable
chargeTransactionIdstring nullable
createdDatestring date-time
modifiedDatestring date-time

Changes

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