Xero · Example Payload

Xero Getinvoices Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Getinvoices 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": "getInvoices",
  "method": "GET",
  "path": "/Invoices",
  "summary": "Xero Retrieves sales invoices or purchase bills",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "900c500b-e83c-4ce2-902a-b8ba04751748",
        "Status": "OK",
        "ProviderName": "Provider Name Example",
        "DateTimeUTC": "/Date(1552326816230)/",
        "pagination": {
          "page": 1,
          "pageSize": 100,
          "pageCount": 1,
          "itemCount": 3
        },
        "Invoices": [
          {
            "Type": "ACCREC",
            "InvoiceID": "d4956132-ed94-4dd7-9eaa-aa22dfdf06f2",
            "InvoiceNumber": "INV-0001",
            "Reference": "Red Fish, Blue Fish",
            "Payments": [],
            "CreditNotes": [],
            "Prepayments": [],
            "Overpayments": [],
            "AmountDue": 0.0,
            "AmountPaid": 0.0,
            "AmountCredited": 0.0,
            "SentToContact": true,
            "CurrencyRate": 1.0,
            "HasErrors": false,
            "IsDiscounted": false,
            "HasAttachments": false,
            "RepeatingInvoiceID": "428c0d75-909f-4b04-8403-a48dc27283b0",
            "Contact": {
              "ContactID": "a3675fc4-f8dd-4f03-ba5b-f1870566bcd7",
              "Name": "Barney Rubble-83203",
              "Addresses": [],
              "Phones": [],
              "ContactGroups": [],
              "ContactPersons": [],
              "HasValidationErrors": false
            },
            "DateString": "2018-10-20 00:00:00",
            "Date": "/Date(1539993600000+0000)/",
            "DueDateString": "2018-12-30 00:00:00",
            "DueDate": "/Date(1546128000000+0000)/",
            "Status": "VOIDED",
            "LineAmountTypes": "Exclusive",
            "LineItems": [],
            "SubTotal": 40.0,
            "TotalTax": 0.0,
            "Total": 40.0,
            "UpdatedDateUTC": "/Date(1541176290160+0000)/",
            "CurrencyCode": "NZD"
          },
          {
            "Type": "ACCREC",
            "InvoiceID": "046d8a6d-1ae1-4b4d-9340-5601bdf41b87",
            "InvoiceNumber": "INV-0002",
            "Reference": "Red Fish, Blue Fish",
            "Payments": [
              {
                "PaymentID": "99ea7f6b-c513-4066-bc27-b7c65dcd76c2",
                "Date": "/Date(1543449600000+0000)/",
                "Amount": 46.0,
                "CurrencyRate": 1.0,
                "HasAccount": false,
                "HasValidationErrors": false
              }
            ],
            "CreditNotes": [],
            "Prepayments": [],
            "Overpayments": [],
            "AmountDue": 0.0,
            "AmountPaid": 46.0,
            "AmountCredited": 0.0,
            "SentToContact": true,
            "CurrencyRate": 1.0,
            "HasErrors": false,
            "IsDiscounted": false,
            "HasAttachments": false,
            "Contact": {
              "ContactID": "a3675fc4-f8dd-4f03-ba5b-f1870566bcd7",
              "Name": "Barney Rubble-83203",
              "Addresses": [],
              "Phones": [],
              "ContactGroups": [],
              "ContactPersons": [],
              "HasValidationErrors": false
            },
            "DateString": "2018-10-20 00:00:00",
            "Date": "/Date(1539993600000+0000)/",
            "DueDateString": "2018-12-30 00:00:00",
            "DueDate": "/Date(1546128000000+0000)/",
            "Status": "PAID",
            "LineAmountTypes": "Exclusive",
            "LineItems": [],
            "SubTotal": 40.0,
            "TotalTax": 6.0,
            "Total": 46.0,
            "UpdatedDateUTC": "/Date(1541176592690+0000)/",
            "CurrencyCode": "NZD",
            "FullyPaidOnDate": "/Date(1543449600000+0000)/"
          },
          {
            "Type": "ACCREC",
            "InvoiceID": "7ef31b20-de17-4312-8382-412f869b1510",
            "InvoiceNumber": "INV-0003",
            "Reference": "",
            "Payments": [],
            "CreditNotes": [],
            "Prepayments": [],
            "Overpayments": [],
            "AmountDue": 115.0,
            "AmountPaid": 0.0,
            "AmountCredited": 0.0,
            "CurrencyRate": 1.0,
            "HasErrors": false,
            "IsDiscounted": false,
            "HasAttachments": false,
            "Contact": {
              "ContactID": "a3675fc4-f8dd-4f03-ba5b-f1870566bcd7",
              "Name": "Barney Rubble-83203",
              "Addresses": [],
              "Phones": [],
              "ContactGroups": [],
              "ContactPersons": [],
              "HasValidationErrors": false
            },
            "DateString": "2018-11-02 00:00:00",
            "Date": "/Date(1541116800000+0000)/",
            "DueDateString": "2018-11-07 00:00:00",
            "DueDate": "/Date(1541548800000+0000)/",
            "Status": "AUTHORISED",
            "LineAmountTypes": "Exclusive",
            "LineItems": [],
            "SubTotal": 100.0,
            "TotalTax": 15.0,
            "Total": 115.0,
            "UpdatedDateUTC": "/Date(1541176648927+0000)/",
            "CurrencyCode": "NZD"
          }
        ]
      }
    }
  ]
}