n8n/packages/nodes-base/nodes/Zoho/descriptions/PurchaseOrderDescription.ts
2021-12-03 09:44:16 +01:00

591 lines
12 KiB
TypeScript

import {
INodeProperties,
} from 'n8n-workflow';
import {
billingAddress,
currencies,
makeCustomFieldsFixedCollection,
makeGetAllFields,
productDetailsOptions,
shippingAddress,
} from './SharedFields';
export const purchaseOrderOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'purchaseOrder',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a purchase order',
},
{
name: 'Create or Update',
value: 'upsert',
description: 'Create a new record, or update the current one if it already exists (upsert)',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a purchase order',
},
{
name: 'Get',
value: 'get',
description: 'Get a purchase order',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get all purchase orders',
},
{
name: 'Update',
value: 'update',
description: 'Update a purchase order',
},
],
default: 'create',
description: 'Operation to perform',
},
];
export const purchaseOrderFields: INodeProperties[] = [
// ----------------------------------------
// purchaseOrder: create
// ----------------------------------------
{
displayName: 'Subject',
name: 'subject',
description: 'Subject or title of the purchase order.',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'purchaseOrder',
],
operation: [
'create',
],
},
},
},
// ----------------------------------------
// purchaseOrder: upsert
// ----------------------------------------
{
displayName: 'Subject',
name: 'subject',
description: 'Subject or title of the purchase order. If a record with this subject exists it will be updated, otherwise a new one will be created.',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'purchaseOrder',
],
operation: [
'upsert',
],
},
},
},
// ----------------------------------------
// purchaseOrder: create + upsert
// ----------------------------------------
{
displayName: 'Vendor ID',
name: 'vendorId',
type: 'options',
default: [],
typeOptions: {
loadOptionsMethod: 'getVendors',
},
description: 'ID of the vendor associated with the purchase order.',
displayOptions: {
show: {
resource: [
'purchaseOrder',
],
operation: [
'create',
'upsert',
],
},
},
},
{
displayName: 'Products',
name: 'Product_Details',
type: 'collection',
typeOptions: {
multipleValues: true,
multipleValueButtonText: 'Add Product',
},
default: {},
placeholder: 'Add Field',
options: productDetailsOptions,
displayOptions: {
show: {
resource: [
'purchaseOrder',
],
operation: [
'create',
'upsert',
],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'purchaseOrder',
],
operation: [
'create',
'upsert',
],
},
},
options: [
{
displayName: 'Adjustment',
name: 'Adjustment',
type: 'number',
default: 0,
typeOptions: {
minValue: 0,
},
description: 'Adjustment in the grand total, if any.',
},
{
displayName: 'Billing Address',
name: 'Billing_Address',
type: 'fixedCollection',
default: {},
placeholder: 'Add Billing Address Field',
options: [
{
displayName: 'Billing Address Fields',
name: 'billing_address_fields',
values: [
{
displayName: 'Billing City',
name: 'Billing_City',
type: 'string',
default: '',
},
{
displayName: 'Billing Code',
name: 'Billing_Code',
type: 'string',
default: '',
},
{
displayName: 'Billing Country',
name: 'Billing_Country',
type: 'string',
default: '',
},
{
displayName: 'Billing State',
name: 'Billing_State',
type: 'string',
default: '',
},
{
displayName: 'Billing Street',
name: 'Billing_Street',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Carrier',
name: 'Carrier',
type: 'string',
default: '',
description: 'Name of the carrier.',
},
{
displayName: 'Currency',
name: 'Currency',
type: 'options',
default: 'USD',
description: 'Symbol of the currency in which revenue is generated.',
options: currencies,
},
makeCustomFieldsFixedCollection('purchaseOrder'),
{
displayName: 'Description',
name: 'Description',
type: 'string',
default: '',
},
{
displayName: 'Discount',
name: 'Discount',
type: 'number',
description: 'Discount applied to the purchase order. For example, enter 12 for 12%.',
default: 0,
typeOptions: {
minValue: 0,
},
},
{
displayName: 'Due Date',
name: 'Due_Date',
type: 'dateTime',
default: '',
},
{
displayName: 'Exchange Rate',
name: 'Exchange_Rate',
type: 'number',
default: 0,
typeOptions: {
minValue: 0,
},
description: 'Exchange rate of the default currency to the home currency.',
},
{
displayName: 'Grand Total',
name: 'Grand_Total',
type: 'number',
default: 0,
typeOptions: {
minValue: 0,
},
description: 'Total amount for the product after deducting tax and discounts.',
},
{
displayName: 'PO Date',
name: 'PO_Date',
type: 'dateTime',
default: '',
description: 'Date on which the purchase order was issued.',
},
{
displayName: 'PO Number',
name: 'PO_Number',
type: 'string',
default: '',
description: 'ID of the purchase order after creating a case.',
},
{
displayName: 'Sales Commission',
name: 'Sales_Commission',
type: 'number',
default: 0,
typeOptions: {
minValue: 0,
},
description: 'Commission of sales person on deal closure as a percentage. For example, enter 12 for 12%.',
},
shippingAddress,
{
displayName: 'Status',
name: 'Status',
type: 'options',
default: [],
typeOptions: {
loadOptionsMethod: 'getPurchaseOrderStatus',
},
description: 'Status of the purchase order.',
},
{
displayName: 'Sub Total',
name: 'Sub_Total',
type: 'number',
default: 0,
typeOptions: {
minValue: 0,
},
description: 'Total amount for the product excluding tax.',
},
{
displayName: 'Tax',
name: 'Tax',
type: 'number',
default: 0,
typeOptions: {
minValue: 0,
},
description: 'Tax amount as the sum of sales tax and value-added tax.',
},
{
displayName: 'Terms and Conditions',
name: 'Terms_and_Conditions',
type: 'string',
default: '',
description: 'Terms and conditions associated with the purchase order.',
},
{
displayName: 'Tracking Number',
name: 'Tracking_Number',
type: 'string',
default: '',
},
],
},
// ----------------------------------------
// purchaseOrder: delete
// ----------------------------------------
{
displayName: 'Purchase Order ID',
name: 'purchaseOrderId',
description: 'ID of the purchase order to delete.',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'purchaseOrder',
],
operation: [
'delete',
],
},
},
},
// ----------------------------------------
// purchaseOrder: get
// ----------------------------------------
{
displayName: 'Purchase Order ID',
name: 'purchaseOrderId',
description: 'ID of the purchase order to retrieve.',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'purchaseOrder',
],
operation: [
'get',
],
},
},
},
// ----------------------------------------
// purchaseOrder: getAll
// ----------------------------------------
...makeGetAllFields('purchaseOrder'),
// ----------------------------------------
// purchaseOrder: update
// ----------------------------------------
{
displayName: 'Purchase Order ID',
name: 'purchaseOrderId',
description: 'ID of the purchase order to update.',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'purchaseOrder',
],
operation: [
'update',
],
},
},
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'purchaseOrder',
],
operation: [
'update',
],
},
},
options: [
{
displayName: 'Adjustment',
name: 'Adjustment',
type: 'number',
default: 0,
typeOptions: {
minValue: 0,
},
description: 'Adjustment in the grand total, if any.',
},
billingAddress,
{
displayName: 'Carrier',
name: 'Carrier',
type: 'string',
default: '',
description: 'Name of the carrier.',
},
{
displayName: 'Currency',
name: 'Currency',
type: 'options',
default: 'USD',
description: 'Symbol of the currency in which revenue is generated.',
options: currencies,
},
makeCustomFieldsFixedCollection('purchaseOrder'),
{
displayName: 'Description',
name: 'Description',
type: 'string',
default: '',
},
{
displayName: 'Discount',
name: 'Discount',
type: 'number',
default: 0,
typeOptions: {
minValue: 0,
},
},
{
displayName: 'Due Date',
name: 'Due_Date',
type: 'dateTime',
default: '',
},
{
displayName: 'Exchange Rate',
name: 'Exchange_Rate',
type: 'number',
default: 0,
typeOptions: {
minValue: 0,
},
description: 'Exchange rate of the default currency to the home currency.',
},
{
displayName: 'Grand Total',
name: 'Grand_Total',
type: 'number',
default: 0,
typeOptions: {
minValue: 0,
},
description: 'Total amount for the product after deducting tax and discounts.',
},
{
displayName: 'PO Date',
name: 'PO_Date',
type: 'dateTime',
default: '',
description: 'Date on which the purchase order was issued.',
},
{
displayName: 'PO Number',
name: 'PO_Number',
type: 'string',
default: '',
description: 'ID of the purchase order after creating a case.',
},
// productDetails('purchaseOrder', 'update'),
{
displayName: 'Sales Commission',
name: 'Sales_Commission',
type: 'number',
default: 0,
typeOptions: {
minValue: 0,
},
description: 'Commission of sales person on deal closure as a percentage. For example, enter 12 for 12%.',
},
shippingAddress,
{
displayName: 'Status',
name: 'Status',
type: 'options',
default: [],
typeOptions: {
loadOptionsMethod: 'getPurchaseOrderStatus',
},
description: 'Status of the purchase order.',
},
{
displayName: 'Sub Total',
name: 'Sub_Total',
type: 'number',
default: 0,
typeOptions: {
minValue: 0,
},
description: 'Total amount for the product excluding tax.',
},
{
displayName: 'Subject',
name: 'Subject',
type: 'string',
default: '',
description: 'Subject or title of the purchase order.',
},
{
displayName: 'Tax',
name: 'Tax',
type: 'number',
default: 0,
typeOptions: {
minValue: 0,
},
description: 'Tax amount as the sum of sales tax and value-added tax.',
},
{
displayName: 'Terms and Conditions',
name: 'Terms_and_Conditions',
type: 'string',
default: '',
description: 'Terms and conditions associated with the purchase order.',
},
{
displayName: 'Tracking Number',
name: 'Tracking_Number',
type: 'string',
default: '',
},
],
},
];