Xero · Example Payload
Xero Getcontactbycontactnumber Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business
Xero Getcontactbycontactnumber 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": "getContactByContactNumber",
  "method": "GET",
  "path": "/Contacts/{ContactNumber}",
  "summary": "Retrieves a specific contact by contact number in a Xero organisation",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "5c83b115-a6e8-4f2a-877f-ba63d009235b",
        "Status": "OK",
        "ProviderName": "Xero API Partner",
        "DateTimeUTC": "/Date(1551462703288)/",
        "Contacts": [
          {
            "ContactID": "8138a266-fb42-49b2-a104-014b7045753d",
            "ContactNumber": "SB2",
            "AccountNumber": "1234567",
            "ContactStatus": "ACTIVE",
            "Name": "Acme Parts Co.",
            "FirstName": "Blake",
            "LastName": "Kohler",
            "CompanyNumber": "NumberBusiness1234",
            "EmailAddress": "bk@krave.co",
            "BankAccountDetails": "12334567",
            "TaxNumber": "123-22-3456",
            "AccountsReceivableTaxType": "TAX003",
            "AccountsPayableTaxType": "TAX022",
            "Addresses": [
              {
                "AddressType": "STREET",
                "AddressLine1": "123 Fake Street",
                "City": "Vancouver",
                "Region": "British Columbia",
                "PostalCode": "V6B 2T4",
                "Country": "",
                "AttentionTo": ""
              },
              {
                "AddressType": "POBOX",
                "AddressLine1": "1234 Fake Street",
                "City": "Vancouver",
                "Region": "British Columbia",
                "PostalCode": "V6B 2T4",
                "Country": "",
                "AttentionTo": "Blake"
              }
            ],
            "Phones": [
              {
                "PhoneType": "DDI",
                "PhoneNumber": "489-44493",
                "PhoneAreaCode": "345",
                "PhoneCountryCode": "4"
              },
              {
                "PhoneType": "DEFAULT",
                "PhoneNumber": "408-0914",
                "PhoneAreaCode": "604",
                "PhoneCountryCode": "1"
              },
              {
                "PhoneType": "FAX",
                "PhoneNumber": "123-9933",
                "PhoneAreaCode": "123",
                "PhoneCountryCode": "2"
              },
              {
                "PhoneType": "MOBILE",
                "PhoneNumber": "999-44",
                "PhoneAreaCode": "234",
                "PhoneCountryCode": "3"
              }
            ],
            "UpdatedDateUTC": "/Date(1551459777193+0000)/",
            "ContactGroups": [],
            "IsSupplier": true,
            "IsCustomer": true,
            "SalesDefaultLineAmountType": "INCLUSIVE",
            "PurchasesDefaultLineAmountType": "INCLUSIVE",
            "DefaultCurrency": "USD",
            "Discount": 13.0,
            "Website": "http://www.google.com",
            "BrandingTheme": {
              "BrandingThemeID": "dabc7637-62c1-4941-8a6e-ee44fa5090e7",
              "Name": "Standard"
            },
            "PurchasesDefaultAccountCode": "660",
            "SalesDefaultAccountCode": "002",
            "BatchPayments": {
              "BankAccountNumber": "12334567",
              "BankAccountName": "Citi Bank",
              "Details": "biz checking",
              "Code": "",
              "Reference": ""
            },
            "Balances": {
              "AccountsReceivable": {
                "Outstanding": 118.9,
                "Overdue": 136.9
              },
              "AccountsPayable": {
                "Outstanding": -43.6,
                "Overdue": 40.0
              }
            },
            "PaymentTerms": {
              "Bills": {
                "Day": 12,
                "Type": "OFFOLLOWINGMONTH"
              },
              "Sales": {
                "Day": 14,
                "Type": "OFCURRENTMONTH"
              }
            },
            "ContactPersons": [
              {
                "FirstName": "Sue",
                "LastName": "Johnson",
                "EmailAddress": "sue.johnson@krave.com",
                "IncludeInEmails": true
              }
            ],
            "HasAttachments": true,
            "Attachments": [
              {
                "AttachmentID": "04e0a3e3-b116-456a-9f32-9706f0d33afa",
                "FileName": "sample5.jpg",
                "Url": "https://api.xero.com/api.xro/2.0/contact/8138a266-fb42-49b2-a104-014b7045753d/Attachments/sample5.jpg",
                "MimeType": "image/jpg",
                "ContentLength": 2878711
              }
            ],
            "HasValidationErrors": false
          }
        ]
      }
    }
  ]
}