Xero · Example Payload

Xero Createpayitem Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Createpayitem 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": "createPayItem",
  "method": "POST",
  "path": "/PayItems",
  "summary": "Creates a pay item",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "EarningsRates": [
          {
            "Name": "MyRate",
            "AccountCode": "400",
            "TypeOfUnits": "4.00",
            "IsExemptFromTax": false,
            "IsExemptFromSuper": true,
            "IsReportableAsW1": false,
            "IsQualifyingEarnings": true,
            "AllowanceContributesToAnnualLeaveRate": false,
            "AllowanceContributesToOvertimeRate": false,
            "EarningsType": "ORDINARYTIMEEARNINGS",
            "EarningsRateID": "1fa4e226-b711-46ba-a8a7-4344c9c5fb87",
            "RateType": "MULTIPLE",
            "RatePerUnit": "10.0",
            "Multiplier": 1.5,
            "Amount": 5,
            "EmploymentTerminationPaymentType": "O"
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Status": "OK",
        "ProviderName": "provider-name",
        "DateTimeUTC": "/Date(1593448963288)/",
        "PayItems": {
          "EarningsRates": [
            {
              "EarningsRateID": "1fa4e226-b711-46ba-a8a7-4344c9c5fb87",
              "Name": "MyRate",
              "EarningsType": "ORDINARYTIMEEARNINGS",
              "RateType": "MULTIPLE",
              "AccountCode": "400",
              "Multiplier": 1.5,
              "IsExemptFromTax": true,
              "IsExemptFromSuper": true,
              "AccrueLeave": false,
              "IsReportableAsW1": false,
              "IsQualifyingEarnings": false,
              "AllowanceContributesToAnnualLeaveRate": false,
              "AllowanceContributesToOvertimeRate": false,
              "UpdatedDateUTC": "/Date(1593448963210+0000)/",
              "CurrentRecord": true
            },
            {
              "EarningsRateID": "c6905c26-0716-4746-9098-608545e04dd2",
              "Name": "Redundancy",
              "EarningsType": "LUMPSUMD",
              "RateType": "FIXEDAMOUNT",
              "AccountCode": "477",
              "IsExemptFromTax": true,
              "IsExemptFromSuper": true,
              "IsReportableAsW1": true,
              "IsQualifyingEarnings": false,
              "AllowanceContributesToAnnualLeaveRate": false,
              "AllowanceContributesToOvertimeRate": false,
              "UpdatedDateUTC": "/Date(1476729649000+0000)/",
              "CurrentRecord": true
            },
            {
              "EarningsRateID": "33820094-656e-4db3-b04b-8bd3e2db0a9b",
              "Name": "ETP Leave Earning",
              "EarningsType": "EMPLOYMENTTERMINATIONPAYMENT",
              "RateType": "RATEPERUNIT",
              "AccountCode": "477",
              "TypeOfUnits": "Hours",
              "IsExemptFromTax": false,
              "IsExemptFromSuper": true,
              "IsReportableAsW1": true,
              "IsQualifyingEarnings": false,
              "AllowanceContributesToAnnualLeaveRate": false,
              "AllowanceContributesToOvertimeRate": false,
              "UpdatedDateUTC": "/Date(1520900705000+0000)/",
              "EmploymentTerminationPaymentType": "O",
              "CurrentRecord": true
            }
          ]
        }
      }
    }
  ]
}