UNPKG

n8n-nodes-quipu

Version:

Quipu integration for n8n - invoice and taxes software for freelancers and companies

1,333 lines 120 kB
{ "openapi": "3.0.3", "info": { "title": "Quipu API", "description": "Quipu is an invoice and taxes software as a service for freelances and companies.\n\nTo use our API you need to sign up in our software. You will have 15 days to try it for free.\nIf you need more time, contact our support team to extend the trial period.\n\nFor more information about our API, libraries and other applications, visit: https://getquipu.com/en/integrations.", "version": "1.0.0" }, "servers": [ { "url": "https://getquipu.com", "description": "Production server" } ], "security": [ { "oauth2": [] } ], "paths": { "/oauth/token": { "post": { "summary": "Get an access token", "operationId": "getAccessToken", "tags": ["Authentication"], "security": [], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": ["grant_type", "scope"], "properties": { "grant_type": { "type": "string", "enum": ["client_credentials"] }, "scope": { "type": "string", "example": "ecommerce" } } } } } }, "responses": { "200": { "description": "Successfully authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } } } } }, "/contacts": { "get": { "summary": "Retrieve all contacts", "operationId": "getContacts", "tags": ["Contacts"], "parameters": [ { "$ref": "#/components/parameters/FilterQ" }, { "$ref": "#/components/parameters/FilterKind" }, { "$ref": "#/components/parameters/FilterTaxId" }, { "$ref": "#/components/parameters/FilterCountry" }, { "$ref": "#/components/parameters/FilterEmail" }, { "$ref": "#/components/parameters/SortParameter" }, { "$ref": "#/components/parameters/PageNumber" } ], "responses": { "200": { "description": "Successful response", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ContactCollection" } } } } } }, "post": { "summary": "Create a new contact", "operationId": "createContact", "tags": ["Contacts"], "requestBody": { "required": true, "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ContactCreate" } } } }, "responses": { "204": { "description": "Contact created successfully", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ContactResponse" } } } }, "422": { "description": "Validation error", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/contacts/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "summary": "Retrieve a specific contact", "operationId": "getContact", "tags": ["Contacts"], "responses": { "200": { "description": "Successful response", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ContactResponse" } } } } } }, "patch": { "summary": "Update a contact", "operationId": "updateContact", "tags": ["Contacts"], "requestBody": { "required": true, "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ContactUpdate" } } } }, "responses": { "200": { "description": "Contact updated successfully", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ContactResponse" } } } }, "422": { "description": "Validation error", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "summary": "Delete a contact", "operationId": "deleteContact", "tags": ["Contacts"], "responses": { "204": { "description": "Contact deleted successfully" }, "403": { "description": "Contact could not be deleted" } } } }, "/book_entries": { "get": { "summary": "Retrieve all invoices, tickets and paysheets", "operationId": "getBookEntries", "tags": ["Book Entries"], "parameters": [ { "$ref": "#/components/parameters/FilterType" }, { "$ref": "#/components/parameters/FilterKind" }, { "$ref": "#/components/parameters/FilterQ" }, { "$ref": "#/components/parameters/FilterPeriod" }, { "$ref": "#/components/parameters/FilterPaymentStatus" }, { "$ref": "#/components/parameters/FilterContactId" }, { "$ref": "#/components/parameters/FilterFieldQuery" }, { "$ref": "#/components/parameters/SortParameter" }, { "$ref": "#/components/parameters/PageNumber" } ], "responses": { "200": { "description": "Successful response", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/BookEntryCollection" } } } } } } }, "/invoices": { "get": { "summary": "Retrieve all invoices", "operationId": "getInvoices", "tags": ["Invoices"], "parameters": [ { "$ref": "#/components/parameters/FilterKind" }, { "$ref": "#/components/parameters/FilterQ" }, { "$ref": "#/components/parameters/FilterPeriod" }, { "$ref": "#/components/parameters/FilterPaymentStatus" }, { "$ref": "#/components/parameters/FilterContactId" }, { "$ref": "#/components/parameters/FilterFieldQuery" }, { "$ref": "#/components/parameters/SortParameter" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/IncludeItems" } ], "responses": { "200": { "description": "Successful response", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/InvoiceCollection" } } } } } }, "post": { "summary": "Create a new invoice", "operationId": "createInvoice", "tags": ["Invoices"], "requestBody": { "required": true, "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/InvoiceCreate" } } } }, "responses": { "201": { "description": "Invoice created successfully", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } } } }, "422": { "description": "Validation error", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/invoices/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "summary": "Retrieve a specific invoice", "operationId": "getInvoice", "tags": ["Invoices"], "parameters": [ { "$ref": "#/components/parameters/IncludeItems" } ], "responses": { "200": { "description": "Successful response", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } } } } } }, "patch": { "summary": "Update an invoice", "operationId": "updateInvoice", "tags": ["Invoices"], "requestBody": { "required": true, "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/InvoiceUpdate" } } } }, "responses": { "200": { "description": "Invoice updated successfully", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } } } }, "422": { "description": "Validation error", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "summary": "Delete an invoice", "operationId": "deleteInvoice", "tags": ["Invoices"], "responses": { "204": { "description": "Invoice deleted successfully" } } } }, "/tickets": { "get": { "summary": "Retrieve all tickets", "operationId": "getTickets", "tags": ["Tickets"], "parameters": [ { "$ref": "#/components/parameters/FilterKind" }, { "$ref": "#/components/parameters/FilterQ" }, { "$ref": "#/components/parameters/FilterPeriod" }, { "$ref": "#/components/parameters/FilterPaymentStatus" }, { "$ref": "#/components/parameters/FilterContactId" }, { "$ref": "#/components/parameters/FilterFieldQuery" }, { "$ref": "#/components/parameters/SortParameter" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/IncludeItems" } ], "responses": { "200": { "description": "Successful response", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/TicketCollection" } } } } } }, "post": { "summary": "Create a new ticket", "operationId": "createTicket", "tags": ["Tickets"], "requestBody": { "required": true, "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/TicketCreate" } } } }, "responses": { "201": { "description": "Ticket created successfully", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/TicketResponse" } } } }, "422": { "description": "Validation error", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tickets/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "summary": "Retrieve a specific ticket", "operationId": "getTicket", "tags": ["Tickets"], "parameters": [ { "$ref": "#/components/parameters/IncludeItems" } ], "responses": { "200": { "description": "Successful response", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/TicketResponse" } } } } } }, "patch": { "summary": "Update a ticket", "operationId": "updateTicket", "tags": ["Tickets"], "requestBody": { "required": true, "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/TicketUpdate" } } } }, "responses": { "200": { "description": "Ticket updated successfully", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/TicketResponse" } } } }, "422": { "description": "Validation error", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "summary": "Delete a ticket", "operationId": "deleteTicket", "tags": ["Tickets"], "responses": { "204": { "description": "Ticket deleted successfully" } } } }, "/paysheets": { "get": { "summary": "Retrieve all paysheets", "operationId": "getPaysheets", "tags": ["Paysheets"], "parameters": [ { "$ref": "#/components/parameters/FilterQ" }, { "$ref": "#/components/parameters/FilterPeriod" }, { "$ref": "#/components/parameters/FilterPaymentStatus" }, { "$ref": "#/components/parameters/FilterContactId" }, { "$ref": "#/components/parameters/FilterFieldQuery" }, { "$ref": "#/components/parameters/SortParameter" }, { "$ref": "#/components/parameters/PageNumber" } ], "responses": { "200": { "description": "Successful response", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/PaysheetCollection" } } } } } }, "post": { "summary": "Create a new paysheet", "operationId": "createPaysheet", "tags": ["Paysheets"], "requestBody": { "required": true, "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/PaysheetCreate" } } } }, "responses": { "201": { "description": "Paysheet created successfully", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/PaysheetResponse" } } } }, "422": { "description": "Validation error", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/paysheets/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "summary": "Retrieve a specific paysheet", "operationId": "getPaysheet", "tags": ["Paysheets"], "responses": { "200": { "description": "Successful response", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/PaysheetResponse" } } } } } }, "patch": { "summary": "Update a paysheet", "operationId": "updatePaysheet", "tags": ["Paysheets"], "requestBody": { "required": true, "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/PaysheetUpdate" } } } }, "responses": { "200": { "description": "Paysheet updated successfully", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/PaysheetResponse" } } } }, "422": { "description": "Validation error", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "summary": "Delete a paysheet", "operationId": "deletePaysheet", "tags": ["Paysheets"], "responses": { "204": { "description": "Paysheet deleted successfully" } } } }, "/numbering_series": { "get": { "summary": "Retrieve all numbering series", "operationId": "getNumberingSeries", "tags": ["Numbering Series"], "parameters": [ { "$ref": "#/components/parameters/FilterPrefix" }, { "$ref": "#/components/parameters/FilterApplicableTo" }, { "$ref": "#/components/parameters/FilterAmending" } ], "responses": { "200": { "description": "Successful response", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/NumberingSeriesCollection" } } } } } }, "post": { "summary": "Create a new numbering series", "operationId": "createNumberingSeries", "tags": ["Numbering Series"], "requestBody": { "required": true, "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/NumberingSeriesCreate" } } } }, "responses": { "201": { "description": "Numbering series created successfully", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/NumberingSeriesResponse" } } } }, "422": { "description": "Validation error", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/numbering_series/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "summary": "Retrieve a specific numbering series", "operationId": "getNumberingSerie", "tags": ["Numbering Series"], "responses": { "200": { "description": "Successful response", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/NumberingSeriesResponse" } } } } } }, "patch": { "summary": "Update a numbering series", "operationId": "updateNumberingSeries", "tags": ["Numbering Series"], "requestBody": { "required": true, "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/NumberingSeriesUpdate" } } } }, "responses": { "200": { "description": "Numbering series updated successfully", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/NumberingSeriesResponse" } } } }, "422": { "description": "Validation error", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "summary": "Delete a numbering series", "operationId": "deleteNumberingSeries", "tags": ["Numbering Series"], "responses": { "204": { "description": "Numbering series deleted successfully" }, "403": { "description": "Numbering series could not be deleted" } } } }, "/accounting_categories": { "get": { "summary": "Retrieve all accounting categories", "operationId": "getAccountingCategories", "tags": ["Accounting Categories"], "parameters": [ { "$ref": "#/components/parameters/FilterKind" }, { "$ref": "#/components/parameters/FilterAccountingPrefix" } ], "responses": { "200": { "description": "Successful response", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/AccountingCategoryCollection" } } } } } } }, "/accounting_categories/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "summary": "Retrieve a specific accounting category", "operationId": "getAccountingCategory", "tags": ["Accounting Categories"], "responses": { "200": { "description": "Successful response", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/AccountingCategoryResponse" } } } } } } }, "/accounting_subcategories": { "get": { "summary": "Retrieve all accounting subcategories", "operationId": "getAccountingSubcategories", "tags": ["Accounting Subcategories"], "parameters": [ { "$ref": "#/components/parameters/FilterAccountingCategoryId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/AccountingSubcategoryCollection" } } } } } }, "post": { "summary": "Create a new accounting subcategory", "operationId": "createAccountingSubcategory", "tags": ["Accounting Subcategories"], "requestBody": { "required": true, "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/AccountingSubcategoryCreate" } } } }, "responses": { "201": { "description": "Accounting subcategory created successfully", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/AccountingSubcategoryResponse" } } } }, "422": { "description": "Validation error", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/accounting_subcategories/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "summary": "Retrieve a specific accounting subcategory", "operationId": "getAccountingSubcategory", "tags": ["Accounting Subcategories"], "responses": { "200": { "description": "Successful response", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/AccountingSubcategoryResponse" } } } } } }, "patch": { "summary": "Update an accounting subcategory", "operationId": "updateAccountingSubcategory", "tags": ["Accounting Subcategories"], "requestBody": { "required": true, "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/AccountingSubcategoryUpdate" } } } }, "responses": { "200": { "description": "Accounting subcategory updated successfully", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/AccountingSubcategoryResponse" } } } }, "422": { "description": "Validation error", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "summary": "Delete an accounting subcategory", "operationId": "deleteAccountingSubcategory", "tags": ["Accounting Subcategories"], "responses": { "204": { "description": "Accounting subcategory deleted successfully" } } } }, "/attachments": { "post": { "summary": "Upload a new attachment", "operationId": "createAttachment", "tags": ["Attachments"], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": ["file", "book_entry_id"], "properties": { "file": { "type": "string", "format": "binary" }, "book_entry_id": { "type": "string" } } } } } }, "responses": { "201": { "description": "Attachment created successfully", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/AttachmentResponse" } } } }, "422": { "description": "Validation error", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/attachments/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "summary": "Retrieve a specific attachment", "operationId": "getAttachment", "tags": ["Attachments"], "responses": { "200": { "description": "Successful response", "content": { "application/vnd.quipu.v1+json": { "schema": { "$ref": "#/components/schemas/AttachmentResponse" } } } } } }, "delete": { "summary": "Delete an attachment", "operationId": "deleteAttachment", "tags": ["Attachments"], "responses": { "204": { "description": "Attachment deleted successfully" } } } } }, "components": { "securitySchemes": { "oauth2": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "/oauth/token", "scopes": { "ecommerce": "Access to ecommerce operations" } } } } }, "parameters": { "FilterQ": { "name": "filter[q]", "in": "query", "description": "Search query", "schema": { "nullable": true, "type": "string" } }, "FilterKind": { "name": "filter[kind]", "in": "query", "description": "Filter by kind", "schema": { "type": "string", "nullable": true, "enum": [ "income", "expenses", "employee", "supplier", "client", "assets" ] } }, "FilterTaxId": { "name": "filter[tax_id]", "in": "query", "description": "Filter by tax ID", "schema": { "nullable": true, "type": "string" } }, "FilterCountry": { "name": "filter[country]", "in": "query", "description": "Filter by countries (comma separated)", "schema": { "nullable": true, "type": "string" } }, "FilterEmail": { "name": "filter[email]", "in": "query", "description": "Filter by email", "schema": { "nullable": true, "type": "string" } }, "FilterType": { "name": "filter[type]", "in": "query", "description": "Filter by type", "schema": { "type": "string", "nullable": true, "enum": ["invoices", "tickets", "paysheets"] } }, "FilterPeriod": { "name": "filter[period]", "in": "query", "description": "Filter by period", "schema": { "type": "string", "nullable": true, "example": "2015-Q1" } }, "FilterPaymentStatus": { "name": "filter[payment_status]", "in": "query", "description": "Filter by payment status", "schema": { "type": "string", "nullable": true, "enum": ["paid", "unpaid", "due", "pending"] } }, "FilterContactId": { "name": "filter[contact_id]", "in": "query", "description": "Filter by contact ID", "schema": { "type": "string", "nullable": true } }, "FilterFieldQuery": { "name": "filter[field_query]", "in": "query", "description": "Filter by field and term", "schema": { "type": "object", "properties": { "field": { "type": "string", "nullable": true }, "term": { "type": "string", "nullable": true } } } }, "FilterPrefix": { "name": "filter[prefix]", "in": "query", "description": "Filter by prefix", "schema": { "type": "string", "nullable": true } }, "FilterApplicableTo": { "name": "filter[applicable_to]", "in": "query", "description": "Filter by applicable document type", "schema": { "type": "string", "nullable": true, "enum": ["invoices", "tickets", "budgets"] } }, "FilterAmending": { "name": "filter[amending]", "in": "query", "description": "Filter by amending status", "schema": { "type": "boolean", "nullable": true, "e