Listar Boleto por Data de Crédito

GET/api/billissuer/list/by/credit-date?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}&statusIntegration={statusIntegration}

Este endpoint é utilizado para listar boletos com base na data em que o crédito foi efetivado. Ele retorna uma lista detalhada com informações relevantes dos boletos, como valor, status e dados do pagador.

O método recebe um período inicial e um período final para a data de crédito, retornando os boletos cuja data de crédito está no intervalo especificado.

Dicionário de dados - Parâmetros

Exemplo de requisição

curl --request GET \
  --url 'https://integration.enoqbank.com/enoq/api/billissuer/list/by/credit-date?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}&statusIntegration={statusIntegration}' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json'

Retorno (200)

Exemplo de resposta

[
  {
    "Id": "GUID",
    "Value": "decimal",
    "IssueDate": "DateTime",
    "DueDate": "DateTime",
    "PayerDocument": "string",
    "PayerName": "string",
    "PayerStreetAndNumber": "string",
    "PayerZipCode": "string",
    "PayerCity": "string",
    "PayerCityState": "string",
    "PayerNeighborhood": "string",
    "PayerPhoneNumber": "string",
    "EffectivePaymentDate": "DateTime",
    "EffectiveCreditDate": "DateTime",
    "EffectivePaymentValue": "decimal",
    "BarCode": "string",
    "OurNumber": "string",
    "DigitableLine": "string",
    "PixEmv": "string",
    "OverduePaymentAllow": "boolean",
    "OverduePaymentDateLimit": "DateTime",
    "OverduePaymentPenalty": "decimal",
    "OverduePenaltyReceived": "decimal",
    "OverduePaymentInterest": "decimal",
    "OverdueInterestReceived": "decimal",
    "CancelDate": "DateTime",
    "CancellationReason": "string",
    "StatusBill": "int",
    "ReferenceCode": "string"
  }
]

Dicionário de dados

Erros

As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.

Observado em homologação

Requisição sem o header Authorization. A camada de autenticação pode rejeitar a chamada antes de resolver a rota ou validar os dados.

HTTP/1.1 401 Unauthorized

A resposta não possui corpo. Não há campos JSON para interpretar neste cenário.