Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Pagamentos

Submeter lote de pagamento

Submete um lote de pagamentos para processamento assíncrono. Retorna 202 Accepted com o identificador do lote (paymentId e requestId).

O header X-Idempotency-Key (UUID v4) é obrigatório para evitar processamento duplicado em caso de retentativa.

post/{companyId}/banking/payroll/payments

Path parameters

companyIdstring required

Headers

X-Idempotency-Keystring uuid required

Chave de idempotência (UUID v4). Evita processamento duplicado de requisições.

Request body

descriptionstring nullable
scheduledDatestring date-time
paymentType2 | 5 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 17 | 18 | 19 | 20 | 21 | 22 | 24

Tipo de operação de pagamento. Valores aceitos:

  • 2 = Salário (PAG_SALARIO)
  • 5 = PLR (Participação nos Lucros e Resultados) (PAG_PLR)
  • 9 = Férias (PAG_FERIAS)
  • 10 = Décimo Terceiro (PAG_DEC_TERCEIRO)
  • 11 = Rescisão (PAG_RESCISAO)
  • 12 = Prêmio / Bonificação (PAG_PREMIO)
  • 13 = Pagamento Genérico (Crédito em Conta) (PAG_CREDITO_EM_CONTA)
  • 14 = Distribuição de Dividendos (PAG_DIST_DIVIDENDOS)
  • 15 = Pagamento de Fornecedor (PAG_FORNECEDOR)
  • 17 = Adiantamento (PAG_ADIANTAMENTO)
  • 18 = Pró-labore (PAG_PROLABORE)
  • 19 = Bolsa Estágio (PAG_BOLSA_ESTAGIO)
  • 20 = Benefício (PAG_BENEFICIO)
  • 21 = Remuneração (PAG_REMUNERACAO)
  • 22 = Reembolso (PAG_REEMBOLSO)
  • 24 = Comissão (PAG_COMISSAO)

Response

Accepted

requestIdstring nullable
paymentIdinteger
statusstring nullable
submittedAtstring date-time
totalEmployeesinteger
totalAmountnumber double
scheduledDatestring date-time