{"swagger":"2.0","info":{"version":"v4-documents","title":"agentOS API V4, Documents Call Group"},"host":"live-api.letmc.com","schemes":["https"],"paths":{"/v4/documents/{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/documents/{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/documents/{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/documents/{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/documents/{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/documents/{shortName}/documents/certificate/{certificateID}":{"get":{"tags":["DocumentsController"],"summary":"Get all public documents for a Certificate:-","operationId":"DocumentsController_GetCertificateDocuments","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"","required":true,"type":"string"},{"name":"certificateID","in":"path","description":"","required":true,"type":"string"},{"name":"startDate","in":"query","description":"","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"","required":true,"type":"string","format":"date-time"},{"name":"removeArchived","in":"query","description":"","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CertificateDocumentationModelResults"}}}}},"/v4/documents/{shortName}/documents/lettingsprogression/{lettingsProgressionID}":{"get":{"tags":["DocumentsController"],"summary":"Get all public documents for a Lettings Progression List:-","operationId":"DocumentsController_GetLettingsProgressionDocuments","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"","required":true,"type":"string"},{"name":"lettingsProgressionID","in":"path","description":"","required":true,"type":"string"},{"name":"startDate","in":"query","description":"","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"","required":true,"type":"string","format":"date-time"},{"name":"removeArchived","in":"query","description":"","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LettingsProgressionDocumentationModelResults"}}}}},"/v4/documents/{shortName}/documents/maintenance/{maintenanceJobID}":{"get":{"tags":["DocumentsController"],"summary":"Get all public documents for a Maintenance Job:-","operationId":"DocumentsController_GetMaintenanceJobDocuments","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"","required":true,"type":"string"},{"name":"maintenanceJobID","in":"path","description":"","required":true,"type":"string"},{"name":"startDate","in":"query","description":"","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"","required":true,"type":"string","format":"date-time"},{"name":"removeArchived","in":"query","description":"","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaintenanceJobDocumentationResults"}}}}},"/v4/documents/{shortName}/documents/person/{personID}":{"get":{"tags":["DocumentsController"],"summary":"Get all public documents for Person:-","operationId":"DocumentsController_GetPersonDocuments","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"","required":true,"type":"string"},{"name":"personID","in":"path","description":"","required":true,"type":"string"},{"name":"startDate","in":"query","description":"","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"","required":true,"type":"string","format":"date-time"},{"name":"removeArchived","in":"query","description":"","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PersonDocumentationModelResults"}}}}},"/v4/documents/{shortName}/documents/person/{personID}/upload":{"post":{"tags":["UploadController"],"summary":"Attach document to person:-","description":"Uploads a document to a person record (tenant, landlord, vendor, etc.).\r\n            \r\nIMPORTANT: Despite the field name \"mimeType\", this API expects the file extension (with dot prefix), not a standard MIME type.\r\n            \r\nAccepted extensions: .pdf, .doc, .docx, .xls, .xlsx, .csv, .txt, .gif, .png, .jpg, .jpeg, .bmp, .msg, .eml, .heic\r\n            \r\nExample: For a file named \"contract.pdf\", set mimeType to \".pdf\" (not \"application/pdf\")\r\n            \r\nMaximum file size: 10MB (content must be Base64 encoded)\r\nThe mimeType field must match the file extension in documentName\r\nAll uploads are subject to malware scanning","operationId":"UploadController_SubmitDocumentToPerson","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":"personID","in":"path","description":"The unique ID of the person","required":true,"type":"string"},{"name":"document","in":"body","description":"Document to attach","required":true,"schema":{"$ref":"#/definitions/DocumentationSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/documents/{shortName}/documents/property/{propertyID}/upload":{"post":{"tags":["UploadController"],"summary":"Attach document to a property:-","description":"Uploads a document to a property record.\r\n            \r\nIMPORTANT: Despite the field name \"mimeType\", this API expects the file extension (with dot prefix), not a standard MIME type.\r\n            \r\nAccepted extensions: .pdf, .doc, .docx, .xls, .xlsx, .csv, .txt, .gif, .png, .jpg, .jpeg, .bmp, .msg, .eml, .heic\r\n            \r\nExample: For a file named \"certificate.pdf\", set mimeType to \".pdf\" (not \"application/pdf\")\r\n            \r\nMaximum file size: 10MB (content must be Base64 encoded)\r\nThe mimeType field must match the file extension in documentName\r\nAll uploads are subject to malware scanning","operationId":"UploadController_SubmitDocumentToProperty","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":"propertyID","in":"path","description":"The unique ID of the Property","required":true,"type":"string"},{"name":"document","in":"body","description":"Document to attach","required":true,"schema":{"$ref":"#/definitions/DocumentationSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/documents/{shortName}/documents/property/tenancy/{tenancyID}":{"get":{"tags":["DocumentsController"],"summary":"Get all public documents for a tenancy:-","operationId":"DocumentsController_GetTenancyDocuments","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"","required":true,"type":"string"},{"name":"tenancyID","in":"path","description":"","required":true,"type":"string"},{"name":"startDate","in":"query","description":"","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"","required":true,"type":"string","format":"date-time"},{"name":"removeArchived","in":"query","description":"","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TenancyDocumentationModelResults"}}}}},"/v4/documents/{shortName}/documents/propertyprogression/{propertyProgressionID}":{"get":{"tags":["DocumentsController"],"summary":"Get all public documents for a Property Progression List:-","operationId":"DocumentsController_GetPropertyProgressionDocuments","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"","required":true,"type":"string"},{"name":"propertyProgressionID","in":"path","description":"","required":true,"type":"string"},{"name":"startDate","in":"query","description":"","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"","required":true,"type":"string","format":"date-time"},{"name":"removeArchived","in":"query","description":"","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PropertyProgressionDocumentationModelResults"}}}}},"/v4/documents/{shortName}/documents/propertyprogression/{salesProgressionID}":{"get":{"tags":["DocumentsController"],"summary":"Get all public documents for a Sales Progression List:-","operationId":"DocumentsController_GetSalesProgressionDocuments","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"","required":true,"type":"string"},{"name":"salesProgressionID","in":"path","description":"","required":true,"type":"string"},{"name":"startDate","in":"query","description":"","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"","required":true,"type":"string","format":"date-time"},{"name":"removeArchived","in":"query","description":"","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SalesProgressionDocumentationModelResults"}}}}},"/v4/documents/{shortName}/documents/sales/{salesInstruction}/upload":{"post":{"tags":["UploadController"],"summary":"Attach document to a sales instruction:-","description":"Uploads a document to a sales instruction record.\r\n            \r\nIMPORTANT: Despite the field name \"mimeType\", this API expects the file extension (with dot prefix), not a standard MIME type.\r\n            \r\nAccepted extensions: .pdf, .doc, .docx, .xls, .xlsx, .csv, .txt, .gif, .png, .jpg, .jpeg, .bmp, .msg, .eml, .heic\r\n            \r\nExample: For a file named \"contract.pdf\", set mimeType to \".pdf\" (not \"application/pdf\")\r\n            \r\nMaximum file size: 10MB (content must be Base64 encoded)\r\nThe mimeType field must match the file extension in documentName\r\nAll uploads are subject to malware scanning","operationId":"UploadController_SubmitDocumentToSalesInstruction","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":"salesInstruction","in":"path","description":"The unique ID of the Sales Instruction","required":true,"type":"string"},{"name":"document","in":"body","description":"Document to attach","required":true,"schema":{"$ref":"#/definitions/DocumentationSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/documents/{shortName}/documents/sales/{salesInstructionID}":{"get":{"tags":["DocumentsController"],"summary":"Get all public documents for a Sales Instruction:-","operationId":"DocumentsController_GetSalesInstructionDocuments","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"","required":true,"type":"string"},{"name":"salesInstructionID","in":"path","description":"","required":true,"type":"string"},{"name":"startDate","in":"query","description":"","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"","required":true,"type":"string","format":"date-time"},{"name":"removeArchived","in":"query","description":"","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SalesInstructionDocumentationModelResults"}}}}},"/v4/documents/{shortName}/documents/tenancy/{tenancyID}/upload":{"post":{"tags":["UploadController"],"summary":"Attach document to a tenancy:-","description":"Uploads a document to a tenancy record.\r\n            \r\nIMPORTANT: Despite the field name \"mimeType\", this API expects the file extension (with dot prefix), not a standard MIME type.\r\n            \r\nAccepted extensions: .pdf, .doc, .docx, .xls, .xlsx, .csv, .txt, .gif, .png, .jpg, .jpeg, .bmp, .msg, .eml, .heic\r\n            \r\nExample: For a file named \"agreement.pdf\", set mimeType to \".pdf\" (not \"application/pdf\")\r\n            \r\nMaximum file size: 10MB (content must be Base64 encoded)\r\nThe mimeType field must match the file extension in documentName\r\nAll uploads are subject to malware scanning","operationId":"UploadController_SubmitDocumentToTenancy","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":"tenancyID","in":"path","description":"The unique ID of the Tenancy","required":true,"type":"string"},{"name":"document","in":"body","description":"Document to attach","required":true,"schema":{"$ref":"#/definitions/DocumentationSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}}},"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"}}},"TenancyDocumentationModelResults":{"description":"Tenancy Documentation Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/TenancyDocumentationModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"TenancyDocumentationModel":{"description":"V4 Tenancy Documentation Model","type":"object","properties":{"TenancyOID":{"description":"Tenancy ID:-","type":"string","readOnly":true},"TenancyGlobalReference":{"description":"Tenancy Global Reference:-","type":"string","readOnly":true},"TenancyDocuments":{"$ref":"#/definitions/DocumentationTierBaseModel","description":"Documentation Tier Base Model Helper:-","readOnly":true}}},"DocumentationTierBaseModel":{"description":"Documentation Tier Base Model","type":"object","properties":{"OID":{"description":"Document ID:-","type":"string","readOnly":true},"Filename":{"description":"Document Filename:-","type":"string","readOnly":true},"Filesize":{"description":"Document Filesize:-","type":"string","readOnly":true},"IsArchived":{"description":"Document is archived?","type":"boolean","readOnly":true},"IsPublic":{"description":"Document is public?","type":"boolean","readOnly":true},"Uploaded":{"format":"date-time","description":"Document upload date:-","type":"string","readOnly":true},"URL":{"description":"Document URL:-","type":"string","readOnly":true}}},"SalesInstructionDocumentationModelResults":{"description":"Sales Instruction Documentation Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/SalesInstructionDocumentationModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"SalesInstructionDocumentationModel":{"description":"V4 Sales Instruction Documentation Model","type":"object","properties":{"SalesInstructionOID":{"description":"Sales Instruction OID:-","type":"string","readOnly":true},"SalesInstructionGlobalReference":{"description":"Sales Instruction Global Reference:-","type":"string","readOnly":true},"SalesInstructionDocuments":{"$ref":"#/definitions/DocumentationTierBaseModel","description":"Documentation Tier Base Model Helper:-","readOnly":true}}},"PersonDocumentationModelResults":{"description":"Person Documentation Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/PersonDocumentationModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"PersonDocumentationModel":{"description":"V4 Person Documentation Model","type":"object","properties":{"PersonOID":{"description":"Applicant ID:-","type":"string","readOnly":true},"PersonGlobalReference":{"description":"Applicant Global Reference:-","type":"string","readOnly":true},"PersonDocuments":{"$ref":"#/definitions/DocumentationTierBaseModel","description":"Documentation Tier Base Model Helper:-","readOnly":true}}},"CertificateDocumentationModelResults":{"description":"Certificate Documentation Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/CertificateDocumentationModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"CertificateDocumentationModel":{"description":"V4 Certificate Documentation Model","type":"object","properties":{"OID":{"type":"string","readOnly":true},"Name":{"type":"string","readOnly":true},"CertificateDocuments":{"$ref":"#/definitions/DocumentationTierBaseModel","readOnly":true}}},"MaintenanceJobDocumentationResults":{"description":"Maintenance Documentation Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/MaintenanceJobDocumentationModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"MaintenanceJobDocumentationModel":{"description":"V4 Lettings Progression Documentation Model","type":"object","properties":{"JobOID":{"description":"Job ID:-","type":"string","readOnly":true},"JobGlobalReference":{"description":"Job Global Reference:-","type":"string","readOnly":true},"JobDocuments":{"$ref":"#/definitions/DocumentationTierBaseModel","description":"Documentation Tier Base Model Helper:-","readOnly":true}}},"LettingsProgressionDocumentationModelResults":{"description":"Progression Documentation Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/LettingsProgressionDocumentationModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"LettingsProgressionDocumentationModel":{"description":"V4 Person Documentation Model","type":"object","properties":{"ProgressionOID":{"description":"Progression ID:-","type":"string","readOnly":true},"ProgressionGlobalReference":{"description":"Progression Global Reference:-","type":"string","readOnly":true},"ProgressionDocuments":{"$ref":"#/definitions/DocumentationTierBaseModel","description":"Documentation Tier Base Model Helper:-","readOnly":true}}},"PropertyProgressionDocumentationModelResults":{"description":"Property Progression Documentation Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/PropertyProgressionDocumentationModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"PropertyProgressionDocumentationModel":{"description":"V4 Property Progression Documentation Model","type":"object","properties":{"ProgressionOID":{"description":"Progression ID:-","type":"string","readOnly":true},"ProgressionGlobalReference":{"description":"Progression Global Reference:-","type":"string","readOnly":true},"ProgressionDocuments":{"$ref":"#/definitions/DocumentationTierBaseModel","description":"Documentation Tier Base Model Helper:-","readOnly":true}}},"SalesProgressionDocumentationModelResults":{"description":"Sales Progression Documentation Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/SalesProgressionDocumentationModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"SalesProgressionDocumentationModel":{"description":"V4 Sales Progression Documentation Model","type":"object","properties":{"ProgressionOID":{"description":"Progression ID:-","type":"string","readOnly":true},"ProgressionGlobalReference":{"description":"Progression Global Reference:-","type":"string","readOnly":true},"ProgressionDocuments":{"$ref":"#/definitions/DocumentationTierBaseModel","description":"Documentation Tier Base Model Helper:-","readOnly":true}}},"DocumentationSubmissionModel":{"description":"Documentation Submission Model for uploading documents to persons, properties, tenancies, and sales instructions","type":"object","properties":{"DocumentName":{"description":"Document name including file extension (e.g., \"contract.pdf\", \"image.jpg\", \"photo.jpeg\")\r\nThe file extension must match the value in MimeType field","type":"string"},"MimeType":{"description":"File extension with dot prefix (e.g., \".pdf\", \".jpg\", \".docx\")\r\nIMPORTANT: Despite the field name, this is NOT a standard MIME type - it must be the file extension with dot prefix\r\nAccepted extensions: .pdf, .doc, .docx, .xls, .xlsx, .csv, .txt, .gif, .png, .jpg, .jpeg, .bmp, .msg, .eml, .heic\r\nMust exactly match the file extension in DocumentName (case-insensitive)\r\nExample: If DocumentName is \"contract.pdf\", MimeType must be \".pdf\" (not \"application/pdf\")","type":"string"},"Contents":{"description":"Base64 encoded string of the document content\r\nMaximum file size: 10MB (before Base64 encoding)\r\nAll content is validated and scanned for malware before storage","type":"string"}}}},"securityDefinitions":{"basic":{"type":"basic","description":"Basic HTTP Authentication"},"apiKey":{"type":"apiKey","description":"ApiKey Authentication","name":"ApiKey","in":"header"}}}