CLIagreement
capxul agreement collect
Collect everything released: the payer pays it as one Payments V3 payment. With --org, an Owner proposal on your Organization's Safe. With nothing released, nothing is signed
Runs in: devnet · staging · production · Moves money: no
Usage
capxul agreement collect [flags] <agreement>Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
<agreement> | string | yes | The agreement's ID (ag_…), from the offer email or agreement list |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--email | string | no | the signed-in person to use, when this machine has several |
--no-wait | boolean | no | return as soon as your approval is open |
--timeout-seconds | integer | no | how long to follow it (default: until the approval lapses) |
Every command also takes the global flags.
Returns
The data of the result that --json prints:
{ status: 'settled' | 'submitted', approvalId, collected, payment: AgreementPayment, agreement: PayeeAgreement }; nothing released: { status: 'nothing_released', collected: '0.00', earned, nextReleaseAt, nextReleaseAmount, agreement }, nothing signed; --no-wait: { status: 'awaiting_approval', action, approvalId, approvalUrl, expiresAt, collected, preview, agreement, next: { argv } }Errors
Generated from capxul schema agreement collect.