Xero (simple) icon

Xero (simple)

Allows requests to the Xero API

Xero (simple)

AI-generated

Overview

This node allows users to make various types of HTTP requests (GET, POST, PUT, PATCH, DELETE, HEAD) to the Xero API, targeting specific endpoints within an organization or tenant. It supports sending query parameters, headers, and body data, including binary data for file uploads. The node can handle paginated GET requests to retrieve all data across multiple pages. It is useful for integrating Xero's accounting and business management features into automated workflows, such as fetching invoices, creating contacts, or updating financial records.

Use Case Examples

  1. Fetch all invoices from a specific organization using a paginated GET request.
  2. Upload a file to a Xero endpoint using a POST request with binary data.
  3. Update a contact's details using a PATCH request with JSON body parameters.

Properties

Name Meaning
Request Method The HTTP method to use for the API request (e.g., GET, POST, PUT, PATCH, DELETE, HEAD). Options include a special GET_ALL for paginated GET requests.
Organization/Tenant ID The unique identifier of the Xero organization or tenant to target for the API request.
Endpoint The specific API endpoint path to make the request to (e.g., /Invoices).
Response Format The format in which the response data is returned, either JSON or string.
Send Binary Data Whether to send binary data as the request body (applicable for PATCH, POST, PUT requests).
Binary Property The name of the binary property containing the file data to upload. Supports multiple properties for multipart form-data.
Body Parameters JSON-formatted body parameters to include in the request (used when not sending binary data).
Query Parameters JSON-formatted query parameters to include in the request URL.
Headers JSON-formatted headers to include in the request.
Additional Fields Additional optional fields such as Branding Theme ID to include in the request body.

Output

JSON

  • response - The data returned from the Xero API request, parsed as JSON or raw string depending on the response format.

Dependencies

  • Xero API with OAuth2 authentication

Troubleshooting

  • Error if binary data is expected but not found on the input item, or if the specified binary property does not exist.
  • Error if required parameters like organizationId or endpoint are missing.
  • Ensure the OAuth2 credentials for Xero API are correctly configured and authorized.
  • If response parsing fails, check the response format setting and the API endpoint's actual response.

Links

Discussion