Payslips

The Payroll API provides the payslips resource for managing payslips. Each time an employer runs payroll in their QuickBooks Online Payroll company, a payslip is generated for each employee that was paid.

Payslips object
Field Data type Description
id String Unique identifier for this payslip.
payDate Date Pay date for this payslip.
payPeriod.beginDate Date Beginning date for the pay period.
payPeriod.endDate Date End date for the pay period.
grossPay.currentAmount String Gross pay for the current pay period.
grossPay.yearToDateAmount String Gross pay for year to date.
deductions.employeeDeduction.alternateIds.nameSpace String Alternate namespace for the employee deduction. Allows multiple namespaces for this entity. Typically used for data migration.
deductions.employeeDeduction.alternateIds.id String Alternate ID for the employee deduction. Allows multiple domain IDs for this entity. Typically used for data migration.
deductions.employeeDeduction.active Boolean Indicates whether the employee deduction is currently active.
employeeContributionAccumulationAmount.currentAmount.currency String The currency for the currently accumulated employee contribution.
employeeContributionAccumulationAmount.currentAmount.value String The value for the currently accumulated employee contribution.
employeeContributionAccumulationAmount.toDateAmounts.amount String The value to date of the currently accumulated employee contribution.
employeeContributionAccumulationAmount.toDateAmounts.toDateAmountType String The type of the currently accumulated employee contribution to date.
employerContributionAccumulationAmount.currentAmount.value String The amount to date of the currently accumulated employer contribution.
employerContributionAccumulationAmount.currentAmount.currency String The currency of the currently accumulated employer contribution.
employerContributionAccumulationAmount.toDateAmounts.amount String The current amount of the accumulated employer contribution to date.
employerContributionAccumulationAmount.toDateAmounts.toDateAmountType String The type of the accumulated employer contribution to date.
compensations.employeeCompensation.active Boolean Indicates whether the employee compensation is currently active.
compensations.employeeCompensation.rate.amount.value String The value of the employee compensation.
compensations.employeeCompensation.rate.amount.currency String The currency of the employee compensation.
calculatedCompensationAccumulationAmount.toDateAmounts.amount String The calculated compensation amount accumulated to date.
calculatedCompensationAccumulationAmount.toDateAmounts.toDateAmountType String

The type of the calculated compensation accumulated to date:

  • MONTH: Month to date
  • QUARTER: Quarter to date
  • YEAR: Year to date
calculatedCompensationAccumulationAmount.currentAmount.currency String The currency of the calculated accumulated compensation.
calculatedCompensationAccumulationAmount.currentAmount.value String The value of the calculated accumulated compensation.
Read payslips information

Scope: qb.payroll.compensation.read

Request

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
  query EmployeePayslips {
   payrollPayslips {
     edges {
       node {
         id
         payPeriod {
           beginDate
           endDate
         }
         grossPay {
           currentAmount
           yearToDateAmount
         }
         deductions {
           employeeDeduction {
             deductionPolicy {
                 statutoryType {
                     value
                 }
                 name
                 id
             }
             active
           }
           employeeContributionAccumulationAmount {
             currentAmount {
               currency
               value
             }
             toDateAmounts {
               amount
               toDateAmountType
             }
           }
           employerContributionAccumulationAmount {
             currentAmount {
               value
               currency
             }
             toDateAmounts {
               amount
               toDateAmountType
             }
           }
         }
         compensations {
           employeeCompensation {
             active
             rate {
               amount {
                 value
                 currency
               }
             }
           }
           calculatedCompensationAccumulationAmount {
             toDateAmounts {
               amount
               toDateAmountType
             }
             currentAmount {
               currency
               value
             }
           }
          }
        }
      }
    }
  }

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
  {
    "data": {
      "payrollPayslips": {
        "edges": [
          {
            "node": {
              "id": "13868994",
              "payPeriod": {
                "beginDate": "2024-05-23T00:00:00.000Z",
                "endDate": "2024-06-05T00:00:00.000Z"
              },
              "grossPay": {
                "currentAmount": "2500",
                "yearToDateAmount": "30000"
              },
              "deductions": [
                {
                  "employeeDeduction": {
                    "deductionPolicy": {
                      "statutoryType": {
                        "value": "TDED_CUS_ERP401KPT"
                      },
                      "name": "401(k)",
                      "id": "3178878"
                    },
                    "active": true
                  },
                  "employeeContributionAccumulationAmount": {
                    "currentAmount": {
                      "currency": "USD",
                      "value": "31"
                    },
                    "toDateAmounts": [
                      {
                        "amount": "262",
                        "toDateAmountType": "YEAR"
                      }
                    ]
                  },
                  "employerContributionAccumulationAmount": {
                    "currentAmount": {
                      "value": "41",
                      "currency": "USD"
                    },
                    "toDateAmounts": [
                      {
                        "amount": "382",
                        "toDateAmountType": "YEAR"
                      }
                    ]
                  }
                }
              ],
              "compensations": [
                {
                  "employeeCompensation": {
                    "active": true,
                    "rate": null
                  },
                  "calculatedCompensationAccumulationAmount": {
                    "toDateAmounts": [
                      {
                        "amount": "30000",
                        "toDateAmountType": "YEAR"
                      }
                    ],
                    "currentAmount": {
                      "currency": "USD",
                      "value": "2500"
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }