Hyfin Logo
API Docs 3.0API Docs 3.1API Docs 4.0 SimpleAPI Docs 4.0

Migrating from 3.1 to 4.0

Important information to update from 3.1 to 4.0 of the API.

Breaking Changes

POST
{base_url}/api/v4/
  • Update requests to hit .../api/v4.0/... instead of .../api/v3.1/... .
POST
{base_url}/api/v4/invoice/addUpdate
  • The totals object is validated against the lines array. If they do not match the request will fail.
  • The lines[i].total is validated when lines[i].qty and lines[i].unit_price are supplied. If they do not match the request will fail.
  • The Totals object has been updated, see below.
Totals Object
  • Field renamed: {Totals}.tax becomes {Totals}.taxes .
    • Affecting
    • POST
      {base_url}/api/v4/invoice/addUpdate