nodes/generated

Interface InvoiceNinjaNodeParameters

Source
interface InvoiceNinjaNodeParameters {
    additionalFields?:
        | {
            clientName?: string;
            idNumber?: string;
            privateNotes?: string;
            vatNumber?: string;
            website?: string;
            workPhone?: string;
        }
        | {
            autoBill?: boolean;
            client?: string;
            customValue1?: number;
            customValue2?: number;
            discount?: string;
            dueDate?: string;
            email?: string;
            emailInvoice?: boolean;
            invoiceDate?: string;
            invoiceNumber?: string;
            invoiceStatus?: 1
            | 2;
            isAmountDiscount?: boolean;
            markSent?: boolean;
            paid?: number;
            partial?: number;
            partialDueDate?: string;
            poNumber?: string;
            privateNotes?: string;
            publicNotes?: string;
            taxName1?: string;
            taxName2?: string;
            taxRate1?: number;
            taxRate2?: number;
        }
        | {
            client?: string;
            customValue1?: string;
            customValue2?: string;
            description?: string;
            project?: string;
        }
        | {
            paymentType?: | 1
            | 3
            | 2
            | 4
            | 5
            | 10
            | 15
            | 6
            | 7
            | 28
            | 8
            | 32
            | 17
            | 16
            | 13
            | 9
            | 11
            | 31
            | 24
            | 19
            | 20
            | 21
            | 27
            | 12
            | 14
            | 30
            | 29
            | 22
            | 23
            | 25
            | 18
            | 26;
            privateNotes?: string;
            transferReference?: string;
        }
        | {
            paymentType?: | 1
            | 2
            | 4
            | 5
            | 10
            | 15
            | 6
            | 7
            | 28
            | 8
            | 32
            | 17
            | 16
            | 13
            | 9
            | 11
            | 31
            | 24
            | 19
            | 20
            | 21
            | 27
            | 12
            | 30
            | 29
            | 22
            | 18
            | 33
            | 34
            | 35
            | 36
            | 37
            | 38
            | 39
            | 40
            | 41
            | 42
            | 43
            | 44
            | 45
            | 46
            | 47
            | 48
            | 49
            | 50
            | 51
            | 52;
            privateNotes?: string;
            transferReference?: string;
        }
        | {
            amount?: number;
            billable?: boolean;
            category?: string;
            client?: string;
            customValue1?: string;
            customValue2?: string;
            expenseDate?: string;
            paymentDate?: string;
            paymentType?: | 1
            | 3
            | 2
            | 4
            | 5
            | 10
            | 15
            | 6
            | 7
            | 28
            | 8
            | 32
            | 17
            | 16
            | 13
            | 9
            | 11
            | 31
            | 24
            | 19
            | 20
            | 21
            | 27
            | 12
            | 14
            | 30
            | 29
            | 22
            | 23
            | 25
            | 18
            | 26;
            privateNotes?: string;
            publicNotes?: string;
            taxName1?: string;
            taxName2?: string;
            taxRate1?: number;
            taxRate2?: number;
            transactionReference?: string;
            vendor?: string;
        }
        | {
            amount?: number;
            billable?: boolean;
            category?: string;
            client?: string;
            customValue1?: string;
            customValue2?: string;
            expenseDate?: string;
            paymentDate?: string;
            paymentType?: | 1
            | 2
            | 4
            | 5
            | 10
            | 15
            | 6
            | 7
            | 28
            | 8
            | 32
            | 17
            | 16
            | 13
            | 9
            | 11
            | 31
            | 24
            | 19
            | 20
            | 21
            | 27
            | 12
            | 30
            | 29
            | 22
            | 18
            | 33
            | 34
            | 35
            | 36
            | 37
            | 38
            | 39
            | 40
            | 41
            | 42
            | 43
            | 44
            | 45
            | 46
            | 47
            | 48
            | 49
            | 50
            | 51
            | 52;
            privateNotes?: string;
            publicNotes?: string;
            taxName1?: string;
            taxName2?: string;
            taxRate1?: number;
            taxRate2?: number;
            transactionReference?: string;
            vendor?: string;
        }
        | {
            autoBill?: boolean;
            client?: string;
            customValue1?: number;
            customValue2?: number;
            discount?: string;
            dueDate?: string;
            email?: string;
            emailQuote?: boolean;
            isAmountDiscount?: boolean;
            paid?: number;
            partial?: number;
            partialDueDate?: string;
            poNumber?: string;
            privateNotes?: string;
            publicNotes?: string;
            quoteDate?: string;
            quoteNumber?: string;
            quoteStatus?: 1
            | 2;
            taxName1?: string;
            taxName2?: string;
            taxRate1?: number;
            taxRate2?: number;
        }
        | {
            amount?: number;
            bankIntegrationId?: string;
            baseType?: "CREDIT"
            | "DEBIT";
            currencyId?: string;
            date?: string;
            description?: string;
        };
    amount?: number;
    apiVersion?: "v4"
    | "v5";
    bankTransactionId?: string;
    billingAddressUi?: {
        billingAddressValue: {
            aptSuite?: string;
            city?: string;
            countryCode?: string;
            postalCode?: string;
            state?: string;
            streetAddress?: string;
        };
    };
    clientId?: string;
    contactsUi?: {
        contacstValues: {
            email?: string;
            firstName?: string;
            lastName?: string;
            phone?: string;
        }[];
    };
    expenseId?: string;
    invoice?: string;
    invoiceId?: string;
    invoiceItemsUi?: {
        invoiceItemsValues: {
            cost?: number;
            description?: string;
            hours?: number;
            service?: string;
            taxName1?: string;
            taxName2?: string;
            taxRate1?: number;
            taxRate2?: number;
        }[];
    };
    limit?: number;
    operation?: | "create"
    | "get"
    | "getAll"
    | "delete"
    | "email"
    | "matchPayment";
    options?: | { include?: "invoices" }
    | {
        createdAt?: string;
        include?: "invoices";
        isDeleted?: boolean;
        status?: "deleted" | "active" | "archived";
        updatedAt?: string;
    }
    | { include?: "client" }
    | {
        clientStatus?:
            | "all"
            | "overdue"
            | "paid"
            | "unpaid";
        createdAt?: string;
        include?: "client";
        invoiceNumber?: string;
        isDeleted?: boolean;
        status?: "deleted"
        | "active"
        | "archived";
        updatedAt?: string;
    }
    | {
        createdAt?: string;
        include?: "client";
        isDeleted?: boolean;
        status?: "deleted"
        | "active"
        | "archived";
        updatedAt?: string;
    }
    | {
        createdAt?: string;
        include?: "client";
        isDeleted?: boolean;
        quoteNumber?: string;
        status?: "deleted"
        | "active"
        | "archived";
        updatedAt?: string;
    };
    paymentId?: string;
    quoteId?: string;
    resource?: | "task"
    | "invoice"
    | "client"
    | "expense"
    | "bank_transaction"
    | "payment"
    | "quote";
    returnAll?: boolean;
    shippingAddressUi?: {
        shippingAddressValue: {
            aptSuite?: string;
            city?: string;
            countryCode?: string;
            postalCode?: string;
            state?: string;
            streetAddress?: string;
        };
    };
    taskId?: string;
    timeLogsUi?: {
        timeLogsValues: {
            duration?: number;
            endDate?: string;
            startDate?: string;
        }[];
    };
}

Properties§

Source§

readonly additionalFields?:
    | {
        clientName?: string;
        idNumber?: string;
        privateNotes?: string;
        vatNumber?: string;
        website?: string;
        workPhone?: string;
    }
    | {
        autoBill?: boolean;
        client?: string;
        customValue1?: number;
        customValue2?: number;
        discount?: string;
        dueDate?: string;
        email?: string;
        emailInvoice?: boolean;
        invoiceDate?: string;
        invoiceNumber?: string;
        invoiceStatus?: 1
        | 2;
        isAmountDiscount?: boolean;
        markSent?: boolean;
        paid?: number;
        partial?: number;
        partialDueDate?: string;
        poNumber?: string;
        privateNotes?: string;
        publicNotes?: string;
        taxName1?: string;
        taxName2?: string;
        taxRate1?: number;
        taxRate2?: number;
    }
    | {
        client?: string;
        customValue1?: string;
        customValue2?: string;
        description?: string;
        project?: string;
    }
    | {
        paymentType?: | 1
        | 3
        | 2
        | 4
        | 5
        | 10
        | 15
        | 6
        | 7
        | 28
        | 8
        | 32
        | 17
        | 16
        | 13
        | 9
        | 11
        | 31
        | 24
        | 19
        | 20
        | 21
        | 27
        | 12
        | 14
        | 30
        | 29
        | 22
        | 23
        | 25
        | 18
        | 26;
        privateNotes?: string;
        transferReference?: string;
    }
    | {
        paymentType?: | 1
        | 2
        | 4
        | 5
        | 10
        | 15
        | 6
        | 7
        | 28
        | 8
        | 32
        | 17
        | 16
        | 13
        | 9
        | 11
        | 31
        | 24
        | 19
        | 20
        | 21
        | 27
        | 12
        | 30
        | 29
        | 22
        | 18
        | 33
        | 34
        | 35
        | 36
        | 37
        | 38
        | 39
        | 40
        | 41
        | 42
        | 43
        | 44
        | 45
        | 46
        | 47
        | 48
        | 49
        | 50
        | 51
        | 52;
        privateNotes?: string;
        transferReference?: string;
    }
    | {
        amount?: number;
        billable?: boolean;
        category?: string;
        client?: string;
        customValue1?: string;
        customValue2?: string;
        expenseDate?: string;
        paymentDate?: string;
        paymentType?: | 1
        | 3
        | 2
        | 4
        | 5
        | 10
        | 15
        | 6
        | 7
        | 28
        | 8
        | 32
        | 17
        | 16
        | 13
        | 9
        | 11
        | 31
        | 24
        | 19
        | 20
        | 21
        | 27
        | 12
        | 14
        | 30
        | 29
        | 22
        | 23
        | 25
        | 18
        | 26;
        privateNotes?: string;
        publicNotes?: string;
        taxName1?: string;
        taxName2?: string;
        taxRate1?: number;
        taxRate2?: number;
        transactionReference?: string;
        vendor?: string;
    }
    | {
        amount?: number;
        billable?: boolean;
        category?: string;
        client?: string;
        customValue1?: string;
        customValue2?: string;
        expenseDate?: string;
        paymentDate?: string;
        paymentType?: | 1
        | 2
        | 4
        | 5
        | 10
        | 15
        | 6
        | 7
        | 28
        | 8
        | 32
        | 17
        | 16
        | 13
        | 9
        | 11
        | 31
        | 24
        | 19
        | 20
        | 21
        | 27
        | 12
        | 30
        | 29
        | 22
        | 18
        | 33
        | 34
        | 35
        | 36
        | 37
        | 38
        | 39
        | 40
        | 41
        | 42
        | 43
        | 44
        | 45
        | 46
        | 47
        | 48
        | 49
        | 50
        | 51
        | 52;
        privateNotes?: string;
        publicNotes?: string;
        taxName1?: string;
        taxName2?: string;
        taxRate1?: number;
        taxRate2?: number;
        transactionReference?: string;
        vendor?: string;
    }
    | {
        autoBill?: boolean;
        client?: string;
        customValue1?: number;
        customValue2?: number;
        discount?: string;
        dueDate?: string;
        email?: string;
        emailQuote?: boolean;
        isAmountDiscount?: boolean;
        paid?: number;
        partial?: number;
        partialDueDate?: string;
        poNumber?: string;
        privateNotes?: string;
        publicNotes?: string;
        quoteDate?: string;
        quoteNumber?: string;
        quoteStatus?: 1
        | 2;
        taxName1?: string;
        taxName2?: string;
        taxRate1?: number;
        taxRate2?: number;
    }
    | {
        amount?: number;
        bankIntegrationId?: string;
        baseType?: "CREDIT"
        | "DEBIT";
        currencyId?: string;
        date?: string;
        description?: string;
    }

Default: {}

Source§

readonly amount?: number

Type options: {"minValue":0}

Source§

readonly apiVersion?: "v4" | "v5"

Default: "v4"

Source§

readonly bankTransactionId?: string

Source§

readonly billingAddressUi?: {
    billingAddressValue: {
        aptSuite?: string;
        city?: string;
        countryCode?: string;
        postalCode?: string;
        state?: string;
        streetAddress?: string;
    };
}

Default: {} Type options: {"multipleValues":false}

Source§

readonly clientId?: string

Source§

readonly contactsUi?: {
    contacstValues: {
        email?: string;
        firstName?: string;
        lastName?: string;
        phone?: string;
    }[];
}

Default: {} Type options: {"multipleValues":true}

Source§

readonly expenseId?: string

Source§

readonly invoice?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getInvoices"}

Source§

readonly invoiceId?: string

Source§

readonly invoiceItemsUi?: {
    invoiceItemsValues: {
        cost?: number;
        description?: string;
        hours?: number;
        service?: string;
        taxName1?: string;
        taxName2?: string;
        taxRate1?: number;
        taxRate2?: number;
    }[];
}

Default: {} Type options: {"multipleValues":true}

Source§

readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1,"maxValue":60}

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "delete"
    | "email"
    | "matchPayment"

Default: "create"

Source§

readonly options?:
    | { include?: "invoices" }
    | {
        createdAt?: string;
        include?: "invoices";
        isDeleted?: boolean;
        status?: "deleted" | "active" | "archived";
        updatedAt?: string;
    }
    | { include?: "client" }
    | {
        clientStatus?:
            | "all"
            | "overdue"
            | "paid"
            | "unpaid";
        createdAt?: string;
        include?: "client";
        invoiceNumber?: string;
        isDeleted?: boolean;
        status?: "deleted"
        | "active"
        | "archived";
        updatedAt?: string;
    }
    | {
        createdAt?: string;
        include?: "client";
        isDeleted?: boolean;
        status?: "deleted"
        | "active"
        | "archived";
        updatedAt?: string;
    }
    | {
        createdAt?: string;
        include?: "client";
        isDeleted?: boolean;
        quoteNumber?: string;
        status?: "deleted"
        | "active"
        | "archived";
        updatedAt?: string;
    }

Default: {}

Source§

readonly paymentId?: string

Source§

readonly quoteId?: string

Source§

readonly resource?:
    | "task"
    | "invoice"
    | "client"
    | "expense"
    | "bank_transaction"
    | "payment"
    | "quote"

Default: "client"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly shippingAddressUi?: {
    shippingAddressValue: {
        aptSuite?: string;
        city?: string;
        countryCode?: string;
        postalCode?: string;
        state?: string;
        streetAddress?: string;
    };
}

Default: {} Type options: {"multipleValues":false}

Source§

readonly taskId?: string

Source§

readonly timeLogsUi?: {
    timeLogsValues: {
        duration?: number;
        endDate?: string;
        startDate?: string;
    }[];
}

Default: {} Type options: {"multipleValues":true}