> ## Documentation Index > Fetch the complete documentation index at: https://developer.noodle.cx/llms.txt > Use this file to discover all available pages before exploring further. # Criar Lote > Use este endpoint para criar um novo lote que será enviado para pagamento via app ou pelo endpoint de pagamento. ## OpenAPI ````yaml api-reference/openapi.json post /split openapi: 3.1.0 info: title: Noodle API contact: name: Time de Engenharia da Noodle url: https://www.noodle.cx/contato email: dev@noodle.cx version: 1.0.0 servers: - url: https://production.api.noodle.cx/external description: Servidor de Produção - url: https://homolog.api.noodle.cx/external description: Servidor de Homologação (Staging) security: [] paths: /split: post: tags: - Lotes summary: Criar Lote description: >- Use este endpoint para criar um novo lote que será enviado para pagamento via app ou pelo endpoint de pagamento. operationId: add_split_split_post requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SplitReportRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Split' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] components: schemas: SplitReportRequest: properties: taxId: type: string title: Taxid description: CPF ou CNPJ do responsável pelo relatório. paymentBatchName: anyOf: - type: string - type: 'null' title: Paymentbatchname description: Nome do lote de pagamentos associado ao relatório. reportId: anyOf: - type: string - type: 'null' title: Reportid description: ID do relatório. amount: type: number title: Amount description: Valor total do relatório. currency: type: string title: Currency description: 'Moeda utilizada no relatório (ex.: BRL, USD, EUR).' default: BRL ownerAmount: type: number title: Owneramount description: Valor pertencente ao proprietário do relatório. default: 0 dateStart: type: string title: Datestart description: Data de início do período do relatório (formato ISO 8601). dateEnd: type: string title: Dateend description: Data de término do período do relatório (formato ISO 8601). payments: items: $ref: '#/components/schemas/SplitReportPaymentRequest' type: array title: Payments description: Lista de pagamentos associados ao relatório. type: object required: - taxId - amount - dateStart - dateEnd - payments title: SplitReportRequest description: >- 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. Split: properties: _id: anyOf: - type: string - type: 'null' title: ' Id' description: ID do relatório de divisão. paymentBatchName: anyOf: - type: string - type: 'null' title: Paymentbatchname description: Nome do lote de pagamentos associado ao relatório. splitDate: anyOf: - type: string - type: 'null' title: Splitdate description: Data de criação do relatório de divisão (formato ISO 8601). fee: anyOf: - type: number - type: 'null' title: Fee description: Taxa aplicada ao relatório. feeAmount: anyOf: - type: number - type: 'null' title: Feeamount description: Valor da taxa aplicada. feePaid: anyOf: - type: boolean - type: 'null' title: Feepaid description: Indica se a taxa foi paga. taxId: anyOf: - type: string - type: 'null' title: Taxid description: CPF ou CNPJ do responsável pelo relatório. batchId: anyOf: - type: string - type: 'null' title: Batchid description: ID do lote associado ao relatório. reportId: anyOf: - type: string - type: 'null' title: Reportid description: ID do relatório associado. bubbleId: anyOf: - type: string - type: 'null' title: Bubbleid description: ID do relatório no sistema Bubble. status: anyOf: - type: string - type: 'null' title: Status description: Status atual do relatório de divisão. logo: anyOf: - type: string - type: 'null' title: Logo description: URL do logo associado ao relatório. origin: anyOf: - type: string - type: 'null' title: Origin description: Origem do relatório. currency: anyOf: - type: string - type: 'null' title: Currency description: 'Moeda utilizada no relatório (ex.: BRL, USD, EUR).' exchangeOrderId: anyOf: - type: string - type: 'null' title: Exchangeorderid description: ID da ordem de câmbio associada. pixQrCodeId: anyOf: - type: string - type: 'null' title: Pixqrcodeid description: ID do QR Code Pix associado. pixQrCodePayload: anyOf: - type: string - type: 'null' title: Pixqrcodepayload description: Payload do QR Code Pix associado. exchangeRate: anyOf: - type: number - type: 'null' title: Exchangerate description: Taxa de câmbio aplicada. showExchangeData: anyOf: - type: boolean - type: 'null' title: Showexchangedata description: Indica se os dados de câmbio devem ser exibidos. date: anyOf: - type: string - type: 'null' title: Date description: Data do relatório (formato ISO 8601). pendingPayments: anyOf: - type: integer - type: 'null' title: Pendingpayments description: Número de pagamentos pendentes. withholdPayments: anyOf: - type: integer - type: 'null' title: Withholdpayments description: Número de pagamentos retidos. donePayments: anyOf: - type: integer - type: 'null' title: Donepayments description: Número de pagamentos concluídos. pendingAmount: anyOf: - type: number - type: 'null' title: Pendingamount description: Valor total pendente. withholdAmount: anyOf: - type: number - type: 'null' title: Withholdamount description: Valor total retido. irAmount: anyOf: - type: number - type: 'null' title: Iramount description: Valor total de imposto retido. paidAmount: anyOf: - type: number - type: 'null' title: Paidamount description: Valor total pago. totalAmount: anyOf: - type: number - type: 'null' title: Totalamount description: Valor total do relatório. type: object title: Split description: >- 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. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError SplitReportPaymentRequest: properties: taxId: type: string title: Taxid description: CPF ou CNPJ do beneficiário do pagamento. name: type: string title: Name description: Nome do beneficiário do pagamento. email: type: string title: Email description: E-mail do beneficiário do pagamento. artistName: anyOf: - type: string - type: 'null' title: Artistname description: Nome artistico, se aplicável. amount: type: number title: Amount description: Valor bruto do pagamento. finalAmount: type: number title: Finalamount description: Valor líquido do pagamento. percentage: anyOf: - type: number - type: 'null' title: Percentage description: Percentual de participação do beneficiário no pagamento. contactId: anyOf: - type: string - type: 'null' title: Contactid description: ID do contato, se já tiver uma conta cadastrada. bankAccount: anyOf: - $ref: '#/components/schemas/SplitBankAccountRequest' - type: 'null' description: Dados da conta bancária ou chave Pix do beneficiário. anticipationId: anyOf: - type: string - type: 'null' title: Anticipationid description: ID da antecipação, se aplicável. parentId: anyOf: - type: string - type: 'null' title: Parentid description: ID do pagamento pai, se aplicável. parentName: anyOf: - type: string - type: 'null' title: Parentname description: Nome do pagamento pai, se aplicável. originalTaxId: anyOf: - type: string - type: 'null' title: Originaltaxid description: CPF ou CNPJ original do beneficiário, se aplicável. originalName: anyOf: - type: string - type: 'null' title: Originalname description: Nome original do beneficiário, se aplicável. advance: anyOf: - type: boolean - type: 'null' title: Advance description: Indica se o pagamento é um adiantamento. default: false isWithhold: anyOf: - type: boolean - type: 'null' title: Iswithhold description: Indica se o pagamento vai ser criado com status retido. default: false bubblePaymentId: anyOf: - type: string - type: 'null' title: Bubblepaymentid description: ID do pagamento no sistema Bubble, se aplicável. products: anyOf: - items: $ref: '#/components/schemas/SplitReportProductRequest' type: array - type: 'null' title: Products description: Lista de produtos associados ao pagamento. default: [] platforms: anyOf: - items: $ref: '#/components/schemas/SplitReportPlatformRequest' type: array - type: 'null' title: Platforms description: Lista de plataformas associadas ao pagamento. default: [] details: anyOf: - items: $ref: '#/components/schemas/SplitReportPaymentDetailsRequest' type: array - type: 'null' title: Details description: Detalhes adicionais do pagamento. default: [] type: object required: - taxId - name - email - amount - finalAmount title: SplitReportPaymentRequest description: >- Representa os dados de um pagamento em um relatório de divisão. **Atributos**: - **tax_id** (*str*): CPF ou CNPJ do beneficiário do pagamento. - **name** (*str*): Nome do beneficiário do pagamento. - **email** (*str*): E-mail do beneficiário do pagamento. - **amount** (*float*): Valor bruto do pagamento. - **final_amount** (*float*): Valor líquido do pagamento. - **bank_account** (*SplitBankAccountRequest*): Dados da conta bancária ou chave Pix do beneficiário. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError SplitBankAccountRequest: properties: name: anyOf: - type: string - type: 'null' title: Name bankCode: anyOf: - type: string - type: 'null' title: Bankcode pspId: anyOf: - type: string - type: 'null' title: Pspid agency: anyOf: - type: string - type: 'null' title: Agency account: anyOf: - type: string - type: 'null' title: Account accountType: anyOf: - type: string - type: 'null' title: Accounttype pixKeyType: anyOf: - type: string - type: 'null' title: Pixkeytype pixDescription: anyOf: - type: string - type: 'null' title: Pixdescription pixKey: anyOf: - type: string - type: 'null' title: Pixkey type: object title: SplitBankAccountRequest description: >- Representa os dados de uma conta bancária ou chave Pix para pagamentos. **Atributos**: - **name** (*str, opcional*): Nome do titular da conta. - **bank_code** (*str, opcional*): Código do banco. - **psp_id** (*str, opcional*): Identificador do provedor de serviços de pagamento (PSP). - **agency** (*str, opcional*): Número da agência bancária. - **account** (*str, opcional*): Número da conta bancária. - **account_type** (*str, opcional*): Tipo da conta bancária, deve ser um dos valores: "saving_account", "payment_account", "checking_account" ou "salary_account". - **pix_key_type** (*str, opcional*): Tipo da chave Pix, deve ser um dos valores: "random_key", "cnpj", "cpf", "phone_number" ou "email". - **pix_description** (*str, opcional*): Descrição da chave Pix. - **pix_key** (*str, opcional*): Chave Pix associada à conta. **Validações**: - Pelo menos um dos campos `pix_key` ou `account` deve ser informado. - Se `pix_key` for informado, o campo `pix_key_type` é obrigatório. - Para contas bancárias, os campos `agency`, `psp_id`, `account_type`, `name` e `bank_code` são obrigatórios. SplitReportProductRequest: properties: upc: type: string title: Upc description: Código UPC do produto. name: type: string title: Name description: Nome do produto. tracks: items: $ref: '#/components/schemas/SplitReportTrackRequest' type: array title: Tracks description: Lista de faixas associadas ao produto. type: object required: - upc - name - tracks title: SplitReportProductRequest description: >- Representa os dados de um produto em um relatório de divisão. **Atributos**: - **upc** (*str*): Código UPC do produto. - **name** (*str*): Nome do produto. - **tracks** (*list[SplitReportTrackRequest]*): Lista de faixas associadas ao produto. SplitReportPlatformRequest: properties: name: type: string title: Name description: Nome da plataforma. plays: type: integer title: Plays description: Número de reproduções na plataforma. period: anyOf: - type: string - type: 'null' title: Period revenue: type: number title: Revenue description: Receita gerada na plataforma. finalAmount: type: number title: Finalamount description: Valor final atribuído à plataforma. type: object required: - name - plays - revenue - finalAmount title: SplitReportPlatformRequest description: |- Representa os dados de uma plataforma em um relatório de divisão. **Atributos**: - **name** (*str*): Nome da plataforma. - **plays** (*int*): Número de reproduções na plataforma. - **revenue** (*float*): Receita gerada na plataforma. - **final_amount** (*float*): Valor final atribuído à plataforma. SplitReportPaymentDetailsRequest: properties: upc: type: string title: Upc description: Código UPC do produto associado ao pagamento. productName: type: string title: Productname description: Nome do produto associado ao pagamento. isrc: type: string title: Isrc description: Código ISRC da faixa associada ao pagamento. period: anyOf: - type: string - type: 'null' title: Period trackName: type: string title: Trackname description: Nome da faixa associada ao pagamento. royalty: type: number title: Royalty description: Valor de royalties gerado pelo pagamento. data: anyOf: - items: $ref: '#/components/schemas/SplitReportPaymentDetailsDataRequest' type: array - type: 'null' title: Data description: Lista de dados detalhados associados ao pagamento. default: [] type: object required: - upc - productName - isrc - trackName - royalty title: SplitReportPaymentDetailsRequest description: >- Representa os detalhes de um pagamento em um relatório de divisão. **Atributos**: - **upc** (*str*): Código UPC do produto associado ao pagamento. - **product_name** (*str*): Nome do produto associado ao pagamento. - **isrc** (*str*): Código ISRC da faixa associada ao pagamento. - **track_name** (*str*): Nome da faixa associada ao pagamento. - **royalty** (*float*): Valor de royalties gerado pelo pagamento. - **data** (*list[SplitReportPaymentDetailsDataRequest], opcional*): Lista de dados detalhados associados ao pagamento. SplitReportTrackRequest: properties: isrc: type: string title: Isrc description: Código ISRC da faixa. name: type: string title: Name description: Nome da faixa. plays: type: integer title: Plays description: Número de reproduções da faixa. period: anyOf: - type: string - type: 'null' title: Period revenue: type: number title: Revenue description: Receita gerada pela faixa. percentage: type: number title: Percentage description: Percentual de participação da faixa. finalAmount: type: number title: Finalamount description: Valor final atribuído à faixa. type: object required: - isrc - name - plays - revenue - percentage - finalAmount title: SplitReportTrackRequest description: |- Representa os dados de uma faixa em um relatório de divisão. **Atributos**: - **isrc** (*str*): Código ISRC da faixa. - **name** (*str*): Nome da faixa. - **plays** (*int*): Número de reproduções da faixa. - **revenue** (*float*): Receita gerada pela faixa. - **percentage** (*float*): Percentual de participação da faixa. - **final_amount** (*float*): Valor final atribuído à faixa. SplitReportPaymentDetailsDataRequest: properties: platform: type: string title: Platform description: Nome da plataforma associada ao pagamento. plays: type: integer title: Plays description: Número de reproduções associadas ao pagamento. period: anyOf: - type: string - type: 'null' title: Period revenue: type: number title: Revenue description: Receita gerada pelo pagamento. type: object required: - platform - plays - revenue title: SplitReportPaymentDetailsDataRequest description: >- Representa os dados detalhados de um pagamento em um relatório de divisão. **Atributos**: - **platform** (*str*): Nome da plataforma associada ao pagamento. - **country** (*str*): País associado ao pagamento. - **type** (*str*): Tipo de pagamento. - **plays** (*int*): Número de reproduções associadas ao pagamento. - **revenue** (*float*): Receita gerada pelo pagamento. securitySchemes: APIKeyHeader: type: apiKey in: header name: Authorization ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.