REST API (beta) – feedback from migrating off the legacy API

We’re a small VAT-registered trading company that books all purchases, supplier payments and sales invoices through the API, and we’re moving from the legacy XML/JSON API to REST ahead of the June 2027 switch-off. Overall it’s been a good experience, but there are some gaps that block a full migration. All points below are checked against the current spec at /api-docs/v2.

Issues found in use

  1. No way to attach a document to a purchase. POST /documents/receipt only uploads to the Receipt Hub. Sales invoices have /documents/sales, and GET /purchases has a has_receipts filter, but there’s no equivalent of the legacy document/upload with PurchaseId. This is our biggest blocker.
  2. Silent breaking change that lost data. The purchase field suppplier_reference (triple “p”) worked in September; by October it had been renamed supplier_reference. The old name was silently ignored rather than rejected, so a PUT /purchases/{id} succeeded but wiped our supplier reference to null. The spec marks PurchasesPutRequest as additionalProperties: false, so unknown fields should be rejected. A changelog or versioning for breaking changes would really help.
  3. PUT /purchases/{id} replaces all item lines. Changing one field means resending every line, and all line IDs are regenerated. A PATCH, or line-level updates, would be safer.
  4. Supplier payments can’t be edited. Changing a payment date needs DELETE + POST. A PUT /supplier_payments/{id} (even just date/notes) would help.
  5. Can’t filter supplier payments by purchase. GET /supplier_payments has no purchase_id filter, so finding the payment for one purchase means paging through all of them.

Gaps in the spec

  1. No purchase credit notes. Sales credit notes are supported (void/refund/hold), but there’s no endpoint to raise a credit note against a purchase, so we still do it in the UI.
  2. Bank transactions can’t be tagged or matched. POST /bank_accounts/{id}/transactions creates untagged transactions only, with no PUT/DELETE. There’s no way to tag a transaction, correct its date, or match a transfer between two of our own accounts. Matching card repayments is a manual UI step every time.
  3. Bank accounts can’t be renamed. /bank_accounts has GET/POST only.
  4. /reports/vat-obligations requires hmrc_account_id, but no endpoint returns it, so the report can’t be used from the API alone. There’s also no way to view filed VAT returns.
  5. No edit (PUT) for client payments, journals, inventory or projects.
  6. Spec errors:
    • /documents/receipt, /documents/sales and /documents/general don’t define their request parameters or body.
    • supplier_reference is described as “Search by supplier reference” in PurchasesPostRequest and PurchasesPutRequest, where it’s a field being set, not a search.
    • The VAT code list says nisogs in PurchasesPostRequest/PurchasesPutRequest but nigoods in PurchaseOrderPutRequest.

Legacy API outage (FYI)

  1. Legacy API seems to be down currently. Every legacy API call fails with “Cannot load the schema for the namespace ‘https://api.quickfile.co.uk’ – The remote server returned an error: (404) Not Found.” REST kept working, which let us carry on, but anyone still on legacy would have been stuck.

What works well

  • POST /purchases with an embedded payment worked first time: the payment auto-allocates and the response includes the receipt number.
  • Redating a supplier payment with DELETE + POST /supplier_payments is reliable.
  • DELETE /client_payments/{id} returns a clear error when the payment is locked in a filed VAT return. The legacy payment/delete fails silently in that case.

Thanks!

Did you get this sorted out?

For things the API still can’t do, like matching bank transfers or creating purchase credit notes, are you doing those by hand? Or have you tried automating them through the UI?

At the moment currently doing by hand as the volume is not high. Not tried automating anything with the UI.

Hello All

The initial goal for the new REST API was to match all the features in the legacy API.

More features will follow.