nodes/generated

Interface XeroNodeParameters

Source
interface XeroNodeParameters {
    additionalFields?:
        | {
            accountNumber?: string;
            addressesUi?: {
                addressesValues: {
                    attentionTo?: string;
                    city?: string;
                    country?: string;
                    line1?: string;
                    line2?: string;
                    postalCode?: string;
                    region?: string;
                    type?: "POBOX"
                    | "STREET";
                }[];
            };
            bankAccountDetails?: string;
            contactNumber?: string;
            contactStatus?: "ACTIVE"
            | "ARCHIVED"
            | "GDPRREQUEST";
            defaultCurrency?: string;
            emailAddress?: string;
            firstName?: string;
            lastName?: string;
            phonesUi?: {
                phonesValues: {
                    phoneAreaCode?: string;
                    phoneCountryCode?: string;
                    phoneNumber?: string;
                    phoneType?: "DEFAULT" | "DDI" | "MOBILE" | "FAX";
                }[];
            };
            purchasesDefaultAccountCode?: string;
            salesDefaultAccountCode?: string;
            skypeUserName?: string;
            taxNumber?: string;
            xeroNetworkKey?: string;
        }
        | {
            brandingThemeId?: string;
            currency?: string;
            currencyRate?: string;
            date?: string;
            dueDate?: string;
            expectedPaymentDate?: string;
            invoiceNumber?: string;
            lineAmountType?: "Exclusive"
            | "Inclusive"
            | "NoTax";
            plannedPaymentDate?: string;
            reference?: string;
            sendToContact?: boolean;
            status?: "DRAFT" | "SUBMITTED" | "AUTHORISED";
            url?: string;
        };
    contactId?: string;
    invoiceId?: string;
    limit?: number;
    lineItemsUi?: {
        lineItemsValues: {
            accountCode?: string;
            description?: string;
            discountRate?: string;
            itemCode?: string;
            lineAmount?: string;
            quantity?: number;
            taxAmount?: string;
            taxType: "NONE"
            | "INPUT"
            | "OUTPUT"
            | "GSTONIMPORTS";
            unitAmount?: string;
        }[];
    };
    name?: string;
    operation?: "create"
    | "get"
    | "getAll"
    | "update";
    options?:
        | {
            includeArchived?: boolean;
            orderBy?: string;
            sortOrder?: "ASC"
            | "DESC";
            where?: string;
        }
        | {
            createdByMyApp?: boolean;
            orderBy?: string;
            sortOrder?: "ASC"
            | "DESC";
            statuses?: ("DRAFT" | "SUBMITTED" | "AUTHORISED")[];
            where?: string;
        };
    organizationId?: string;
    resource?: "contact"
    | "invoice";
    returnAll?: boolean;
    type?: "ACCPAY" | "ACCREC";
    updateFields?:
        | {
            accountNumber?: string;
            addressesUi?: {
                addressesValues: {
                    attentionTo?: string;
                    city?: string;
                    country?: string;
                    line1?: string;
                    line2?: string;
                    postalCode?: string;
                    region?: string;
                    type?: "POBOX"
                    | "STREET";
                }[];
            };
            bankAccountDetails?: string;
            contactNumber?: string;
            contactStatus?: "ACTIVE"
            | "ARCHIVED"
            | "GDPRREQUEST";
            defaultCurrency?: string;
            emailAddress?: string;
            firstName?: string;
            lastName?: string;
            name?: string;
            phonesUi?: {
                phonesValues: {
                    phoneAreaCode?: string;
                    phoneCountryCode?: string;
                    phoneNumber?: string;
                    phoneType?: "DEFAULT" | "DDI" | "MOBILE" | "FAX";
                }[];
            };
            purchasesDefaultAccountCode?: string;
            salesDefaultAccountCode?: string;
            skypeUserName?: string;
            taxNumber?: string;
            xeroNetworkKey?: string;
        }
        | {
            brandingThemeId?: string;
            contactId?: string;
            currency?: string;
            currencyRate?: string;
            date?: string;
            dueDate?: string;
            expectedPaymentDate?: string;
            invoiceNumber?: string;
            lineAmountType?: "Exclusive"
            | "Inclusive"
            | "NoTax";
            lineItemsUi?: {
                lineItemsValues: {
                    accountCode?: string;
                    description?: string;
                    discountRate?: string;
                    itemCode?: string;
                    lineAmount?: string;
                    lineItemId?: string;
                    quantity?: number;
                    taxAmount?: string;
                    taxType:
                        | "NONE"
                        | "INPUT"
                        | "OUTPUT"
                        | "GSTONIMPORTS";
                    unitAmount?: string;
                }[];
            };
            plannedPaymentDate?: string;
            reference?: string;
            sendToContact?: boolean;
            status?: "DRAFT"
            | "SUBMITTED"
            | "AUTHORISED";
            url?: string;
        };
}

Properties§

Source§

readonly additionalFields?:
    | {
        accountNumber?: string;
        addressesUi?: {
            addressesValues: {
                attentionTo?: string;
                city?: string;
                country?: string;
                line1?: string;
                line2?: string;
                postalCode?: string;
                region?: string;
                type?: "POBOX"
                | "STREET";
            }[];
        };
        bankAccountDetails?: string;
        contactNumber?: string;
        contactStatus?: "ACTIVE"
        | "ARCHIVED"
        | "GDPRREQUEST";
        defaultCurrency?: string;
        emailAddress?: string;
        firstName?: string;
        lastName?: string;
        phonesUi?: {
            phonesValues: {
                phoneAreaCode?: string;
                phoneCountryCode?: string;
                phoneNumber?: string;
                phoneType?: "DEFAULT" | "DDI" | "MOBILE" | "FAX";
            }[];
        };
        purchasesDefaultAccountCode?: string;
        salesDefaultAccountCode?: string;
        skypeUserName?: string;
        taxNumber?: string;
        xeroNetworkKey?: string;
    }
    | {
        brandingThemeId?: string;
        currency?: string;
        currencyRate?: string;
        date?: string;
        dueDate?: string;
        expectedPaymentDate?: string;
        invoiceNumber?: string;
        lineAmountType?: "Exclusive"
        | "Inclusive"
        | "NoTax";
        plannedPaymentDate?: string;
        reference?: string;
        sendToContact?: boolean;
        status?: "DRAFT" | "SUBMITTED" | "AUTHORISED";
        url?: string;
    }

Default: {}

Source§

readonly contactId?: string

Source§

readonly invoiceId?: string

Source§

readonly limit?: number

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

Source§

readonly lineItemsUi?: {
    lineItemsValues: {
        accountCode?: string;
        description?: string;
        discountRate?: string;
        itemCode?: string;
        lineAmount?: string;
        quantity?: number;
        taxAmount?: string;
        taxType: "NONE" | "INPUT" | "OUTPUT" | "GSTONIMPORTS";
        unitAmount?: string;
    }[];
}

Line item data Default: {} Type options: {"multipleValues":true}

Source§

readonly name?: string

Full name of contact/organisation

Source§

readonly operation?: "create" | "get" | "getAll" | "update"

Default: "create"

Source§

readonly options?:
    | {
        includeArchived?: boolean;
        orderBy?: string;
        sortOrder?: "ASC"
        | "DESC";
        where?: string;
    }
    | {
        createdByMyApp?: boolean;
        orderBy?: string;
        sortOrder?: "ASC"
        | "DESC";
        statuses?: ("DRAFT" | "SUBMITTED" | "AUTHORISED")[];
        where?: string;
    }

Default: {}

Source§

readonly organizationId?: string

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

Source§

readonly resource?: "contact" | "invoice"

Default: "invoice"

Source§

readonly returnAll?: boolean

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

Source§

readonly type?: "ACCPAY" | "ACCREC"

Invoice Type

Source§

readonly updateFields?:
    | {
        accountNumber?: string;
        addressesUi?: {
            addressesValues: {
                attentionTo?: string;
                city?: string;
                country?: string;
                line1?: string;
                line2?: string;
                postalCode?: string;
                region?: string;
                type?: "POBOX"
                | "STREET";
            }[];
        };
        bankAccountDetails?: string;
        contactNumber?: string;
        contactStatus?: "ACTIVE"
        | "ARCHIVED"
        | "GDPRREQUEST";
        defaultCurrency?: string;
        emailAddress?: string;
        firstName?: string;
        lastName?: string;
        name?: string;
        phonesUi?: {
            phonesValues: {
                phoneAreaCode?: string;
                phoneCountryCode?: string;
                phoneNumber?: string;
                phoneType?: "DEFAULT" | "DDI" | "MOBILE" | "FAX";
            }[];
        };
        purchasesDefaultAccountCode?: string;
        salesDefaultAccountCode?: string;
        skypeUserName?: string;
        taxNumber?: string;
        xeroNetworkKey?: string;
    }
    | {
        brandingThemeId?: string;
        contactId?: string;
        currency?: string;
        currencyRate?: string;
        date?: string;
        dueDate?: string;
        expectedPaymentDate?: string;
        invoiceNumber?: string;
        lineAmountType?: "Exclusive"
        | "Inclusive"
        | "NoTax";
        lineItemsUi?: {
            lineItemsValues: {
                accountCode?: string;
                description?: string;
                discountRate?: string;
                itemCode?: string;
                lineAmount?: string;
                lineItemId?: string;
                quantity?: number;
                taxAmount?: string;
                taxType:
                    | "NONE"
                    | "INPUT"
                    | "OUTPUT"
                    | "GSTONIMPORTS";
                unitAmount?: string;
            }[];
        };
        plannedPaymentDate?: string;
        reference?: string;
        sendToContact?: boolean;
        status?: "DRAFT"
        | "SUBMITTED"
        | "AUTHORISED";
        url?: string;
    }

Default: {}