Skip to main content
POST
Definir Pagamento como Pago

Authorizations

Authorization
string
header
required

Path Parameters

payment_id
string
required

Response

Successful Response

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

Atributos:

  • id (str, opcional): ID do pagamento.
  • split_id (str, opcional): ID do relatório de divisão associado ao pagamento.
  • split_batch (str, opcional): Nome do lote de divisão associado ao pagamento.
  • split_date (str, opcional): Data do relatório de divisão (formato ISO 8601).
  • report_id (str, opcional): ID do relatório associado ao pagamento.
  • anticipation_id (str, opcional): ID da antecipação, se aplicável.
  • owner_tax_id (str, opcional): CPF ou CNPJ do proprietário do pagamento.
  • origin (str, opcional): Origem do pagamento.
  • tax_id (str, opcional): CPF ou CNPJ do beneficiário do pagamento.
  • name (str, opcional): Nome do beneficiário do pagamento.
  • artist_name (str, opcional): Nome do artista associado ao pagamento.
  • email (str, opcional): E-mail do beneficiário do pagamento.
  • amount (float, opcional): Valor bruto do pagamento.
  • original_amount (float, opcional): Valor bruto original do pagamento.
  • final_amount (float, opcional): Valor líquido do pagamento.
  • original_final_amount (float, opcional): Valor líquido original do pagamento.
  • ir_percent (float, opcional): Percentual de imposto retido.
  • ir_amount (float, opcional): Valor do imposto retido.
  • currency (str, opcional): Moeda utilizada no pagamento (ex.: BRL, USD, EUR).
  • original_currency (str, opcional): Moeda original do pagamento.
  • exchange_rate (float, opcional): Taxa de câmbio aplicada.
  • final_exchange_rate (float, opcional): Taxa de câmbio final aplicada.
  • show_exchange_data (bool, opcional): Indica se os dados de câmbio devem ser exibidos.
  • status (str, opcional): Status atual do pagamento.
  • paid_manually (bool, opcional): Indica se o pagamento foi realizado manualmente.
  • payment_date (str, opcional): Data de pagamento (formato ISO 8601).
  • attempt_date (str, opcional): Data da tentativa de pagamento (formato ISO 8601).
  • transaction_id (str, opcional): ID da transação associada ao pagamento.
  • error_reason (str, opcional): Motivo do erro, se aplicável.
  • bubble_payment_id (str, opcional): ID do pagamento no sistema Bubble.
  • advance (bool, opcional): Indica se o pagamento é um adiantamento.
  • parent_id (str, opcional): ID do pagamento pai, se aplicável.
  • parent_name (str, opcional): Nome do pagamento pai, se aplicável.
  • original_tax_id (str, opcional): CPF ou CNPJ original do beneficiário, se aplicável.
  • original_name (str, opcional): Nome original do beneficiário, se aplicável.
  • bank_account (SplitBankAccount, opcional): Dados da conta bancária ou chave Pix do beneficiário.
  • products (list[SplitReportProduct], opcional): Lista de produtos associados ao pagamento.
  • platforms (list[SplitReportPlatform], opcional): Lista de plataformas associadas ao pagamento.
  • details (list[SplitReportPaymentDetails], opcional): Detalhes adicionais do pagamento.

Propriedades:

  • safe_ir_amount: Retorna o valor do imposto retido ou 0.0 se não estiver definido.
  • safe_ir_percent: Retorna o percentual de imposto retido ou 0.0 se não estiver definido.
_id
string | null
splitId
string | null
splitBatch
string | null
splitDate
string | null
reportId
string | null
anticipationId
string | null
ownerTaxId
string | null
origin
string | null
taxId
string | null
name
string | null
artistName
string | null
email
string | null
amount
number | null
originalAmount
number | null
finalAmount
number | null
originalFinalAmount
number | null
irPercent
number | null
irAmount
number | null
currency
string | null
originalCurrency
string | null
exchangeRate
number | null
finalExchangeRate
number | null
showExchangeData
boolean | null
status
string | null
paidManually
boolean | null
paymentDate
string | null
attemptDate
string | null
transactionId
string | null
errorReason
string | null
bubblePaymentId
string | null
advance
boolean | null
default:false
parentId
string | null
parentName
string | null
originalTaxId
string | null
originalName
string | null
bankAccount
SplitBankAccount · object | null
products
SplitReportProduct · object[] | null
platforms
SplitReportPlatform · object[] | null
details
SplitReportPaymentDetails · object[] | null