Payments

Push held receipts to the ERP

Releases payments whose receipt is HELD (the connection's payment_push_mode is manual) so they are pushed to the ERP. One request releases up to 100 payments; the ERP still receives ONE receipt per payment, one call each, so a failure on one never affects the others and a payment already in the ERP is never posted twice. The answer is a verdict per payment id — ACCEPTANCE, not the ERP's outcome, which arrives afterwards: read each payment's erp_push_status (posted on success, failed with erp_push_error_category otherwise). released — it was held and is now being pushed. already_pushed — the ERP has it. not_held — nothing to release: it is queued, in flight, failed (retry is a separate admin action in the app), or has no receipt at all (a Finero-created invoice, payment sync switched off, or a payment before payment sync was enabled). not_found — not a payment in this workspace. Safe to repeat: a second request for the same ids answers already_pushed or not_held.

Requires an admin API key (has side effects).

post/v1/payments/erp-push

Request

  • Base URL: https://api.getfinero.com/functions/v1/api
  • URL: https://api.getfinero.com/functions/v1/api/v1/payments/erp-push
  • Auth: HTTP bearer

Request body

payment_idsstring[] required

Payment ids (from GET /v1/payments) to release. Duplicates are answered once.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.