mirror of
https://github.com/Abdulazizzn/n8n-enterprise-unlocked.git
synced 2025-12-17 18:12:04 +00:00
✨ Add QuickBooks node (#1365)
* Add OAuth2 credentials * Adjust credentials params * Add node to listing * Add initial node scaffolding * Remove unused credentials params * Add customer search with select statement * Add pagination to customer search * Add customer creation functionality * Add customer update functionality * Small formatting fix * Adjust property name casing for consistency * Adjust customer operations for consistency * Handle large QuickBooks listings * Add initial estimate resource description * Add estimate resource retrieval operations * Refactor customer billing address * Simplify customer billing address * Fix casing for customer additional fields * Adjust types to accommodate loadOptions functions * Add loadOptions for customers to estimate * Sort customer update fields alphabetically * Refactor estimate line into standalone file * Add stub for PDF retrieval operation * Add invoice resource description and execute branches * Implement estimate PDF download functionality * Place descriptions in their own dir * Add get and getAll for invoices * Add send functionality to invoices * Refactor handling of binary data * Add invoice voiding functionality * Add invoice deletion functionality * Refactor resources into subdirs and add interfaces * Add get and getAll for bill * Add payment description * Add get and getAll for payment * Make variables in endpoints consistent * Refactor interfaces for consistency * Add interface for item resource * Fill in fields for all resources * Minor fixes in defaults and descriptions * Refactor loader * Add all resources to execute function * Fix line property duplication * Add get and getAll for vendor * Optimize description imports * Add creation for customer and bill * Add update operation for bill * Refactor create and update for customer * Implement employee create and update * Implement create and update for estimate * Make address params more consistent * Add create and update to payment * Add item operations * Add create and delete operations for invoice * Refactor binary data handler * Refactor generic functions * Add create and update operations for vendor * Fix build * Fix total amount in bill:update * Fix balance in bill:update * Remove currency from bill:update * Implement reference retrieval in bill:update * Fix failing params in customer:update * Fix param in employee:update * Implement reference retrieval in estimate:update * Fix failing params in estimate:update * Fix failing params in invoice:update * Fix failing param in vendor:update * Implement reference retrieval in payment:update * Remove unused interfaces * Rename line property function * Remove hared directory * Refactor reference and sync token retrieval * Fix line structure in bill:create * Fix line structure in estimate:create * Flatten responses * Refactor line processing * Remove unused interfaces * Add endpoint documentation * Fix payment:void content type * Fix default for bill line item * Hide auth URI query parameters * Hide auth header parameter * Add switch for credentials environment * Adjust OAuth2 callback to accommodate realmId * Retrieve realmId from OAuth2 flow * ⚡ Improvements * Reposition dividers * Add IDs to display names of reference fields * Add estimate:delete and bill:delete * Load items in lines for bill, estimate and invoice * Add filename for binary property in PDF download * ⚡ Improvements * Adjust field description * Implement estimate:send * Adjust field description * Adjust custom field descriptions * Add missing period to description * ⚡ Minor improvements on QuickBooks-Node * Add descriptions for bill * Add descriptions for customer * Add descriptions for employee * Add descriptions for estimate * Add descriptions for invoice * Add descriptions for payment * Add descriptions for vendor Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
This commit is contained in:
Iván Ovejero
990
packages/nodes-base/nodes/QuickBooks/QuickBooks.node.ts
Normal file
990
packages/nodes-base/nodes/QuickBooks/QuickBooks.node.ts
Normal file
@@ -0,0 +1,990 @@
|
||||
import {
|
||||
IExecuteFunctions,
|
||||
} from 'n8n-core';
|
||||
|
||||
import {
|
||||
IDataObject,
|
||||
ILoadOptionsFunctions,
|
||||
INodeExecutionData,
|
||||
INodeType,
|
||||
INodeTypeDescription,
|
||||
} from 'n8n-workflow';
|
||||
|
||||
import {
|
||||
billFields,
|
||||
billOperations,
|
||||
customerFields,
|
||||
customerOperations,
|
||||
employeeFields,
|
||||
employeeOperations,
|
||||
estimateFields,
|
||||
estimateOperations,
|
||||
invoiceFields,
|
||||
invoiceOperations,
|
||||
itemFields,
|
||||
itemOperations,
|
||||
paymentFields,
|
||||
paymentOperations,
|
||||
vendorFields,
|
||||
vendorOperations,
|
||||
} from './descriptions';
|
||||
|
||||
import {
|
||||
getRefAndSyncToken,
|
||||
getSyncToken,
|
||||
handleBinaryData,
|
||||
handleListing,
|
||||
loadResource,
|
||||
populateFields,
|
||||
processLines,
|
||||
quickBooksApiRequest,
|
||||
} from './GenericFunctions';
|
||||
|
||||
import {
|
||||
capitalCase,
|
||||
} from 'change-case';
|
||||
|
||||
import {
|
||||
isEmpty,
|
||||
} from 'lodash';
|
||||
|
||||
export class QuickBooks implements INodeType {
|
||||
description: INodeTypeDescription = {
|
||||
displayName: 'QuickBooks',
|
||||
name: 'quickbooks',
|
||||
icon: 'file:quickbooks.svg',
|
||||
group: ['transform'],
|
||||
version: 1,
|
||||
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
|
||||
description: 'Consume the QuickBooks API',
|
||||
defaults: {
|
||||
name: 'QuickBooks',
|
||||
color: '#2CA01C',
|
||||
},
|
||||
inputs: ['main'],
|
||||
outputs: ['main'],
|
||||
credentials: [
|
||||
{
|
||||
name: 'quickBooksOAuth2Api',
|
||||
required: true,
|
||||
},
|
||||
],
|
||||
properties: [
|
||||
{
|
||||
displayName: 'Resource',
|
||||
name: 'resource',
|
||||
type: 'options',
|
||||
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: 'Vendor',
|
||||
value: 'vendor',
|
||||
},
|
||||
],
|
||||
default: 'customer',
|
||||
description: 'Resource to consume',
|
||||
},
|
||||
...billOperations,
|
||||
...billFields,
|
||||
...customerOperations,
|
||||
...customerFields,
|
||||
...employeeOperations,
|
||||
...employeeFields,
|
||||
...estimateOperations,
|
||||
...estimateFields,
|
||||
...invoiceOperations,
|
||||
...invoiceFields,
|
||||
...itemOperations,
|
||||
...itemFields,
|
||||
...paymentOperations,
|
||||
...paymentFields,
|
||||
...vendorOperations,
|
||||
...vendorFields,
|
||||
],
|
||||
};
|
||||
|
||||
methods = {
|
||||
loadOptions: {
|
||||
async getCustomers(this: ILoadOptionsFunctions) {
|
||||
return await loadResource.call(this, 'customer');
|
||||
},
|
||||
|
||||
async getCustomFields(this: ILoadOptionsFunctions) {
|
||||
return await loadResource.call(this, 'preferences');
|
||||
},
|
||||
|
||||
async getItems(this: ILoadOptionsFunctions) {
|
||||
return await loadResource.call(this, 'item');
|
||||
},
|
||||
|
||||
async getVendors(this: ILoadOptionsFunctions) {
|
||||
return await loadResource.call(this, 'vendor');
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
||||
const items = this.getInputData();
|
||||
|
||||
const resource = this.getNodeParameter('resource', 0) as string;
|
||||
const operation = this.getNodeParameter('operation', 0) as string;
|
||||
|
||||
let responseData;
|
||||
const returnData: IDataObject[] = [];
|
||||
|
||||
const { oauthTokenData } = this.getCredentials('quickBooksOAuth2Api') as IDataObject;
|
||||
// @ts-ignore
|
||||
const companyId = oauthTokenData.callbackQueryString.realmId;
|
||||
|
||||
for (let i = 0; i < items.length; i++) {
|
||||
|
||||
if (resource === 'bill') {
|
||||
|
||||
// *********************************************************************
|
||||
// bill
|
||||
// *********************************************************************
|
||||
|
||||
// https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/estimate
|
||||
|
||||
if (operation === 'create') {
|
||||
|
||||
// ----------------------------------
|
||||
// bill: create
|
||||
// ----------------------------------
|
||||
|
||||
const lines = this.getNodeParameter('Line', i) as IDataObject[];
|
||||
|
||||
if (!lines.length) {
|
||||
throw new Error(`Please enter at least one line for the ${resource}.`);
|
||||
}
|
||||
|
||||
if (lines.some(line => line.DetailType === undefined || line.Amount === undefined || line.Description === undefined)) {
|
||||
throw new Error('Please enter detail type, amount and description for every line.');
|
||||
}
|
||||
|
||||
lines.forEach(line => {
|
||||
if (line.DetailType === 'AccountBasedExpenseLineDetail' && line.accountId === undefined) {
|
||||
throw new Error('Please enter an account ID for the associated line.');
|
||||
} else if (line.DetailType === 'ItemBasedExpenseLineDetail' && line.itemId === undefined) {
|
||||
throw new Error('Please enter an item ID for the associated line.');
|
||||
}
|
||||
});
|
||||
|
||||
let body = {
|
||||
VendorRef: {
|
||||
value: this.getNodeParameter('VendorRef', i),
|
||||
},
|
||||
} as IDataObject;
|
||||
|
||||
body.Line = processLines.call(this, body, lines, resource);
|
||||
|
||||
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
||||
|
||||
body = populateFields.call(this, body, additionalFields, resource);
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, {}, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'delete') {
|
||||
|
||||
// ----------------------------------
|
||||
// bill: delete
|
||||
// ----------------------------------
|
||||
|
||||
const qs = {
|
||||
operation: 'delete',
|
||||
} as IDataObject;
|
||||
|
||||
const body = {
|
||||
Id: this.getNodeParameter('billId', i),
|
||||
SyncToken: await getSyncToken.call(this, i, companyId, resource),
|
||||
} as IDataObject;
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, qs, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'get') {
|
||||
|
||||
// ----------------------------------
|
||||
// bill: get
|
||||
// ----------------------------------
|
||||
|
||||
const billId = this.getNodeParameter('billId', i);
|
||||
const endpoint = `/v3/company/${companyId}/${resource}/${billId}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'GET', endpoint, {}, {});
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'getAll') {
|
||||
|
||||
// ----------------------------------
|
||||
// bill: getAll
|
||||
// ----------------------------------
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/query`;
|
||||
responseData = await handleListing.call(this, i, endpoint, resource);
|
||||
|
||||
} else if (operation === 'update') {
|
||||
|
||||
// ----------------------------------
|
||||
// bill: update
|
||||
// ----------------------------------
|
||||
|
||||
const { ref, syncToken } = await getRefAndSyncToken.call(this, i, companyId, resource, 'VendorRef');
|
||||
|
||||
let body = {
|
||||
Id: this.getNodeParameter('billId', i),
|
||||
SyncToken: syncToken,
|
||||
sparse: true,
|
||||
VendorRef: {
|
||||
name: ref.name,
|
||||
value: ref.value,
|
||||
},
|
||||
} as IDataObject;
|
||||
|
||||
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
|
||||
|
||||
if (isEmpty(updateFields)) {
|
||||
throw new Error(`Please enter at least one field to update for the ${resource}.`);
|
||||
}
|
||||
|
||||
body = populateFields.call(this, body, updateFields, resource);
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, {}, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
}
|
||||
|
||||
} else if (resource === 'customer') {
|
||||
|
||||
// *********************************************************************
|
||||
// customer
|
||||
// *********************************************************************
|
||||
|
||||
// https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/customer
|
||||
|
||||
if (operation === 'create') {
|
||||
|
||||
// ----------------------------------
|
||||
// customer: create
|
||||
// ----------------------------------
|
||||
|
||||
let body = {
|
||||
DisplayName: this.getNodeParameter('displayName', i),
|
||||
} as IDataObject;
|
||||
|
||||
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
||||
|
||||
body = populateFields.call(this, body, additionalFields, resource);
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, {}, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'get') {
|
||||
|
||||
// ----------------------------------
|
||||
// customer: get
|
||||
// ----------------------------------
|
||||
|
||||
const customerId = this.getNodeParameter('customerId', i);
|
||||
const endpoint = `/v3/company/${companyId}/${resource}/${customerId}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'GET', endpoint, {}, {});
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'getAll') {
|
||||
|
||||
// ----------------------------------
|
||||
// customer: getAll
|
||||
// ----------------------------------
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/query`;
|
||||
responseData = await handleListing.call(this, i, endpoint, resource);
|
||||
|
||||
} else if (operation === 'update') {
|
||||
|
||||
// ----------------------------------
|
||||
// customer: update
|
||||
// ----------------------------------
|
||||
|
||||
let body = {
|
||||
Id: this.getNodeParameter('customerId', i),
|
||||
SyncToken: await getSyncToken.call(this, i, companyId, resource),
|
||||
sparse: true,
|
||||
} as IDataObject;
|
||||
|
||||
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
|
||||
|
||||
if (isEmpty(updateFields)) {
|
||||
throw new Error(`Please enter at least one field to update for the ${resource}.`);
|
||||
}
|
||||
|
||||
body = populateFields.call(this, body, updateFields, resource);
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, {}, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
}
|
||||
|
||||
} else if (resource === 'employee') {
|
||||
|
||||
// *********************************************************************
|
||||
// employee
|
||||
// *********************************************************************
|
||||
|
||||
if (operation === 'create') {
|
||||
|
||||
// ----------------------------------
|
||||
// employee: create
|
||||
// ----------------------------------
|
||||
|
||||
let body = {
|
||||
FamilyName: this.getNodeParameter('FamilyName', i),
|
||||
GivenName: this.getNodeParameter('GivenName', i),
|
||||
} as IDataObject;
|
||||
|
||||
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
||||
|
||||
body = populateFields.call(this, body, additionalFields, resource);
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, {}, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'get') {
|
||||
|
||||
// ----------------------------------
|
||||
// employee: get
|
||||
// ----------------------------------
|
||||
|
||||
const employeeId = this.getNodeParameter('employeeId', i);
|
||||
const endpoint = `/v3/company/${companyId}/${resource}/${employeeId}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'GET', endpoint, {}, {});
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'getAll') {
|
||||
|
||||
// ----------------------------------
|
||||
// employee: getAll
|
||||
// ----------------------------------
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/query`;
|
||||
responseData = await handleListing.call(this, i, endpoint, resource);
|
||||
|
||||
} else if (operation === 'update') {
|
||||
|
||||
// ----------------------------------
|
||||
// employee: update
|
||||
// ----------------------------------
|
||||
|
||||
let body = {
|
||||
Id: this.getNodeParameter('employeeId', i),
|
||||
SyncToken: await getSyncToken.call(this, i, companyId, resource),
|
||||
sparse: true,
|
||||
} as IDataObject;
|
||||
|
||||
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
|
||||
|
||||
if (isEmpty(updateFields)) {
|
||||
throw new Error(`Please enter at least one field to update for the ${resource}.`);
|
||||
}
|
||||
|
||||
body = populateFields.call(this, body, updateFields, resource);
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, {}, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
}
|
||||
|
||||
} else if (resource === 'estimate') {
|
||||
|
||||
// *********************************************************************
|
||||
// estimate
|
||||
// *********************************************************************
|
||||
|
||||
// https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/estimate
|
||||
|
||||
if (operation === 'create') {
|
||||
|
||||
// ----------------------------------
|
||||
// estimate: create
|
||||
// ----------------------------------
|
||||
|
||||
const lines = this.getNodeParameter('Line', i) as IDataObject[];
|
||||
|
||||
if (!lines.length) {
|
||||
throw new Error(`Please enter at least one line for the ${resource}.`);
|
||||
}
|
||||
|
||||
if (lines.some(line => line.DetailType === undefined || line.Amount === undefined || line.Description === undefined)) {
|
||||
throw new Error('Please enter detail type, amount and description for every line.');
|
||||
}
|
||||
|
||||
lines.forEach(line => {
|
||||
if (line.DetailType === 'SalesItemLineDetail' && line.itemId === undefined) {
|
||||
throw new Error('Please enter an item ID for the associated line.');
|
||||
}
|
||||
});
|
||||
|
||||
let body = {
|
||||
CustomerRef: {
|
||||
value: this.getNodeParameter('CustomerRef', i),
|
||||
},
|
||||
} as IDataObject;
|
||||
|
||||
body.Line = processLines.call(this, body, lines, resource);
|
||||
|
||||
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
||||
|
||||
body = populateFields.call(this, body, additionalFields, resource);
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, {}, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'delete') {
|
||||
|
||||
// ----------------------------------
|
||||
// estimate: delete
|
||||
// ----------------------------------
|
||||
|
||||
const qs = {
|
||||
operation: 'delete',
|
||||
} as IDataObject;
|
||||
|
||||
const body = {
|
||||
Id: this.getNodeParameter('estimateId', i),
|
||||
SyncToken: await getSyncToken.call(this, i, companyId, resource),
|
||||
} as IDataObject;
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, qs, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'get') {
|
||||
|
||||
// ----------------------------------
|
||||
// estimate: get
|
||||
// ----------------------------------
|
||||
|
||||
const estimateId = this.getNodeParameter('estimateId', i) as string;
|
||||
const download = this.getNodeParameter('download', i) as boolean;
|
||||
|
||||
if (download) {
|
||||
|
||||
responseData = await handleBinaryData.call(this, items, i, companyId, resource, estimateId);
|
||||
|
||||
} else {
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}/${estimateId}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'GET', endpoint, {}, {});
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
}
|
||||
|
||||
} else if (operation === 'getAll') {
|
||||
|
||||
// ----------------------------------
|
||||
// estimate: getAll
|
||||
// ----------------------------------
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/query`;
|
||||
responseData = await handleListing.call(this, i, endpoint, resource);
|
||||
|
||||
} else if (operation === 'send') {
|
||||
|
||||
// ----------------------------------
|
||||
// estimate: send
|
||||
// ----------------------------------
|
||||
|
||||
const estimateId = this.getNodeParameter('estimateId', i) as string;
|
||||
|
||||
const qs = {
|
||||
sendTo: this.getNodeParameter('email', i) as string,
|
||||
} as IDataObject;
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}/${estimateId}/send`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, qs, {});
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'update') {
|
||||
|
||||
// ----------------------------------
|
||||
// estimate: update
|
||||
// ----------------------------------
|
||||
|
||||
const { ref, syncToken } = await getRefAndSyncToken.call(this, i, companyId, resource, 'CustomerRef');
|
||||
|
||||
let body = {
|
||||
Id: this.getNodeParameter('estimateId', i),
|
||||
SyncToken: syncToken,
|
||||
sparse: true,
|
||||
CustomerRef: {
|
||||
name: ref.name,
|
||||
value: ref.value,
|
||||
},
|
||||
} as IDataObject;
|
||||
|
||||
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
|
||||
|
||||
if (isEmpty(updateFields)) {
|
||||
throw new Error(`Please enter at least one field to update for the ${resource}.`);
|
||||
}
|
||||
|
||||
body = populateFields.call(this, body, updateFields, resource);
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, {}, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
}
|
||||
|
||||
} else if (resource === 'invoice') {
|
||||
|
||||
// *********************************************************************
|
||||
// invoice
|
||||
// *********************************************************************
|
||||
|
||||
// https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/invoice
|
||||
|
||||
if (operation === 'create') {
|
||||
|
||||
// ----------------------------------
|
||||
// invoice: create
|
||||
// ----------------------------------
|
||||
|
||||
const lines = this.getNodeParameter('Line', i) as IDataObject[];
|
||||
|
||||
if (!lines.length) {
|
||||
throw new Error(`Please enter at least one line for the ${resource}.`);
|
||||
}
|
||||
|
||||
if (lines.some(line => line.DetailType === undefined || line.Amount === undefined || line.Description === undefined)) {
|
||||
throw new Error('Please enter detail type, amount and description for every line.');
|
||||
}
|
||||
|
||||
lines.forEach(line => {
|
||||
if (line.DetailType === 'SalesItemLineDetail' && line.itemId === undefined) {
|
||||
throw new Error('Please enter an item ID for the associated line.');
|
||||
}
|
||||
});
|
||||
|
||||
let body = {
|
||||
CustomerRef: {
|
||||
value: this.getNodeParameter('CustomerRef', i),
|
||||
},
|
||||
} as IDataObject;
|
||||
|
||||
body.Line = processLines.call(this, body, lines, resource);
|
||||
|
||||
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
||||
|
||||
body = populateFields.call(this, body, additionalFields, resource);
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, {}, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'delete') {
|
||||
|
||||
// ----------------------------------
|
||||
// invoice: delete
|
||||
// ----------------------------------
|
||||
|
||||
const qs = {
|
||||
operation: 'delete',
|
||||
} as IDataObject;
|
||||
|
||||
const body = {
|
||||
Id: this.getNodeParameter('invoiceId', i),
|
||||
SyncToken: await getSyncToken.call(this, i, companyId, resource),
|
||||
} as IDataObject;
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, qs, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'get') {
|
||||
|
||||
// ----------------------------------
|
||||
// invoice: get
|
||||
// ----------------------------------
|
||||
|
||||
const invoiceId = this.getNodeParameter('invoiceId', i) as string;
|
||||
const download = this.getNodeParameter('download', i) as boolean;
|
||||
|
||||
if (download) {
|
||||
|
||||
responseData = await handleBinaryData.call(this, items, i, companyId, resource, invoiceId);
|
||||
|
||||
} else {
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}/${invoiceId}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'GET', endpoint, {}, {});
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
}
|
||||
|
||||
} else if (operation === 'getAll') {
|
||||
|
||||
// ----------------------------------
|
||||
// invoice: getAll
|
||||
// ----------------------------------
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/query`;
|
||||
responseData = await handleListing.call(this, i, endpoint, resource);
|
||||
|
||||
} else if (operation === 'send') {
|
||||
|
||||
// ----------------------------------
|
||||
// invoice: send
|
||||
// ----------------------------------
|
||||
|
||||
const invoiceId = this.getNodeParameter('invoiceId', i) as string;
|
||||
|
||||
const qs = {
|
||||
sendTo: this.getNodeParameter('email', i) as string,
|
||||
} as IDataObject;
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}/${invoiceId}/send`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, qs, {});
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'update') {
|
||||
|
||||
// ----------------------------------
|
||||
// invoice: update
|
||||
// ----------------------------------
|
||||
|
||||
const { ref, syncToken } = await getRefAndSyncToken.call(this, i, companyId, resource, 'CustomerRef');
|
||||
|
||||
let body = {
|
||||
Id: this.getNodeParameter('invoiceId', i),
|
||||
SyncToken: syncToken,
|
||||
sparse: true,
|
||||
CustomerRef: {
|
||||
name: ref.name,
|
||||
value: ref.value,
|
||||
},
|
||||
} as IDataObject;
|
||||
|
||||
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
|
||||
|
||||
if (isEmpty(updateFields)) {
|
||||
throw new Error(`Please enter at least one field to update for the ${resource}.`);
|
||||
}
|
||||
|
||||
body = populateFields.call(this, body, updateFields, resource);
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, {}, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'void') {
|
||||
|
||||
// ----------------------------------
|
||||
// invoice: void
|
||||
// ----------------------------------
|
||||
|
||||
const qs = {
|
||||
Id: this.getNodeParameter('invoiceId', i),
|
||||
SyncToken: await getSyncToken.call(this, i, companyId, resource),
|
||||
operation: 'void',
|
||||
} as IDataObject;
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, qs, {});
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
}
|
||||
|
||||
} else if (resource === 'item') {
|
||||
|
||||
// *********************************************************************
|
||||
// item
|
||||
// *********************************************************************
|
||||
|
||||
// https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/item
|
||||
|
||||
if (operation === 'get') {
|
||||
|
||||
// ----------------------------------
|
||||
// item: get
|
||||
// ----------------------------------
|
||||
|
||||
const item = this.getNodeParameter('itemId', i);
|
||||
const endpoint = `/v3/company/${companyId}/${resource}/${item}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'GET', endpoint, {}, {});
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'getAll') {
|
||||
|
||||
// ----------------------------------
|
||||
// item: getAll
|
||||
// ----------------------------------
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/query`;
|
||||
responseData = await handleListing.call(this, i, endpoint, resource);
|
||||
|
||||
}
|
||||
|
||||
} else if (resource === 'payment') {
|
||||
|
||||
// *********************************************************************
|
||||
// payment
|
||||
// *********************************************************************
|
||||
|
||||
// https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/payment
|
||||
|
||||
if (operation === 'create') {
|
||||
|
||||
// ----------------------------------
|
||||
// payment: create
|
||||
// ----------------------------------
|
||||
|
||||
let body = {
|
||||
CustomerRef: {
|
||||
value: this.getNodeParameter('CustomerRef', i),
|
||||
},
|
||||
TotalAmt: this.getNodeParameter('TotalAmt', i),
|
||||
} as IDataObject;
|
||||
|
||||
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
||||
|
||||
body = populateFields.call(this, body, additionalFields, resource);
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, {}, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'delete') {
|
||||
|
||||
// ----------------------------------
|
||||
// payment: delete
|
||||
// ----------------------------------
|
||||
|
||||
const qs = {
|
||||
operation: 'delete',
|
||||
} as IDataObject;
|
||||
|
||||
const body = {
|
||||
Id: this.getNodeParameter('paymentId', i),
|
||||
SyncToken: await getSyncToken.call(this, i, companyId, resource),
|
||||
} as IDataObject;
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, qs, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'get') {
|
||||
|
||||
// ----------------------------------
|
||||
// payment: get
|
||||
// ----------------------------------
|
||||
|
||||
const paymentId = this.getNodeParameter('paymentId', i) as string;
|
||||
const download = this.getNodeParameter('download', i) as boolean;
|
||||
|
||||
if (download) {
|
||||
|
||||
responseData = await handleBinaryData.call(this, items, i, companyId, resource, paymentId);
|
||||
|
||||
} else {
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}/${paymentId}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'GET', endpoint, {}, {});
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
}
|
||||
|
||||
} else if (operation === 'getAll') {
|
||||
|
||||
// ----------------------------------
|
||||
// payment: getAll
|
||||
// ----------------------------------
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/query`;
|
||||
responseData = await handleListing.call(this, i, endpoint, resource);
|
||||
|
||||
} else if (operation === 'send') {
|
||||
|
||||
// ----------------------------------
|
||||
// payment: send
|
||||
// ----------------------------------
|
||||
|
||||
const paymentId = this.getNodeParameter('paymentId', i) as string;
|
||||
|
||||
const qs = {
|
||||
sendTo: this.getNodeParameter('email', i) as string,
|
||||
} as IDataObject;
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}/${paymentId}/send`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, qs, {});
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'update') {
|
||||
|
||||
// ----------------------------------
|
||||
// payment: update
|
||||
// ----------------------------------
|
||||
|
||||
const { ref, syncToken } = await getRefAndSyncToken.call(this, i, companyId, resource, 'CustomerRef');
|
||||
|
||||
let body = {
|
||||
Id: this.getNodeParameter('paymentId', i),
|
||||
SyncToken: syncToken,
|
||||
sparse: true,
|
||||
CustomerRef: {
|
||||
name: ref.name,
|
||||
value: ref.value,
|
||||
},
|
||||
} as IDataObject;
|
||||
|
||||
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
|
||||
|
||||
if (isEmpty(updateFields)) {
|
||||
throw new Error(`Please enter at least one field to update for the ${resource}.`);
|
||||
}
|
||||
|
||||
body = populateFields.call(this, body, updateFields, resource);
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, {}, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'void') {
|
||||
|
||||
// ----------------------------------
|
||||
// payment: void
|
||||
// ----------------------------------
|
||||
|
||||
const qs = {
|
||||
Id: this.getNodeParameter('paymentId', i),
|
||||
SyncToken: await getSyncToken.call(this, i, companyId, resource),
|
||||
operation: 'void',
|
||||
} as IDataObject;
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, qs, {});
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
}
|
||||
|
||||
} else if (resource === 'vendor') {
|
||||
|
||||
// *********************************************************************
|
||||
// vendor
|
||||
// *********************************************************************
|
||||
|
||||
// https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/vendor
|
||||
|
||||
if (operation === 'create') {
|
||||
|
||||
// ----------------------------------
|
||||
// vendor: create
|
||||
// ----------------------------------
|
||||
|
||||
let body = {
|
||||
DisplayName: this.getNodeParameter('displayName', i),
|
||||
} as IDataObject;
|
||||
|
||||
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
||||
|
||||
body = populateFields.call(this, body, additionalFields, resource);
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, {}, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'get') {
|
||||
|
||||
// ----------------------------------
|
||||
// vendor: get
|
||||
// ----------------------------------
|
||||
|
||||
const vendorId = this.getNodeParameter('vendorId', i);
|
||||
const endpoint = `/v3/company/${companyId}/${resource}/${vendorId}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'GET', endpoint, {}, {});
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
} else if (operation === 'getAll') {
|
||||
|
||||
// ----------------------------------
|
||||
// vendor: getAll
|
||||
// ----------------------------------
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/query`;
|
||||
responseData = await handleListing.call(this, i, endpoint, resource);
|
||||
|
||||
} else if (operation === 'update') {
|
||||
|
||||
// ----------------------------------
|
||||
// vendor: update
|
||||
// ----------------------------------
|
||||
|
||||
let body = {
|
||||
Id: this.getNodeParameter('vendorId', i),
|
||||
SyncToken: await getSyncToken.call(this, i, companyId, resource),
|
||||
sparse: true,
|
||||
} as IDataObject;
|
||||
|
||||
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
|
||||
|
||||
if (isEmpty(updateFields)) {
|
||||
throw new Error(`Please enter at least one field to update for the ${resource}.`);
|
||||
}
|
||||
|
||||
body = populateFields.call(this, body, updateFields, resource);
|
||||
|
||||
const endpoint = `/v3/company/${companyId}/${resource}`;
|
||||
responseData = await quickBooksApiRequest.call(this, 'POST', endpoint, {}, body);
|
||||
responseData = responseData[capitalCase(resource)];
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
Array.isArray(responseData)
|
||||
? returnData.push(...responseData)
|
||||
: returnData.push(responseData);
|
||||
}
|
||||
|
||||
const download = this.getNodeParameter('download', 0, false) as boolean;
|
||||
|
||||
if (['invoice', 'estimate', 'payment'].includes(resource) && ['get'].includes(operation) && download) {
|
||||
return this.prepareOutputData(responseData);
|
||||
} else {
|
||||
return [this.helpers.returnJsonArray(returnData)];
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user