Xero · Example Payload

Xero Getsuperannuations Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Getsuperannuations 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": "getSuperannuations",
  "method": "GET",
  "path": "/Superannuations",
  "summary": "Retrieves superannuations",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "563273ea-0dae-4f82-86a4-e0db77c008ea",
        "providerName": "provider-name",
        "dateTimeUTC": "2020-09-14 22:35:14.680608",
        "httpStatusCode": "OK",
        "pagination": {
          "page": 1,
          "pageSize": 100,
          "pageCount": 1,
          "itemCount": 2
        },
        "problem": null,
        "benefits": [
          {
            "id": "563273ea-0dae-4f82-86a4-e0db77c008ea",
            "name": "KiwiSaver",
            "category": "KiwiSaver",
            "liabilityAccountId": "fa5cdc43-643b-4ad8-b4ac-3ffe0d0f4488",
            "expenseAccountId": "b343c3b0-5941-4166-82b4-dd926622e0e2",
            "standardAmount": 5,
            "percentage": 3,
            "calculationTypeNZ": "PercentageOfTaxableEarnings",
            "currentRecord": true,
            "companyMax": 2
          },
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "SidSaver",
            "category": "Other",
            "liabilityAccountId": "568f2e9a-0870-46cc-8678-f83f132ed4e3",
            "expenseAccountId": "e4eb36f6-97e3-4427-a394-dd4e1b355c2e",
            "standardAmount": 10,
            "percentage": 4,
            "calculationTypeNZ": "FixedAmount",
            "currentRecord": true,
            "companyMax": 4
          }
        ]
      }
    }
  ]
}