QuickBooks
QuickBooks is a full-featured business and financial management suite complete with tools for accounting, inventory, payroll, tax filing, and invoicing platforms for individuals and businesses.
The QuickBooks Sandbox allows developers to develop and test integrations without affecting real customer data. You can point your integrations at this sandbox as you assemble them.
Authorization
OAuth 2.0
QuickBooks uses OAuth 2.0 to authenticate requests against the Quickbooks Online API. To configure an OAuth 2.0 credential through Quickbooks, you will need to create an app within the Intuit developer portal. When you create your app, be sure to enter Sapper OAuth callback URL Sapper- as a Callback URL. Consult Quickbooks to determine the proper OAuth Scopes to assign. Once the app has been created, you will be provided with a Client ID and Client Secret. Now, configure OAuth 2.0 settings in Prismatic. Create a new credential of type OAuth 2.0 - Authorization Code.
Enter the Client ID and Client Secret that you received from the Intuit developer portal.
Set Scopes to any of the values in this list.
Input | Key | Examples |
|---|---|---|
Authorize URL | The OAuth 2.0 Authorization URL for Quickbooks | |
Client ID
| The Client ID is a public identifier of your application. |
|
Client Secret
| The Client Secret is confidential and should only be used to authenticate your application and make requests to APIs.
|
|
Revoke URL | The OAuth 2.0 Revocation URL for Quickbooks | |
Scopes
| A space-delimited set of one or more scopes to get the user's permission to access. |
|
Token URL | The OAuth 2.0 Token URL for Quickbooks | |
Use Sandbox
| Choose whether or not to use QuickBooks' sandbox. This is helpful for integration testing. |
|
QuickBooks Connections
QuickBooks OAuth2.0 Connection
Input | Key | Description | Example |
Select Application | application | Select QuickBooks application |
|
Connection Type | connection type | Select the type of connection. | REST |
REST Connection Type | rest connection type | Select the type of REST connection. | OAuth2.0 |
Connection Name | name | Provide a name for the connection. | QuickBooks connection |
Connection Description | description | Provide a description for the connection. |
|
Host Name | host | Provide a string value for the URL of the user's QuickBooks account. |
|
Grant Type | grant type | Provide the grant type - authorization code, password, client credentials. |
|
Actions
Create Customer in QuickBooks
Create customer in QuickBooks | key: createCustomer
Input | Key | Description | Example |
|---|---|---|---|
Bill address | bill address | It is an address that one makes the payment of the goods or services. | 123 Main Street, Somewhere, CA 94000 |
Display Name | display name | A display name is how you want to be known to the community. It can be different from your real name. It is often consisted of a first name and potentially last name. |
|
Primary Phone | primary phone | Provide the primary phone number. | +12163547758 |
Primary email Address | primary email id | Primary email id is a unique address oathe users used for sending emails. | |
Company Id | company id | A company id is the unique identifier used to match a user's login to your organization, and can be the name of your company, an abbreviation, or any combination of letters and numbers. |
|
Get Employees in QuickBooks
Get employees in QuickBooks | key: getEmployees
Input | Key | Description | Example |
|---|---|---|---|
Company Id | company id | A company id is the unique identifier used to match a user's login to your organization, and can be the name of your company, an abbreviation, or any combination of letters and numbers. |
|
Get Customer
Get customer | key: getCustomer
Input | Key | Description | Example |
|---|---|---|---|
Company Id | company id | A company id is the unique identifier used to match a user's login to your organization, and can be the name of your company, an abbreviation, or any combination of letters and numbers. |
|
Get Employee by ID
Get employee by id | key: getEmployeebyID
Input | Key | Description | Example |
|---|---|---|---|
Company Id | company id | A company id is the unique identifier used to match a user's login to your organization, and can be the name of your company, an abbreviation, or any combination of letters and numbers. |
|
Employee Id | employee id | It is a unique identification number that is assigned to a business entity for easy identification by the other department. It can be a number or a combination of letters, numbers, and other symbols. |
|
Create Sales Receipt
Create sales receipt | key: createSalesreceipt
Input | Key | Description | Example |
|---|---|---|---|
Receipt Id | receiptID | The receipt id is the key field that uniquely identifies a tax receipt entry record in the transaction file. The field is a merged combination of the transaction id number in the first four digits and the file identification suffix in the last two digits. |
|
Line Number | lineNumber | A line number is a method used to specify a particular sequence of characters in a text file. |
|
Description | description | Description is a statement that gives details about something. |
|
Amount | amount | Mention the required amount. |
|
Sales Type | salesType | Provide the sales type. |
|
Item Value | item value | Item of value means an item, or an instrument that can be used to obtain cash, or any other thing of value. |
|
Item Name | itemName | Mention the appropriate name of the Item |
|
Item unit price | itemUnitprice | The unit price of an item is the cost per unit of the item. |
|
Quantity | quantity | Quantity is defined ,as an amount, measure or number. |
|
Account Name | accountName | An account name is a name of a person authorized to have an account, using specific personal information. |
|
Account Value | accountValue | An account value is known as total equity. |
|
Tax Code | taxCode | A tax code is a federal government document, usually numbering thousands of pages, that details the rules individuals and businesses must follow in remitting a percentage of their incomes to the federal or state government. |
|
Company Id | companyID | A company id is the unique identifier used to match a user's login to your organization, and can be the name of your company, an abbreviation, or any combination of letters and numbers. |
|
Update Sales Receipt
Update sales receipt | key: updateSalesreceipt
Input | Key | Description | Example |
|---|---|---|---|
Receipt Id | receiptID | The receipt id is the key field that uniquely identifies a tax receipt entry record in the transaction file. The field is a merged combination of the transaction id number in the first four digits and the file identification suffix in the last two digits. |
|
Sync Token | syncToken | Synchronization provides a secure mechanism through which the server and token can automatically resynchronize when a user authenticates. |
|
Line Id | lineID | A line id is an unique identification used to specify a particular sequence of characters or line. |
|
Line Number | lineNumber | A line number is a method used to specify a particular sequence of characters in a text file. |
|
Description | description | Description is a statement that gives details about something. |
|
Amount | amount | Mention the required amount. |
|
Sales Type | salesType | Provide the sales type. |
|
Item Value | item value | Item of value means an item, or an instrument that can be used to obtain cash, or any other thing of value. |
|
Item Name | itemName | Mention the appropriate name of the Item |
|
Item unit price | itemUnitprice | The unit price of an item is the cost per unit of the item. |
|
Item Quantity | itemQuantity | Item quantity is defined as an amount, measure or number of the entity. |
|
Tax Code | taxCode | A tax code is a federal government document, usually numbering thousands of pages, that details the rules individuals and businesses must follow in remitting a percentage of their incomes to the federal or state government. |
|
Company Id | companyID | A company id is the unique identifier used to match a user's login to your organization, and can be the name of your company, an abbreviation, or any combination of letters and numbers. |
|
Get Sales Receipt by ID
Get sales receipt by id | key: getSalesReceiptbyID
Input | Key | Description | Example |
|---|---|---|---|
Receipt Id | receiptID | The receipt id is the key field that uniquely identifies a tax receipt entry record in the transaction file. The field is a merged combination of the transaction id number in the first four digits and the file identification suffix in the last two digits. |
|
Company Id | companyID | A company id is the unique identifier used to match a user's login to your organization, and can be the name of your company, an abbreviation, or any combination of letters and numbers. |
|