The "Xero Get" functionality lets you retrieve different records from your account.

📘
Info:
Before using the "Xero Get", ensure that you have configured your Xero organization. Please refer to the Xero page for more information.

Below, you'll find a list of all possible correspondingRecordType options and examples of how to retrieve each type of record.

account
brandingTheme
contact
creditNote
currency
invoice
item
manualJournal
purchaseOrder
payment
trackingCategory
taxRate

1. Get Account

Retrieve account information.

const tenantId = (await C.getCompanySettings()).xeroOrganisation.xeroId;
    if (!tenantId) {
        throw "Default xero organisation is not set in company settings";
    }
const response = await C.xeroGet({
        xeroTenantId: tenantId,
        correspondingRecordType: "account"

2. Get Branding Theme

Retrieve branding theme details.

const tenantId = (await C.getCompanySettings()).xeroOrganisation.xeroId;
    if (!tenantId) {
        throw "Default xero organisation is not set in company settings";
    }
const response = await C.xeroGet({
        xeroTenantId: tenantId,
        correspondingRecordType: "brandingTheme"

3. Get Contact

Retrieve contact details.

const tenantId = (await C.getCompanySettings()).xeroOrganisation.xeroId;
    if (!tenantId) {
        throw "Default xero organisation is not set in company settings";
    }
const response = await C.xeroGet({
        xeroTenantId: tenantId,
        correspondingRecordType: "contact"

4. Get Credit Note

Retrieve credit note information.

const tenantId = (await C.getCompanySettings()).xeroOrganisation.xeroId;
    if (!tenantId) {
        throw "Default xero organisation is not set in company settings";
    }
const response = await C.xeroGet({
        xeroTenantId: tenantId,
        correspondingRecordType: "creditNote

5. Get Currency

Retrieve currency information.

const tenantId = (await C.getCompanySettings()).xeroOrganisation.xeroId;
    if (!tenantId) {
        throw "Default xero organisation is not set in company settings";
    }
const response = await C.xeroGet({
        xeroTenantId: tenantId,
        correspondingRecordType: "currency"

6. Get Invoice

Retrieve invoice details.

const tenantId = (await C.getCompanySettings()).xeroOrganisation.xeroId;
    if (!tenantId) {
        throw "Default xero organisation is not set in company settings";
    }
const response = await C.xeroGet({
        xeroTenantId: tenantId,
        correspondingRecordType: "invoice"

7. Get Item

Retrieve item information.

const tenantId = (await C.getCompanySettings()).xeroOrganisation.xeroId;
    if (!tenantId) {
        throw "Default xero organisation is not set in company settings";
    }
const response = await C.xeroGet({
        xeroTenantId: tenantId,
        correspondingRecordType: "item"

8. Get Manual Journal

Retrieve manual journal entries.

const tenantId = (await C.getCompanySettings()).xeroOrganisation.xeroId;
    if (!tenantId) {
        throw "Default xero organisation is not set in company settings";
    }
const response = await C.xeroGet({
        xeroTenantId: tenantId,
        correspondingRecordType: "manualJournal"

9. Get Purchase Order

Retrieve purchase orders.

const tenantId = (await C.getCompanySettings()).xeroOrganisation.xeroId;
    if (!tenantId) {
        throw "Default xero organisation is not set in company settings";
    }
const response = await C.xeroGet({
        xeroTenantId: tenantId,
        correspondingRecordType: "purchaseOrder"

10. Get Payment

Retrieve payment information.

const tenantId = (await C.getCompanySettings()).xeroOrganisation.xeroId;
    if (!tenantId) {
        throw "Default xero organisation is not set in company settings";
    }
const response = await C.xeroGet({
        xeroTenantId: tenantId,
        correspondingRecordType: "payment"

11. Get Tracking Category

Retrieve tracking category details.

const tenantId = (await C.getCompanySettings()).xeroOrganisation.xeroId;
    if (!tenantId) {
        throw "Default xero organisation is not set in company settings";
    }
const response = await C.xeroGet({
        xeroTenantId: tenantId,
        correspondingRecordType: "trackingCategory"

12. Get Tax Rate

Retrieve tax rate information.

const tenantId = (await C.getCompanySettings()).xeroOrganisation.xeroId;
    if (!tenantId) {
        throw "Default xero organisation is not set in company settings";
    }
const response = await C.xeroGet({
        xeroTenantId: tenantId,
        correspondingRecordType: "taxRate"

📌 Need Help?

If you require assistance or encounter any issues, please don't hesitate to contact us for further support.