v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Pagamentos

Detalhe do lote de pagamento

Retorna o detalhe completo de um lote de pagamento, incluindo status individual de cada item.

Estados terminais: settled · failed · cancelled

get/{companyId}/banking/payroll/payments/{paymentId}

Path parameters

companyIdstring required
paymentIdinteger required

Identificador único do lote de pagamento

Query parameters

companyTaxIdsstring[]

CNPJs das empresas (14 dígitos, sem formatação). Aceita múltiplos valores.

Response

OK

paymentIdinteger
descriptionstring nullable
statusstring nullable
submittedAtstring date-time nullable
approvedAtstring date-time nullable
settledAtstring date-time nullable
cancelledAtstring date-time nullable
scheduledDatestring date-time nullable
totalEmployeesinteger
totalAmountnumber double
settledCountinteger
failedCountinteger