Xero · Example Payload

Xero Updatepaysliplineitems Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Updatepaysliplineitems 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": "updatePaySlipLineItems",
  "method": "PUT",
  "path": "/PaySlips/{PaySlipID}",
  "summary": "Creates an employee pay slip",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "earningsLines": [
          {
            "earningsLineID": "f9d8f5b5-9049-47f4-8541-35e200f750a5",
            "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5",
            "displayName": "Ordinary Time",
            "ratePerUnit": 25,
            "numberOfUnits": 0,
            "amount": 0,
            "isLinkedToTimesheet": false,
            "isSystemGenerated": true
          },
          {
            "earningsLineID": "65b83d94-f20f-45e1-85ae-387fcf460c26",
            "earningsRateID": "65b83d94-f20f-45e1-85ae-387fcf460c26",
            "displayName": "Salary",
            "ratePerUnit": 0,
            "numberOfUnits": 8,
            "amount": 0,
            "isLinkedToTimesheet": false,
            "isSystemGenerated": false
          }
        ],
        "leaveEarningsLines": [
          {
            "earningsLineID": "0441497f-5dc7-4cd3-a90d-f2e07e21b2a6",
            "earningsRateID": "39b3560a-5d2f-4538-924a-4349dc86396e",
            "displayName": "Holiday Pay",
            "fixedAmount": 268.8,
            "amount": 268.8,
            "isLinkedToTimesheet": false,
            "isSystemGenerated": true
          }
        ],
        "deductionLines": [
          {
            "deductionTypeID": "a3760fe4-68a4-4e38-8326-fe616af7dc74",
            "amount": 100
          }
        ],
        "leaveAccrualLines": [
          {
            "leaveTypeID": "0441497f-5dc7-4cd3-a90d-f2e07e21b2a6",
            "numberOfUnits": 268.8
          },
          {
            "leaveTypeID": "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4",
            "numberOfUnits": 0
          },
          {
            "leaveTypeID": "f2f994cf-1899-46f3-ad4f-5d92d78c3719",
            "numberOfUnits": 0
          },
          {
            "leaveTypeID": "34129765-11cb-4d8c-b568-84a2219beda3",
            "numberOfUnits": 0
          }
        ],
        "superannuationLines": [
          {
            "superannuationTypeID": "563273ea-0dae-4f82-86a4-e0db77c008ea",
            "displayName": "KiwiSaver",
            "amount": 108.86,
            "fixedAmount": 3,
            "percentage": 3,
            "manualAdjustment": false
          }
        ],
        "employeeTaxLines": [
          {
            "taxLineID": "1084146b-e890-489c-aed3-06de80f63d84",
            "amount": 1057.22,
            "globalTaxTypeID": "11",
            "manualAdjustment": false
          }
        ],
        "employerTaxLines": [
          {
            "taxLineID": "6f9eb8cd-0f4a-440b-939c-bdb0f6ad694c",
            "amount": 18.9,
            "globalTaxTypeID": "10",
            "manualAdjustment": false
          }
        ],
        "statutoryDeductionLines": [
          {
            "statutoryDeductionTypeID": "b5efd8d1-0c93-4a14-a314-b5cba4a4e6b3",
            "amount": 108.86
          }
        ],
        "grossEarningsHistory": {
          "daysPaid": 3,
          "unpaidWeeks": 0
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "00000000-0000-0000-0000-000000000000",
        "providerName": "provider-name",
        "dateTimeUTC": "2020-09-10 17:20:24.297016",
        "httpStatusCode": "OK",
        "pagination": null,
        "problem": null,
        "paySlip": {
          "paySlipID": "51a01760-cf9d-4ba1-bf3a-2065d4f8e073",
          "employeeID": "68342973-c405-4b86-b5d3-d7b877c27995",
          "payRunID": "8ba9831d-38e4-43d4-808e-472a5d195bce",
          "lastEdited": "2020-09-10 17:20:23.733501",
          "firstName": "Tony",
          "lastName": "Starkwpjgdjxdvwson",
          "totalEarnings": 3628.8,
          "grossEarnings": 3628.8,
          "totalPay": 2362.72,
          "totalEmployerTaxes": 18.9,
          "totalEmployeeTaxes": 1057.22,
          "totalDeductions": 100,
          "totalReimbursements": 0,
          "totalStatutoryDeductions": 108.86,
          "totalSuperannuation": 108.86,
          "bacsHash": null,
          "paymentMethod": "Electronically",
          "earningsLines": [
            {
              "earningsLineID": "f9d8f5b5-9049-47f4-8541-35e200f750a5",
              "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5",
              "displayName": "Ordinary Time",
              "ratePerUnit": 25,
              "numberOfUnits": 0,
              "fixedAmount": null,
              "amount": 0,
              "isLinkedToTimesheet": false,
              "isAverageDailyPayRate": null,
              "isSystemGenerated": true
            },
            {
              "earningsLineID": "65b83d94-f20f-45e1-85ae-387fcf460c26",
              "earningsRateID": "65b83d94-f20f-45e1-85ae-387fcf460c26",
              "displayName": "Salary",
              "ratePerUnit": 0,
              "numberOfUnits": 8,
              "fixedAmount": null,
              "amount": 0,
              "isLinkedToTimesheet": false,
              "isAverageDailyPayRate": null,
              "isSystemGenerated": false
            }
          ],
          "leaveEarningsLines": [
            {
              "earningsLineID": "0441497f-5dc7-4cd3-a90d-f2e07e21b2a6",
              "earningsRateID": "39b3560a-5d2f-4538-924a-4349dc86396e",
              "displayName": "Holiday Pay",
              "ratePerUnit": null,
              "numberOfUnits": null,
              "fixedAmount": 268.8,
              "amount": 268.8,
              "isLinkedToTimesheet": false,
              "isAverageDailyPayRate": null,
              "isSystemGenerated": true
            }
          ],
          "timesheetEarningsLines": [],
          "deductionLines": [
            {
              "deductionTypeID": "a3760fe4-68a4-4e38-8326-fe616af7dc74",
              "displayName": "KiwiSaver Voluntary Contributions",
              "amount": 100,
              "subjectToTax": null,
              "percentage": null
            }
          ],
          "reimbursementLines": [],
          "leaveAccrualLines": [
            {
              "leaveTypeID": "0441497f-5dc7-4cd3-a90d-f2e07e21b2a6",
              "numberOfUnits": 268.8
            },
            {
              "leaveTypeID": "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4",
              "numberOfUnits": 0
            },
            {
              "leaveTypeID": "f2f994cf-1899-46f3-ad4f-5d92d78c3719",
              "numberOfUnits": 0
            },
            {
              "leaveTypeID": "34129765-11cb-4d8c-b568-84a2219beda3",
              "numberOfUnits": 0
            }
          ],
          "superannuationLines": [
            {
              "superannuationTypeID": "563273ea-0dae-4f82-86a4-e0db77c008ea",
              "displayName": "KiwiSaver",
              "amount": 108.86,
              "fixedAmount": 3,
              "percentage": 3,
              "manualAdjustment": false
            }
          ],
          "paymentLines": [
            {
              "paymentLineID": "6dc42925-2a11-4041-ac9a-4098e77791d5",
              "amount": 2262.72,
              "accountNumber": "0607050201419000",
              "sortCode": null,
              "accountName": "Casual Worker"
            },
            {
              "paymentLineID": "30d6d414-426b-417d-8d0d-d05ca0e5bc88",
              "amount": 100,
              "accountNumber": "1234448494848373",
              "sortCode": null,
              "accountName": "test"
            }
          ],
          "employeeTaxLines": [
            {
              "taxLineID": "2faf8f5d-6446-4bea-a2cd-d5cd7e8b9384",
              "description": null,
              "amount": 1057.22,
              "globalTaxTypeID": 11,
              "manualAdjustment": false
            }
          ],
          "employerTaxLines": [
            {
              "taxLineID": "caa8d4fa-0949-460d-90f5-f43ec9f3db12",
              "description": null,
              "amount": 18.9,
              "globalTaxTypeID": 10,
              "manualAdjustment": false
            }
          ],
          "statutoryDeductionLines": [
            {
              "statutoryDeductionTypeID": "b5efd8d1-0c93-4a14-a314-b5cba4a4e6b3",
              "amount": 108.86,
              "fixedAmount": null,
              "manualAdjustment": null
            }
          ],
          "taxSettings": {
            "periodUnits": 1.0,
            "periodType": "weeks",
            "taxCode": "M",
            "specialTaxRate": null,
            "lumpSumTaxCode": "SB",
            "lumpSumAmount": null
          },
          "grossEarningsHistory": {
            "daysPaid": 3,
            "unpaidWeeks": 0
          }
        }
      }
    }
  ]
}