Action: Create Invoice

Xero Operation

Create a new invoice in Xero

Example User Story

As a business owner, I want to post an invoice to Xero so that I can bill my customers accurately and efficiently.

Fields

Field Name	Field Type	Required
contactID	String	Yes
lineItems	Array	Yes
date	String	No
dueDate	String	No
invoiceNumber	String	No
reference	String	No

Related Connections

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "post-invoice",
  "state": "inDev",
  "meta": {
    "short": "Post Invoice",
    "description": "Creates a new invoice in Xero."
  },
  "input": [
    {
      "name": "contactID",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The Xero ContactID for the customer."
      }
    },
    {
      "name": "lineItems",
      "type": "Array",
      "required": true,
      "meta": {
        "description": "Array of line items for the invoice."
      }
    },
    {
      "name": "date",
      "type": "String",
      "required": false,
      "meta": {
        "description": "Date of the invoice (YYYY-MM-DD)."
      }
    },
    {
      "name": "dueDate",
      "type": "String",
      "required": false,
      "meta": {
        "description": "Due date of the invoice (YYYY-MM-DD)."
      }
    },
    {
      "name": "invoiceNumber",
      "type": "String",
      "required": false,
      "meta": {
        "description": "Invoice number."
      }
    },
    {
      "name": "reference",
      "type": "String",
      "required": false,
      "meta": {
        "description": "Additional reference for the invoice."
      }
    }
  ],
  "output": [
    {
      "name": "invoiceID",
      "type": "String",
      "selector": ["Invoices", "InvoiceID"],
      "meta": {
        "description": "The ID of the created invoice."
      }
    },
    {
      "name": "invoiceNumber",
      "type": "String",
      "selector": ["Invoices", "InvoiceNumber"],
      "meta": {
        "description": "The invoice number of the created invoice."
      }
    },
    {
      "name": "status",
      "type": "String",
      "selector": ["Invoices", "Status"],
      "meta": {
        "description": "The status of the created invoice."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/api.xro/2.0/Invoices",
        "headers": {
          "Content-Type": "application/json",
          "Xero-tenant-id": "{{tenantID}}"
        },
        "bodyTemplate": {
          "value": "{\"Invoices\":[{\"Type\":\"ACCREC\",\"Contact\":{\"ContactID\":\"{{contactID}}\"},\"Date\":\"{{date}}\",\"DueDate\":\"{{dueDate}}\",\"LineItems\":{{lineItems}},\"InvoiceNumber\":\"{{invoiceNumber}}\",\"Reference\":\"{{reference}}\"}]}",
          "placeholders": [
            {
              "name": "accessToken",
              "type": "String",
              "description": "Xero access token.",
              "required": true
            },
            {
              "name": "tenantID",
              "type": "String",
              "description": "Xero tenant ID.",
              "required": true
            },
            {
              "name": "contactID",
              "type": "String",
              "description": "The Xero ContactID for the customer.",
              "required": true
            },
            {
              "name": "lineItems",
              "type": "String",
              "description": "JSON array of line items for the invoice.",
              "required": true
            },
            {
              "name": "date",
              "type": "String",
              "description": "Date of the invoice (YYYY-MM-DD).",
              "required": false
            },
            {
              "name": "dueDate",
              "type": "String",
              "description": "Due date of the invoice (YYYY-MM-DD).",
              "required": false
            },
            {
              "name": "invoiceNumber",
              "type": "String",
              "description": "Invoice number.",
              "required": false
            },
            {
              "name": "reference",
              "type": "String",
              "description": "Additional reference for the invoice.",
              "required": false
            }
          ]
        }
      }
    }
  ]
}