File: batch.nu 1 exported command 0 internal commands

qb batch

Run a batch operation on a list of records.

Pipe in a list of records and specify the entity type and operation. Records are automatically chunked into batches of 30 (QBO maximum). Returns the combined batch response.

Usage

qb batch <entity> --operation <string> --max-batch-size <int>

Parameters

entity <string>
Entity type (e.g. Customer, Invoice)

Flags

--operation <string>
Operation: create, update, or delete
--max-batch-size <int>
Max items per batch request (QBO limit is 30) (default: 30)

Input/output types

inputoutput
anyany

Examples

batch create customers

[{DisplayName: "Acme"}, {DisplayName: "Globex"}] | qb batch Customer --operation create

batch delete payments

[{Id: "1", SyncToken: "0"}, {Id: "2", SyncToken: "1"}] | qb batch Payment --operation delete