Get custom enum mappings for normalizing PMS-specific field 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. Custom enum fields in the API schema are identified by types beginning with "enum." (e.g., enum.lease_status, enum.applicant_status). Valid model/field combinations: - leases/status → Maps PMS-specific lease status values to normalized lease statuses. Used by the leases.status field. Custom enum type in schema: enum.lease_status Possible normalized values: ACTIVE, INACTIVE, OTHER, PENDING, EVICTED - residents/type → Maps PMS-specific resident type values to normalized resident types. Used by the residents.type field. Custom enum type in schema: enum.resident_type Possible normalized values: PRIMARY, SECONDARY, GUARANTOR, OTHER - billing/payment-method → Maps PMS-specific payment method values to normalized payment methods. Used by the billing.payment-method field (which corresponds to payment_method on transaction records). Custom enum type in schema: enum.transaction_payment_method Possible normalized values: CASH, CASHIERCHECK, CHECK, CREDITCARD, MONEYORDER, DIRECTDEPOSIT, ELECTRONICPAYMENT, OTHER - properties/type → Maps PMS-specific property type values to normalized property types. Used by the properties.type field. Custom enum type in schema: enum.property_type Possible normalized values: SINGLE_FAMILY, MULTI_FAMILY, STUDENT_HOUSING, VACATION, COMMERCIAL, OTHER - applicants/status → Maps PMS-specific applicant status values to normalized applicant statuses. Used by the applicants.status field. Custom enum type in schema: enum.applicant_status Possible normalized values: APPROVED, DENIED, CANCELED, OTHER, PENDING - applicants/type → Maps PMS-specific applicant type values to normalized applicant types. Used by the applicants.type field. Custom enum type in schema: enum.applicant_type Possible normalized values: GUARANTOR, OTHER, PRIMARY, SECONDARY Custom enum mappings allow user-configurable normalization of PMS-specific enum values to standardized Propexo values. You can identify custom enum fields in the schema by looking for types that begin with "enum." prefix (e.g., enum.lease_status, enum.applicant_status).

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. For example: leases.status, applicants.status, applicants.type, residents.type, properties.type, billing.payment-method. 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
The integration vendor associated with the data diff

Response

Successful response
resultsobject

Errors