import type { INodeProperties } from 'n8n-workflow'; import { invoiceAdditionalFieldsOptions } from './InvoiceAdditionalFieldsOptions'; export const invoiceOperations: INodeProperties[] = [ { displayName: 'Operation', name: 'operation', type: 'options', noDataExpression: true, default: 'get', options: [ { name: 'Create', value: 'create', action: 'Create an invoice', }, { name: 'Delete', value: 'delete', action: 'Delete an invoice', }, { name: 'Get', value: 'get', action: 'Get an invoice', }, { name: 'Get Many', value: 'getAll', action: 'Get many invoices', }, { name: 'Send', value: 'send', action: 'Send an invoice', }, { name: 'Update', value: 'update', action: 'Update an invoice', }, { name: 'Void', value: 'void', action: 'Void an invoice', }, ], displayOptions: { show: { resource: ['invoice'], }, }, }, ]; export const invoiceFields: INodeProperties[] = [ // ---------------------------------- // invoice: create // ---------------------------------- { displayName: 'For Customer Name or ID', name: 'CustomerRef', type: 'options', required: true, description: 'The ID of the customer who the invoice is for. Choose from the list, or specify an ID using an expression.', default: [], typeOptions: { loadOptionsMethod: 'getCustomers', }, displayOptions: { show: { resource: ['invoice'], operation: ['create'], }, }, }, { displayName: 'Line', name: 'Line', type: 'collection', placeholder: 'Add Line Item Property', description: 'Individual line item of a transaction', typeOptions: { multipleValues: true, }, default: {}, displayOptions: { show: { resource: ['invoice'], operation: ['create'], }, }, options: [ { displayName: 'Amount', name: 'Amount', description: 'Monetary amount of the line item', type: 'number', default: 0, }, { displayName: 'Description', name: 'Description', description: 'Textual description of the line item', type: 'string', default: '', }, { displayName: 'Detail Type', name: 'DetailType', type: 'options', default: 'SalesItemLineDetail', options: [ { name: 'Sales Item Line Detail', value: 'SalesItemLineDetail', }, ], }, { displayName: 'Item Name or ID', name: 'itemId', type: 'options', description: 'Choose from the list, or specify an ID using an expression', default: [], typeOptions: { loadOptionsMethod: 'getItems', }, }, { displayName: 'Position', name: 'LineNum', description: 'Position of the line item relative to others', type: 'number', default: 1, }, { displayName: 'Tax Code Ref Name or ID', name: 'TaxCodeRef', type: 'options', description: 'Choose from the list, or specify an ID using an expression', default: [], typeOptions: { loadOptionsMethod: 'getTaxCodeRefs', }, }, ], }, { displayName: 'Additional Fields', name: 'additionalFields', type: 'collection', placeholder: 'Add Field', default: {}, displayOptions: { show: { resource: ['invoice'], operation: ['create'], }, }, options: invoiceAdditionalFieldsOptions, }, // ---------------------------------- // invoice: delete // ---------------------------------- { displayName: 'Invoice ID', name: 'invoiceId', type: 'string', required: true, default: '', description: 'The ID of the invoice to delete', displayOptions: { show: { resource: ['invoice'], operation: ['delete'], }, }, }, // ---------------------------------- // invoice: get // ---------------------------------- { displayName: 'Invoice ID', name: 'invoiceId', type: 'string', required: true, default: '', description: 'The ID of the invoice to retrieve', displayOptions: { show: { resource: ['invoice'], operation: ['get'], }, }, }, { displayName: 'Download', name: 'download', type: 'boolean', required: true, default: false, description: 'Whether to download the invoice as a PDF file', displayOptions: { show: { resource: ['invoice'], operation: ['get'], }, }, }, { displayName: 'Put Output File in Field', name: 'binaryProperty', type: 'string', required: true, default: 'data', hint: 'The name of the output binary field to put the file in', displayOptions: { show: { resource: ['invoice'], 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: ['invoice'], operation: ['get'], download: [true], }, }, }, // ---------------------------------- // invoice: getAll // ---------------------------------- { displayName: 'Return All', name: 'returnAll', type: 'boolean', default: false, description: 'Whether to return all results or only up to a given limit', displayOptions: { show: { resource: ['invoice'], operation: ['getAll'], }, }, }, { displayName: 'Limit', name: 'limit', type: 'number', default: 50, description: 'Max number of results to return', typeOptions: { minValue: 1, maxValue: 1000, }, displayOptions: { show: { resource: ['invoice'], 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 invoices. See the guide for supported syntax.', }, ], displayOptions: { show: { resource: ['invoice'], operation: ['getAll'], }, }, }, // ---------------------------------- // invoice: send // ---------------------------------- { displayName: 'Invoice ID', name: 'invoiceId', type: 'string', required: true, default: '', description: 'The ID of the invoice to send', displayOptions: { show: { resource: ['invoice'], operation: ['send'], }, }, }, { displayName: 'Email', name: 'email', type: 'string', placeholder: 'name@email.com', required: true, default: '', description: 'The email of the recipient of the invoice', displayOptions: { show: { resource: ['invoice'], operation: ['send'], }, }, }, // ---------------------------------- // invoice: void // ---------------------------------- { displayName: 'Invoice ID', name: 'invoiceId', type: 'string', required: true, default: '', description: 'The ID of the invoice to void', displayOptions: { show: { resource: ['invoice'], operation: ['void'], }, }, }, // ---------------------------------- // invoice: update // ---------------------------------- { displayName: 'Invoice ID', name: 'invoiceId', type: 'string', required: true, default: '', description: 'The ID of the invoice to update', displayOptions: { show: { resource: ['invoice'], operation: ['update'], }, }, }, { displayName: 'Update Fields', name: 'updateFields', type: 'collection', placeholder: 'Add Field', default: {}, required: true, displayOptions: { show: { resource: ['invoice'], operation: ['update'], }, }, // filter out fields that cannot be updated options: invoiceAdditionalFieldsOptions.filter( (property) => property.name !== 'TotalAmt' && property.name !== 'Balance', ), }, ];