{ "opencollection": "1.0.0", "info": { "name": "Arthur Tenancies API", "version": "2.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.arthuronline.co.uk/oauth/authorize", "accessTokenUrl": "https://auth.arthuronline.co.uk/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Tenants", "type": "folder" }, "items": [ { "info": { "name": "List Tenants On Tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/tenants", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This retrieves a list of tenants related to a tenancy" }, { "info": { "name": "Add Tenant On Tenancy", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/tenants", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new tenant on a tenancy. The API will return the saved data and a unique tenant ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nmain_tenant \n True \n Boolean \n No \n\nmove_in_date \n 2019-05-28 \n Date \n No \n\nmove_out_date \n 2019-06-28 \n Time \n No \n\ntitle \n Mr \n Enum \n No \n\nfirst_name \n Ryan \n String \n No \n\nlast_name \n Cullen \n String \n No \n\ndate_of_birth \n 1995-01-21 \n Date \n No \n\ngender \n Male \n Enum" } ] }, { "info": { "name": "Assets", "type": "folder" }, "items": [ { "info": { "name": "List Assets On Tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/assets", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of assets associated with the given tenancy ID." }, { "info": { "name": "Create Asset On Tenancy", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/assets", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new asset related to an  tenancy . The API will return the saved data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nasset_type \n image \n String \n No \n\nname \n inventory \n String \n No \n\nshare_manager \n true \n Boolean \n No \n\nshare_tenant \n false \n Boolean \n No \n\nshare_contractor \n true \n Boolean \n No \n\nshare_owner \n true \n Boolean \n No \n\nfile \n base64 \n String \n Yes \n\nmime_type \n application/pdf \n Str" } ] }, { "info": { "name": "Certificates", "type": "folder" }, "items": [ { "info": { "name": "List Certificates On Tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/certificates", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of certificates associated with the given tenancy ID." }, { "info": { "name": "Add Certificate on Tenancy", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/certificates", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new certificate related to a  tenancy . The API will return the saved data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntype \n Boiler Service \n String \n Yes \n\nexpiry_date \n 2023-12-05 \n String \n No \n\nnotes \n Fully assessed \n String \n No \n\nfile \n Base64 \n String \n No \n\nmime_type \n application/pdf \n String \n No (Required if File field is present) \n\nfile_name \n Certificate Document \n string \n No (Req" } ] }, { "info": { "name": "Register Deposit", "type": "folder" }, "items": [ { "info": { "name": "Register Deposit on Tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tenancies/:id/register_deposit", "headers": [ { "name": "X-EntityID", "value": "" } ] }, "docs": "This endpoint retrieves the registered deposit associated with the given tenancy ID." }, { "info": { "name": "Update Deposit on Tenancy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/tenancies/:id/register_deposit", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the registered deposit related to a tenancy . The API will return the saved data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ndeposit_registered_not_needed \n true \n Boolean \n No \n\ndate_registered \n 2023-12-05 \n String \n No \n\ncertificate_no \n ABC \n String \n No \n\ndeposit_scheme \n Base64 \n String \n No \n\ndeposit_held_by \n TDS \n String \n No \n\ndeposit_required \n 1200 \n string \n No \n\ndeposit_registered \n t" } ] }, { "info": { "name": "Tasks", "type": "folder" }, "items": [ { "info": { "name": "List Tasks On Tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/tasks", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of tasks associated with the given tenancy ID." }, { "info": { "name": "Add Task On Tenancy", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/tasks", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new task record for a tenancy . The API will return the saved data and a unique task ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntask_type \n Inspection \n String \n No \n\ndescription \n Radiator not working \n String \n Yes \n\ntags \n ['one','two'] \n Array(String) \n No \n\ndue_date \n 2020-10-11 \n Date \n No \n\ndue_time \n 15:32 \n Time \n No \n\nassigned_managers \n [123,1234] \n Array(Integer) \n No \n\nemergency " }, { "info": { "name": "View Task On Tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/tasks/:task_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." } ] }, "docs": "This API endpoint retrieves the details of a single tenancy  task , identified by its unique  id ." }, { "info": { "name": "Update Task On Tenancy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/tasks/:task_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing task using the same fields as the 'Add Task' endpoint. The API will return the updated data for the tenancy in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntask_type \n Inspection \n String \n No \n\ndescription \n Radiator not working \n String \n No \n\ntags \n ['one','two'] \n Array(String) \n No \n\ndue_date \n 2020-10-11 \n Date \n No \n\ndue_time \n 15:32 \n Time \n No \n\nassigned_managers \n [123,1" }, { "info": { "name": "Delete Task On Tenancy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." } ] }, "docs": "This endpoint deletes an existing asset record using the task  id , under a tenancy ID" } ] }, { "info": { "name": "Tenancies", "type": "folder" }, "items": [ { "info": { "name": "View Tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." } ] }, "docs": "This API endpoint retrieves the details of a single tenancy, identified by its unique  tenancy_id .\n\nUse this endpoint to view the specific details of a tenancy." }, { "info": { "name": "Update Tenancy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing tenancy using the same fields as the 'Add Tenancy' endpoint excluding the  unit_id . Any fields that are not provided will not be changed. The API will return the updated data for the unit in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nstatus \n Current \n Integer \n No \n\ntenancy_type \n Commercial \n Integer \n No \n\nletting_agent_id \n 90909 \n Integer \n No \n\ncontract_type \n Company \n S" }, { "info": { "name": "List Tenancies", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tenancies", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "assigned_to", "value": "", "type": "query", "description": "Filter by unit manager ID" }, { "name": "tags", "value": "", "type": "query", "description": "Filter by tags associated with the tenancy, which should be provided as a comma-separated list" }, { "name": "moveInDate", "value": "", "type": "query", "description": "Filter by tenancies move in date. Use the format yyyy-mm-dd to input the date" }, { "name": "moveOutDate", "value": "", "type": "query", "description": "Filter by tenancy move out date. Use the format yyyy-mm-dd to input the date" }, { "name": "modified", "value": "", "type": "query", "description": "Filter by the last modified date. Use the format yyyy-mm-dd to input the date" }, { "name": "modifiedFrom", "value": "", "type": "query", "description": "Filters tenancies by the modified date, starting from the specified date. Use the format yyyy-mm-dd to input the date." }, { "name": "modifiedTo", "value": "", "type": "query", "description": "Filters tenancies by the modified date, up to the specified date. Use the format yyyy-mm-dd to input the date." }, { "name": "status", "value": "", "type": "query", "description": "Filter by the tenancy status" }, { "name": "full_address", "value": "", "type": "query", "description": "Filter by the full address of the property" }, { "name": "tenancy_type", "value": "", "type": "query", "description": "Filter by the tenancy type" }, { "name": "tenancy_sub_type", "value": "", "type": "query", "description": "Filter by the tenancy sub type" }, { "name": "unit_owner_id", "value": "", "type": "query", "description": "Filer by the landlord ID" }, { "name": "letting_agent_id", "value": "", "type": "query", "description": "Filter by the letting agent ID" }, { "name": "start_date", "value": "", "type": "query", "description": "Filter by start date" }, { "name": "end_date", "value": "", "type": "query", "description": "Filter by end date" }, { "name": "_q", "value": "", "type": "query", "description": "Filter by a keyword" }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This retrieves a list of tenancies.\n\nSee available filters below to customize the list of tenants returned." }, { "info": { "name": "Add Tenancy", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/tenancies", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new tenancy record. The API will return the saved data and a unique tenancy ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Default \n Required? \n\nunit_id \n 12345 \n Integer \n\nYes \n\nstatus \n Current \n Integer \n Prospective \n No \n\ntenancy_type \n Commercial \n Integer \n Residential \n No \n\nletting_agent_id \n 90909 \n Integer \n\nNo \n\ncontract_type \n Company \n String \n\nNo \n\nrenter_company \n Renter Ltd. \n String \n\nNo \n\n" } ] }, { "info": { "name": "Workorders", "type": "folder" }, "items": [ { "info": { "name": "List Workorders On Tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/workorders", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of workorders associated with the given tenancy ID." }, { "info": { "name": "Create Workorder On Tenancy", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/workorders", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new workorder record for a  tenancy . The API will return the saved data and a unique workorder ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntitle \n workorder title \n String \n No \n\ndescription \n workorder description \n String \n No \n\ninvite_contractors \n [123,1234] \n Array(integer) \n No \n\nservice_type \n Carpet Layer \n String \n Yes \n\nstart_date \n 2020-02-20 \n Date \n No \n\ndue_date \n 2020-02-20 \n D" }, { "info": { "name": "View Workorder On Tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/workorders/:workorder_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." } ] }, "docs": "This API endpoint retrieves the details of a single tenancy  workorder , identified by its unique  id ." }, { "info": { "name": "Update Workorder On Tenancy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/tenancy/:tenancy_id/workorders/:workorder_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing workorder using the same fields as the 'Add Workorder' endpoint. The API will return the updated data for the tenancy in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntitle \n workorder title \n String \n No \n\ndescription \n workorder description \n String \n No \n\ninvite_contractors \n [123,1234] \n Array(integer) \n No \n\nservice_type \n Carpet Layer \n String \n No \n\nstart_date \n 2020-02-20 \n" } ] }, { "info": { "name": "Conversations", "type": "folder" }, "items": [ { "info": { "name": "Get Recipients for Tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/conversation_recipients", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." } ] }, "docs": "This endpoint retrieves a list of conversation recipients on a tenancy record, identified by its unique  tenancy_id ." }, { "info": { "name": "List Conversation On Tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/conversations", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of conversations on a tenancy, identified by its unique  tenancy_id ." }, { "info": { "name": "Create Conversation On Tenancy", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/viewings/:viewing_id/conversations", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "viewing_id", "value": "", "type": "path", "description": "Arthur viewing id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new conversation on a tenancy record. The API will return the saved data and a unique Conversation ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nmessage \n It's done \n String \n Yes \n\nsubject \n Meeting tomorrow \n String \n Yes \n\nperson_ids \n ['1','2'] \n Array(String) \n Yes" } ] }, { "info": { "name": "Transactions", "type": "folder" }, "items": [ { "info": { "name": "List Transactions On Tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/transactions", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "statement", "value": "", "type": "query", "description": "Filters the transactions by statement. The available options are tenant , tenant-deposit , property-owner , \n property-owner-consolidated , contractor , tenancy-closing-statement , late-rents , contingency-statement , invoices" }, { "name": "status", "value": "", "type": "query", "description": "The status of the transaction. The available options are paid , unpaid , partpaid , outstanding , or overdue . Use this parameter to filter transactions based on their payment status." }, { "name": "date_from", "value": "", "type": "query", "description": "Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date." }, { "name": "date_to", "value": "", "type": "query", "description": "Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This retrieves a list of transactions for a Tenancy \n\nSee available filters below to customize the list of transactions returned." } ] }, { "info": { "name": "Notes", "type": "folder" }, "items": [ { "info": { "name": "List Notes On Tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/notes", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of  notes  associated with the given tenancy ID." }, { "info": { "name": "Add Note On Tenancy", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/notes", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new note record for a  tenancy . The API will return the saved data and a unique note ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ncontent \n Moving away \n String \n Yes \n\ntags \n ['one','two'] \n Array(String) \n No" }, { "info": { "name": "View Note On Tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/notes/:note_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "note_id", "value": "", "type": "path", "description": "Arthur note id." } ] }, "docs": "This API endpoint retrieves the details of a single tenancy  note , identified by its unique  id" }, { "info": { "name": "Update Note On Tenancy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/notes/:note_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "note_id", "value": "", "type": "path", "description": "Arthur note id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing note on a tenancy using the same fields as the 'Add Note' endpoint. The API will return the updated data for the note in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ncontent \n Moving away \n String \n No \n\ntags \n ['one','two'] \n Array(String) \n No" }, { "info": { "name": "Delete Note On Tenancy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/notes/:note_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "note_id", "value": "", "type": "path", "description": "Arthur note id." } ] }, "docs": "This endpoint deletes an existing tenancy note using the note  id ." } ] }, { "info": { "name": "Tags", "type": "folder" }, "items": [ { "info": { "name": "List Tags on Tenancy", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/tags", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of tags associated with the given Tenancy ID." }, { "info": { "name": "Tag Tenancy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/tags", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new tag record for a  tenancy . The API will return the saved data and a unique tag ID.\n\nSupported Fields \n The following fields are supported for the request body\nTag field should be a valid tag ID or name.\n\nField \n Example \n Type \n Required? \n\ntag \n [\"123\"] \n Array(String) \n Yes" }, { "info": { "name": "Untag Tenancy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/untag", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to unassign tag record from a  tenancy . The API will return the saved data. Tag field should be a valid tag ID or name.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntag \n \"1234\" \n String \n Yes" }, { "info": { "name": "Untag All Tenancy Tags", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancy_id/untag_all", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancy_id", "value": "", "type": "path", "description": "Arthur tenancy id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ] }, "docs": "Use this endpoint to unassign all tags from the  tenancy ." } ] }, { "info": { "name": "Recurrings", "type": "folder" }, "items": [ { "info": { "name": "List Recurrings", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/tenancies/:tenancyId/recurrings", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "tenancyId", "value": "", "type": "path", "description": "Arthur tenancyId." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of recurrings associated to a specific tenancy" } ] } ], "bundled": true }