submit_lifecycle_status
Emit a processing status for a received invoice, such as Refused or Cashed, with mandatory transmission to PPF for certain statuses. Requires user confirmation to prevent accidental actions.
Instructions
Emit a processing status on a received invoice: Refused, Approved, PartiallyApproved, Disputed, Suspended, Cashed, PaymentTransmitted, Cancelled. Refused and Cashed are mandatory transmissions to PPF. Reason is mandatory for Refused and Disputed.
HUMAN-IN-THE-LOOP: Requires user confirmation. Call without confirmation_token first, show the summary to the user, then call again with the token.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| referenced_flow_id | Yes | Identifier of the invoice flow to which this status applies (flowId returned upon receipt, maxLength 36). | |
| status_code | Yes | Lifecycle status code to emit. Values defined in XP Z12-014: Refused (transmitted to PPF), Approved, PartiallyApproved, Disputed, Suspended, Cashed (transmitted to PPF), PaymentTransmitted, Cancelled. Refused and Cashed are mandatory transmissions to PPF. | |
| reason | No | Status reason, mandatory for Refused and Disputed. Free text describing the reason for refusal or dispute. | |
| payment_date | No | Payment date (ISO 8601 format: YYYY-MM-DD). Provided for Cashed and PaymentTransmitted statuses. | |
| payment_amount | No | Payment amount (decimal string, e.g. '1250.00'). Provided for Cashed and PaymentTransmitted statuses. | |
| confirmation_token | No | Confirmation token from a previous call. Omit on the first call; supply on the second call to execute. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||