QuickBooks

QuickBooks is an accounting software package developed and marketed by Intuit. It is geared mainly toward small and medium-sized businesses and offers on-premises accounting applications as well as cloud-based versions that accept business payments, manage and pay bills, and payroll functions.

Categories: Accounting

Type: quickbooks/v1

Connections

Version: 1

OAuth2 Authorization Code

Properties

Name	Label	Type	Description	Required
base	Base	STRING Options https://sandbox-quickbooks.api.intuit.com, https://quickbooks.api.intuit.com	The base URL for Quickbooks.	true
companyId	Company Id	STRING	To get the company id, go to your dashboard. On the top right corner press the gear logo and click Additional information. There you will see your company ID.	true
clientId	Client Id	STRING		true
clientSecret	Client Secret	STRING		true

Actions

Create Category

Name: createCategory

Creates a new category.

Properties

Name	Label	Type	Description	Required
name	Name	STRING	Name of the category.	true

Example JSON Structure

{
  "label" : "Create Category",
  "name" : "createCategory",
  "parameters" : {
    "name" : ""
  },
  "type" : "quickbooks/v1/createCategory"
}

Output

Type: OBJECT

Properties

Name	Type	Description
item	OBJECT Properties {STRING(domain), STRING(id), STRING(name), STRING(active), STRING(fullyQualifiedName), STRING(type)}

Output Example

{
  "item" : {
    "domain" : "",
    "id" : "",
    "name" : "",
    "active" : "",
    "fullyQualifiedName" : "",
    "type" : ""
  }
}

Create Customer

Name: createCustomer

Creates a new customer.

Properties

Name	Label	Type	Description	Required
displayName	Display Name	STRING	The name of the person or organization as displayed.	true
givenName	First Name	STRING	Given name or first name of a person.	false
familyName	Last Name	STRING	Family name or the last name of the person.	false
suffix	Suffix	STRING	Suffix of the name.	false
title	Title	STRING	Title of the person.	false
middleName	Middle Name	STRING	Middle name of the person.	false

Example JSON Structure

{
  "label" : "Create Customer",
  "name" : "createCustomer",
  "parameters" : {
    "displayName" : "",
    "givenName" : "",
    "familyName" : "",
    "suffix" : "",
    "title" : "",
    "middleName" : ""
  },
  "type" : "quickbooks/v1/createCustomer"
}

Output

Type: OBJECT

Properties

Name	Type	Description
customer	OBJECT Properties {STRING(domain), STRING(id), STRING(title), STRING(givenName), STRING(middleName), STRING(familyName), STRING(suffix), STRING(fullyQualifiedName), STRING(displayName), STRING(active)}

Output Example

{
  "customer" : {
    "domain" : "",
    "id" : "",
    "title" : "",
    "givenName" : "",
    "middleName" : "",
    "familyName" : "",
    "suffix" : "",
    "fullyQualifiedName" : "",
    "displayName" : "",
    "active" : ""
  }
}

Create Item

Name: createItem

Creates a new item.

Properties

Name	Label	Type	Description	Required
name	Name	STRING	Name of the item.	true
type	Type	STRING Options INVENTORY, SERVICE, NON_INVENTORY	Type of item.	true
account		DYNAMIC_PROPERTIES Depends On type		null
expenseAccountRef	Expense Account	STRING		true
qtyOnHand	Quantity on Hand	NUMBER	Current quantity of the inventory items available for sale.	true

Example JSON Structure

{
  "label" : "Create Item",
  "name" : "createItem",
  "parameters" : {
    "name" : "",
    "type" : "",
    "account" : { },
    "expenseAccountRef" : "",
    "qtyOnHand" : 0.0
  },
  "type" : "quickbooks/v1/createItem"
}

Output

Type: OBJECT

Properties

Name	Type	Description
item	OBJECT Properties {STRING(domain), STRING(id), STRING(name), STRING(active), STRING(fullyQualifiedName), STRING(type), {STRING(name)}(incomeAccountRef), {STRING(name)}(assetAccountRef), {STRING(name)}(expenseAccountRef)}

Output Example

{
  "item" : {
    "domain" : "",
    "id" : "",
    "name" : "",
    "active" : "",
    "fullyQualifiedName" : "",
    "type" : "",
    "incomeAccountRef" : {
      "name" : ""
    },
    "assetAccountRef" : {
      "name" : ""
    },
    "expenseAccountRef" : {
      "name" : ""
    }
  }
}

Create Payment

Name: createPayment

Creates a new payment.

Properties

Name	Label	Type	Description	Required
customer	Customer	STRING		true
totalAmt	Total Amount	NUMBER	Total amount of the transaction.	true

Example JSON Structure

{
  "label" : "Create Payment",
  "name" : "createPayment",
  "parameters" : {
    "customer" : "",
    "totalAmt" : 0.0
  },
  "type" : "quickbooks/v1/createPayment"
}

Output

Type: OBJECT

Properties

Name	Type	Description
payment	OBJECT Properties {STRING(domain), STRING(id), {STRING(name)}(CurrencyRef), {STRING(name)}(customerRef), STRING(totalAmt)}

Output Example

{
  "payment" : {
    "domain" : "",
    "id" : "",
    "CurrencyRef" : {
      "name" : ""
    },
    "customerRef" : {
      "name" : ""
    },
    "totalAmt" : ""
  }
}

Get Customer

Name: getCustomer

Gets details about a specific customer.

Properties

Name	Label	Type	Description	Required
customer	Customer ID	STRING	ID of the customer to get.	true

Example JSON Structure

{
  "label" : "Get Customer",
  "name" : "getCustomer",
  "parameters" : {
    "customer" : ""
  },
  "type" : "quickbooks/v1/getCustomer"
}

Output

Type: OBJECT

Properties

Name	Type	Description
customer	OBJECT Properties {STRING(domain), STRING(id), STRING(title), STRING(givenName), STRING(middleName), STRING(familyName), STRING(suffix), STRING(fullyQualifiedName), STRING(displayName), STRING(active)}

Output Example

{
  "customer" : {
    "domain" : "",
    "id" : "",
    "title" : "",
    "givenName" : "",
    "middleName" : "",
    "familyName" : "",
    "suffix" : "",
    "fullyQualifiedName" : "",
    "displayName" : "",
    "active" : ""
  }
}

Get Invoice

Name: getInvoice

Gets details about a specific invoice.

Properties

Name	Label	Type	Description	Required
invoice	Invoice ID	STRING	ID of the invoice to get.	true

Example JSON Structure

{
  "label" : "Get Invoice",
  "name" : "getInvoice",
  "parameters" : {
    "invoice" : ""
  },
  "type" : "quickbooks/v1/getInvoice"
}

Output

Type: OBJECT

Properties

Name	Type	Description
invoice	OBJECT Properties {STRING(domain), STRING(id), STRING(DocNumber), {STRING(name)}(customerRef), STRING(Balance)}

Output Example

{
  "invoice" : {
    "domain" : "",
    "id" : "",
    "DocNumber" : "",
    "customerRef" : {
      "name" : ""
    },
    "Balance" : ""
  }
}

Get Item

Name: getItem

Gets details about a specific item.

Properties

Name	Label	Type	Description	Required
item	Item ID	STRING	ID of the item to get.	true

Example JSON Structure

{
  "label" : "Get Item",
  "name" : "getItem",
  "parameters" : {
    "item" : ""
  },
  "type" : "quickbooks/v1/getItem"
}

Output

Type: OBJECT

Properties

Name	Type	Description
item	OBJECT Properties {STRING(domain), STRING(id), STRING(name), STRING(active), STRING(fullyQualifiedName), STRING(type), {STRING(name)}(incomeAccountRef), {STRING(name)}(assetAccountRef), {STRING(name)}(expenseAccountRef)}

Output Example

{
  "item" : {
    "domain" : "",
    "id" : "",
    "name" : "",
    "active" : "",
    "fullyQualifiedName" : "",
    "type" : "",
    "incomeAccountRef" : {
      "name" : ""
    },
    "assetAccountRef" : {
      "name" : ""
    },
    "expenseAccountRef" : {
      "name" : ""
    }
  }
}

Get Payment

Name: getPayment

Gets details about a specific payment.

Properties

Name	Label	Type	Description	Required
payment	Payment ID	STRING	ID of the payment to get.	true

Example JSON Structure

{
  "label" : "Get Payment",
  "name" : "getPayment",
  "parameters" : {
    "payment" : ""
  },
  "type" : "quickbooks/v1/getPayment"
}

Output

Type: OBJECT

Properties

Name	Type	Description
payment	OBJECT Properties {STRING(domain), STRING(id), {STRING(name)}(CurrencyRef), {STRING(name)}(customerRef), STRING(totalAmt)}

Output Example

{
  "payment" : {
    "domain" : "",
    "id" : "",
    "CurrencyRef" : {
      "name" : ""
    },
    "customerRef" : {
      "name" : ""
    },
    "totalAmt" : ""
  }
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

On this page