Neofin V1
  1. Listando suas cobranças
Neofin V1
  • Inicie sua jornada na Neofin
  • Preparando seus ambientes
  • Versão 1
    • API de Cobranças
      • Upsert de Cobranças
        • Como realizar o upsert de uma cobrança
        • Upsert de Cobranças
          POST
      • Buscando uma cobrança
        • Como buscar uma única cobrança
        • Buscando pelo Integration Identifier
          GET
        • Buscando pelo Billing Number
          GET
      • Marcando uma cobrança como paga
        • Como marcar uma cobrança como paga
        • Marcando como paga
          PUT
      • Cancelando uma cobrança
        • Como cancelar uma cobrança
        • Cancelando uma cobrança
          PUT
      • Listando suas cobranças
        • Como listar suas cobranças
        • Todas as cobranças
          GET
        • Cobranças por status
          GET
        • Cobranças por cliente
          GET
        • Cobranças por data de atualização
          GET
        • Eventos de cobranças
          GET
        • Eventos de uma uma cobrança por Integration Identifier
          GET
        • Cobranças por data de pagamento
          GET
      • Enviando anexos
        • Como enviar anexos
        • Anexando uma NF a uma cobrança pelo Integration Identifier
          PUT
        • Anexando um Boleto a uma cobrança pelo Integration Identifier
          PUT
    • API de Clientes
      • Upsert de um cliente
        • Como realizar o upsert de um cliente
        • Upsert de clientes
          POST
      • Buscando um cliente
        • Buscando um cliente por Integration Identifier
          GET
        • Buscando um cliente pelo documento
          GET
    • Webhooks
      • Como preparar seus webhooks
    • FAQ
      • Dúvidas frequentes
  1. Listando suas cobranças

Cobranças por data de pagamento

GET
https://api.sandbox.neofin.services/billing/installment/by_payment_date
Last modified:2025-05-19 17:44:49
Retorna pagamentos a partir da data informada. Caso você informe por exemplo a data 2025-01-18 serão listados pagamentos dessa data em diante.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api.sandbox.neofin.services/billing/installment/by_payment_date?start_paid_at_date={{$date.isoTimestamp(representation='\''date'\'')}}&end_paid_at_date={{$date.isoTimestamp(representation='\''date'\'')}}' \
--header 'api-key: ' \
--header 'secret-key: ' \
--header 'Content-Type: application/json'
Response Response Example
200 - Example 1
{
  "installments": [
    {
      "discount_before_payment": 0,
      "fine": 0,
      "original_amount": 0,
      "boleto_pdf": "string",
      "nfe_number": "string",
      "customer_phone": "string",
      "nf_url": "string",
      "renegotiation_in_progress": true,
      "paid_amount": 0,
      "installment_order": "string",
      "customer_document": "string",
      "paid_at": "string",
      "installment_number": "string",
      "integration_identifier": 0,
      "customer_id": "string",
      "biling": {
        "fine": 0,
        "digest": "string",
        "status": "processing",
        "nfe_number": "string",
        "customer_phone": "string",
        "fees": 0,
        "billing_number": "string",
        "created_by_name": "string",
        "customer_document": "string",
        "discount_before_payment": 0,
        "integration_identifier": "string",
        "issued_at": 0,
        "amount": 0,
        "description": "string",
        "discount_before_payment_due_date": 0,
        "customer_name": "string"
      }
    }
  ],
  "next_page_token": "string",
  "count": 0
}

Request

Query Params
start_paid_at_date
string 
optional
ISO 8601 Date em string. Campo obrigatório
Example:
{{$date.isoTimestamp(representation='date')}}
end_paid_at_date
string 
optional
ISO 8601 Date em string. Campo opcional
Example:
{{$date.isoTimestamp(representation='date')}}
Header Params
api-key
string 
required
Neofin API Key
Example:
{{API_KEY}}
secret-key
string 
required
Neofin Secret Key
Example:
{{SECRET_KEY}}
Content-Type
string 
required
Example:
application/json

Responses

🟢200OK
application/json
Body
installments
array[object (InstallmentWithBilling) {16}] 
required
discount_before_payment
number 
optional
fine
number 
optional
original_amount
number 
optional
boleto_pdf
string 
optional
nfe_number
string 
optional
customer_phone
string 
optional
nf_url
string 
optional
renegotiation_in_progress
boolean 
optional
paid_amount
integer 
optional
installment_order
string 
optional
customer_document
string 
optional
paid_at
string 
optional
installment_number
string 
optional
integration_identifier
number 
optional
customer_id
string 
optional
biling
object (BillingInInstallment) 
optional
next_page_token
string  | null 
optional
count
integer 
required
🟠403Invalid API Keys
🔴500Internal Server Error
🟠400Invalid Payment Date
Previous
Eventos de uma uma cobrança por Integration Identifier
Next
Como enviar anexos
Built with