Criar Lote - Mint Starter Kit

Authorizations

Authorization

string

header

required

Body

application/json

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

Atributos:

tax_id (str): CPF ou CNPJ do responsável pelo relatório.
payment_batch_name (str, opcional): Nome do lote de pagamentos associado ao relatório.
report_id (str, opcional): ID do relatório.
amount (float): Valor total do relatório.
currency (str): Moeda utilizada no relatório (ex.: BRL, USD, EUR).
owner_amount (float): Valor pertencente ao proprietário do relatório.
date_start (str): Data de início do período do relatório (formato ISO 8601).
date_end (str): Data de término do período do relatório (formato ISO 8601).
payments (list[SplitReportPaymentRequest]): Lista de pagamentos associados ao relatório.

Validações:

As datas date_start e date_end são convertidas para o formato de string ISO 8601.

taxId

string

required

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

amount

number

required

Valor total do relatório.

dateStart

string

required

Data de início do período do relatório (formato ISO 8601).

dateEnd

string

required

Data de término do período do relatório (formato ISO 8601).

payments

SplitReportPaymentRequest · object[]

required

Lista de pagamentos associados ao relatório.

Show child attributes

payments.taxId

string

required

CPF ou CNPJ do beneficiário do pagamento.

payments.name

string

required

Nome do beneficiário do pagamento.

payments.email

string

required

E-mail do beneficiário do pagamento.

payments.amount

number

required

Valor bruto do pagamento.

payments.finalAmount

number

required

Valor líquido do pagamento.

payments.artistName

string | null

Nome artistico, se aplicável.

payments.percentage

number | null

Percentual de participação do beneficiário no pagamento.

payments.contactId

string | null

ID do contato, se já tiver uma conta cadastrada.

payments.bankAccount

SplitBankAccountRequest · object

Dados da conta bancária ou chave Pix do beneficiário.

Show child attributes

payments.bankAccount.name

string | null

payments.bankAccount.bankCode

string | null

payments.bankAccount.pspId

string | null

payments.bankAccount.agency

string | null

payments.bankAccount.account

string | null

payments.bankAccount.accountType

string | null

payments.bankAccount.pixKeyType

string | null

payments.bankAccount.pixDescription

string | null

payments.bankAccount.pixKey

string | null

payments.anticipationId

string | null

ID da antecipação, se aplicável.

payments.parentId

string | null

ID do pagamento pai, se aplicável.

payments.parentName

string | null

Nome do pagamento pai, se aplicável.

payments.originalTaxId

string | null

CPF ou CNPJ original do beneficiário, se aplicável.

payments.originalName

string | null

Nome original do beneficiário, se aplicável.

payments.advance

boolean | null

default:false

Indica se o pagamento é um adiantamento.

payments.isWithhold

boolean | null

default:false

Indica se o pagamento vai ser criado com status retido.

payments.bubblePaymentId

string | null

ID do pagamento no sistema Bubble, se aplicável.

payments.products

SplitReportProductRequest · object[] | null

Lista de produtos associados ao pagamento.

Show child attributes

payments.products.upc

string

required

Código UPC do produto.

payments.products.name

string

required

Nome do produto.

payments.products.tracks

SplitReportTrackRequest · object[]

required

Lista de faixas associadas ao produto.

Show child attributes

payments.products.tracks.isrc

string

required

Código ISRC da faixa.

payments.products.tracks.name

string

required

Nome da faixa.

payments.products.tracks.plays

integer

required

Número de reproduções da faixa.

payments.products.tracks.revenue

number

required

Receita gerada pela faixa.

payments.products.tracks.percentage

number

required

Percentual de participação da faixa.

payments.products.tracks.finalAmount

number

required

Valor final atribuído à faixa.

payments.products.tracks.period

string | null

payments.platforms

SplitReportPlatformRequest · object[] | null

Lista de plataformas associadas ao pagamento.

Show child attributes

payments.platforms.name

string

required

Nome da plataforma.

payments.platforms.plays

integer

required

Número de reproduções na plataforma.

payments.platforms.revenue

number

required

Receita gerada na plataforma.

payments.platforms.finalAmount

number

required

Valor final atribuído à plataforma.

payments.platforms.period

string | null

payments.details

SplitReportPaymentDetailsRequest · object[] | null

Detalhes adicionais do pagamento.

Show child attributes

payments.details.upc

string

required

Código UPC do produto associado ao pagamento.

payments.details.productName

string

required

Nome do produto associado ao pagamento.

payments.details.isrc

string

required

Código ISRC da faixa associada ao pagamento.

payments.details.trackName

string

required

Nome da faixa associada ao pagamento.

payments.details.royalty

number

required

Valor de royalties gerado pelo pagamento.

payments.details.period

string | null

payments.details.data

SplitReportPaymentDetailsDataRequest · object[] | null

Lista de dados detalhados associados ao pagamento.

Show child attributes

payments.details.data.platform

string

required

Nome da plataforma associada ao pagamento.

payments.details.data.plays

integer

required

Número de reproduções associadas ao pagamento.

payments.details.data.revenue

number

required

Receita gerada pelo pagamento.

payments.details.data.period

string | null

paymentBatchName

string | null

Nome do lote de pagamentos associado ao relatório.

reportId

string | null

ID do relatório.

currency

string

default:BRL

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

ownerAmount

number

default:0

Valor pertencente ao proprietário do relatório.

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.

Referência da API

Authorizations

Body

Response