Invoice Ninja
Node: invoiceNinja · Full type: n8n-nodes-base.invoiceNinja · Version: 2
Credentials
invoiceNinjaApi (alias: @invoice)
CREDENTIAL @invoice = invoiceNinjaApi "My Invoice Ninja"
Operations
Resource: bank_transaction
create
| Parameter |
Type |
Default |
Details |
additionalFields |
collection |
{} |
keys: amount, bankIntegrationId, baseType, currencyId, date, description |
delete
| Parameter |
Type |
Default |
Details |
bankTransactionId |
string |
"" |
required |
get
| Parameter |
Type |
Default |
Details |
bankTransactionId |
string |
"" |
required |
getAll
| Parameter |
Type |
Default |
Details |
returnAll |
boolean |
false |
|
limit |
number |
50 |
|
matchPayment
| Parameter |
Type |
Default |
Details |
bankTransactionId |
string |
"" |
required |
paymentId |
options |
"" |
|
Resource: client
create
| Parameter |
Type |
Default |
Details |
additionalFields |
collection |
{} |
keys: clientName, idNumber, privateNotes, vatNumber, workPhone, website |
billingAddressUi |
fixedCollection |
{} |
groups: billingAddressValue |
contactsUi |
fixedCollection |
{} |
groups: contacstValues |
shippingAddressUi |
fixedCollection |
{} |
groups: shippingAddressValue |
delete
| Parameter |
Type |
Default |
Details |
clientId |
string |
"" |
required |
get
| Parameter |
Type |
Default |
Details |
clientId |
string |
"" |
required |
options |
collection |
{} |
keys: include |
getAll
| Parameter |
Type |
Default |
Details |
returnAll |
boolean |
false |
|
limit |
number |
50 |
|
options |
collection |
{} |
keys: include, status, createdAt, updatedAt, isDeleted |
Resource: expense
create
| Parameter |
Type |
Default |
Details |
additionalFields |
collection |
{} |
keys: amount, billable, client, customValue1, customValue2, category, ... |
additionalFields |
collection |
{} |
keys: amount, billable, client, customValue1, customValue2, category, ... |
delete
| Parameter |
Type |
Default |
Details |
expenseId |
string |
"" |
required |
get
| Parameter |
Type |
Default |
Details |
expenseId |
string |
"" |
required |
getAll
| Parameter |
Type |
Default |
Details |
returnAll |
boolean |
false |
|
limit |
number |
50 |
|
Resource: invoice
create
| Parameter |
Type |
Default |
Details |
additionalFields |
collection |
{} |
keys: client, autoBill, customValue1, customValue2, discount, dueDate, ... |
invoiceItemsUi |
fixedCollection |
{} |
groups: invoiceItemsValues |
delete
| Parameter |
Type |
Default |
Details |
invoiceId |
string |
"" |
required |
email
| Parameter |
Type |
Default |
Details |
invoiceId |
string |
"" |
required |
get
| Parameter |
Type |
Default |
Details |
invoiceId |
string |
"" |
required |
options |
collection |
{} |
keys: include |
getAll
| Parameter |
Type |
Default |
Details |
returnAll |
boolean |
false |
|
limit |
number |
50 |
|
options |
collection |
{} |
keys: invoiceNumber, include, status, createdAt, updatedAt, isDeleted, ... |
Resource: payment
create
| Parameter |
Type |
Default |
Details |
invoice |
options |
"" |
|
amount |
number |
0 |
|
additionalFields |
collection |
{} |
keys: paymentType, transferReference, privateNotes |
additionalFields |
collection |
{} |
keys: paymentType, transferReference, privateNotes |
delete
| Parameter |
Type |
Default |
Details |
paymentId |
string |
"" |
required |
get
| Parameter |
Type |
Default |
Details |
paymentId |
string |
"" |
required |
options |
collection |
{} |
keys: include |
getAll
| Parameter |
Type |
Default |
Details |
returnAll |
boolean |
false |
|
limit |
number |
50 |
|
options |
collection |
{} |
keys: include, status, createdAt, updatedAt, isDeleted |
Resource: quote
create
| Parameter |
Type |
Default |
Details |
additionalFields |
collection |
{} |
keys: client, autoBill, customValue1, customValue2, discount, dueDate, ... |
invoiceItemsUi |
fixedCollection |
{} |
groups: invoiceItemsValues |
delete
| Parameter |
Type |
Default |
Details |
quoteId |
string |
"" |
required |
email
| Parameter |
Type |
Default |
Details |
quoteId |
string |
"" |
required |
get
| Parameter |
Type |
Default |
Details |
quoteId |
string |
"" |
required |
options |
collection |
{} |
keys: include |
getAll
| Parameter |
Type |
Default |
Details |
returnAll |
boolean |
false |
|
limit |
number |
50 |
|
options |
collection |
{} |
keys: quoteNumber, include, status, createdAt, updatedAt, isDeleted |
Resource: task
create
| Parameter |
Type |
Default |
Details |
additionalFields |
collection |
{} |
keys: client, customValue1, customValue2, description, project |
timeLogsUi |
fixedCollection |
{} |
groups: timeLogsValues |
delete
| Parameter |
Type |
Default |
Details |
taskId |
string |
"" |
required |
get
| Parameter |
Type |
Default |
Details |
taskId |
string |
"" |
required |
options |
collection |
{} |
keys: include |
getAll
| Parameter |
Type |
Default |
Details |
returnAll |
boolean |
false |
|
limit |
number |
50 |
|
options |
collection |
{} |
keys: include |
Common Parameters
| Parameter |
Type |
Default |
Details |
apiVersion |
options |
"v4" |
v4, v5 |
Parameter Details
additionalFields children:
| Parameter |
Type |
Default |
Details |
clientName |
string |
"" |
|
idNumber |
string |
"" |
|
privateNotes |
string |
"" |
|
vatNumber |
string |
"" |
|
workPhone |
string |
"" |
|
website |
string |
"" |
|
billingAddressUi children:
billingAddressValue group:
| Parameter |
Type |
Default |
Details |
streetAddress |
string |
"" |
|
aptSuite |
string |
"" |
|
city |
string |
"" |
|
state |
string |
"" |
|
postalCode |
string |
"" |
|
countryCode |
options |
"" |
|
contactsUi children:
contacstValues group:
| Parameter |
Type |
Default |
Details |
firstName |
string |
"" |
|
lastName |
string |
"" |
|
email |
string |
"" |
|
phone |
string |
"" |
|
shippingAddressUi children:
shippingAddressValue group:
| Parameter |
Type |
Default |
Details |
streetAddress |
string |
"" |
|
aptSuite |
string |
"" |
|
city |
string |
"" |
|
state |
string |
"" |
|
postalCode |
string |
"" |
|
countryCode |
options |
"" |
|
options children:
| Parameter |
Type |
Default |
Details |
include |
options |
"invoices" |
invoices |
invoiceItemsUi children:
invoiceItemsValues group:
| Parameter |
Type |
Default |
Details |
cost |
number |
0 |
|
description |
string |
"" |
|
service |
string |
"" |
|
hours |
number |
0 |
|
taxName1 |
string |
"" |
|
taxName2 |
string |
"" |
|
taxRate1 |
number |
0 |
|
taxRate2 |
number |
0 |
|
timeLogsUi children:
timeLogsValues group:
| Parameter |
Type |
Default |
Details |
startDate |
dateTime |
"" |
|
endDate |
dateTime |
"" |
|
duration |
number |
0 |
|
Example
NODE "invoiceNinja" @invoice AS "Invoice Ninja" {
resource: "bank_transaction",
operation: "get",
clientId: {{ $json.clientId }},
invoiceId: {{ $json.invoiceId }},
taskId: {{ $json.taskId }}
}