Skip to main content

Get concession by ID

GEThttps://api.propexo.com/v1/concessions/:concession_id

Authentication​

  • AuthorizationBearer
    Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters​

concession_id stringrequired

The ID of the resource.

Query parameters​

order-by string

Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc

Default value: created_at:desc
updated_at_gte string | null

Filter to records updated at or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

updated_at_lte string | null

Filter to records updated at or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

last_seen_gte string | null

Filter to records whose last_seen date is on or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

last_seen_lte string | null

Filter to records whose last_seen date is on or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

offset integer | null

Possible values: >= 0

Can be used for paginating results

Default value: 0
limit integer | null

Possible values: >= 0 and <= 250

A number between 1 and 250 to determine the number of results to return in a single query

Default value: 100

Response​

Successful response

    meta objectrequired
    offsetinteger

    The offset of the first result

    Possible values: >= 0

    Example: 0
    limitinteger

    The number of results to return

    Possible values: >= 0 and <= 250

    Example: 100
    orderBy object[]required

    The order of the results

  • Array [
    • object
  • ]
    • hasMoreboolean | nullnullable

    Whether there are more results

    totalinteger

    The total number of results

    Possible values: >= 0

    Example: 1000
    results objectrequired
    idstringrequired

    The Propexo unique identifier for the concession

    Example: clwktsp9v000008l31iv218hn
    created_atstringrequired

    The date record first entered Propexo

    Example: 2024-03-21T15:38:08.337Z
    updated_atstringrequired

    The date record was last updated in Propexo

    Example: 2024-03-22T10:59:45.119Z
    last_seenstring | nullnullablerequired

    The date the record was last seen from the PMS

    Example: 2024-03-22T10:59:45.119Z
    x_idstringrequired

    The external ID from the integration vendor

    Method
    propertyunits/getSpecials
    Example: 321
    x_property_idstringrequired

    The external ID of the property from the integration vendor

    Method
    propertyunits/getSpecials
    Example: 567
    x_location_idnullrequired

    The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations.

    Notice

    This field will always be null for ENTRATA

    Example: null
    x_unit_idstring | nullnullablerequired

    The external ID of the unit from the integration vendor

    Method
    propertyunits/getSpecials
    Example: 729
    x_floor_plan_idstring | nullnullablerequired

    The external ID of the floor plan from the integration vendor

    Method
    propertyunits/getSpecials
    Example: 12354
    total_amount_in_centsinteger | nullnullablerequired

    The total amount of the concession

    Method
    propertyunits/getSpecials
    Example: 23000
    start_datestring | nullnullablerequired

    The start date associated with the concession

    Method
    propertyunits/getSpecials
    Example: 2025-01-28T00:00:00.000Z
    end_datestring | nullnullablerequired

    The end date associated with the concession

    Method
    propertyunits/getSpecials
    Example: 2025-02-28T00:00:00.000Z
    is_activeboolean | nullnullablerequired

    Whether the concession is active

    Method
    propertyunits/getSpecials
    Example: true
    descriptionstring | nullnullablerequired

    Description of the concession

    Method
    propertyunits/getSpecials
    Example: Lease renewal concession
    is_one_timeboolean | nullnullablerequired

    Whether or not the concession occurs a single time

    Method
    propertyunits/getSpecials
    Example: true
    is_recurringboolean | nullnullablerequired

    Whether or not the concession is recurring

    Method
    propertyunits/getSpecials
    monthly_fixed_amount_in_centsinteger | nullnullablerequired

    The monthly fixed amount of the concession in cents

    Method
    propertyunits/getSpecials
    Example: 12300
    monthly_percentage_amountinteger | nullnullablerequired

    The monthly percentage amount of the concession. This is rounded to the nearest percent

    Method
    propertyunits/getSpecials
    Example: 15
    monthly_percentage_rawstring | nullnullablerequired

    The raw monthly percentage amount of the concession as a string, preserving decimal precision

    Method
    propertyunits/getSpecials
    Example: 15.23
    one_time_fixed_amount_in_centsinteger | nullnullablerequired

    The one time fixed amount of the concession in cents

    Method
    propertyunits/getSpecials
    Example: 1200
    one_time_percentage_amountinteger | nullnullablerequired

    The one time percentage amount of the concession. This is rounded to the nearest percent

    Method
    propertyunits/getSpecials
    Example: 10
    one_time_percentage_rawstring | nullnullablerequired

    The raw one time percentage amount of the concession as a string, preserving decimal precision

    Method
    propertyunits/getSpecials
    Example: 10.45
    number_of_occurrencesnullrequired

    The number of occurrences of the concession

    Notice

    This field will always be null for ENTRATA

    Example: null
    fixed_amount_in_centsinteger | nullnullablerequired

    The fixed amount of the concession in cents

    Method
    propertyunits/getSpecials
    Example: 12200
    percentage_amountinteger | nullnullablerequired

    The percentage amount of the concession. This is rounded to the nearest percent

    Method
    propertyunits/getSpecials
    Example: 15
    percentage_rawstring | nullnullablerequired

    The raw percentage amount of the concession as a string, preserving decimal precision

    Method
    propertyunits/getSpecials
    Example: 15.23
    lease_term_in_monthsinteger | nullnullablerequired

    The amount of months for the lease term

    Method
    propertyunits/getSpecials
    Example: 15
    lease_term_rawstring | nullnullablerequired

    The raw value for the lease term

    Method
    propertyunits/getSpecials
    Example: 15 months
    concession_formula_rawstring | nullnullablerequired

    The raw formula name used to calculate the concession (e.g., "Fixed Amount", "Percent of Charge Code Group")

    Method
    propertyunits/getSpecials
    Example: Fixed Amount
    integration_idstringrequired

    The Propexo unique identifier for the integration

    Example: clwh5u07w000508me66sfh3um
    integration_vendorEnum15required

    The property management system of record

    Show 13 enum values
    ENTRATAAPPFOLIOBUILDIUMMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
    Example: ENTRATA
    property_idstringrequired

    The Propexo unique identifier for the property

    Example: clwi5xiix000008l6ctdgafyh
    unit_idstring | nullnullablerequired

    The Propexo unique identifier for the unit

    Method
    propertyunits/getSpecials
    Example: cm9jzvir22142121432mxv9s39pz9s4
    floor_plan_idstring | nullnullablerequired

    The Propexo unique identifier for the floor plan

    Method
    propertyunits/getSpecials
    Example: cm9jzvir321421216451nqymhw1lrmdjw

Errors​

  • 400Bad Request
      error objectrequired
      codestringrequired
      Example: invalid_request
      messagestringrequired
      Example: invalid request
      details object
      property name*any
      Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}
GET /v1/concessions/:concession_id
curl https://api.propexo.com/v1/concessions/:concession_id \
     -H "Authorization: Bearer <token>"
200 Successful response
{
  "meta": {
    "offset": 0,
    "limit": 100,
    "orderBy": [
      {}
    ],
    "hasMore": true,
    "total": 1000
  },
  "results": {
    "id": "clwktsp9v000008l31iv218hn",
    "created_at": "2024-03-21T15:38:08.337Z",
    "updated_at": "2024-03-22T10:59:45.119Z",
    "last_seen": "2024-03-22T10:59:45.119Z",
    "x_id": "321",
    "x_property_id": "567",
    "x_location_id": null,
    "x_unit_id": "729",
    "x_floor_plan_id": "12354",
    "total_amount_in_cents": 23000,
    "start_date": "2025-01-28T00:00:00.000Z",
    "end_date": "2025-02-28T00:00:00.000Z",
    "is_active": true,
    "description": "Lease renewal concession",
    "is_one_time": true,
    "is_recurring": true,
    "monthly_fixed_amount_in_cents": 12300,
    "monthly_percentage_amount": 15,
    "monthly_percentage_raw": "15.23",
    "one_time_fixed_amount_in_cents": 1200,
    "one_time_percentage_amount": 10,
    "one_time_percentage_raw": "10.45",
    "number_of_occurrences": null,
    "fixed_amount_in_cents": 12200,
    "percentage_amount": 15,
    "percentage_raw": "15.23",
    "lease_term_in_months": 15,
    "lease_term_raw": "15 months",
    "concession_formula_raw": "Fixed Amount",
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "ENTRATA",
    "property_id": "clwi5xiix000008l6ctdgafyh",
    "unit_id": "cm9jzvir22142121432mxv9s39pz9s4",
    "floor_plan_id": "cm9jzvir321421216451nqymhw1lrmdjw"
  }
}