
QuickBooks is a popular accounting software developed by Intuit, designed primarily for small and medium-sized businesses. It offers a range of features to help businesses manage their finances
QuickBooks is widely used due to its user-friendly interface, comprehensive features, and integration capabilities with other business tools and services.
Connecting QuickBooks to Wiresk enhances financial and operational management by automating tasks and improving data accuracy.
Possible actions in Wiresk:
- With scheduled Triggers like Check Updated Invoice and Check New Invoice, you can automatically monitor and update changes in QuickBooks.
- Use Wiresk’s Query Builder and Get Records by Search String to quickly locate specific records, such as invoices or customer details.
- Manage records efficiently with actions like Create, Update Record, and Upsert. You can add new invoices, modify customer information, or handle credit card transactions (Create Credit Card).
- Handle files with Upload File and Download, enabling you to attach documents to records or retrieve them for audits or client requests.
- Automate communications with Send Mail, ensuring timely updates about invoices or payments.
- Add context to records using Create File Note or remove outdated data with the Delete Method. The Find and List Methods help locate specific records or generate lists for analysis, providing better insights into your financial data.
Explore the available functionalities through the QuickBooks API documentation.
1 – Connect Quickbooks to Wiresk Copy Link
A connection to your Quickbooks account is needed so we can sync it with our platform.
There are two ways to connect your app to Wiresk:
▪️ In “My apps” section, where you can manage your connections (select or create your group first to get access to this section, refer to the Group system ).
▪️ While building your Flow, you can easily establish a connection to your app directly within the Flow builder. This can be done during the setup of either a Trigger or a Method.
In this documentation, we will explain how to create a connection in “My apps” section, it is essentially the same as when creating it on-the-go.
Add Quickbooks app in Wiresk Copy Link
- On the left panel of Wiresk user interface, go to “My apps” and click on the (+) button.
- Search “Quickbooks” in the search field or scroll down the list of apps and choose the Quickbooks icon.

Connect Quickbooks via an OAuth connection: Copy Link
- In the prompted screen, give a name to your connection, e.g., “Quickbooks Connection”.
- Select the environment of your account (Development or Production).
- Select the checkbox Quickbooks (permissions for authorization).
- Select the “Authorize” button. You will be redirected to Quickbooks connection page.

- If you’ve already logged into your QuickBooks account, the connection will happen automatically, and you’ll be redirected back to Wiresk’s connection screen. If you haven’t logged in yet, you’ll need to connect to your QuickBooks account by entering your credentials and completing the identity verification steps.

- Back to the “Add Apps” screen, you can notice a new field “Email” with your Quickbooks email account.

- Now select the “Save” button. Voila! Your Quickbooks app connection is ready. You can now use it to build your Flows.
2 – Create your automated Flows with Quickbooks Copy Link
Now that Quickbooks is linked to Wiresk, you’re ready to start building Flows.
How to create a Flow (select to expand ↓ )
- Select your Group, then on the Flow management screen click on “Create Flow”.

A – Select the Trigger
- Name the Flow that you want to create.
- Add your Trigger by clicking on the red plus (+) Add button.
- On the Trigger selection screen, search your app or select it from the list below the screen.

- Select your preferred Trigger on the next screen and customize its settings (for Quickbooks Triggers, refer to the Trigger settings below).
As mentioned in “How to connect your app to Wiresk” above, during your Trigger settings, you can create a new connection to your apps at this stage.
B – Add an HTTP Trigger to your Flow
An HTTP Trigger allows you to manually activate your Flows.
- Click on the red plus button (+) again to add a Trigger for testing your Flow, then click on the button “HTTP Trigger”.

- Write a description and select your API key or create a new one.

- Click on save. Now you can use your HTTP Trigger to Manually run your Flow.
C – Add a Method to your Flow
The Method will perform a specific task on a particular app or service you’ve connected to Wiresk like get info or send emails.
You can add at least 1 or multiple Methods for complex Flows (a maximum of 255 Methods).
- On the Flow builder screen, click on the plus button (+) next to the Trigger icon.

- Search or scroll down to select your apps Methods, then configure it settings. For Quickbooks Methods, see Methods list and settings in the step below.
D – Add Wiresk Tools to your Flow
If you want to build a complex Flow, Wiresk offers a selection of tools at your disposal. Refer to Wiresk’s Tools
To add Tools in your Flow, Follow the same step as adding the Methods. On the Flow builder screen, click on the plus button (+) then just click on the “Tool” tab and select the Tool that you want to add.
3 – Quickbooks Triggers Copy Link
What will start your automation…
Recurrence rule or scheduler settings Copy Link
Setting up the recurrence rule or scheduler of your Trigger (if the Trigger is not a Webhook):
- Regular intervals will monitor your Trigger by intervals in minute
- Daily recurrence will monitor your Trigger by day and hour
- Monthly recurrence will monitor your Trigger every month on a defined date and hour
- Yearly recurrence will monitor your Trigger on a specific date and hour every year
- Specific dates will start your Trigger on specific dates
Get Sample Copy Link
After setting up the Trigger parameters (refer to how to define your parameters in the steps below), click on “Get sample”.
The “Get sample” allows you to extract a subset of data for validation. The data will be used to MAP your Method parameters according to your Flow. Refer to FIELD MAPPING documentation.

Scheduled Triggers List and Settings Copy Link
These Triggers will start your Flow automatically at a specific time or intervals instead of being triggered real-time event (Webhooks).
Check Updated Invoice Copy Link
Configuration Table:
Name* | Check Updated Invoice |
Connection* | Select your connection or create one. |
Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
Recurrence rule/scheduler* | Set up your recurrence rule. |
Parameters | |
Include Previous Invoices | Selecting Yes retrieve all existing invoices. Choosing No shows only invoices created since the last time the flow was executed. |
Preview Data | In this tab, you can preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available”, or “Cannot read properties of null ” will be displayed. |
(*) required field
Before saving your Trigger, don’t forget to use “Get Sample”.
Get Records by Search String Copy Link
The query operation is similar to a pared down SQL query select statement, but with a few limitations.
See Quickbooks documentation on Query operation and syntax.
Configuration Table:
Name* | Get Records by Search String |
Connection* | Select your connection or create one. |
Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
Recurrence rule/scheduler* | Set up your recurrence rule. |
Parameters | |
Query String | Example of Query: select * from Invoice where id = ‘239’ |
Preview Data | In this tab, you can preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available”, or “Cannot read properties of null ” will be displayed. |
(*) required field
Before saving your Trigger, don’t forget to use “Get Sample”.
Check New Invoice Copy Link
Configuration Table:
Name* | Check New Invoice |
Connection* | Select your connection or create one. |
Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
Recurrence rule/scheduler* | Set up your recurrence rule. |
Parameters | |
Include Previous Invoices | Selecting Yes retrieve all existing invoices. Choosing No shows only invoices created since the last time the flow was executed. |
Preview Data | In this tab, you can preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available”, or “Cannot read properties of null ” will be displayed. |
(*) required field
Before saving your Trigger, don’t forget to use “Get Sample”.
Retrieve records using Wiresk’s Query Builder Copy Link
A Query Builder allows you to create complex SQL queries without having to write any code.
This allows non-technical users to easily access and analyze data with a graphical user interface.
See how to use Wiresk’s Query Builder.
✓ When This Trigger is running, the result of the Query can be use to Map your Methods.
Configuration Table:
Name* | Retrieve Records using Wiresk’s Query Builder |
Connection* | Select your connection or create one Refer to how to create a connection. |
Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
Recurrence rule/scheduler* | Set up your recurrence rule |
Parameters | |
Entity* (Set of data that contain records) | Select the Entity where the data records are located. For example, “Invoice“, “Item“, or “Payment“. |
Related Entities | This section allows you to link related entities in Quickbooks to the primary entity you are querying. Clicking “Link an entity” will let you select and define relationships between the primary entity and its related entities. |
Configure Filter | This tab enables you to define specific criteria to narrow down the records being retrieved. |
Configure grouping | This tab allows you to group the retrieved records based on certain attributes or fields. |
Configure Columns | Configure which columns or fields of data will be retrieved and included in the output. Preview Data: To visualize the records. You must select at least 1 Columns to get the Preview Dat. If you get this message:” Cannot convert undefined or null to object”, it means there is no records. Number of records:10 By default, 10 records will be shown. Begin at record:0 The display starts at record 0. Edit Columns Customize which columns are displayed and retrieved. Minimum 1 column, maximum 50 columns. Configure Sorting This option is for sorting the data in the columns by Ascending or descending order. |
(*) required field
Before saving your Trigger, don’t forget to use “Get Sample”.
Get All Records of an Entity Copy Link
Configuration Table:
Name* | Get All Records of an Entity |
Connection* | Select your connection or create one. |
Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
Recurrence rule/scheduler* | Set up your recurrence rule. |
Parameters | |
Entity* (Set of data that contain records) | Select the Entity to retrieve records. Invoice, Bill, Journal Entry, Deposit, Credit Memo, Purchase Order, Customer, Vendor, Account, Purchase, Time Activity, Refund Receipt, Sales Receipt, Estimate, Payment, Item, File. |
Page | Define the page number of retrieve records. |
Limit | Define the maximum of records per page. |
Preview Data | In this tab, you can preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available”, or “Cannot read properties of null ” will be displayed. |
(*) required field
Before saving your Trigger, don’t forget to use “Get Sample”.
4 – Quickbooks Methods Copy Link
What your automation will do…

Methods List and Settings Copy Link
CREATE Copy Link
This Method allows you to create:
Invoice, Item, Payment, Journal Entry, Bill, Sale Receipt, Estimate, Deposit, Credit Memo, Purchase Order, Customer, Vendor, Account, Purchase, Time Activity, Refund Receipt.
Configuration Table:
Input Options:
- Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
- Default Value: You can specify a fixed attribute.
Name* | Create |
Connection* | Select your connection or create one. |
Entity* (Set of data that contain records) | Select the available Entity to create records: Invoice, Item, Payment, Journal Entry, Bill, Sale Receipt, Estimate, Deposit, Credit Memo, Purchase Order, Customer, Vendor, Account, Purchase, Time Activity, Refund Receipt. |
(*) required field
Configuration table for each Entity:
Create Invoice Copy Link
Note:
▪️ Have at least one Line a sales item or inline subtotal.
▪️ The
DocNumber
attribute is populated automatically by the data service if not supplied.▪️ If
ShipAddr, BillAddr
, or both are not provided, the appropriate customer address from the referenced Customer object is used to fill those values.Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Invoice API Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the invoice creation. Additional fields: Sales Term Reference, Transaction Date, Customer Memo, Transaction Tax Detail, Deposit, Line, DocNumber. | |
Customer Reference* | A customer is a consumer of the service or product that your business offers. Reference to a customer or job. Customer ID*: The ID for the referenced customer. Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Line* Invoice line object. If the transaction is taxable there is a limit of 750 lines per transaction. | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Invoice Line. Detail Type*: Possible choices for each line: Sales Item Line Detail Group Line Detail Amount*: The amount of the line item. The [+ Add Field] button allows to add fields corresponding to the Detail Type. Description: Free form text description of the line item that appears in the printed record. Max character: 4000. Line Number: Specifies the position of the line in the collection of transaction lines. Sale Item Line Detail [+ Add Field] add more fields in Sale Item Line Detail: _ Quantity: Number of items for the line. _ Unit Price: Unit price of the subject item as referenced by ItemRef. _ Discount Amount: Fixed discount. _ Discount Rate: The discount rate applied to this line. If both Discount are provided, Discount Rate takes precedence and Discount Amount is recalculated by QuickBooks services based on amount of Discount Rate. _ Item Reference: Reference to an Item object. [+ Add Field] add more fields in Item reference: ___ Item ID: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._ Tax Code Reference: Reference to the Tax Code for this item. [+ Add Field] add more fields in Tax Code Reference: ___ Value: The ID for the referenced Tax Code. ___ Name: Name derived from the field that holds the common name of that Tax Code. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
ADDITIONAL FIELDS | |
Sales Term Reference | Reference to the sales term associated with the transaction. Value: The ID for the referenced Sales Term. |
Transaction Date | The date entered by the user when this transaction occurred. yyyy/MM/dd is the valid date format. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. |
Customer Memo Max 1000 chars. | Value: User’s message to the customer; this message is visible to the end user on their transactions. |
Transaction Tax Detail | This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. Transaction Tax Code Reference: _ Value: Reference to the transaction tax code. See Global tax model for more information about this element. |
Deposit | The deposit made towards this invoice. |
DocNumber | This field stores the transaction’s reference number. You can specify a custom value during creation. If none is provided this field is populated based on the setting of Preferences: CustomTxnNumber .▪️ If UseCustomTxnNumbers preference is enabled: You can provide a custom DocNumber . Duplicates are not allowed.▪️ If no custom value is given, DocNumber is null.▪️ If UseCustomTxnNumbers is disabled: DocNumber is automatically generated by the system.Cash/CreditCard: Duplicates always cause an error. Check: Duplicates cause an error only if the WarnDuplicateCheckNumber preference is enabled.Tips: Check the UseCustomTxnNumbers preference before setting DocNumber manually.Allow Duplicates: Use the include=allowduplicatedocnum query parameter to allow duplicate DocNumber (not recommended).Default Sort Order: Ascending order. |
(*) required field
Response sample from Create Invoice
{
"Invoice": {
"TxnDate": "2015-07-24",
"domain": "QBO",
"PrintStatus": "NeedToPrint",
"TotalAmt": 100.0,
"Line": [
{
"LineNum": 1,
"Amount": 100.0,
"SalesItemLineDetail": {
"TaxCodeRef": {
"value": "NON"
},
"ItemRef": {
"name": "Services",
"value": "1"
}
},
"Id": "1",
"DetailType": "SalesItemLineDetail"
},
{
"DetailType": "SubTotalLineDetail",
"Amount": 100.0,
"SubTotalLineDetail": {}
}
],
"DueDate": "2015-08-23",
"ApplyTaxAfterDiscount": false,
"DocNumber": "1069",
"sparse": false,
"ProjectRef": {
"value": "39298034"
},
"Deposit": 0,
"Balance": 100.0,
"CustomerRef": {
"name": "Amy's Bird Sanctuary",
"value": "1"
},
"TxnTaxDetail": {
"TotalTax": 0
},
"SyncToken": "0",
"LinkedTxn": [],
"ShipAddr": {
"City": "Bayshore",
"Line1": "4581 Finch St.",
"PostalCode": "94326",
"Lat": "INVALID",
"Long": "INVALID",
"CountrySubDivisionCode": "CA",
"Id": "109"
},
"EmailStatus": "NotSet",
"BillAddr": {
"City": "Bayshore",
"Line1": "4581 Finch St.",
"PostalCode": "94326",
"Lat": "INVALID",
"Long": "INVALID",
"CountrySubDivisionCode": "CA",
"Id": "2"
},
"MetaData": {
"CreateTime": "2015-07-24T10:33:39-07:00",
"LastUpdatedTime": "2015-07-24T10:33:39-07:00"
},
"CustomField": [
{
"DefinitionId": "1",
"Type": "StringType",
"Name": "Crew #"
}
],
"Id": "238"
},
"time": "2015-07-24T10:33:39.11-07:00"
}
Create Item Copy Link
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Item API Reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Item creation. Additional fields: Active, SKU, Unit Price, TrackQtyOnHand, QtyOnHand, AssetAccountRef, InvStartDate, ExpenseAccountRef. | |
Name* Maximum of 100 chars | Name of the item. This value must be unique, at least one character in length, and cannot include tabs, new lines, or colons. Required for create. |
IncomeAccountRef* | Reference to the posting account, that is, the account that records the proceeds from the sale of this item. Must be an account with account type of Sales of Product Income .Account ID*: The ID for the referenced Income Account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Type* | Classification that specifies the use of this item:Inventory - Service - Non inventory See the description at the top of the Item entity page for details about supported item types. |
ADDITIONAL FIELDS | |
Active | True – False Inactivating an item is achieved by setting the Active attribute to false. |
SKU | The stock keeping unit (SKU) for this Item. This is a company-defined identifier for an item or product used in tracking inventory. maximum of 100 chars. minorVersion: 4 |
Unit Price | Price of the item. |
TrackQtyOnHand | True - False |
QtyOnHand | Current quantity of the Inventory items available for sale.Not used for Service or NonInventory type items.Required for Inventory type items. |
AssetAccountRef | Reference to the Inventory Asset account that tracks the current value of the inventory. If the same account is used for all inventory items, the current balance of this account will represent the current total value of the inventory. Must be an account with account type of Other Current Asset . Use Account.Id and Account.Name from that object for AssetAccountRef.value and AssetAccountRef.name , respectively. Required for Inventory item types.Account ID*: The ID for the referenced asset account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
InvStartDate | Date of opening balance for the inventory transaction. Required when creating an Item.Type =Inventory. Required for Inventory item types.Local timezone: YYYY-MM-DD UTC: YYYY-MM-DDZ Specific time zone: YYYY-MM-DD+/-HH:MM The date format follows the XML Schema standard. |
ExpenseAccountRef | Reference to the expense account used to pay the vendor for this item. Must be an account with account type of Cost of Goods Sold .Account ID*: The ID for the referenced expense account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
(*) required field
Response sample from Create Item
{
"Item": {
"FullyQualifiedName": "Garden Supplies",
"domain": "QBO",
"Id": "19",
"Name": "Garden Supplies",
"TrackQtyOnHand": true,
"UnitPrice": 0,
"PurchaseCost": 0,
"QtyOnHand": 10,
"IncomeAccountRef": {
"name": "Sales of Product Income",
"value": "79"
},
"AssetAccountRef": {
"name": "Inventory Asset",
"value": "81"
},
"Taxable": false,
"sparse": false,
"Active": true,
"SyncToken": "0",
"InvStartDate": "2015-01-01",
"Type": "Inventory",
"ExpenseAccountRef": {
"name": "Cost of Goods Sold",
"value": "80"
},
"MetaData": {
"CreateTime": "2015-12-09T11:12:39-08:00",
"LastUpdatedTime": "2015-12-09T11:12:41-08:00"
}
},
"time": "2015-12-09T11:12:39.748-08:00"
}
Create Payment Copy Link
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Payment API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Payment creation. Additional fields: Currency Reference, Project Reference, Line. | |
Total amount* | Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. If you process a linked refund transaction against a specific transaction, the totalAmt value won’t change. It will remain the same. However, voiding the linked refund will change the totalAmt value to 0. |
Customer reference* | Reference to a customer or job. Customer ID*: The ID for the referenced customer. Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
ADDITIONAL FIELDS | |
Currency Reference | Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multi-currency is enabled for the company. Read more about multi-currency support here. Currency ID: A three letter string representing the ISO 4217 code for the currency. For example, USD, AUD, EUR. Name: The full name of the currency. |
Project reference | Reference to the Project ID associated with this transaction. Project ID: The ID for the referenced Project. Name: Name derived from the field that holds the common name of that project. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Line Zero or more transactions accounting for this payment. | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Payment Line can be added as elements. Element 1: Represents the first Payment Line. Amount*: The amount of the line item. Linked Transaction*: Transaction to which the current entity is related. For example, a billpayment line links to the originating bill object for which the billpayment is applied._ Transaction ID*: Transaction id of the related transaction. _ Transaction Type*: Possible values: Expense Check Credit Card Credit Journal Entry Credit Memo Invoice |
(*) required field
Response sample from Create Payment
{ "Payment": { "SyncToken": "0", "domain": "QBO", "DepositToAccountRef": { "value": "4" }, "UnappliedAmt": 25.0, "TxnDate": "2014-12-30", "TotalAmt": 25.0, "ProjectRef": { "value": "39298034" }, "ProcessPayment": false, "sparse": false, "Line": [], "CustomerRef": { "name": "Red Rock Diner", "value": "20" }, "Id": "154", "MetaData": { "CreateTime": "2014-12-30T10:26:03-08:00", "LastUpdatedTime": "2014-12-30T10:26:03-08:00" } }, "time": "2014-12-30T10:26:03.668-08:00" }
Create Journal Entry Copy Link
▪️ There are at least one pair of lines, a debit and a credit, called distribution lines.
▪️ Each distribution line has an account from the Chart of Accounts. Query the Account resource for a listing of the Chart of Accounts.
▪️ The total of the debit column equals the total of the credit column.
When you record a transaction with a JournalEntry object, the QuickBooks Online UI labels the transaction as JRNL in the register and as General Journal on reports that list transactions.
Tip: For Any Reference fields like Customer Reference, Account Reference or Vendor Reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Journal Entry API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Journal Entry creation. Additional fields: DocNumber. | |
Line* Individual line items of a transaction. There must be at least one pair of Journal Entry Line elements, representing a debit and a credit, called distribution lines. Set Line Detail Type to Journal Entry Line for both lines. | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Journal Entry Line can be added as elements. Element 1: Represents the first Journal Entry Line. Detail Type*: Set to Journal Entry Line Detail .Amount*: The amount of the line item. Journal Entry Line Detail*: _ Posting Type*: Indicates whether this Journal Entry line is a Debit or Credit. _ Account Reference*: Reference to the account associated with this line. ___ Value*: The ID for the referenced account. ___ Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘.⚠️ If this account has same location as specified in the transaction by the TransactionLocationType attribute and the same VAT as in the line item TaxCodeRef attribute, then this account is used.⚠️ If there is a mismatch, then the account from the account category list that matches the transaction location and VAT is used. ⚠️ If this account is not present in the account category list, then a new account is created with the new location, new VAT code, and all other attributes as in the default account. Description: Free form text description of the line item that appears in the printed record. Max 4000 chars. |
ADDITIONAL FIELDS | |
DocNumber | This field stores the transaction’s reference number. You can specify a custom value during creation. If none is provided this field is populated based on the setting of Preferences: CustomTxnNumber .▪️ If UseCustomTxnNumbers preference is enabled: You can provide a custom DocNumber . Duplicates are not allowed.▪️ If no custom value is given, DocNumber is null.▪️ If UseCustomTxnNumbers is disabled: DocNumber is automatically generated by the system.Cash/CreditCard: Duplicates always cause an error. Check: Duplicates cause an error only if the WarnDuplicateCheckNumber preference is enabled.Tips: Check the UseCustomTxnNumbers preference before setting DocNumber manually.Allow Duplicates: Use the include=allowduplicatedocnum query parameter to allow duplicate DocNumber (not recommended).Default Sort Order: Ascending order. |
(*) required field
Response sample from Create Journal Entry
{
"time": "2015-06-29T12:45:32.183-07:00",
"JournalEntry": {
"SyncToken": "0",
"domain": "QBO",
"TxnDate": "2015-06-29",
"sparse": false,
"Line": [
{
"JournalEntryLineDetail": {
"PostingType": "Debit",
"AccountRef": {
"name": "Truck:Depreciation",
"value": "39"
}
},
"DetailType": "JournalEntryLineDetail",
"Amount": 100.0,
"Id": "0",
"Description": "nov portion of rider insurance"
},
{
"JournalEntryLineDetail": {
"PostingType": "Credit",
"AccountRef": {
"name": "Notes Payable",
"value": "44"
}
},
"DetailType": "JournalEntryLineDetail",
"Amount": 100.0,
"Id": "1",
"Description": "nov portion of rider insurance"
}
],
"Adjustment": false,
"Id": "228",
"TxnTaxDetail": {},
"MetaData": {
"CreateTime": "2015-06-29T12:45:32-07:00",
"LastUpdatedTime": "2015-06-29T12:45:32-07:00"
}
}
}
Create Bill Copy Link
When creating a bill, only certain transaction types can be linked. The most commonly supported transaction types include:
▪️ BillPaymentCheck – A payment made by check to pay the bill.
▪️ BillPaymentCreditCard – A payment made by credit card to pay the bill.
▪️ CreditMemo – A credit memo applied to the bill.
▪️ JournalEntry – A journal entry affecting the bill.
Transactions like Invoice and Deposit are not typically linked to a bill because a bill represents an expense or liability, while invoices are accounts receivable (money owed to you, not by you). Deposits usually relate to received funds, not expenses.
Tip: For Any Reference fields like Customer Reference, Account Reference or Vendor Reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Bill API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Bill creation. Additional fields: Currency Reference, Ap Account Reference, Sales Term Reference, Linked Transaction, DocNumber. | |
Vendors Reference* | Reference to the vendor for this transaction. [+ Add Field] add more fields: Value: The ID for the referenced vendor. Name: Name derived from the field that holds the common name of that vendor. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Line* | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type*: Possible choices for each line: Account Based Expense Line Detail – Item based Expense Line Detail Amount*: The amount of the line item. The [+ Add Field] button allows to add fields corresponding to Detail Type. Description: Free form text description of the line item that appears in the printed record. Max 4000 chars. Account Based Expense Line Detail: _ Account Reference: Reference to the Expense account associated with this item. ___ Account ID: The ID for the referenced account. ___ Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘.⚠️ If this account has same location as specified in the transaction by the TransactionLocationType attribute and the same VAT as in the line item TaxCodeRef attribute, then this account is used.⚠️ If there is a mismatch, then the account from the account category list that matches the transaction location and VAT is used. ⚠️ If this account is not present in the account category list, then a new account is created with the new location, new VAT code, and all other attributes as in the default account. Item based Expense Line Detail: _ Quantity: Number of items for the line. _ Unit Price: Unit price of the subject item. _ Item Reference: : Reference to the Item. ___ Value: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._ Customer Reference: Reference to a customer or job. ___ Value: The ID for the referenced customer. ___ Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
ADDITIONAL FIELDS | |
Currency Reference | Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multi-currency is enabled for the company. Read more about multi-currency support here. [+ Add Field] add more fields: Value: A three letter string representing the ISO 4217 code for the currency. For example, USD, AUD, EUR. Name: The full name of the currency. |
Ap Account Reference | Specifies to which AP account the bill is credited. [+ Add Field] add more fields: Value: The ID for the referenced account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘.⚠️ The specified account must have Account.Classification set to Liability and Account.AccountSubType set to AccountsPayable . If the company has a single AP account, the account is implied. However, it is recommended that the AP Account be explicitly specified in all cases to prevent unexpected errors when relating transactions to each other. |
Sales Term Reference | Reference to the Term associated with the transaction. [+ Add Field] add more fields: Value: The ID for the referenced sales term. Name: Name derived from the field that holds the common name of that sales term. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Linked Transaction | Zero or more transactions linked to this Bill object. [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Linked Transaction can be added as elements. Element 1: Represents the first Linked Transaction. Transaction ID: Unique identifier of the related transaction. Transaction Type: Possible values: BillPaymentCheck – A payment made by check to pay the bill.BillPaymentCreditCard – A payment made by credit card to pay the bill.CreditMemo – A credit memo applied to the bill.JournalEntry – A journal entry affecting the bill. |
DocNumber | This field stores the transaction’s reference number. You can specify a custom value during creation. If none is provided this field is populated based on the setting of Preferences: CustomTxnNumber .▪️ If UseCustomTxnNumbers preference is enabled: You can provide a custom DocNumber . Duplicates are not allowed.▪️ If no custom value is given, DocNumber is null.▪️ If UseCustomTxnNumbers is disabled: DocNumber is automatically generated by the system.Cash/CreditCard: Duplicates always cause an error. Check: Duplicates cause an error only if the WarnDuplicateCheckNumber preference is enabled.Tips: Check the UseCustomTxnNumbers preference before setting DocNumber manually.Allow Duplicates: Use the include=allowduplicatedocnum query parameter to allow duplicate DocNumber (not recommended).Default Sort Order: Ascending order. |
(*) required field
Response Sample from Create Bill
{
"Bill": {
"SyncToken": "0",
"domain": "QBO",
"VendorRef": {
"name": "Bob's Burger Joint",
"value": "56"
},
"TxnDate": "2014-12-31",
"TotalAmt": 200.0,
"APAccountRef": {
"name": "Accounts Payable (A/P)",
"value": "33"
},
"Id": "151",
"sparse": false,
"Line": [
{
"DetailType": "AccountBasedExpenseLineDetail",
"Amount": 200.0,
"Id": "1",
"AccountBasedExpenseLineDetail": {
"TaxCodeRef": {
"value": "NON"
},
"AccountRef": {
"name": "Advertising",
"value": "7"
},
"BillableStatus": "NotBillable"
}
}
],
"Balance": 200.0,
"DueDate": "2014-12-31",
"MetaData": {
"CreateTime": "2014-12-31T09:59:18-08:00",
"LastUpdatedTime": "2014-12-31T09:59:18-08:00"
}
},
"time": "2014-12-31T09:59:17.449-08:00"
}
Create Sale Receipt Copy Link
The receipt specifies a deposit account for the received funds. If no deposit account is designated, the payment is directed to the Undeposited Account.
▪️ A SalesReceipt object must have at least one line that describes an item and an amount.
Tip: For Any Reference fields like Customer Reference, Account Reference or Vendor Reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Sales Receipt API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Sale Receipt creation. Additional fields: DocNumber. | |
Line* The minimum line item required for the request is Sales Item Line or Group Line. | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type* Possible values for each line: Sales Item Line Detail Group Line Detail Description Line Detail Discount Line Detail Subtotal Line Detail Amount*: The amount of the line item. Sale Item Line Detail*: _ Item Reference*: : Reference to the Item. ___ Value*: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._ Unit Price: Unit price of the subject item as referenced by ItemRef ._ Quantity: Number of items for the line. _ Tax Code Reference: Reference to the TaxCode for this item. [+ Add Field] add more fields: ___ Value: The ID for the referenced Tax Code. [+ Add Field] add more fields: Description: Free form text description of the line item that appears in the printed record. Max 4000 chars. |
ADDITIONAL FIELDS | |
DocNumber | This field stores the transaction’s reference number. You can specify a custom value during creation. If none is provided this field is populated based on the setting of Preferences: CustomTxnNumber .▪️ If UseCustomTxnNumbers preference is enabled: You can provide a custom DocNumber . Duplicates are not allowed.▪️ If no custom value is given, DocNumber is null.▪️ If UseCustomTxnNumbers is disabled: DocNumber is automatically generated by the system.Cash/CreditCard: Duplicates always cause an error. Check: Duplicates cause an error only if the WarnDuplicateCheckNumber preference is enabled.Tips: Check the UseCustomTxnNumbers preference before setting DocNumber manually.Allow Duplicates: Use the include=allowduplicatedocnum query parameter to allow duplicate DocNumber (not recommended).Default Sort Order: Ascending order. |
(*) required field
Response Sample from Create Sale Receipt
{
"SalesReceipt": {
"DocNumber": "1074",
"SyncToken": "0",
"domain": "QBO",
"Balance": 0,
"DepositToAccountRef": {
"name": "Undeposited Funds",
"value": "4"
},
"TxnDate": "2015-07-29",
"TotalAmt": 35.0,
"PrintStatus": "NeedToPrint",
"EmailStatus": "NotSet",
"sparse": false,
"Line": [
{
"Description": "Pest Control Services",
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"TaxCodeRef": {
"value": "NON"
},
"Qty": 1,
"UnitPrice": 35,
"ItemRef": {
"name": "Pest Control",
"value": "10"
}
},
"LineNum": 1,
"Amount": 35.0,
"Id": "1"
},
{
"DetailType": "SubTotalLineDetail",
"Amount": 35.0,
"SubTotalLineDetail": {}
}
],
"ApplyTaxAfterDiscount": false,
"CustomField": [
{
"DefinitionId": "1",
"Type": "StringType",
"Name": "Crew #"
}
],
"Id": "263",
"TxnTaxDetail": {
"TotalTax": 0
},
"MetaData": {
"CreateTime": "2015-07-29T09:25:02-07:00",
"LastUpdatedTime": "2015-07-29T09:25:02-07:00"
}
},
"time": "2015-07-29T09:25:04.214-07:00"
}
Create Estimate Copy Link
▪️ An Estimate must have at least one line that describes an item.
▪️ An Estimate must have a reference to a customer.
▪️ If shipping address and billing address are not provided, the address from the referenced Customer object is used.
Tip: For Any Reference fields like Customer Reference, Account Reference or Vendor Reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Estimate API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Estimate creation. Additional fields: Shipping Address, Customer Reference, Apply Tax After Discount. | |
Customer Reference* | Reference to a customer or job. Customer ID*: The ID for the referenced customer. Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Bill Email* | Identifies the e-mail address where the estimate is sent. Address*: An email address. The address format must follow the RFC 822 standard. |
Line* | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type* Possible values : Sales Item Line Detail Group Line Detail Description Line Detail Discount Line Detail Subtotal Line Detail Amount*: The amount of the line item. Sale Item Line Detail*: _ Item Reference*: Reference to the Item. ___ Value*: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘.[+ Add Field] add more fields: _ Unit Price: Unit price of the subject item as referenced by ItemRef ._ Quantity: Number of items for the line. _ Tax Code Reference: Reference to the TaxCode for this item. [+ Add Field] add more fields: ___ Value: The ID for the referenced Tax Code. |
ADDITIONAL FIELDS | |
Customer Memo | Value*: User’s message to the customer; this message is visible to the end user on their transactions. Max 1000 chars. |
Shipping Address | This field indicates the shipping address for the goods. If no specific shipping address is provided, QuickBooks will automatically use the default shipping address associated with the referenced customer in the system. When entering international addresses, specify the country using either the 3-letter ISO code (e.g., USA, GBR) or the full country name. [+ Add Field] add more fields: City Line1 Postal Code Latitude longitude Country Sub Division Code |
Apply Tax After Discount apply to USA. | If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax. |
(*) required field
Response Sample from Create Estimate
{
"Estimate": {
"DocNumber": "1001",
"SyncToken": "0",
"domain": "QBO",
"TxnStatus": "Pending",
"BillEmail": {
"Address": "Cool_Cars@intuit.com"
},
"TxnDate": "2015-03-26",
"TotalAmt": 31.5,
"CustomerRef": {
"name": "Cool Cars",
"value": "3"
},
"CustomerMemo": {
"value": "Thank you for your business and have a great day!"
},
"ShipAddr": {
"CountrySubDivisionCode": "CA",
"City": "Half Moon Bay",
"PostalCode": "94213",
"Id": "104",
"Line1": "65 Ocean Dr."
},
"ProjectRef": {
"value": "39298034"
},
"PrintStatus": "NeedToPrint",
"BillAddr": {
"CountrySubDivisionCode": "CA",
"City": "Half Moon Bay",
"PostalCode": "94213",
"Id": "103",
"Line1": "65 Ocean Dr."
},
"sparse": false,
"EmailStatus": "NotSet",
"Line": [
{
"Description": "Pest Control Services",
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"TaxCodeRef": {
"value": "NON"
},
"Qty": 1,
"UnitPrice": 35,
"ItemRef": {
"name": "Pest Control",
"value": "10"
}
},
"LineNum": 1,
"Amount": 35.0,
"Id": "1"
},
{
"DetailType": "SubTotalLineDetail",
"Amount": 35.0,
"SubTotalLineDetail": {}
},
{
"DetailType": "DiscountLineDetail",
"Amount": 3.5,
"DiscountLineDetail": {
"DiscountAccountRef": {
"name": "Discounts given",
"value": "86"
},
"PercentBased": true,
"DiscountPercent": 10
}
}
],
"ApplyTaxAfterDiscount": false,
"CustomField": [
{
"DefinitionId": "1",
"Type": "StringType",
"Name": "Crew #"
}
],
"Id": "177",
"TxnTaxDetail": {
"TotalTax": 0
},
"MetaData": {
"CreateTime": "2015-03-26T13:25:05-07:00",
"LastUpdatedTime": "2015-03-26T13:25:05-07:00"
}
},
"time": "2015-03-26T13:25:05.473-07:00"
}
Create Deposit Copy Link
▪️ Customer payments previously held in the ‘Undeposited Funds’ account, now transferred to the designated Asset Account. This information is linked using the Deposit.line.LinkedTxn element.
▪️ New direct deposits, detailed within the Deposit.Line.DepositLineDetail section.
A deposit must include at least one deposit line, which can be either a direct deposit or a deposit linked to a previous transaction.
Multiple deposit lines of different types can be included in a single request.
For a direct deposit, each line must specify:
▪️ The target account (Deposit.Line.DepositLineDetail.AccountRef).
▪️ The overall deposit destination account (Deposit.DepositToAccountRef).
For a deposit linked to a previous transaction, each line must specify:
▪️ The linked transaction (Deposit.Line.LinkedTxn).
▪️ The overall deposit destination account (Deposit.DepositToAccountRef).
Tip: For Any Reference fields like Customer Reference, Account Reference or Vendor Reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Deposit API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Deposit creation. Additional fields: Deposit to Account Reference. | |
Line* | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type*: Possible values : Deposit Line detail. Amount*: The amount of the deposit. Deposit Line Detail*: _ Account Reference*: Account where the funds are deposited. ___ Value*: The ID for the referenced account. ___ Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
ADDITIONAL FIELDS | |
Deposit to Account Reference | Identifies the account to be used for this deposit. [+ Add Field] add more fields: Value: The ID for the referenced account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
(*) required field
Response Sample from Create Deposit
{
"Deposit": {
"SyncToken": "0",
"domain": "QBO",
"DepositToAccountRef": {
"name": "Checking",
"value": "35"
},
"TxnDate": "2014-12-22",
"TotalAmt": 20.0,
"sparse": false,
"Line": [
{
"DetailType": "DepositLineDetail",
"ProjectRef": {
"value": "42991284"
},
"LineNum": 1,
"Amount": 20.0,
"Id": "1",
"DepositLineDetail": {
"AccountRef": {
"name": "Unapplied Cash Payment Income",
"value": "87"
}
}
}
],
"Id": "149",
"MetaData": {
"CreateTime": "2014-12-22T14:46:36-08:00",
"LastUpdatedTime": "2014-12-22T14:46:36-08:00"
}
},
"time": "2014-12-22T14:46:36.084-08:00"
}
Create Credit Memo Copy Link
Tip: For Any Reference fields like Customer Reference, Account Reference or Vendor Reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Credit Memo API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Credit Memo creation. Additional fields: Customer Reference, Bill Email, Customer Memo, Bill Address, Shipping Address. | |
Line* | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type*: Possible values: Sales Item Line Detail Group Line Detail Description Line Detail Discount Line Detail Subtotal Line Detail Amount*: The amount of the credit memo. Sales Item Line Detail*: _ Item Reference*: Reference to the Item. ___ Value*: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Customer Reference* | Reference to a customer or job. Customer ID*: The ID for the referenced customer. Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
ADDITIONAL FIELDS | |
Bill Email | Identifies the e-mail address where the estimate is sent. [+ Add Field] add more fields: Address*: An email address. The address format must follow the RFC 822 standard.’ |
Customer Memo | [+ Add Field] add more fields: Value: User’s message to the customer; this message is visible to the end user on their transactions. Max 1000 chars. |
Bill Address | Bill-to address of the credit memo. If no specific bill address is provided, QuickBooks will automatically use the default billing address associated with the referenced customer in the system. When entering international addresses, specify the country using either the 3-letter ISO code (e.g., USA, GBR) or the full country name. [+ Add Field] add more fields: Line1 Line2 Line3 Line4 |
Shipping Address | This field indicates the shipping address for the goods. If no specific shipping address is provided, QuickBooks will automatically use the default shipping address associated with the referenced customer in the system. When entering international addresses, specify the country using either the 3-letter ISO code (e.g., USA, GBR) or the full country name. [+ Add Field] add more fields: Country Sub Division Code City Postal Code line1 |
(*) required field
Response Sample from Create Credit Memo
{
"CreditMemo": {
"DocNumber": "1039",
"SyncToken": "0",
"domain": "QBO",
"Balance": 50.0,
"BillAddr": {
"City": "Half Moon Bay",
"Line1": "65 Ocean Dr.",
"PostalCode": "94213",
"Lat": "37.4300318",
"Long": "-122.4336537",
"CountrySubDivisionCode": "CA",
"Id": "4"
},
"TxnDate": "2014-12-31",
"TotalAmt": 50.0,
"CustomerRef": {
"name": "Cool Cars",
"value": "3"
},
"ShipAddr": {
"City": "Half Moon Bay",
"Line1": "65 Ocean Dr.",
"PostalCode": "94213",
"Lat": "37.4300318",
"Long": "-122.4336537",
"CountrySubDivisionCode": "CA",
"Id": "4"
},
"RemainingCredit": 50.0,
"PrintStatus": "NeedToPrint",
"ProjectRef": {
"value": "39298034"
},
"EmailStatus": "NotSet",
"sparse": false,
"Line": [
{
"LineNum": 1,
"Amount": 50.0,
"SalesItemLineDetail": {
"TaxCodeRef": {
"value": "NON"
},
"ItemRef": {
"name": "Concrete",
"value": "3"
}
},
"Id": "1",
"DetailType": "SalesItemLineDetail"
},
{
"DetailType": "SubTotalLineDetail",
"Amount": 50.0,
"SubTotalLineDetail": {}
}
],
"ApplyTaxAfterDiscount": false,
"CustomField": [
{
"DefinitionId": "1",
"Type": "StringType",
"Name": "Crew #"
}
],
"Id": "150",
"TxnTaxDetail": {
"TotalTax": 0
},
"MetaData": {
"CreateTime": "2014-12-31T09:44:40-08:00",
"LastUpdatedTime": "2014-12-31T09:44:40-08:00"
}
},
"time": "2014-12-31T09:44:40.726-08:00"
}
Create Purchase Order Copy Link
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Purchase Order API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Purchase Order creation. Additional fields: AP Account Reference, Vendor Reference, DocNumber. | |
Line* | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type* Value: Item based Expense Line Detail, Account Based Expense Line Detail. Amount*: amount, price of the line. Item Based Expense Line Detail* _ Item Reference*: Reference to the Item. ___ Value*: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._ Customer Reference*: Reference to a customer or job. ___ Value*: The ID for the referenced customer. ___ Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._ Quantity*: Number of items. _ Item Reference*: Reference to the Item. ___ Value*: The ID for the referenced item. _ Billable Status: The billable status of the expense. This field is not updatable through an API request. The value automatically changes when an invoice is created. Possible values: Billable, Not Billable, Has Been Billed _ Unit Price: Unit price of the subject item as referenced by ItemRef. Corresponds to the Rate column on the QuickBooks Online UI to specify either unit price, a discount, or a tax rate for item. If used for unit price, the monetary value of the service or product, as expressed in the home currency. If used for a discount or tax rate, express the percentage as a fraction. For example, specify 0.4 for 40% tax. |
AP Account Reference* | This field indicates the Accounts Payable (AP) account used to record the bill. While many small businesses may only have one AP account, it’s crucial to always explicitly specify the account. This ensures accurate record-keeping, especially for businesses with multiple AP accounts. The specified account must be a Liability account specifically designated for Payables. Failing to explicitly specify the AP account can lead to unexpected errors when linking transactions within your accounting system. [+ Add Field] add more fields: Value: The ID for the referenced account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Vendor Reference* | Reference to the vendor for this transaction. [+ Add Field] add more fields: Value: The ID for the referenced vendor. Name: Name derived from the field that holds the common name of that vendor. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
ADDITIONAL FIELDS | |
DocNumber | This field stores the transaction’s reference number. You can specify a custom value during creation. If none is provided this field is populated based on the setting of Preferences: CustomTxnNumber .▪️ If UseCustomTxnNumbers preference is enabled: You can provide a custom DocNumber . Duplicates are not allowed.▪️ If no custom value is given, DocNumber is null.▪️ If UseCustomTxnNumbers is disabled: DocNumber is automatically generated by the system.Cash/CreditCard: Duplicates always cause an error. Check: Duplicates cause an error only if the WarnDuplicateCheckNumber preference is enabled.Tips: Check the UseCustomTxnNumbers preference before setting DocNumber manually.Allow Duplicates: Use the include=allowduplicatedocnum query parameter to allow duplicate DocNumber (not recommended).Default Sort Order: Ascending order. |
(*) required field
Response Sample from Create Purchase Order
{
"PurchaseOrder": {
"DocNumber": "1007",
"SyncToken": "0",
"domain": "QBO",
"VendorRef": {
"name": "Hicks Hardware",
"value": "41"
},
"TxnDate": "2015-07-28",
"TotalAmt": 25.0,
"APAccountRef": {
"name": "Accounts Payable (A/P)",
"value": "33"
},
"EmailStatus": "NotSet",
"sparse": false,
"Line": [
{
"DetailType": "ItemBasedExpenseLineDetail",
"Amount": 25.0,
"ProjectRef": {
"value": "39298034"
},
"Id": "1",
"ItemBasedExpenseLineDetail": {
"ItemRef": {
"name": "Pump",
"value": "11"
},
"CustomerRef": {
"name": "Cool Cars",
"value": "3"
},
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
},
"BillableStatus": "NotBillable",
"UnitPrice": 25
}
}
],
"CustomField": [
{
"DefinitionId": "1",
"Type": "StringType",
"Name": "Crew #"
},
{
"DefinitionId": "2",
"Type": "StringType",
"Name": "Sales Rep"
}
],
"Id": "259",
"MetaData": {
"CreateTime": "2015-07-28T16:06:03-07:00",
"LastUpdatedTime": "2015-07-28T16:06:03-07:00"
}
},
"time": "2015-07-28T16:06:04.864-07:00"
}
Create Customer Copy Link
Customer Relationships: Customer relationships can be complex. Some customers may have a hierarchical structure. For example:
▪️ A team is the main customer, and its individual members are sub-customers.
▪️ A property management company is the main customer, and the properties they manage are sub-customers.
Tracking Work: You can use the system to track specific tasks or projects associated with a customer. For instance:
▪️ A homeowner is the customer, and their kitchen remodel is the project with individual tasks.
▪️ A car owner is the customer, and their car repairs are the projects with individual tasks.
⚠️ The Display Name attribute or at least one of Title, Given Name, Middle Name, Family Name, or Suffix attributes is required during customer creation.
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Customer API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Customer creation. Additional fields: Primary Email Address, Suffix, Title, Middle Name, Notes, Primary Phone, Company Name, Bill Address, Given Name. | |
Family Name* | Family name or the last name of the person. |
Display Name* | The Display Name is how the person or organization is identified within the system. It must be unique within the system (across Customers, Vendors, and Employees). This field cannot be removed using sparse updates.If not provided, the system will create one for you by combining the customer’s name components (like title, first name, last name). |
ADDITIONAL FIELDS | |
Primary Email Address | Primary email address. [+ Add Field] add more fields. Address: An email address, the format must follow the RFC 822 standard. |
Suffix | Suffix of the name. For example, Jr. |
Title | Title of the person. This tag supports i18n (localized translations of titles such as “Mr.,” “Ms.,” “Dr.,” “Prof.,” or job-related titles like “CEO” and “Manager” in different languages and cultures). |
Middle Name | Middle name of the person. The person can have zero or more middle names. |
Notes Max 2000 chars. | Free form text describing the Customer. |
Primary Phone Max 30 chars. | Primary phone number. [+ Add Field] add more fields. Free for Number. |
Company Name | The name of the company associated with the person or organization. |
Bill Address | Default billing address. When a physical address is updated within a transaction object, the QuickBooks Online API organizes the address components differently in the transaction response compared to when it was initially created: The Line1 and Line2 fields are now filled with the customer name and company name. The original Line1 to Line5, along with City, SubDivisionCode (State/Province), and PostalCode, are shifted into Line3 through Line5 as free-form text. [+ Add Field] add more fields. Country Sub Division Code City Postal Code line1 Country |
Given Name | Given name or first name of a person. |
(*) required field
Response Sample from Create Customer
{ "Customer": { "domain": "QBO", "PrimaryEmailAddr": { "Address": "jdrew@myemail.com" }, "DisplayName": "King's Groceries", "CurrencyRef": { "name": "United States Dollar", "value": "USD" }, "DefaultTaxCodeRef": { "value": "2" }, "PreferredDeliveryMethod": "Print", "GivenName": "James", "FullyQualifiedName": "King's Groceries", "BillWithParent": false, "Title": "Mr", "Job": false, "BalanceWithJobs": 0, "PrimaryPhone": { "FreeFormNumber": "(555) 555-5555" }, "Taxable": true, "MetaData": { "CreateTime": "2015-07-23T10:58:12-07:00", "LastUpdatedTime": "2015-07-23T10:58:12-07:00" }, "BillAddr": { "City": "Mountain View", "Country": "USA", "Line1": "123 Main Street", "PostalCode": "94042", "CountrySubDivisionCode": "CA", "Id": "112" }, "MiddleName": "B", "Notes": "Here are other details.", "Active": true, "Balance": 0, "SyncToken": "0", "Suffix": "Jr", "CompanyName": "King Groceries", "FamilyName": "King", "PrintOnCheckName": "King Groceries", "sparse": false, "Id": "67" }, "time": "2015-07-23T10:58:12.099-07:00" }
Create Vendor Copy Link
⚠️ The Display Name attribute or at least one of Title, Given Name, Middle Name, Family Name, or Suffix attributes is required during customer creation.
See Quickbooks Vendor API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Vendor creation. Additional fields: Print on Check Name, Primary Email Address, Suffix, Title, Tax Identifier, Account Number, Primary Phone, Web Address, Mobile, Company Name, Bill Address, Given Name. | |
Family Name* | Family name or the last name of the person. |
Display Name | The Display Name is how the person or organization is identified within the system. It must be unique within the system (across Customers, Vendors, and Employees). This field cannot be removed using sparse updates.If not provided, the system will create one for you by combining the customer’s name components (like title, first name, last name). |
ADDITIONAL FIELDS | |
Print on Check Name | This field displays the name of the person or organization as it should appear on a printed check. If you don’t provide this name, it will be automatically filled in using the DisplayName . |
Primary Email Address | Primary email address. [+ Add Field] add more fields. Address: Email address, the format must follow the RFC 822 standard. |
Suffix | Suffix of the name. For example, Jr. |
Title | Title of the person. This tag supports i18n (localized translations of titles such as “Mr.,” “Ms.,” “Dr.,” “Prof.,” or job-related titles like “CEO” and “Manager” in different languages and cultures). |
Tax Identifier Max 20 chars. | The tax ID of the Person or Organization. The value is masked in responses, exposing only last four characters. For example, the ID of 123-45-6789 is returned as XXXXXXX6789. |
Account Number Max 100 chars. | Name or number of the account associated with this vendor. |
Primary Phone | Primary phone number. [+ Add Field] add more fields. Free for Number. Max 30 chars. |
Web Address Maximum 1000 chars. | [+ Add Field] add more fields. URI: Uniform Resource Identifier for the web site. |
Mobile Maximum of 30 chars. | Mobile phone number. [+ Add Field] add more fields. Free for Number: Specifies the telephone number in free form. |
Company Name | The name of the company associated with the person or organization. |
Bill Address | Default billing address. When a physical address is updated within a transaction object, the QuickBooks Online API organizes the address components differently in the transaction response compared to when it was initially created: The Line1 and Line2 fields are now filled with the customer name and company name. The original Line1 to Line5, along with City, SubDivisionCode (State/Province), and PostalCode, are shifted into Line3 through Line5 as free-form text. [+ Add Field] add more fields. Country Sub Division Code City Postal Code line1 Country |
Given Name | Given name or first name of a person. |
(*) required field
Response Sample from Create Vendor
{ "Vendor": { "domain": "QBO", "PrimaryEmailAddr": { "Address": "dbradley@myemail.com" }, "DisplayName": "Dianne's Auto Shop", "CurrencyRef": { "name": "United States Dollar", "value": "USD" }, "GivenName": "Dianne", "Title": "Ms.", "PrimaryPhone": { "FreeFormNumber": "(650) 555-2342" }, "Active": true, "MetaData": { "CreateTime": "2015-07-28T12:51:21-07:00", "LastUpdatedTime": "2015-07-28T12:51:21-07:00" }, "Vendor1099": false, "BillAddr": { "City": "Millbrae", "Country": "U.S.A", "Line3": "29834 Mustang Ave.", "Line2": "Dianne Bradley", "Line1": "Dianne's Auto Shop", "PostalCode": "94030", "CountrySubDivisionCode": "CA", "Id": "423" }, "Mobile": { "FreeFormNumber": "(650) 555-2000" }, "WebAddr": { "URI": "http://DiannesAutoShop.com" }, "Balance": 0, "SyncToken": "0", "Suffix": "Sr.", "CompanyName": "Dianne's Auto Shop", "FamilyName": "Bradley", "TaxIdentifier": "99-5688293", "AcctNum": "35372649", "PrintOnCheckName": "Dianne's Auto Shop", "sparse": false, "Id": "137" }, "time": "2015-07-28T12:51:21.326-07:00" }
Create Account Copy Link
▪️ Money coming in: Income and revenue.
▪️ Money going out: Expenses.
▪️ The value of your assets: Things your business owns like vehicles and equipment.
There are five main types of accounts: assets, liabilities, income, expenses, and equity.
All your business’s accounts are listed in your Chart of Accounts, which is a unique list created for your specific business. Accountants often refer to these accounts as “ledgers.”
The “account object” is the tool you’ll use within the QuickBooks system to manage and work with your accounts.
See Quickbooks Account API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Account creation. Additional fields: Currency reference, Meta Data, Current Balance, Active, Sub Account. | |
Name* Must be unique. max 100 characters. | Name for the Account. Account.Name attribute must not contain double quotes (“) or colon (:). |
Account Sub Type* | The account sub-type classification and is based on the AccountType value. Required if AccountType is not specified. See possible values in the Account type and Account Sub Type List below. |
Account Type* | A detailed account classification that specifies the use of this account. The type is based on the Classification. Required if AccountSubType is not specified. See possible values in the Account type and Account Sub Type List below. |
ADDITIONAL FIELDS | |
Currency reference | Reference to the currency in which this account holds amounts. [+ Add Field] add more fields: Value: A three letter string representing the ISO 4217 code for the currency. For example, USD, AUD, EUR. Name: The full name of the currency |
Meta Data | Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications. [+ Add Field] add more fields. Create Time: Time the entity was created in the source domain. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM Last Update Time: Time the entity was last updated in the source domain. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM |
Current Balance | Specifies the balance amount for the current Account. Valid for Balance Sheet accounts. |
Active | True – False Inactive accounts can be hidden from most views and may not be used for new transactions. |
(*) required field
Account Type and Account Sub Type List
ASSET ACCOUNTS
ACCOUNT TYPE | ACCOUNT SUB TYPE |
---|---|
Bank | Default CashOnHand (default), Checking, MoneyMarket, RentsHeldInTrust, Savings, TrustAccounts, CashAndCashEquivalents, OtherEarMarkedBankAccounts |
Other Current Asset | Default AllowanceForBadDebts, DevelopmentCosts, EmployeeCashAdvances (default), OtherCurrentAssets, Inventory, Investment_MortgageRealEstateLoans, Investment_Other, Investment_TaxExemptSecurities, Investment_USGovernmentObligations, LoansToOfficers, LoansToOthers, LoansToStockholders, PrepaidExpenses, Retainage, UndepositedFunds, AssetsAvailableForSale, BalWithGovtAuthorities, CalledUpShareCapitalNotPaid, ExpenditureAuthorisationsAndLettersOfCredit, GlobalTaxDeferred, GlobalTaxRefund, InternalTransfers, OtherConsumables, ProvisionsCurrentAssets, ShortTermInvestmentsInRelatedParties, ShortTermLoansAndAdvancesToRelatedParties, TradeAndOtherReceivables |
Fixed Asset | Default AccumulatedDepletion, AccumulatedDepreciation, DepletableAssets, FixedAssetComputers, FixedAssetCopiers, FixedAssetFurniture, FixedAssetPhone, FixedAssetPhotoVideo, FixedAssetSoftware, FixedAssetOtherToolsEquipment, FurnitureAndFixtures (default), Land, LeaseholdImprovements, OtherFixedAssets, AccumulatedAmortization, Buildings, IntangibleAssets, MachineryAndEquipment, Vehicles, AssetsInCourseOfConstruction, CapitalWip, CumulativeDepreciationOnIntangibleAssets, IntangibleAssetsUnderDevelopment, LandAsset, NonCurrentAssets, ParticipatingInterests, ProvisionsFixedAssets |
Other Asset | Default LeaseBuyout, OtherLongTermAssets, SecurityDeposits, AccumulatedAmortizationOfOtherAssets, Goodwill, Licenses (default), OrganizationalCosts, AssetsHeldForSale, AvailableForSaleFinancialAssets, DeferredTax, Investments, LongTermInvestments, LongTermLoansAndAdvancesToRelatedParties, OtherIntangibleAssets, OtherLongTermInvestments, OtherLongTermLoansAndAdvances, PrepaymentsAndAccruedIncome, ProvisionsNonCurrentAssets |
Accounts Receivable | Default Accounts Receivable |
EQUITY ACCOUNTS
ACCOUNT TYPE | ACCOUNT SUB TYPE |
---|---|
Equity | Default OpeningBalanceEquity (default), PartnersEquity, RetainedEarnings, AccumulatedAdjustment, OwnersEquity, PaidInCapitalOrSurplus, PartnerContributions, PartnerDistributions, PreferredStock, CommonStock, TreasuryStock, EstimatedTaxes, Healthcare, PersonalIncome, PersonalExpense, AccumulatedOtherComprehensiveIncome, CalledUpShareCapital, CapitalReserves, DividendDisbursed, EquityInEarningsOfSubsidiaries, InvestmentGrants, MoneyReceivedAgainstShareWarrants, OtherFreeReserves, ShareApplicationMoneyPendingAllotment, ShareCapital, Funds |
EXPENSE ACCOUNTS
ACCOUNT TYPE | ACCOUNT SUB TYPE |
---|---|
Expense | Default AdvertisingPromotional, BadDebts, BankCharges, CharitableContributions, CommissionsAndFees, Entertainment, EntertainmentMeals, EquipmentRental, FinanceCosts, GlobalTaxExpense, Insurance, InterestPaid, LegalProfessionalFees, OfficeExpenses, OfficeGeneralAdministrativeExpenses, OtherBusinessExpenses, OtherMiscellaneousServiceCost, PromotionalMeals, RentOrLeaseOfBuildings, RepairMaintenance, ShippingFreightDelivery, SuppliesMaterials, Travel (default), TravelMeals, Utilities, Auto, CostOfLabor, DuesSubscriptions, PayrollExpenses, TaxesPaid, UnappliedCashBillPaymentExpense, Utilities, AmortizationExpense, AppropriationsToDepreciation, BorrowingCost, CommissionsAndFees, DistributionCosts, ExternalServices, ExtraordinaryCharges, IncomeTaxExpense, LossOnDiscontinuedOperationsNetOfTax, ManagementCompensation, OtherCurrentOperatingCharges, OtherExternalServices, OtherRentalCosts, OtherSellingExpenses, ProjectStudiesSurveysAssessments, PurchasesRebates, ShippingAndDeliveryExpense, StaffCosts, Sundry, TravelExpensesGeneralAndAdminExpenses, TravelExpensesSellingExpense |
Other Expense | Default Depreciation (default), ExchangeGainOrLoss, OtherMiscellaneousExpense, PenaltiesSettlements, Amortization, GasAndFuel, HomeOffice, HomeOwnerRentalInsurance, OtherHomeOfficeExpenses, MortgageInterest, RentAndLease, RepairsAndMaintenance, ParkingAndTolls, Vehicle, VehicleInsurance, VehicleLease, VehicleLoanInterest, VehicleLoan, VehicleRegistration, VehicleRepairs, OtherVehicleExpenses, Utilities, WashAndRoadServices, DeferredTaxExpense, Depletion, ExceptionalItems, ExtraordinaryItems, IncomeTaxOtherExpense, MatCredit, PriorPeriodItems, TaxRoundoffGainOrLoss |
Cost of Goods Sold | Default EquipmentRentalCos, OtherCostsOfServiceCos, ShippingFreightDeliveryCos, SuppliesMaterialsCogs, CostOfLaborCos (default), CostOfSales, FreightAndDeliveryCost |
LIABILITY ACCOUNTS
ACCOUNT TYPE | ACCOUNT SUB TYPE |
---|---|
Accounts Payable | Default Accounts Payable, OutstandingDuesMicroSmallEnterprise, OutstandingDuesOtherThanMicroSmallEnterprise |
Credit Card | Default Credit Card |
Long Term Liability | Default NotesPayable (default), OtherLongTermLiabilities, ShareholderNotesPayable, AccrualsAndDeferredIncome, AccruedLongTermLiabilities, AccruedVacationPayable, BankLoans, DebtsRelatedToParticipatingInterests, DeferredTaxLiabilities, GovernmentAndOtherPublicAuthorities, GroupAndAssociates, LiabilitiesRelatedToAssetsHeldForSale, LongTermBorrowings, LongTermDebit, LongTermEmployeeBenefitObligations, ObligationsUnderFinanceLeases, OtherLongTermProvisions, ProvisionForLiabilities, ProvisionsNonCurrentLiabilities, StaffAndRelatedLongTermLiabilityAccounts |
Other Current Liability | Default DirectDepositPayable, LineOfCredit, LoanPayable, GlobalTaxPayable, GlobalTaxSuspense, OtherCurrentLiabilities (default), PayrollClearing, PayrollTaxPayable, PrepaidExpensesPayable, RentsInTrustLiability, TrustAccountsLiabilities, FederalIncomeTaxPayable, InsurancePayable, SalesTaxPayable, StateLocalIncomeTaxPayable, AccruedLiabilities, CurrentLiabilities, CurrentPortionEmployeeBenefitsObligations, CurrentPortionOfObligationsUnderFinanceLeases, CurrentTaxLiability, DividendsPayable, DutiesAndTaxes, InterestPayables, ProvisionForWarrantyObligations, ProvisionsCurrentLiabilities, ShortTermBorrowings, SocialSecurityAgencies, StaffAndRelatedLiabilityAccounts, SundryDebtorsAndCreditors, TradeAndOtherPayables |
REVENUE ACCOUNTS
ACCOUNT TYPE | ACCOUNT SUB TYPE |
---|---|
Income | Default NonProfitIncome, OtherPrimaryIncome (default), SalesOfProductIncome, ServiceFeeIncome, DiscountsRefundsGiven, UnappliedCashPaymentIncome, CashReceiptIncome, OperatingGrants, OtherCurrentOperatingIncome, OwnWorkCapitalized, RevenueGeneral, SalesRetail, SalesWholesale, SavingsByTaxScheme |
Other Income | Default DividendIncome, InterestEarned, OtherInvestmentIncome (default), OtherMiscellaneousIncome, TaxExemptInterest, GainLossOnSaleOfFixedAssets, GainLossOnSaleOfInvestments, LossOnDisposalOfAssets, OtherOperatingIncome, UnrealisedLossOnSecuritiesNetOfTax |
Response Sample from Create Account
{ "Account": { "FullyQualifiedName": "MyJobs", "domain": "QBO", "Name": "MyJobs", "Classification": "Asset", "AccountSubType": "AccountsReceivable", "CurrencyRef": { "name": "United States Dollar", "value": "USD" }, "CurrentBalanceWithSubAccounts": 0, "sparse": false, "MetaData": { "CreateTime": "2014-12-31T09:29:05-08:00", "LastUpdatedTime": "2014-12-31T09:29:05-08:00" }, "AccountType": "Accounts Receivable", "CurrentBalance": 0, "Active": true, "SyncToken": "0", "Id": "94", "SubAccount": false }, "time": "2014-12-31T09:29:05.717-08:00" }
Create Purchase Copy Link
To create a Purchase:
▪️ You must specify an Account Reference for all purchases.
▪️ The Total Amount attribute must add up to sum of Line.Amount attributes.
There are three types of purchases: Cash, Check, and Credit Card.
▪️ Cash Purchase contains information regarding a payment made in cash.
▪️ Check Purchase contains information regarding a payment made by check.
▪️ Credit Card Purchase contains information regarding a payment made by credit card or refunded/credited back to a credit card.
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Purchase API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Purchase creation. Additional fields: Account Reference, Currency Reference, Transaction Date, Print Status, Transaction Source, Global Tax Calculation, Transaction Location Type, Document Number, Private Note, Credit, Payment Method Reference, PurchaseEx, Exchange Rate, Department Reference, Entity Reference, Include In Annual TPAR. | |
Payment type* | Payment Type can be: Cash, Check, or Credit Card |
Line* | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type* Possible values: – Item based Expense Line Detail (This option is only available when the ‘For Purchase’ preference is activated for Products and Services). – Account Based Expense Line Detail. Amount*: The amount of the line item. The [+ Add Field] button allows to add fields corresponding to Detail Type. ID: Unique identifier (ID) of the line item. Update Operation: If a valid ID is provided, the request is treated as an update to an existing line item. Create Operation: If no ID is provided, or the provided ID is invalid, the request is treated as a creation of a new line item. This ID field is available in all objects that contain lines and support updates. Item Based Expense Line Detail: [+ Add Field] add more related fields. _Tax Inclusive Amount: represents the total amount of the purchase, including tax if applicable. Use TaxInclusiveAmount when the total purchase price includes tax, and QuickBooks should derive the pre-tax amount.Do NOT use it if tax should be calculated separately based on the taxable subtotal. _ Item Reference*: Reference to the Item. [+ Add Field] add more fields. ___ Value*: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._ Customer Reference*: Reference to a customer or job. [+ Add Field] add more fields. ___ Value*: The ID for the referenced customer. ___ Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._Price Level Reference: Reference to the PriceLevel of the service or item for the line. [+ Add Field] add more fields. ___ Value*: The ID for the referenced Price Level. ___ Name: Name derived from the field that holds the common name of that price level. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._Class Reference: Reference to the Class associated with the expense. [+ Add Field] add more fields. ___ Value*: The ID for the referenced Class. ___ Name: Name derived from the field that holds the common name of that class. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._Tax Code Reference: Reference to the TaxCode for this item. [+ Add Field] add more fields in Tax Code Reference: ___ Value: The ID for the referenced Tax Code. ___ Name: Name derived from the field that holds the common name of that Tax Code. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._Markup Info: Markup information for the expense. [+ Add Field] add more fields. ___ Price Level Reference: Reference to a PriceLevel for the markup. ______ Value*: The ID for the referenced Price Level. ______ Name: Name derived from the field that holds the common name of that price level. ___ Percent:Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01. _Quantity*: Number of items. _Unit Price: Unit price of the subject item as referenced by ItemRef. Corresponds to the Rate column on the QuickBooks Online UI to specify either unit price, a discount, or a tax rate for item. If used for unit price, the monetary value of the service or product, as expressed in the home currency. If used for a discount or tax rate, express the percentage as a fraction. For example, specify 0.4 for 40% tax. Linked Transaction: Zero or more transactions linked to this Purchase. [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Linked Transaction can be added as elements. Element 1: Represents the first Linked Transaction. _Transaction ID*: Transaction Id of the related transaction. _Transaction Type*: Bill, BillPaymentCheck, BillPaymentCreditCard, CreditCardCredit, ReimburseCharge, VendorCredit, Expense, Check, Payment _Transaction Line ID: This field is required for Deposit and Bill entities. It specifies the line number within the linked transaction. If you include this field, you must also provide the TxnId and TxnType of the linked transaction.Description: Free form text description of the line item that appears in the printed record. Max 4000 chars. Line Number: Specifies the position of the line in the collection of transaction lines. Account Based Expense Line Detail: [+ Add Field] add more fields. _Account Reference*: This field indicates the account used for this purchase, depending on the payment method (e.g., bank account for checks, credit card account for credit card payments). [+ Add Field] add more fields in account Reference: ___ Value*: The ID for the referenced account ___ Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._Tax Amount: Sales tax paid as part of the expense. _Tax Inclusive Amount: The total amount of the line item including tax. _Class Reference: This field specifies the class associated with the expense. Class tracking must be enabled at the line item level in your accounting preferences for this field to be available. [+ Add Field] add more fields. ___ Value*: The ID for the referenced Class. ___ Name: Name derived from the field that holds the common name of that class. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._Tax Code Reference: Reference to the TaxCode for this expense. [+ Add Field] add more fields in Tax Code Reference: ___ Value*: The ID for the referenced Tax Code. ___ Name: Name derived from the field that holds the common name of that Tax Code. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._Markup Info: Markup information for the expense. [+ Add Field] add more fields. ___ Price Level Reference: Reference to a PriceLevel for the markup. ______ Value*: The ID for the referenced Price Level. ______ Name: Name derived from the field that holds the common name of that price level. ___ Percent:Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01. _Customer Reference: Reference to the Customer associated with the expense. [+ Add Field] add more fields. ___ Value*: The ID for the referenced customer. ___ Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Account Reference* | This field specifies the associated account. For checks, it must be a bank account. For credit cards, it must be a credit card account. The account reference must be valid and currently active. [+ Add Field] add more fields. Value*: The ID for the referenced account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
ADDITIONAL FIELDS | |
Currency reference | Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multi-currency is enabled for the company. Read more about multi-currency support here. Value*: A three letter string representing the ISO 4217 code for the currency. For example, USD, AUD, EUR. Name: The full name of the currency. |
Transaction Date | The date entered by the user when this transaction occurred. yyyy/MM/dd is the valid date format. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. |
Print Status | Applicable only for Check. Ignored for Credit Card charge or refund. Possible values: Not Set, Need To Print, Print Complete. |
Transaction Source | Used internally to specify originating source of a credit card transaction. |
Global Tax Calculation | Method in which tax is applied. Allowed values are: Tax Excluded, Tax Inclusive, and Not Applicable. |
Transaction Location Type For France locales, only. | The account location. Valid values include: Within France France Overseas Outside France With EU Outside EU |
Document Number Maximum of 21 chars. | This field stores the transaction’s reference number. You can specify a custom value during creation. If none is provided this field is populated based on the setting of Preferences: CustomTxnNumber .▪️ If UseCustomTxnNumbers preference is enabled: You can provide a custom DocNumber . Duplicates are not allowed.▪️ If no custom value is given, DocNumber is null.▪️ If UseCustomTxnNumbers is disabled: DocNumber is automatically generated by the system.Cash/CreditCard: Duplicates always cause an error. Check: Duplicates cause an error only if the WarnDuplicateCheckNumber preference is enabled.Tips: Check the UseCustomTxnNumbers preference before setting DocNumber manually.Allow Duplicates: Use the include=allowduplicatedocnum query parameter to allow duplicate DocNumber (not recommended).Default Sort Order: Ascending order. |
Private Note Max of 4000 chars. | User-entered, organization-private note about the transaction. This field maps to the Memo field on the Expense form in the QuickBooks UI. |
Credit | False—it represents a charge. True—it represents a refund. Valid only for Credit Card payment type and Credit Card transactions. |
Payment Method Reference | Reference to a Payment Method associated with this transaction. [+ Add Field] add more fields. Value*: The ID for the referenced payment method. Name: Name derived from the field that holds the common name of that payment method. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
PurchaseEx | For internal use. Extension field that allows custom data storage. It is often used for third-party integrations that need to track extra metadata. |
Exchange Rate | This field represents the exchange rate, which is the number of your company’s home currency units needed to equal one unit of a different currency. This field is only applicable if your company uses multiple currencies. |
Department Reference | This field links the transaction to a specific department within your company. This feature is only available if the ‘Track Departments’ preference is enabled in your accounting settings. [+ Add Field] add more fields. Value*: The ID for the referenced department. Name: Name derived from the field that holds the common name of that department. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Entity Reference | This field links an expense transaction to a specific entity. Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate Customer, Vendor or Employee object for this reference. [+ Add Field] add more fields. Reference Type*: Specifies the type of entity (Customer, Vendor, Employee). Value*: The ID for the referenced entity. Name: Name derived from the field that holds the common name of that entity. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Include In Annual TPAR | True – False Include the supplier in the annual TPAR. TPAR stands for Taxable Payments Annual Report. The TPAR is mandated by ATO to get the details payments that businesses make to contractors for providing services. Some government entities also need to report the grants they have paid in a TPAR. |
(*) required field
Response Sample from Create Purchase
{
"Purchase": {
"SyncToken": "0",
"domain": "QBO",
"PurchaseEx": {
"any": [
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"nil": false,
"value": {
"Name": "TxnType",
"Value": "54"
},
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"globalScope": true,
"typeSubstituted": false
}
]
},
"Credit": false,
"TotalAmt": 10.0,
"PaymentType": "CreditCard",
"TxnDate": "2015-07-27",
"sparse": false,
"Line": [
{
"DetailType": "AccountBasedExpenseLineDetail",
"Amount": 10.0,
"ProjectRef": {
"value": "42991284"
},
"Id": "1",
"AccountBasedExpenseLineDetail": {
"TaxCodeRef": {
"value": "NON"
},
"AccountRef": {
"name": "Meals and Entertainment",
"value": "13"
},
"BillableStatus": "NotBillable"
}
}
],
"AccountRef": {
"name": "Visa",
"value": "42"
},
"CustomField": [],
"Id": "247",
"MetaData": {
"CreateTime": "2015-07-27T10:27:01-07:00",
"LastUpdatedTime": "2015-07-27T10:27:01-07:00"
}
},
"time": "2015-07-27T10:27:01.593-07:00"
}
Create Time Activity Copy Link
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Time Activity API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Time Activity creation. Additional fields: Transaction Date, Description, Item Reference, Minutes, Hours, Billable Status, Hourly Rate, Taxable, Customer Reference, Meta Data. | |
Name of* | This field specifies the type of time activity being recorded. It’s required when creating a new record and must be used in conjunction with either the EmployeeRef or VendorRef attributes. Possible values: Vendor or Employee. |
Employee Reference | Specifies the employee whose time is being recorded. Value: The ID for the referenced employee. Name: Name derived from the field that holds the common name of that employee. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Vendor Reference | Specifies the vendor whose time is being recorded. Value: The ID for the referenced vendor. Name: Name derived from the field that holds the common name of that vendor. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Start Time* | This field indicates the start time of the work. It’s required if the specific hours and minutes are not provided. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM Important: Only include the hours (e.g., 9, 10, 11) without the time zone offset, as it doesn’t affect the time activity hours calculation. If is provided: Use the specified Transaction Date (in YYYY-MM-DD format) and include Start Time and End Time in hours and minutes (without time zone offsets).If Transaction Date is not provided: Use the current server date and include StartTime and EndTime in hours and minutes (with or without time zone offsets).For historical or future transactions, always include the Transaction Date in YYYY-MM-DD format and specify StartTime and End Time in hours and minutes. |
End Time* | This field indicates the end time of the work. It’s required if the specific hours and minutes are not provided. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM Important: Only include the hours (e.g., 5, 6, 7) without the time zone offset, as it doesn’t affect the time activity hours calculation. If is provided: Use the specified TxnDate (in YYYY-MM-DD format) and include StartTime and EndTime in hours and minutes (without time zone offsets).If is not provided: Use the current server date and include StartTime and EndTime in hours and minutes (with or without time zone offsets).For historical or future transactions, always include the in YYYY-MM-DD format and specify StartTime and EndTime in hours and minutes. |
ADDITIONAL FIELDS | |
Transaction Date | The date for the time activity. This field represents the date used for financial reporting. If no date is provided, the current system date is used. The default sort order for transactions is ascending by date. If you specify the start and end times without time zone offsets, you must also provide the transaction date ( TxnDate ) for any past or future time activities. For example, to record a past time activity, include the TxnDate and specify the start and end times in hours (without time zone offsets).Local timezone: YYYY-MM-DD UTC: YYYY-MM-DDZ Specific time zone: YYYY-MM-DD+/-HH:MM The date format follows the XML Schema standard. |
Description maximum 4000 characters. | Description of work completed during time activity. |
Item Reference | Reference to the service item associated with this object. [+ Add Field] add more fields in Item reference: ___ Item ID: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘.me |
Minutes Maximum of 8760 hours 59 minutes; if hours is 8760 minutes must be 0 | minutes worked. |
Hours Maximum of 8760 hours 59 minutes; if hours is 8760 minutes must be 0 | Hours and minutes worked. Required if StartTime and EndTime not specified |
Hourly Rate max character: 0 to 99999999999 hours. | Hourly bill rate of the employee or vendor for this time activity. Required if Billable Status is set to Billable. |
Taxable | True – False True if the time recorded is both billable and taxable. |
Customer Reference | Reference to a customer or job. [+ Add Field] add more fields. Value: The ID for the referenced customer. Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Meta Data | Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications. [+ Add Field] add more fields. Create Time: Time the entity was created in the source domain. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM Last Update Time: Time the entity was last updated in the source domain. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM |
(*) required field
Response Sample from Create Time Activity
{
"TimeActivity": {
"TxnDate": "2015-07-28",
"domain": "QBO",
"NameOf": "Employee",
"sparse": false,
"ItemRef": {
"name": "Hours",
"value": "2"
},
"ProjectRef": {
"value": "39298034"
},
"BillableStatus": "NotBillable",
"StartTime": "2015-07-28T09:00:00-07:00",
"HourlyRate": 0,
"Taxable": false,
"EmployeeRef": {
"name": "Emily Platt",
"value": "55"
},
"EndTime": "2015-07-28T18:00:00-07:00",
"CustomerRef": {
"name": "Cool Cars",
"value": "3"
},
"Id": "6",
"SyncToken": "0",
"MetaData": {
"CreateTime": "2015-07-28T10:26:25-07:00",
"LastUpdatedTime": "2015-07-28T10:26:25-07:00"
}
},
"time": "2015-07-28T10:26:26.952-07:00"
}
Create Refund Receipt Copy Link
▪️ At least one line item: This details the item(s) being refunded.
▪️ A designated deposit account: Specified by Deposit To Account Ref.
If no billing address is provided, The customer’s address will be used as the billing address.
Tax Code Restrictions:
▪️ Custom Sales Tax cannot be used for Transaction Tax Code Ref.
▪️ This tax code is reserved for transactions using the older sales tax model.
▪️ You cannot create or update transactions that use TaxCode.CustomSalesTax.
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Refund Receipt API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Refund Receipt creation. Additional fields: Document Number, Balance, Payment Method Reference, Bill Address, Transaction Date, Customer Reference, Customer Memo, Shipping Address, Print Status, Bill Email, Line, Apply Tax After Discount, Custom Field, Transaction Tax Detail, Meta Data. | |
Deposit to Account Reference* | Accounts receivable asset account from which payment money is refunded. _Reference Type*: [+ Add Field] add more fields. ___ Value*: The ID for the referenced account. ___ Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._Currency Reference Type: This field specifies the currency used for all amounts in the transaction. (Required if your company uses multiple currencies (i.e., if Preferences.MultiCurrencyEnabled is set to ‘true’).For more information, please refer to Manage multiple currencies. ___ Value: A three letter string representing the ISO 4217 code for the currency. For example, USD, AUD, EUR. ___ Name: The full name of the currency. |
Line* The minimum line item required for the request is one of the following: Sales Item Line and Group Line. | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type*: Possible choices for each line: Sales Item Line Detail Group Line Detail Sale Item Line Detail*: _ Item Reference*: Reference to the Item. ___ Value*: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘.[+ Add Field] add more fields: _ Unit Price: Unit price of the subject item as referenced by ItemRef ._ Quantity: Number of items for the line. _ Tax Code Reference: Reference to the TaxCode for this item. [+ Add Field] add more fields: ___ Value: The ID for the referenced Tax Code. Amount*: The amount of the line item. Description: Free form text description of the line item that appears in the printed record (max character: 4000). Line Number: Specifies the position of the line in the collection of transaction lines. ID: Unique identifier (ID) of the line item. Update Operation: If a valid ID is provided, the request is treated as an update to an existing line item. Create Operation: If no ID is provided, or the provided ID is invalid, the request is treated as a creation of a new line item. This ID field is available in all objects that contain lines and support updates. |
ADDITIONAL FIELDS | |
Document Number Maximum of 21 chars. | This field stores the transaction’s reference number. You can specify a custom value during creation. If none is provided this field is populated based on the setting of Preferences: CustomTxnNumber .▪️ If UseCustomTxnNumbers preference is enabled: You can provide a custom DocNumber . Duplicates are not allowed.▪️ If no custom value is given, DocNumber is null.▪️ If UseCustomTxnNumbers is disabled: DocNumber is automatically generated by the system.Cash/CreditCard: Duplicates always cause an error. Check: Duplicates cause an error only if the WarnDuplicateCheckNumber preference is enabled.Tips: Check the UseCustomTxnNumbers preference before setting DocNumber manually.Allow Duplicates: Use the include=allowduplicatedocnum query parameter to allow duplicate DocNumber (not recommended).Default Sort Order: Ascending order. |
Payment Method Reference | Reference to a Payment Method associated with this transaction. [+ Add Field] add more fields. Value*: The ID for the referenced payment method. Name: Name derived from the field that holds the common name of that payment method. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Bill Address | This field specifies the billing address for the invoice. If no billing address is provided: QuickBooks will use the default billing address associated with the customer. For international addresses: Use the 3-letter ISO country code or the full country name. Address Updates: If you update the physical address within the transaction itself, the address components will be presented differently in the API response compared to the original creation: Line 1 and Line 2: Will display the customer name and company name. Line 3 to Line 5: Will contain the original address information (Line 1-5, City, State/Province, Postal Code) as free-form text. [+ Add Field] add more fields. Line1 Line2 Postal Code Latitude longitude |
Transaction Date | The date entered by the user when this transaction occurred. yyyy/MM/dd is the valid date format. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. |
Customer Reference | Reference to a customer or job. Value: The ID for the referenced customer. Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Customer Memo | Value: User’s message to the customer; this message is visible to the end user on their transactions. |
Shipping Address | This field indicates the shipping address for the goods. If no specific shipping address is provided, QuickBooks will automatically use the default shipping address associated with the referenced customer in the system. When entering international addresses, specify the country using either the 3-letter ISO code (e.g., USA, GBR) or the full country name. If you update the physical address within the transaction itself, the address components will be presented differently in the API response compared to the original creation: Line 1 and Line 2: Will display the customer name and company name. Line 3 to Line 5: Will contain the original address information (Line 1-5, City, State/Province, Postal Code) as free-form text. [+ Add Field] add more fields: City Line1 Postal Code Latitude longitude Country Sub Division Code |
Print Status | Applicable only for Check. Ignored for Credit Card charge or refund. Possible values: Not Set, Need To Print, Print Complete. |
Bill Email | Identifies the e-mail address where the estimate is sent. [+ Add Field] add more fields Email*: The address format must follow the RFC 822 standard. |
Apply Tax After Discount Apply to USA. | True – False If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax. |
Custom field | This allows you to add up to three custom fields to your transactions. These fields are available only if they have been configured for your company in the settings: ▪️ Check “Preferences.SalesFormsPrefs.CustomField” for sales transactions. ▪️ Check “Preferences.VendorAndPurchasesPrefs.POCustomField” for purchase orders. Click here for information on managing custom fields. [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional custom field can be added as elements. Element 1: Represents the first custom field. Value Name Field Type |
Transaction Tax Detail | This data type contains information about the taxes applied to the entire transaction. It includes details of sales taxes calculated based on the tax codes specified within the transaction. ▪️ QuickBooks can calculate these taxes automatically. ▪️ You can also provide the tax details when adding a transaction. Global Tax Model: Refer to the Global Tax Model documentation for more information. Sales Tax Disabled: If sales tax is disabled in your company’s preferences ( Preferences.TaxPrefs.UsingSalesTax is false), this data will be ignored and not stored.[+ Add Field] add more fields. Total Tax: Total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list. |
Meta Data | Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications. [+ Add Field] add more fields. Create Time: Time the entity was created in the source domain. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM Last Update Time: Time the entity was last updated in the source domain. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM |
(*) required field
Response Sample from Create Refund Receipt
{
"RefundReceipt": {
"DocNumber": "1072",
"SyncToken": "0",
"domain": "QBO",
"Balance": 0,
"DepositToAccountRef": {
"name": "Checking",
"value": "35"
},
"TxnDate": "2015-07-29",
"TotalAmt": 420.0,
"PrintStatus": "NeedToPrint",
"PaymentRefNum": "To Print",
"sparse": false,
"Line": [
{
"LineNum": 1,
"Amount": 420.0,
"SalesItemLineDetail": {
"TaxCodeRef": {
"value": "NON"
},
"ItemRef": {
"name": "Garden Supplies",
"value": "38"
}
},
"Id": "1",
"DetailType": "SalesItemLineDetail"
},
{
"DetailType": "SubTotalLineDetail",
"Amount": 420.0,
"SubTotalLineDetail": {}
}
],
"ApplyTaxAfterDiscount": false,
"CustomField": [
{
"DefinitionId": "1",
"Type": "StringType",
"Name": "Crew #"
}
],
"Id": "261",
"TxnTaxDetail": {
"TotalTax": 0
},
"MetaData": {
"CreateTime": "2015-07-29T08:07:43-07:00",
"LastUpdatedTime": "2015-07-29T08:07:43-07:00"
}
},
"time": "2015-07-29T08:07:43.749-07:00"
}
UPDATE RECORDS Copy Link
Tip: Use Wiresk Method “List” or Trigger “Get Records by Search String” to get the IDs.
This Method allows you to update:
Invoice, Item, Payment, Journal Entry, Bill, Sale Receipt, Estimate, Deposit, Credit Memo, Purchase Order, Customer, Vendor, Account, Purchase, Time Activity, Refund Receipt.
Configuration Table:
Input Options:
- Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
- Default Value: You can specify a fixed attribute.
Name* | Update Record |
Connection* | Select your connection or create one. |
Entity* (Set of data that contain records) | Select the available Entity to update the records: Invoice, Item, Payment, Journal Entry, Bill, Sale Receipt, Estimate, Deposit, Credit Memo, Purchase Order, Customer, Vendor, Account, Purchase, Time Activity, Refund Receipt. |
(*) required field
Configuration table for each Entity:
Update Invoice Copy Link
Tip: Use Wiresk Method “List” or Trigger “Get Records by Search String” to get the IDs.
See Quickbooks Invoice API reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the invoice update. Additional fields: Sales Term Reference, Transaction Date, Customer Memo, Transaction Tax Detail, Deposit, Line, DocNumber. | |
ID* | Unique identifier of the Invoice. |
Customer Reference* | A customer is a consumer of the service or product that your business offers. Reference to a customer or job. Customer ID*: The ID for the referenced customer. Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Line* Invoice line object. If the transaction is taxable there is a limit of 750 lines per transaction. | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Invoice Line. Detail Type*: Possible choices for each line: Sales Item Line Detail Group Line Detail Amount*: The amount of the line item. The [+ Add Field] button allows to add fields corresponding to the Detail Type. Description: Free form text description of the line item that appears in the printed record. Max character: 4000. Line Number: Specifies the position of the line in the collection of transaction lines. Sale Item Line Detail [+ Add Field] add more fields in Sale Item Line Detail: _ Quantity: Number of items for the line. _ Unit Price: Unit price of the subject item as referenced by ItemRef. _ Discount Amount: Fixed discount. _ Discount Rate: The discount rate applied to this line. If both Discount are provided, Discount Rate takes precedence and Discount Amount is recalculated by QuickBooks services based on amount of Discount Rate. _ Item Reference: Reference to an Item object. [+ Add Field] add more fields in Item reference: ___ Item ID: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._ Tax Code Reference: Reference to the Tax Code for this item. [+ Add Field] add more fields in Tax Code Reference: ___ Value: The ID for the referenced Tax Code. ___ Name: Name derived from the field that holds the common name of that Tax Code. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
ADDITIONAL FIELDS | |
Sales Term Reference | Reference to the sales term associated with the transaction. Value: The ID for the referenced Sales Term. |
Transaction Date | The date entered by the user when this transaction occurred. yyyy/MM/dd is the valid date format. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. |
Customer Memo Max 1000 chars.. | Value: User’s message to the customer; this message is visible to the end user on their transactions. |
Transaction Tax Detail | This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. Transaction Tax Code Reference: _ Value: Reference to the transaction tax code. See Global tax model for more information about this element. |
Deposit | The deposit made towards this invoice. |
DocNumber | This field stores the transaction’s reference number. You can specify a custom value during creation. If none is provided this field is populated based on the setting of Preferences: CustomTxnNumber .▪️ If UseCustomTxnNumbers preference is enabled: You can provide a custom DocNumber . Duplicates are not allowed.▪️ If no custom value is given, DocNumber is null.▪️ If UseCustomTxnNumbers is disabled: DocNumber is automatically generated by the system.Cash/CreditCard: Duplicates always cause an error. Check: Duplicates cause an error only if the WarnDuplicateCheckNumber preference is enabled.Tips: Check the UseCustomTxnNumbers preference before setting DocNumber manually.Allow Duplicates: Use the include=allowduplicatedocnum query parameter to allow duplicate DocNumber (not recommended).Default Sort Order: Ascending order. |
(*) required field
Response sample from Update Invoice
Update “DueDate”
“DueDate”: “2015-09-30”
{ "Invoice": { "TxnDate": "2015-07-24", "domain": "QBO", "PrintStatus": "NeedToPrint", "TotalAmt": 100.0, "Line": [ { "LineNum": 1, "Amount": 100.0, "SalesItemLineDetail": { "TaxCodeRef": { "value": "NON" }, "ItemRef": { "name": "Services", "value": "1" } }, "Id": "1", "DetailType": "SalesItemLineDetail" }, { "DetailType": "SubTotalLineDetail", "Amount": 100.0, "SubTotalLineDetail": {} } ], "DueDate": "2015-09-30", "ApplyTaxAfterDiscount": false, "DocNumber": "1069", "sparse": true, "ProjectRef": { "value": "39298045" }, "Deposit": 0, "Balance": 100.0, "CustomerRef": { "name": "Amy's Bird Sanctuary", "value": "1" }, "TxnTaxDetail": { "TotalTax": 0 }, "SyncToken": "1", "LinkedTxn": [], "ShipAddr": { "City": "Bayshore", "Line1": "4581 Finch St.", "PostalCode": "94326", "Lat": "INVALID", "Long": "INVALID", "CountrySubDivisionCode": "CA", "Id": "109" }, "EmailStatus": "NotSet", "BillAddr": { "City": "Bayshore", "Line1": "4581 Finch St.", "PostalCode": "94326", "Lat": "INVALID", "Long": "INVALID", "CountrySubDivisionCode": "CA", "Id": "2" }, "MetaData": { "CreateTime": "2015-07-24T10:33:39-07:00", "LastUpdatedTime": "2015-07-24T11:03:26-07:00" }, "CustomField": [ { "DefinitionId": "1", "Type": "StringType", "Name": "Crew #" } ], "Id": "238" }, "time": "2015-07-24T11:03:26.674-07:00" }
Update Item Copy Link
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Item API Reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Item update. Additional fields: Active, SKU, Unit Price, TrackQtyOnHand, QtyOnHand, AssetAccountRef, InvStartDate, ExpenseAccountRef. | |
ID* | Unique identifier of the Item. |
Name* Maximum of 100 chars | Name of the item. This value must be unique, at least one character in length, and cannot include tabs, new lines, or colons. Required for create. |
IncomeAccountRef* | Reference to the posting account, that is, the account that records the proceeds from the sale of this item. Must be an account with account type of Sales of Product Income .Account ID*: The ID for the referenced Income Account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Type* | Classification that specifies the use of this item:Inventory - Service - Non inventory See the description at the top of the Item entity page for details about supported item types. |
ADDITIONAL FIELDS | |
Active | True – False Inactivating an item is achieved by setting the Active attribute to false. |
SKU | The stock keeping unit (SKU) for this Item. This is a company-defined identifier for an item or product used in tracking inventory. maximum of 100 chars. minorVersion: 4 |
Unit Price | Price of the item. |
TrackQtyOnHand | True - False |
QtyOnHand | Current quantity of the Inventory items available for sale.Not used for Service or NonInventory type items.Required for Inventory type items. |
AssetAccountRef | Reference to the Inventory Asset account that tracks the current value of the inventory. If the same account is used for all inventory items, the current balance of this account will represent the current total value of the inventory. Must be an account with account type of Other Current Asset . Use Account.Id and Account.Name from that object for AssetAccountRef.value and AssetAccountRef.name , respectively. Required for Inventory item types.Account ID*: The ID for the referenced asset account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
InvStartDate | Date of opening balance for the inventory transaction. Required when creating an Item.Type =Inventory. Required for Inventory item types.Local timezone: YYYY-MM-DD UTC: YYYY-MM-DDZ Specific time zone: YYYY-MM-DD+/-HH:MM The date format follows the XML Schema standard. |
ExpenseAccountRef | Reference to the expense account used to pay the vendor for this item. Must be an account with account type of Cost of Goods Sold .Account ID*: The ID for the referenced expense account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
(*) required field
Response sample from Update Item
{
"Item": {
"FullyQualifiedName": "Rock Fountain",
"domain": "QBO",
"Id": "5",
"Name": "Rock Fountain",
"TrackQtyOnHand": true,
"Type": "Inventory",
"PurchaseCost": 125,
"QtyOnHand": 2,
"IncomeAccountRef": {
"name": "Sales of Product Income",
"value": "79"
},
"AssetAccountRef": {
"name": "Inventory Asset",
"value": "81"
},
"Taxable": true,
"MetaData": {
"CreateTime": "2014-09-16T10:42:19-07:00",
"LastUpdatedTime": "2015-04-22T11:10:18-07:00"
},
"sparse": false,
"Active": true,
"SyncToken": "3",
"InvStartDate": "2014-09-19",
"UnitPrice": 275,
"ExpenseAccountRef": {
"name": "Cost of Goods Sold",
"value": "80"
},
"PurchaseDesc": "Rock Fountain",
"Description": "New, updated description for Rock Fountain"
},
"time": "2015-04-22T11:08:31.596-07:00"
}
Update Payment Copy Link
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Payment API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Payment update. Additional fields: Currency Reference, Project Reference, Line, Private Note, Deposit to Account Reference, Exchange Rate, Transaction source, Transaction Date, Transaction Location Type, Meta Data, Payment Reference Number. | |
ID* | Unique identifier of the Item. |
Total amount* | Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. If you process a linked refund transaction against a specific transaction, the totalAmt value won’t change. It will remain the same. However, voiding the linked refund will change the totalAmt value to 0. |
Customer reference* | Reference to a customer or job. Customer ID*: The ID for the referenced customer. Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Payment Method Reference* | Reference to a Payment Method associated with this transaction. [+ Add Field] add more fields. Value*: The ID for the referenced payment method. Name: Name derived from the field that holds the common name of that payment method. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
ADDITIONAL FIELDS | |
Currency Reference | Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multi-currency is enabled for the company. Read more about multi-currency support here. Currency ID: A three letter string representing the ISO 4217 code for the currency. For example, USD, AUD, EUR. Name: The full name of the currency. |
Project reference | Reference to the Project ID associated with this transaction. Project ID: The ID for the referenced Project. Name: Name derived from the field that holds the common name of that project. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Line Zero or more transactions accounting for this payment. | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Payment Line can be added as elements. Element 1: Represents the first Payment Line. Amount*: The amount of the line item. Linked Transaction*: Transaction to which the current entity is related. For example, a billpayment line links to the originating bill object for which the billpayment is applied._ Transaction ID*: Transaction id of the related transaction. _ Transaction Type*: Possible values: Expense Check Credit Card Credit Journal Entry Credit Memo Invoice |
Private Note Max of 4000 chars. | User-entered, organization-private note about the transaction. This field maps to the Memo field on the Expense form in the QuickBooks UI. |
Deposit to Account Reference | Identifies the account to be used for this payment. [+ Add Field] add more fields. Value*: The ID for the referenced account. Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Exchange Rate | This field represents the exchange rate, which is the number of your company’s home currency units needed to equal one unit of a different currency. This field is only applicable if your company uses multiple currencies. |
Transaction source | Used internally to specify originating source of a credit card transaction. |
Transaction Date | The date entered by the user when this transaction occurred. yyyy/MM/dd is the valid date format. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. |
Transaction Location Type For France Only. | The account location. Valid values include: Within France France Overseas Outside France With EU Outside EU |
Meta Data | Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications. [+ Add Field] add more fields. Create Time: Time the entity was created in the source domain. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM Last Update Time: Time the entity was last updated in the source domain. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM |
Payment Reference Number For France Only. | Provide the reference number for the payment received. For example, use the Check number for checks and the envelope number for cash donations. This field is a mandatory requirement for transactions in France. |
(*) required field
Response sample from Update Payment
{ "Payment": { "SyncToken": "1", "domain": "QBO", "PaymentMethodRef": { "value": "16" }, "UnappliedAmt": 0, "TxnDate": "2013-03-13", "TotalAmt": 0, "ProjectRef": { "value": "39298045" }, "PaymentRefNum": "123456", "sparse": false, "Line": [ { "Amount": 300, "LinkedTxn": [ { "TxnId": "67", "TxnType": "Invoice" } ] }, { "Amount": 300, "LinkedTxn": [ { "TxnId": "68", "TxnType": "CreditMemo" } ] } ], "CustomerRef": { "value": "16" }, "Id": "69", "MetaData": { "CreateTime": "2013-03-13T14:49:21-07:00", "LastUpdatedTime": "2013-03-13T14:49:21-07:00" } }, "time": "2013-03-13T14:49:41.512-07:00" }
Update Journal Entry Copy Link
Tip: For Any Reference fields like Customer Reference, Account Reference or Vendor Reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Journal Entry API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Journal Entry creation. Additional fields: DocNumber. | |
ID* | Unique identifier of the Journal Entry. |
Line* Individual line items of a transaction. There must be at least one pair of Journal Entry Line elements, representing a debit and a credit, called distribution lines. Set Line Detail Type to Journal Entry Line for both lines. | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Journal Entry Line can be added as elements. Element 1: Represents the first Journal Entry Line. Detail Type*: Set to Journal Entry Line Detail .Amount*: The amount of the line item. Journal Entry Line Detail*: _ Posting Type*: Indicates whether this Journal Entry line is a Debit or Credit. _ Account Reference*: Reference to the account associated with this line. ___ Value*: The ID for the referenced account. ___ Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘.⚠️ If this account has same location as specified in the transaction by the TransactionLocationType attribute and the same VAT as in the line item TaxCodeRef attribute, then this account is used.⚠️ If there is a mismatch, then the account from the account category list that matches the transaction location and VAT is used. ⚠️ If this account is not present in the account category list, then a new account is created with the new location, new VAT code, and all other attributes as in the default account. Description: Free form text description of the line item that appears in the printed record. Max 4000 chars. |
ADDITIONAL FIELDS | |
DocNumber | This field stores the transaction’s reference number. You can specify a custom value during creation. If none is provided this field is populated based on the setting of Preferences: CustomTxnNumber .▪️ If UseCustomTxnNumbers preference is enabled: You can provide a custom DocNumber . Duplicates are not allowed.▪️ If no custom value is given, DocNumber is null.▪️ If UseCustomTxnNumbers is disabled: DocNumber is automatically generated by the system.Cash/CreditCard: Duplicates always cause an error. Check: Duplicates cause an error only if the WarnDuplicateCheckNumber preference is enabled.Tips: Check the UseCustomTxnNumbers preference before setting DocNumber manually.Allow Duplicates: Use the include=allowduplicatedocnum query parameter to allow duplicate DocNumber (not recommended).Default Sort Order: Ascending order. |
(*) required field
Response sample from Update Journal Entry
{ "time": "2015-06-29T12:54:38.135-07:00", "JournalEntry": { "DocNumber": "1112", "SyncToken": "1", "domain": "QBO", "TxnDate": "2015-11-30", "PrivateNote": "Revised private note via sparse update", "sparse": true, "Line": [ { "JournalEntryLineDetail": { "PostingType": "Debit", "AccountRef": { "name": "Job Expenses:Job Materials:Fountain and Garden Lighting", "value": "65" } }, "DetailType": "JournalEntryLineDetail", "Amount": 25.54, "Id": "0", "Description": "Four sprinkler heads damaged" }, { "JournalEntryLineDetail": { "PostingType": "Credit", "AccountRef": { "name": "Notes Payable", "value": "44" } }, "DetailType": "JournalEntryLineDetail", "Amount": 25.54, "Id": "1", "Description": "Sprinkler Hds - Sprinkler Hds Inventory Adjustment" } ], "Adjustment": false, "Id": "227", "TxnTaxDetail": {}, "MetaData": { "CreateTime": "2015-06-29T12:33:57-07:00", "LastUpdatedTime": "2015-06-29T12:54:38-07:00" } } }
Update Bill Copy Link
Only certain transaction types can be linked to a bill. The most commonly supported transaction types include:
▪️ BillPaymentCheck – A payment made by check to pay the bill.
▪️ BillPaymentCreditCard – A payment made by credit card to pay the bill.
▪️ CreditMemo – A credit memo applied to the bill.
▪️ JournalEntry – A journal entry affecting the bill.
Transactions like Invoice and Deposit are not typically linked to a bill because a bill represents an expense or liability, while invoices are accounts receivable (money owed to you, not by you). Deposits usually relate to received funds, not expenses.
Tip: For Any Reference fields like Customer Reference, Account Reference or Vendor Reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Bill API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Bill update. Additional fields: Currency Reference, Ap Account Reference, Sales Term Reference, Linked Transaction, DocNumber. | |
ID* | Unique identifier of the Journal Entry. |
Vendors Reference* | Reference to the vendor for this transaction. [+ Add Field] add more fields: Value: The ID for the referenced vendor. Name: Name derived from the field that holds the common name of that vendor. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Line* | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type*: Possible choices for each line: Account Based Expense Line Detail – Item based Expense Line Detail Amount*: The amount of the line item. The [+ Add Field] button allows to add fields corresponding to Detail Type. Description: Free form text description of the line item that appears in the printed record. Max 4000 chars. Account Based Expense Line Detail: _ Account Reference: Reference to the Expense account associated with this item. ___ Account ID: The ID for the referenced account. ___ Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘.⚠️ If this account has same location as specified in the transaction by the TransactionLocationType attribute and the same VAT as in the line item TaxCodeRef attribute, then this account is used.⚠️ If there is a mismatch, then the account from the account category list that matches the transaction location and VAT is used. ⚠️ If this account is not present in the account category list, then a new account is created with the new location, new VAT code, and all other attributes as in the default account. Item based Expense Line Detail: _ Quantity: Number of items for the line. _ Unit Price: Unit price of the subject item. _ Item Reference: : Reference to the Item. ___ Value: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._ Customer Reference: Reference to a customer or job. ___ Value: The ID for the referenced customer. ___ Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
ADDITIONAL FIELDS | |
Currency Reference | Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multi-currency is enabled for the company. Read more about multi-currency support here. [+ Add Field] add more fields: Value: A three letter string representing the ISO 4217 code for the currency. For example, USD, AUD, EUR. Name: The full name of the currency. |
Ap Account Reference | Specifies to which AP account the bill is credited. [+ Add Field] add more fields: Value: The ID for the referenced account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘.⚠️ The specified account must have Account.Classification set to Liability and Account.AccountSubType set to AccountsPayable . If the company has a single AP account, the account is implied. However, it is recommended that the AP Account be explicitly specified in all cases to prevent unexpected errors when relating transactions to each other. |
Sales Term Reference | Reference to the Term associated with the transaction. [+ Add Field] add more fields: Value: The ID for the referenced sales term. Name: Name derived from the field that holds the common name of that sales term. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Linked Transaction | Zero or more transactions linked to this Bill object. [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Linked Transaction can be added as elements. Element 1: Represents the first Linked Transaction. Transaction ID: Unique identifier of the related transaction. Transaction Type: Possible values: BillPaymentCheck – A payment made by check to pay the bill.BillPaymentCreditCard – A payment made by credit card to pay the bill.CreditMemo – A credit memo applied to the bill.JournalEntry – A journal entry affecting the bill. |
DocNumber | This field stores the transaction’s reference number. You can specify a custom value during creation. If none is provided this field is populated based on the setting of Preferences: CustomTxnNumber .▪️ If UseCustomTxnNumbers preference is enabled: You can provide a custom DocNumber . Duplicates are not allowed.▪️ If no custom value is given, DocNumber is null.▪️ If UseCustomTxnNumbers is disabled: DocNumber is automatically generated by the system.Cash/CreditCard: Duplicates always cause an error. Check: Duplicates cause an error only if the WarnDuplicateCheckNumber preference is enabled.Tips: Check the UseCustomTxnNumbers preference before setting DocNumber manually.Allow Duplicates: Use the include=allowduplicatedocnum query parameter to allow duplicate DocNumber (not recommended).Default Sort Order: Ascending order. |
(*) required field
Response Sample from update Bill
{
"Bill": {
"DocNumber": "56789",
"SyncToken": "2",
"domain": "QBO",
"APAccountRef": {
"name": "Accounts Payable",
"value": "49"
},
"VendorRef": {
"name": "Bayshore CalOil Service",
"value": "81"
},
"TxnDate": "2014-04-04",
"TotalAmt": 200.0,
"CurrencyRef": {
"name": "United States Dollar",
"value": "USD"
},
"PrivateNote": "This is a updated memo.",
"SalesTermRef": {
"value": "12"
},
"DepartmentRef": {
"name": "Garden Services",
"value": "1"
},
"DueDate": "2013-06-09",
"sparse": false,
"Line": [
{
"Description": "Gasoline",
"DetailType": "AccountBasedExpenseLineDetail",
"ProjectRef": {
"value": "39298034"
},
"Amount": 200.0,
"Id": "1",
"AccountBasedExpenseLineDetail": {
"TaxCodeRef": {
"value": "TAX"
},
"AccountRef": {
"name": "Automobile",
"value": "75"
},
"BillableStatus": "Billable",
"CustomerRef": {
"name": "Blackwell, Edward",
"value": "20"
},
"MarkupInfo": {
"Percent": 10
}
}
}
],
"Balance": 200.0,
"Id": "890",
"MetaData": {
"CreateTime": "2014-04-04T12:38:01-07:00",
"LastUpdatedTime": "2014-04-04T12:58:16-07:00"
}
},
"time": "2014-04-04T12:58:16.491-07:00"
}
Update Sale Receipt Copy Link
▪️ A SalesReceipt object must have at least one line that describes an item and an amount.
Tip: For Any Reference fields like Customer Reference, Account Reference or Vendor Reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Sales Receipt API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Sale Receipt update. Additional fields: DocNumber. | |
ID* | Unique identifier of the Sale receipt. |
Line* The minimum line item required for the request is Sales Item Line or Group Line. | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type* Possible values for each line: Sales Item Line Detail Group Line Detail Description Line Detail Discount Line Detail Subtotal Line Detail Amount*: The amount of the line item. Sale Item Line Detail*: _ Item Reference*: : Reference to the Item. ___ Value*: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._ Unit Price: Unit price of the subject item as referenced by ItemRef ._ Quantity: Number of items for the line. _ Tax Code Reference: Reference to the TaxCode for this item. [+ Add Field] add more fields: ___ Value: The ID for the referenced Tax Code. [+ Add Field] add more fields: Description: Free form text description of the line item that appears in the printed record. Max 4000 chars. |
ADDITIONAL FIELDS | |
DocNumber | This field stores the transaction’s reference number. You can specify a custom value during creation. If none is provided this field is populated based on the setting of Preferences: CustomTxnNumber .▪️ If UseCustomTxnNumbers preference is enabled: You can provide a custom DocNumber . Duplicates are not allowed.▪️ If no custom value is given, DocNumber is null.▪️ If UseCustomTxnNumbers is disabled: DocNumber is automatically generated by the system.Cash/CreditCard: Duplicates always cause an error. Check: Duplicates cause an error only if the WarnDuplicateCheckNumber preference is enabled.Tips: Check the UseCustomTxnNumbers preference before setting DocNumber manually.Allow Duplicates: Use the include=allowduplicatedocnum query parameter to allow duplicate DocNumber (not recommended).Default Sort Order: Ascending order. |
(*) required field
Response Sample from Update Sale Receipt
{
"SalesReceipt": {
"DocNumber": "1003",
"SyncToken": "2",
"domain": "QBO",
"Balance": 0,
"DepositToAccountRef": {
"name": "Undeposited Funds",
"value": "4"
},
"TxnDate": "2015-07-29",
"TotalAmt": 337.5,
"CustomerMemo": {
"value": "A sparsely updated customer memo."
},
"PrintStatus": "NeedToPrint",
"EmailStatus": "NotSet",
"sparse": true,
"Line": [
{
"Description": "Custom Design",
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"TaxCodeRef": {
"value": "NON"
},
"Qty": 4.5,
"UnitPrice": 75,
"ItemRef": {
"name": "Design",
"value": "4"
}
},
"LineNum": 1,
"Amount": 337.5,
"Id": "1"
},
{
"DetailType": "SubTotalLineDetail",
"Amount": 337.5,
"SubTotalLineDetail": {}
}
],
"ApplyTaxAfterDiscount": false,
"CustomField": [
{
"DefinitionId": "1",
"Type": "StringType",
"Name": "Crew #"
}
],
"Id": "11",
"TxnTaxDetail": {
"TotalTax": 0
},
"MetaData": {
"CreateTime": "2014-09-16T14:59:48-07:00",
"LastUpdatedTime": "2015-07-29T09:45:55-07:00"
}
},
"time": "2015-07-29T09:45:39.381-07:00"
}
Update Estimate Copy Link
▪️ An Estimate must have at least one line that describes an item.
▪️ An Estimate must have a reference to a customer.
▪️ If shipping address and billing address are not provided, the address from the referenced Customer object is used.
Tip: For Any Reference fields like Customer Reference, Account Reference or Vendor Reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Estimate API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Estimate update. Additional fields: Shipping Address, Customer Reference, Apply Tax After Discount. | |
ID* | Unique identifier of the Estimate. |
Customer Reference* | Reference to a customer or job. Customer ID*: The ID for the referenced customer. Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Bill Email* | Identifies the e-mail address where the estimate is sent. Address*: An email address. The address format must follow the RFC 822 standard. |
Line* | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type* Possible values : Sales Item Line Detail Group Line Detail Description Line Detail Discount Line Detail Subtotal Line Detail Amount*: The amount of the line item. Sale Item Line Detail*: _ Item Reference*: Reference to the Item. ___ Value*: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘.[+ Add Field] add more fields: _ Unit Price: Unit price of the subject item as referenced by ItemRef ._ Quantity: Number of items for the line. _ Tax Code Reference: Reference to the TaxCode for this item. [+ Add Field] add more fields: ___ Value: The ID for the referenced Tax Code. |
ADDITIONAL FIELDS | |
Customer Memo | Value*: User’s message to the customer; this message is visible to the end user on their transactions. Max 1000 chars. |
Shipping Address | This field indicates the shipping address for the goods. If no specific shipping address is provided, QuickBooks will automatically use the default shipping address associated with the referenced customer in the system. When entering international addresses, specify the country using either the 3-letter ISO code (e.g., USA, GBR) or the full country name. [+ Add Field] add more fields: City Line1 Postal Code Latitude longitude Country Sub Division Code |
Apply Tax After Discount apply to USA. | True – False If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax. |
(*) required field
Response Sample from Update Estimate
{
"Estimate": {
"TxnDate": "2014-09-07",
"domain": "QBO",
"PrintStatus": "NeedToPrint",
"TxnStatus": "Closed",
"TotalAmt": 582.5,
"Line": [
{
"Description": "Rock Fountain",
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"TaxCodeRef": {
"value": "NON"
},
"Qty": 1,
"UnitPrice": 275,
"ItemRef": {
"name": "Rock Fountain",
"value": "5"
}
},
"LineNum": 1,
"Amount": 275.0,
"Id": "1"
},
{
"Description": "Custom Design",
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"TaxCodeRef": {
"value": "NON"
},
"Qty": 3.5,
"UnitPrice": 75,
"ItemRef": {
"name": "Design",
"value": "4"
}
},
"LineNum": 2,
"Amount": 262.5,
"Id": "2"
},
{
"Description": "Fountain Pump",
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"TaxCodeRef": {
"value": "NON"
},
"Qty": 2,
"UnitPrice": 22.5,
"ItemRef": {
"name": "Pump",
"value": "11"
}
},
"LineNum": 3,
"Amount": 45.0,
"Id": "3"
},
{
"DetailType": "SubTotalLineDetail",
"Amount": 582.5,
"SubTotalLineDetail": {}
}
],
"ApplyTaxAfterDiscount": false,
"DocNumber": "1001",
"sparse": true,
"CustomerMemo": {
"value": "An updated memo via full update the second time."
},
"ProjectRef": {
"value": "39298033"
},
"CustomerRef": {
"name": "Geeta Kalapatapu",
"value": "10"
},
"TxnTaxDetail": {
"TotalTax": 0
},
"SyncToken": "4",
"LinkedTxn": [
{
"TxnId": "103",
"TxnType": "Invoice"
}
],
"CustomField": [
{
"DefinitionId": "1",
"Type": "StringType",
"Name": "Crew #"
}
],
"ShipAddr": {
"CountrySubDivisionCode": "CA",
"City": "Middlefield",
"PostalCode": "94303",
"Id": "119",
"Line1": "1987 Main St."
},
"EmailStatus": "NotSet",
"BillAddr": {
"Line3": "Middlefield, CA 94303",
"Id": "59",
"Line1": "Geeta Kalapatapu",
"Line2": "1987 Main St."
},
"MetaData": {
"CreateTime": "2014-09-17T11:20:06-07:00",
"LastUpdatedTime": "2015-07-24T14:17:23-07:00"
},
"BillEmail": {
"Address": "Geeta@Kalapatapu.com"
},
"Id": "41"
},
"time": "2015-07-24T14:17:23.307-07:00"
}
Update Deposit Copy Link
A deposit must include at least one deposit line, which can be either a direct deposit or a deposit linked to a previous transaction.
Multiple deposit lines of different types can be included in a single request.
For a direct deposit, each line must specify:
▪️ The target account (Deposit.Line.DepositLineDetail.AccountRef).
▪️ The overall deposit destination account (Deposit.DepositToAccountRef).
For a deposit linked to a previous transaction, each line must specify:
▪️ The linked transaction (Deposit.Line.LinkedTxn).
▪️ The overall deposit destination account (Deposit.DepositToAccountRef).
Tip: For Any Reference fields like Customer Reference, Account Reference or Vendor Reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Deposit API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Deposit update. Additional fields: Deposit to Account Reference. | |
ID* | Unique identifier of the Deposit. |
Line* | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type*: Possible values : Deposit Line detail. Amount*: The amount of the deposit. Deposit Line Detail*: _ Account Reference*: Account where the funds are deposited. ___ Value*: The ID for the referenced account. ___ Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
ADDITIONAL FIELDS | |
Deposit to Account Reference | Identifies the account to be used for this deposit. [+ Add Field] add more fields: Value: The ID for the referenced account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
(*) required field
Response Sample from Update Deposit
{
"Deposit": {
"SyncToken": "1",
"domain": "QBO",
"DepositToAccountRef": {
"name": "Checking",
"value": "35"
},
"TxnDate": "2014-12-02",
"TotalAmt": 20.0,
"sparse": true,
"Line": [
{
"LineNum": 1,
"Amount": 20.0,
"Id": "1",
"DepositLineDetail": {
"AccountRef": {
"name": "Unapplied Cash Payment Income",
"value": "87"
}
},
"DetailType": "DepositLineDetail"
}
],
"Id": "146",
"MetaData": {
"CreateTime": "2014-12-10T15:24:40-08:00",
"LastUpdatedTime": "2014-12-22T15:13:18-08:00"
}
},
"time": "2014-12-22T15:13:17.913-08:00"
}
Update Credit Memo Copy Link
Tip: For Any Reference fields like Customer Reference, Account Reference or Vendor Reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Credit Memo API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Credit Memo update. Additional fields: Customer Reference, Bill Email, Customer Memo, Bill Address, Shipping Address. | |
ID* | Unique identifier of the Deposit. |
Line* | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type*: Possible values: Sales Item Line Detail Group Line Detail Description Line Detail Discount Line Detail Subtotal Line Detail Amount*: The amount of the credit memo. Sales Item Line Detail*: _ Item Reference*: Reference to the Item. ___ Value*: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Customer Reference* | Reference to a customer or job. Customer ID*: The ID for the referenced customer. Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
ADDITIONAL FIELDS | |
Bill Email | Identifies the e-mail address where the estimate is sent. [+ Add Field] add more fields: Address*: An email address. The address format must follow the RFC 822 standard.’ |
Customer Memo | [+ Add Field] add more fields: Value: User’s message to the customer; this message is visible to the end user on their transactions. Max 1000 chars. |
Bill Address | Bill-to address of the credit memo. If no specific bill address is provided, QuickBooks will automatically use the default billing address associated with the referenced customer in the system. When entering international addresses, specify the country using either the 3-letter ISO code (e.g., USA, GBR) or the full country name. [+ Add Field] add more fields: Line1 Line2 Line3 Line4 |
Shipping Address | This field indicates the shipping address for the goods. If no specific shipping address is provided, QuickBooks will automatically use the default shipping address associated with the referenced customer in the system. When entering international addresses, specify the country using either the 3-letter ISO code (e.g., USA, GBR) or the full country name. [+ Add Field] add more fields: Country Sub Division Code City Postal Code line1 |
(*) required field
Response Sample from Update Credit Memo
{ "CreditMemo": { "TxnDate": "2014-09-02", "domain": "QBO", "PrintStatus": "NeedToPrint", "TotalAmt": 100.0, "RemainingCredit": 0, "Line": [ { "Description": "Pest Control Services", "DetailType": "SalesItemLineDetail", "SalesItemLineDetail": { "TaxCodeRef": { "value": "NON" }, "Qty": 1, "UnitPrice": 100, "ItemRef": { "name": "Pest Control", "value": "10" } }, "LineNum": 1, "Amount": 100.0, "Id": "1" }, { "DetailType": "SubTotalLineDetail", "Amount": 100.0, "SubTotalLineDetail": {} } ], "ApplyTaxAfterDiscount": false, "DocNumber": "1026", "sparse": false, "CustomerMemo": { "value": "Another memo update." }, "ProjectRef": { "value": "39298045" }, "Balance": 0, "CustomerRef": { "name": "Amy's Bird Sanctuary", "value": "1" }, "TxnTaxDetail": { "TotalTax": 0 }, "SyncToken": "5", "CustomField": [ { "DefinitionId": "1", "Type": "StringType", "Name": "Crew #" } ], "ShipAddr": { "CountrySubDivisionCode": "CA", "City": "Bayshore", "PostalCode": "94326", "Id": "108", "Line1": "4581 Finch St." }, "EmailStatus": "NotSet", "BillAddr": { "Line4": "Bayshore, CA 94326", "Line3": "4581 Finch St.", "Id": "79", "Line1": "Amy Lauterbach", "Line2": "Amy's Bird Sanctuary" }, "MetaData": { "CreateTime": "2014-09-18T12:51:27-07:00", "LastUpdatedTime": "2015-07-23T09:23:52-07:00" }, "BillEmail": { "Address": "Birds@Intuit.com" }, "Id": "73" }, "time": "2015-07-23T09:23:52.115-07:00" }
Update Purchase Order Copy Link
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Purchase Order API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Purchase Order update. Additional fields: AP Account Reference, Vendor Reference, DocNumber. | |
ID* | Unique identifier of the Purchase Order. |
Line* | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type* Value: Item based Expense Line Detail, Account Based Expense Line Detail. Amount*: amount, price of the line. Item Based Expense Line Detail* _ Item Reference*: Reference to the Item. ___ Value*: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._ Customer Reference*: Reference to a customer or job. ___ Value*: The ID for the referenced customer. ___ Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._ Quantity*: Number of items. _ Item Reference*: Reference to the Item. ___ Value*: The ID for the referenced item. _ Billable Status: The billable status of the expense. This field is not updatable through an API request. The value automatically changes when an invoice is created. Possible values: Billable, Not Billable, Has Been Billed _ Unit Price: Unit price of the subject item as referenced by ItemRef. Corresponds to the Rate column on the QuickBooks Online UI to specify either unit price, a discount, or a tax rate for item. If used for unit price, the monetary value of the service or product, as expressed in the home currency. If used for a discount or tax rate, express the percentage as a fraction. For example, specify 0.4 for 40% tax. |
AP Account Reference* | This field indicates the Accounts Payable (AP) account used to record the bill. While many small businesses may only have one AP account, it’s crucial to always explicitly specify the account. This ensures accurate record-keeping, especially for businesses with multiple AP accounts. The specified account must be a Liability account specifically designated for Payables. Failing to explicitly specify the AP account can lead to unexpected errors when linking transactions within your accounting system. [+ Add Field] add more fields: Value: The ID for the referenced account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Vendor Reference* | Reference to the vendor for this transaction. [+ Add Field] add more fields: Value: The ID for the referenced vendor. Name: Name derived from the field that holds the common name of that vendor. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
ADDITIONAL FIELDS | |
DocNumber | This field stores the transaction’s reference number. You can specify a custom value during creation. If none is provided this field is populated based on the setting of Preferences: CustomTxnNumber .▪️ If UseCustomTxnNumbers preference is enabled: You can provide a custom DocNumber . Duplicates are not allowed.▪️ If no custom value is given, DocNumber is null.▪️ If UseCustomTxnNumbers is disabled: DocNumber is automatically generated by the system.Cash/CreditCard: Duplicates always cause an error. Check: Duplicates cause an error only if the WarnDuplicateCheckNumber preference is enabled.Tips: Check the UseCustomTxnNumbers preference before setting DocNumber manually.Allow Duplicates: Use the include=allowduplicatedocnum query parameter to allow duplicate DocNumber (not recommended).Default Sort Order: Ascending order. |
(*) required field
Response Sample from Update Purchase Order
{ "PurchaseOrder": { "DocNumber": "1005", "SyncToken": "1", "domain": "QBO", "APAccountRef": { "name": "Accounts Payable (A/P)", "value": "33" }, "CurrencyRef": { "name": "United States Dollar", "value": "USD" }, "TxnDate": "2015-07-28", "TotalAmt": 25.0, "ShipAddr": { "Line4": "Half Moon Bay, CA 94213", "Line3": "65 Ocean Dr.", "Id": "121", "Line1": "Grace Pariente", "Line2": "Cool Cars" }, "PrivateNote": "This is a private note added during update.", "VendorAddr": { "Line4": "Middlefield, CA 94303", "Line3": "42 Main St.", "Id": "120", "Line1": "Geoff Hicks", "Line2": "Hicks Hardware" }, "POStatus": "Open", "sparse": false, "VendorRef": { "name": "Hicks Hardware", "value": "41" }, "Line": [ { "DetailType": "ItemBasedExpenseLineDetail", "Amount": 25.0, "ProjectRef": { "value": "39298034" }, "Id": "1", "ItemBasedExpenseLineDetail": { "ItemRef": { "name": "Garden Supplies", "value": "38" }, "CustomerRef": { "name": "Cool Cars", "value": "3" }, "Qty": 1, "TaxCodeRef": { "value": "NON" }, "BillableStatus": "NotBillable", "UnitPrice": 25 } } ], "CustomField": [ { "DefinitionId": "1", "Type": "StringType", "Name": "Crew #" }, { "DefinitionId": "2", "Type": "StringType", "Name": "Sales Rep" } ], "Id": "257", "MetaData": { "CreateTime": "2015-07-28T16:01:47-07:00", "LastUpdatedTime": "2015-07-28T16:17:41-07:00" } }, "time": "2015-07-28T16:17:42.952-07:00" }
Update Customer Copy Link
Customer Relationships: Customer relationships can be complex. Some customers may have a hierarchical structure. For example:
▪️ A team is the main customer, and its individual members are sub-customers.
▪️ A property management company is the main customer, and the properties they manage are sub-customers.
Tracking Work: You can use the system to track specific tasks or projects associated with a customer. For instance:
▪️ A homeowner is the customer, and their kitchen remodel is the project with individual tasks.
▪️ A car owner is the customer, and their car repairs are the projects with individual tasks.
⚠️ The Display Name attribute or at least one of Title, Given Name, Middle Name, Family Name, or Suffix attributes is required during customer creation.
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Customer API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Customer update. Additional fields: Primary Email Address, Suffix, Title, Middle Name, Notes, Primary Phone, Company Name, Bill Address, Given Name. | |
ID* | Unique Identifier of the Customer. |
Family Name* | Family name or the last name of the person. |
Display Name* | The Display Name is how the person or organization is identified within the system. It must be unique within the system (across Customers, Vendors, and Employees). This field cannot be removed using sparse updates.If not provided, the system will create one for you by combining the customer’s name components (like title, first name, last name). |
ADDITIONAL FIELDS | |
Primary Email Address | Primary email address. [+ Add Field] add more fields. Address: An email address, the format must follow the RFC 822 standard. |
Suffix | Suffix of the name. For example, Jr. |
Title | Title of the person. This tag supports i18n (localized translations of titles such as “Mr.,” “Ms.,” “Dr.,” “Prof.,” or job-related titles like “CEO” and “Manager” in different languages and cultures). |
Middle Name | Middle name of the person. The person can have zero or more middle names. |
Notes Max 2000 chars. | Free form text describing the Customer. |
Primary Phone Max 30 chars. | Primary phone number. [+ Add Field] add more fields. Free for Number. |
Company Name | The name of the company associated with the person or organization. |
Bill Address | Default billing address. When a physical address is updated within a transaction object, the QuickBooks Online API organizes the address components differently in the transaction response compared to when it was initially created: The Line1 and Line2 fields are now filled with the customer name and company name. The original Line1 to Line5, along with City, SubDivisionCode (State/Province), and PostalCode, are shifted into Line3 through Line5 as free-form text. [+ Add Field] add more fields. Country Sub Division Code City Postal Code line1 Country |
Given Name | Given name or first name of a person. |
(*) required field
Response Sample from Update Customer
{
"Customer": {
"domain": "QBO",
"PrimaryEmailAddr": {
"Address": "Surf@Intuit.com"
},
"DisplayName": "Bill's Windsurf Shop",
"PreferredDeliveryMethod": "Print",
"GivenName": "Bill",
"FullyQualifiedName": "Bill's Windsurf Shop",
"BillWithParent": false,
"Job": false,
"BalanceWithJobs": 85.0,
"PrimaryPhone": {
"FreeFormNumber": "(415) 444-6538"
},
"Active": true,
"MetaData": {
"CreateTime": "2014-09-11T16:49:28-07:00",
"LastUpdatedTime": "2015-07-23T11:07:55-07:00"
},
"BillAddr": {
"City": "Half Moon Bay",
"Line1": "12 Ocean Dr.",
"PostalCode": "94213",
"Lat": "37.4307072",
"Long": "-122.4295234",
"CountrySubDivisionCode": "CA",
"Id": "3"
},
"MiddleName": "Mark",
"Taxable": false,
"Balance": 85.0,
"SyncToken": "1",
"CompanyName": "Bill's Windsurf Shop",
"FamilyName": "Lucchini",
"PrintOnCheckName": "Bill's Windsurf Shop",
"sparse": true,
"Id": "2"
},
"time": "2015-07-23T11:07:55.772-07:00"
}
Update Vendor Copy Link
⚠️ The Display Name attribute or at least one of Title, Given Name, Middle Name, Family Name, or Suffix attributes is required during customer creation.
See Quickbooks Vendor API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Vendor update. Additional fields: Print on Check Name, Primary Email Address, Suffix, Title, Tax Identifier, Account Number, Primary Phone, Web Address, Mobile, Company Name, Bill Address, Given Name. | |
ID* | Unique Identifier of the Vendor. |
Family Name* | Family name or the last name of the person. |
Display Name | The Display Name is how the person or organization is identified within the system. It must be unique within the system (across Customers, Vendors, and Employees). This field cannot be removed using sparse updates.If not provided, the system will create one for you by combining the customer’s name components (like title, first name, last name). |
ADDITIONAL FIELDS | |
Print on Check Name | This field displays the name of the person or organization as it should appear on a printed check. If you don’t provide this name, it will be automatically filled in using the DisplayName . |
Primary Email Address | Primary email address. [+ Add Field] add more fields. Address: Email address, the format must follow the RFC 822 standard. |
Suffix | Suffix of the name. For example, Jr. |
Title | Title of the person. This tag supports i18n (localized translations of titles such as “Mr.,” “Ms.,” “Dr.,” “Prof.,” or job-related titles like “CEO” and “Manager” in different languages and cultures). |
Tax Identifier Max 20 chars. | The tax ID of the Person or Organization. The value is masked in responses, exposing only last four characters. For example, the ID of 123-45-6789 is returned as XXXXXXX6789. |
Account Number Max 100 chars. | Name or number of the account associated with this vendor. |
Primary Phone | Primary phone number. [+ Add Field] add more fields. Free for Number. Max 30 chars. |
Web Address Maximum 1000 chars. | [+ Add Field] add more fields. URI: Uniform Resource Identifier for the web site. |
Mobile Maximum of 30 chars. | Mobile phone number. [+ Add Field] add more fields. Free for Number: Specifies the telephone number in free form. |
Company Name | The name of the company associated with the person or organization. |
Bill Address | Default billing address. When a physical address is updated within a transaction object, the QuickBooks Online API organizes the address components differently in the transaction response compared to when it was initially created: The Line1 and Line2 fields are now filled with the customer name and company name. The original Line1 to Line5, along with City, SubDivisionCode (State/Province), and PostalCode, are shifted into Line3 through Line5 as free-form text. [+ Add Field] add more fields. Country Sub Division Code City Postal Code line1 Country |
Given Name | Given name or first name of a person. |
(*) required field
Response Sample from Update Vendor
{
"Vendor": {
"PrimaryEmailAddr": {
"Address": "Books@Intuit.com"
},
"Vendor1099": false,
"domain": "QBO",
"GivenName": "Bessie",
"DisplayName": "Books by Bessie",
"BillAddr": {
"City": "Palo Alto",
"Line1": "15 Main St.",
"PostalCode": "94303",
"Lat": "37.445013",
"Long": "-122.1391443",
"CountrySubDivisionCode": "CA",
"Id": "31"
},
"SyncToken": "2",
"PrintOnCheckName": "Books by Bessie and Joan",
"FamilyName": "Williams",
"PrimaryPhone": {
"FreeFormNumber": "(650) 555-7745"
},
"AcctNum": "13451234",
"CompanyName": "Books by Bessie",
"WebAddr": {
"URI": "http://www.booksbybessie.co"
},
"sparse": false,
"Active": true,
"Balance": 0,
"Id": "30",
"MetaData": {
"CreateTime": "2014-09-12T10:07:56-07:00",
"LastUpdatedTime": "2015-07-28T13:37:05-07:00"
}
},
"time": "2015-07-28T13:37:07.196-07:00"
}
Update Account Copy Link
Update any writable field of an existing Payment object. Make sure to includes all fields as returned in the read response. Omitted fields will be set to NULL.
There are five main types of accounts: assets, liabilities, income, expenses, and equity.
All your business’s accounts are listed in your Chart of Accounts, which is a unique list created for your specific business. Accountants often refer to these accounts as “ledgers.”
The “account object” is the tool you’ll use within the QuickBooks system to manage and work with your accounts.
See Quickbooks Account API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Account update. Additional fields: Currency reference, Meta Data, Current Balance, Active, Sub Account. | |
ID* | Unique Identifier of the Account. |
Name* Must be unique. max 100 characters. | Name for the Account. Account.Name attribute must not contain double quotes (“) or colon (:). |
Account Sub Type* | The account sub-type classification and is based on the AccountType value. Required if AccountType is not specified. See possible values in the Account type and Account Sub Type List below. |
Account Type* | A detailed account classification that specifies the use of this account. The type is based on the Classification. Required if AccountSubType is not specified. See possible values in the Account type and Account Sub Type List below. |
ADDITIONAL FIELDS | |
Currency reference | Reference to the currency in which this account holds amounts. [+ Add Field] add more fields: Value: A three letter string representing the ISO 4217 code for the currency. For example, USD, AUD, EUR. Name: The full name of the currency |
Meta Data | Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications. [+ Add Field] add more fields. Create Time: Time the entity was created in the source domain. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM Last Update Time: Time the entity was last updated in the source domain. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM |
Current Balance | Specifies the balance amount for the current Account. Valid for Balance Sheet accounts. |
Active | True – False Inactive accounts can be hidden from most views and may not be used for new transactions. |
(*) required field
Account Type and Account Sub Type List
ASSET ACCOUNTS
ACCOUNT TYPE | ACCOUNT SUB TYPE |
---|---|
Bank | Default CashOnHand (default), Checking, MoneyMarket, RentsHeldInTrust, Savings, TrustAccounts, CashAndCashEquivalents, OtherEarMarkedBankAccounts |
Other Current Asset | Default AllowanceForBadDebts, DevelopmentCosts, EmployeeCashAdvances (default), OtherCurrentAssets, Inventory, Investment_MortgageRealEstateLoans, Investment_Other, Investment_TaxExemptSecurities, Investment_USGovernmentObligations, LoansToOfficers, LoansToOthers, LoansToStockholders, PrepaidExpenses, Retainage, UndepositedFunds, AssetsAvailableForSale, BalWithGovtAuthorities, CalledUpShareCapitalNotPaid, ExpenditureAuthorisationsAndLettersOfCredit, GlobalTaxDeferred, GlobalTaxRefund, InternalTransfers, OtherConsumables, ProvisionsCurrentAssets, ShortTermInvestmentsInRelatedParties, ShortTermLoansAndAdvancesToRelatedParties, TradeAndOtherReceivables |
Fixed Asset | Default AccumulatedDepletion, AccumulatedDepreciation, DepletableAssets, FixedAssetComputers, FixedAssetCopiers, FixedAssetFurniture, FixedAssetPhone, FixedAssetPhotoVideo, FixedAssetSoftware, FixedAssetOtherToolsEquipment, FurnitureAndFixtures (default), Land, LeaseholdImprovements, OtherFixedAssets, AccumulatedAmortization, Buildings, IntangibleAssets, MachineryAndEquipment, Vehicles, AssetsInCourseOfConstruction, CapitalWip, CumulativeDepreciationOnIntangibleAssets, IntangibleAssetsUnderDevelopment, LandAsset, NonCurrentAssets, ParticipatingInterests, ProvisionsFixedAssets |
Other Asset | Default LeaseBuyout, OtherLongTermAssets, SecurityDeposits, AccumulatedAmortizationOfOtherAssets, Goodwill, Licenses (default), OrganizationalCosts, AssetsHeldForSale, AvailableForSaleFinancialAssets, DeferredTax, Investments, LongTermInvestments, LongTermLoansAndAdvancesToRelatedParties, OtherIntangibleAssets, OtherLongTermInvestments, OtherLongTermLoansAndAdvances, PrepaymentsAndAccruedIncome, ProvisionsNonCurrentAssets |
Accounts Receivable | Default Accounts Receivable |
EQUITY ACCOUNTS
ACCOUNT TYPE | ACCOUNT SUB TYPE |
---|---|
Equity | Default OpeningBalanceEquity (default), PartnersEquity, RetainedEarnings, AccumulatedAdjustment, OwnersEquity, PaidInCapitalOrSurplus, PartnerContributions, PartnerDistributions, PreferredStock, CommonStock, TreasuryStock, EstimatedTaxes, Healthcare, PersonalIncome, PersonalExpense, AccumulatedOtherComprehensiveIncome, CalledUpShareCapital, CapitalReserves, DividendDisbursed, EquityInEarningsOfSubsidiaries, InvestmentGrants, MoneyReceivedAgainstShareWarrants, OtherFreeReserves, ShareApplicationMoneyPendingAllotment, ShareCapital, Funds |
EXPENSE ACCOUNTS
ACCOUNT TYPE | ACCOUNT SUB TYPE |
---|---|
Expense | Default AdvertisingPromotional, BadDebts, BankCharges, CharitableContributions, CommissionsAndFees, Entertainment, EntertainmentMeals, EquipmentRental, FinanceCosts, GlobalTaxExpense, Insurance, InterestPaid, LegalProfessionalFees, OfficeExpenses, OfficeGeneralAdministrativeExpenses, OtherBusinessExpenses, OtherMiscellaneousServiceCost, PromotionalMeals, RentOrLeaseOfBuildings, RepairMaintenance, ShippingFreightDelivery, SuppliesMaterials, Travel (default), TravelMeals, Utilities, Auto, CostOfLabor, DuesSubscriptions, PayrollExpenses, TaxesPaid, UnappliedCashBillPaymentExpense, Utilities, AmortizationExpense, AppropriationsToDepreciation, BorrowingCost, CommissionsAndFees, DistributionCosts, ExternalServices, ExtraordinaryCharges, IncomeTaxExpense, LossOnDiscontinuedOperationsNetOfTax, ManagementCompensation, OtherCurrentOperatingCharges, OtherExternalServices, OtherRentalCosts, OtherSellingExpenses, ProjectStudiesSurveysAssessments, PurchasesRebates, ShippingAndDeliveryExpense, StaffCosts, Sundry, TravelExpensesGeneralAndAdminExpenses, TravelExpensesSellingExpense |
Other Expense | Default Depreciation (default), ExchangeGainOrLoss, OtherMiscellaneousExpense, PenaltiesSettlements, Amortization, GasAndFuel, HomeOffice, HomeOwnerRentalInsurance, OtherHomeOfficeExpenses, MortgageInterest, RentAndLease, RepairsAndMaintenance, ParkingAndTolls, Vehicle, VehicleInsurance, VehicleLease, VehicleLoanInterest, VehicleLoan, VehicleRegistration, VehicleRepairs, OtherVehicleExpenses, Utilities, WashAndRoadServices, DeferredTaxExpense, Depletion, ExceptionalItems, ExtraordinaryItems, IncomeTaxOtherExpense, MatCredit, PriorPeriodItems, TaxRoundoffGainOrLoss |
Cost of Goods Sold | Default EquipmentRentalCos, OtherCostsOfServiceCos, ShippingFreightDeliveryCos, SuppliesMaterialsCogs, CostOfLaborCos (default), CostOfSales, FreightAndDeliveryCost |
LIABILITY ACCOUNTS
ACCOUNT TYPE | ACCOUNT SUB TYPE |
---|---|
Accounts Payable | Default Accounts Payable, OutstandingDuesMicroSmallEnterprise, OutstandingDuesOtherThanMicroSmallEnterprise |
Credit Card | Default Credit Card |
Long Term Liability | Default NotesPayable (default), OtherLongTermLiabilities, ShareholderNotesPayable, AccrualsAndDeferredIncome, AccruedLongTermLiabilities, AccruedVacationPayable, BankLoans, DebtsRelatedToParticipatingInterests, DeferredTaxLiabilities, GovernmentAndOtherPublicAuthorities, GroupAndAssociates, LiabilitiesRelatedToAssetsHeldForSale, LongTermBorrowings, LongTermDebit, LongTermEmployeeBenefitObligations, ObligationsUnderFinanceLeases, OtherLongTermProvisions, ProvisionForLiabilities, ProvisionsNonCurrentLiabilities, StaffAndRelatedLongTermLiabilityAccounts |
Other Current Liability | Default DirectDepositPayable, LineOfCredit, LoanPayable, GlobalTaxPayable, GlobalTaxSuspense, OtherCurrentLiabilities (default), PayrollClearing, PayrollTaxPayable, PrepaidExpensesPayable, RentsInTrustLiability, TrustAccountsLiabilities, FederalIncomeTaxPayable, InsurancePayable, SalesTaxPayable, StateLocalIncomeTaxPayable, AccruedLiabilities, CurrentLiabilities, CurrentPortionEmployeeBenefitsObligations, CurrentPortionOfObligationsUnderFinanceLeases, CurrentTaxLiability, DividendsPayable, DutiesAndTaxes, InterestPayables, ProvisionForWarrantyObligations, ProvisionsCurrentLiabilities, ShortTermBorrowings, SocialSecurityAgencies, StaffAndRelatedLiabilityAccounts, SundryDebtorsAndCreditors, TradeAndOtherPayables |
REVENUE ACCOUNTS
ACCOUNT TYPE | ACCOUNT SUB TYPE |
---|---|
Income | Default NonProfitIncome, OtherPrimaryIncome (default), SalesOfProductIncome, ServiceFeeIncome, DiscountsRefundsGiven, UnappliedCashPaymentIncome, CashReceiptIncome, OperatingGrants, OtherCurrentOperatingIncome, OwnWorkCapitalized, RevenueGeneral, SalesRetail, SalesWholesale, SavingsByTaxScheme |
Other Income | Default DividendIncome, InterestEarned, OtherInvestmentIncome (default), OtherMiscellaneousIncome, TaxExemptInterest, GainLossOnSaleOfFixedAssets, GainLossOnSaleOfInvestments, LossOnDisposalOfAssets, OtherOperatingIncome, UnrealisedLossOnSecuritiesNetOfTax |
Response Sample from Update Account
{
"Account": {
"FullyQualifiedName": "Accounts Payable (A/P)",
"domain": "QBO",
"SubAccount": false,
"Description": "Description added during update.",
"Classification": "Liability",
"AccountSubType": "AccountsPayable",
"CurrentBalanceWithSubAccounts": -1091.23,
"sparse": false,
"MetaData": {
"CreateTime": "2014-09-12T10:12:02-07:00",
"LastUpdatedTime": "2015-07-13T15:35:13-07:00"
},
"AccountType": "Accounts Payable",
"CurrentBalance": -1091.23,
"Active": true,
"SyncToken": "1",
"Id": "33",
"Name": "Accounts Payable (A/P)"
},
"time": "2015-07-13T15:31:25.618-07:00"
}
Update Purchase Copy Link
To create a Purchase:
▪️ You must specify an Account Reference for all purchases.
▪️ The Total Amount attribute must add up to sum of Line.Amount attributes.
There are three types of purchases: Cash, Check, and Credit Card.
▪️ Cash Purchase contains information regarding a payment made in cash.
▪️ Check Purchase contains information regarding a payment made by check.
▪️ Credit Card Purchase contains information regarding a payment made by credit card or refunded/credited back to a credit card.
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Purchase API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Purchase update. Additional fields: Account Reference, Currency Reference, Transaction Date, Print Status, Transaction Source, Global Tax Calculation, Transaction Location Type, Document Number, Private Note, Credit, Payment Method Reference, PurchaseEx, Exchange Rate, Department Reference, Entity Reference, Include In Annual TPAR. | |
ID* | Unique Identifier of the Purchase. |
Payment type* | Payment Type can be: Cash, Check, or Credit Card |
Line* | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type* Possible values: – Item based Expense Line Detail (This option is only available when the ‘For Purchase’ preference is activated for Products and Services). – Account Based Expense Line Detail. Amount*: The amount of the line item. The [+ Add Field] button allows to add fields corresponding to Detail Type. ID: Unique identifier (ID) of the line item. Update Operation: If a valid ID is provided, the request is treated as an update to an existing line item. Create Operation: If no ID is provided, or the provided ID is invalid, the request is treated as a creation of a new line item. This ID field is available in all objects that contain lines and support updates. Item Based Expense Line Detail: [+ Add Field] add more related fields. _Tax Inclusive Amount: represents the total amount of the purchase, including tax if applicable. Use TaxInclusiveAmount when the total purchase price includes tax, and QuickBooks should derive the pre-tax amount.Do NOT use it if tax should be calculated separately based on the taxable subtotal. _ Item Reference*: Reference to the Item. [+ Add Field] add more fields. ___ Value*: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._ Customer Reference*: Reference to a customer or job. [+ Add Field] add more fields. ___ Value*: The ID for the referenced customer. ___ Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._Price Level Reference: Reference to the PriceLevel of the service or item for the line. [+ Add Field] add more fields. ___ Value*: The ID for the referenced Price Level. ___ Name: Name derived from the field that holds the common name of that price level. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._Class Reference: Reference to the Class associated with the expense. [+ Add Field] add more fields. ___ Value*: The ID for the referenced Class. ___ Name: Name derived from the field that holds the common name of that class. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._Tax Code Reference: Reference to the TaxCode for this item. [+ Add Field] add more fields in Tax Code Reference: ___ Value: The ID for the referenced Tax Code. ___ Name: Name derived from the field that holds the common name of that Tax Code. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._Markup Info: Markup information for the expense. [+ Add Field] add more fields. ___ Price Level Reference: Reference to a PriceLevel for the markup. ______ Value*: The ID for the referenced Price Level. ______ Name: Name derived from the field that holds the common name of that price level. ___ Percent:Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01. _Quantity*: Number of items. _Unit Price: Unit price of the subject item as referenced by ItemRef. Corresponds to the Rate column on the QuickBooks Online UI to specify either unit price, a discount, or a tax rate for item. If used for unit price, the monetary value of the service or product, as expressed in the home currency. If used for a discount or tax rate, express the percentage as a fraction. For example, specify 0.4 for 40% tax. Linked Transaction: Zero or more transactions linked to this Purchase. [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Linked Transaction can be added as elements. Element 1: Represents the first Linked Transaction. _Transaction ID*: Transaction Id of the related transaction. _Transaction Type*: Bill, BillPaymentCheck, BillPaymentCreditCard, CreditCardCredit, ReimburseCharge, VendorCredit, Expense, Check, Payment _Transaction Line ID: This field is required for Deposit and Bill entities. It specifies the line number within the linked transaction. If you include this field, you must also provide the TxnId and TxnType of the linked transaction.Description: Free form text description of the line item that appears in the printed record. Max 4000 chars. Line Number: Specifies the position of the line in the collection of transaction lines. Account Based Expense Line Detail: [+ Add Field] add more fields. _Account Reference*: This field indicates the account used for this purchase, depending on the payment method (e.g., bank account for checks, credit card account for credit card payments). [+ Add Field] add more fields in account Reference: ___ Value*: The ID for the referenced account ___ Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._Tax Amount: Sales tax paid as part of the expense. _Tax Inclusive Amount: The total amount of the line item including tax. _Class Reference: This field specifies the class associated with the expense. Class tracking must be enabled at the line item level in your accounting preferences for this field to be available. [+ Add Field] add more fields. ___ Value*: The ID for the referenced Class. ___ Name: Name derived from the field that holds the common name of that class. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._Tax Code Reference: Reference to the TaxCode for this expense. [+ Add Field] add more fields in Tax Code Reference: ___ Value*: The ID for the referenced Tax Code. ___ Name: Name derived from the field that holds the common name of that Tax Code. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._Markup Info: Markup information for the expense. [+ Add Field] add more fields. ___ Price Level Reference: Reference to a PriceLevel for the markup. ______ Value*: The ID for the referenced Price Level. ______ Name: Name derived from the field that holds the common name of that price level. ___ Percent:Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01. _Customer Reference: Reference to the Customer associated with the expense. [+ Add Field] add more fields. ___ Value*: The ID for the referenced customer. ___ Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Account Reference* | This field specifies the associated account. For checks, it must be a bank account. For credit cards, it must be a credit card account. The account reference must be valid and currently active. [+ Add Field] add more fields. Value*: The ID for the referenced account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
ADDITIONAL FIELDS | |
Currency reference | Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multi-currency is enabled for the company. Read more about multi-currency support here. Value*: A three letter string representing the ISO 4217 code for the currency. For example, USD, AUD, EUR. Name: The full name of the currency. |
Transaction Date | The date entered by the user when this transaction occurred. yyyy/MM/dd is the valid date format. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. |
Print Status | Applicable only for Check. Ignored for Credit Card charge or refund. Possible values: Not Set, Need To Print, Print Complete. |
Transaction Source | Used internally to specify originating source of a credit card transaction. |
Global Tax Calculation | Method in which tax is applied. Allowed values are: Tax Excluded, Tax Inclusive, and Not Applicable. |
Transaction Location Type For France locales, only. | The account location. Valid values include: Within France France Overseas Outside France With EU Outside EU |
Document Number Maximum of 21 chars. | This field stores the transaction’s reference number. You can specify a custom value during creation. If none is provided this field is populated based on the setting of Preferences: CustomTxnNumber .▪️ If UseCustomTxnNumbers preference is enabled: You can provide a custom DocNumber . Duplicates are not allowed.▪️ If no custom value is given, DocNumber is null.▪️ If UseCustomTxnNumbers is disabled: DocNumber is automatically generated by the system.Cash/CreditCard: Duplicates always cause an error. Check: Duplicates cause an error only if the WarnDuplicateCheckNumber preference is enabled.Tips: Check the UseCustomTxnNumbers preference before setting DocNumber manually.Allow Duplicates: Use the include=allowduplicatedocnum query parameter to allow duplicate DocNumber (not recommended).Default Sort Order: Ascending order. |
Private Note Max of 4000 chars. | User-entered, organization-private note about the transaction. This field maps to the Memo field on the Expense form in the QuickBooks UI. |
Credit | False—it represents a charge. True—it represents a refund. Valid only for Credit Card payment type and Credit Card transactions. |
Payment Method Reference | Reference to a Payment Method associated with this transaction. [+ Add Field] add more fields. Value*: The ID for the referenced payment method. Name: Name derived from the field that holds the common name of that payment method. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
PurchaseEx | For internal use. Extension field that allows custom data storage. It is often used for third-party integrations that need to track extra metadata. |
Exchange Rate | This field represents the exchange rate, which is the number of your company’s home currency units needed to equal one unit of a different currency. This field is only applicable if your company uses multiple currencies. |
Department Reference | This field links the transaction to a specific department within your company. This feature is only available if the ‘Track Departments’ preference is enabled in your accounting settings. [+ Add Field] add more fields. Value*: The ID for the referenced department. Name: Name derived from the field that holds the common name of that department. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Entity Reference | This field links an expense transaction to a specific entity. Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate Customer, Vendor or Employee object for this reference. [+ Add Field] add more fields. Reference Type*: Specifies the type of entity (Customer, Vendor, Employee). Value*: The ID for the referenced entity. Name: Name derived from the field that holds the common name of that entity. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Include In Annual TPAR | True – False Include the supplier in the annual TPAR. TPAR stands for Taxable Payments Annual Report. The TPAR is mandated by ATO to get the details payments that businesses make to contractors for providing services. Some government entities also need to report the grants they have paid in a TPAR. |
(*) required field
Response Sample from Update Purchase
{
"SyncToken": "1",
"domain": "QBO",
"PurchaseEx": {
"any": [
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"nil": false,
"value": {
"Name": "TxnType",
"Value": "54"
},
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"globalScope": true,
"typeSubstituted": false
}
]
},
"TxnDate": "2015-07-27",
"TotalAmt": 10.0,
"PrivateNote": "Added an updated private note via update.",
"PaymentType": "Cash",
"sparse": false,
"Line": [
{
"DetailType": "AccountBasedExpenseLineDetail",
"Amount": 10.0,
"ProjectRef": {
"value": "42991284"
},
"Id": "1",
"AccountBasedExpenseLineDetail": {
"TaxCodeRef": {
"value": "NON"
},
"AccountRef": {
"name": "Meals and Entertainment",
"value": "13"
},
"BillableStatus": "NotBillable"
}
}
],
"AccountRef": {
"name": "Checking",
"value": "35"
},
"CustomField": [],
"Id": "252",
"MetaData": {
"CreateTime": "2015-07-27T10:37:26-07:00",
"LastUpdatedTime": "2015-07-27T10:42:11-07:00"
}
}
Update Time Activity Copy Link
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Time Activity API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Time Activity update. Additional fields: Transaction Date, Description, Item Reference, Minutes, Hours, Billable Status, Hourly Rate, Taxable, Customer Reference, Meta Data. | |
ID* | Unique Identifier of the Time Activity. |
Name of* | This field specifies the type of time activity being recorded. It’s required when creating a new record and must be used in conjunction with either the EmployeeRef or VendorRef attributes. Possible values: Vendor or Employee. |
Employee Reference | Specifies the employee whose time is being recorded. Value: The ID for the referenced employee. Name: Name derived from the field that holds the common name of that employee. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Vendor Reference | Specifies the vendor whose time is being recorded. Value: The ID for the referenced vendor. Name: Name derived from the field that holds the common name of that vendor. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Start Time* | This field indicates the start time of the work. It’s required if the specific hours and minutes are not provided. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM Important: Only include the hours (e.g., 9, 10, 11) without the time zone offset, as it doesn’t affect the time activity hours calculation. If is provided: Use the specified Transaction Date (in YYYY-MM-DD format) and include Start Time and End Time in hours and minutes (without time zone offsets).If Transaction Date is not provided: Use the current server date and include StartTime and EndTime in hours and minutes (with or without time zone offsets).For historical or future transactions, always include the Transaction Date in YYYY-MM-DD format and specify StartTime and End Time in hours and minutes. |
End Time* | This field indicates the end time of the work. It’s required if the specific hours and minutes are not provided. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM Important: Only include the hours (e.g., 5, 6, 7) without the time zone offset, as it doesn’t affect the time activity hours calculation. If is provided: Use the specified TxnDate (in YYYY-MM-DD format) and include StartTime and EndTime in hours and minutes (without time zone offsets).If is not provided: Use the current server date and include StartTime and EndTime in hours and minutes (with or without time zone offsets).For historical or future transactions, always include the in YYYY-MM-DD format and specify StartTime and EndTime in hours and minutes. |
ADDITIONAL FIELDS | |
Transaction Date | The date for the time activity. This field represents the date used for financial reporting. If no date is provided, the current system date is used. The default sort order for transactions is ascending by date. If you specify the start and end times without time zone offsets, you must also provide the transaction date ( TxnDate ) for any past or future time activities. For example, to record a past time activity, include the TxnDate and specify the start and end times in hours (without time zone offsets).Local timezone: YYYY-MM-DD UTC: YYYY-MM-DDZ Specific time zone: YYYY-MM-DD+/-HH:MM The date format follows the XML Schema standard. |
Description maximum 4000 characters. | Description of work completed during time activity. |
Item Reference | Reference to the service item associated with this object. [+ Add Field] add more fields in Item reference: ___ Item ID: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘.me |
Minutes Maximum of 8760 hours 59 minutes; if hours is 8760 minutes must be 0 | minutes worked. |
Hours Maximum of 8760 hours 59 minutes; if hours is 8760 minutes must be 0 | Hours and minutes worked. Required if StartTime and EndTime not specified |
Hourly Rate max character: 0 to 99999999999 hours. | Hourly bill rate of the employee or vendor for this time activity. Required if Billable Status is set to Billable. |
Taxable | True – False True if the time recorded is both billable and taxable. |
Customer Reference | Reference to a customer or job. [+ Add Field] add more fields. Value: The ID for the referenced customer. Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Meta Data | Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications. [+ Add Field] add more fields. Create Time: Time the entity was created in the source domain. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM Last Update Time: Time the entity was last updated in the source domain. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM |
(*) required field
Response Sample from Update Time Activity
{
"TimeActivity": {
"TxnDate": "2014-09-16",
"domain": "QBO",
"NameOf": "Employee",
"Description": "Updated descirption",
"ItemRef": {
"name": "Design",
"value": "4"
},
"Minutes": 0,
"ProjectRef": {
"value": "39298005"
},
"Hours": 5,
"BillableStatus": "Billable",
"sparse": false,
"HourlyRate": 75,
"Taxable": false,
"EmployeeRef": {
"name": "John Johnson",
"value": "54"
},
"SyncToken": "1",
"CustomerRef": {
"name": "Amy's Bird Sanctuary",
"value": "1"
},
"Id": "3",
"MetaData": {
"CreateTime": "2014-09-17T11:53:15-07:00",
"LastUpdatedTime": "2015-07-28T11:59:41-07:00"
}
},
"time": "2015-07-28T11:59:41.178-07:00"
}
Update Refund Receipt Copy Link
A Refund Receipt must include:
▪️ At least one line item: This details the item(s) being refunded.
▪️ A designated deposit account: Specified by Deposit To Account Ref.
If no billing address is provided, The customer’s address will be used as the billing address.
Tax Code Restrictions:
▪️ Custom Sales Tax cannot be used for Transaction Tax Code Ref.
▪️ This tax code is reserved for transactions using the older sales tax model.
▪️ You cannot create or update transactions that use TaxCode.CustomSalesTax.
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Refund Receipt API reference.
MAP FIELDS [+ Add Field] Select fields from list, to configure the Refund Receipt update. Additional fields: Document Number, Balance, Payment Method Reference, Bill Address, Transaction Date, Customer Reference, Customer Memo, Shipping Address, Print Status, Bill Email, Line, Apply Tax After Discount, Custom Field, Transaction Tax Detail, Meta Data. | |
ID* | Unique Identifier of the Refund Receipt. |
Deposit to Account Reference* | Accounts receivable asset account from which payment money is refunded. _Reference Type*: [+ Add Field] add more fields. ___ Value*: The ID for the referenced account. ___ Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._Currency Reference Type: This field specifies the currency used for all amounts in the transaction. (Required if your company uses multiple currencies (i.e., if Preferences.MultiCurrencyEnabled is set to ‘true’).For more information, please refer to Manage multiple currencies. ___ Value: A three letter string representing the ISO 4217 code for the currency. For example, USD, AUD, EUR. ___ Name: The full name of the currency. |
Line* The minimum line item required for the request is one of the following: Sales Item Line and Group Line. | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type*: Possible choices for each line: Sales Item Line Detail Group Line Detail Sale Item Line Detail*: _ Item Reference*: Reference to the Item. ___ Value*: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘.[+ Add Field] add more fields: _ Unit Price: Unit price of the subject item as referenced by ItemRef ._ Quantity: Number of items for the line. _ Tax Code Reference: Reference to the TaxCode for this item. [+ Add Field] add more fields: ___ Value: The ID for the referenced Tax Code. Amount*: The amount of the line item. Description: Free form text description of the line item that appears in the printed record (max character: 4000). Line Number: Specifies the position of the line in the collection of transaction lines. ID: Unique identifier (ID) of the line item. Update Operation: If a valid ID is provided, the request is treated as an update to an existing line item. Create Operation: If no ID is provided, or the provided ID is invalid, the request is treated as a creation of a new line item. This ID field is available in all objects that contain lines and support updates. |
ADDITIONAL FIELDS | |
Document Number Maximum of 21 chars. | This field stores the transaction’s reference number. You can specify a custom value during creation. If none is provided this field is populated based on the setting of Preferences: CustomTxnNumber .▪️ If UseCustomTxnNumbers preference is enabled: You can provide a custom DocNumber . Duplicates are not allowed.▪️ If no custom value is given, DocNumber is null.▪️ If UseCustomTxnNumbers is disabled: DocNumber is automatically generated by the system.Cash/CreditCard: Duplicates always cause an error. Check: Duplicates cause an error only if the WarnDuplicateCheckNumber preference is enabled.Tips: Check the UseCustomTxnNumbers preference before setting DocNumber manually.Allow Duplicates: Use the include=allowduplicatedocnum query parameter to allow duplicate DocNumber (not recommended).Default Sort Order: Ascending order. |
Payment Method Reference | Reference to a Payment Method associated with this transaction. [+ Add Field] add more fields. Value*: The ID for the referenced payment method. Name: Name derived from the field that holds the common name of that payment method. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Bill Address | This field specifies the billing address for the invoice. If no billing address is provided: QuickBooks will use the default billing address associated with the customer. For international addresses: Use the 3-letter ISO country code or the full country name. Address Updates: If you update the physical address within the transaction itself, the address components will be presented differently in the API response compared to the original creation: Line 1 and Line 2: Will display the customer name and company name. Line 3 to Line 5: Will contain the original address information (Line 1-5, City, State/Province, Postal Code) as free-form text. [+ Add Field] add more fields. Line1 Line2 Postal Code Latitude longitude |
Transaction Date | The date entered by the user when this transaction occurred. yyyy/MM/dd is the valid date format. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. |
Customer Reference | Reference to a customer or job. Value: The ID for the referenced customer. Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Customer Memo | Value: User’s message to the customer; this message is visible to the end user on their transactions. |
Shipping Address | This field indicates the shipping address for the goods. If no specific shipping address is provided, QuickBooks will automatically use the default shipping address associated with the referenced customer in the system. When entering international addresses, specify the country using either the 3-letter ISO code (e.g., USA, GBR) or the full country name. If you update the physical address within the transaction itself, the address components will be presented differently in the API response compared to the original creation: Line 1 and Line 2: Will display the customer name and company name. Line 3 to Line 5: Will contain the original address information (Line 1-5, City, State/Province, Postal Code) as free-form text. [+ Add Field] add more fields: City Line1 Postal Code Latitude longitude Country Sub Division Code |
Print Status | Applicable only for Check. Ignored for Credit Card charge or refund. Possible values: Not Set, Need To Print, Print Complete. |
Bill Email | Identifies the e-mail address where the estimate is sent. [+ Add Field] add more fields Email*: The address format must follow the RFC 822 standard. |
Apply Tax After Discount Apply to USA. | True – False If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax. |
Custom field | This allows you to add up to three custom fields to your transactions. These fields are available only if they have been configured for your company in the settings: ▪️ Check “Preferences.SalesFormsPrefs.CustomField” for sales transactions. ▪️ Check “Preferences.VendorAndPurchasesPrefs.POCustomField” for purchase orders. Click here for information on managing custom fields. [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional custom field can be added as elements. Element 1: Represents the first custom field. Value Name Field Type |
Transaction Tax Detail | This data type contains information about the taxes applied to the entire transaction. It includes details of sales taxes calculated based on the tax codes specified within the transaction. ▪️ QuickBooks can calculate these taxes automatically. ▪️ You can also provide the tax details when adding a transaction. Global Tax Model: Refer to the Global Tax Model documentation for more information. Sales Tax Disabled: If sales tax is disabled in your company’s preferences ( Preferences.TaxPrefs.UsingSalesTax is false), this data will be ignored and not stored.[+ Add Field] add more fields. Total Tax: Total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list. |
Meta Data | Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications. [+ Add Field] add more fields. Create Time: Time the entity was created in the source domain. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM Last Update Time: Time the entity was last updated in the source domain. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM |
(*) required field
Response Sample from Update Refund Receipt
{
"RefundReceipt": {
"TxnDate": "2014-09-17",
"domain": "QBO",
"PrintStatus": "NotSet",
"TotalAmt": 87.5,
"Line": [
{
"Description": "Refund - Pest control was ineffective",
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"TaxCodeRef": {
"value": "NON"
},
"Qty": 2.5,
"UnitPrice": 35,
"ItemRef": {
"name": "Pest Control",
"value": "10"
}
},
"LineNum": 1,
"Amount": 87.5,
"Id": "1"
},
{
"DetailType": "SubTotalLineDetail",
"Amount": 87.5,
"SubTotalLineDetail": {}
}
],
"ApplyTaxAfterDiscount": false,
"DocNumber": "1020",
"PrivateNote": "This is a new private note added via sparse update.",
"sparse": true,
"DepositToAccountRef": {
"name": "Checking",
"value": "35"
},
"CustomerMemo": {
"value": "Thank you for your business and have a great day!"
},
"ProjectRef": {
"value": "39298034"
},
"Balance": 0,
"CustomerRef": {
"name": "Pye's Cakes",
"value": "15"
},
"TxnTaxDetail": {
"TotalTax": 0
},
"SyncToken": "3",
"PaymentMethodRef": {
"name": "Check",
"value": "2"
},
"CustomField": [
{
"DefinitionId": "1",
"Type": "StringType",
"Name": "Crew #"
}
],
"ShipAddr": {
"City": "South Orange",
"Line1": "350 Mountain View Dr.",
"PostalCode": "07079",
"Lat": "40.7633073",
"Long": "-74.2426072",
"CountrySubDivisionCode": "NJ",
"Id": "15"
},
"BillAddr": {
"Line4": "South Orange, NJ 07079",
"Line3": "350 Mountain View Dr.",
"Id": "73",
"Line1": "Karen Pye",
"Line2": "Pye's Cakes"
},
"MetaData": {
"CreateTime": "2014-09-17T15:35:07-07:00",
"LastUpdatedTime": "2015-07-29T08:59:30-07:00"
},
"BillEmail": {
"Address": "pyescakes@intuit.com"
},
"Id": "66"
},
"time": "2015-07-29T08:59:32.061-07:00"
}
UPSERT Copy Link
This Method allows you to upsert:
Invoice, Item, Journal Entry, Bill, Sale Receipt, Purchase Order, Customer, Vendor, Account.
Configuration Table:
Input Options:
- Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
- Default Value: You can specify a fixed attribute.
Name* | Upsert |
Connection* | Select your connection or create one. |
Entity* (Set of data that contain records) | Select the available Entity to upsert records: Invoice, Item, Journal Entry, Bill, Sale Receipt, Purchase Order, Customer, Vendor, Account. |
(*) required field
Configuration table for each Entity:
Upsert Invoice Copy Link
Note:
▪️ Have at least one Line a sales item or inline subtotal.
▪️ The
DocNumber
attribute is populated automatically by the data service if not supplied.▪️ If
ShipAddr, BillAddr
, or both are not provided, the appropriate customer address from the referenced Customer object is used to fill those values.Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Invoice API Reference.
MATCHING CRITERIA | |
DocNumber* | Equal to the Invoice DocNumber field value. |
MAP FIELDS [+ Add Field] Select fields from a list, to configure the invoice upsert. Additional fields: Sales Term Reference, Transaction Date, Customer Memo, Transaction Tax Detail, Deposit, Line. | |
Customer Reference* | A customer is a consumer of the service or product that your business offers. Reference to a customer or job. Customer ID*: The ID for the referenced customer. Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Line* Invoice line object. If the transaction is taxable there is a limit of 750 lines per transaction. | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Invoice Line. Detail Type*: Possible choices for each line: Sales Item Line Detail Group Line Detail Amount*: The amount of the line item. The [+ Add Field] button allows to add fields corresponding to the Detail Type. Description: Free form text description of the line item that appears in the printed record. Max character: 4000. Line Number: Specifies the position of the line in the collection of transaction lines. Sale Item Line Detail [+ Add Field] add more fields in Sale Item Line Detail: _ Quantity: Number of items for the line. _ Unit Price: Unit price of the subject item as referenced by ItemRef. _ Discount Amount: Fixed discount. _ Discount Rate: The discount rate applied to this line. If both Discount are provided, Discount Rate takes precedence and Discount Amount is recalculated by QuickBooks services based on amount of Discount Rate. _ Item Reference: Reference to an Item object. [+ Add Field] add more fields in Item reference: ___ Item ID: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._ Tax Code Reference: Reference to the Tax Code for this item. [+ Add Field] add more fields in Tax Code Reference: ___ Value: The ID for the referenced Tax Code. ___ Name: Name derived from the field that holds the common name of that Tax Code. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
ADDITIONAL FIELDS | |
Sales Term Reference | Reference to the sales term associated with the transaction. Value: The ID for the referenced Sales Term. |
Transaction Date | The date entered by the user when this transaction occurred. yyyy/MM/dd is the valid date format. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. |
Customer Memo Max 1000 chars.. | Value: User’s message to the customer; this message is visible to the end user on their transactions. |
Transaction Tax Detail | This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. Transaction Tax Code Reference: _ Value: Reference to the transaction tax code. See Global tax model for more information about this element. |
Deposit | The deposit made towards this invoice. |
(*) required field
Upsert Item Copy Link
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Item API Reference.
MATCHING CRITERIA | |
Name* Maximum of 100 chars | Equal to the Item unique name. |
MAP FIELDS [+ Add Field] Select fields from list, to configure the Item creation. Additional fields: Active, SKU, Unit Price, TrackQtyOnHand, QtyOnHand, AssetAccountRef, InvStartDate, ExpenseAccountRef. | |
IncomeAccountRef* | Reference to the posting account, that is, the account that records the proceeds from the sale of this item. Must be an account with account type of Sales of Product Income .Account ID*: The ID for the referenced Income Account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Type* | Classification that specifies the use of this item:Inventory - Service - Non inventory See the description at the top of the Item entity page for details about supported item types. |
ADDITIONAL FIELDS | |
Active | True – False Inactivating an item is achieved by setting the Active attribute to false. |
SKU | The stock keeping unit (SKU) for this Item. This is a company-defined identifier for an item or product used in tracking inventory. maximum of 100 chars. minorVersion: 4 |
Unit Price | Price of the item. |
TrackQtyOnHand | True - False |
QtyOnHand | Current quantity of the Inventory items available for sale.Not used for Service or NonInventory type items.Required for Inventory type items. |
AssetAccountRef | Reference to the Inventory Asset account that tracks the current value of the inventory. If the same account is used for all inventory items, the current balance of this account will represent the current total value of the inventory. Must be an account with account type of Other Current Asset . Use Account.Id and Account.Name from that object for AssetAccountRef.value and AssetAccountRef.name , respectively. Required for Inventory item types.Account ID*: The ID for the referenced asset account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
InvStartDate | Date of opening balance for the inventory transaction. Required when creating an Item.Type =Inventory. Required for Inventory item types.Local timezone: YYYY-MM-DD UTC: YYYY-MM-DDZ Specific time zone: YYYY-MM-DD+/-HH:MM The date format follows the XML Schema standard. |
ExpenseAccountRef | Reference to the expense account used to pay the vendor for this item. Must be an account with account type of Cost of Goods Sold .Account ID*: The ID for the referenced expense account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
(*) required field
Upsert Journal Entry Copy Link
Journal Entry is a transaction in which:
▪️ There are at least one pair of lines, a debit and a credit, called distribution lines.
▪️ Each distribution line has an account from the Chart of Accounts. Query the Account resource for a listing of the Chart of Accounts.
▪️ The total of the debit column equals the total of the credit column.
When you record a transaction with a JournalEntry object, the QuickBooks Online UI labels the transaction as JRNL in the register and as General Journal on reports that list transactions.
Tip: For Any Reference fields like Customer Reference, Account Reference or Vendor Reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Journal Entry API reference.
MATCHING CRITERIA | |
DocNumber* | Equal to the Journal Entry DocNumber. |
MAP FIELDS | |
Line* Individual line items of a transaction. There must be at least one pair of Journal Entry Line elements, representing a debit and a credit, called distribution lines. Set Line Detail Type to Journal Entry Line for both lines. | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Journal Entry Line can be added as elements. Element 1: Represents the first Journal Entry Line. Detail Type*: Set to Journal Entry Line Detail .Amount*: The amount of the line item. Journal Entry Line Detail*: _ Posting Type*: Indicates whether this Journal Entry line is a Debit or Credit. _ Account Reference*: Reference to the account associated with this line. ___ Value*: The ID for the referenced account. ___ Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘.⚠️ If this account has same location as specified in the transaction by the TransactionLocationType attribute and the same VAT as in the line item TaxCodeRef attribute, then this account is used.⚠️ If there is a mismatch, then the account from the account category list that matches the transaction location and VAT is used. ⚠️ If this account is not present in the account category list, then a new account is created with the new location, new VAT code, and all other attributes as in the default account. Description: Free form text description of the line item that appears in the printed record. Max 4000 chars. |
(*) required field
Upsert Bill Copy Link
When creating a bill, only certain transaction types can be linked. The most commonly supported transaction types include:
▪️ BillPaymentCheck – A payment made by check to pay the bill.
▪️ BillPaymentCreditCard – A payment made by credit card to pay the bill.
▪️ CreditMemo – A credit memo applied to the bill.
▪️ JournalEntry – A journal entry affecting the bill.
Transactions like Invoice and Deposit are not typically linked to a bill because a bill represents an expense or liability, while invoices are accounts receivable (money owed to you, not by you). Deposits usually relate to received funds, not expenses.
Tip: For Any Reference fields like Customer Reference, Account Reference or Vendor Reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Bill API reference.
MATCHING CRITERIA | |
DocNumber* | Equal to the Bill DocNumber. |
MAP FIELDS [+ Add Field] Select fields from list, to configure the Bill upsert. Additional fields: Currency Reference, Ap Account Reference, Sales Term Reference, Linked Transaction. | |
Vendors Reference* | Reference to the vendor for this transaction. [+ Add Field] add more fields: Value: The ID for the referenced vendor. Name: Name derived from the field that holds the common name of that vendor. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Line* | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type*: Possible choices for each line: Account Based Expense Line Detail – Item based Expense Line Detail Amount*: The amount of the line item. The [+ Add Field] button allows to add fields corresponding to Detail Type. Description: Free form text description of the line item that appears in the printed record. Max 4000 chars. Account Based Expense Line Detail: _ Account Reference: Reference to the Expense account associated with this item. ___ Account ID: The ID for the referenced account. ___ Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘.⚠️ If this account has same location as specified in the transaction by the TransactionLocationType attribute and the same VAT as in the line item TaxCodeRef attribute, then this account is used.⚠️ If there is a mismatch, then the account from the account category list that matches the transaction location and VAT is used. ⚠️ If this account is not present in the account category list, then a new account is created with the new location, new VAT code, and all other attributes as in the default account. Item based Expense Line Detail: _ Quantity: Number of items for the line. _ Unit Price: Unit price of the subject item. _ Item Reference: : Reference to the Item. ___ Value: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._ Customer Reference: Reference to a customer or job. ___ Value: The ID for the referenced customer. ___ Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
ADDITIONAL FIELDS | |
Currency Reference | Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multi-currency is enabled for the company. Read more about multi-currency support here. [+ Add Field] add more fields: Value: A three letter string representing the ISO 4217 code for the currency. For example, USD, AUD, EUR. Name: The full name of the currency. |
Ap Account Reference | Specifies to which AP account the bill is credited. [+ Add Field] add more fields: Value: The ID for the referenced account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘.⚠️ The specified account must have Account.Classification set to Liability and Account.AccountSubType set to AccountsPayable . If the company has a single AP account, the account is implied. However, it is recommended that the AP Account be explicitly specified in all cases to prevent unexpected errors when relating transactions to each other. |
Sales Term Reference | Reference to the Term associated with the transaction. [+ Add Field] add more fields: Value: The ID for the referenced sales term. Name: Name derived from the field that holds the common name of that sales term. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Linked Transaction | Zero or more transactions linked to this Bill object. [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Linked Transaction can be added as elements. Element 1: Represents the first Linked Transaction. Transaction ID: Unique identifier of the related transaction. Transaction Type: Possible values: BillPaymentCheck – A payment made by check to pay the bill.BillPaymentCreditCard – A payment made by credit card to pay the bill.CreditMemo – A credit memo applied to the bill.JournalEntry – A journal entry affecting the bill. |
(*) required field
Upsert Sale Receipt Copy Link
A Sales Receipt object represents a receipt issued to a customer upon payment for goods or services. It functions similarly to an invoice, but payment is received concurrently with the sale.
The receipt specifies a deposit account for the received funds. If no deposit account is designated, the payment is directed to the Undeposited Account.
▪️ A SalesReceipt object must have at least one line that describes an item and an amount.
Tip: For Any Reference fields like Customer Reference, Account Reference or Vendor Reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Sales Receipt API reference.
MATCHING CRITERIA | |
DocNumber* | Equal to the Sale Receipt DocNumber. |
MAP FIELDS | |
Line* The minimum line item required for the request is Sales Item Line or Group Line. | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type* Possible values for each line: Sales Item Line Detail Group Line Detail Description Line Detail Discount Line Detail Subtotal Line Detail Amount*: The amount of the line item. Sale Item Line Detail*: _ Item Reference*: : Reference to the Item. ___ Value*: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._ Unit Price: Unit price of the subject item as referenced by ItemRef ._ Quantity: Number of items for the line. _ Tax Code Reference: Reference to the TaxCode for this item. [+ Add Field] add more fields: ___ Value: The ID for the referenced Tax Code. [+ Add Field] add more fields: Description: Free form text description of the line item that appears in the printed record. Max 4000 chars. |
(*) required field
Upsert Purchase Order Copy Link
The Purchase Order object is a non-posting transaction representing a request to purchase goods or services from a third party.
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Purchase Order API reference.
MATCHING CRITERIA | |
DocNumber* | Equal to the Purchase Order DocNumber. |
MAP FIELDS | |
Line* | [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional Line can be added as elements. Element 1: Represents the first Line. Detail Type* Value: Item based Expense Line Detail, Account Based Expense Line Detail. Amount*: amount, price of the line. Item Based Expense Line Detail* _ Item Reference*: Reference to the Item. ___ Value*: The ID for the referenced item. ___ Name: Name derived from the field that holds the common name of that item. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._ Customer Reference*: Reference to a customer or job. ___ Value*: The ID for the referenced customer. ___ Name: Name derived from the field that holds the common name of that customer. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘._ Quantity*: Number of items. _ Item Reference*: Reference to the Item. ___ Value*: The ID for the referenced item. _ Billable Status: The billable status of the expense. This field is not updatable through an API request. The value automatically changes when an invoice is created. Possible values: Billable, Not Billable, Has Been Billed _ Unit Price: Unit price of the subject item as referenced by ItemRef. Corresponds to the Rate column on the QuickBooks Online UI to specify either unit price, a discount, or a tax rate for item. If used for unit price, the monetary value of the service or product, as expressed in the home currency. If used for a discount or tax rate, express the percentage as a fraction. For example, specify 0.4 for 40% tax. |
AP Account Reference* | This field indicates the Accounts Payable (AP) account used to record the bill. While many small businesses may only have one AP account, it’s crucial to always explicitly specify the account. This ensures accurate record-keeping, especially for businesses with multiple AP accounts. The specified account must be a Liability account specifically designated for Payables. Failing to explicitly specify the AP account can lead to unexpected errors when linking transactions within your accounting system. [+ Add Field] add more fields: Value: The ID for the referenced account. Name: Name derived from the field that holds the common name of that account. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
Vendor Reference* | Reference to the vendor for this transaction. [+ Add Field] add more fields: Value: The ID for the referenced vendor. Name: Name derived from the field that holds the common name of that vendor. For example, when referencing a Customer object, the field used is ‘ Customer.DisplayName ‘. |
(*) required field
Upsert Customer Copy Link
Customer Relationships: Customer relationships can be complex. Some customers may have a hierarchical structure. For example:
▪️ A team is the main customer, and its individual members are sub-customers.
▪️ A property management company is the main customer, and the properties they manage are sub-customers.
Tracking Work: You can use the system to track specific tasks or projects associated with a customer. For instance:
▪️ A homeowner is the customer, and their kitchen remodel is the project with individual tasks.
▪️ A car owner is the customer, and their car repairs are the projects with individual tasks.
⚠️ The Display Name attribute or at least one of Title, Given Name, Middle Name, Family Name, or Suffix attributes is required during customer creation.
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Customer API reference.
MATCHING CRITERIA | |
Display Name* | Equal to Customer unique display name. |
MAP FIELDS [+ Add Field] Select fields from list, to configure the Customer upsert. Additional fields: Primary Email Address, Suffix, Title, Middle Name, Notes, Primary Phone, Company Name, Bill Address, Given Name. | |
Family Name* | Family name or the last name of the person. |
Display Name* | The Display Name is how the person or organization is identified within the system. It must be unique within the system (across Customers, Vendors, and Employees). This field cannot be removed using sparse updates.If not provided, the system will create one for you by combining the customer’s name components (like title, first name, last name). |
ADDITIONAL FIELDS | |
Primary Email Address | Primary email address. [+ Add Field] add more fields. Address: An email address, the format must follow the RFC 822 standard. |
Suffix | Suffix of the name. For example, Jr. |
Title | Title of the person. This tag supports i18n (localized translations of titles such as “Mr.,” “Ms.,” “Dr.,” “Prof.,” or job-related titles like “CEO” and “Manager” in different languages and cultures). |
Middle Name | Middle name of the person. The person can have zero or more middle names. |
Notes Max 2000 chars. | Free form text describing the Customer. |
Primary Phone Max 30 chars. | Primary phone number. [+ Add Field] add more fields. Free for Number. |
Company Name | The name of the company associated with the person or organization. |
Bill Address | Default billing address. When a physical address is updated within a transaction object, the QuickBooks Online API organizes the address components differently in the transaction response compared to when it was initially created: The Line1 and Line2 fields are now filled with the customer name and company name. The original Line1 to Line5, along with City, SubDivisionCode (State/Province), and PostalCode, are shifted into Line3 through Line5 as free-form text. [+ Add Field] add more fields. Country Sub Division Code City Postal Code line1 Country |
Given Name | Given name or first name of a person. |
(*) required field
Upsert Vendor Copy Link
⚠️ The Display Name attribute or at least one of Title, Given Name, Middle Name, Family Name, or Suffix attributes is required during customer creation.
See Quickbooks Vendor API reference.
MATCHING CRITERIA | |
Display Name* | Equal to the Vendor unique display name. |
MAP FIELDS [+ Add Field] Select fields from list, to configure the Vendor upsert. Additional fields: Print on Check Name, Primary Email Address, Suffix, Title, Tax Identifier, Account Number, Primary Phone, Web Address, Mobile, Company Name, Bill Address, Given Name. | |
Family Name* | Family name or the last name of the person. |
Display Name | The Display Name is how the person or organization is identified within the system. It must be unique within the system (across Customers, Vendors, and Employees). This field cannot be removed using sparse updates.If not provided, the system will create one for you by combining the customer’s name components (like title, first name, last name). |
ADDITIONAL FIELDS | |
Print on Check Name | This field displays the name of the person or organization as it should appear on a printed check. If you don’t provide this name, it will be automatically filled in using the DisplayName . |
Primary Email Address | Primary email address. [+ Add Field] add more fields. Address: Email address, the format must follow the RFC 822 standard. |
Suffix | Suffix of the name. For example, Jr. |
Title | Title of the person. This tag supports i18n (localized translations of titles such as “Mr.,” “Ms.,” “Dr.,” “Prof.,” or job-related titles like “CEO” and “Manager” in different languages and cultures). |
Tax Identifier Max 20 chars. | The tax ID of the Person or Organization. The value is masked in responses, exposing only last four characters. For example, the ID of 123-45-6789 is returned as XXXXXXX6789. |
Account Number Max 100 chars. | Name or number of the account associated with this vendor. |
Primary Phone | Primary phone number. [+ Add Field] add more fields. Free for Number. Max 30 chars. |
Web Address Maximum 1000 chars. | [+ Add Field] add more fields. URI: Uniform Resource Identifier for the web site. |
Mobile Maximum of 30 chars. | Mobile phone number. [+ Add Field] add more fields. Free for Number: Specifies the telephone number in free form. |
Company Name | The name of the company associated with the person or organization. |
Bill Address | Default billing address. When a physical address is updated within a transaction object, the QuickBooks Online API organizes the address components differently in the transaction response compared to when it was initially created: The Line1 and Line2 fields are now filled with the customer name and company name. The original Line1 to Line5, along with City, SubDivisionCode (State/Province), and PostalCode, are shifted into Line3 through Line5 as free-form text. [+ Add Field] add more fields. Country Sub Division Code City Postal Code line1 Country |
Given Name | Given name or first name of a person. |
(*) required field
Upsert Account Copy Link
Accounts are the building blocks of your financial records. They track all your business’s financial activity:
▪️ Money coming in: Income and revenue.
▪️ Money going out: Expenses.
▪️ The value of your assets: Things your business owns like vehicles and equipment.
There are five main types of accounts: assets, liabilities, income, expenses, and equity.
All your business’s accounts are listed in your Chart of Accounts, which is a unique list created for your specific business. Accountants often refer to these accounts as “ledgers.”
The “account object” is the tool you’ll use within the QuickBooks system to manage and work with your accounts.
See Quickbooks Account API reference.
MATCHING CRITERIA | |
Name* max 100 characters. | Equal to the Account unique name. |
MAP FIELDS [+ Add Field] Select fields from list, to configure the Account upsert. Additional fields: Currency reference, Meta Data, Current Balance, Active, Sub Account. | |
Account Sub Type* | The account sub-type classification and is based on the AccountType value. Required if AccountType is not specified. See possible values in the Account type and Account Sub Type List below. |
Account Type* | A detailed account classification that specifies the use of this account. The type is based on the Classification. Required if AccountSubType is not specified. See possible values in the Account type and Account Sub Type List below. |
ADDITIONAL FIELDS | |
Currency reference | Reference to the currency in which this account holds amounts. [+ Add Field] add more fields: Value: A three letter string representing the ISO 4217 code for the currency. For example, USD, AUD, EUR. Name: The full name of the currency |
Meta Data | Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications. [+ Add Field] add more fields. Create Time: Time the entity was created in the source domain. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM Last Update Time: Time the entity was last updated in the source domain. Local time zone: YYYY-MM-DDTHH:MM:SS UTC: YYYY-MM-DDT HH :MM: SSZ Specific time zone: YYYY-MM-DDT HH :MM:SS +/- HH :MM |
Current Balance | Specifies the balance amount for the current Account. Valid for Balance Sheet accounts. |
Active | True – False Inactive accounts can be hidden from most views and may not be used for new transactions. |
(*) required field
Account Type and Account Sub Type List
ASSET ACCOUNTS
ACCOUNT TYPE | ACCOUNT SUB TYPE |
---|---|
Bank | Default CashOnHand (default), Checking, MoneyMarket, RentsHeldInTrust, Savings, TrustAccounts, CashAndCashEquivalents, OtherEarMarkedBankAccounts |
Other Current Asset | Default AllowanceForBadDebts, DevelopmentCosts, EmployeeCashAdvances (default), OtherCurrentAssets, Inventory, Investment_MortgageRealEstateLoans, Investment_Other, Investment_TaxExemptSecurities, Investment_USGovernmentObligations, LoansToOfficers, LoansToOthers, LoansToStockholders, PrepaidExpenses, Retainage, UndepositedFunds, AssetsAvailableForSale, BalWithGovtAuthorities, CalledUpShareCapitalNotPaid, ExpenditureAuthorisationsAndLettersOfCredit, GlobalTaxDeferred, GlobalTaxRefund, InternalTransfers, OtherConsumables, ProvisionsCurrentAssets, ShortTermInvestmentsInRelatedParties, ShortTermLoansAndAdvancesToRelatedParties, TradeAndOtherReceivables |
Fixed Asset | Default AccumulatedDepletion, AccumulatedDepreciation, DepletableAssets, FixedAssetComputers, FixedAssetCopiers, FixedAssetFurniture, FixedAssetPhone, FixedAssetPhotoVideo, FixedAssetSoftware, FixedAssetOtherToolsEquipment, FurnitureAndFixtures (default), Land, LeaseholdImprovements, OtherFixedAssets, AccumulatedAmortization, Buildings, IntangibleAssets, MachineryAndEquipment, Vehicles, AssetsInCourseOfConstruction, CapitalWip, CumulativeDepreciationOnIntangibleAssets, IntangibleAssetsUnderDevelopment, LandAsset, NonCurrentAssets, ParticipatingInterests, ProvisionsFixedAssets |
Other Asset | Default LeaseBuyout, OtherLongTermAssets, SecurityDeposits, AccumulatedAmortizationOfOtherAssets, Goodwill, Licenses (default), OrganizationalCosts, AssetsHeldForSale, AvailableForSaleFinancialAssets, DeferredTax, Investments, LongTermInvestments, LongTermLoansAndAdvancesToRelatedParties, OtherIntangibleAssets, OtherLongTermInvestments, OtherLongTermLoansAndAdvances, PrepaymentsAndAccruedIncome, ProvisionsNonCurrentAssets |
Accounts Receivable | Default Accounts Receivable |
EQUITY ACCOUNTS
ACCOUNT TYPE | ACCOUNT SUB TYPE |
---|---|
Equity | Default OpeningBalanceEquity (default), PartnersEquity, RetainedEarnings, AccumulatedAdjustment, OwnersEquity, PaidInCapitalOrSurplus, PartnerContributions, PartnerDistributions, PreferredStock, CommonStock, TreasuryStock, EstimatedTaxes, Healthcare, PersonalIncome, PersonalExpense, AccumulatedOtherComprehensiveIncome, CalledUpShareCapital, CapitalReserves, DividendDisbursed, EquityInEarningsOfSubsidiaries, InvestmentGrants, MoneyReceivedAgainstShareWarrants, OtherFreeReserves, ShareApplicationMoneyPendingAllotment, ShareCapital, Funds |
EXPENSE ACCOUNTS
ACCOUNT TYPE | ACCOUNT SUB TYPE |
---|---|
Expense | Default AdvertisingPromotional, BadDebts, BankCharges, CharitableContributions, CommissionsAndFees, Entertainment, EntertainmentMeals, EquipmentRental, FinanceCosts, GlobalTaxExpense, Insurance, InterestPaid, LegalProfessionalFees, OfficeExpenses, OfficeGeneralAdministrativeExpenses, OtherBusinessExpenses, OtherMiscellaneousServiceCost, PromotionalMeals, RentOrLeaseOfBuildings, RepairMaintenance, ShippingFreightDelivery, SuppliesMaterials, Travel (default), TravelMeals, Utilities, Auto, CostOfLabor, DuesSubscriptions, PayrollExpenses, TaxesPaid, UnappliedCashBillPaymentExpense, Utilities, AmortizationExpense, AppropriationsToDepreciation, BorrowingCost, CommissionsAndFees, DistributionCosts, ExternalServices, ExtraordinaryCharges, IncomeTaxExpense, LossOnDiscontinuedOperationsNetOfTax, ManagementCompensation, OtherCurrentOperatingCharges, OtherExternalServices, OtherRentalCosts, OtherSellingExpenses, ProjectStudiesSurveysAssessments, PurchasesRebates, ShippingAndDeliveryExpense, StaffCosts, Sundry, TravelExpensesGeneralAndAdminExpenses, TravelExpensesSellingExpense |
Other Expense | Default Depreciation (default), ExchangeGainOrLoss, OtherMiscellaneousExpense, PenaltiesSettlements, Amortization, GasAndFuel, HomeOffice, HomeOwnerRentalInsurance, OtherHomeOfficeExpenses, MortgageInterest, RentAndLease, RepairsAndMaintenance, ParkingAndTolls, Vehicle, VehicleInsurance, VehicleLease, VehicleLoanInterest, VehicleLoan, VehicleRegistration, VehicleRepairs, OtherVehicleExpenses, Utilities, WashAndRoadServices, DeferredTaxExpense, Depletion, ExceptionalItems, ExtraordinaryItems, IncomeTaxOtherExpense, MatCredit, PriorPeriodItems, TaxRoundoffGainOrLoss |
Cost of Goods Sold | Default EquipmentRentalCos, OtherCostsOfServiceCos, ShippingFreightDeliveryCos, SuppliesMaterialsCogs, CostOfLaborCos (default), CostOfSales, FreightAndDeliveryCost |
LIABILITY ACCOUNTS
ACCOUNT TYPE | ACCOUNT SUB TYPE |
---|---|
Accounts Payable | Default Accounts Payable, OutstandingDuesMicroSmallEnterprise, OutstandingDuesOtherThanMicroSmallEnterprise |
Credit Card | Default Credit Card |
Long Term Liability | Default NotesPayable (default), OtherLongTermLiabilities, ShareholderNotesPayable, AccrualsAndDeferredIncome, AccruedLongTermLiabilities, AccruedVacationPayable, BankLoans, DebtsRelatedToParticipatingInterests, DeferredTaxLiabilities, GovernmentAndOtherPublicAuthorities, GroupAndAssociates, LiabilitiesRelatedToAssetsHeldForSale, LongTermBorrowings, LongTermDebit, LongTermEmployeeBenefitObligations, ObligationsUnderFinanceLeases, OtherLongTermProvisions, ProvisionForLiabilities, ProvisionsNonCurrentLiabilities, StaffAndRelatedLongTermLiabilityAccounts |
Other Current Liability | Default DirectDepositPayable, LineOfCredit, LoanPayable, GlobalTaxPayable, GlobalTaxSuspense, OtherCurrentLiabilities (default), PayrollClearing, PayrollTaxPayable, PrepaidExpensesPayable, RentsInTrustLiability, TrustAccountsLiabilities, FederalIncomeTaxPayable, InsurancePayable, SalesTaxPayable, StateLocalIncomeTaxPayable, AccruedLiabilities, CurrentLiabilities, CurrentPortionEmployeeBenefitsObligations, CurrentPortionOfObligationsUnderFinanceLeases, CurrentTaxLiability, DividendsPayable, DutiesAndTaxes, InterestPayables, ProvisionForWarrantyObligations, ProvisionsCurrentLiabilities, ShortTermBorrowings, SocialSecurityAgencies, StaffAndRelatedLiabilityAccounts, SundryDebtorsAndCreditors, TradeAndOtherPayables |
REVENUE ACCOUNTS
ACCOUNT TYPE | ACCOUNT SUB TYPE |
---|---|
Income | Default NonProfitIncome, OtherPrimaryIncome (default), SalesOfProductIncome, ServiceFeeIncome, DiscountsRefundsGiven, UnappliedCashPaymentIncome, CashReceiptIncome, OperatingGrants, OtherCurrentOperatingIncome, OwnWorkCapitalized, RevenueGeneral, SalesRetail, SalesWholesale, SavingsByTaxScheme |
Other Income | Default DividendIncome, InterestEarned, OtherInvestmentIncome (default), OtherMiscellaneousIncome, TaxExemptInterest, GainLossOnSaleOfFixedAssets, GainLossOnSaleOfInvestments, LossOnDisposalOfAssets, OtherOperatingIncome, UnrealisedLossOnSecuritiesNetOfTax |
Create Credit Card Copy Link
The card entity is the exclusive method for storing credit and debit card information within the QuickBooks Payments API. It’s important to note that applications cannot automatically store data from swiped transactions.
Note: This entity can only be used for US-based QuickBooks Online companies.
See Quickbooks Card API reference.
Name* | Create Credit Card |
Connection* | Select your connection or create one. |
MAP FIELDS [+ Add Field] Select fields from list, to configure the Credit Card creation. Additional fields: Commercial Card Code, Address, IsBusiness. | |
Number* | The credit card number. |
Expiration Month* | The card’s two digit expiration month. |
Expiration Year* | The card’s four digit expiration year. |
CVC* | The Card Verification Code (CVC) on the back of the card. This can be up to four digits. The number varies by card provider. |
Name | The name of the credit or debit card holder, as it appears on the card. |
Default | True – False The date entered by the user when this transaction occurred. yyyy/MM/dd is the valid date fIndicates if the credit or debit card is the default. When users set a default, the flag is true. This is the credit or debit card QuickBooks uses when another isn’t specified. The flag defaults to false. When a credit or debit card flag is true, all other cards are automatically set to false. |
ADDITIONAL FIELDS | |
Commercial Card Code | A code that indicates if the card is a commercial or corporate card. This can be used to track specific business purchases. |
Address | The cardholder’s full address. [+ Add Field] add more fields. City: The city name for the address. Street Address: The full street adddress. This may include the house number and street name (CR acceptable). Country: The ISO-standard country code. Refer to the ISO Country Code List. Postal Code: The postal code for the address. For US and Canada, this is the zip code. Required if no region is provided. Region: Specifies the region within a country. This is the state, province, prefecture, or region name. For the US, this is the state name. For Canada, this is the province name. Required if no postal code is provided. |
IsBusiness | True – False Set to True if the Credit card is a business card. |
(*) required field
Response example from Create Credit Card
{
"updated": "2015-03-25T22:24:33Z",
"name": "Test User",
"created": "2015-03-25T22:24:33Z",
"default": false,
"number": "xxxxxxxxxxxx7893",
"expMonth": "12",
"address": {
"postalCode": "44112",
"city": "Richmond",
"region": "VA",
"streetAddress": "1245 Hana Rd",
"country": "US"
},
"expYear": "2026",
"isBusiness": false,
"id": "101101015602106732027893"
}
Create File Note Copy Link
Tip: For Any Reference fields like Customer reference, Account reference or Vendor reference, etc…, get the Value ID and Name by using Wiresk Method “List” or Trigger “Get Records by Search String” to determine the appropriate object for this reference.
See Quickbooks Attachable note API reference.
Name* | Create File Note |
Connection* | Select your connection or create one. |
Entity* | Set to File |
Note* max 2000 chars | Enter the note. |
MAP FIELDS | |
Attachable Reference* | Specifies the transaction object to which this attachable file is to be linked. [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional custom field can be added as elements. Element 1: Represents the first Attachable Reference. IncludeOnSend*: True – False Indicates whether or not the attachment is sent with the transaction when Save and Send button is clicked in the QuickBooks UI or when the Send endpoint (send email) is invoked for the object. EntityRef*: _Type*: Specify type of the target object Customer – Vendor – Employee – Invoice – Estimate – SalesReceipt – Bill –Payment – CreditMemo – RefundReceipt. _Value*: The ID for the referenced attachable. |
(*) required field
Response example from Create File Note
{
"Attachable": {
"SyncToken": "0",
"domain": "QBO",
"AttachableRef": [
{
"IncludeOnSend": false,
"EntityRef": {
"type": "Invoice",
"value": "95"
}
}
],
"Note": "This is an attached note.",
"sparse": false,
"Id": "200900000000000008541",
"MetaData": {
"CreateTime": "2015-11-17T11:05:15-08:00",
"LastUpdatedTime": "2015-11-17T11:05:15-08:00"
}
},
"time": "2015-11-17T11:05:15.797-08:00"
}
Delete Copy Link
Tip: Use Wiresk Method “List” or Trigger “Get Records by Search String” to get the IDs.
This Method allows you to delete:
Invoice, Payment, Journal Entry, Bill, Sale Receipt, Estimate, Deposit, Credit Memo, Purchase Order, Purchase, Time Activity, Refund Receipt, File.
⚠️ If you need to delete an account, set the Active attribute to false in the Upsert Method. This makes it inactive. The account itself isn’t permanently deleted, but is hidden for display purposes. References to inactive objects remain intact.
Configuration Table:
Input Options:
- Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
- Default Value: You can specify a fixed attribute.
Name* | Delete |
Connection* | Select your connection or create one. |
Entity* (Set of data that contain records) | Select the available Entity to delete records: Invoice, Payment, Journal Entry, Bill, Sale Receipt, Estimate, Deposit, Credit Memo, Purchase Order, Purchase, Time Activity, Refund Receipt, File. |
MATCHING CRITERIA | |
ID* | Unique Identifier of the Entity record to delete. |
(*) required field
Response example from Delete (Void) Invoice
{
"Invoice": {
"AllowOnlineACHPayment": false,
"domain": "QBO",
"TxnDate": "2014-11-09",
"PrintStatus": "NEED_TO_PRINT",
"SalesTermRef": {
"value": "3"
},
"TotalAmt": 0,
"Line": [
{
"Description": "Sod",
"DetailType": "SALES_ITEM_LINE_DETAIL",
"SalesItemLineDetail": {
"TaxCodeRef": {
"value": "TAX"
},
"Qty": 0,
"ItemRef": {
"name": "Sod",
"value": "14"
}
},
"LineNum": 1,
"Amount": 0,
"Id": "1"
},
{
"Description": "2 cubic ft. bag",
"DetailType": "SALES_ITEM_LINE_DETAIL",
"SalesItemLineDetail": {
"TaxCodeRef": {
"value": "TAX"
},
"Qty": 0,
"ItemRef": {
"name": "Soil",
"value": "15"
}
},
"LineNum": 2,
"Amount": 0,
"Id": "2"
},
{
"Description": "Weekly Gardening Service",
"DetailType": "SALES_ITEM_LINE_DETAIL",
"SalesItemLineDetail": {
"TaxCodeRef": {
"value": "NON"
},
"Qty": 0,
"ItemRef": {
"name": "Gardening",
"value": "6"
}
},
"LineNum": 3,
"Amount": 0,
"Id": "3"
},
{
"Description": "Rock Fountain",
"DetailType": "SALES_ITEM_LINE_DETAIL",
"SalesItemLineDetail": {
"TaxCodeRef": {
"value": "TAX"
},
"Qty": 0,
"ItemRef": {
"name": "Rock Fountain",
"value": "5"
}
},
"LineNum": 4,
"Amount": 0,
"Id": "4"
},
{
"Description": "Fountain Pump",
"DetailType": "SALES_ITEM_LINE_DETAIL",
"SalesItemLineDetail": {
"TaxCodeRef": {
"value": "TAX"
},
"Qty": 0,
"ItemRef": {
"name": "Pump",
"value": "11"
}
},
"LineNum": 5,
"Amount": 0,
"Id": "5"
},
{
"DetailType": "SUB_TOTAL_LINE_DETAIL",
"Amount": 0,
"SubTotalLineDetail": {}
}
],
"DueDate": "2014-12-09",
"MetaData": {
"CreateTime": "2014-11-09T13:15:36-08:00",
"LastUpdatedTime": "2016-03-16T12:27:10-07:00"
},
"DocNumber": "1036",
"PrivateNote": "Voided",
"sparse": false,
"CustomerMemo": {
"value": "Thank you for your business and have a great day!"
},
"ProjectRef": {
"value": "39298045"
},
"Deposit": 0,
"Balance": 0,
"CustomerRef": {
"name": "0969 Ocean View Road",
"value": "8"
},
"TxnTaxDetail": {
"TotalTax": 0
},
"AllowOnlineCreditCardPayment": false,
"SyncToken": "1",
"LinkedTxn": [],
"BillEmail": {
"Address": "Sporting_goods@intuit.com"
},
"ShipAddr": {
"City": "Middlefield",
"Line1": "370 Easy St.",
"PostalCode": "94482",
"Lat": "37.4031672",
"Long": "-122.0642815",
"CountrySubDivisionCode": "CA",
"Id": "8"
},
"EmailStatus": "NOT_SET",
"BillAddr": {
"Line4": "Middlefield, CA 94482",
"Line3": "370 Easy St.",
"Line2": "Freeman Sporting Goods",
"Line1": "Sasha Tillou",
"Long": "INVALID",
"Lat": "INVALID",
"Id": "94"
},
"ApplyTaxAfterDiscount": false,
"CustomField": [
{
"DefinitionId": "1",
"StringValue": "105",
"Type": "STRING_TYPE",
"Name": "Crew #"
}
],
"Id": "129",
"AllowOnlinePayment": false,
"AllowIPNPayment": false
},
"time": "2016-03-16T12:27:10.711-07:00"
}
Download Copy Link
Tip: Use Wiresk Method “List” or Trigger “Get Records by Search String” to get the IDs.
This Method allows you to download:
Invoice, Payment, Sale Receipt, Estimate, File.
Configuration Table:
Input Options:
- Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
- Default Value: You can specify a fixed attribute.
Name* | Download |
Connection* | Select your connection or create one. |
Entity* (Set of data that contain records) | Select the available Entity to download the document: Invoice, Payment, Sale Receipt, Estimate, File. |
MATCHING CRITERIA | |
ID* | Unique Identifier of the Entity. |
(*) required field
Response example from Download Invoice
{
"file": "(Base64 String)...JVBERi0xjEyIDc5Ml0vUmVzb3VyY2VzPDwvRm9udDw8L0ZBQUFBSCA3IDAgUiysxGDQo="
}
Find Copy Link
▪️ Search invoice by DocNumber only.
▪️ Search Item by ID, if string (text) is entered, the Method will search in the name field.
▪️ Search other Entities by ID.
Tip: Use Wiresk Method “List” or Trigger “Get Records by Search String” to get the IDs.
Configuration Table:
Input Options:
- Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
- Default Value: You can specify a fixed attribute.
Name* | Find |
Connection* | Select your connection or create one. |
Entity* (Set of data that contain records) | Select the available Entity to retrieve data from: Invoice, Item, Payment, Journal Entry, Bill, Sale Receipt, Estimate, Deposit, Credit Memo, Purchase Order, Customer, Vendor, Account, Purchase, Time Activity, Refund Receipt. |
MATCHING CRITERIA | |
Search* | Unique Identifier of the Entity. |
(*) required field
Response example from Find Invoice
{
"QueryResponse": {
"startPosition": 1,
"totalCount": 1,
"maxResults": 1,
"Invoice": [
{
"TxnDate": "2015-07-24",
"domain": "QBO",
"PrintStatus": "NeedToPrint",
"TotalAmt": 150.0,
"Line": [
{
"LineNum": 1,
"Amount": 150.0,
"SalesItemLineDetail": {
"TaxCodeRef": {
"value": "NON"
},
"ItemRef": {
"name": "Services",
"value": "1"
}
},
"Id": "1",
"DetailType": "SalesItemLineDetail"
},
{
"DetailType": "SubTotalLineDetail",
"Amount": 150.0,
"SubTotalLineDetail": {}
}
],
"DueDate": "2015-08-23",
"ApplyTaxAfterDiscount": false,
"DocNumber": "1070",
"sparse": false,
"ProjectRef": {
"value": "39298034"
},
"Deposit": 0,
"Balance": 150.0,
"CustomerRef": {
"name": "Amy's Bird Sanctuary",
"value": "1"
},
"TxnTaxDetail": {
"TotalTax": 0
},
"SyncToken": "0",
"LinkedTxn": [],
"ShipAddr": {
"City": "Bayshore",
"Line1": "4581 Finch St.",
"PostalCode": "94326",
"Lat": "INVALID",
"Long": "INVALID",
"CountrySubDivisionCode": "CA",
"Id": "109"
},
"EmailStatus": "NotSet",
"BillAddr": {
"City": "Bayshore",
"Line1": "4581 Finch St.",
"PostalCode": "94326",
"Lat": "INVALID",
"Long": "INVALID",
"CountrySubDivisionCode": "CA",
"Id": "2"
},
"MetaData": {
"CreateTime": "2015-07-24T10:35:08-07:00",
"LastUpdatedTime": "2015-07-24T10:35:08-07:00"
},
"CustomField": [
{
"DefinitionId": "1",
"Type": "StringType",
"Name": "Crew #"
}
],
"Id": "239"
}
]
},
"time": "2015-07-24T10:38:50.01-07:00"
}
List Copy Link
Tip: Use Wiresk Method “List” or Trigger “Get Records by Search String” to get the IDs.
Configuration Table:
Input Options:
- Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
- Default Value: You can specify a fixed attribute.
Name* | List |
Connection* | Select your connection or create one. |
Entity* (Set of data that contain records) | Select the available Entity to retrieve data from: Invoice, Item, Payment, Journal Entry, Bill, Sale Receipt, Estimate, Deposit, Credit Memo, Purchase Order, Customer, Vendor, Account, Purchase, Time Activity, Refund Receipt. |
MATCHING CRITERIA | |
Page* | Define the page number of retrieve records. |
Limit* | Define Maximum record per page. |
(*) required field
Response example from List Invoice
[
{
"Id": "155",
"SyncToken": "2",
"MetaData": {
"CreatedByRef": null,
"CreateTime": "2024-05-23T03:19:00-07:00",
"LastModifiedByRef": "9130357435627626",
"LastUpdatedTime": "2025-02-16T22:41:33-08:00",
"LastChangedInQB": null,
"Synchronized": null
},
"CustomField": null,
"AttachableRef": null,
"domain": null,
"status": null,
"sparse": null,
"DocNumber": "1042",
"TxnDate": "2024-05-23",
"DepartmentRef": null,
"CurrencyRef": "USD",
"ExchangeRate": null,
"PrivateNote": null,
"TxnStatus": null,
"LinkedTxn": null,
"Line": [
{
"Id": "1",
"LineNum": "1",
"Description": "Option 330ml -> Qty:1,Amount:2.0000",
"Amount": "20.00",
"Received": null,
"LinkedTxn": null,
"DetailType": "SalesItemLineDetail",
"PaymentLineDetail": null,
"DiscountLineDetail": null,
"TaxLineDetail": null,
"SalesItemLineDetail": {
"ItemRef": "20",
"ClassRef": null,
"UnitPrice": null,
"UnitCostPrice": null,
"RatePercent": null,
"PriceLevelRef": null,
"MarkupInfo": null,
"Qty": "1",
"UOMRef": null,
"ItemAccountRef": "7",
"InventorySiteRef": null,
"TaxCodeRef": "NON",
"TaxClassificationRef": null,
"ServiceDate": null,
"TaxInclusiveAmt": null,
"DiscountRate": null,
"DiscountAmt": null,
"DeferredRevenue": null,
"SalesItemLineDetailEx": null
},
"DescriptionLineDetail": null,
"ItemBasedExpenseLineDetail": null,
"AccountBasedExpenseLineDetail": null,
"ReimburseLineDetail": null,
"DepositLineDetail": null,
"PurchaseOrderItemLineDetail": null,
"SalesOrderItemLineDetail": null,
"ItemReceiptLineDetail": null,
"JournalEntryLineDetail": null,
"GroupLineDetail": null,
"SubTotalLineDetail": null,
"TDSLineDetail": null,
"ItemAdjustmentLineDetail": null,
"CustomField": null,
"LineEx": null,
"ProjectRef": null,
"CostAmount": null,
"HomeCostAmount": null
},
{
"Id": "2",
"LineNum": "2",
"Description": null,
"Amount": "1.00",
"Received": null,
"LinkedTxn": null,
"DetailType": "SalesItemLineDetail",
"PaymentLineDetail": null,
"DiscountLineDetail": null,
"TaxLineDetail": null,
"SalesItemLineDetail": {
"ItemRef": "20",
"ClassRef": null,
"UnitPrice": null,
"UnitCostPrice": null,
"RatePercent": null,
"PriceLevelRef": null,
"MarkupInfo": null,
"Qty": "1",
"UOMRef": null,
"ItemAccountRef": "7",
"InventorySiteRef": null,
"TaxCodeRef": "NON",
"TaxClassificationRef": null,
"ServiceDate": null,
"TaxInclusiveAmt": null,
"DiscountRate": null,
"DiscountAmt": null,
"DeferredRevenue": null,
"SalesItemLineDetailEx": null
},
"TxnTaxDetail": {
"DefaultTaxCodeRef": null,
"TxnTaxCodeRef": null,
"TotalTax": "0",
"TaxReviewStatus": null,
"TaxLine": null,
"UseAutomatedSalesTax": null
},
"TxnSource": null,
"TaxFormType": null,
"TaxFormNum": null,
"TransactionLocationType": null,
"Tag": null,
"TxnApprovalInfo": null,
"RecurDataRef": null,
"RecurringInfo": null,
"ProjectRef": null,
"TotalCostAmount": null,
"HomeTotalCostAmount": null,
"AutoDocNumber": null,
"CustomerRef": "64",
"CustomerMemo": null,
"BillAddr": null,
"ShipAddr": null,
"FreeFormAddress": "false",
"ShipFromAddr": {
"Id": "100",
"Line1": "123 Sierra Way",
"Line2": "San Pablo, CA 87999",
"Line3": null,
"Line4": null,
"Line5": null,
"City": null,
"Country": null,
"CountryCode": null,
"County": null,
"CountrySubDivisionCode": null,
"PostalCode": null,
"PostalCodeSuffix": null,
"Lat": null,
"Long": null,
"Tag": null,
"Note": null
},
"RemitToRef": null,
"ClassRef": null,
"SalesTermRef": null,
"DueDate": "2024-06-22",
"SalesRepRef": null,
"PONumber": null,
"FOB": null,
"ShipMethodRef": null,
"ShipDate": null,
"TrackingNum": null,
"GlobalTaxCalculation": null,
"TotalAmt": "584.34",
"HomeTotalAmt": null,
"ApplyTaxAfterDiscount": "false",
"ShippingTaxIncludedInTotalTax": null,
"TemplateRef": null,
"PrintStatus": "NeedToPrint",
"EmailStatus": "NotSet",
"BillEmail": null,
"BillEmailCc": null,
"BillEmailBcc": null,
"ARAccountRef": null,
"Balance": "584.34",
"HomeBalance": null,
"FinanceCharge": null,
"PaymentMethodRef": null,
"PaymentRefNum": null,
"PaymentType": null,
"CheckPayment": null,
"CreditCardPayment": null,
"DepositToAccountRef": null,
"DeliveryInfo": null,
"DiscountRate": null,
"DiscountAmt": null,
"GovtTxnRefIdentifier": null,
"TaxExemptionRef": null,
"Deposit": null,
"AllowIPNPayment": "false",
"AllowOnlinePayment": "false",
"AllowOnlineCreditCardPayment": "false",
"AllowOnlineACHPayment": "false",
"AllowOnlinePayPalPayment": null,
"EInvoiceStatus": null,
"ECloudStatusTimeStamp": null,
"CfdiUse": null,
"Exportation": null,
"GlobalInfo": null,
"invoiceStatus": null,
"callToAction": null,
"invoiceStatusLog": null,
"InvoiceEx": null,
"LessCIS": null,
"InvoiceLink": null,
"PaymentDetailsMessage": null,
"ConvenienceFeeDetail": null,
"InvoiceLinkSecurityCode": null,
"InvoiceLinkExpiryDate": null,
"AutoPayEligible": null,
"SchedulePayEligible": null,
"ScheduledPaymentId": null,
"GratuityEnabled": null,
"FinancingProductType": null,
"SubscriptionPaymentsSetting": null
}
]
Send Email Copy Link
Tip: Use Wiresk Method “List” or Trigger “Get Records by Search String” to get the IDs.
Note:
▪️ The
EmailStatus
parameter is marked as EmailSent
.▪️ The Invoice.DeliveryInfo
element is populated with sending details such as:"DeliveryInfo": {
"DeliveryType": "Email",
"DeliveryTime": "2014-12-17T11:50:52-08:00"
▪️ The Invoice
BillEmailAddress
parameter is modified to reflect the specified address from this Method. Configuration Table:
Input Options:
- Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
- Default Value: You can specify a fixed attribute.
Name* | Send Email |
Connection* | Select your connection or create one. |
Entity* (Set of data that contain records) | Select the available Entity to send to an email address: Invoice, Payment, Sale Receipt, Estimate. |
MAP FIELDS | |
ID* | Identifier of the the entity. |
Email* | Email address to send to. |
(*) required field
Response example from Send Email
{
"Invoice": {
"TxnDate": "2013-03-14",
"domain": "QBO",
"CurrencyRef": {
"name": "United States Dollar",
"value": "USD"
},
"ShipDate": "2013-03-01",
"TrackingNum": "123456789",
"ClassRef": {
"name": "Class 1",
"value": "200900000000000003901"
},
"PrintStatus": "NeedToPrint",
"SalesTermRef": {
"value": "4"
},
"DeliveryInfo": {
"DeliveryType": "Email",
"DeliveryTime": "2014-12-17T11:50:52-08:00"
},
"TotalAmt": 52.0,
"Line": [
{
"Description": "Sample invoice create request",
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"TaxCodeRef": {
"value": "TAX"
},
"Qty": 1,
"UnitPrice": 50,
"ServiceDate": "2013-03-04",
"ItemRef": {
"name": "Hours",
"value": "2"
}
},
"LineNum": 1,
"Amount": 50.0,
"Id": "1"
},
{
"DetailType": "SubTotalLineDetail",
"Amount": 50.0,
"SubTotalLineDetail": {}
},
{
"DetailType": "DiscountLineDetail",
"Amount": 5.0,
"DiscountLineDetail": {
"DiscountAccountRef": {
"name": "Discounts given",
"value": "30"
},
"PercentBased": true,
"DiscountPercent": 10
}
},
{
"DetailType": "SalesItemLineDetail",
"Amount": 2.0,
"SalesItemLineDetail": {
"ItemRef": {
"value": "SHIPPING_ITEM_ID"
}
}
}
],
"DueDate": "2013-05-13",
"MetaData": {
"CreateTime": "2013-03-14T01:42:16-07:00",
"LastUpdatedTime": "2014-12-17T11:50:58-08:00"
},
"DocNumber": "Sample_Inv#2",
"PrivateNote": "Summary for sample invoice",
"sparse": false,
"DepositToAccountRef": {
"name": "Undeposited Funds",
"value": "4"
},
"CustomerMemo": {
"value": "This is the customer message"
},
"EmailStatus": "EmailSent",
"ProjectRef": {
"value": "39298037"
},
"Deposit": 12.0,
"Balance": 40.0,
"CustomerRef": {
"name": "Mr V3 Service Customer Jr2",
"value": "15"
},
"TxnTaxDetail": {
"TxnTaxCodeRef": {
"value": "5"
},
"TotalTax": 5.0,
"TaxLine": [
{
"DetailType": "TaxLineDetail",
"Amount": 5.0,
"TaxLineDetail": {
"NetAmountTaxable": 50.0,
"TaxPercent": 10,
"TaxRateRef": {
"value": "2"
},
"PercentBased": true
}
}
]
},
"SyncToken": "0",
"BillEmail": {
"Address": "test@intuit.com"
},
"ShipAddr": {
"City": "San Jose",
"Country": "USA",
"Line5": "Cube 999",
"Line4": "Dept 12",
"Line3": "123 street",
"Line2": "Building 1",
"Line1": "Intuit",
"PostalCode": "95123",
"Lat": "37.2374847",
"Long": "-121.8277925",
"CountrySubDivisionCode": "CA",
"Id": "36"
},
"DepartmentRef": {
"name": "Mountain View",
"value": "1"
},
"ShipMethodRef": {
"name": "UPS",
"value": "UPS"
},
"BillAddr": {
"City": "Mountain View",
"Country": "USA",
"Line5": "Cube 999",
"Line4": "Dept 12",
"Line3": "123 street",
"Line2": "Building 1",
"Line1": "Google",
"PostalCode": "95123",
"Lat": "37.2374847",
"Long": "-121.8277925",
"CountrySubDivisionCode": "CA",
"Id": "35"
},
"ApplyTaxAfterDiscount": false,
"CustomField": [
{
"StringValue": "Custom1",
"Type": "StringType",
"Name": "Custom 1"
},
{
"StringValue": "Custom2",
"Type": "StringType",
"Name": "Custom 2"
},
{
"StringValue": "Custom3",
"Type": "StringType",
"Name": "Custom 3"
}
],
"Id": "96"
},
"time": "2013-03-14T13:32:04.895-07:00"
}
Upload File Copy Link
⚠️ Convert your file into a base64 string beforehand.
This Method allows you to upload files that must not exceed 100 MB in size.
Supported File Type:
Ai, csv, doc, docx, eps, gif, jpeg, jpg, ods, pdf, png, rtf ,tif, txt, xls, xlsx, xml
Configuration Table:
Input Options:
- Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
- Default Value: You can specify a fixed attribute.
Name* | Upload File |
Connection* | Select your connection or create one. |
Entity* (Set of data that contain records) | Select the available Entity to download the document: Invoice, Payment, Sale Receipt, Estimate, File. |
MAP FIELDS | |
File* Base64 encoding file. | File Name: name of the encoded file Extension: extension of the encoded file, e.g., docx. Content: String of the base64 encoded file. |
Attachable Reference* | Specifies the transaction object to which this attachable file is to be linked. [⊕ Element][⊕ Map] Add fields or Map it from a Data Source. See Field Mapping. Additional custom field can be added as elements. Element 1: Represents the first Attachable Reference. EntityRef*: _Type*: Specify type of the target object Customer – Vendor – Employee – Invoice – Estimate – SalesReceipt – Bill –Payment – CreditMemo – RefundReceipt. _Value*: The ID for the referenced attachable. IncludeOnSend*: True – False Indicates whether or not the attachment is sent with the transaction when Save and Send button is clicked in the QuickBooks UI or when the Send endpoint (send email) is invoked for the object. |
(*) required field
Response example from Upload a file
{
"AttachableResponse": [
{
"Attachable": {
"SyncToken": "0",
"domain": "QBO",
"FileAccessUri": "...",
"ThumbnailFileAccessUri": "...",
"AttachableRef": [
{
"IncludeOnSend": false,
"EntityRef": {
"type": "Invoice",
"value": "95"
}
}
],
"TempDownloadUri": "https://...",
"MetaData": {
"CreateTime": "2015-11-16T10:59:02-08:00",
"LastUpdatedTime": "2015-11-16T10:59:02-08:00"
},
"sparse": false,
"ContentType": "image/jpeg",
"FileName": "receipt_nov15.jpg",
"Id": "100000000004190865",
"Size": 1594261
}
}
],
"time": "2015-11-16T10:58:58.100-08:00"
}
5 – Test run or automate your Flow Copy Link
After setting up your Flow, you can choose to:
- “Run once”, your Flow will run only a single time. You can use this function to test your Flow. Refer to how to set up an HTTP Trigger, in the “Create a Flow” step.
- “Run Scheduler” will automate your Flows with the recurrence rule you previously defined.
For more details, refer to How to run a Flow tutorial in our Help Center.
If you are using a Webhook Trigger, the Flow will initiate automatically when a webhook is received from your connected apps. This means that the Flow is automated without a scheduler and will run until you deactivate the Flow manually. Refer to Webhook documentation in our Help Center.
If you need an integration that you cannot find in Wiresk, you can make a request to our team, and we will try our best to satisfy your needs.