submit_lifecycle_status
Submit a processing status for an invoice flow: choose from Refused, Approved, PartiallyApproved, Disputed, Suspended, Cashed, PaymentTransmitted, or Cancelled. Mandatory transmission of Refused and Cashed to the PPF.
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.
Input 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||