Sales and receivables
Generated from --help output of fob-zb 0.2.1. Every command also accepts the global options --profile <name> (alias --org), --help and --version.
contacts#
contacts list#
fob-zb contacts list
List contacts (customers & vendors)
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]
--type Filter by contact type (mutually exclusive with --status)
[string] [choices: "customer", "vendor"]
--status Filter by status (mutually exclusive with --type)
[string] [choices: "all", "active", "inactive"]
--search Free-text search (name, company, email, phone) [string]
contacts show#
fob-zb contacts show <id>
Show a contact by id
Positionals:
id Contact id [string] [required]
Options:
--json Output raw JSON [boolean]
contacts create#
fob-zb contacts create
Create a contact
Options:
--company Company name [string]
--type Contact type [string] [choices: "customer", "vendor"]
--sub-type Customer sub-type
[string] [choices: "business", "individual"]
--email Primary contact email [string]
--phone Primary contact phone [string]
--website Website [string]
--notes Notes [string]
--payment-terms Payment terms in days [number]
--json Output raw JSON of the saved record [boolean]
--name Contact name [string] [required]
contacts edit#
fob-zb contacts edit <id>
Update a contact (only passed flags change)
Positionals:
id Contact id [string] [required]
Options:
--company Company name [string]
--type Contact type [string] [choices: "customer", "vendor"]
--sub-type Customer sub-type
[string] [choices: "business", "individual"]
--email Primary contact email [string]
--phone Primary contact phone [string]
--website Website [string]
--notes Notes [string]
--payment-terms Payment terms in days [number]
--json Output raw JSON of the saved record [boolean]
--name Contact name [string]
contacts delete#
fob-zb contacts delete <id>
Delete a contact (requires --yes)
Positionals:
id Contact id [string] [required]
Options:
-y, --yes Confirm deletion [boolean]
contacts activate#
fob-zb contacts activate <id>
Mark a contact active
Positionals:
id Contact id [string] [required]
contacts deactivate#
fob-zb contacts deactivate <id>
Mark a contact inactive
Positionals:
id Contact id [string] [required]
contact-persons#
contact-persons list#
fob-zb contact-persons list
List contact persons
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]
--contact Filter by contact id [string]
contact-persons show#
fob-zb contact-persons show <id>
Show a contact person by id
Positionals:
id Contact person id [string] [required]
Options:
--json Output raw JSON [boolean]
estimates#
estimates list#
fob-zb estimates list
List estimates
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", "sent", "invoiced", "accepted", "declined",
"expired"]
--customer Filter by customer id [string]
--search Free-text search [string]
estimates show#
fob-zb estimates show <id>
Show an estimate by id (with line items)
Positionals:
id Estimate id [string] [required]
Options:
--json Output raw JSON [boolean]
estimates create#
fob-zb estimates create
Create an estimate
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]
--customer Customer id [string] [required]
--number estimate number (default: auto) [string]
estimates edit#
fob-zb estimates edit <id>
Update an estimate (only passed flags change)
Positionals:
id estimate 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]
--customer Customer id [string]
--number estimate number [string]
estimates delete#
fob-zb estimates delete <id>
Delete an estimate (requires --yes)
Positionals:
id estimate id [string] [required]
Options:
-y, --yes Confirm deletion [boolean]
estimates mark-sent#
fob-zb estimates mark-sent <id>
Mark as sent
Positionals:
id estimate id [string] [required]
estimates mark-accepted#
fob-zb estimates mark-accepted <id>
Mark as accepted
Positionals:
id estimate id [string] [required]
estimates mark-declined#
fob-zb estimates mark-declined <id>
Mark as declined
Positionals:
id estimate id [string] [required]
estimates submit#
fob-zb estimates submit <id>
Submit for approval
Positionals:
id estimate id [string] [required]
estimates approve#
fob-zb estimates approve <id>
Approve
Positionals:
id estimate id [string] [required]
estimates email#
fob-zb estimates email <id>
Email the estimate
Positionals:
id estimate id [string] [required]
Options:
--to Recipient emails (comma-separated) [string]
--subject Email subject [string]
--body Email body [string]
sales-orders#
sales-orders list#
fob-zb sales-orders list
List sales 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", "invoiced", "partially_invoiced", "
closed", "void"]
--customer Filter by customer id [string]
--search Free-text search [string]
sales-orders show#
fob-zb sales-orders show <id>
Show a sales order by id (with line items)
Positionals:
id Sales order id [string] [required]
Options:
--json Output raw JSON [boolean]
sales-orders create#
fob-zb sales-orders create
Create a sales 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]
--customer Customer id [string] [required]
--number sales order number (default: auto) [string]
sales-orders edit#
fob-zb sales-orders edit <id>
Update a sales order (only passed flags change)
Positionals:
id sales 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]
--customer Customer id [string]
--number sales order number [string]
sales-orders delete#
fob-zb sales-orders delete <id>
Delete a sales order (requires --yes)
Positionals:
id sales order id [string] [required]
Options:
-y, --yes Confirm deletion [boolean]
sales-orders mark-open#
fob-zb sales-orders mark-open <id>
Mark as open
Positionals:
id sales order id [string] [required]
sales-orders mark-void#
fob-zb sales-orders mark-void <id>
Void the sales order
Positionals:
id sales order id [string] [required]
sales-orders submit#
fob-zb sales-orders submit <id>
Submit for approval
Positionals:
id sales order id [string] [required]
sales-orders approve#
fob-zb sales-orders approve <id>
Approve
Positionals:
id sales order id [string] [required]
sales-orders email#
fob-zb sales-orders email <id>
Email the sales order
Positionals:
id sales order id [string] [required]
Options:
--to Recipient emails (comma-separated) [string]
--subject Email subject [string]
--body Email body [string]
invoices#
invoices list#
fob-zb invoices list
List invoices
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", "sent", "draft", "overdue", "paid", "partially_paid"
, "void", "unpaid", "viewed"]
--customer Filter by customer id [string]
--search Free-text search [string]
invoices show#
fob-zb invoices show <id>
Show an invoice by id (with line items)
Positionals:
id Invoice id [string] [required]
Options:
--json Output raw JSON [boolean]
invoices create#
fob-zb invoices create
Create an invoice
Options:
--number Invoice number (default: auto) [string]
--date Invoice date (YYYY-MM-DD) [string]
--due-date Due date (YYYY-MM-DD) [string]
--reference Reference number [string]
--notes Customer notes [string]
--terms Terms & conditions [string]
--line Line item "item_id=..,quantity=..,rate=..,description=.." (
repeatable) [array]
--item Single line: item id [string]
--description Single line: description (ad-hoc line) [string]
--quantity Single line: quantity [number]
--rate Single line: rate [number]
--json Output raw JSON of the saved record [boolean]
--customer Customer id [string] [required]
invoices edit#
fob-zb invoices edit <id>
Update an invoice (only passed flags change)
Positionals:
id Invoice id [string] [required]
Options:
--number Invoice number (default: auto) [string]
--date Invoice date (YYYY-MM-DD) [string]
--due-date Due date (YYYY-MM-DD) [string]
--reference Reference number [string]
--notes Customer notes [string]
--terms Terms & conditions [string]
--line Line item "item_id=..,quantity=..,rate=..,description=.." (
repeatable) [array]
--item Single line: item id [string]
--description Single line: description (ad-hoc line) [string]
--quantity Single line: quantity [number]
--rate Single line: rate [number]
--json Output raw JSON of the saved record [boolean]
--customer Customer id [string]
invoices delete#
fob-zb invoices delete <id>
Delete an invoice (requires --yes)
Positionals:
id Invoice id [string] [required]
Options:
-y, --yes Confirm deletion [boolean]
invoices mark-sent#
fob-zb invoices mark-sent <id>
Mark an invoice as sent
Positionals:
id Invoice id [string] [required]
invoices mark-void#
fob-zb invoices mark-void <id>
Void an invoice
Positionals:
id Invoice id [string] [required]
invoices email#
fob-zb invoices email <id>
Email an invoice to the customer
Positionals:
id Invoice id [string] [required]
Options:
--to Recipient emails (comma-separated); default: customer contacts
[string]
--subject Email subject [string]
--body Email body [string]
invoices writeoff#
fob-zb invoices writeoff <id>
Write off the outstanding balance
Positionals:
id Invoice id [string] [required]
invoices cancel-writeoff#
fob-zb invoices cancel-writeoff <id>
Cancel a write-off
Positionals:
id Invoice id [string] [required]
recurring-invoices#
recurring-invoices list#
fob-zb recurring-invoices list
List recurring invoices
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"]
--customer Filter by customer id [string]
--search Free-text search [string]
recurring-invoices show#
fob-zb recurring-invoices show <id>
Show a recurring invoice by id
Positionals:
id Recurring invoice id [string] [required]
Options:
--json Output raw JSON [boolean]
recurring-invoices stop#
fob-zb recurring-invoices stop <id>
Stop the recurring profile
Positionals:
id recurring invoice id [string] [required]
recurring-invoices resume#
fob-zb recurring-invoices resume <id>
Resume the recurring profile
Positionals:
id recurring invoice id [string] [required]
credit-notes#
credit-notes list#
fob-zb credit-notes list
List credit notes
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"]
--customer Filter by customer id [string]
--search Free-text search [string]
credit-notes show#
fob-zb credit-notes show <id>
Show a credit note by id (with line items)
Positionals:
id Credit note id [string] [required]
Options:
--json Output raw JSON [boolean]
credit-notes create#
fob-zb credit-notes create
Create a credit note
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]
--customer Customer id [string] [required]
--number credit note number (default: auto) [string]
credit-notes edit#
fob-zb credit-notes edit <id>
Update a credit note (only passed flags change)
Positionals:
id credit note 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]
--customer Customer id [string]
--number credit note number [string]
credit-notes delete#
fob-zb credit-notes delete <id>
Delete a credit note (requires --yes)
Positionals:
id credit note id [string] [required]
Options:
-y, --yes Confirm deletion [boolean]
credit-notes mark-open#
fob-zb credit-notes mark-open <id>
Mark as open
Positionals:
id credit note id [string] [required]
credit-notes mark-void#
fob-zb credit-notes mark-void <id>
Void the credit note
Positionals:
id credit note id [string] [required]
credit-notes submit#
fob-zb credit-notes submit <id>
Submit for approval
Positionals:
id credit note id [string] [required]
credit-notes approve#
fob-zb credit-notes approve <id>
Approve
Positionals:
id credit note id [string] [required]
credit-notes email#
fob-zb credit-notes email <id>
Email the credit note
Positionals:
id credit note id [string] [required]
Options:
--to Recipient emails (comma-separated) [string]
--subject Email subject [string]
--body Email body [string]
retainer-invoices#
retainer-invoices list#
fob-zb retainer-invoices list
List retainer invoices
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", "sent", "paid", "partially_paid", "void", "
unpaid", "overdue"]
--customer Filter by customer id [string]
--search Free-text search [string]
retainer-invoices show#
fob-zb retainer-invoices show <id>
Show a retainer invoice by id (with line items)
Positionals:
id Retainer invoice id [string] [required]
Options:
--json Output raw JSON [boolean]
customer-payments#
customer-payments list#
fob-zb customer-payments list
List customer payments (payments received)
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]
--customer Filter by customer id [string]
--search Free-text search [string]
customer-payments show#
fob-zb customer-payments show <id>
Show a customer payment by id
Positionals:
id Payment id [string] [required]
Options:
--json Output raw JSON [boolean]