4 Dec ’23

• New API endpoint to retrieve webhook failures. v1.1

 

28 Nov ’23

• Extended all payments report with new entry payment_instruction.id to assist with matching payment instructions added through the API to outgoing payments on the transaction history. v1.1

 

15 Nov ’23

• New API endpoint to generate damage deposits report. v1.1

 

26 Oct ’23

• New API endpoint to generate property account report. v1.1

 

16 Aug ’23

• New API endpoint to generate processing summary report. v1.1

 

15 Aug ’23

• Added optional URL parameter payment_batch_id on all payments report to return only those outgoing payments that were batched up in a bulk sum. v1.1

 

26 Jul ’23

• Added new income_category webhook for create and update actions. v1.1
• Added new expense_category webhook for create and update actions. v1.1

 

15 Jun ’23

• New API endpoint to list tags. v1.1
• New API endpoint to create tags. v1.1
• New API endpoint to update tags. v1.1
• New API endpoint to delete tags. v1.1
• New API endpoint to link tags with entities. v1.1
• New API endpoint to list tagged entities. v1.1
• New API endpoint to delete tag entity links. v1.1

 

16 May ’23

• New API endpoint to manage webhooks. v1.1

 

12 May ’23

• The beneficiaries export is_owner field has been deprecated in favor of is_active_owner. v1.1

 

8 May ’23

• Endpoints that return multiple results now include a pagination object in the response body v1.1
• Modified tenant export to accept multiple search_by parameters. v1.1

 

24 Mar ’23

• New API endpoint to generate agency invoice PDF document. v1.1
• Extended fee type fields on agency income report endpoint v1.1
• Extended property export search_by parameter with city, first_line, second_line, third_line, postal_code and state values to filter properties by address fields. v1.1

 

6 Mar ’23

• Extended tenant export search_by parameter with email_address value to filter tenants by email address. v1.1
• Extended beneficiary export search_by parameter with email_address value to filter beneficiaries by email address. v1.1

 

2 Mar ’23

• Fixed an issue with agency income report fees values not being negated properly. v1.1
• Added a new category refund for agency income report fees field. v1.1
• Fixed an issue with all payments report items not having persistent ordering between API calls. v1.1

 

22 Feb ’23

• Added a new field status to tenant statement report transactions structure. The field contains transaction processing status with possible values of new, failed, deleted, waiting, reversed, processed and confirmed. v1.1

 

17 Feb ’23

• Added an optional URL parameter property_id to tenant export to return tenants where the tenant has or has had a tenancy for the property. v1.1 v1.0
• Added a new field tenancy to tenant export that includes the status of tenant and property tenancy status if property_id parameter is set. v1.1 v1.0
• Tenant export properties field will no longer be populated if property_id parameter is set. v1.1 v1.0

 

12 Jan ’23

• Payment entity now accepts global beneficiary ID in beneficiary_id field. The global_beneficiary field is deprecated and will be removed in the future. v1.1
• Entity endpoints now return status as part of the error response. v1.1

 

5 Dec ’22

• Added a new API endpoint to download attachments. v1.1

 

2 Dec ’22

• Added maintenance_ticket_id field on export payments structure. v1.1 v1.0
• Added optional URL paramater maintenance_ticket_id on payment export to filter records based on maintenance ticket ID. v1.1

 

17 Nov ’22

• Added new endpoint to list maintenance tickets. v1.1
• Added new endpoint to create maintenance tickets. v1.1
• Added new endpoint to update maintenance tickets. v1.1
• Added new endpoint to get single maintenance ticket. v1.1
• Added new endpoint to list maintenance ticket categories. v1.1
• Added new endpoint to list maintenance ticket messages. v1.1
• Added new endpoint to create maintenance ticket messages. v1.1
• Added new endpoint to get single maintenance ticket message. v1.1
• Extended attachments route with new entity type maintenance-ticket. v1.1
• Extended attachments route with new entity type maintenance-ticket-image. v1.1
• Extended attachments route with new entity type maintenance-ticket-message-image. v1.1
• Extended payment entity route with new field maintenance_ticket_id. v1.1
• Extended property export active_tenancies node with email_address field. v1.1
• Extended property export active_tenancies node with mobile_number field. v1.1
• New API endpoint to retrieve global beneficiaries v1.1
• New API endpoint to create secondary payments v1.1
• New API endpoint to update secondary payments v1.1
• New API endpoint to retrieve secondary payments v1.1

 

1 Nov ’22

• New API endpoint to return payment and invoice frequencies. v1.1

 

20 Oct ’22

• New API endpoint to generate agency income report. v1.1

 

11 Oct ’22

• Extended payment entity frequency field values to O, W, 2W, 4W, M, 2M, 6M, Q and A. v1.1

 

29 Sep ’22

• Added customer_id field that contains unique, case-sensitive value per invoice entity. The value can be used to retrieve and update invoice entities. Please note that currently, this functionality is marked as experimental; we strongly recommend keeping track of PayProp entity external_id along with your customer_id v1.1
• Added customer_id field that contains unique, case-sensitive value per payment entity. The value can be used to retrieve and update payment entities. Please note that currently, this functionality is marked as experimental; we strongly recommend keeping track of PayProp entity external_id along with your customer_id v1.1

 

28 Sep ’22

• Added optional URL parameter bank_account_number to beneficiary export to filter beneficiaries by given bank account number. v1.1
• Added optional URL parameter bank_branch_code to beneficiary export to filter beneficiaries by given bank branch code. v1.1

 

21 Sep ’22

• Added transaction fee records to all payments report. Fee records can be identified where amount field is 0 having one or both of service_fee/transaction_fee fields set. v1.1

 

6 Sep ’22

• Added new /attachment/:entity/:entity_id endpoint for listing and adding attachment files for entities. v1.1

 

3 Aug ’22

• Added optional URL parameter category_id to invoice export to filter records based on invoice category external ID. v1.1
• Added optional URL parameter category_id to payment export to filter records based on payment category external ID. v1.1
• Added optional URL parameter category_id to invoice instruction export to filter records based on invoice category external ID. v1.1
• Added category field to invoice export that contains invoice category external ID and name. v1.1 v1.0
• Added category_id field to payment export that contains payment category external ID. v1.1 v1.0
• Added optional URL parameter parent_payment_id on all payments report to filter records based on parent payment ID. v1.1

 

29 Jul ’22

• Added name field to all payments report beneficiary structure. v1.1
• Added secondary_payment node on payment report to help identify if whether or not the current outgoing payment is primary or secondary. v1.1

 

26 Jul ’22

• Added amount field to all payments report payment_batch structure. This field contains a lump sum paid to the beneficiary consisting of one or more outgoing payment records. v1.1
• Added optional URL parameter incoming_transaction_id to all payments report to filter outgoing payment records based on incoming payment ID. v1.1

 

21 Jul ’22

• Added optional URL parameter include_balance to properties export that will include a sum of all recurring invoice amounts, minus the property min monthly balance, when set to true. v1.1
• Added business_name field to invoice export tenant structure. v1.1 v1.0

 

8 Jul ’22

• Added filter_by field on all outgoing payments report, to filter the results by remittance_date or reconciliation_date. v1.1
• Added optional URL parameter property_id on all outgoing payments report, to filter records based on property external ID. v1.1

 

7 Jul ’22

• Added optional URL parameter include_contract_amount to properties export that will include a sum of all recurring invoice amounts when set to true. v1.1
• Added optional URL parameter include_commission to properties export that will include commission amount and percentage when set to true. v1.1

 

1 Jul ’22

• Added account_type field to invoice export with possible values of "debit order", "direct deposit" or null. v1.1 v1.0
• Limit beneficiaries export properties item count to 25 per beneficiary to avoid large response content. v1.1 v1.0
• Limit tenants export properties item count to 25 per tenant to avoid large response content. v1.1 v1.0
• Added hold_all_owner_funds field to beneficiaries export properties node that indicates if money to be paid after commission and fixed payments should be sent to the property account instead of the owner. v1.1 v1.0
• Added hold_all_owner_funds field to properties export that indicates if money to be paid after commission and fixed payments should be sent to the property account instead of the owner. v1.1 v1.0
• Removed address field from beneficiaries export properties node. This field was never populated for beneficiaries export and will be removed from other exports in future. v1.1 v1.0
• Added responsible_agent_id field to tenants export properties node that contains external ID of an agent. v1.1 v1.0
• Added responsible_agent_id field to beneficiaries export properties node that contains external ID of an agent. v1.1 v1.0
• Added various export field data normalizations to improve performance. These are minor non-breaking changes that do not affect the current response content. v1.1 v1.0

 

29 Jun ’22

• Limit properties export active_tenancies item count to 25 per property to avoid large response content. v1.1
• Added deposit_id field to property export active_tenancies structure. v1.1
• Added display_name field to property export active_tenancies structure. v1.1

 

27 Jun ’22

• Added optional URL parameter tenant_id to invoice instruction export to filter records based on tenant external ID. v1.1

 

24 Jun ’22

• New API endpoint to generate invoice, credit & debit notes (ICDN) report. v1.1
• Added optional URL parameter tenant_id to invoice export to filter records based on tenant external ID. v1.1 v1.0

 

23 Jun ’22

• New API endpoint to generate beneficiaries with balances report. v1.1

 

15 Jun ’22

• New API endpoint to generate all outgoing payments report. v1.1

 

8 Jun ’22

• New API endpoint to generate tenant balances report. v1.1

 

29 Apr ’22

• Added customer_id to beneficiary, tenant and property export to allow filtering by a unique ID set by customer, the customer_id field is returned on beneficiary, tenant and property exports. v1.1

 

28 Apr ’22

• Added postal_code field to tenants, properties, beneficiaries, invoices and payments export routes. zip_code is deprecated and will be removed in the future. v1.1 v1.0

 

27 Apr ’22

• Fixed an issue where mobile_number is required on tenant update. v1.1
• Fixed an issue where mobile is required on beneficiary update. v1.1

 

26 Apr ’22

• The account_type is no longer required when creating a tenant and will default to "individual" if no value is provided. v1.1 v1.0

 

15 Apr ’22

• Added is_archived field on tenants, properties and beneficiaries export route. The value can be used to retrieve archived entities, by default, active entities will be returned. v1.1

 

13 Apr ’22

• New API endpoint to create tenant, beneficiary and property reminders. v1.1
• New API endpoint to retrieve tenant, beneficiary and property reminders. v1.1
• New API endpoint to update tenant, beneficiary and property reminders. v1.1

 

11 Apr ’22

• Added responsible_agent_id to property export that contains external ID of an agent. v1.1 v1.0

 

1 Apr ’22

• Fixed an issue where invoice webhook was not sent when action originated from API. v1.1 v1.0
• Fixed an issue where payment webhook was not sent when action originated from API. v1.1 v1.0
• Fixed an issue where debit and credit note webhooks were not sent when action originated from API. v1.1
• Fixed an issue where posted payment webhook was not sent when action originated from API. v1.1

 

31 Mar ’22

• Added customer_id field that contains unique, case-sensitive value per beneficiary entity. The value can be used to retrieve and update beneficiary entities. v1.1
• Added customer_id field that contains unique, case-sensitive value per tenant entity. The value can be used to retrieve and update tenant entities. v1.1
• Added customer_id field that contains unique, case-sensitive value per property entity. The value can be used to retrieve and update property entities. v1.1

 

9 Mar ’22

• Added reconciliation info for tenant statement entries where transaction_type is "debit note". v1.1 v1.0

 

14 Feb ’22

• Added optional URL parameter external_id to payment export to filter payment records based on id. v1.1
• Added optional URL parameter external_id to invoice export to filter invoice records based on id. v1.1

 

9 Feb ’22

• New API endpoint to retrieve invoice instructions. v1.1
• New API endpoint to retrieve ID types. v1.1
• Added id_type_id field to beneficiary entity. v1.1
• Added id_type_id field to tenant entity. v1.1

 

10 Jan ’22

• Added webhook retry mechanism.

 

6 Jan ’22

• Added payment_method field to beneficiary entity. v1.1
• The international field has been deprecated for beneficiary entity and will be removed in future versions. v1.1

 

20 Dec ’21

• Debit notes can now be created with tax values when has_tax is set to true. v1.1
• Credit notes can now be created with tax values when has_tax is set to true. v1.1
• Fixed an issue where tax values are not returned for ad-hoc percentage payments from property account. v1.1
• The tax_group_id field has been deprecated for property entity and will be removed in future versions. v1.1

 

3 Dec ’21

• Added frequency_code to invoice export. v1.1 v1.0
• Added frequency_code to payment export. v1.1 v1.0
• Added optional URL parameter include_beneficiary_info to payment export that will include information about payment recpient when set to true. v1.1 v1.0

 

2 Dec ’21

• New API endpoint to create invoice categories. v1.1
• New API endpoint to update invoice categories. v1.1
• New API endpoint to create payment categories. v1.1
• New API endpoint to update payment categories. v1.1
• Added optional URL parameter include_last_processing_info to property export that will include last transaction processing information on the property when set to true. v1.1

 

24 Nov ’21

• Added webhook documentation. v1.1

 

16 Nov ’21

• We now send a webhook, of type property_account_balance, whenever the property account balance changes.

 

15 Nov ’21

• The settings.listing_from field is no longer required for property entity. v1.1
• Payment category route will exclude categories where the API consumer does not have the relevant feature enabled. v1.1 v1.0
• Invoice category route will exclude categories where the API consumer does not have the relevant feature enabled. v1.1 v1.0

 

5 Nov ’21

• Webhook notifications will no longer be sent to the consumer-defined endpoint when calling the API. To receive a webhook notification to your defined endpoint for your API operations, please provide the send_webhook=true parameter with your requests.

 

25 Oct ’21

• New API endpoint to retrieve tax groups. v1.1
• New API endpoint to create debit notes. v1.1
• New API endpoint to create credit notes. v1.1
• New API endpoint to create posted payments. v1.1
• New API endpoint to retrieve agent account details. v1.1
• Tenant entity mobile numbers must now be provided using the following pattern ^[1-9]d+$. v1.1
• Beneficiary entity mobile numbers must now be provided using the following pattern ^[1-9]d+$. v1.1
• The category field has been deprecated for payment entity. To provide a transaction category please use the category_id field. v1.1
• The category field has been deprecated for invoice entity. To provide a transaction category please use the category_id field. v1.1
• API v1.0 has been deprecated.We will continue to provide bug fixes while API v1.0 remains active, however new features will not be added to this version.