Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Payroll

Get paycheck contribution by PaymentBatchGuid

Get list of paycheck contributions by paymentBatchGuid filtered to the authorized partner access.

get/v1/payment-batch/{paymentBatchGuid}/contributions

Path parameters

paymentBatchGuidstring required

The unique identifier for the payment batch, formatted as a GUID.

Headers

Tenantstring

Tenant company code for scoped data access during the request.

FrontOfficeTenantIdinteger

An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.

RequestIdstring uuid required

The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.

Response

200 response

paymentCheckContributionGuidstring guid required

The unique identifier for the paymentcheck contribution, formatted as a UUID.

supplierGuidstring guid required

The unique identifier for the Staffing Supplier, formatted as a UUID.

accountingPeriodDatestring date-time required

The date of accounting period the payroll was completed in.

paymentCheckGuidstring guid required

The unique identifier for the paycheck, formatted as a UUID.

talentGuidstring guid required

The unique identifier for the talent, formatted as a GUID.

employeeContributionGuidstring guid

The unique identifier for the Employee contribution.

transactionTypeIdinteger

The unique identifier for the deduction type.

checkDatestring date-time

The Check Date for the PaymentBatch.

contributionAmountnumber

The total amount deducted from the talent's paycheck.

contributionAmountYtdnumber

The Year to Date total for the deduction for the talent.

deductionAmountLtdnumber

The Life Time total for the deduction for the talent.