CLIorg
capxul org agreement offer
Offer a payee a salary, a stream or a retainer from a department's payroll budget
Runs in: devnet · staging · production · Moves money: no
Usage
capxul org agreement offer [flags] <payee>Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
<payee> | string | yes | The payee: a person's email, or an Organization's @handle |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--department | string | yes | the department whose budget pays it: its key (engineering) or ID (dep_…) |
--salary | string | no | a salary: 40000/year, 3500/month or 800/week |
--stream | string | no | a stream, released every second: 1400/month |
--amount | string | no | a retainer, released once per period of its rate: 250/week |
--start | string | no | the first day paid, YYYY-MM-DD (default: the acceptance) |
--end | string | no | the last day paid, inclusive, YYYY-MM-DD; makes it a fixed term |
--early-access | choice | no | a salary released daily instead of on the 1st of each month (choices: daily) |
--release | string | no | how often pay is released: 1mo, 7d, 1d, 1s, monthly, weekly, daily or second |
--expires | string | no | when the offer lapses: a date or an ISO time (default: 14 days, or the start if sooner) |
--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, approvalId, agreement: Agreement, department: AgreementDepartment & { added?, frees?, freesAt? }, released? }: the agreement once its call is on chain; --no-wait: { status: 'awaiting_approval', approvalId, approvalUrl, expiresAt, agreement, department, next: { argv } }Errors
Generated from capxul schema org agreement offer.