Transactions - Propify Documentation

{
  "meta": {
    "offset": "integer",
    "limit": "integer",
    "orderBy": [
      {}
    ],
    "hasMore": [
      "boolean",
      "null"
    ],
    "total": "number"
  },
  "results": [
    {
      "id": "string",
      "created_at": "string",
      "updated_at": "string",
      "x_gl_account_id": [
        "string",
        "null"
      ],
      "x_id": "string",
      "x_lease_id": [
        "string",
        "null"
      ],
      "x_property_id": "string",
      "x_resident_id": [
        "string",
        "null"
      ],
      "x_unit_id": [
        "string",
        "null"
      ],
      "x_vendor_id": [
        "string",
        "null"
      ],
      "x_work_order_id": [
        "string",
        "null"
      ],
      "amount_in_cents": [
        "number",
        "null"
      ],
      "approval_status": "APPROVAL_REQUIRED",
      "approval_status_normalized": "APPROVAL_REQUIRED",
      "approval_status_raw": [
        "string",
        "null"
      ],
      "bill_date": [
        "string",
        "null"
      ],
      "custom_data": {},
      "due_date": [
        "string",
        "null"
      ],
      "gl_account_id_1": [
        "string",
        "null"
      ],
      "gl_account_id_2": [
        "string",
        "null"
      ],
      "notes": [
        "string",
        "null"
      ],
      "payee_name": [
        "string",
        "null"
      ],
      "payment_method": "CASH",
      "payment_method_normalized": "CASH",
      "payment_method_raw": [
        "string",
        "null"
      ],
      "reference_number": [
        "string",
        "null"
      ],
      "transaction_date": [
        "string",
        "null"
      ],
      "transaction_type": "CHARGE",
      "transaction_type_normalized": "CHARGE",
      "transaction_type_raw": [
        "string",
        "null"
      ],
      "transaction_source": "OTHER",
      "integration_id": "string",
      "integration_vendor": "string",
      "property_id": "string"
    }
  ]
}

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=vendor:asc,created_at:desc

offset

Default: 0

integernull

Can be used for paginating results

limit

Default: 100

integernull

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

x_id

string

The external transaction id

x_property_id

string

The external property id

x_lease_id

string

The external lease id

x_unit_id

string

The external unit id

x_resident_id

string

The external resident id

x_gl_account_id

string

The external GL account id

property_id

string

The Propify property id

integration_id

string

The Propify integration id

integration_vendor

string

The integration vendor for the transaction.

Response

metarequired

object

resultsrequired

array

idrequired

string

The Propify unique identifier for the transaction

created_atrequired

string

The date record first entered Propify

updated_atrequired

string

The date record was last updated in Propify

x_gl_account_idrequired

string | null

The external ID of the general ledger account from the integration vendor

x_idrequired

string

The external ID from the integration vendor

x_lease_idrequired

string | null

The external ID of the lease from the integration vendor

x_property_idrequired

string

The external ID of the property from the integration vendor

x_resident_idrequired

string | null

The external ID of the resident from the integration vendor

x_unit_idrequired

string | null

The external ID of the unit from the integration vendor

x_vendor_idrequired

string | null

The external ID of the vendor from the integration vendor

x_work_order_idrequired

string | null

The external ID of the work order from the integration vendor

amount_in_centsrequired

number | null

The amount of the transaction in cents.

approval_statusrequired

string | null

DEPRECATED. Use approval_status_normalized.

Available options:

APPROVAL_REQUIRED,

APPROVED,

NOT_NEEDED,

PENDING,

REJECTED

approval_status_normalizedrequired

string | null

The approval status of the transaction

Available options:

APPROVAL_REQUIRED,

APPROVED,

NOT_NEEDED,

PENDING,

REJECTED

approval_status_rawrequired

string | null

The raw approval status of the transaction from the PMS.

bill_daterequired

string | null

The bill date of the transaction

custom_datarequired

object | null

Custom data

due_daterequired

string | null

The due date of the transaction

gl_account_id_1required

string | null

The first general ledger account ID associated with the transaction

gl_account_id_2required

string | null

The second general ledger account ID associated with the transaction

notesrequired

string | null

Notes.

payee_namerequired

string | null

The payee name associated with the transaction

payment_methodrequired

string | null

DEPRECATED. Use payment_method_normalized.

Available options:

CASH,

CASHIERCHECK,

CHECK,

CREDITCARD,

DIRECTDEPOSIT,

ELECTRONICPAYMENT,

MONEYORDER,

OTHER

payment_method_normalizedrequired

string | null

The payment method used in the transaction.

Available options:

CASH,

CASHIERCHECK,

CHECK,

CREDITCARD,

DIRECTDEPOSIT,

ELECTRONICPAYMENT,

MONEYORDER,

OTHER

payment_method_rawrequired

string | null

The raw payment method used in the transaction from the PMS.

reference_numberrequired

string | null

The reference number associated with the transaction

transaction_daterequired

string | null

The date the transaction was received.

transaction_typerequired

string | null

DEPRECATED. Use transaction_type_normalized.

Available options:

CHARGE,

CREDIT,

OTHER,

PAYMENT

transaction_type_normalizedrequired

string | null

The type of transaction.

Available options:

CHARGE,

CREDIT,

OTHER,

PAYMENT

transaction_type_rawrequired

string | null

The raw type of transaction from the PMS.

transaction_sourcerequired

string | null

The source of the transaction

Available options:

OTHER,

RESIDENT,

VENDOR

integration_idrequired

string

The Propify unique identifier for the integration

integration_vendorrequired

string

The property management system of record

property_idrequired

string

The Propify unique identifier for the property

API Reference

​Query Parameters

​Response

Query Parameters

Response