Action: Update Invoice

Xero Operation

Update an existing invoice in Xero with the provided details.

Example User Story

As a business owner, I want to update an existing invoice in Xero so that I can reflect changes in billing details or corrections.

Fields

Field Name	Field Type	Required
InvoiceID	String	Yes
InvoiceNumber	String	No
Reference	String	No
Status	String	No
LineAmountTypes	String	No
LineItems	Array	No
DueDate	String	No
CurrencyCode	String	No

Related Connections

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "put-invoices",
  "state": "inDev",
  "meta": {
    "short": "Update Invoice",
    "description": "Update an existing invoice in Xero with the provided details."
  },
  "input": [
    {
      "name": "InvoiceID",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The unique identifier of the invoice to update."
      }
    },
    {
      "name": "InvoiceNumber",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The invoice number."
      }
    },
    {
      "name": "Reference",
      "type": "String",
      "required": false,
      "meta": {
        "description": "Additional reference for the invoice."
      }
    },
    {
      "name": "Status",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The status of the invoice (e.g., DRAFT, SUBMITTED, PAID).",
        "options": ["DRAFT", "SUBMITTED", "AUTHORISED", "PAID", "VOIDED"]
      }
    },
    {
      "name": "LineAmountTypes",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The line amount types for the invoice.",
        "options": ["Exclusive", "Inclusive", "NoTax"]
      }
    },
    {
      "name": "LineItems",
      "type": "Array",
      "required": false,
      "meta": {
        "description": "Array of line items for the invoice."
      }
    },
    {
      "name": "DueDate",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The due date of the invoice (format: YYYY-MM-DD)."
      }
    },
    {
      "name": "CurrencyCode",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The currency code for the invoice (e.g., USD, EUR)."
      }
    }
  ],
  "output": [
    {
      "name": "Invoices",
      "type": "Array",
      "selector": ["Invoices"],
      "meta": {
        "description": "Array of updated invoices."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "PUT",
        "path": "/Invoices/{{InvoiceID}}",
        "headers": {
          "Content-Type": "application/json",
          "Xero-tenant-id": "{{TenantID}}"
        },
        "bodyTemplate": {
          "value": "{\n  \"InvoiceNumber\": \"{{InvoiceNumber}}\",\n  \"Reference\": \"{{Reference}}\",\n  \"Status\": \"{{Status}}\",\n  \"LineAmountTypes\": \"{{LineAmountTypes}}\",\n  \"LineItems\": {{LineItems}},\n  \"DueDate\": \"{{DueDate}}\",\n  \"CurrencyCode\": \"{{CurrencyCode}}\"\n}",
          "placeholders": [
            {
              "name": "InvoiceNumber",
              "type": "String",
              "description": "The invoice number.",
              "required": false
            },
            {
              "name": "Reference",
              "type": "String",
              "description": "Additional reference for the invoice.",
              "required": false
            },
            {
              "name": "Status",
              "type": "String",
              "description": "The status of the invoice.",
              "required": false
            },
            {
              "name": "LineAmountTypes",
              "type": "String",
              "description": "The line amount types for the invoice.",
              "required": false
            },
            {
              "name": "LineItems",
              "type": "Array",
              "description": "Array of line items for the invoice.",
              "required": false
            },
            {
              "name": "DueDate",
              "type": "String",
              "description": "The due date of the invoice.",
              "required": false
            },
            {
              "name": "CurrencyCode",
              "type": "String",
              "description": "The currency code for the invoice.",
              "required": false
            }
          ]
        }
      }
    }
  ]
}