Create a draft

post

https://api.open-finance.ai/integrations/{integrationId}/proposals

Prepares documents (credit notes, receipts, tax invoices, invoice-receipts) or customers against the provider and freezes them as a draft for the user to approve in Financy (proposal.approvalUrl). Nothing is issued until the user approves it there; an API key can never approve. A draft expires 24 hours after creation unless approved. All or nothing: when any item does not resolve or prepare, nothing is stored.

Drafts are available for Invoice4U, Morning, SUMIT and iCount. Priority and Isracard Business are read only: a draft answers 503 WRITES_DISABLED.

Send an Idempotency-Key to retry safely: the same key with the same body returns the first answer (refusals included) with Idempotent-Replayed: true; the same key with another body is 409 IDEMPOTENCY_KEY_REUSED.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

401

Missing or invalid access token (answered by the API gateway, without the error envelope).

201Draft created, waiting for approval in Financy

400The request is invalid. type: VALIDATION_FAILED.

403Refused. type: INSUFFICIENT_SCOPE, FORBIDDEN, IP_NOT_ALLOWED, NOT_AVAILABLE_ON_SURFACE, FORBIDDEN_BY_POLICY, USER_ID_REQUIRED, UPGRADE_REQUIRED, ENTITLEMENT_NOT_PROVISIONED, NOT_ENTITLED.

404Not found. type: NOT_FOUND, INTEGRATION_NOT_FOUND. A malformed id in the path is also NOT_FOUND.

409Conflict. type: ACCOUNT_TERMINATION_PENDING, INTEGRATION_NEEDS_REAUTH, IDEMPOTENCY_KEY_REUSED, IDEMPOTENCY_IN_PROGRESS.

422Refused by the content of the request. type: PROPOSAL_INVALID, PROPOSAL_TOO_LARGE, CREDIT_EXCEEDS_REMAINING, CREDIT_VAT_RATE_UNSUPPORTED. details.items names each refused item (itemIndex, fields, reason, e.g. not_found, not_creditable, inactive).

429Too many requests. type: RATE_LIMITED, PROPOSAL_THROTTLED. PROPOSAL_THROTTLED: too many drafts in the last hour for this user (20 by default). RATE_LIMITED: over 600 requests per minute per API client.

500Internal error. type: INTERNAL.

503Temporarily unavailable. type: TEMPORARILY_UNAVAILABLE, CONNECTOR_UNAVAILABLE, WRITES_DISABLED, PROVIDER_UNAVAILABLE. WRITES_DISABLED: the connector is read only (Priority, Isracard Business) or writes are switched off for it right now.