quickbooks.json•13.7 kB
{
"nodeType": "n8n-nodes-base.quickbooks",
"displayName": "QuickBooks Online",
"description": "Consume the QuickBooks Online API",
"version": 1,
"properties": [
{
"name": "VendorRef",
"displayName": "For Vendor Name or ID",
"type": "options",
"default": [],
"description": "The ID of the vendor who the bill is for. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"required": true,
"displayOptions": {
"show": {
"resource": [
"bill"
],
"operation": [
"create"
]
}
}
},
{
"name": "Line",
"displayName": "Line",
"type": "collection",
"default": {},
"description": "Individual line item of a transaction",
"placeholder": "Add Line Item Property",
"options": [
{
"name": "accountId",
"displayName": "Account ID",
"type": "string",
"default": ""
},
{
"name": "Amount",
"displayName": "Amount",
"type": "number",
"default": 0,
"description": "Monetary amount of the line item"
},
{
"name": "Description",
"displayName": "Description",
"type": "string",
"default": "",
"description": "Textual description of the line item"
}
],
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"resource": [
"bill"
],
"operation": [
"create"
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"placeholder": "Add Field",
"displayOptions": {
"show": {
"resource": [
"bill"
],
"operation": [
"create"
]
}
}
},
{
"name": "billId",
"displayName": "Bill ID",
"type": "string",
"default": "",
"description": "The ID of the bill to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"bill"
],
"operation": [
"delete"
]
}
}
},
{
"name": "returnAll",
"displayName": "Return All",
"type": "boolean",
"default": false,
"description": "Whether to return all results or only up to a given limit",
"displayOptions": {
"show": {
"resource": [
"bill"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "limit",
"displayName": "Limit",
"type": "number",
"default": 50,
"description": "Max number of results to return",
"typeOptions": {
"minValue": 1,
"maxValue": 1000
},
"displayOptions": {
"show": {
"resource": [
"bill"
],
"operation": [
"getAll"
],
"returnAll": [
false
]
}
}
},
{
"name": "filters",
"displayName": "Filters",
"type": "collection",
"default": {},
"description": "The condition for selecting bills. See the <a href=\"https://developer.intuit.com/app/developer/qbo/docs/develop/explore-the-quickbooks-online-api/data-queries\">guide</a> for supported syntax.",
"placeholder": "Add Field",
"options": [
{
"name": "query",
"displayName": "Query",
"type": "string",
"default": "",
"description": "The condition for selecting bills. See the <a href=\"https://developer.intuit.com/app/developer/qbo/docs/develop/explore-the-quickbooks-online-api/data-queries\">guide</a> for supported syntax.",
"placeholder": "WHERE Metadata.LastUpdatedTime > '2021-01-01'"
}
],
"displayOptions": {
"show": {
"resource": [
"bill"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "updateFields",
"displayName": "Update Fields",
"type": "collection",
"default": {},
"placeholder": "Add Field",
"required": true,
"displayOptions": {
"show": {
"resource": [
"bill"
],
"operation": [
"update"
]
}
}
},
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "get",
"options": [
{
"name": "Create",
"value": "create"
},
{
"name": "Delete",
"value": "delete"
},
{
"name": "Get",
"value": "get"
},
{
"name": "Get Many",
"value": "getAll"
},
{
"name": "Update",
"value": "update"
}
],
"displayOptions": {
"show": {
"resource": [
"bill"
]
}
}
},
{
"name": "displayName",
"displayName": "Display Name",
"type": "string",
"default": "",
"description": "The display name of the customer to create",
"required": true,
"displayOptions": {
"show": {
"resource": [
"customer"
],
"operation": [
"create"
]
}
}
},
{
"name": "customerId",
"displayName": "Customer ID",
"type": "string",
"default": "",
"description": "The ID of the customer to retrieve",
"required": true,
"displayOptions": {
"show": {
"resource": [
"customer"
],
"operation": [
"get"
]
}
}
},
{
"name": "FamilyName",
"displayName": "Family Name",
"type": "string",
"default": "",
"displayOptions": {
"show": {
"resource": [
"employee"
],
"operation": [
"create"
]
}
}
},
{
"name": "GivenName",
"displayName": "Given Name",
"type": "string",
"default": "",
"displayOptions": {
"show": {
"resource": [
"employee"
],
"operation": [
"create"
]
}
}
},
{
"name": "employeeId",
"displayName": "Employee ID",
"type": "string",
"default": "",
"description": "The ID of the employee to retrieve",
"required": true,
"displayOptions": {
"show": {
"resource": [
"employee"
],
"operation": [
"get"
]
}
}
},
{
"name": "CustomerRef",
"displayName": "For Customer Name or ID",
"type": "options",
"default": [],
"description": "The ID of the customer who the estimate is for. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"required": true,
"displayOptions": {
"show": {
"resource": [
"estimate"
],
"operation": [
"create"
]
}
}
},
{
"name": "estimateId",
"displayName": "Estimate ID",
"type": "string",
"default": "",
"description": "The ID of the estimate to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"estimate"
],
"operation": [
"delete"
]
}
}
},
{
"name": "download",
"displayName": "Download",
"type": "boolean",
"default": false,
"description": "Whether to download the estimate as a PDF file",
"required": true,
"displayOptions": {
"show": {
"resource": [
"estimate"
],
"operation": [
"get"
]
}
}
},
{
"name": "binaryProperty",
"displayName": "Put Output File in Field",
"type": "string",
"default": "data",
"required": true,
"displayOptions": {
"show": {
"resource": [
"estimate"
],
"operation": [
"get"
],
"download": [
true
]
}
}
},
{
"name": "fileName",
"displayName": "File Name",
"type": "string",
"default": "",
"description": "Name of the file that will be downloaded",
"placeholder": "data.pdf",
"required": true,
"displayOptions": {
"show": {
"resource": [
"estimate"
],
"operation": [
"get"
],
"download": [
true
]
}
}
},
{
"name": "email",
"displayName": "Email",
"type": "string",
"default": "",
"description": "The email of the recipient of the estimate",
"placeholder": "name@email.com",
"required": true,
"displayOptions": {
"show": {
"resource": [
"estimate"
],
"operation": [
"send"
]
}
}
},
{
"name": "invoiceId",
"displayName": "Invoice ID",
"type": "string",
"default": "",
"description": "The ID of the invoice to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"invoice"
],
"operation": [
"delete"
]
}
}
},
{
"name": "itemId",
"displayName": "Item ID",
"type": "string",
"default": "",
"description": "The ID of the item to retrieve",
"required": true,
"displayOptions": {
"show": {
"resource": [
"item"
],
"operation": [
"get"
]
}
}
},
{
"name": "TotalAmt",
"displayName": "Total Amount",
"type": "number",
"default": 0,
"description": "Total amount of the transaction",
"displayOptions": {
"show": {
"resource": [
"payment"
],
"operation": [
"create"
]
}
}
},
{
"name": "paymentId",
"displayName": "Payment ID",
"type": "string",
"default": "",
"description": "The ID of the payment to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"payment"
],
"operation": [
"delete"
]
}
}
},
{
"name": "purchaseId",
"displayName": "Purchase ID",
"type": "string",
"default": "",
"description": "The ID of the purchase to retrieve",
"required": true,
"displayOptions": {
"show": {
"resource": [
"purchase"
],
"operation": [
"get"
]
}
}
},
{
"name": "simple",
"displayName": "Simplify",
"type": "boolean",
"default": true,
"description": "Whether to return a simplified version of the response instead of the raw data",
"displayOptions": {
"show": {
"resource": [
"transaction"
],
"operation": [
"getReport"
]
}
}
},
{
"name": "vendorId",
"displayName": "Vendor ID",
"type": "string",
"default": "",
"description": "The ID of the vendor to retrieve",
"required": true,
"displayOptions": {
"show": {
"resource": [
"vendor"
],
"operation": [
"get"
]
}
}
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "customer",
"options": [
{
"name": "Bill",
"value": "bill"
},
{
"name": "Customer",
"value": "customer"
},
{
"name": "Employee",
"value": "employee"
},
{
"name": "Estimate",
"value": "estimate"
},
{
"name": "Invoice",
"value": "invoice"
},
{
"name": "Item",
"value": "item"
},
{
"name": "Payment",
"value": "payment"
},
{
"name": "Purchase",
"value": "purchase"
},
{
"name": "Transaction",
"value": "transaction"
},
{
"name": "Vendor",
"value": "vendor"
}
]
}
],
"credentialsConfig": [
{
"name": "quickBooksOAuth2Api",
"required": true
},
{
"name": "resource",
"required": false
}
],
"io": {
"inputs": [
"Main"
],
"outputs": [
"Main"
],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [
"Main"
],
"produces": [
"Main"
]
}
}