Appearance

v1.1.0 ​

New endpoints and schemas across Bills, Mandates, and Direct Debit, plus Payout Links and Counterparty updates.

Bills ​

  • POST /api/v1/bills — Ingest a new bill from your ERP into Synthix Flow.
  • GET /api/v1/bills — List bills with optional filters (status, type, cashflowType, counterpartyReference, due-date range) and pagination.
  • GET /api/v1/bills/{uniqueReferenceIdentifier} — Retrieve a single bill by tenant reference.
  • PATCH /api/v1/bills/{uniqueReferenceIdentifier} — Update bill status, open amount, or due date.
  • POST /api/v1/bills/{uniqueReferenceIdentifier}/document — Upload a PDF, JPEG, or PNG document and link it to a bill.
  • Supported regions (x-region): EU, IN, US, UK.

Mandates (SEPA only) ​

  • POST /api/v1/mandates — Create a SEPA direct debit mandate.
  • GET /api/v1/mandates — List mandates with optional filters.
  • GET /api/v1/mandates/{mandateReference} — Retrieve a single mandate by reference.
  • DELETE /api/v1/mandates/{mandateReference} — Cancel an active mandate (transitions to CANCELLED).
  • Region: EU only. Currency: EUR only.
  • mode: CORE only. type: RECURRING or ONE_OFF. frequency is optional. The SEPA Creditor Identifier is supplied via the creditor's bankIdentifier (dedicated MandateCreditorBankIdentifier).

Direct Debit (SEPA only) ​

  • POST /api/v1/direct-debit — Initiate a collection request against an active mandate.
  • GET /api/v1/direct-debit — List collection requests with cursor-based pagination.
  • GET /api/v1/direct-debit/{collectionReference} — Retrieve a single collection request.
  • Region: EU only. Currency: EUR only.
  • Added optional accountHolderName field to the create-payout-link request.
  • Added UK payouts: UK-BACS and UK-FAST payment rails (payoutMethod), alongside SEPA-CT, SEPA-INSTANT, and US-ACH.
  • Added uiMode to control how the payout link renders: hosted (default — Synthix-hosted full-page checkout) or embedded (rendered inside a partner-controlled iframe via the Synthix SDK). Embedded mode accepts short link windows (expiryPeriod pt10m–pt12h); the partner origin must be on the tenant's allowed-SDK-origins allowlist.
  • Currency: EUR, USD, GBP. Regions: EU, US, UK.

Counterparties ​

  • PATCH /api/v1/counterparties/{counterpartyReference} now supports updating counterparty details (accountHolderName, emailAddress, mobileNumber, remarks, address). counterpartyReference remains immutable.
  • branchIdentifier.type is matched to the account currency: BIC (EUR), SORT (UK/GBP), ROUTING (US/USD), IFSC (INR).

United Kingdom (UK) ​

  • Added UK as a supported region. The previous GB region code is now UK (x-region: UK).
  • Added SORT as a branchIdentifier.type — a 6-digit UK sort code used for GBP accounts.

Error handling ​

  • Every error response now uses the standard { code, field, message } envelope with a documented code on all 4xx and 5xx responses. Bills server errors previously returned an empty body on 5xx — they now carry a code you can log and quote to support.
  • Corrected the codes returned for several Bills validation cases (region/currency mismatch, invalid bill reference) and an Accounts query-parameter validation case so they match the published API Error Codes reference.