GET/api/v1/Billing

Cobrança · Cobranças

Método de visualização da lista de cobranças

Lista e filtra registros de api.

Visão geral

Método de visualização da lista de cobranças.

Autenticação e pré-requisitos

Requer autenticação. Envie o token no header Authorization: Bearer {{token}} (JWT do AWS Cognito). Integrações servidor-a-servidor podem usar X-Api-Key. Todo tráfego é HTTPS e a credencial nunca vai na URL nem em query string.

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`Registered`	query	`boolean`	opcional	—	`true`
`Amount`	query	`integer (int64)`	opcional	—	`10`
`DocumentNumber`	query	`string`	opcional	—	`valor`
`BarCode`	query	`string`	opcional	—	`valor`
`SearchString`	query	`string`	opcional	—	`valor`
`Tags`	query	`array de string`	opcional	—	`valor`
`StatusesValue`	query	`array de string`	opcional	—	`valor`
`ExcludeStatusesValue`	query	`array de string`	opcional	—	`valor`
`WalletsCode`	query	`array de integer (int64)`	opcional	—	`valor`
`DocumentsNumber`	query	`array de string`	opcional	—	`valor`
`BankSlipId`	query	`string`	opcional	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`InstallmentId`	query	`string`	opcional	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`CommunicationSettingId`	query	`string`	opcional	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`BillingSettingId`	query	`string`	opcional	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`InitialDueDate`	query	`string (date-time)`	opcional	—	`valor`
`FinalDueDate`	query	`string (date-time)`	opcional	—	`valor`
`InitialSettlementDate`	query	`string (date-time)`	opcional	—	`valor`
`FinalSettlementDate`	query	`string (date-time)`	opcional	—	`valor`
`InitialCreatedDate`	query	`string (date-time)`	opcional	—	`valor`
`FinalCreatedDate`	query	`string (date-time)`	opcional	—	`valor`
`PayerName`	query	`string`	opcional	—	`valor`
`Tenant`	query	`string`	opcional	—	`uy3`
`PayerRegistrationNumber`	query	`string`	opcional	—	`valor`
`FirstInstructionDebtCollection`	query	`string`	opcional	—	`valor`
`OurNumber`	query	`string`	opcional	—	`valor`
`ReferenceId`	query	`string`	opcional	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`IsOrderByDueDate`	query	`boolean`	opcional	—	`true`
`Page`	query	`integer`	opcional	—	`10`
`Size`	query	`integer`	opcional	—	`10`
`BillingIds`	query	`array de string`	opcional	—	`valor`

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`data`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`page`	`integer`	opcional	—	—	`0`
`totalPages`	`integer`	opcional	—	—	`0`
`totalItems`	`integer`	opcional	—	—	`0`
`isCountTruncated`	`boolean`	opcional	—	—	`true`

Detalhe de `data`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string`	opcional	—	—	`"texto"`
`externalId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`walletCode`	`integer (int64)`	opcional	—	—	`0`
`documentNumber`	`string`	opcional	—	—	`"texto"`
`amount`	`integer (int64)`	opcional	—	—	`0`
`paidAmount`	`integer (int64)`	opcional	—	—	`1`
`pendingAmount`	`integer (int64)`	opcional	—	—	`0`
`description`	`string`	opcional	—	—	`"texto"`
`discount`	`integer`	opcional	—	—	`0`
`discountLimitDate`	`string`	opcional	—	—	`"texto"`
`discount2`	`integer`	opcional	—	—	`0`
`discountLimitDate2`	`string`	opcional	—	—	`"texto"`
`discount3`	`integer`	opcional	—	—	`0`
`discountLimitDate3`	`string`	opcional	—	—	`"texto"`
`dueDate`	`string`	opcional	—	—	`"texto"`
`billingSettingId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`billingSettingDisplay`	`string`	opcional	—	—	`"texto"`
`communicationSettingId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`communicationSettingDisplay`	`string`	opcional	—	—	`"texto"`
`tags`	`array de string`	opcional	—	—	`[ … ]`
`creditTypeValue`	`string`	opcional	—	—	`"texto"`
`creditTypeDisplay`	`string`	opcional	—	—	`"texto"`
`payer`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`guarantor`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`registered`	`boolean`	opcional	—	—	`true`
`errorMessage`	`string`	opcional	—	—	`"texto"`
`createdAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`settlementAt`	`string`	opcional	—	—	`"texto"`
`settlementChannelValue`	`string`	opcional	—	—	`"texto"`
`settlementChannelValueDisplay`	`string`	opcional	—	—	`"texto"`
`statusValue`	`string`	opcional	—	—	`"texto"`
`statusDisplay`	`string`	opcional	—	—	`"texto"`
`firstInstructionDebtCollection`	`string`	opcional	—	—	`"texto"`
`secondInstructionDebtCollection`	`integer`	opcional	—	—	`0`
`installmentId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`bankSlip`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`settings`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`ourNumber`	`integer (int64)`	opcional	—	—	`0`
`ourNumberDigit`	`string`	opcional	—	—	`"texto"`
`walletNumber`	`integer`	opcional	—	—	`0`
`numberPayments`	`integer`	opcional	—	—	`0`
`deduction`	`integer`	opcional	—	—	`0`
`latePaymentInterestAmountPerDay`	`integer`	opcional	—	—	`0`
`conditionForIssuingBillingSlip`	`string`	opcional	—	—	`"texto"`
`zero`	`string`	opcional	—	—	`"texto"`
`directDebitAgency`	`string`	opcional	—	—	`"texto"`
`directDebitAgencyDigit`	`string`	opcional	—	—	`"texto"`
`directDebitAccount`	`string`	opcional	—	—	`"texto"`
`directDebitAccountDigit`	`string`	opcional	—	—	`"texto"`
`directDebitReason`	`string`	opcional	—	—	`"texto"`
`bonusDiscountDay`	`string`	opcional	—	—	`"texto"`
`addressingAutomaticDebitNotification`	`string`	opcional	—	—	`"texto"`
`identificationBillingSlipIssuance`	`string`	opcional	—	—	`"texto"`
`acceptanceIdentification`	`string`	opcional	—	—	`"01310930"`
`depositoryAgency`	`string`	opcional	—	—	`"texto"`
`billingBankCharge`	`string`	opcional	—	—	`"texto"`
`bankCode`	`string`	opcional	—	—	`"texto"`
`iof`	`string`	opcional	—	—	`"texto"`
`bankingOperationIdentification`	`string`	opcional	—	—	`"texto"`
`creditDistributionIdentification`	`string`	opcional	—	—	`"texto"`
`participantControlNumber`	`string`	opcional	—	—	`"texto"`
`generateInstructionTransactionLine`	`boolean`	opcional	—	—	`true`
`captureType`	`string`	opcional	—	—	`"texto"`
`captureTypeDisplay`	`string`	opcional	—	—	`"texto"`
`paymentMethod`	`string`	opcional	—	—	`"texto"`
`paymentMethodDisplay`	`string`	opcional	—	—	`"texto"`
`billingCreateType`	`string`	opcional	—	—	`"texto"`
`billingCreateTypeDisplay`	`string`	opcional	—	—	`"texto"`
`lastPaymentDate`	`string`	opcional	—	—	`"texto"`
`payments`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`fileInstructionLines`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`fileConfirmationLines`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`isAnticipatedBilling`	`boolean`	opcional	—	—	`true`

Detalhe de `payments`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`settlementChannelValue`	`string`	opcional	—	—	`"texto"`
`settlementChannelValueDisplay`	`string`	opcional	—	—	`"texto"`
`paymentDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`paymentAmount`	`integer (int64)`	opcional	—	—	`0`
`paymentISPB`	`integer`	opcional	—	—	`0`
`paymentAgency`	`integer`	opcional	—	—	`0`
`debtCollectionProtocol`	`string`	opcional	—	—	`"texto"`

Detalhe de `fileInstructionLines`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string`	opcional	—	—	`"texto"`
`walletCode`	`integer (int64)`	opcional	—	—	`0`
`lineType`	`string`	opcional	—	—	`"texto"`
`lineTypeDisplay`	`string`	opcional	—	—	`"texto"`
`sequentialNumber`	`integer`	opcional	—	—	`0`
`detail`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`

Detalhe de `fileConfirmationLines`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string`	opcional	—	—	`"texto"`
`lineType`	`string`	opcional	—	—	`"texto"`
`lineTypeDisplay`	`string`	opcional	—	—	`"texto"`
`sequentialNumber`	`integer`	opcional	—	—	`0`
`detail`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`

Exemplo de resposta

{
  "data": [
    {
      "id": "texto",
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "walletCode": 0,
      "documentNumber": "texto",
      "amount": 0,
      "paidAmount": 1,
      "pendingAmount": 0,
      "description": "texto",
      "discount": 0,
      "discountLimitDate": "texto",
      "discount2": 0,
      "discountLimitDate2": "texto",
      "discount3": 0,
      "discountLimitDate3": "texto",
      "dueDate": "texto",
      "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "billingSettingDisplay": "texto",
      "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "communicationSettingDisplay": "texto",
      "tags": [
        "texto"
      ],
      "creditTypeValue": "texto",
      "creditTypeDisplay": "texto",
      "payer": {
        "name": "Fulano de Tal",
        "personTypeValue": "texto",
        "personTypeValueDisplay": "texto",
        "registrationNumber": "12345678909",
        "zipCode": "01310930",
        "addressName": "Fulano de Tal",
        "addressNumber": "texto",
        "addressComplement": "texto",
        "email": "cliente@exemplo.com.br"
      },
      "guarantor": {
        "name": "Fulano de Tal",
        "registrationNumber": "12345678909"
      },
      "registered": true,
      "errorMessage": "texto",
      "createdAt": "2025-08-11T13:45:00Z",
      "settlementAt": "texto",
      "settlementChannelValue": "texto",
      "settlementChannelValueDisplay": "texto",
      "statusValue": "texto",
      "statusDisplay": "texto",
      "firstInstructionDebtCollection": "texto",
      "secondInstructionDebtCollection": 0,
      "installmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "bankSlip": {
        "id": "texto",
        "barCode": "texto",
        "statusRegisterValue": "texto",
        "statusRegisterValueDisplay": "texto",
        "statusSettlementValue": "texto",
        "statusSettlementValueDisplay": "texto",
        "statusDebtCollectionValue": "texto",
        "statusDebtCollectionValueDisplay": "texto"
      },
      "settings": {
        "interestTypeValue": "texto",
        "interestTypeValueDisplay": "texto",
        "interestAmount": 1000,
        "fineTypeValue": "texto",
        "fineTypeValueDisplay": "texto",
        "fineAmount": 1000
      },
      "ourNumber": 0,
      "ourNumberDigit": "texto",
      "walletNumber": 0,
      "numberPayments": 0,
      "deduction": 0,
      "latePaymentInterestAmountPerDay": 0,
      "conditionForIssuingBillingSlip": "texto",
      "zero": "texto",
      "directDebitAgency": "texto",
      "directDebitAgencyDigit": "texto",
      "directDebitAccount": "texto",
      "directDebitAccountDigit": "texto",
      "directDebitReason": "texto",
      "bonusDiscountDay": "texto",
      "addressingAutomaticDebitNotification": "texto",
      "identificationBillingSlipIssuance": "texto",
      "acceptanceIdentification": "01310930",
      "depositoryAgency": "texto",
      "billingBankCharge": "texto",
      "bankCode": "texto",
      "iof": "texto",
      "bankingOperationIdentification": "texto",
      "creditDistributionIdentification": "texto",
      "participantControlNumber": "texto",
      "generateInstructionTransactionLine": true,
      "captureType": "texto",
      "captureTypeDisplay": "texto",
      "paymentMethod": "texto",
      "paymentMethodDisplay": "texto",
      "billingCreateType": "texto",
      "billingCreateTypeDisplay": "texto",
      "lastPaymentDate": "texto",
      "payments": [
        {}
      ],
      "fileInstructionLines": [
        {}
      ],
      "fileConfirmationLines": [
        {}
      ],
      "isAnticipatedBilling": true
    }
  ],
  "page": 0,
  "totalPages": 0,
  "totalItems": 0,
  "isCountTruncated": true
}

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	—
`401`	Não autenticado — token ausente, inválido ou expirado.	—

Exemplos

curl -X GET "{{baseUrl}}/api/v1/Billing" \
  -H "Authorization: Bearer {{token}}"

var baseUrl = "{{baseUrl}}";
var token   = "{{token}}";

using var http = new HttpClient { BaseAddress = new Uri(baseUrl) };
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", token);

var rota = "/api/v1/Billing";

var resp = await http.GetAsync(rota);
resp.EnsureSuccessStatusCode();
var json = await resp.Content.ReadAsStringAsync();

const baseUrl = '{{baseUrl}}';
const token   = '{{token}}';

const resp = await fetch(`${baseUrl}/api/v1/Billing`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
const data = await resp.json();

Troque apenas {{baseUrl}} e {{token}}. No Postman, defina-os como variáveis de environment; o cURL importa em Import > Raw text.

Downloads

Este endpoint já vem configurado nas collections abaixo, na pasta da etapa correspondente.

Collection completaConsignado privado e FGTS, em pastas espelhando a documentação.Baixar →Environment do PostmanAs variáveis fora da collection, para versionar uma sem versionar o token.Baixar →Documentação consolidada para LLMToda a documentação em um arquivo de texto, na ordem da navegação.Baixar →Referência em MarkdownEste contrato, campo a campo, gerado do spec.Baixar →

Guia de importação: Como importar no Postman · Todos os downloads: Downloads