n8n/packages/nodes-base/nodes/Harvest/InvoiceDescription.ts

487 lines
11 KiB
TypeScript
Raw Normal View History

import {
INodeProperties,
} from 'n8n-workflow';
2020-01-28 07:50:15 -08:00
const resource = [
'invoice',
];
2020-01-28 07:50:15 -08:00
export const invoiceOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource,
2020-01-28 07:50:15 -08:00
},
},
options: [
{
name: 'Get',
value: 'get',
description: 'Get data of an invoice',
2020-01-28 07:50:15 -08:00
},
{
name: 'Get All',
value: 'getAll',
description: 'Get data of all invoices',
},
2020-02-03 03:57:39 -08:00
{
name: 'Create',
value: 'create',
description: `Create an invoice`,
2020-02-03 03:57:39 -08:00
},
{
name: 'Update',
value: 'update',
description: `Update an invoice`,
2020-02-03 03:57:39 -08:00
},
2020-01-31 04:47:20 -08:00
{
name: 'Delete',
value: 'delete',
description: `Delete an invoice`,
2020-01-31 04:47:20 -08:00
},
2020-01-28 07:50:15 -08:00
],
default: 'getAll',
2020-01-28 07:50:15 -08:00
description: 'The operation to perform.',
},
] as INodeProperties[];
export const invoiceFields = [
/* -------------------------------------------------------------------------- */
/* invoice:getAll */
/* -------------------------------------------------------------------------- */
2020-01-28 07:50:15 -08:00
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource,
operation: [
'getAll',
],
},
2020-01-28 07:50:15 -08:00
},
default: false,
description: 'Returns a list of your invoices.',
2020-01-28 07:50:15 -08:00
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource,
operation: [
'getAll',
],
returnAll: [
false,
],
},
2020-01-28 07:50:15 -08:00
},
typeOptions: {
minValue: 1,
maxValue: 100,
2020-01-28 07:50:15 -08:00
},
default: 100,
description: 'How many results to return.',
2020-01-28 07:50:15 -08:00
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Filter',
default: {},
displayOptions: {
show: {
resource,
operation: [
'getAll',
],
},
2020-01-28 07:50:15 -08:00
},
options: [
{
displayName: 'Client ID',
name: 'client_id',
type: 'string',
default: '',
description: 'Only return time entries belonging to the client with the given ID.',
},
{
displayName: 'From',
name: 'from',
type: 'dateTime',
default: '',
description: 'Only return time entries with a spent_date on or after the given date.',
},
{
displayName: 'Page',
name: 'page',
type: 'number',
typeOptions: {
minValue: 1,
},
default: 1,
description: 'The page number to use in pagination. For instance, if you make a list request and receive 100 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)',
},
{
displayName: 'Project ID',
name: 'project_id',
type: 'string',
default: '',
description: 'Only return time entries belonging to the client with the given ID.',
},
{
displayName: 'State',
name: 'state',
type: 'multiOptions',
options: [
{
name: 'draft',
value: 'draft',
},
{
name: 'open',
value: 'open',
},
{
name: 'paid',
value: 'paid',
},
{
name: 'closed',
value: 'closed',
},
],
default: [],
description: 'Only return invoices with a state matching the value provided. Options: draft, open, paid, or closed.',
},
{
displayName: 'To',
name: 'to',
type: 'dateTime',
default: '',
description: 'Only return time entries with a spent_date on or before the given date.',
},
{
displayName: 'Updated Since',
name: 'updated_since',
type: 'dateTime',
default: '',
description: 'Only return time entries that have been updated since the given date and time.',
},
],
},
2020-01-28 07:50:15 -08:00
/* -------------------------------------------------------------------------- */
/* invoice:get */
/* -------------------------------------------------------------------------- */
{
displayName: 'Invoice Id',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'get',
],
resource,
},
2020-01-28 07:50:15 -08:00
},
description: 'The ID of the invoice you are retrieving.',
2020-01-28 07:50:15 -08:00
},
2020-01-31 04:47:20 -08:00
/* -------------------------------------------------------------------------- */
/* invoice:delete */
/* -------------------------------------------------------------------------- */
{
displayName: 'Invoice Id',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'delete',
],
resource,
},
2020-01-31 04:47:20 -08:00
},
description: 'The ID of the invoice want to delete.',
2020-01-31 04:47:20 -08:00
},
2020-02-03 01:23:58 -08:00
/* -------------------------------------------------------------------------- */
/* invoice:create */
2020-02-03 01:23:58 -08:00
/* -------------------------------------------------------------------------- */
{
2020-02-03 04:55:21 -08:00
displayName: 'Client Id',
name: 'clientId',
2020-02-03 01:23:58 -08:00
type: 'string',
displayOptions: {
show: {
operation: [
'create',
],
resource,
},
},
default: '',
required: true,
description: 'The ID of the retainer associated with this invoice..',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: [
'create',
],
resource,
},
},
default: {},
options: [
{
displayName: 'Currency',
name: 'currency',
2020-02-03 01:23:58 -08:00
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'The currency used by the invoice. If not provided, the clients currency will be used. See a list of supported currencies',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Discount',
name: 'over_budget_notification_percentage',
2020-02-03 01:23:58 -08:00
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'This percentage is subtracted from the subtotal. Example: use 10.0 for 10.0%.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Due Date',
name: 'ends_on',
type: 'dateTime',
2020-02-03 01:23:58 -08:00
default: '',
2020-10-22 06:46:03 -07:00
description: 'Date the invoice is due. Defaults to the issue_date if no payment_term is specified.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Estimate Id',
name: 'estimate_id',
2020-02-03 01:23:58 -08:00
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'The ID of the estimate associated with this invoice.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Issue Date',
name: 'issue_date',
type: 'dateTime',
2020-02-03 01:23:58 -08:00
default: '',
2020-10-22 06:46:03 -07:00
description: 'Date the invoice was issued. Defaults to todays date.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Notes',
name: 'notes',
2020-02-03 01:23:58 -08:00
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'Notes about the project.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Number',
name: 'number',
2020-02-03 01:23:58 -08:00
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'If no value is set, the number will be automatically generated.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Payment Term',
name: 'payment_term',
2020-02-03 01:23:58 -08:00
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'The timeframe in which the invoice should be paid. Defaults to custom. Options: upon receipt, net 15, net 30, net 45, or net 60.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Purchase Order',
name: 'purchase_order',
2020-02-03 01:23:58 -08:00
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'The purchase order number.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Retainer Id',
name: 'retainer_id',
type: 'boolean',
default: true,
2020-10-22 06:46:03 -07:00
description: 'The ID of the retainer associated with this invoice.',
},
{
displayName: 'Subject',
name: 'subject',
2020-02-03 01:23:58 -08:00
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'The invoice subject.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Tax',
name: 'tax',
type: 'string',
2020-02-03 01:23:58 -08:00
default: '',
2020-10-22 06:46:03 -07:00
description: 'This percentage is applied to the subtotal, including line items and discounts. Example: use 10.0 for 10.0%.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Tax2',
name: 'tax2',
type: 'string',
2020-02-03 01:23:58 -08:00
default: '',
2020-10-22 06:46:03 -07:00
description: 'This percentage is applied to the subtotal, including line items and discounts. Example: use 10.0 for 10.0%.',
2020-02-03 01:23:58 -08:00
},
],
},
/* -------------------------------------------------------------------------- */
/* invoice:update */
2020-02-03 01:23:58 -08:00
/* -------------------------------------------------------------------------- */
2020-02-03 01:54:21 -08:00
{
displayName: 'Invoice Id',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'update',
],
resource,
},
},
description: 'The ID of the invoice want to update.',
},
2020-02-03 01:23:58 -08:00
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: [
2020-02-03 01:54:21 -08:00
'update',
2020-02-03 01:23:58 -08:00
],
resource,
},
},
default: {},
options: [
{
2020-02-03 04:55:21 -08:00
displayName: 'Client Id',
2020-02-03 01:23:58 -08:00
name: 'client_id',
type: 'string',
default: '',
description: 'The ID of the retainer associated with this invoice..',
},
{
displayName: 'Currency',
name: 'currency',
2020-02-03 01:23:58 -08:00
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'The currency used by the invoice. If not provided, the clients currency will be used. See a list of supported currencies',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Discount',
name: 'over_budget_notification_percentage',
2020-02-03 01:23:58 -08:00
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'This percentage is subtracted from the subtotal. Example: use 10.0 for 10.0%.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Due Date',
name: 'ends_on',
type: 'dateTime',
2020-02-03 01:23:58 -08:00
default: '',
2020-10-22 06:46:03 -07:00
description: 'Date the invoice is due. Defaults to the issue_date if no payment_term is specified.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Estimate Id',
name: 'estimate_id',
2020-02-03 01:23:58 -08:00
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'The ID of the estimate associated with this invoice.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Issue Date',
name: 'issue_date',
type: 'dateTime',
2020-02-03 01:23:58 -08:00
default: '',
2020-10-22 06:46:03 -07:00
description: 'Date the invoice was issued. Defaults to todays date.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Notes',
name: 'notes',
2020-02-03 01:23:58 -08:00
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'Notes about the project.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Number',
name: 'number',
2020-02-03 01:23:58 -08:00
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'If no value is set, the number will be automatically generated.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Payment Term',
name: 'payment_term',
2020-02-03 01:23:58 -08:00
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'The timeframe in which the invoice should be paid. Defaults to custom. Options: upon receipt, net 15, net 30, net 45, or net 60.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Purchase Order',
name: 'purchase_order',
2020-02-03 01:23:58 -08:00
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'The purchase order number.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Retainer Id',
name: 'retainer_id',
type: 'boolean',
default: true,
2020-10-22 06:46:03 -07:00
description: 'The ID of the retainer associated with this invoice.',
},
{
displayName: 'Subject',
name: 'subject',
2020-02-03 01:23:58 -08:00
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'The invoice subject.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Tax',
name: 'tax',
type: 'string',
2020-02-03 01:23:58 -08:00
default: '',
2020-10-22 06:46:03 -07:00
description: 'This percentage is applied to the subtotal, including line items and discounts. Example: use 10.0 for 10.0%.',
2020-02-03 01:23:58 -08:00
},
{
displayName: 'Tax2',
name: 'tax2',
type: 'string',
2020-02-03 01:23:58 -08:00
default: '',
2020-10-22 06:46:03 -07:00
description: 'This percentage is applied to the subtotal, including line items and discounts. Example: use 10.0 for 10.0%.',
2020-02-03 01:23:58 -08:00
},
],
},
2020-01-28 07:50:15 -08:00
] as INodeProperties[];