Skip to main content

API R31

· 2 min read
Craig Herrington

Release 31 of the API includes 2 new endpoints and changes to 4 existing endpoints.

Release Date

The UAT API will be updated on 08-Jul-2026.

The Live API release date is 15-Jul-2026.

Times may change without notice, no downtime of the API is expected.

View Billing Spec

Billing​

NEW GET /v1/api/payment-terms & /v1/api/payment-terms/:payment-term-uuid

  • Retrieve payment terms. The list endpoint supports optional query parameter is-active to filter by active status.
  • Some default payment terms exist in the system but are not active by default; use is-active to include or exclude them as needed.
  • Each payment term includes payment-term-uuid, term-code, term-name, term-days, end-of-month, and is-active.

CHANGE POST /v1/api/payments

  • Optional fields allocation-insured and allocation-uninsured added. When supplied, the payment is allocated only to the specified insured and uninsured amounts. Both values can be provided.

CHANGE GET /v1/api/invoices & /v1/api/:billing-uuid/invoices

  • New query filters: contact-uuid, due-date-start, due-date-end, modified-date-start, modified-date-end, and unpaid-only.
  • Results can now include deleted invoices. Query parameter deleted supports IncludeDeleted, ExcludeDeleted, and DeletedOnly. The dedicated deleted-invoices endpoint will be deprecated in a future release.
  • Query parameter has-balance-on filters by balance type: Invoice (any outstanding balance on the invoice), Uninsured (outstanding uninsured balance), or Insured (outstanding insured balance).
  • Invoice responses now include invoice-due-date, payment-term-uuid, payment-term-name, contact-uuid, location-uuid, balance-outstanding, balance-insured, balance-uninsured, and deleted-date.

CHANGE GET /v1/api/invoices/:invoice-uuid

  • Invoice responses now include invoice-due-date, payment-term-uuid, payment-term-name, contact-uuid, location-uuid, balance-outstanding, balance-insured, balance-uninsured, and deleted-date, including when the invoice has been deleted.

If you have any questions please contact us.