Get custom enum mappings for normalizing PMS-specific field values | Propexo

Retrieves the custom enum mappings that normalize PMS-specific enum values to standardized Propexo values. These mappings can be user-customized per integration or use default system mappings.

Valid model/field combinations (use these exact values for the model and field route parameters):

leases/status → Maps PMS-specific lease status values to normalized lease statuses. Normalized values are returned in the leases.status_normalized response field. Possible normalized values: ACTIVE, INACTIVE, OTHER, PENDING, EVICTED
residents/type → Maps PMS-specific resident type values to normalized resident types. Normalized values are returned in the residents.leases_meta_data[].resident_type_normalized response field. Possible normalized values: PRIMARY, SECONDARY, GUARANTOR, OTHER
billing/payment-method → Maps PMS-specific payment method values to normalized payment methods. Normalized values are returned in the transactions.payment_method_normalized response field. Possible normalized values: CASH, CASHIERCHECK, CHECK, CREDITCARD, MONEYORDER, DIRECTDEPOSIT, ELECTRONICPAYMENT, OTHER
properties/type → Maps PMS-specific property type values to normalized property types. Normalized values are returned in the properties.type_normalized response field. Possible normalized values: SINGLE_FAMILY, MULTI_FAMILY, STUDENT_HOUSING, VACATION, COMMERCIAL, OTHER
applicants/status → Maps PMS-specific applicant status values to normalized applicant statuses. Normalized values are returned in the applicants.status_normalized response field. Possible normalized values: APPROVED, DENIED, CANCELED, OTHER, PENDING
applicants/type → Maps PMS-specific applicant type values to normalized applicant types. Normalized values are returned in the applicants.type_normalized response field. Possible normalized values: GUARANTOR, OTHER, PRIMARY, SECONDARY

Custom enum mappings allow user-configurable normalization of PMS-specific enum values to standardized Propexo values.

Retrieves the custom enum mappings that normalize PMS-specific enum values to standardized Propexo values. These mappings can be user-customized per integration or use default system mappings. Valid model/field combinations (use these exact values for the model and field route parameters): - leases/status → Maps PMS-specific lease status values to normalized lease statuses. Normalized values are returned in the leases.status_normalized response field. Possible normalized values: ACTIVE, INACTIVE, OTHER, PENDING, EVICTED - residents/type → Maps PMS-specific resident type values to normalized resident types. Normalized values are returned in the residents.leases_meta_data[].resident_type_normalized response field. Possible normalized values: PRIMARY, SECONDARY, GUARANTOR, OTHER - billing/payment-method → Maps PMS-specific payment method values to normalized payment methods. Normalized values are returned in the transactions.payment_method_normalized response field. Possible normalized values: CASH, CASHIERCHECK, CHECK, CREDITCARD, MONEYORDER, DIRECTDEPOSIT, ELECTRONICPAYMENT, OTHER - properties/type → Maps PMS-specific property type values to normalized property types. Normalized values are returned in the properties.type_normalized response field. Possible normalized values: SINGLE_FAMILY, MULTI_FAMILY, STUDENT_HOUSING, VACATION, COMMERCIAL, OTHER - applicants/status → Maps PMS-specific applicant status values to normalized applicant statuses. Normalized values are returned in the applicants.status_normalized response field. Possible normalized values: APPROVED, DENIED, CANCELED, OTHER, PENDING - applicants/type → Maps PMS-specific applicant type values to normalized applicant types. Normalized values are returned in the applicants.type_normalized response field. Possible normalized values: GUARANTOR, OTHER, PRIMARY, SECONDARY Custom enum mappings allow user-configurable normalization of PMS-specific enum values to standardized Propexo values.

Authentication

AuthorizationBearer

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

Path parameters

modelstringRequired

The model name (route parameter). Must be one of: leases, residents, billing, properties, or applicants. See the endpoint description for valid model/field combinations.

fieldstringRequired

The field name within the model (route parameter). Valid fields depend on the model: leases/status, applicants/status, applicants/type, residents/type, properties/type, billing/payment-method. This is the mapping name and never carries the “_normalized” suffix used by response fields. Use “status” rather than “status_normalized” for leases. See the endpoint description for all valid model/field combinations.

The field name within the model (route parameter). Valid fields depend on the model: leases/status, applicants/status, applicants/type, residents/type, properties/type, billing/payment-method. This is the mapping name and never carries the "_normalized" suffix used by response fields. Use "status" rather than "status_normalized" for leases. See the endpoint description for all valid model/field combinations.

Query parameters

integration_idstringOptional

The ID of the integration for which to retrieve custom mappings. If provided, returns integration-specific custom mappings (if they exist). If omitted, returns the default system mappings for the vendor.

integration_vendorenumRequired

Response

Successful response

resultsobject

Errors

400

Bad Request Error

Retrieves the custom enum mappings that normalize PMS-specific enum values to standardized Propexo values. These mappings can be user-customized per integration or use default system mappings.

Valid model/field combinations (use these exact values for the model and field route parameters):

leases/status → Maps PMS-specific lease status values to normalized lease statuses. Normalized values are returned in the leases.status_normalized response field. Possible normalized values: ACTIVE, INACTIVE, OTHER, PENDING, EVICTED
residents/type → Maps PMS-specific resident type values to normalized resident types. Normalized values are returned in the residents.leases_meta_data[].resident_type_normalized response field. Possible normalized values: PRIMARY, SECONDARY, GUARANTOR, OTHER
billing/payment-method → Maps PMS-specific payment method values to normalized payment methods. Normalized values are returned in the transactions.payment_method_normalized response field. Possible normalized values: CASH, CASHIERCHECK, CHECK, CREDITCARD, MONEYORDER, DIRECTDEPOSIT, ELECTRONICPAYMENT, OTHER
properties/type → Maps PMS-specific property type values to normalized property types. Normalized values are returned in the properties.type_normalized response field. Possible normalized values: SINGLE_FAMILY, MULTI_FAMILY, STUDENT_HOUSING, VACATION, COMMERCIAL, OTHER
applicants/status → Maps PMS-specific applicant status values to normalized applicant statuses. Normalized values are returned in the applicants.status_normalized response field. Possible normalized values: APPROVED, DENIED, CANCELED, OTHER, PENDING
applicants/type → Maps PMS-specific applicant type values to normalized applicant types. Normalized values are returned in the applicants.type_normalized response field. Possible normalized values: GUARANTOR, OTHER, PRIMARY, SECONDARY

Custom enum mappings allow user-configurable normalization of PMS-specific enum values to standardized Propexo values.

1	{
2	"results": {
3	"is_custom_mapping": true,
4	"mappings": {},
5	"default_value": "string"
6	}
7	}