Toggle Reconciliation
POST/api/magento2/integration-instances/:magento2IntegrationInstance/transactions/:txn/reconcile
Toggle the manual reconciliation flag on the transaction. The note is optional and persists alongside the timestamp; setting is_reconciled: false clears both fields.
Body params:
is_reconciled(required, boolean) — true to set, false to clear.note(optional, string, max 1000) — free-text reconciliation note.type(optional, string) — discriminator. One of: invoice, credit_memo. Default: invoice.
Error responses:
404— id does not exist for the suppliedtypein this instance.422— body validation failed.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.