Xero Node SDK

https://xeroapi.github.io/xero-node/
Admin
Xero Node SDK is a Node.js library that provides developers with programmatic access to Xero's...
Tokens:124,483
Snippets:617
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Branding Themes

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves all available branding themes.

```APIDOC
## GET /BrandingThemes

### Description
Retrieves all the branding themes.

### Method
GET

### Endpoint
/BrandingThemes

### Parameters
#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant
```

--------------------------------

### Get Prepayment

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a specified prepayment.

```APIDOC
## GET /Prepayments/{PrepaymentID}

### Description
Retrieves a specified prepayment.

### Method
GET

### Endpoint
/Prepayments/{PrepaymentID}

### Parameters
#### Path Parameters
- **PrepaymentID** (uuid) - Required - Unique identifier for a Prepayment

#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant

### Request Example
```javascript
await xero.accountingApi.getPrepayment(xeroTenantId, prepaymentID);
```

### Response
#### Success Response (200)
- **body** - The prepayment details.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Get Accounts

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a list of all accounts associated with the Xero tenant. Supports filtering and ordering.

```APIDOC
## GET /Accounts

### Description
Retrieves a list of all accounts associated with the Xero tenant. Supports filtering and ordering.

### Method
GET

### Endpoint
/Accounts

### Parameters
#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant
- **If-Modified-Since** (Date) - Optional - Only records created or modified since this timestamp will be returned

#### Query Parameters
- **where** (String) - Optional - Filter by any element
- **order** (String) - Optional - Order by any element

### Request Example
```javascript
await xero.setTokenSet(tokenSet);
const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const ifModifiedSince = new Date("2020-02-06T12:17:43.202-08:00");
const where = 'Status=="ACTIVE" AND Type=="BANK"';
const order = 'Name ASC';
try {
  const response = await xero.accountingApi.getAccounts(xeroTenantId, ifModifiedSince, where, order);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

### Response
#### Success Response (200)
- **body** (Object) - Contains the list of accounts

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### postSetup

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Sets the chart of accounts, the conversion date and conversion balances for a new Xero organization.

```APIDOC
## postSetup

### Description
Sets the chart of accounts, the conversion date and conversion balances.

### Method
POST

### Endpoint
/Setup

### Parameters
#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant
- **Idempotency-Key** (String) - Required - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

#### Request Body
- **setup** (Setup) - Required - Object including an accounts array, a conversion balances array and a conversion date object in body of request

### Request Example
```json
{
  "accounts": [
    {
      "code": "123",
      "name": "Business supplies",
      "type": "EXPENSE"
    }
  ],
  "conversionDate": {
    "month": 10,
    "year": 2020
  },
  "conversionBalances": []
}
```

### Response
#### Success Response (200)
- **body** (Object) - Response body containing setup details

#### Response Example
```json
{
  "accounts": [
    {
      "code": "123",
      "name": "Business supplies",
      "type": "EXPENSE"
    }
  ],
  "conversionDate": {
    "month": 10,
    "year": 2020
  },
  "conversionBalances": []
}
```
```

--------------------------------

### Create Tracking Options with Node.js SDK

Source: https://xeroapi.github.io/xero-node/accounting/index.html

This example shows how to create options for a specific tracking category using the Xero Node.js SDK. It requires the tenant ID, tracking category ID, and an idempotency key.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const trackingCategoryID = '00000000-0000-0000-0000-000000000000';
const idempotencyKey = 'KEY_VALUE';

const trackingOption: TrackingOption = {
  name: "Foobar"
};

try {
  const response = await xero.accountingApi.createTrackingOptions(xeroTenantId, trackingCategoryID, trackingOption, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Get Payment

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a specific payment by its ID.

```APIDOC
## GET /Payments/{PaymentID}

### Description
Retrieves a specific payment by its ID.

### Method
GET

### Endpoint
/Payments/{PaymentID}

### Parameters
#### Path Parameters
- **PaymentID** (uuid) - Required - Unique identifier for a Payment

#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant

### Request Example
```javascript
await xero.accountingApi.getPayment(xeroTenantId, paymentID);
```

### Response
#### Success Response (200)
- **body** - The payment details.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Create Account with Node.js SDK

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Use this to create a new account in your Xero organization. Ensure you have set the token set and provided the necessary tenant ID and account details. An idempotency key is recommended for safe retries.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const idempotencyKey = 'KEY_VALUE';

const account: Account = {
  code: "123456",
  name: "FooBar",
  type: AccountType.EXPENSE,
  description: "Hello World"
};

try {
  const response = await xero.accountingApi.createAccount(xeroTenantId, account, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Get Currencies

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves currencies for your Xero organisation.

```APIDOC
## GET /Currencies

### Description
Retrieves currencies for your Xero organisation.

### Method
GET

### Endpoint
/Currencies

### Parameters
#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant

#### Query Parameters
- **where** (String) - Optional - Filter by an any element
- **order** (String) - Optional - Order by an any element

### Request Example
```javascript
await xero.setTokenSet(tokenSet);
const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const where = 'Code=="USD"';
const order = 'Code ASC';
try {
  const response = await xero.accountingApi.getCurrencies(xeroTenantId, where, order);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

### Scopes
- accounting.settings
- accounting.settings.read
```

--------------------------------

### Get Credit Notes

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves any credit notes.

```APIDOC
## GET /CreditNotes

### Description
Retrieves any credit notes.

### Method
GET

### Endpoint
/CreditNotes

### Parameters
#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant
- **If-Modified-Since** (Date) - Optional - Only records created or modified since this timestamp will be returned

#### Query Parameters
- **where** (String) - Optional - Filter by an any element
- **order** (String) - Optional - Order by an any element
- **page** (Integer) - Optional - e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note
- **unitdp** (Integer) - Optional - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- **pageSize** (Integer) - Optional - Number of records to retrieve per page

### Request Example
```javascript
await xero.setTokenSet(tokenSet);
const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const ifModifiedSince = new Date("2020-02-06T12:17:43.202-08:00");
const where = 'Status=="DRAFT"';
const order = 'CreditNoteNumber ASC';
const page = 1;
const unitdp = 4;
const pageSize = 100;
try {
  const response = await xero.accountingApi.getCreditNotes(xeroTenantId, ifModifiedSince, where, order, page, unitdp, pageSize);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

### Scopes
- accounting.transactions
- accounting.transactions.read
```

--------------------------------

### Set up Conversion Balances and Chart of Accounts

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Use this to set up the chart of accounts, conversion date, and conversion balances for a new Xero organisation. Ensure the tokenSet is valid before making the call.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const idempotencyKey = 'KEY_VALUE';

const account: Account = {
  code: "123",
  name: "Business supplies",
  type: AccountType.EXPENSE
};
const accounts = [];
accounts.push(account)

const conversionDate: ConversionDate = {
  month: 10,
  year: 2020
};
const conversionBalances = [];

const setup: Setup = {
  accounts: accounts,
  conversionDate: conversionDate,
  conversionBalances: conversionBalances
};

try {
  const response = await xero.accountingApi.postSetup(xeroTenantId, setup, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Create Prepayment History (Node.js)

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Use this method to create a history record for a specific prepayment. Ensure you have set the token set and provided the correct tenant ID, prepayment ID, and history records.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const prepaymentID = '00000000-0000-0000-0000-000000000000';
const idempotencyKey = 'KEY_VALUE';

const historyRecord: HistoryRecord = {
  details: "Hello World"
};

const historyRecords: HistoryRecords = {
  historyRecords: [historyRecord]
};

try {
  const response = await xero.accountingApi.createPrepaymentHistory(xeroTenantId, prepaymentID, historyRecords, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Get Account

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a specific account by its ID.

```APIDOC
## GET /Accounts/{AccountID}

### Description
Retrieves a specific account by its unique identifier.

### Method
GET

### Endpoint
/Accounts/{AccountID}

### Parameters
#### Path Parameters
- **AccountID** (uuid) - Required - Unique identifier for the Account object.

#### Header Parameters
- **xero-tenant-id** (string) - Required - Xero identifier for Tenant.

### Request Example
```javascript
await xero.accountingApi.getAccount(xeroTenantId, accountID);
```

### Response
#### Success Response (200)
- **body** - The account details.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Get Payment Services

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves available payment services.

```APIDOC
## GET /PaymentServices

### Description
Retrieves available payment services.

### Method
GET

### Endpoint
/PaymentServices

### Parameters
#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant

### Request Example
```javascript
await xero.accountingApi.getPaymentServices(xeroTenantId);
```

### Response
#### Success Response (200)
- **body** - A list of payment services.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Create Purchase Orders with Node.js SDK

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Use this snippet to create one or more purchase orders. Ensure you have set up the token set and provided the necessary tenant ID, contact details, line items, and date.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const summarizeErrors = true;
const idempotencyKey = 'KEY_VALUE';
const dateValue = '2020-10-10'

const contact: Contact = {
  contactID: "00000000-0000-0000-0000-000000000000"
};

const lineItem: LineItem = {
  description: "Foobar",
  quantity: 1.0,
  unitAmount: 20.0,
  accountCode: "000"
};   
const lineItems = [];
lineItems.push(lineItem)

const purchaseOrder: PurchaseOrder = {
  contact: contact,
  lineItems: lineItems,
  date: dateValue
};

const purchaseOrders: PurchaseOrders = {
  purchaseOrders: [purchaseOrder]
};

try {
  const response = await xero.accountingApi.createPurchaseOrders(xeroTenantId, purchaseOrders,  summarizeErrors,idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Get Manual Journals

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a list of manual journals.

```APIDOC
## GET /ManualJournals

### Description
Retrieves manual journals.

### Method
GET

### Endpoint
/ManualJournals

### Parameters
#### Header Parameters
- **xero-tenant-id** (string) - Required - Xero identifier for Tenant

#### Query Parameters
- **ifModifiedSince** (Date) - Optional - Retrieves manual journals modified since this date.
- **where** (string) - Optional - Retrieves manual journals matching the where clause. e.g. Status=="DRAFT"
- **order** (string) - Optional - Retrieves manual journals in the specified order. e.g. Date ASC
```

--------------------------------

### Get Trial Balance Report - Node.js

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieve the Trial Balance report for a specific date, with an option to include only payments. Requires setting the token set and providing the Xero Tenant ID.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const date: Date = new Date("2019-10-31");
const paymentsOnly = true;

try {
  const response = await xero.accountingApi.getReportTrialBalance(xeroTenantId,  date, paymentsOnly);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Create Multiple Contacts (Bulk) - Node.js

Source: https://xeroapi.github.io/xero-node/accounting/index.html

This example demonstrates how to create multiple contacts in bulk for a Xero organization. It includes setting up phone numbers and contact details. The `summarizeErrors` flag can be used to control error reporting.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const summarizeErrors = true;
const idempotencyKey = 'KEY_VALUE';

const phone: Phone = {
  phoneNumber: "555-1212",
  phoneType: Phone.PhoneTypeEnum.MOBILE
};
const phones = [];
phones.push(phone)

const contact: Contact = {
  name: "Bruce Banner",
  emailAddress: "hulk@avengers.com",
  phones: phones
};

const contacts: Contacts = {
  contacts: [contact]
};

try {
  const response = await xero.accountingApi.createContacts(xeroTenantId, contacts,  summarizeErrors,idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Get Expense Claims

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a list of expense claims.

```APIDOC
## GET /ExpenseClaims

### Description
Retrieves expense claims.

### Method
GET

### Endpoint
/ExpenseClaims

### Parameters
#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant.

### Request Example
```javascript
await xero.accountingApi.getExpenseClaims(xeroTenantId);
```

### Response
#### Success Response (200)
- **body** - The list of expense claims.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Create Linked Transactions with Node.js SDK

Source: https://xeroapi.github.io/xero-node/accounting/index.html

This example demonstrates how to create linked transactions (billable expenses) using the Xero Node.js SDK. Requires an authenticated `xero` object and a valid `xeroTenantId`. The `Idempotency-Key` header is recommended for safe retries.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const idempotencyKey = 'KEY_VALUE';

const linkedTransaction: LinkedTransaction = {
  sourceTransactionID: "00000000-0000-0000-0000-000000000000",
  sourceLineItemID: "00000000-0000-0000-0000-000000000000"
};

try {
  const response = await xero.accountingApi.createLinkedTransaction(xeroTenantId, linkedTransaction, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Get Employee

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a specific employee by their unique ID.

```APIDOC
## GET /Employees/{EmployeeID}

### Description
Retrieves a specific employee using their unique identifier.

### Method
GET

### Endpoint
/Employees/{EmployeeID}

### Parameters
#### Path Parameters
- **EmployeeID** (uuid) - Required - Unique identifier for an Employee.

#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant.

### Request Example
```javascript
await xero.accountingApi.getEmployee(xeroTenantId, employeeID);
```

### Response
#### Success Response (200)
- **body** - The employee object.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Create Account

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Creates a new chart of accounts. Requires 'accounting.settings' scope.

```APIDOC
## POST /Accounts

### Description
Creates a new chart of accounts.

### Method
POST

### Endpoint
/Accounts

### Parameters
#### Header parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant
- **Idempotency-Key** (String) - Optional - Allows safe retry of requests without duplicate processing. 128 character max.

#### Request Body
- **account** (Account) - Required - Account object in body of request

### Request Example
```json
{
  "code": "123456",
  "name": "FooBar",
  "type": "EXPENSE",
  "description": "Hello World"
}
```

### Scopes
accounting.settings | Grant read-write access to organisation and account settings
```

--------------------------------

### Create Tax Rates (Node.js)

Source: https://xeroapi.github.io/xero-node/accounting/index.html

This method creates one or more tax rates. It requires the Xero tenant ID and an idempotency key for safe retries. The `taxRates` object should contain an array of `TaxRate` objects, each with a name and an array of `TaxComponent` objects.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const idempotencyKey = 'KEY_VALUE';

const taxComponent: TaxComponent = {
  name: "State Tax",
  rate: 2.25
};  
const taxComponent = [];
taxComponents.push(taxComponent)

const taxRate: TaxRate = {
  name: "CA State Tax",
  taxComponents: taxComponents,

const taxRates: TaxRates = {
  taxRates: [taxRate]
};

try {
  const response = await xero.accountingApi.createTaxRates(xeroTenantId, taxRates, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Get Accounts

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves the full chart of accounts for an organization.

```APIDOC
## GET /Accounts

### Description
Retrieves the full chart of accounts.

### Method
GET

### Endpoint
/Accounts

### Parameters
#### Header Parameters
- **xero-tenant-id** (string) - Required - Xero identifier for Tenant.

### Request Example
```javascript
await xero.accountingApi.getAccounts(xeroTenantId);
```

### Response
#### Success Response (200)
- **body** - A list of accounts.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Get Purchase Order as PDF - Node.js

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a specific purchase order as a PDF file using its unique ID. Requires the Xero tenant ID and the purchase order ID.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const purchaseOrderID = '00000000-0000-0000-0000-000000000000';

try {
  const response = await xero.accountingApi.getPurchaseOrderAsPdf(xeroTenantId, purchaseOrderID);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Get Quote Attachments

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves all attachments associated with a specific quote.

```APIDOC
## GET /Quotes/{QuoteID}/Attachments

### Description
Retrieves attachments for a specific quote.

### Method
GET

### Endpoint
/Quotes/{QuoteID}/Attachments

### Parameters
#### Path Parameters
- **QuoteID** (uuid) - Required - Unique identifier for an Quote.

#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant.

### Request Example
```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const quoteID = '00000000-0000-0000-0000-000000000000';

try {
  const response = await xero.accountingApi.getQuoteAttachments(xeroTenantId, quoteID);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

### Scopes
- accounting.attachments | Grant read-write access to attachments
- accounting.attachments.read | Grant read-only access to attachments
```

--------------------------------

### getOrganisationCISSettings

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves the CIS settings for the Xero organisation. Requires the Xero Tenant ID and the Organisation ID.

```APIDOC
## GET /Organisation/{OrganisationID}/CISSettings

### Description
Retrieves the CIS settings for the Xero organistaion.

### Method
GET

### Endpoint
/Organisation/{OrganisationID}/CISSettings

### Parameters
#### Path Parameters
- **OrganisationID** (uuid) - Required - The unique Xero identifier for an organisation

#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant

### Scopes
- accounting.settings
- accounting.settings.read
```

--------------------------------

### Get Payments

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a list of payments for invoices and credit notes.

```APIDOC
## GET /Payments

### Description
Retrieves a list of payments for invoices and credit notes.

### Method
GET

### Endpoint
/Payments

### Parameters
#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant
- **If-Modified-Since** (Date) - Optional - Only records created or modified since this timestamp will be returned

#### Query Parameters
- **where** (String) - Optional - Filter by an any element
- **order** (String) - Optional - Order by an any element
- **page** (Integer) - Optional - Up to 100 payments will be returned in a single API call
- **pageSize** (Integer) - Optional - Number of records to retrieve per page

### Request Example
```javascript
await xero.accountingApi.getPayments(xeroTenantId, ifModifiedSince, where, order, page, pageSize);
```

### Response
#### Success Response (200)
- **body** - A list of payments.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Retrieve Budgets with Node.js SDK

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Use this method to retrieve a list of budgets. Ensure you have set the token set and provided the Xero tenant ID. Optional parameters include budget IDs and date ranges for filtering.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const iDs = ["00000000-0000-0000-0000-000000000000"];
const dateTo: Date = new Date("2019-10-31");
const dateFrom: Date = new Date("2019-10-31");

try {
  const response = await xero.accountingApi.getBudgets(xeroTenantId,  iDs, dateTo, dateFrom);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Get Payment History

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves history records of a specific payment.

```APIDOC
## GET /Payments/{PaymentID}/History

### Description
Retrieves history records of a specific payment.

### Method
GET

### Endpoint
/Payments/{PaymentID}/History

### Parameters
#### Path Parameters
- **PaymentID** (uuid) - Required - Unique identifier for a Payment

#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant

### Request Example
```javascript
await xero.accountingApi.getPaymentHistory(xeroTenantId, paymentID);
```

### Response
#### Success Response (200)
- **body** - The payment history records.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Create Batch Payment with Node.js SDK

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Use this snippet to create a batch payment. Ensure the 'xero-tenant-id' header is set and the request body includes the necessary BatchPayments object. Handles potential API errors by logging the status code and response body.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const summarizeErrors = true;
const idempotencyKey = 'KEY_VALUE';
const currDate = '2020-12-10'

const paymentAccount: Account = {
  accountID: "00000000-0000-0000-0000-000000000000"
};

const bankAccount: Account = {
  accountID: "00000000-0000-0000-0000-000000000000"
};

const invoice: Invoice = {
  invoiceID: "00000000-0000-0000-0000-000000000000"
};

const payment: Payment = {
  account: bankAccount,
  date: currDate,
  amount: 1.0,
  invoice: invoice
};   
const payments = [];
payments.push(payment)

const batchPayment: BatchPayment = {
  account: paymentAccount,
  reference: "hello foobar",
  date: currDate,
  payments: payments
};

const batchPayments: BatchPayments = {
  batchPayments: [batchPayment]
};

try {
  const response = await xero.accountingApi.createBatchPayment(xeroTenantId, batchPayments,  summarizeErrors,idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Get Overpayments

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a list of overpayments, with options for filtering and sorting.

```APIDOC
## GET /Overpayments

### Description
Retrieves overpayments, with options for filtering and sorting.

### Method
GET

### Endpoint
/Overpayments

### Parameters
#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant
- **If-Modified-Since** (Date) - Optional - Only records created or modified since this timestamp will be returned

#### Query Parameters
- **where** (String) - Optional - Filter by an any element
- **order** (String) - Optional - Order by an any element
- **page** (Integer) - Optional - e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment
- **unitdp** (Integer) - Optional - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- **pageSize** (Integer) - Optional - Number of records to retrieve per page
- **References** (array[String]) - Optional - Filter by a comma-separated list of References

### Request Example
```javascript
await xero.setTokenSet(tokenSet);
const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const ifModifiedSince = new Date("2020-02-06T12:17:43.202-08:00");
const where = 'Status=="AUTHORISED"';
const order = 'Status ASC';
const page = 1;
const unitdp = 4;
const pageSize = 100;
const references = ["Ref1", "Ref2"];
try {
  const response = await xero.accountingApi.getOverpayments(xeroTenantId, ifModifiedSince, where, order, page, unitdp, pageSize, references);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

### Response
#### Success Response (200)
- **body** - The response body contains the list of overpayments.

#### Response Example
(Response structure not provided in source)
```

--------------------------------

### Get Overpayment History

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves the history records for a specific overpayment.

```APIDOC
## GET /Overpayments/{OverpaymentID}/History

### Description
Retrieves history records of a specific overpayment.

### Method
GET

### Endpoint
/Overpayments/{OverpaymentID}/History

### Parameters
#### Path Parameters
- **OverpaymentID** (UUID) - Required - Unique identifier for an Overpayment

#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant

### Request Example
```javascript
await xero.setTokenSet(tokenSet);
const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const overpaymentID = '00000000-0000-0000-0000-000000000000';
try {
  const response = await xero.accountingApi.getOverpaymentHistory(xeroTenantId, overpaymentID);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

### Response
#### Success Response (200)
- **body** - The response body contains the history records for the overpayment.

#### Response Example
(Response structure not provided in source)
```

--------------------------------

### Get All Branding Themes - Node.js

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a list of all available branding themes for the authenticated tenant. Requires a valid xeroTenantId.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';

try {
  const response = await xero.accountingApi.getBrandingThemes(xeroTenantId);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Get Overpayment

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a specific overpayment using its unique identifier.

```APIDOC
## GET /Overpayments/{OverpaymentID}

### Description
Retrieves a specific overpayment using a unique overpayment Id.

### Method
GET

### Endpoint
/Overpayments/{OverpaymentID}

### Parameters
#### Path Parameters
- **OverpaymentID** (UUID) - Required - Unique identifier for an Overpayment

#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant

### Request Example
```javascript
await xero.setTokenSet(tokenSet);
const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const overpaymentID = '00000000-0000-0000-0000-000000000000';
try {
  const response = await xero.accountingApi.getOverpayment(xeroTenantId, overpaymentID);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

### Response
#### Success Response (200)
- **body** - The response body contains the details of the overpayment.

#### Response Example
(Response structure not provided in source)
```

--------------------------------

### Get Profit and Loss Report (Node.js)

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Fetches the Profit and Loss report with various optional parameters for filtering by date, periods, timeframe, and tracking categories. Requires an authorized tokenSet and xero-tenant-id. Includes error handling.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const fromDate: Date = new Date("2019-10-31");
const toDate: Date = new Date("2019-10-31");
const periods = 3;
const timeframe = 'MONTH';
const trackingCategoryID = '00000000-0000-0000-0000-000000000000';
const trackingCategoryID2 = '00000000-0000-0000-0000-000000000000';
const trackingOptionID = '00000000-0000-0000-0000-000000000000';
const trackingOptionID2 = '00000000-0000-0000-0000-000000000000';
const standardLayout = true;
const paymentsOnly = false;

try {
  const response = await xero.accountingApi.getReportProfitAndLoss(xeroTenantId,  fromDate, toDate, periods, timeframe, trackingCategoryID, trackingCategoryID2, trackingOptionID, trackingOptionID2, standardLayout, paymentsOnly);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Get Organisations

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a list of organizations associated with the authenticated user.

```APIDOC
## GET /Organisations

### Description
Retrieves a list of organizations associated with the authenticated user.

### Method
GET

### Endpoint
/Organisations

### Parameters
#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant

### Request Example
```javascript
await xero.setTokenSet(tokenSet);
const xeroTenantId = 'YOUR_XERO_TENANT_ID';
try {
  const response = await xero.accountingApi.getOrganisations(xeroTenantId);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

### Response
#### Success Response (200)
- **body** - The response body contains the list of organizations.

#### Response Example
(Response structure not provided in source)
```

--------------------------------

### Get Budget Summary Report (Node.js)

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a budget summary report. Ensure the xero-tenant-id is set and the tokenSet is authorized. Handles potential API errors by logging the status code and response body.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const date: Date = new Date("2019-03-31");
const periods = 2;
const timeframe = 3;

try {
  const response = await xero.accountingApi.getReportBudgetSummary(xeroTenantId,  date, periods, timeframe);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Get Prepayments - Node.js

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a list of prepayments with options for filtering, sorting, and pagination. Supports filtering by date, status, and invoice numbers.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const ifModifiedSince: Date = new Date("2020-02-06T12:17:43.202-08:00");
const where = 'Status=="AUTHORISED"';
const order = 'Reference ASC';
const page = 1;
const unitdp = 4;
const pageSize = 100;
const invoiceNumbers = ["INV-001", "INV-002"];

try {
  const response = await xero.accountingApi.getPrepayments(xeroTenantId, ifModifiedSince, where, order, page, unitdp, pageSize, invoiceNumbers);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Get Budget

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a specific budget, including its budget lines.

```APIDOC
## GET /Budgets/{BudgetID}

### Description
Retrieves a specific budget, which includes budget lines.

### Method
GET

### Endpoint
/Budgets/{BudgetID}

### Parameters
#### Path Parameters
- **BudgetID** (UUID) - Required - Unique identifier for a Budget

#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant

#### Query Parameters
- **dateTo** (Date) - Optional - The end date for the budget period.
- **dateFrom** (Date) - Optional - The start date for the budget period.
```

--------------------------------

### Get Bank Transfer

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a specific bank transfer by its ID.

```APIDOC
## GET /BankTransfers/{BankTransferID}

### Description
Retrieves a specific bank transfer by its unique identifier.

### Method
GET

### Endpoint
/BankTransfers/{BankTransferID}

### Parameters
#### Path Parameters
- **BankTransferID** (uuid) - Required - Xero generated unique identifier for a bank transfer

#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant
```

--------------------------------

### Create Purchase Order Attachment by File Name (Node.js)

Source: https://xeroapi.github.io/xero-node/accounting/index.html

This method creates an attachment for a specific purchase order. It requires the tenant ID, purchase order ID, file name, and the file content as a readable stream. Ensure the 'mime-types' and 'path' modules are installed and imported.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const purchaseOrderID = '00000000-0000-0000-0000-000000000000';
const fileName = 'xero-dev.jpg';
const idempotencyKey = 'KEY_VALUE';
const path = require("path");
const mime = require("mime-types");
const pathToUpload = path.resolve(__dirname, "../public/images/xero-dev.jpg"); // determine the path to your file
const body = fs.createReadStream(pathToUpload); // {fs.ReadStream} read the file
const contentType = mime.lookup(fileName);

try {
  const response = await xero.accountingApi.createPurchaseOrderAttachmentByFileName(xeroTenantId, purchaseOrderID, fileName, body, idempotencyKey, {
    headers: {
      "Content-Type": contentType,
    }
  });
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Get Repeating Invoice

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a specific repeating invoice by its unique ID.

```APIDOC
## Get Repeating Invoice

### Description
Retrieves a specific repeating invoice by using a unique repeating invoice Id.

### Method
GET

### Endpoint
/RepeatingInvoices/{RepeatingInvoiceID}

### Parameters
#### Path Parameters
- **RepeatingInvoiceID** (UUID) - Required - Unique identifier for a Repeating Invoice

#### Header Parameters
- **xero-tenant-id** (String) - Required - Xero identifier for Tenant
```

--------------------------------

### Create Purchase Order History (Node.js)

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Use this method to create a history record for a specific purchase order. Ensure you have set the token set and provided the correct tenant ID, purchase order ID, and history records.

```javascript
await xero.setTokenSet(tokenSet);

const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const purchaseOrderID = '00000000-0000-0000-0000-000000000000';
const idempotencyKey = 'KEY_VALUE';

const historyRecord: HistoryRecord = {
  details: "Hello World"
};

const historyRecords: HistoryRecords = {
  historyRecords: [historyRecord]
};

try {
  const response = await xero.accountingApi.createPurchaseOrderHistory(xeroTenantId, purchaseOrderID, historyRecords, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}
```

--------------------------------

### Get Receipts

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves a list of draft expense claim receipts for any user.

```APIDOC
## GET /Receipts

### Description
Retrieves draft expense claim receipts for any user.

### Method
GET

### Endpoint
/Receipts
```

--------------------------------

### Get Manual Journal Attachments

Source: https://xeroapi.github.io/xero-node/accounting/index.html

Retrieves all attachments for a specific manual journal.

```APIDOC
## GET /ManualJournals/{ManualJournalID}/Attachments

### Description
Retrieves attachment for a specific manual journal.

### Method
GET

### Endpoint
/ManualJournals/{ManualJournalID}/Attachments

### Parameters
#### Path Parameters
- **ManualJournalID** (uuid) - Required - Unique identifier for a ManualJournal

#### Header Parameters
- **xero-tenant-id** (string) - Required - Xero identifier for Tenant
```
Tokens:
Raw