Skip to main content
GET
/
split
Listar Lotes
curl --request GET \
  --url https://production.api.noodle.cx/external/split \
  --header 'Authorization: <api-key>'
[
  {
    "_id": "<string>",
    "paymentBatchName": "<string>",
    "splitDate": "<string>",
    "fee": 123,
    "feeAmount": 123,
    "feePaid": true,
    "taxId": "<string>",
    "batchId": "<string>",
    "reportId": "<string>",
    "bubbleId": "<string>",
    "status": "<string>",
    "logo": "<string>",
    "origin": "<string>",
    "currency": "<string>",
    "exchangeOrderId": "<string>",
    "pixQrCodeId": "<string>",
    "pixQrCodePayload": "<string>",
    "exchangeRate": 123,
    "showExchangeData": true,
    "date": "<string>",
    "pendingPayments": 123,
    "withholdPayments": 123,
    "donePayments": 123,
    "pendingAmount": 123,
    "withholdAmount": 123,
    "irAmount": 123,
    "paidAmount": 123,
    "totalAmount": 123
  }
]

Authorizations

​
Authorization
string
header
required

Query Parameters

​
status
enum<string> | null

Filtra os lotes por status.

Available options:
PENDING,
DONE,
ERROR,
EXCLUDED,
PROCESSING,
CLOSED

Response

Successful Response

​
_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.