Purchases and payables
Generated from --help output of fob-zb 0.2.1. Every command also accepts the global options --profile <name> (alias --org), --help and --version.
bills#
bills list#
fob-zb bills list
List bills (vendor payables)
Options:
--page Page number [number] [default: 1]
--per-page Page size (max 200) [number] [default: 200]
--json Output raw JSON [boolean]
--fields Columns to show, comma-separated [string]
--format Output format. csv/json auto-paginate the full result set
[string] [choices: "table", "csv", "json"]
--output Write output to a file instead of stdout [string]
--status Filter by status
[string] [choices: "all", "draft", "open", "overdue", "paid", "partially_paid"
, "void"]
--vendor Filter by vendor id [string]
--search Free-text search [string]
bills show#
fob-zb bills show <id>
Show a bill by id (with line items)
Positionals:
id Bill id [string] [required]
Options:
--json Output raw JSON [boolean]
bills create#
fob-zb bills create
Create a bill
Options:
--number Bill number (vendor invoice no.) — required unless auto-num
bering is enabled [string]
--date Bill date (YYYY-MM-DD) [string]
--due-date Due date (YYYY-MM-DD) [string]
--reference Reference number [string]
--notes Notes [string]
--line Line "account_id=..,rate=..,quantity=..,description=.." (re
peatable) [array]
--account Single line: expense/GL account id [string]
--item Single line: item id [string]
--description Single line: description [string]
--quantity Single line: quantity [number]
--rate Single line: rate [number]
--json Output raw JSON of the saved record [boolean]
--vendor Vendor id [string] [required]
bills edit#
fob-zb bills edit <id>
Update a bill (only passed flags change)
Positionals:
id Bill id [string] [required]
Options:
--number Bill number (vendor invoice no.) — required unless auto-num
bering is enabled [string]
--date Bill date (YYYY-MM-DD) [string]
--due-date Due date (YYYY-MM-DD) [string]
--reference Reference number [string]
--notes Notes [string]
--line Line "account_id=..,rate=..,quantity=..,description=.." (re
peatable) [array]
--account Single line: expense/GL account id [string]
--item Single line: item id [string]
--description Single line: description [string]
--quantity Single line: quantity [number]
--rate Single line: rate [number]
--json Output raw JSON of the saved record [boolean]
--vendor Vendor id [string]
bills delete#
fob-zb bills delete <id>
Delete a bill (requires --yes)
Positionals:
id Bill id [string] [required]
Options:
-y, --yes Confirm deletion [boolean]
bills mark-open#
fob-zb bills mark-open <id>
Mark a bill as open
Positionals:
id Bill id [string] [required]
bills mark-void#
fob-zb bills mark-void <id>
Void a bill
Positionals:
id Bill id [string] [required]
recurring-bills#
recurring-bills list#
fob-zb recurring-bills list
List recurring bills
Options:
--page Page number [number] [default: 1]
--per-page Page size (max 200) [number] [default: 200]
--json Output raw JSON [boolean]
--fields Columns to show, comma-separated [string]
--format Output format. csv/json auto-paginate the full result set
[string] [choices: "table", "csv", "json"]
--output Write output to a file instead of stdout [string]
--status Filter by status
[string] [choices: "all", "active", "stopped", "expired"]
--vendor Filter by vendor id [string]
--search Free-text search [string]
recurring-bills show#
fob-zb recurring-bills show <id>
Show a recurring bill by id
Positionals:
id Recurring bill id [string] [required]
Options:
--json Output raw JSON [boolean]
recurring-bills stop#
fob-zb recurring-bills stop <id>
Stop the recurring profile
Positionals:
id recurring bill id [string] [required]
recurring-bills resume#
fob-zb recurring-bills resume <id>
Resume the recurring profile
Positionals:
id recurring bill id [string] [required]
vendor-credits#
vendor-credits list#
fob-zb vendor-credits list
List vendor credits
Options:
--page Page number [number] [default: 1]
--per-page Page size (max 200) [number] [default: 200]
--json Output raw JSON [boolean]
--fields Columns to show, comma-separated [string]
--format Output format. csv/json auto-paginate the full result set
[string] [choices: "table", "csv", "json"]
--output Write output to a file instead of stdout [string]
--status Filter by status
[string] [choices: "all", "open", "closed", "void", "draft"]
--vendor Filter by vendor id [string]
--search Free-text search [string]
vendor-credits show#
fob-zb vendor-credits show <id>
Show a vendor credit by id (with line items)
Positionals:
id Vendor credit id [string] [required]
Options:
--json Output raw JSON [boolean]
purchase-orders#
purchase-orders list#
fob-zb purchase-orders list
List purchase orders
Options:
--page Page number [number] [default: 1]
--per-page Page size (max 200) [number] [default: 200]
--json Output raw JSON [boolean]
--fields Columns to show, comma-separated [string]
--format Output format. csv/json auto-paginate the full result set
[string] [choices: "table", "csv", "json"]
--output Write output to a file instead of stdout [string]
--status Filter by status
[string] [choices: "all", "draft", "open", "billed", "cancelled", "pending_app
roval"]
--vendor Filter by vendor id [string]
--search Free-text search [string]
purchase-orders show#
fob-zb purchase-orders show <id>
Show a purchase order by id (with line items)
Positionals:
id Purchase order id [string] [required]
Options:
--json Output raw JSON [boolean]
purchase-orders create#
fob-zb purchase-orders create
Create a purchase order
Options:
--date Document date (YYYY-MM-DD) [string]
--reference Reference number [string]
--notes Notes [string]
--line Line "item_id=..,quantity=..,rate=..,description=.." (repea
table) [array]
--item Single line: item id [string]
--account Single line: account id (expense/GL) [string]
--description Single line: description [string]
--quantity Single line: quantity [number]
--rate Single line: rate [number]
--json Output raw JSON of the saved record [boolean]
--vendor Vendor id [string] [required]
--number purchase order number (default: auto) [string]
purchase-orders edit#
fob-zb purchase-orders edit <id>
Update a purchase order (only passed flags change)
Positionals:
id purchase order id [string] [required]
Options:
--date Document date (YYYY-MM-DD) [string]
--reference Reference number [string]
--notes Notes [string]
--line Line "item_id=..,quantity=..,rate=..,description=.." (repea
table) [array]
--item Single line: item id [string]
--account Single line: account id (expense/GL) [string]
--description Single line: description [string]
--quantity Single line: quantity [number]
--rate Single line: rate [number]
--json Output raw JSON of the saved record [boolean]
--vendor Vendor id [string]
--number purchase order number [string]
purchase-orders delete#
fob-zb purchase-orders delete <id>
Delete a purchase order (requires --yes)
Positionals:
id purchase order id [string] [required]
Options:
-y, --yes Confirm deletion [boolean]
purchase-orders mark-open#
fob-zb purchase-orders mark-open <id>
Mark as open (issued)
Positionals:
id purchase order id [string] [required]
purchase-orders mark-billed#
fob-zb purchase-orders mark-billed <id>
Mark as billed
Positionals:
id purchase order id [string] [required]
purchase-orders mark-cancelled#
fob-zb purchase-orders mark-cancelled <id>
Cancel the purchase order
Positionals:
id purchase order id [string] [required]
purchase-orders submit#
fob-zb purchase-orders submit <id>
Submit for approval
Positionals:
id purchase order id [string] [required]
purchase-orders approve#
fob-zb purchase-orders approve <id>
Approve
Positionals:
id purchase order id [string] [required]
purchase-orders email#
fob-zb purchase-orders email <id>
Email the purchase order
Positionals:
id purchase order id [string] [required]
Options:
--to Recipient emails (comma-separated) [string]
--subject Email subject [string]
--body Email body [string]
expenses#
expenses list#
fob-zb expenses list
List expenses
Options:
--page Page number [number] [default: 1]
--per-page Page size (max 200) [number] [default: 200]
--json Output raw JSON [boolean]
--fields Columns to show, comma-separated [string]
--format Output format. csv/json auto-paginate the full result set
[string] [choices: "table", "csv", "json"]
--output Write output to a file instead of stdout [string]
--status Filter by status
[string] [choices: "all", "billable", "nonbillable", "reimbursed", "invoiced",
"unbilled"]
--search Free-text search [string]
expenses show#
fob-zb expenses show <id>
Show an expense by id
Positionals:
id Expense id [string] [required]
Options:
--json Output raw JSON [boolean]
recurring-expenses#
recurring-expenses list#
fob-zb recurring-expenses list
List recurring expenses
Options:
--page Page number [number] [default: 1]
--per-page Page size (max 200) [number] [default: 200]
--json Output raw JSON [boolean]
--fields Columns to show, comma-separated [string]
--format Output format. csv/json auto-paginate the full result set
[string] [choices: "table", "csv", "json"]
--output Write output to a file instead of stdout [string]
--status Filter by status
[string] [choices: "all", "active", "stopped", "expired"]
--search Free-text search [string]
recurring-expenses show#
fob-zb recurring-expenses show <id>
Show a recurring expense by id
Positionals:
id Recurring expense id [string] [required]
Options:
--json Output raw JSON [boolean]
recurring-expenses stop#
fob-zb recurring-expenses stop <id>
Stop the recurring profile
Positionals:
id recurring expense id [string] [required]
recurring-expenses resume#
fob-zb recurring-expenses resume <id>
Resume the recurring profile
Positionals:
id recurring expense id [string] [required]
vendor-payments#
vendor-payments list#
fob-zb vendor-payments list
List vendor payments (payments made)
Options:
--page Page number [number] [default: 1]
--per-page Page size (max 200) [number] [default: 200]
--json Output raw JSON [boolean]
--fields Columns to show, comma-separated [string]
--format Output format. csv/json auto-paginate the full result set
[string] [choices: "table", "csv", "json"]
--output Write output to a file instead of stdout [string]
--vendor Filter by vendor id [string]
vendor-payments show#
fob-zb vendor-payments show <id>
Show a vendor payment by id
Positionals:
id Payment id [string] [required]
Options:
--json Output raw JSON [boolean]
vendor-payments create#
fob-zb vendor-payments create
Record a vendor payment (pay one or more bills)
Options:
--vendor Vendor id [string] [required]
--amount Payment amount [number] [required]
--date Payment date (YYYY-MM-DD) [string] [required]
--paid-through Paying account id (bank/cash) [string] [required]
--mode Payment mode [string] [default: "cash"]
--reference Reference number [string]
--bill Bill id to apply the full amount to [string]
--apply Apply to bills: "bill_id=amount" (repeatable) [array]
--json Output raw JSON of the saved record [boolean]
vendor-payments delete#
fob-zb vendor-payments delete <id>
Delete a vendor payment (requires --yes)
Positionals:
id Payment id [string] [required]
Options:
-y, --yes Confirm deletion [boolean]