Xero · Example Payload
Xero Getcontacts Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business
Xero Getcontacts 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

{
  "operationId": "getContacts",
  "method": "GET",
  "path": "/Contacts",
  "summary": "Retrieves all contacts in a Xero organisation",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "04e93d48-e72f-4775-b7dd-15a041fab972",
        "Status": "OK",
        "ProviderName": "Xero API Partner",
        "DateTimeUTC": "/Date(1551399323399)/",
        "pagination": {
          "page": 1,
          "pageSize": 100,
          "pageCount": 1,
          "itemCount": 2
        },
        "Contacts": [
          {
            "ContactID": "5cc8cf28-567e-4d43-b287-687cfcaec47c",
            "ContactStatus": "ACTIVE",
            "Name": "Katherine Warren",
            "FirstName": "Katherine",
            "LastName": "Warren",
            "CompanyNumber": "NumberBusiness1234",
            "EmailAddress": "kat.warren@clampett.com",
            "BankAccountDetails": "",
            "TaxNumber": "",
            "TaxNumbeType": "",
            "Addresses": [
              {
                "AddressType": "STREET",
                "City": "",
                "Region": "",
                "PostalCode": "",
                "Country": ""
              },
              {
                "AddressType": "POBOX",
                "AddressLine1": "",
                "AddressLine2": "",
                "AddressLine3": "",
                "AddressLine4": "",
                "City": "Palo Alto",
                "Region": "CA",
                "PostalCode": "94020",
                "Country": "United States"
              }
            ],
            "Phones": [
              {
                "PhoneType": "DDI",
                "PhoneNumber": "",
                "PhoneAreaCode": "",
                "PhoneCountryCode": ""
              },
              {
                "PhoneType": "DEFAULT",
                "PhoneNumber": "847-1294",
                "PhoneAreaCode": "(626)",
                "PhoneCountryCode": ""
              },
              {
                "PhoneType": "FAX",
                "PhoneNumber": "",
                "PhoneAreaCode": "",
                "PhoneCountryCode": ""
              },
              {
                "PhoneType": "MOBILE",
                "PhoneNumber": "",
                "PhoneAreaCode": "",
                "PhoneCountryCode": ""
              }
            ],
            "UpdatedDateUTC": "/Date(1503348544227+0000)/",
            "ContactGroups": [],
            "IsSupplier": true,
            "IsCustomer": true,
            "SalesDefaultLineAmountType": "INCLUSIVE",
            "PurchasesDefaultLineAmountType": "INCLUSIVE",
            "Balances": {
              "AccountsReceivable": {
                "Outstanding": 760.0,
                "Overdue": 920.0
              },
              "AccountsPayable": {
                "Outstanding": 231.6,
                "Overdue": 360.0
              }
            },
            "ContactPersons": [],
            "HasAttachments": false,
            "HasValidationErrors": false
          },
          {
            "ContactID": "3ec601ad-eddc-4ccb-a8ac-736e88293b1b",
            "ContactStatus": "ACTIVE",
            "Name": "Lisa Parker",
            "FirstName": "Lisa",
            "LastName": "Parker",
            "EmailAddress": "lparker@parkerandco.com",
            "BankAccountDetails": "",
            "TaxNumber": "",
            "TaxNumbeType": "",
            "Addresses": [
              {
                "AddressType": "STREET",
                "City": "",
                "Region": "",
                "PostalCode": "",
                "Country": ""
              },
              {
                "AddressType": "POBOX",
                "AddressLine1": "",
                "AddressLine2": "",
                "AddressLine3": "",
                "AddressLine4": "",
                "City": "Anchorage",
                "Region": "AK",
                "PostalCode": "99501",
                "Country": "United States"
              }
            ],
            "Phones": [
              {
                "PhoneType": "DDI",
                "PhoneNumber": "",
                "PhoneAreaCode": "",
                "PhoneCountryCode": ""
              },
              {
                "PhoneType": "DEFAULT",
                "PhoneNumber": "266-3583",
                "PhoneAreaCode": "(510)",
                "PhoneCountryCode": ""
              },
              {
                "PhoneType": "FAX",
                "PhoneNumber": "",
                "PhoneAreaCode": "",
                "PhoneCountryCode": ""
              },
              {
                "PhoneType": "MOBILE",
                "PhoneNumber": "",
                "PhoneAreaCode": "",
                "PhoneCountryCode": ""
              }
            ],
            "UpdatedDateUTC": "/Date(1503348546760+0000)/",
            "ContactGroups": [],
            "IsSupplier": false,
            "IsCustomer": false,
            "ContactPersons": [],
            "HasAttachments": false,
            "HasValidationErrors": false
          }
        ]
      }
    }
  ]
}