AVavionte
Payroll

Get Paychecks by Payment Batch GUID

Returns a list of paychecks for the specified payment batch.

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

Request

  • Base URL
    https://api.avionte.com/back-office
  • URL
    https://api.avionte.com/back-office/v1/payment-batch/{paymentBatchGuid}/paychecks
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

paymentBatchGuidstring required

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

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

supplierGuidstring guid required

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

branchGuidstring guid

The unique identifier for the branch.

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.

payeeGuidstring guid required

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

payeeTypestring

The type of payee, either Talent or Agency.

checkNumberstring

The identifier for the check.

checkDatestring date-time required

The Check Date for the PaymentBatch.

statusstring

The status of the paycheck.

isW2boolean

An indication of whether the paycheck is a W2 or Non-W2.

Changes

No recorded changes to this operation across all 1 revision of this API.