Skip to main content
POST
Fechar Lote

Authorizations

Authorization
string
header
required

Path Parameters

split_id
string
required

Response

Successful Response

Representa os dados de um relatório de divisão.

Atributos:

  • id (str, opcional): ID do relatório de divisão.
  • payment_batch_name (str, opcional): Nome do lote de pagamentos associado ao relatório.
  • split_date (str, opcional): Data de criação do relatório de divisão (formato ISO 8601).
  • fee (float, opcional): Taxa aplicada ao relatório.
  • fee_amount (float, opcional): Valor da taxa aplicada.
  • fee_paid (bool, opcional): Indica se a taxa foi paga.
  • tax_id (str, opcional): CPF ou CNPJ do responsável pelo relatório.
  • batch_id (str, opcional): ID do lote associado ao relatório.
  • report_id (str, opcional): ID do relatório associado.
  • bubble_id (str, opcional): ID do relatório no sistema Bubble.
  • status (str, opcional): Status atual do relatório de divisão.
  • logo (str, opcional): URL do logo associado ao relatório.
  • origin (str, opcional): Origem do relatório.
  • currency (str, opcional): Moeda utilizada no relatório (ex.: BRL, USD, EUR).
  • exchange_order_id (str, opcional): ID da ordem de câmbio associada.
  • pix_qr_code_id (str, opcional): ID do QR Code Pix associado.
  • pix_qr_code_payload (str, opcional): Payload do QR Code Pix associado.
  • exchange_rate (float, opcional): Taxa de câmbio aplicada.
  • show_exchange_data (bool, opcional): Indica se os dados de câmbio devem ser exibidos.
  • date (str, opcional): Data do relatório (formato ISO 8601).
  • pending_payments (int, opcional): Número de pagamentos pendentes.
  • withhold_payments (int, opcional): Número de pagamentos retidos.
  • done_payments (int, opcional): Número de pagamentos concluídos.
  • pending_amount (float, opcional): Valor total pendente.
  • withhold_amount (float, opcional): Valor total retido.
  • ir_amount (float, opcional): Valor total de imposto retido.
  • paid_amount (float, opcional): Valor total pago.
  • total_amount (float, opcional): Valor total do relatório.
_id
string | null

ID do relatório de divisão.

paymentBatchName
string | null

Nome do lote de pagamentos associado ao relatório.

splitDate
string | null

Data de criação do relatório de divisão (formato ISO 8601).

fee
number | null

Taxa aplicada ao relatório.

feeAmount
number | null

Valor da taxa aplicada.

feePaid
boolean | null

Indica se a taxa foi paga.

taxId
string | null

CPF ou CNPJ do responsável pelo relatório.

batchId
string | null

ID do lote associado ao relatório.

reportId
string | null

ID do relatório associado.

bubbleId
string | null

ID do relatório no sistema Bubble.

status
string | null

Status atual do relatório de divisão.

logo
string | null

URL do logo associado ao relatório.

origin
string | null

Origem do relatório.

currency
string | null

Moeda utilizada no relatório (ex.: BRL, USD, EUR).

exchangeOrderId
string | null

ID da ordem de câmbio associada.

pixQrCodeId
string | null

ID do QR Code Pix associado.

pixQrCodePayload
string | null

Payload do QR Code Pix associado.

exchangeRate
number | null

Taxa de câmbio aplicada.

showExchangeData
boolean | null

Indica se os dados de câmbio devem ser exibidos.

date
string | null

Data do relatório (formato ISO 8601).

pendingPayments
integer | null

Número de pagamentos pendentes.

withholdPayments
integer | null

Número de pagamentos retidos.

donePayments
integer | null

Número de pagamentos concluídos.

pendingAmount
number | null

Valor total pendente.

withholdAmount
number | null

Valor total retido.

irAmount
number | null

Valor total de imposto retido.

paidAmount
number | null

Valor total pago.

totalAmount
number | null

Valor total do relatório.