{"swagger":"2.0","info":{"version":"v4-reporting","title":"agentOS Api V4, Reporting Call Group"},"host":"live-api.letmc.com","schemes":["https"],"paths":{"/v4/reporting/{shortName}/company/branches/{branchID}":{"get":{"tags":["CompanyController"],"summary":"Get a specific branch given its unique Object ID (OID):-","operationId":"CompanyController_GetBranches","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"branchID","in":"path","description":"The unique ID of the Branch","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseBranchModel"}}}}},"/v4/reporting/{shortName}/company/branches/{offset}/{count}":{"get":{"tags":["CompanyController"],"summary":"All branches defined for a company:-","operationId":"CompanyController_GetBranches","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseBranchModelResults"}}}}},"/v4/reporting/{shortName}/company/dataAudit/{offset}/{count}":{"get":{"tags":["CustomReportingController"],"summary":"Return Audit Data Report between to dates:-","operationId":"CustomReportingController_GetLSLAuditDataModel","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"},{"name":"startDate","in":"query","description":"The search from date","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"The search to date","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DataAuditModelResults"}}}}},"/v4/reporting/{shortName}/company/finance/salestypes/{offset}/{count}":{"get":{"tags":["CompanyController"],"summary":"All Finance Sales Types Defined For a Company:-","operationId":"CompanyController_GetFinanceSalesTypes","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseFinanceSalesTypeModelResults"}}}}},"/v4/reporting/{shortName}/company/maintenance/certificatetypes/{offset}/{count}":{"get":{"tags":["CompanyController"],"summary":"All Maintenance Certificate Types Defined For a Company:-","operationId":"CompanyController_GetMaintenanceCertificateTypes","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseMaintenanceCertificateTypeModelResults"}}}}},"/v4/reporting/{shortName}/company/object/{objectID}/customfield":{"get":{"tags":["CompanyController"],"summary":"Get Custom Field by ObjectID:-","operationId":"CompanyController_GetCustomfieldbyID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"objectID","in":"path","description":"The Unique Object ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseCustomField"}}}}},"/v4/reporting/{shortName}/company/objects/{objectID}/{fieldID}/customfield":{"post":{"tags":["CompanyController"],"summary":"Set Custom Field Value:-","operationId":"CompanyController_SetCustomFieldValue","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"objectID","in":"path","description":"The Unique Object ID","required":true,"type":"string"},{"name":"fieldID","in":"path","description":"The Unique Field ID","required":true,"type":"string"},{"name":"value","in":"body","description":"Value to enter (string)","required":true,"schema":{"$ref":"#/definitions/BaseCustomFieldSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/reporting/{shortName}/company/objects/{objectID}/{fieldID}/value":{"get":{"tags":["CompanyController"],"summary":"Get Custom Field Value:-","operationId":"CompanyController_GetCustomFieldValue","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"objectID","in":"path","description":"The Unique Object ID","required":true,"type":"string"},{"name":"fieldID","in":"path","description":"The Unique Field ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/v4/reporting/{shortName}/financials/reports/invoicedSales/{salesTypeID}":{"get":{"tags":["FinancialsController"],"summary":"Retrieve invoiced sales by type for the provided query date (null will default to current month):-","operationId":"FinancialsController_GetInvoicedSalesForMonthByType","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short name","required":true,"type":"string"},{"name":"salesTypeID","in":"path","description":"Sales Type ID to retrieve entries for","required":true,"type":"string"},{"name":"queryDate","in":"query","description":"Date to search for, will search for the 30 days following the provided query date","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InvoicedSalesModelResults"}}}}},"/v4/reporting/{shortName}/financials/reports/rentcollected/latest":{"get":{"tags":["FinancialsController"],"summary":"Retrieve the latest rent collected report from agentOS for the provided query date (null will default to latest month):-","operationId":"FinancialsController_GetLatestRentRollReport","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short name","required":true,"type":"string"},{"name":"queryDate","in":"query","description":"Date to search for, will search for the 30 days following the provided query date","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RentRollModelResults"}}}}},"/v4/reporting/{shortName}/financials/transactions/landlords/{offset}/{count}":{"get":{"tags":["FinancialsController"],"summary":"Retrieve all landlord transactions (linked to properties) for the query date (null will default to last 30 days):-","operationId":"FinancialsController_GetLandlordPaymentsForPast30Days","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short name","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first landlord to retrieve finance entries for at a time","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The total number of landlords to retrieve finance entries for at a time","required":true,"type":"integer","format":"int32"},{"name":"queryDate","in":"query","description":"Date to search for, will search for the 30 days following the provided query date","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FinanceEntryModelResults"}}}}},"/v4/reporting/{shortName}/financials/transactions/landlords/all/{offset}/{count}":{"get":{"tags":["FinancialsController"],"summary":"Retrieve all landlord transactions for the query date (null will default to last 30 days):-","operationId":"FinancialsController_GetAllLandlordPaymentsForPast30Days","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short name","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first landlord to retrieve finance entries for at a time","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The total number of landlords to retrieve finance entries for at a time","required":true,"type":"integer","format":"int32"},{"name":"queryDate","in":"query","description":"Date to search for, will search for the 30 days following the provided query date","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FinanceEntryModelResults"}}}}},"/v4/reporting/{shortName}/lettings/{propertyID}/shareholder":{"get":{"tags":["LettingsController"],"summary":"Retrieve all Landlords by Property ID:-","operationId":"LettingsController_GetOwnersByPropertyID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"","required":true,"type":"string"},{"name":"propertyID","in":"path","description":"","required":true,"type":"string"},{"name":"offset","in":"query","description":"","required":true,"type":"integer","format":"int32"},{"name":"count","in":"query","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PropertyShareHolderModelResults"}}}}},"/v4/reporting/{shortname}/lettings/{tenancyID}/progressionchecklist":{"get":{"tags":["LettingsController"],"summary":"Get Tenancy Progression List by Tenancy ID:-","operationId":"LettingsController_GetTenancyProgressionChecklist","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortname","in":"path","description":"The unique client shortName","required":true,"type":"string"},{"name":"tenancyID","in":"path","description":"The unique Tenancy ID","required":true,"type":"string"},{"name":"offset","in":"query","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"query","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LettingsProgressionChecklistModelResults"}}}}},"/v4/reporting/{shortname}/lettings/{tenancyID}/specialconditions":{"get":{"tags":["LettingsController"],"summary":"Retrieve Special Conditions by Tenancy ID:-","operationId":"LettingsController_GetSpecialConditionsByTenancyID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortname","in":"path","description":"Unique company shortname","required":true,"type":"string"},{"name":"tenancyID","in":"path","description":"The unique Tenancy ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SpecialConditionsModel"}}}}},"/v4/reporting/{shortName}/lettings/applications/failed":{"get":{"tags":["LettingsController"],"summary":"Retrieve all failed tenancy applications for specified query date (null searches for past 30 days):-","operationId":"LettingsController_GetFailedApplications","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short name","required":true,"type":"string"},{"name":"queryDate","in":"query","description":"Date to query for failed applications (will only search 30 days form provided date)","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FailedTenancyApplicationModelResults"}}}}},"/v4/reporting/{shortName}/lettings/certificates/{certificateTypeID}":{"get":{"tags":["LettingsController"],"summary":"Retrieve all maintenance certificates of type:-","operationId":"LettingsController_GetCertificates","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short name","required":true,"type":"string"},{"name":"certificateTypeID","in":"path","description":"Type of certificate to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaintenanceCertificateModelResults"}}}}},"/v4/reporting/{shortname}/lettings/properties/{propertyID}/progressionchecklist":{"get":{"tags":["LettingsController"],"summary":"Get Property Progression List by Property ID:-","operationId":"LettingsController_GetPropertyProgressionChecklist","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortname","in":"path","description":"The unique client shortName","required":true,"type":"string"},{"name":"propertyID","in":"path","description":"The unique Property ID","required":true,"type":"string"},{"name":"offset","in":"query","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"query","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PropertyProgressionChecklistModelResults"}}}}},"/v4/reporting/{shortName}/lettings/tenancies/{offset}/{count}":{"get":{"tags":["LettingsController"],"summary":"Retrieve all tenancies:-","operationId":"LettingsController_GetTenancies","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short name","required":true,"type":"string"},{"name":"offset","in":"path","description":"Index of first result to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"Total number of results to return, max 1000","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ReportingTenancyModelResults"}}}}},"/v4/reporting/{shortname}/sales/{SalesID}/progressionchecklist":{"get":{"tags":["SalesController"],"summary":"Get Sales Progression List by Sales ID:-","operationId":"SalesController_GetSalesProgressionChecklist","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortname","in":"path","description":"The unique client shortName","required":true,"type":"string"},{"name":"SalesID","in":"path","description":"The unique sales instruction ID","required":true,"type":"string"},{"name":"offset","in":"query","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"query","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SalesProgressionChecklistModelResults"}}}}}},"definitions":{"BaseBranchModelResults":{"description":"Holds results from a paged query returning BranchModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/BaseBranchModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"},"Links":{"description":"Base Hypermedia Links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"BaseBranchModel":{"description":"Defines a single branch of a client.","type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"Name":{"description":"The branch name.","type":"string"},"CompanyName":{"description":"The relevant company name, if not the one specified on the branch then the one on company.","type":"string"},"Address1":{"description":"Branch address line 1.","type":"string"},"Address2":{"description":"Branch address line 2.","type":"string"},"Address3":{"description":"Branch address line 3.","type":"string"},"Address4":{"description":"Branch address line 4.","type":"string"},"Postcode":{"description":"Branch address postcode.","type":"string"},"WebAddress":{"description":"Branch web address.","type":"string"},"EMailAddress":{"description":"Branch email address.","type":"string"},"LandPhone":{"description":"Branch land phone number.","type":"string"},"FaxPhone":{"description":"Branch fax phone number.","type":"string"},"County":{"description":"County","type":"string"},"Links":{"description":"Hypermedia links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"BaseHypermediaLink":{"description":"Hypermedia Link Class","type":"object","properties":{"Relationship":{"description":"The hypermedia link relationship to current result object.","type":"string"},"Href":{"description":"The hypermedia href","type":"string"},"Method":{"description":"The http method type","type":"string"}}},"BaseFinanceSalesTypeModelResults":{"description":"Base Finance Sales Type Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/BaseFinanceSalesTypeModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"BaseFinanceSalesTypeModel":{"description":"Base Finance Sales Type Model:-","type":"object","properties":{"OID":{"description":"The unique ID of the Finance Sales Type:-","type":"string"},"Name":{"description":"The name of the finance sales type:-","type":"string"},"NominalCode":{"description":"Nominal Code of finance sales type:-","type":"string"}}},"BaseMaintenanceCertificateTypeModelResults":{"description":"Base Maintenance Certificate Type Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/BaseMaintenanceCertificateTypeModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"BaseMaintenanceCertificateTypeModel":{"description":"Base Finance Sales Type Model:-","type":"object","properties":{"OID":{"description":"The unique ID of the Maintenance Certificate Type:-","type":"string"},"Name":{"description":"The name of the maintenance certificate type:-","type":"string"}}},"BaseCustomField":{"type":"object","properties":{"CustomFields":{"description":"Dynamic Custom Field:-","type":"array","items":{"$ref":"#/definitions/CustomFieldDataModel"}}}},"CustomFieldDataModel":{"type":"object","properties":{"ID":{"description":"Field ID:-","type":"string"},"TabName":{"description":"Tab on OS custom field belongs to:-","type":"string"},"GroupName":{"description":"The grouping on OS the custom field belongs to:-","type":"string"},"FieldName":{"description":"Name of the custom field:-","type":"string"},"Retired":{"description":"Is field retired:-","type":"boolean"},"Value":{"description":"Custom Field Value:-","type":"object"}}},"BaseCustomFieldSubmissionModel":{"type":"object","properties":{"customfieldValue":{"description":"Custom Field Value","type":"string"}}},"DataAuditModelResults":{"description":"Data Audit Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/DataAuditModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"DataAuditModel":{"description":"V4 Data Audit Model:-","type":"object","properties":{"DateEdited":{"format":"date-time","description":"Date entry edited:-","type":"string","readOnly":true},"Staff":{"description":"Name of staff member who edited entry:-","type":"string","readOnly":true},"Address":{"description":"Address of property:-","type":"string","readOnly":true},"FieldChanges":{"description":"Field changes helper model:-","type":"array","items":{"$ref":"#/definitions/CustomFieldChanges"},"readOnly":true}}},"CustomFieldChanges":{"description":"Custom Field Changes:-","type":"object","properties":{"FieldName":{"description":"Field Name:-","type":"string","readOnly":true},"OldValue":{"description":"Old Value:-","type":"object","readOnly":true},"NewValue":{"description":"New Value:-","type":"object","readOnly":true}}},"RentRollModelResults":{"description":"Rent Roll Results Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/RentRollModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"RentRollModel":{"description":"Rent Roll Model:-","type":"object","properties":{"BranchID":{"description":"Branch ID of branch collecting rent:-","type":"string"},"LandlordName":{"description":"Landlord Name:-","type":"string"},"Property":{"description":"Property Rent is for:-","type":"string"},"AmountCollected":{"format":"double","description":"Amount of Rent Collected:-","type":"number"},"CollectionDate":{"format":"date-time","description":"Collection Date:-","type":"string"}}},"InvoicedSalesModelResults":{"description":"Invoiced Sales Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/InvoicedSalesModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"InvoicedSalesModel":{"description":"Invoiced Sales Model:-","type":"object","properties":{"Invoiced":{"format":"date-time","description":"Date Invoice Sent:-","type":"string"},"BranchID":{"description":"ID of branch that issued invoice:-","type":"string"},"Property":{"description":"Property Invoice Relates To:-","type":"string"},"InvoiceGrossAmount":{"format":"double","description":"Gross Amount Of Invoice:-","type":"number"},"InvoiceNetAmount":{"format":"double","description":"Invoice Net Amount:-","type":"number"},"InvoiceVatAmount":{"format":"double","description":"Invoice Net Amount:-","type":"number"},"InvoiceFullyPaid":{"description":"Invoice Fully Paid?:-","type":"boolean"}}},"FinanceEntryModelResults":{"description":"Finance Entry Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/FinanceEntryModel"}},"Count":{"format":"int32","description":"Total number of landlords to get payments for:-","type":"integer"}}},"FinanceEntryModel":{"description":"Finance Entry Model:-","type":"object","properties":{"TransactionOID":{"description":"Unique Trasaction OID:-","type":"string"},"BranchID":{"description":"The branch that handles the transaction:-","type":"string"},"TransactionAmount":{"format":"double","description":"The amount the transaction is for:-","type":"number"},"TransactionPerson":{"description":"The person the transaction is linked to:-","type":"string"},"TransactionProperty":{"description":"The property the transaction is linked to:-","type":"string"},"TransactionAuthorisedDate":{"description":"The date the transaction was authorised:-","type":"string"},"TransactionNumber":{"description":"The transaction number:-","type":"string"}}},"FailedTenancyApplicationModelResults":{"description":"Failed Tenancy Application Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/FailedTenancyApplicationModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"FailedTenancyApplicationModel":{"description":"Failed Tenancy Application Model:-","type":"object","properties":{"TenancyID":{"description":"ID of tenancy application was failed:-","type":"string"},"TenancyETag":{"description":"When tenancy was last modified (The same tenancy model can be cancelled multiple times so use this field to check if the failed application matches the one stored client side):-","type":"string"},"BranchID":{"description":"ID of branch linked to tenancy:-","type":"string"},"TenancyProperty":{"description":"Property linked to tenancy:-","type":"string"},"Landlord":{"description":"Landlord linked to tenancy:-","type":"string"},"FallenThroughDate":{"format":"date-time","description":"Date application fell through:-","type":"string"},"FallenThroughReason":{"description":"Reason application fell through:-","type":"string"},"Charges":{"description":"Charges linked to failed application:-","type":"array","items":{"$ref":"#/definitions/FailedTenancyApplicationChargeModel"},"readOnly":true}}},"FailedTenancyApplicationChargeModel":{"description":"Failed Tenancy Application Charges (These are all the auto charges set up on a property and may not apply to cancelled tenancies.\r\nThe charges will need to be filtered by the client for which charges they apply at the stage where the tenancy is cancelled):-","type":"object","properties":{"ChargeID":{"description":"Charge ID:-","type":"string"},"ChargeETag":{"description":"Charge ETag for if the charge has been modified:-","type":"string"},"ChargeName":{"description":"Charge Name:-","type":"string"},"ChargeAppliesTo":{"description":"What Charge Applies To:-","enum":["NewTenancyAndRenewal","NewTenancyOnly","RenewalOnly"],"type":"string"},"ChargeAmount":{"format":"double","description":"Charge Amount:-","type":"number"},"ChargeOwner":{"description":"Charge Owner:-","type":"string"},"ChargeTitle":{"description":"Title Of The Charge:-","type":"string","readOnly":true}}},"MaintenanceCertificateModelResults":{"description":"Maintenance Certificate Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/MaintenanceCertificateModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"MaintenanceCertificateModel":{"description":"Maintenance Certificate Model:-","type":"object","properties":{"CertificateOID":{"description":"Unique Certificate ID:-","type":"string"},"CertificateETag":{"description":"Certificate ETag (Increments when object is updated):-","type":"string"},"BranchID":{"description":"ID of branch that manages the certificate:-","type":"string"},"Property":{"description":"Property Certificate is linked to:-","type":"string"},"ValidFrom":{"format":"date-time","description":"Certificate Valid From:-","type":"string"},"DueAt":{"format":"date-time","description":"Certificate renewal due at:-","type":"string"},"CertificateResponsibility":{"description":"Party responsible for fulfilling the certificate:-","enum":["Landlord","Tenant","Agent","LandlordContractor"],"type":"string"},"CertificateDescription":{"description":"Description of Certificate:-","type":"string"}}},"ReportingTenancyModelResults":{"description":"Reporting Tenancy Model Results","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/ReportingTenancyModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"ReportingTenancyModel":{"description":"Reporting Tenancy Model:-","type":"object","properties":{"OID":{"description":"Tenancy ID:-","type":"string"},"GlobalReference":{"description":"Tenancy Global Reference:-","type":"string"},"Address":{"$ref":"#/definitions/BaseAddressModel","description":"Tenancy Address:-"},"DisplayAddress":{"description":"Tenancy Display Address:-","type":"string"},"TenancyPropertyGlobalReference":{"description":"Tenancy Property Global Reference:-","type":"string"},"TenancyPorpertyOID":{"description":"Tenancy Property OID:-","type":"string"},"TermStartDate":{"format":"date-time","description":"Start Date of Tenancy Term:-","type":"string"},"TermEndDate":{"format":"date-time","description":"End Date of tenancy term (it can either have this, or abandoned, or neither if tenancy ongoing, not both):-","type":"string"},"TenancyAbandonedDate":{"format":"date-time","description":"Tenancy Abandoned Date (Can be abandoned, ended, or neither, never both):-","type":"string"},"IsAbandoned":{"description":"Has the tenancy been abandoned (only 1 flag will be true at a time):-","type":"boolean"},"IsAdvertised":{"description":"Is the tenancy advertied (only 1 flag will be true at a time):-","type":"boolean"},"IsTenancyClosed":{"description":"Is the tenancy closed (only 1 flag will be true at a time):-","type":"boolean"},"IsTenancyEnded":{"description":"Is the tenancy ended, different from closed as money can still be outstanding on an ended tenancy (only 1 flag will be true at a time):-","type":"boolean"},"IsPeriodic":{"description":"Is tenancy periodic (only 1 flag will be true at a time):-","type":"boolean"},"IsProposed":{"description":"Is the tenancy Let Agreed (only 1 flag will be true at a time):-","type":"boolean"},"IsUpForRenewal":{"description":"Is the tenancy up for renewal (only 1 flag will be true at a time):-","type":"boolean"},"IsRenewed":{"description":"Has the tenancy been renewed (only 1 flag will be true at a time):-","type":"boolean"},"IsSigned":{"description":"Has the tenancy been signed, this indicated the tenancy is currently lived in (only 1 flag will be true at a time):-","type":"boolean"},"BranchID":{"description":"Branch that owns the tenancy:-","type":"string"},"PropertyOwnershipDetails":{"description":"Property Owner Details:-","type":"array","items":{"$ref":"#/definitions/ReportingOwnerModel"}},"TenancyIsArchived":{"description":"Tenancy Is Archived:-","type":"boolean"},"PropertyIsArchived":{"description":"Property Is Archived:-","type":"object"},"ManagementFee":{"format":"double","description":"Get Current Managment Fee","type":"number","readOnly":true}}},"BaseAddressModel":{"description":"Base Address Model:-","type":"object","properties":{"Address1":{"description":"Address 1:-","type":"string"},"Address2":{"description":"Address 2:-","type":"string"},"Address3":{"description":"Address 3:-","type":"string"},"Address4":{"description":"Address 4:-","type":"string"},"Postcode":{"description":"Postcode:-","type":"string"},"FlatOrRoomNumber":{"description":"Flat Or Room Number:-","type":"string"},"AddressNumber":{"description":"Address Number:-","type":"string"}}},"ReportingOwnerModel":{"description":"Extension to owner model to include shareholder's name:-","type":"object","properties":{"Name":{"description":"Shareholder name:-","type":"string"},"OID":{"description":"The Landlord ID:-","type":"string","readOnly":true},"SharePercentage":{"format":"double","description":"Percentage Share of the landlord:-","type":"number","readOnly":true},"ApplyFrom":{"format":"date-time","description":"Apply From:-","type":"string","readOnly":true}}},"PropertyShareHolderModelResults":{"description":"Property Shareholder Model Results Model","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/PropertyShareHolderModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"PropertyShareHolderModel":{"description":"Property Shareholder Model","type":"object","properties":{"PropertyOID":{"description":"PropertyID","type":"string","readOnly":true},"ShareholderOID":{"description":"Current Shareholder ID","type":"string","readOnly":true},"ShareHolderName":{"description":"Current Property Shareholder","type":"string","readOnly":true},"SharePercent":{"format":"double","description":"Shareholder Percentage owned:-","type":"number","readOnly":true}}},"PropertyProgressionChecklistModelResults":{"description":"Property Progression Checklist Model Results","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/PropertyProgressionChecklistModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"PropertyProgressionChecklistModel":{"description":"Property Progression Checklist Model:-","type":"object","properties":{"OID":{"type":"string"},"ChecklistItem":{"description":"Item Name:-","type":"string","readOnly":true},"Comments":{"description":"Comments:-","type":"string","readOnly":true},"Actions":{"description":"Actions to take:-","type":"string","readOnly":true},"CompletedItemProperty":{"$ref":"#/definitions/CompletedItemPropertyModel","description":"Completed Item Property Model:-","readOnly":true},"IsArchived":{"description":"Is object archived in the system:-","type":"boolean","readOnly":true},"AsssignedTo":{"description":"Item Assigned to:-","type":"string","readOnly":true},"DueDays":{"format":"date-time","description":"Due Date Days :-","type":"string","readOnly":true}}},"CompletedItemPropertyModel":{"description":"Completed Item Property Model:-","type":"object","properties":{"CompletedBy":{"description":"Completed By:-","type":"string","readOnly":true},"CompletedDate":{"format":"date-time","description":"Completed Date:-","type":"string","readOnly":true}}},"LettingsProgressionChecklistModelResults":{"description":"Lettings Progression Checklist Model Results","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/LettingsProgressionChecklistModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"LettingsProgressionChecklistModel":{"description":"Lettings Progression Checklist Model:-","type":"object","properties":{"OID":{"type":"string"},"ChecklistItem":{"description":"Item Name:-","type":"string","readOnly":true},"Comments":{"description":"Comments:-","type":"string","readOnly":true},"Actions":{"description":"Actions to take:-","type":"string","readOnly":true},"CompletedItemLettings":{"$ref":"#/definitions/CompletedItemLettingsModel","description":"Completed Item Lettings Model:-","readOnly":true},"IsArchived":{"description":"Is object archived in the system:-","type":"boolean","readOnly":true},"AsssignedTo":{"description":"Assigned to:-","type":"string","readOnly":true},"DueDays":{"format":"date-time","description":"Due Date Days:-","type":"string","readOnly":true}}},"CompletedItemLettingsModel":{"description":"Completed Item Lettings Model:-","type":"object","properties":{"CompletedBy":{"description":"Completed By","type":"string","readOnly":true},"CompletedDate":{"format":"date-time","description":"Completed Date:-","type":"string","readOnly":true}}},"SpecialConditionsModel":{"description":"Model to help retrieve special conditions:-","type":"object","properties":{"TenancyOID":{"description":"The Unique Tenancy OID","type":"string","readOnly":true},"SpecialConditions":{"description":"Special Conditions Helper Module:-","type":"array","items":{"$ref":"#/definitions/SpecialConditionsHelperModel"},"readOnly":true}}},"SpecialConditionsHelperModel":{"description":"Special Conditions Helper Model:-","type":"object","properties":{"SpecialConditionsOID":{"description":"Special Conditions OID:-","type":"string","readOnly":true},"Condition":{"description":"The Special Condition:-","type":"string","readOnly":true},"CreatedAt":{"format":"date-time","description":"Created At:-","type":"string","readOnly":true}}},"SalesProgressionChecklistModelResults":{"description":"Sales Progression Checklist Model Results","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/SalesProgressionChecklistModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"SalesProgressionChecklistModel":{"description":"Sales Progression Checklist Model:-","type":"object","properties":{"OID":{"type":"string"},"ChecklistItem":{"description":"Item Name:-","type":"string","readOnly":true},"Actions":{"description":"Remaining actions to do:-","type":"string","readOnly":true},"Comments":{"description":"Comments :-","type":"string","readOnly":true},"CompletedItem":{"$ref":"#/definitions/CompletedItemModelSales","description":"Completed Item Model:-","readOnly":true},"IsArchived":{"description":"Is object archived in the system:-","type":"boolean","readOnly":true},"AsssignedTo":{"description":"Assigned to:-","type":"string","readOnly":true},"DueDays":{"format":"int32","description":"Number of Due Days:-","type":"integer","readOnly":true}}},"CompletedItemModelSales":{"description":"Completed Sales Lettings Model:-","type":"object","properties":{"CompletedBy":{"description":"Completed By:-","type":"string","readOnly":true},"CompletedDate":{"format":"date-time","description":"Completed Date:-","type":"string","readOnly":true}}}},"securityDefinitions":{"basic":{"type":"basic","description":"Basic HTTP Authentication"},"apiKey":{"type":"apiKey","description":"ApiKey Authentication","name":"ApiKey","in":"header"}}}