n8n/packages/nodes-base/nodes/QuickBooks/descriptions/Payment/PaymentDescription.ts
Iván Ovejero 5baa31b053
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>
2021-02-13 17:27:08 +01:00

400 lines
6.6 KiB
TypeScript

import {
INodeProperties,
} from 'n8n-workflow';
import {
paymentAdditionalFieldsOptions
} from './PaymentAdditionalFieldsOptions';
export const paymentOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
default: 'get',
description: 'Operation to perform',
options: [
{
name: 'Create',
value: 'create',
},
{
name: 'Delete',
value: 'delete',
},
{
name: 'Get',
value: 'get',
},
{
name: 'Get All',
value: 'getAll',
},
{
name: 'Send',
value: 'send',
},
{
name: 'Update',
value: 'update',
},
{
name: 'Void',
value: 'void',
},
],
displayOptions: {
show: {
resource: [
'payment',
],
},
},
},
] as INodeProperties[];
export const paymentFields = [
// ----------------------------------
// payment: create
// ----------------------------------
{
displayName: 'For Customer ID',
name: 'CustomerRef',
type: 'options',
required: true,
description: 'The ID of the customer who the payment is for.',
default: [],
typeOptions: {
loadOptionsMethod: 'getCustomers',
},
displayOptions: {
show: {
resource: [
'payment',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Total Amount',
name: 'TotalAmt',
description: 'Total amount of the transaction.',
type: 'number',
default: 0,
displayOptions: {
show: {
resource: [
'payment',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'payment',
],
operation: [
'create',
],
},
},
options: paymentAdditionalFieldsOptions,
},
// ----------------------------------
// payment: delete
// ----------------------------------
{
displayName: 'Payment ID',
name: 'paymentId',
type: 'string',
required: true,
default: '',
description: 'The ID of the payment to delete.',
displayOptions: {
show: {
resource: [
'payment',
],
operation: [
'delete',
],
},
},
},
// ----------------------------------
// payment: get
// ----------------------------------
{
displayName: 'Payment ID',
name: 'paymentId',
type: 'string',
required: true,
default: '',
description: 'The ID of the payment to retrieve.',
displayOptions: {
show: {
resource: [
'payment',
],
operation: [
'get',
],
},
},
},
{
displayName: 'Download',
name: 'download',
type: 'boolean',
required: true,
default: false,
description: 'Download estimate as PDF file',
displayOptions: {
show: {
resource: [
'payment',
],
operation: [
'get',
],
},
},
},
{
displayName: 'Binary Property',
name: 'binaryProperty',
type: 'string',
required: true,
default: 'data',
description: 'Name of the binary property to which to write to.',
displayOptions: {
show: {
resource: [
'payment',
],
operation: [
'get',
],
download: [
true,
],
},
},
},
{
displayName: 'File Name',
name: 'fileName',
type: 'string',
required: true,
default: '',
placeholder: 'data.pdf',
description: 'Name of the file that will be downloaded.',
displayOptions: {
show: {
resource: [
'payment',
],
operation: [
'get',
],
download: [
true,
],
},
},
},
// ----------------------------------
// payment: getAll
// ----------------------------------
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Return all results.',
displayOptions: {
show: {
resource: [
'payment',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 5,
description: 'The number of results to return.',
typeOptions: {
minValue: 1,
maxValue: 1000,
},
displayOptions: {
show: {
resource: [
'payment',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Field',
default: {},
options: [
{
displayName: 'Query',
name: 'query',
type: 'string',
default: '',
placeholder: 'WHERE Metadata.LastUpdatedTime > \'2021-01-01\'',
description: 'The condition for selecting payments. See the <a href="https://developer.intuit.com/app/developer/qbo/docs/develop/explore-the-quickbooks-online-api/data-queries" target="_blank">guide</a> for supported syntax.',
typeOptions: {
alwaysOpenEditWindow: true,
},
},
],
displayOptions: {
show: {
resource: [
'payment',
],
operation: [
'getAll',
],
},
},
},
// ----------------------------------
// payment: send
// ----------------------------------
{
displayName: 'Payment ID',
name: 'paymentId',
type: 'string',
required: true,
default: '',
description: 'The ID of the payment to send.',
displayOptions: {
show: {
resource: [
'payment',
],
operation: [
'send',
],
},
},
},
{
displayName: 'Email',
name: 'email',
type: 'string',
required: true,
default: '',
description: 'The email of the recipient of the payment.',
displayOptions: {
show: {
resource: [
'payment',
],
operation: [
'send',
],
},
},
},
// ----------------------------------
// payment: void
// ----------------------------------
{
displayName: 'Payment ID',
name: 'paymentId',
type: 'string',
required: true,
default: '',
description: 'The ID of the payment to void.',
displayOptions: {
show: {
resource: [
'payment',
],
operation: [
'void',
],
},
},
},
// ----------------------------------
// payment: update
// ----------------------------------
{
displayName: 'Payment ID',
name: 'paymentId',
type: 'string',
required: true,
default: '',
description: 'The ID of the payment to update.',
displayOptions: {
show: {
resource: [
'payment',
],
operation: [
'update',
],
},
},
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
required: true,
displayOptions: {
show: {
resource: [
'payment',
],
operation: [
'update',
],
},
},
options: paymentAdditionalFieldsOptions,
},
] as INodeProperties[];