Procedures
Automation procedures in the QuickBooks BDK Book.
Make sure to add the QuickBooks BDK Book to your agent before using these automation procedures.
to attach a file to the (bill) and get the attachment
Upload an attachment to an existing bill in QuickBooks.
Input Concepts
file
The file-like object to upload.
file
Yes
(no default)
file name
The name of the file to be attached.
text
Yes
(no default)
note
Optional note to add to the attachment.
text
No
(no default)
Output Concepts
Examples
the bill
the file
attach the file to the bill
the file name is "attachment.pdf"
the note is "This is an attachment note"
to create a bill
Create a new bill in QuickBooks from the provided bill details.
Input Concepts
Output Concepts
Examples
Create a bill with mixed line items.
set the department's company id to 9341455406391846
the vendor
get '{"line_items":[{"name":"Sprinkler Heads","amount":200.00,"quantity":4,"unit_price":50.00},{"account_name":"Supplies","amount":75.00,"description":"Miscellaneous office expenses"}]}' as a json
use the above as bill
set the bill's vendor to the vendor
create the bill
Create a bill with all optional fields for item-based line items.
set the department's company id to 9341455406391846
the vendor
the customer
get the customer as a string
get '{"terms":"Net 30","bill_date":"2025-07-15","due_date":"2025-08-14","bill_no":"COMPLETE-123","line_items":[{"name":"Sprinkler Heads","amount":200.00,"description":"Premium sprinkler heads","customer": {the customer},"quantity":4,"unit_price":50.00,"billable_status":"Billable"}]}' as a json
use the above as bill
set the bill's vendor to the vendor
create the bill
Create a bill with account-based line items.
set the department's company id to 9341455406391846
the vendor
the customer
get the customer as a string
get '{"line_items":[{"account_name":"Supplies","amount":150.00,"description":"Office supplies expense","customer": {the customer}}]}' as a json
set the bill's vendor to the vendor
use the above as bill
create the bill
to retrieve (customers)
Retrieve customers in QuickBooks from the company.
Input Concepts
limit
The maximum number of customers to retrieve.
number
No
(no default)
offset
The number which starts the customers to retrieve.
number
No
(no default)
Output Concepts
Examples
retrieve the customers whose display_name has "Cool"
use the first customer as the customer
to retrieve (vendors)
Retrieve vendors in QuickBooks from the company.
Input Concepts
limit
The maximum number of messages to retrieve.
number
No
(no default)
offset
The number which starts the messages to retrieve.
number
No
(no default)
Output Concepts
Examples
retrieve the vendors whose display_name is "Pam Seitz"
use the first vendor as the vendor
to retrieve a (report)
Retrieve a specific report from QuickBooks.
This procedure handles both summary and detail AR/AP reports.
Input Concepts
report type
The type of report to retrieve (AR summary, AR detail, AP summary, or AP detail).
enum[ap_detail, ap_summary, ar_detail, ar_summary]
Yes
(no default)
Output Concepts
A Report object containing the report header, columns, and grouped table sections.
quickbooks report
Examples
retrieve the report from quickbooks
the report type is "AP_DETAIL"
Last updated
Was this helpful?