{"swagger":"2.0","info":{"version":"v4-deposits","title":"agentOS Api V4, Deposits Call Group"},"host":"live-api.letmc.com","schemes":["https"],"paths":{"/v4/deposits/{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/deposits/{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/deposits/{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/deposits/{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/deposits/{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/deposits/{shortName}/deposits/{branchID}/tenancies/{offset}/{count}":{"get":{"tags":["DepositsController"],"summary":"Export deposit details for tenancies:-","operationId":"DepositsController_GetDepositForTenanices","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 branch ID:-","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/TenancyDepositModelResults"}}}}}},"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"}}},"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"}}},"TenancyDepositModelResults":{"description":"Holds results from a paged query returning Tenancy Deposit Model values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/TenancyDepositModel"}},"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"}}}},"TenancyDepositModel":{"description":"Tenancy Deposit Model:-","type":"object","properties":{"OID":{"description":"The Unique Tenany OID:-","type":"string","readOnly":true},"TenancyAddress":{"$ref":"#/definitions/TenancyAddressModel","description":"Tenancy Address Model:-","readOnly":true},"TenancyDetails":{"description":"Tenancy Tenants Details Model:-","type":"array","items":{"$ref":"#/definitions/TenancyTenantsDetailsModel"},"readOnly":true},"LandlordDetails":{"description":"Landlord Details Model:-","type":"array","items":{"$ref":"#/definitions/TenancyLandlordDetailsModel"},"readOnly":true},"TenancyStartDate":{"format":"date-time","description":"Tenancy Start Date:-","type":"string","readOnly":true},"TenancyEndDate":{"format":"date-time","description":"Tenancy End Date:-","type":"string","readOnly":true},"TenancyLengthMonths":{"format":"int32","description":"Tenancy Length in Months:-","type":"integer","readOnly":true},"RentAmount":{"format":"double","description":"Rent Amount:-","type":"number","readOnly":true},"RentFrequency":{"format":"int32","description":"Rent Frequency (Recurrence):-","type":"integer","readOnly":true},"DepositRequired":{"format":"double","description":"Deposit Required:-","type":"number","readOnly":true},"DepositAmountToProtect":{"format":"double","description":"Deposit Amount To Protect:-","type":"number","readOnly":true},"DepositScheme":{"description":"Lettings Service Bond Scheme:-","enum":["Unprotected","TDS","MyDeposits","DPSCustodial","LPS","SafeDeposits","MyDepositsScotland","CapitaEnglandWales","CapitaNorthernIrelandCustodial","CapitaNorthernIrelandInsured","TDSNorthernIrelandCustodial","TDSNorthernIrelandInsured","MyDepositsNorthernIrelandCustodial","MyDepositsNorthernIrelandInsured","DPSInsured","LPSNorthernIrelandCustodial","TDSCustodial"],"type":"string","readOnly":true},"DepositType":{"description":"Lettings Service Bond Type:-","enum":["DontCollect","CollectAndPayToLandlord","CollectAndHoldForLandlord"],"type":"string","readOnly":true},"NumberOfLandlords":{"format":"int32","description":"Number of Landlords:-","type":"integer","readOnly":true}}},"TenancyAddressModel":{"description":"Tenancy Address Model:-","type":"object","properties":{"AddressNumber":{"description":"Tenancy Address number:-","type":"string","readOnly":true},"AddressFlatRoomNumber":{"description":"Tenancy Address Flat Room Number:-","type":"string","readOnly":true},"Address1":{"description":"Tenancy Address 1:-","type":"string","readOnly":true},"Address2":{"description":"Tenancy Address 2:-","type":"string","readOnly":true},"Address3":{"description":"Tenancy Address 3:-","type":"string","readOnly":true},"Address4":{"description":"Tenancy Address 4:-","type":"string","readOnly":true},"AddressPostcode":{"description":"Tenancy Address Postcode:-","type":"string","readOnly":true},"MainPhotoUrl":{"description":"Main Photo URL:-","type":"string","readOnly":true}}},"TenancyTenantsDetailsModel":{"description":"Tenancy Tenants Details Model","type":"object","properties":{"TenantOID":{"description":"The Unique Tenant OID:-","type":"string","readOnly":true},"TenantName":{"description":"Tenants Name:-","type":"string","readOnly":true},"TenantTitle":{"description":"Tenant Title:-","type":"string","readOnly":true},"TenantFirstName":{"description":"Tenant First Name:-","type":"string","readOnly":true},"TenantLastName":{"description":"Tenant Last Name:-","type":"string","readOnly":true},"TenantEmail":{"description":"Tenant Email Address:-","type":"string","readOnly":true},"TenantMobile":{"description":"Tenant Mobile Phone:-","type":"string","readOnly":true},"TenantIsLeadTenant":{"description":"Is Lead Tenant (Head Tenant):-","type":"boolean","readOnly":true},"TenantBondOutstanding":{"format":"double","description":"Tenants Bond Oustanding:-","type":"number","readOnly":true},"TenantBondPaid":{"format":"double","description":"Tenants Bond Paid:-","type":"number","readOnly":true}}},"TenancyLandlordDetailsModel":{"description":"Tenancy Landlord Details Model","type":"object","properties":{"LandlordOID":{"description":"Landlord OID:-","type":"string","readOnly":true},"LandlordTitle":{"description":"Landlord Title:-","type":"string","readOnly":true},"LandlordFirstName":{"description":"Landlord First Name:-","type":"string","readOnly":true},"LandlordLastName":{"description":"Landlord Last Name:-","type":"string","readOnly":true},"LandlordEmail":{"description":"Landlord Email Address:-","type":"string","readOnly":true},"LandlordIsPrimaryLandlord":{"description":"Is Primary Landlord (Main Correspondence):-","type":"boolean","readOnly":true},"LandlordIsBusiness":{"description":"Is Business (Company Landlord):-","type":"boolean","readOnly":true},"LandlordAddressLine1":{"description":"Landlord Address Line 1:-","type":"string","readOnly":true},"LandlordAddressLine2":{"description":"Landlord Address Line 2:-","type":"string","readOnly":true},"LandlordAddressLine3":{"description":"Landlord Address Line 3:-","type":"string","readOnly":true},"LandlordPostcode":{"description":"Landlord Postcode:-","type":"string","readOnly":true},"LandlordCountry":{"description":"Landlord Country:-","type":"string","readOnly":true}}}},"securityDefinitions":{"basic":{"type":"basic","description":"Basic HTTP Authentication"},"apiKey":{"type":"apiKey","description":"ApiKey Authentication","name":"ApiKey","in":"header"}}}