API Docs 3.0API Docs 3.1API Docs 4.0 SimpleAPI Docs 4.0

Migrating from 3.1 to 4.0 Simple

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

Please make sure you have migrated to 3.1 first before migrating to 4.0s 3.1 Migration Guide

Breaking Changes

4.0 Simple is a streamlined variant of 4.0 designed for integrations that prefer a minimal interface. It retains external_id based record identification and a flat customer structure, so the migration from 3.1 is smaller in scope than the full 4.0.

POST
{base_url}/api/v4/
  • Update requests to .../api/v4/... instead of .../api/v3.1/... .
POST
{base_url}/api/v4/site/{site_id}/customer/addUpdate
  • The notification_options field has been removed from the Customer.
Products → Items
  • The Products endpoint has been renamed to Items. Update requests to site/{site_id}/item/addUpdate instead of site/{site_id}/product/addUpdate .
    • Affecting
    • POST
      {base_url}/api/v4/site/{site_id}/item/addUpdate
Attachments
  • The attachments field (a plain list of URLs) has been replaced by the attachment_refs object, which organises attachments into internal , external , and source_pdf sub-fields.
    • Affecting
    • POST
      {base_url}/api/v4/site/{site_id}/invoice/addUpdate
    • POST
      {base_url}/api/v4/site/{site_id}/customer/addUpdate
    • POST
      {base_url}/api/v4/site/{site_id}/subscription/addUpdate