Xero · Example Payload

Xero Getorganisations Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Getorganisations 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": "getOrganisations",
  "method": "GET",
  "path": "/Organisation",
  "summary": "Retrieves Xero organisation details",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "27b7a645-a3ee-43c8-b2c6-a2fa7b84c8c5",
        "Status": "OK",
        "ProviderName": "Provider Name Example",
        "DateTimeUTC": "/Date(1552404447003)/",
        "Organisations": [
          {
            "APIKey": "CTJ60UH519MXQIXEJSDPDALS3EOZ5Y",
            "Name": "Dev Evangelist - Sid Test 3 (NZ-2016-02)",
            "LegalName": "Dev Evangelist - Sid Test 3 (NZ-2016-02)",
            "PaysTax": true,
            "Version": "NZ",
            "OrganisationType": "COMPANY",
            "BaseCurrency": "NZD",
            "CountryCode": "NZ",
            "IsDemoCompany": false,
            "OrganisationStatus": "ACTIVE",
            "TaxNumber": "071-138-054",
            "FinancialYearEndDay": 31,
            "FinancialYearEndMonth": 3,
            "SalesTaxBasis": "PAYMENTS",
            "SalesTaxPeriod": "TWOMONTHS",
            "DefaultSalesTax": "Tax Exclusive",
            "DefaultPurchasesTax": "Tax Exclusive",
            "PeriodLockDate": "/Date(1546214400000+0000)/",
            "EndOfYearLockDate": "/Date(1546214400000+0000)/",
            "CreatedDateUTC": "/Date(1455827393000)/",
            "OrganisationEntityType": "COMPANY",
            "Timezone": "NEWZEALANDSTANDARDTIME",
            "ShortCode": "!mBdtL",
            "OrganisationID": "b2c885a9-4bb9-4a00-9b6e-6c2bf60b1a2b",
            "Edition": "BUSINESS",
            "Class": "PREMIUM",
            "Addresses": [],
            "Phones": [],
            "ExternalLinks": [],
            "PaymentTerms": {}
          }
        ]
      }
    }
  ]
}