Delinquency exempt updates

Discussion

Returns the delinquency exempt updates of facilities based on given date filters. The results are sorted by updated_at, facility_id in ascending order and tenants.last_name in ascending order.
The possible action values are:

  • enabled
  • disabled

The default page size is 500 results with a maximum of 2,000 results per page.

>>>

GET /v1/companies/:company_id/delinquency_exempt_updates
Returns the delinquency exempt updates for a company

Examples

GET /v1/companies/7080ac59-4366-4a77-b425-79071b0b353a/delinquency_exempt_updates
200
{
  "delinquency_exempt_updates": [
    {
      "id": "795ec140-bd4c-4d60-808d-47e63349bca7",
      "store_number": 101,
      "tenant_id": "9e640b2d-a898-4619-9ea5-e467b720392a",
      "tenant_name": "Martin Johnson",
      "action": "disabled",
      "updated_at": "2022-07-10T04:15:01-10:00",
      "updated_by": "Martin Johnson",
      "updated_by_id": "9e640b2d-a898-4619-9ea5-e467b720392a"
    },
    {
      "id": "5a47bbdb-2d7d-40fd-9799-1d8a84a277c5",
      "store_number": 101,
      "tenant_id": "9e640b2d-a898-4619-9ea5-e467b720392a",
      "tenant_name": "Martin Johnson",
      "action": "disabled",
      "updated_at": "2022-07-10T04:15:01-10:00",
      "updated_by": "Ethan Smith",
      "updated_by_id": "398c039a-11d0-4707-82a7-ea92b6ae5142"
    },
    {
      "id": "89fe4264-b4cc-464d-94fc-aca841f71522",
      "store_number": 101,
      "tenant_id": "c48a72f2-bd36-4426-8b02-4469fbfd8031",
      "tenant_name": "Olivia Johnson",
      "action": "disabled",
      "updated_at": "2022-07-05T10:35:20-10:00",
      "updated_by": "Liam Davis",
      "updated_by_id": "8308c68c-0ad4-4328-9cf9-f0b8e402f8a9"
    },
    {
      "id": "a8ff075a-c34e-4494-ba6b-9d489a542f69",
      "store_number": 101,
      "tenant_id": "c48a72f2-bd36-4426-8b02-4469fbfd8031",
      "tenant_name": "Olivia Johnson",
      "action": "disabled",
      "updated_at": "2022-07-05T10:35:20-10:00",
      "updated_by": "Olivia Johnson",
      "updated_by_id": "c48a72f2-bd36-4426-8b02-4469fbfd8031"
    },
    {
      "id": "2dfba1b1-e0c2-45db-b0bc-165685ad0d32",
      "store_number": 101,
      "tenant_id": "c48a72f2-bd36-4426-8b02-4469fbfd8031",
      "tenant_name": "Olivia Johnson",
      "action": "disabled",
      "updated_at": "2022-07-05T10:35:20-10:00",
      "updated_by": "Liam Davis",
      "updated_by_id": "8308c68c-0ad4-4328-9cf9-f0b8e402f8a9"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 2000,
      "total_entries": 5,
      "previous_page": null,
      "next_page": null
    },
    "filters": {},
    "sorting": null,
    "search_term": null,
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": "909071e6-36be-4fa0-9ada-5852257714fc",
    "parameters": {
      "updated_after": "2022-06-22",
      "updated_before": "2022-07-23",
      "per_page": "2000",
      "company_id": "7080ac59-4366-4a77-b425-79071b0b353a"
    }
  }
}

Params

Param name Description
company_id
required

The company id


Value: Must be a String
updated_after
required

The datetime after which delinquency exempt updates will be returned. Used with updated_before and format should be YYYY-MM-DDThh:mm:ssTZD (e.g. 2023-07-16T00:00:00-05:00)


Value: Must be a DateTime
updated_before
required

The datetime before which delinquency exempt updates will be returned. Used with updated_after and format should be YYYY-MM-DDThh:mm:ssTZD (e.g. 2023-07-16T23:59:59-05:00)


Value: Must be a DateTime