447 lines
9.0 KiB
TypeScript
447 lines
9.0 KiB
TypeScript
import type { INodeProperties } from 'n8n-workflow';
|
|
|
|
export const invoiceDescription: INodeProperties[] = [
|
|
{
|
|
"displayName": "Operation",
|
|
"name": "operation",
|
|
"type": "options",
|
|
"noDataExpression": true,
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
]
|
|
}
|
|
},
|
|
"options": [
|
|
{
|
|
"name": "Order API Create Invoice",
|
|
"value": "Order API Create Invoice",
|
|
"action": "Create an invoice for an existing order. This request is extra throttled by order and api key to a maximum of 1 per 5 minutes.",
|
|
"description": "Create an invoice for an existing order. This request is extra throttled by order and api key to a maximum of 1 per 5 minutes.",
|
|
"routing": {
|
|
"request": {
|
|
"method": "POST",
|
|
"url": "=/api/v1/orders/CreateInvoice/{{$parameter[\"id\"]}}"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Order API Get Invoice List",
|
|
"value": "Order API Get Invoice List",
|
|
"action": "Get a list of all invoices optionally filtered by date. This request ist throttled to 1 per 1 minute for same page and minInvoiceDate",
|
|
"description": "Get a list of all invoices optionally filtered by date. This request ist throttled to 1 per 1 minute for same page and minInvoiceDate",
|
|
"routing": {
|
|
"request": {
|
|
"method": "GET",
|
|
"url": "=/api/v1/orders/invoices"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"default": ""
|
|
},
|
|
{
|
|
"displayName": "POST /api/v1/orders/CreateInvoice/{id}",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
],
|
|
"operation": [
|
|
"Order API Create Invoice"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "id",
|
|
"required": true,
|
|
"description": "The internal billbee id of the order",
|
|
"default": 0,
|
|
"type": "number",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
],
|
|
"operation": [
|
|
"Order API Create Invoice"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Include Invoice PDF",
|
|
"name": "includeInvoicePdf",
|
|
"description": "If true, the PDF is included in the response as base64 encoded string",
|
|
"default": true,
|
|
"type": "boolean",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "includeInvoicePdf",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
],
|
|
"operation": [
|
|
"Order API Create Invoice"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Template ID",
|
|
"name": "templateId",
|
|
"description": "You can pass the id of an invoice template to overwrite the assigned template for invoice creation",
|
|
"default": 0,
|
|
"type": "number",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "templateId",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
],
|
|
"operation": [
|
|
"Order API Create Invoice"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Send To Cloud ID",
|
|
"name": "sendToCloudId",
|
|
"description": "You can pass the id of a connected cloud printer/storage to send the invoice to it",
|
|
"default": 0,
|
|
"type": "number",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "sendToCloudId",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
],
|
|
"operation": [
|
|
"Order API Create Invoice"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "GET /api/v1/orders/invoices",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
],
|
|
"operation": [
|
|
"Order API Get Invoice List"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Min Invoice Date",
|
|
"name": "minInvoiceDate",
|
|
"description": "Specifies the oldest invoice date to include",
|
|
"default": "",
|
|
"type": "string",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "minInvoiceDate",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
],
|
|
"operation": [
|
|
"Order API Get Invoice List"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Max Invoice Date",
|
|
"name": "maxInvoiceDate",
|
|
"description": "Specifies the newest invoice date to include",
|
|
"default": "",
|
|
"type": "string",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "maxInvoiceDate",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
],
|
|
"operation": [
|
|
"Order API Get Invoice List"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Page",
|
|
"name": "page",
|
|
"description": "Specifies the page to request",
|
|
"default": 0,
|
|
"type": "number",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "page",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
],
|
|
"operation": [
|
|
"Order API Get Invoice List"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Page Size",
|
|
"name": "pageSize",
|
|
"description": "Specifies the pagesize. Defaults to 50, max value is 250",
|
|
"default": 0,
|
|
"type": "number",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "pageSize",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
],
|
|
"operation": [
|
|
"Order API Get Invoice List"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Shop ID",
|
|
"name": "shopId",
|
|
"description": "Specifies a list of shop ids for which invoices should be included",
|
|
"default": "[\n null\n]",
|
|
"type": "json",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "shopId",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
],
|
|
"operation": [
|
|
"Order API Get Invoice List"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Order State ID",
|
|
"name": "orderStateId",
|
|
"description": "Specifies a list of state ids to include in the response",
|
|
"default": "[\n null\n]",
|
|
"type": "json",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "orderStateId",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
],
|
|
"operation": [
|
|
"Order API Get Invoice List"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Tag",
|
|
"name": "tag",
|
|
"default": "[\n null\n]",
|
|
"type": "json",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "tag",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
],
|
|
"operation": [
|
|
"Order API Get Invoice List"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Min Pay Date",
|
|
"name": "minPayDate",
|
|
"default": "",
|
|
"type": "string",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "minPayDate",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
],
|
|
"operation": [
|
|
"Order API Get Invoice List"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Max Pay Date",
|
|
"name": "maxPayDate",
|
|
"default": "",
|
|
"type": "string",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "maxPayDate",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
],
|
|
"operation": [
|
|
"Order API Get Invoice List"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Include Positions",
|
|
"name": "includePositions",
|
|
"default": true,
|
|
"type": "boolean",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "includePositions",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
],
|
|
"operation": [
|
|
"Order API Get Invoice List"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Exclude Tags",
|
|
"name": "excludeTags",
|
|
"description": "If true the list of tags passed to the call are used to filter orders to not include these tags",
|
|
"default": true,
|
|
"type": "boolean",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "excludeTags",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Invoice"
|
|
],
|
|
"operation": [
|
|
"Order API Get Invoice List"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
];
|