1. Overview
QuickBooks is a comprehensive accounting software developed by Intuit, designed primarily for small and medium-sized businesses. It offers a wide range of features to manage income and expenses, track financial health, and streamline business operations.
With the GoInsight Quickbooks node, you can seamlessly integrate accounting functionalities into your automated workflows. This allows for the management of key financial data, including:
- Invoicing and Payments: Create, update, send, and delete invoices and payments.
- Customer and Vendor Management: Manage customer and vendor records, including creation and updates.
- Expense Tracking: Handle bills and purchases to keep your financial records accurate.
- Employee and Estimate Management: Create, update, and manage employee records and customer estimates.
- Reporting: Retrieve financial reports to gain insights into your business performance.
2. Prerequisites
Before using this node, you need to have a valid Quickbooks account. You may also need administrative or specific permissions to create and manage API credentials required for the integration.
3. Credentials
For a detailed guide on how to obtain and configure your credentials, please refer to our official documentation: Credentials Configuration Guide.
4. Supported Operations
This section provides a summary of the supported operations, followed by detailed descriptions of each.
Summary
The Quickbooks node allows you to perform operations on various resources such as Bills, Customers, Employees, Estimates, Invoices, Items, Payments, Purchases, Reports, and Vendors.
| Resource | Operation | Description |
|---|---|---|
| Bill | Create a Bill | Creates a Bill in QuickBooks Online for a specified vendor. |
| Bill | Delete a Bill | Deletes a specific Bill in QuickBooks Online. |
| Bill | Get a Bill | Retrieves a specific Bill in QuickBooks Online by its bill ID. |
| Bill | Get Many Bills | Retrieves multiple Bill objects from QuickBooks Online. |
| Bill | Update a Bill | Updates an existing Bill in QuickBooks Online. |
| Customer | Create a Customer | Creates a new QuickBooks Online customer record. |
| Customer | Get a Customer | Retrieves a QuickBooks Online customer record by its ID. |
| Customer | Get Many Customers | Retrieves multiple QuickBooks Online customer records. |
| Customer | Update a Customer | Updates an existing QuickBooks Online customer record. |
| Employee | Create an Employee | Creates a new QuickBooks Online employee record. |
| Employee | Get an Employee | Retrieves a QuickBooks Online employee record by its ID. |
| Employee | Get Many Employees | Retrieves multiple QuickBooks Online employee records. |
| Employee | Update an Employee | Updates an existing QuickBooks Online employee record. |
| Estimate | Create an Estimate | Creates a QuickBooks Online estimate record. |
| Estimate | Delete an Estimate | Deletes a QuickBooks Online estimate by its ID. |
| Estimate | Get an Estimate | Gets a QuickBooks Online estimate record by its ID. |
| Estimate | Get Many Estimates | Retrieves multiple QuickBooks Online estimate records. |
| Estimate | Send an Estimate | Sends an existing QuickBooks Online estimate by email. |
| Estimate | Update an Estimate | Updates an existing QuickBooks Online estimate record. |
| Invoice | Create an Invoice | Creates a new QuickBooks Online invoice. |
| Invoice | Delete an Invoice | Deletes a QuickBooks Online invoice by its ID. |
| Invoice | Get an Invoice | Retrieves a single QuickBooks Online invoice by its ID. |
| Invoice | Get Many Invoices | Retrieves multiple QuickBooks Online invoices. |
| Invoice | Send an Invoice | Sends an existing QuickBooks Online invoice to a customer’s email. |
| Invoice | Void an Invoice | Voids a QuickBooks invoice by its invoice ID. |
| Invoice | Update an Invoice | Updates an existing QuickBooks invoice. |
| Item | Get an Item | Gets a single QuickBooks item by its item ID. |
| Item | Get Many Items | Gets multiple QuickBooks items. |
| Payment | Create a Payment | Creates a payment record in QuickBooks. |
| Payment | Delete a Payment | Deletes a single QuickBooks payment record by its ID. |
| Payment | Get a Payment | Gets a single QuickBooks payment by its payment ID. |
| Payment | Get Many Payments | Gets multiple payments from QuickBooks. |
| Payment | Send a Payment | Sends an existing payment in QuickBooks Online to an email address. |
| Payment | Void a Payment | Voids a payment in QuickBooks Online by its payment ID. |
| Payment | Update a Payment | Updates an existing payment in QuickBooks Online. |
| Purchase | Get a Purchase | Retrieves a purchase from QuickBooks Online by purchase ID. |
| Purchase | Get Many Purchases | Retrieves a list of purchases from QuickBooks Online. |
| Report | Get a Report | Retrieves a report from QuickBooks Online. |
| Vendor | Create a Vendor | Creates a new vendor in QuickBooks Online. |
| Vendor | Get a Vendor | Retrieves a vendor from QuickBooks Online by vendor ID. |
| Vendor | Get Many Vendors | Retrieves a list of vendors from QuickBooks Online. |
| Vendor | Update a Vendor | Updates an existing vendor in QuickBooks Online. |
Operation Details
Create a Bill
Creates a Bill in QuickBooks Online for a specified vendor with given line items and optional transaction and due dates.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- VendorId: The ID of the vendor to whom the bill is issued.
- LineItems: A JSON string representing an array of bill line item objects.
Options:
- TxnDate: Transaction date of the bill in YYYY-MM-DD format.
- DueDate: Due date of the bill in YYYY-MM-DD format.
- Memo: A memo or note for the bill.
Output:
- Bill (object): The created Bill object returned by the QuickBooks API.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error description if creation fails.
Delete a Bill
Deletes a specific Bill in QuickBooks Online using the bill's ID; this action cannot be undone.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- BillId: The ID of the bill to delete.
Output:
- Deleted (bool): Indicates whether the bill was successfully deleted.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error description if deletion fails.
Get a Bill
Retrieves a specific Bill in QuickBooks Online by its bill ID.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- BillId: The ID of the bill to retrieve.
Output:
- Bill (object): The bill object returned by the QuickBooks API.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error description if retrieval fails.
Get Many Bills
Retrieves multiple Bill objects from QuickBooks Online using the Query endpoint.
Input Parameters:
- RealmId: QuickBooks company realm ID.
Options:
- StartPosition: The starting position of the result set (>=1).
- MaxResults: Maximum number of items to return (>=1).
- BillIds: The ID List of the bill to retrieve (e.g., 110,111,112,113,....).
Output:
- Bills (object-array): A list of Bill objects returned by the QuickBooks API.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error description if query fails.
Update a Bill
Updates an existing Bill in QuickBooks Online; this action cannot be undone.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- BillId: The ID of the bill to update.
Options:
- VendorId: The vendor ID associated with the bill.
- LineItems: A list of expense line items for the bill.
- TxnDate: Transaction date of the bill in YYYY-MM-DD format.
- DueDate: Due date of the bill in YYYY-MM-DD format.
- Memo: A memo or note for the bill.
Output:
- Bill (object): The updated Bill object returned by the QuickBooks API.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error description if update fails.
Create a Customer
Creates a new QuickBooks Online customer record using the provided customer information.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- DisplayName: Customer's display name.
Options:
- GivenName: Customer's first name.
- FamilyName: Customer's last name.
- CompanyName: Customer's company name.
- PrimaryEmail: Customer's primary email address.
- PrimaryPhone: Customer's primary phone number.
- BillingAddr: JSON string representing the customer's billing address object.
- PrintOnCheckName: Name to print on checks for the customer.
- ShippingAddr: JSON string representing the customer's shipping address object.
- Balance: Open balance amount or amount unpaid by the customer.
Output:
- Customer (object): The newly created customer object.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error description if creation fails.
Get a Customer
Retrieves a QuickBooks Online customer record specified by its customer ID.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- CustomerId: The ID of the customer to retrieve.
Output:
- Customer (object): The retrieved customer object.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error description if retrieval fails.
Get Many Customers
Retrieves multiple QuickBooks Online customer records specified by a comma-separated list of customer IDs.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
Options:
- StartPosition: The starting position of the result set (>=1).
- MaxResults: Maximum number of items to return (>=1).
- CustomerIds: A comma-separated list of customer IDs to retrieve.
Output:
- Customers (object-array): A list of customer objects.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if parameter validation fails.
Update a Customer
Updates an existing QuickBooks Online customer record.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- CustomerId: The ID of the customer to update.
Options:
- DisplayName: Updated customer display name.
- GivenName: Updated customer first name.
- FamilyName: Updated customer last name.
- CompanyName: Updated customer company name.
- PrimaryEmail: Updated primary email address.
- PrimaryPhone: Updated primary phone number.
- BillingAddr: JSON string representing updated billing address object.
- PrintOnCheckName: Updated name printed on checks.
- ShippingAddr: JSON string representing updated shipping address object.
- Balance: Updated open balance amount.
Output:
- Customer (object): The updated customer object.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error description if update fails.
Create an Employee
Creates a new QuickBooks Online employee record.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- FamilyName: Employee's last name.
- GivenName: Employee's first name.
- DisplayName: Employee's display name.
Options:
- PrimaryAddr: JSON string representing the employee's primary address object.
- PrimaryPhone: Employee's contact phone number.
- PrintOnCheckName: The name to print on checks for the employee.
- SSN: Employee's social security number.
Output:
- Employee (object): The newly created employee object.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error description if creation fails.
Get an Employee
Retrieves a QuickBooks Online employee record by its ID.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- EmployeeId: The ID of the employee to retrieve.
Output:
- Employee (object): The retrieved employee object.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if retrieval fails.
Get Many Employees
Retrieves multiple QuickBooks Online employee records.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
Options:
- StartPosition: The starting position of the result set (>=1).
- MaxResults: Maximum number of items to return (>=1).
- EmployeeIds: A comma-separated list of employee IDs to retrieve.
Output:
- Employees (object-array): A list of employee objects.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if parameter validation fails.
Update an Employee
Updates an existing QuickBooks Online employee record.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- EmployeeId: The ID of the employee to update.
Options:
- FamilyName: Employee's last name.
- GivenName: Employee's first name.
- DisplayName: Employee's display name.
- PrimaryAddr: JSON string representing the employee's primary address object.
- PrimaryPhone: Employee's contact phone number.
- PrintOnCheckName: The name to print on checks for the employee.
- SSN: Employee's social security number.
Output:
- Employee (object): The updated employee object.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if the update fails.
Create an Estimate
Creates a QuickBooks Online estimate record.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- CustomerId: The ID of the customer for whom to create the estimate.
- LineData: JSON string representing an array or object of line items.
Options:
- TxnDate: Transaction date of the estimate (YYYY-MM-DD).
- ExpirationDate: Expiration date of the estimate (YYYY-MM-DD).
- CustomerMemo: Customer memo for the estimate.
- SalesId: Sales representative ID associated with the estimate.
- DocNum: Document number for the estimate (>=0).
- BillingAddr: JSON string representing the billing address object.
- BillingEmail: Email address to send the estimate to the customer.
- ShippingAddr: JSON string representing the shipping address object.
Output:
- Estimate (object): The created estimate object.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if the operation fails.
Delete an Estimate
Deletes a QuickBooks Online estimate by its ID. This action is permanent.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- EstimateId: The ID of the estimate to delete.
Output:
- Deleted (bool): Indicates whether the estimate was successfully deleted.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error description if deletion fails.
Get an Estimate
Gets a QuickBooks Online estimate record by its ID.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- EstimateId: The ID of the estimate to retrieve.
Output:
- Estimate (object): The estimate object returned by the QuickBooks API.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if the operation fails.
Get Many Estimates
Retrieves multiple QuickBooks Online estimate records.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
Options:
- StartPosition: The starting position for query results (>= 1).
- MaxResults: Maximum number of estimate records to return (>= 1).
Output:
- Estimates (object-array): List of retrieved estimate objects.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if the operation fails.
Send an Estimate
Sends an existing QuickBooks Online estimate by email to the customer.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- EstimateId: The ID of the estimate to send.
- SendTo: Recipient email address.
Output:
- Sent (bool): Indicates whether the estimate email was successfully sent.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if the send action fails.
Update an Estimate
Updates an existing QuickBooks Online estimate record by its ID.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- EstimateId: The ID of the estimate to update.
Options:
- LineData: JSON string representing an array or object of updated line items.
- TxnDate: New transaction date for the estimate (YYYY-MM-DD).
- ExpirationDate: New expiration date for the estimate (YYYY-MM-DD).
- CustomerMemo: New memo for the estimate.
- SalesId: New sales representative ID.
- DocNum: New document number for the estimate (>=0).
- BillingAddr: JSON string representing updated billing address object.
- BillingEmail: New email address for sending the estimate.
- ShippingAddr: JSON string representing updated shipping address object.
Output:
- Estimate (object): The updated estimate object.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if the update fails.
Create an Invoice
Creates a new QuickBooks Online invoice.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- CustomerId: ID of the customer for whom to create the invoice.
- LineData: JSON string representing an array or object of line items.
Options:
- TotalAmt: Total transaction amount for the invoice (>=0).
- TxnDate: Transaction date of the invoice (YYYY-MM-DD).
- DueDate: Due date for invoice payment (YYYY-MM-DD).
- Balance: Balance amount applied to the invoice (>=0).
- SalesId: Sales representative ID associated with the invoice.
- CustomerMemo: Customer memo for the invoice.
- DocNum: Document number for the invoice.
- BillingAddr: JSON string representing the billing address object.
- BillingEmail: Email address to send the invoice to the customer.
- ShippingAddr: JSON string representing the shipping address object.
Output:
- Invoice (object): The created invoice object.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if the operation fails.
Delete an Invoice
Deletes a QuickBooks Online invoice by its ID. This action is permanent.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- InvoiceId: The ID of the invoice to delete.
Output:
- Deleted (bool): Indicates whether the invoice was successfully deleted.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error description if deletion fails.
Get an Invoice
Retrieves a single QuickBooks Online invoice by its ID.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- InvoiceId: The ID of the invoice to retrieve.
Output:
- Invoice (object): The invoice object returned by the QuickBooks API.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error description if retrieval fails.
Get Many Invoices
Retrieves multiple QuickBooks Online invoices.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
Options:
- InvoiceIds: Comma-separated invoice IDs to filter results.
- LastUpdatedTime: Filter by invoice last update time.
- StartPosition: Starting record number (>=1) for pagination.
- MaxResults: Maximum number of records to retrieve (1–1000).
Output:
- Invoices (object-array): An array of invoice objects.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error description if retrieval fails.
Send an Invoice
Sends an existing QuickBooks Online invoice to a customer’s email address.
Input Parameters:
- RealmId: QuickBooks company (Realm) ID.
- InvoiceId: ID of the invoice to send.
- SendTo: Recipient email address.
Output:
- Sent (bool): Indicates whether the invoice email was sent successfully.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error description if sending fails.
Void an Invoice
Voids a QuickBooks invoice by its invoice ID.
Input Parameters:
- RealmId: QuickBooks company realm ID.
- InvoiceId: The ID of the invoice to be voided.
Output:
- Invoice (object): The voided Invoice object.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if operation failed.
Update an Invoice
Updates an existing QuickBooks invoice with specified data fields.
Input Parameters:
- RealmId: QuickBooks Online company (Realm) ID.
- InvoiceId: The ID of the invoice to update.
Options:
- BillingAddr: JSON string representing the billing address.
- BillingEmail: Billing email address.
- DocNum: Transaction reference number.
- DueDate: Invoice due date in YYYY-MM-DD format.
- ShippingAddr: JSON string representing the shipping address.
- TxnDate: Transaction date in YYYY-MM-DD format.
Output:
- UpdatedInvoice (object): The updated invoice object.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error description if update fails.
Get an Item
Gets a single QuickBooks item by its item ID.
Input Parameters:
- RealmId: QuickBooks company realm ID.
- ItemId: The ID of the item to retrieve.
Output:
- Item (object): The retrieved Item object.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if operation failed.
Get Many Items
Gets multiple QuickBooks items.
Input Parameters:
- RealmId: QuickBooks company realm ID.
Options:
- StartPosition: The starting position of the result set (>=1).
- MaxResults: Maximum number of items to return (>=1).
Output:
- Items (object-array): List of Item objects.
- StartPosition (number): The starting position used in the query.
- MaxResults (number): The maximum number of items requested.
- TotalCount (number): Total number of items matching the query.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if operation failed.
Create a Payment
Creates a payment record in QuickBooks.
Input Parameters:
- RealmId: QuickBooks company realm ID.
- CustomerId: The ID of the customer to whom the payment is applied.
- TotalAmt: The total amount of the payment.
Options:
- TxnDate: Transaction date in YYYY-MM-DD format.
Output:
- Payment (object): The created Payment object.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if operation failed.
Delete a Payment
Deletes a single QuickBooks payment record by its ID.
Input Parameters:
- RealmId: QuickBooks company realm ID.
- PaymentId: The ID of the payment record to be deleted.
Output:
- Deleted (bool): Indicates whether the payment was successfully deleted.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if operation failed.
Get a Payment
Gets a single QuickBooks payment by its payment ID.
Input Parameters:
- RealmId: QuickBooks company realm ID.
- PaymentId: The ID of the payment record to retrieve.
Output:
- Payment (object): The retrieved Payment object.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if operation failed.
Get Many Payments
Gets multiple payments from QuickBooks.
Input Parameters:
- RealmId: QuickBooks company realm ID.
Options:
- StartPosition: The starting position of the result set (>=1).
- MaxResults: Maximum number of payments to return (>=1).
- LastUpdatedTime: Filter by last update time.
- TotalAmt: Filter by payment amount.
- TxnDate: Filter by transaction date.
Output:
- Payments (object-array): List of payment objects.
- StartPosition (number): Starting position of the returned result set.
- MaxResults (number): Maximum number of payments requested.
- TotalCount (number): Total number of payments matching the query.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if operation failed.
Send a Payment
Sends an existing payment in QuickBooks Online to an email address.
Input Parameters:
- RealmId: QuickBooks Online company ID (realm ID).
- PaymentId: The payment record ID to send.
- SendTo: The email address to which the payment should be sent.
Output:
- Sent (bool): Indicates whether the email was successfully sent.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if an error occurred.
Void a Payment
Voids a payment in QuickBooks Online by its payment ID.
Input Parameters:
- RealmId: QuickBooks Online company ID (realm ID).
- PaymentId: The payment record ID to be voided.
Output:
- Payment (object): The voided payment object.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if an error occurred.
Update a Payment
Updates an existing payment in QuickBooks Online.
Input Parameters:
- RealmId: QuickBooks Online company ID (realm ID).
- PaymentId: The payment record ID to update.
Options:
- TotalAmt: The total amount of the payment.
- TxnDate: Transaction date in YYYY-MM-DD format.
Output:
- Payment (object): The updated payment object.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if an error occurred.
Get a Purchase
Retrieves a purchase from QuickBooks Online by purchase ID.
Input Parameters:
- RealmId: QuickBooks Online company ID (realm ID).
- PurchaseId: The purchase record ID to retrieve.
Output:
- Purchase (object): Purchase object as returned by QuickBooks Online API.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if an error occurred.
Get Many Purchases
Retrieves a list of purchases from QuickBooks Online.
Input Parameters:
- RealmId: QuickBooks Online company ID (realm ID).
Options:
- StartPosition: The starting record position for the purchases list.
- MaxResults: Maximum number of purchase records to return.
Output:
- Purchases (object-array): List of purchase objects.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if an error occurred.
Get a Report
Retrieves a report from QuickBooks Online.
Input Parameters:
- RealmId: QuickBooks Online company ID (realm ID).
Options:
- StartDate: The starting date for the report in "YYYY-MM-DD" format.
- EndDate: The ending date for the report in "YYYY-MM-DD" format.
- Columns: Comma-separated list of columns to include in the report.
- Vendor: Vendor ID to filter the report.
- SortBy: Column name to sort the report.
- SortOrder: Sort direction: "Ascend" or "Descend".
- GroupBy: Column name to group the report results.
Output:
- Report (object): The report data returned by QuickBooks Online API.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if an error occurred.
Create a Vendor
Creates a new vendor in QuickBooks Online.
Input Parameters:
- RealmId: QuickBooks Online company ID (realm ID).
- DisplayName: The display name of the vendor to be created.
Options:
- Title: The title display name of the vendor.
- GivenName: The first name of the vendor.
- FamilyName: The last name of the vendor.
- Suffix: The suffix name of the vendor.
- PrimaryEmailAddr: The primary email address of the vendor.
- WebAddr: The homepage address of the vendor.
- PrimaryPhone: The primary phone of the vendor.
- MobilePhone: The mobile phone of the vendor.
- TaxIdentifier: The tax identifier of the vendor.
- AcctNum: The bank account number of the vendor.
- CompanyName: The company name of the vendor.
- BillAddr: The billing address of the vendor's company.
- PrintOnCheckName: The name to print on checks for the vendor.
Output:
- Vendor (object): Created vendor object.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if an error occurred.
Get a Vendor
Retrieves a vendor from QuickBooks Online by vendor ID.
Input Parameters:
- RealmId: QuickBooks Online company ID (realm ID).
- VendorId: QuickBooks Online vendor ID.
Output:
- Vendor (object): Vendor object as returned by QuickBooks Online API.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if an error occurred.
Get Many Vendors
Retrieves a list of vendors from QuickBooks Online.
Input Parameters:
- RealmId: QuickBooks Online company ID (realm ID).
Options:
- StartPosition: The starting record position for the vendor list.
- MaxResults: Maximum number of vendor records to return.
Output:
- Vendors (object-array): List of vendor objects.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error message if an error occurred.
Update a Vendor
Updates an existing vendor in QuickBooks Online.
Input Parameters:
- RealmId: The QuickBooks Online company ID (realm ID).
- VendorId: The unique ID of the vendor to be updated.
Options:
- DisplayName: The display name of the vendor.
- Title: The title display name of the vendor.
- GivenName: The first name of the vendor.
- FamilyName: The last name of the vendor.
- Suffix: The suffix name of the vendor.
- PrimaryEmailAddr: The primary email address of the vendor.
- WebAddr: The homepage address of the vendor.
- PrimaryPhone: The primary phone of the vendor.
- Mobile: The mobile phone of the vendor.
- TaxIdentifier: The tax identifier of the vendor.
- AcctNum: The bank account number of the vendor.
- CompanyName: The company name of the vendor.
- BillAddr: The billing address of the vendor's company.
- PrintOnCheckName: The name to print on checks for the vendor.
Output:
- VendorId (string): The ID of the vendor that was updated.
- Updated (bool): Indicates whether the update was successful.
- StatusCode (number): Operation status code.
- ErrorMessage (string): Error description if the update fails.
5. Example Usage
This section guides you through creating a simple workflow to create a new customer in your Quickbooks account.
Workflow Overview
The workflow will consist of a Start node, a Quickbooks node to create the customer, and an Answer node to display the result.
Step-by-Step Guide
- Add the Quickbooks Node:
- In the workflow canvas, click the "+" icon to add a new node.
- Select the "Tools" tab in the pop-up panel.
- Find and select "Quickbooks" from the list of tools.
- In the list of supported operations, click "Create a Customer" to add the node to the canvas.
- Configure the Node:
- Click the newly added "Create a Customer" node to open its configuration panel on the right.
- Credentials: In the credentials field, select your pre-configured Quickbooks credentials from the dropdown menu.
- Parameters: Fill in the required parameters for creating a customer:
- RealmId: Enter your QuickBooks Online company (Realm) ID.
- DisplayName: Provide a display name for the new customer, e.g., "John Doe".
- You can also fill in optional fields like GivenName, FamilyName, and PrimaryEmail to add more details.
- Run and Verify:
- Once all required parameters are filled, the error indicators on the workflow canvas will disappear.
- Click the "Run" button in the top-right corner of the canvas to execute the workflow.
- After successful execution, you can view the detailed input and output of the node by clicking the log icon in the top-right corner to verify that the customer was created successfully.
Final Workflow
After completing these steps, your workflow is ready. When you run it, a new customer will be created in your Quickbooks account.
6. FAQs
Q: What should I do if I get a 401 or 403 error?
A: These errors typically indicate an issue with your credentials or permissions. Please check the following:
- Ensure your API credentials are correct and have not expired.
- Verify that your Quickbooks account has the necessary permissions to perform the requested operation.
Q: Why is my "Create a Customer" operation failing?
A: Make sure you have provided all the required fields, especially RealmId and DisplayName. Also, check that the data formats are correct (e.g., email addresses).
7. Official Documentation
For more detailed information, you can refer to the Quickbooks Official API Documentation.
Leave a Reply.