entity

File: entity.nu 7 exported commands 0 internal commands

`qb get`

Get a QuickBooks entity by its ID.

Usage

qb get <entity> <id>

Parameters

entity <string>: Entity type (e.g. Customer, Invoice, Item)
id <any>: The entity ID

Input/output types

input	output
any	any

Examples

get a customer by ID

qb get Customer 1

get an invoice by ID

qb get Invoice 42

`qb create`

Create a new QuickBooks entity.

Accepts data as a record argument or piped input. Returns the created entity record.

Usage

qb create <entity> <data?>

Parameters

entity <string>: Entity type (e.g. Customer, Invoice)
data <record>: Entity data to create. Can also be piped in. (optional)

Input/output types

input	output
any	any

Examples

create a customer

qb create Customer {DisplayName: "Acme Corp", CompanyName: "Acme"}

create a customer via pipe

{DisplayName: "Acme Corp"} | qb create Customer

`qb update`

Update an existing QuickBooks entity.

The data record MUST include Id and SyncToken fields. Returns the updated entity record.

Usage

qb update <entity> <data?>

Parameters

entity <string>: Entity type (e.g. Customer, Invoice)
data <record>: Entity data with Id and SyncToken. Can also be piped in. (optional)

Input/output types

input	output
any	any

Examples

update a customer

qb update Customer {Id: "1", SyncToken: "0", DisplayName: "New Name"}

update via pipe

{Id: "1", SyncToken: "0", CompanyName: "Updated"} | qb update Customer

`qb delete`

Delete a QuickBooks entity.

The data record MUST include Id and SyncToken fields.

Usage

qb delete <entity> <data?>

Parameters

entity <string>: Entity type (e.g. Payment, Bill)
data <record>: Record with Id and SyncToken. Can also be piped in. (optional)

Input/output types

input	output
any	any

Examples

delete a payment

qb delete Payment {Id: "5", SyncToken: "1"}

delete via pipe

{Id: "5", SyncToken: "1"} | qb delete Bill

`qb void`

Void a QuickBooks transaction (Invoice, Payment, SalesReceipt, BillPayment).

The data record MUST include Id and SyncToken fields.

Usage

qb void <entity> <data?>

Parameters

entity <string>: Entity type (Invoice, Payment, SalesReceipt, BillPayment)
data <record>: Record with Id and SyncToken. Can also be piped in. (optional)

Input/output types

input	output
any	any

Examples

void an invoice

qb void Invoice {Id: "7", SyncToken: "3"}

void a payment

qb void Payment {Id: "10", SyncToken: "2"}

`qb send`

Send an entity via email (e.g. an Invoice or Estimate).

Usage

qb send <entity> <id> --to <string>

Parameters

entity <string>: Entity type (e.g. Invoice, Estimate)
id <any>: The entity ID

Flags

--to <string>: Optional email address override

Input/output types

input	output
any	any

Examples

send an invoice

qb send Invoice 7

send an invoice to a specific email

qb send Invoice 7 --to "customer@example.com"

`qb pdf`

Download a PDF of an entity (Invoice, Estimate, SalesReceipt, etc.).

Returns the raw PDF bytes. Pipe to `save` to write to a file.

Usage

qb pdf <entity> <id>

Parameters

entity <string>: Entity type (e.g. Invoice, SalesReceipt)
id <any>: The entity ID

Input/output types

input	output
any	any

Examples

download an invoice PDF

qb pdf Invoice 7 | save invoice_7.pdf

download a sales receipt PDF

qb pdf SalesReceipt 12 | save receipt.pdf