Get all invoices

GEThttps://api.propexo.com/v1/invoices/

Authentication

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

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

location_id string

The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations.

property_id string

The Propexo unique identifier for the property

integration_id string

The Propexo unique identifier for the integration

integration_vendor string

Show 13 enum values

APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST

The property management system of record

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 object[]required
Array [
idstringrequired
The Propexo unique identifier for the invoice
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
vendors/getInvoices
Example: 742891
x_property_idstringrequired
The external ID of the property from the integration vendor
Method
vendors/getInvoices
Example: 889254
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_vendor_idstring | nullnullablerequired
The external ID of the vendor from the integration vendor
Method
vendors/getInvoices
Example: 318472
x_financial_account_idnullrequired
The external ID of the financial account from the integration vendor
Notice
This field will always be null for ENTRATA
Example: null
x_cash_financial_account_idnullrequired
The external ID of the cash financial account from the integration vendor
Notice
This field will always be null for ENTRATA
Example: null
x_ap_financial_account_idnullrequired
The external ID of the AP financial account from the integration vendor
Notice
This field will always be null for ENTRATA
Example: null
amount_due_in_centsnumber | nullnullablerequired
The amount due on the invoice, in cents
Method
vendors/getInvoices
Example: 3500
amount_paid_in_centsnumber | nullnullablerequired
The amount paid on the invoice, in cents
Method
vendors/getInvoices
Example: 3500
custom_data object | nullrequired
object
due_datestring | nullnullablerequired
The due date associated with the invoice
Method
vendors/getInvoices
Example: 2024-03-03T00:00:00.000Z
discount_amount_in_centsnumber | nullnullablerequired
The deposit amount in cents associated with the invoice
Method
vendors/getInvoices
Example: 500
discount_datenullrequired
The date a discount was issued on invoice
Notice
This field will always be null for ENTRATA
Example: null
invoice_datestring | nullnullablerequired
The date the invoice was issued
Method
vendors/getInvoices
Example: 2024-03-03T00:00:00.000Z
invoice_numberstring | nullnullablerequired
The reference number for the invoice
Method
vendors/getInvoices
Example: INV-1234
notesstring | nullnullablerequired
Notes associated with the invoice
Method
vendors/getInvoices
Example: This is a note
post_datestring | nullnullablerequired
The date the invoice was posted. Some PMS systems only show the month.
Method
vendors/getInvoices
Example: 2024-03-03T00:00:00.000Z
post_monthstring | nullnullablerequired
The month the invoice was posted.
Method
vendors/getInvoices
Example: 2024-03-03T00:00:00.000Z
post_status_rawstring | nullnullablerequired
The raw post status associated with the invoice
Method
vendors/getInvoices
Example: Posted
sub_total_amount_in_centsnumber | nullnullablerequired
The sub total amount of the invoice
Method
vendors/getInvoices
Example: 3000
total_amount_in_centsnumber | nullnullablerequired
The amount of the invoice, in cents
Method
vendors/getInvoices
Example: 3500
property_idstringrequired
The Propexo unique identifier for the property
Example: clwi5xiix000008l6ctdgafyh
financial_account_idnullrequired
The Propexo unique identifier for the financial account
Notice
This field will always be null for ENTRATA
Example: null
cash_financial_account_idnullrequired
The Propexo unique identifier for the cash financial account
Notice
This field will always be null for ENTRATA
Example: null
ap_financial_account_idnullrequired
The Propexo unique identifier for the ap financial account
Notice
This field will always be null for ENTRATA
Example: null
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
invoice_items object[]required
The invoice list items associated with the invoice
Array [
x_idstringrequired
The external ID from the integration vendor
Method
vendors/getInvoices
Example: 986235
x_property_idstringrequired
The external ID of the property from the integration vendor
Method
vendors/getInvoices
Example: 889254
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_gl_account_idstring | nullnullablerequired
The external ID of the financial account from the integration vendor
Method
vendors/getInvoices
Example: 235226
x_cash_financial_account_idnullrequired
The external ID of the cash financial account from the integration vendor
Notice
This field will always be null for ENTRATA
Example: null
invoice_idstringrequired
The Propexo unique identifier for the invoice
Method
vendors/getInvoices
Example: clxkr6spo0006t7ozhc0keba8
construction_job_idnullrequired
The Propexo unique identifier for the construction job
Notice
This field will always be null for ENTRATA
Example: null
amount_due_in_centsnumber | nullnullablerequired
The amount due on the invoice item, in cents
Method
vendors/getInvoices
Example: 2500
notesstring | nullnullablerequired
Notes associated with the invoice item
Method
vendors/getInvoices
Example: This is a note
total_amount_in_centsnumber | nullnullablerequired
The amount of the invoice item, in cents
Method
vendors/getInvoices
Example: 2500
property_idstringrequired
The Propexo unique identifier for the property
Example: clwi5xiix000008l6ctdgafyh
financial_account_idstring | nullnullablerequired
The Propexo unique identifier for the financial account
Method
vendors/getInvoices
Example: cme02s5xx454647512saocg1tpazam
cash_financial_account_idnullrequired
The Propexo unique identifier for the cash financial account
Notice
This field will always be null for ENTRATA
Example: null
]
]

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/invoices/

curl https://api.propexo.com/v1/invoices/ \
     -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": "742891",
      "x_property_id": "889254",
      "x_location_id": null,
      "x_vendor_id": "318472",
      "x_financial_account_id": null,
      "x_cash_financial_account_id": null,
      "x_ap_financial_account_id": null,
      "amount_due_in_cents": 3500,
      "amount_paid_in_cents": 3500,
      "custom_data": "Unknown Type: object,null",
      "due_date": "2024-03-03T00:00:00.000Z",
      "discount_amount_in_cents": 500,
      "discount_date": null,
      "invoice_date": "2024-03-03T00:00:00.000Z",
      "invoice_number": "INV-1234",
      "notes": "This is a note",
      "post_date": "2024-03-03T00:00:00.000Z",
      "post_month": "2024-03-03T00:00:00.000Z",
      "post_status_raw": "Posted",
      "sub_total_amount_in_cents": 3000,
      "total_amount_in_cents": 3500,
      "property_id": "clwi5xiix000008l6ctdgafyh",
      "financial_account_id": null,
      "cash_financial_account_id": null,
      "ap_financial_account_id": null,
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "ENTRATA",
      "invoice_items": [
        {
          "x_id": "986235",
          "x_property_id": "889254",
          "x_location_id": null,
          "x_gl_account_id": "235226",
          "x_cash_financial_account_id": null,
          "invoice_id": "clxkr6spo0006t7ozhc0keba8",
          "construction_job_id": null,
          "amount_due_in_cents": 2500,
          "notes": "This is a note",
          "total_amount_in_cents": 2500,
          "property_id": "clwi5xiix000008l6ctdgafyh",
          "financial_account_id": "cme02s5xx454647512saocg1tpazam",
          "cash_financial_account_id": null
        }
      ]
    }
  ]
}