Xero · Example Payload

Xero Updateinvoice Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Updateinvoice Example is an example object payload from Xero, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "updateInvoice",
  "method": "POST",
  "path": "/Invoices/{InvoiceID}",
  "summary": "Xero Updates a specific sales invoices or purchase bills",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "Invoices": [
          {
            "Reference": "May the force be with you",
            "InvoiceID": "00000000-0000-0000-0000-000000000000",
            "LineItems": [],
            "Contact": {},
            "Type": "ACCPAY"
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "bd83b60e-9d16-4a3b-9f59-0a2d0ccd35f2",
        "Status": "OK",
        "ProviderName": "Provider Name Example",
        "DateTimeUTC": "/Date(1552329729002)/",
        "Invoices": [
          {
            "Type": "ACCREC",
            "InvoiceID": "4074292c-09b3-456d-84e7-add864c6c39b",
            "InvoiceNumber": "INV-0008",
            "Reference": "My the Force be With You",
            "Prepayments": [],
            "Overpayments": [],
            "AmountDue": 575.0,
            "AmountPaid": 0.0,
            "SentToContact": false,
            "CurrencyRate": 1.0,
            "HasErrors": false,
            "IsDiscounted": false,
            "Contact": {
              "ContactID": "be392c72-c121-4f83-9512-03ac71e54c20",
              "ContactStatus": "ACTIVE",
              "Name": "Luke Skywalker",
              "EmailAddress": "",
              "BankAccountDetails": "",
              "Addresses": [
                {
                  "AddressType": "STREET",
                  "City": "",
                  "Region": "",
                  "PostalCode": "",
                  "Country": ""
                },
                {
                  "AddressType": "POBOX",
                  "City": "",
                  "Region": "",
                  "PostalCode": "",
                  "Country": ""
                }
              ],
              "Phones": [
                {
                  "PhoneType": "DEFAULT",
                  "PhoneNumber": "",
                  "PhoneAreaCode": "",
                  "PhoneCountryCode": ""
                },
                {
                  "PhoneType": "DDI",
                  "PhoneNumber": "",
                  "PhoneAreaCode": "",
                  "PhoneCountryCode": ""
                },
                {
                  "PhoneType": "FAX",
                  "PhoneNumber": "",
                  "PhoneAreaCode": "",
                  "PhoneCountryCode": ""
                },
                {
                  "PhoneType": "MOBILE",
                  "PhoneNumber": "",
                  "PhoneAreaCode": "",
                  "PhoneCountryCode": ""
                }
              ],
              "UpdatedDateUTC": "/Date(1552329691573+0000)/",
              "ContactGroups": [],
              "IsSupplier": false,
              "IsCustomer": true,
              "DefaultCurrency": "NZD",
              "SalesTrackingCategories": [],
              "PurchasesTrackingCategories": [],
              "ContactPersons": [],
              "HasValidationErrors": false
            },
            "DateString": "2019-03-11 00:00:00",
            "Date": "/Date(1552262400000+0000)/",
            "DueDateString": "2019-03-12 00:00:00",
            "DueDate": "/Date(1552348800000+0000)/",
            "Status": "SUBMITTED",
            "LineAmountTypes": "Exclusive",
            "LineItems": [
              {
                "Description": "Light Saber",
                "UnitAmount": 500.0,
                "TaxType": "OUTPUT2",
                "TaxAmount": 75.0,
                "LineAmount": 500.0,
                "AccountCode": "200",
                "Tracking": [],
                "Quantity": 1.0,
                "LineItemID": "6de1bf9f-de95-4c47-9287-37305db758c9",
                "ValidationErrors": []
              }
            ],
            "SubTotal": 500.0,
            "TotalTax": 75.0,
            "Total": 575.0,
            "UpdatedDateUTC": "/Date(1552329728987+0000)/",
            "CurrencyCode": "NZD"
          }
        ]
      }
    }
  ]
}