Charges

post/tenancies/{tenancyId}/charges

Request

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

Path parameters

tenancyIdstring required

Headers

AgencyRefstring required

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

Request body multipart/form-data

tenantIdstring

The unique identifier for the tenant.

excludeFromArrearsboolean

Excludes the tenancy from arrears. If this is true then Alto.PropertyManagement.Api.Models.Requests.TenancyChargeRequest.ShowInArrearsAfterDays cannot be set. Defaults to false.

showInArrearsAfterDaysinteger

The tenancy will only show in arrears after so many days. Can only receive a positive value if Alto.PropertyManagement.Api.Models.Requests.TenancyChargeRequest.ExcludeFromArrears is false or null. Defaults to 0.

sendDocsboolean

Should the docs be sent. Defaults to false.

paymentMethod'Unknown' | 'Bacs' | 'Cheque' | 'Cash' | 'StandingOrder' | 'DirectDebit' | 'Internet' | 'CreditCard' | 'DebitCard' | 'Transfer' | 'Journal' | 'ReceiptImport'

Payment method.

paymentReferencestring

The payment reference.

raiseInAdvanceDaysinteger

Raise the payment in advance by this many days. Defaults to 0.

raiseEndDatestring date-time

Raise the charge up to and including this date.

chargeType'Maintenance' | 'Deposit' | 'DepositToLandlord' | 'ReferencingFee' | 'AdministrationFee' | 'CheckInFee' | 'CheckOutFee' | 'TenancyAgreementFee' | 'CapitalExpenditure' | 'Cleaning' | 'Electrical' | 'Gardening' | 'Plumbing' | 'GasSafetyCheck' | 'EPC' | 'MaintenanceExpense' | 'InsuranceBuildings' | 'InsuranceContents' | 'InsuranceRentProtection' | 'UtilitiesWater' | 'UtilitiesCouncilTax' | 'UtilitiesElectricity' | 'UtilitiesGas' | 'Decorating' | 'BankCharges' | 'ServiceCharge' | 'GroundRent' | 'ElectricalSafetyCheck' | 'Appliances' | 'KeysLocksmith' | 'Inventory' | 'Furniture' | 'PortableApplianceTest' | 'LeadTest' required
supplierIdstring
invoiceReferencestring
totalNetnumber float
totalVatnumber float
vatRateType'Exempt' | 'Standard' | 'Reduced' | 'Zero' | 'StandardROI'
workOrderIdstring
invoiceDocumentstring binary
descriptionstring
raiseImmediatelyboolean
chargeDatestring date-time

Example request

{
  "tenantId": "123",
  "excludeFromArrears": true,
  "showInArrearsAfterDays": 5,
  "sendDocs": true,
  "paymentMethod": "DirectDebit",
  "paymentReference": "12345",
  "raiseInAdvanceDays": 3,
  "raiseEndDate": "2024-06-01T00:00:00.0000000+00:00"
}

Response

Created

idstring nullable
supplierIdstring nullable
chargeType'Maintenance' | 'Deposit' | 'DepositToLandlord' | 'ReferencingFee' | 'AdministrationFee' | 'CheckInFee' | 'CheckOutFee' | 'TenancyAgreementFee' | 'CapitalExpenditure' | 'Cleaning' | 'Electrical' | 'Gardening' | 'Plumbing' | 'GasSafetyCheck' | 'EPC' | 'MaintenanceExpense' | 'InsuranceBuildings' | 'InsuranceContents' | 'InsuranceRentProtection' | 'UtilitiesWater' | 'UtilitiesCouncilTax' | 'UtilitiesElectricity' | 'UtilitiesGas' | 'Decorating' | 'BankCharges' | 'ServiceCharge' | 'GroundRent' | 'ElectricalSafetyCheck' | 'Appliances' | 'KeysLocksmith' | 'Inventory' | 'Furniture' | 'PortableApplianceTest' | 'LeadTest'
totalNetnumber float
totalVatnumber float
vatRateType'Exempt' | 'Standard' | 'Reduced' | 'Zero' | 'StandardROI'
invoiceReferencestring nullable
invoiceDocumentIdstring nullable
workOrderIdstring nullable
descriptionstring nullable
chargeDatestring date-time
tenantIdstring nullable
tenancyIdstring nullable
propertyIdstring nullable
excludeFromArrearsboolean
showInArrearsAfterDaysinteger
sendDocsboolean
paymentMethod'Unknown' | 'Bacs' | 'Cheque' | 'Cash' | 'StandingOrder' | 'DirectDebit' | 'Internet' | 'CreditCard' | 'DebitCard' | 'Transfer' | 'Journal' | 'ReceiptImport' nullable
paymentReferencestring nullable
raiseInAdvanceDaysinteger
raiseEndDatestring date-time nullable

Changes

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