{"swagger":"2.0","info":{"version":"v3-sales","title":"agentOS API V3, Sales Call Group"},"host":"live-api.letmc.com","schemes":["https"],"paths":{"/v3/sales/{shortName}/contacts/getbuyers":{"get":{"tags":["ContactsController"],"summary":"Retrieve active applicant buyers","operationId":"ContactsController_GetBuyers","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"Unique client short-name","required":true,"type":"string"},{"name":"branchID","in":"query","description":"The branch ID to retrieve buyers for","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)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SalesApplicantBuyerModelResults"}}}}},"/v3/sales/{shortName}/contacts/getbuyers/{buyerID}":{"get":{"tags":["ContactsController"],"summary":"Retrieve active applicant buyer by ID","operationId":"ContactsController_GetBuyerByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"Unique client short-name","required":true,"type":"string"},{"name":"buyerID","in":"path","description":"The unique buyer ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SalesApplicantBuyerModel"}}}}},"/v3/sales/{shortName}/contacts/getvendors":{"get":{"tags":["ContactsController"],"summary":"Retrieve active vendors","operationId":"ContactsController_GetVendors","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"Unique client short-name","required":true,"type":"string"},{"name":"branchID","in":"query","description":"The branch ID to retrieve buyers for","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)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SalesVendorModelResults"}}}}},"/v3/sales/{shortName}/contacts/getvendors/{vendorID}":{"get":{"tags":["ContactsController"],"summary":"Retrieve active vendor by ID","operationId":"ContactsController_GetVendorByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"Unique client short-name","required":true,"type":"string"},{"name":"vendorID","in":"path","description":"The unqiue vendor id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SalesVendorModel"}}}}},"/v3/sales/{shortName}/offers/{offerID}":{"get":{"tags":["OffersController"],"summary":"Return offer by ID","operationId":"OffersController_GetOfferByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"offerID","in":"path","description":"The sales offer ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SalesOfferModel"}}}}},"/v3/sales/{shortName}/salesinstructions/{salesInstructionID}":{"get":{"tags":["SalesInstructionsController"],"summary":"Return sales instruction by ID","operationId":"SalesInstructionsController_GetSalesInstructionByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"salesInstructionID","in":"path","description":"The sales offer ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SalesInstructionModel"}}}}}},"definitions":{"SalesApplicantBuyerModelResults":{"description":"Helper results model","type":"object","properties":{"Data":{"description":"Results Data","type":"array","items":{"$ref":"#/definitions/SalesApplicantBuyerModel"}},"Count":{"format":"int32","description":"Results Count","type":"integer"}}},"SalesApplicantBuyerModel":{"description":"Represents a applicant buyer.","type":"object","properties":{"OID":{"description":"OID","type":"string"},"ETag":{"description":"ETag","type":"string"},"Title":{"description":"Title","type":"string"},"Forename":{"description":"Forename","type":"string"},"MiddleName":{"description":"Middle name","type":"string"},"Surname":{"description":"Surname","type":"string"},"Email":{"description":"Email","type":"string"},"PhoneNumber":{"description":"Phone Number","type":"string"},"AddressNumber":{"description":"Prospect address number","type":"string"},"Address1":{"description":"Prospect address 1","type":"string"},"Address2":{"description":"Prospect address 2","type":"string"},"Address3":{"description":"Prospect address 3","type":"string"},"Address4":{"description":"Prospect address 4","type":"string"},"Postcode":{"description":"Prospect postcode","type":"string"},"PurchasePriceMinimum":{"format":"double","description":"Purchase price minimum","type":"number"},"PurchasePricetMaximum":{"format":"double","description":"Purchase price maximum","type":"number"},"RequirementsNotes":{"description":"Requirements notes","type":"string"},"BuyingPosition":{"description":"Buying position","enum":["Cash","FirstTimeBuyer","Mortgage","Investor","NeedsToSell","Company","Other","SSTC"],"type":"string"},"SellingPosition":{"description":"Selling position","enum":["PropertyOnMarket","PropertyNotOnMarket","PropertyUnderOffer","NoNeedToSell","Other"],"type":"string"},"PurchaseReason":{"description":"Sales purchase reason","enum":["Downsizing","Upsizing","ChangingArea","SecondHome","InvestmentProperty","Other","FirstTimeBuyer"],"type":"string"},"MortgageOffered":{"description":"Mortgage offered status","enum":["NoMortgageInPlace","AgreementInPrinciple","Other","NoMortageRequired"],"type":"string"},"LinkedOfferIDs":{"description":"ID's of linked offers to buyer","type":"array","items":{"type":"string"}}}},"SalesVendorModelResults":{"description":"Helper model for sales vendor model results","type":"object","properties":{"Data":{"description":"Results Data","type":"array","items":{"$ref":"#/definitions/SalesVendorModel"}},"Count":{"format":"int32","description":"Results Count","type":"integer"}}},"SalesVendorModel":{"description":"Sales Vendor Model","type":"object","properties":{"OID":{"description":"Unique Identifer","type":"string"},"Title":{"description":"Vendor Title","type":"string"},"Forename":{"description":"Vendor Forename","type":"string"},"MiddleName":{"description":"Vendor Middle Name","type":"string"},"Surname":{"description":"Vendor Surname","type":"string"},"Email":{"description":"Vendor Email","type":"string"},"PhoneNumber":{"description":"Vendor Phone Number","type":"string"},"Address1":{"description":"Vendor Address 1","type":"string"},"Address2":{"description":"Vendor Address 2","type":"string"},"Address3":{"description":"Vendor Address 3","type":"string"},"Address4":{"description":"Vendor Address 4","type":"string"},"AddressNumber":{"description":"Vendor Address Number","type":"string"},"Postcode":{"description":"Vendor Postcode","type":"string"},"LinkedInstructionIDs":{"description":"Array of Sales Instruction ID's linked to the vendor","type":"array","items":{"type":"string"}}}},"SalesOfferModel":{"description":"Sales Offer Model","type":"object","properties":{"OID":{"description":"Unique Offer ID","type":"string"},"ETag":{"description":"Offer ETag","type":"string"},"Amount":{"format":"double","description":"Offer amount","type":"number"},"FixturesFitting":{"description":"Offer Fixtures Fitting","type":"string"},"HowCloseToAsking":{"description":"How close offer is to asking price","type":"string"},"LinkedSalesInstructionID":{"description":"The linked sales instruction for the offer","type":"string"},"NegotiatorID":{"description":"The unique negotiator ID","type":"string"},"Notes":{"description":"Offer Notes","type":"string"},"OfferDate":{"description":"Offer Date","type":"string"},"LinkedBuyerID":{"description":"The unique buyer ID for the offer","type":"string"},"SpecialTerms":{"description":"Special terms of the offer","type":"string"},"State":{"description":"State of the offer","enum":["Pending","Accepted","Declined","DeclinedOfferRevised","Withdrawn","AcceptedFallenThrough","ReferredToVendor"],"type":"string"},"SubjectTo":{"description":"Offer subject to","type":"string"},"SubjectToContract":{"description":"Offer subject to contract","type":"boolean"},"SubjectToMortgage":{"description":"Offer subject to mortgage","type":"boolean"},"SubjectToSurvey":{"description":"Offer subject to survey","type":"boolean"}}},"SalesInstructionModel":{"description":"Sales Instruction Model","type":"object","properties":{"OID":{"description":"Unique sales instruction ID","type":"string"},"GlobalReference":{"description":"Global reference","type":"string"},"ETag":{"description":"ETag","type":"string"},"AcceptedOfferID":{"description":"ID of accepted offer","type":"string"},"Address1":{"description":"Address 1","type":"string"},"Address2":{"description":"Address 2","type":"string"},"Address3":{"description":"Address 3","type":"string"},"Address4":{"description":"Address 4","type":"string"},"AddressNumber":{"description":"Address Number","type":"string"},"Postcode":{"description":"Postcode","type":"string"},"Advertised":{"format":"date-time","description":"Date sales instruction was advertised","type":"string"},"AppraisalGuidePrice":{"format":"double","description":"Appraisal guide price","type":"number"},"AppraisalHighGuidePrice":{"format":"double","description":"Appraisal guide price (High limit)","type":"number"},"AppraisalLowGuidePrice":{"format":"double","description":"Appraisal guide price (low limit)","type":"number"},"AppraisalNotes":{"description":"Appraisal notes","type":"string"},"BranchID":{"description":"Branch ID of sales instruction","type":"string"},"Price":{"format":"double","description":"Price of sales instruction","type":"number"},"PriceHistory":{"description":"Historic price data of sales instruction","type":"array","items":{"$ref":"#/definitions/PriceHistoryModel"}},"ProposedCompletionDate":{"format":"date-time","description":"Estimated date of completion","type":"string"},"PurchaserSignedContracts":{"format":"date-time","description":"Date buyer signed contracts","type":"string"},"RentalYield":{"format":"double","description":"Potential rent from sales instruction","type":"number"},"SaleBy":{"description":"Sold by","enum":["PrivateTreaty","ByAuction","Confidential","ByTender","OffersInvited","POA","GuidePrice","FixedPrice","OffersInExcessOf","OffersInRegionOf","SharedOwnership","PartBuyPartRent","SharedEquity","EquityLoan"],"type":"string"},"SaleFeeFixed":{"format":"double","description":"Fixed sale fee","type":"number"},"SaleFeePercent":{"format":"double","description":"Percentage sale fee","type":"number"},"SalesNumber":{"format":"int32","description":"Sales number","type":"integer"},"LinkedVendorID":{"description":"ID of linked vendor","type":"string"},"LinkedSecondVendorID":{"description":"ID of second linked vendor if available","type":"string"},"ServiceCharge":{"format":"double","description":"Sale service charge","type":"number"},"State":{"description":"State of sales instruction","enum":["MarketAppraisal","LostAppraisal","Instructed","Advertised","UnderOffer","ContractsExchanged","Completed","FallenThrough","Withdrawn"],"type":"string"},"Stats":{"description":"Sales instructions stats","type":"array","items":{"type":"string"}},"Summary":{"description":"Sales instruction summary","type":"string"},"SurveyDate":{"format":"date-time","description":"Date sales instruction was surveyed","type":"string"},"Tenure":{"description":"Tenure","enum":["Freehold","Leasehold","Commonhold","ShareOfFreehold","FlyingFreehold","ShareTransfer","Unknown"],"type":"string"},"UnderOffer":{"format":"date-time","description":"Date sale was under offer","type":"string"},"VendorSignedContract":{"format":"date-time","description":"Date vendor signed contract","type":"string"},"ViewingNotes":{"description":"Viewing Notes","type":"string"},"ViewingsOwnerConfirmation":{"description":"Require owner confirmation for viewings","type":"boolean"},"Withdrawn":{"format":"date-time","description":"Sale withdrawn","type":"string"}}},"PriceHistoryModel":{"description":"Helper model for price history model","type":"object","properties":{"SaleDate":{"format":"date-time","description":"Date of the sale","type":"string"},"SalePrice":{"format":"double","description":"Price of the sale","type":"number"}}}},"securityDefinitions":{"basic":{"type":"basic","description":"Basic HTTP Authentication"},"apiKey":{"type":"apiKey","description":"ApiKey Authentication","name":"ApiKey","in":"header"}}}