GET
/
reports#getPayrollJournalReport
curl --request GET \
  --url 'https://sandbox.rollfi.xyz/reports#getPayrollJournalReport' \
  --header 'Content-Type: application/json' \
  --data '{
  "method": "getPayrollJournalReport",
  "payPeriodId": "560372BC-8286-4061-A33B-0AEE935D563D",
  "companyId": "E4D18B68-07E2-4024-98E2-12B283B3EED4"
}'
{
  "summary": "Success",
  "value": {
    "Employee": [
      {
        "EmployeeID": "CFA175E6-C0EF-4C3C-8776-39243D85F94F",
        "CompanyID": "E4D18B68-07E2-4024-98E2-12B283B3EED4",
        "Employee": "Bryson Cherry",
        "PhoneNumber": "2356895988",
        "JobTitle": "HR",
        "Cust_EMP_ID": "",
        "details": {
          "Employee": [
            {
              "EmployeeID": "CFA175E6-C0EF-4C3C-8776-39243D85F94F",
              "CompanyID": "E4D18B68-07E2-4024-98E2-12B283B3EED4",
              "Employee": "Bryson Cherry",
              "PhoneNumber": "2356895988",
              "Cust_EMP_ID": "",
              "JobTitle": "HR",
              "EmployeeWages": [
                {
                  "WageRate": 1000,
                  "WageBasis": {
                    "WageBasis": "Per Week"
                  }
                }
              ],
              "W4Informations": [
                {
                  "W4FilingStatus": {
                    "W4FilingStatus": "Single"
                  },
                  "Dependents": 0
                }
              ],
              "EmployeeAddress": {
                "Address": "42775 Generation Dr,  Ashburn, VA, 20147-4314",
                "Address1": "42775 Generation Dr",
                "Address2": "",
                "City": "Ashburn",
                "State": "VA",
                "Zipcode": "20147-4314"
              }
            }
          ],
          "EntityTax": [
            {
              "TaxID": "569856895"
            }
          ],
          "PayrollLineItem": [],
          "payrollLineItemPrevious": []
        }
      },
      {
        "EmployeeID": "2CA2BC54-7BF1-4118-AB0A-E7D970287821",
        "CompanyID": "E4D18B68-07E2-4024-98E2-12B283B3EED4",
        "Employee": "Tori Boone",
        "PhoneNumber": "2565623202",
        "JobTitle": "QA",
        "Cust_EMP_ID": "",
        "details": {
          "Employee": [
            {
              "EmployeeID": "2CA2BC54-7BF1-4118-AB0A-E7D970287821",
              "CompanyID": "E4D18B68-07E2-4024-98E2-12B283B3EED4",
              "Employee": "Tori Boone",
              "PhoneNumber": "2565623202",
              "Cust_EMP_ID": "",
              "JobTitle": "QA",
              "EmployeeWages": [
                {
                  "WageRate": 1000,
                  "WageBasis": {
                    "WageBasis": "Per Week"
                  }
                }
              ],
              "W4Informations": [
                {
                  "W4FilingStatus": {
                    "W4FilingStatus": "Single"
                  },
                  "Dependents": 0
                }
              ],
              "EmployeeAddress": {
                "Address": "42775 Generation Dr,  Ashburn, VA, 20147-4314",
                "Address1": "42775 Generation Dr",
                "Address2": "",
                "City": "Ashburn",
                "State": "VA",
                "Zipcode": "20147-4314"
              }
            }
          ],
          "EntityTax": [
            {
              "TaxID": "258965855"
            }
          ],
          "PayrollLineItem": [
            {
              "PayPeriodID": "560372BC-8286-4061-A33B-0AEE935D563D",
              "PayrollLineItemID": "FC32B8D9-E760-4534-B522-E6EFA8462A5D",
              "PayrollLineItemDetails": [
                {
                  "CheckNumber": null,
                  "Amount": 798.5,
                  "PayPercentage": 100,
                  "EmployeePayAccount": {
                    "PayAccountTypeID": "DF7ED049-B678-42BC-9921-D7E193B0BA28",
                    "EmployeePayAccountEntities": [
                      {
                        "AccountNumber": "1111222233331111",
                        "RoutingNumber": "011401533"
                      }
                    ]
                  }
                }
              ],
              "PayPeriod": {
                "PayPeriod_PaySchedule": {
                  "StandardWorkingHours": 8
                },
                "PayPeriod": "09/23/2023 - 09/29/2023",
                "PayDate": "2024-09-25",
                "PayBeginDate": "2023-09-23",
                "PayEndDate": "2023-09-29",
                "WorkerType": {
                  "WorkerType": "W2"
                }
              },
              "BaseTotal": 1000,
              "GrossTotal": 1000,
              "NetTotal": 798.5,
              "payrollLineItemDetailsEmployeeTax": [
                {
                  "VertexRefTaxCodeMapping": {
                    "TaxIdentifierID": "400",
                    "TaxIdentifier": "Federal Withholding Tax",
                    "TaxJurisdiction": "Federal"
                  },
                  "TaxAmount": 81.85,
                  "TaxAmountYTD": 408.95
                },
                {
                  "VertexRefTaxCodeMapping": {
                    "TaxIdentifierID": "403",
                    "TaxIdentifier": "Social Security",
                    "TaxJurisdiction": "Federal"
                  },
                  "TaxAmount": 62,
                  "TaxAmountYTD": 198.4
                },
                {
                  "VertexRefTaxCodeMapping": {
                    "TaxIdentifierID": "406",
                    "TaxIdentifier": "Medicare",
                    "TaxJurisdiction": "Federal"
                  },
                  "TaxAmount": 14.5,
                  "TaxAmountYTD": 46.4
                },
                {
                  "VertexRefTaxCodeMapping": {
                    "TaxIdentifierID": "450",
                    "TaxIdentifier": "VA - State Withholding Tax",
                    "TaxJurisdiction": "State"
                  },
                  "TaxAmount": 43.15,
                  "TaxAmountYTD": 155.3
                }
              ],
              "payrollLineItemDetailsEmployerTax": [
                {
                  "VertexRefTaxCodeMapping": {
                    "TaxIdentifierID": "402",
                    "TaxIdentifier": "FUTA",
                    "TaxJurisdiction": "Federal"
                  },
                  "TaxAmount": 6,
                  "TaxAmountYTD": 19.2
                },
                {
                  "VertexRefTaxCodeMapping": {
                    "TaxIdentifierID": "404",
                    "TaxIdentifier": "Social Security",
                    "TaxJurisdiction": "Federal"
                  },
                  "TaxAmount": 62,
                  "TaxAmountYTD": 198.4
                },
                {
                  "VertexRefTaxCodeMapping": {
                    "TaxIdentifierID": "407",
                    "TaxIdentifier": "Medicare",
                    "TaxJurisdiction": "Federal"
                  },
                  "TaxAmount": 14.5,
                  "TaxAmountYTD": 46.4
                },
                {
                  "VertexRefTaxCodeMapping": {
                    "TaxIdentifierID": "459",
                    "TaxIdentifier": "VA - State Unemployment Insurance",
                    "TaxJurisdiction": "State"
                  },
                  "TaxAmount": 62,
                  "TaxAmountYTD": 198.4
                }
              ],
              "PayrollLineItemDeductions": [],
              "PayrollLineItemAdditionalCompensations": [],
              "PayrollLineItemYTDs": [
                {
                  "BaseTotal": 3200,
                  "GrossTotal": 3200,
                  "NetTotal": 2390.95
                }
              ]
            }
          ],
          "payrollLineItemPrevious": []
        }
      }
    ],
    "Company": [
      {
        "Company": "Passport hope api testing",
        "KYBInformations": [
          {
            "PhoneNumber": "8565898658"
          }
        ]
      }
    ],
    "EntityTax": [
      {
        "TaxID": "895645896"
      }
    ],
    "CompanyLocation": [
      {
        "Address": "42775 Generation Dr,  Ashburn, VA, 20147-4314",
        "CompanyLocation": "Branch",
        "Address1": "42775 Generation Dr",
        "Address2": "",
        "City": "Ashburn",
        "State": "VA",
        "Zipcode": "20147-4314"
      }
    ],
    "PayPeriod": [
      {
        "PayDate": "2024-09-25",
        "PayBeginDate": "2023-09-23",
        "PayEndDate": "2023-09-29",
        "PayPeriod": "09/23/2023 - 09/29/2023",
        "WorkerType": {
          "WorkerType": "W2"
        },
        "IsProcessed": true,
        "IsActive": true
      }
    ]
  }
}

Body

application/json
method
string
required
Example:
["getPayrollJournalReport"]
payPeriodId
string
required
companyId
string
required

Response

200 - application/json
Employee
object
required