Query: Get Invoices

Xero Operation

Retrieve a list of invoices from Xero

Example User Story

As an accountant, I want to retrieve a list of invoices from Xero so that I can review and reconcile them.

Fields

Field Name	Field Type	Required
where	String	No
order	String	No
page	Integer	No

Related Connections

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "get-invoices",
  "state": "inDev",
  "meta": {
    "short": "Get Invoices",
    "description": "Retrieve a list of invoices from Xero."
  },
  "input": [
    {
      "name": "where",
      "type": "String",
      "required": false,
      "meta": {
        "description": "Filter invoices by a specific condition."
      }
    },
    {
      "name": "order",
      "type": "String",
      "required": false,
      "meta": {
        "description": "Order invoices by a specific field."
      }
    },
    {
      "name": "page",
      "type": "Integer",
      "required": false,
      "meta": {
        "description": "Page number for pagination."
      }
    }
  ],
  "output": [
    {
      "name": "invoices",
      "type": "Array",
      "selector": ["Invoices"],
      "meta": {
        "description": "List of retrieved invoices."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "GET",
        "path": "/api.xro/2.0/Invoices",
        "headers": {
          "Accept": "application/json"
        },
        "queryParams": {
          "where": "{{where}}",
          "order": "{{order}}",
          "page": "{{page}}"
        }
      }
    }
  ]
}