GET Cobrancas

Retorna as cobranças de um cliente em especifico dentro do periodo filtrado.
Os campos aceitos no corpo da requisição são: (id_cliente ou cpf)*, data_inicial*, data_final*, filtrar_por.
O parametro filtrar_por aceita baixa, pagamento ou vencimento. se um valor diferente for passado, filtra-ra por data de emissao Exemplo: https://api.serodonto.com.br/cobrancas?id_cliente=1&data_inicial=2024-01-01&data_final=2024-01-31&filtrar_por=baixa
Exemplo: https://api.serodonto.com.br/cobrancas?cpf=000.000.006-04&data_inicial=2024-01-01&data_final=2024-01-31&filtrar_por=baixa
* Campos obrigatórios.

Informações da Requisição

Parâmetros URI

Nenhuma.

Parâmetros do Corpo

Nenhum.

Informações da Resposta

Descrição do Recurso

Collection of Cobranca_Cliente
NomeDescriçãoTipoInformações adicionais
nome_cliente

string

Nenhuma.
cpf

string

Nenhuma.
identificador_cliente

globally unique identifier

Nenhuma.
id_cliente

integer

Nenhuma.
numero_documento

string

Nenhuma.
data_emissao

date

Nenhuma.
numero_parcela

integer

Nenhuma.
data_vencimento

date

Nenhuma.
valor_original

decimal number

Nenhuma.
saldo

decimal number

Nenhuma.
data_pagamento

date

Nenhuma.
data_transacao

date

Nenhuma.
valor_pago

decimal number

Nenhuma.
taxa

decimal number

Nenhuma.
valor_liquido

decimal number

Nenhuma.
desconto

decimal number

Nenhuma.
juros

decimal number

Nenhuma.
multa

decimal number

Nenhuma.
forma_pagamento

string

Nenhuma.
documento_cartao

string

Nenhuma.
autorizacao_cartao

string

Nenhuma.

Formatos da Resposta

application/json, text/json

Sample: 
[
  {
    "nome_cliente": "sample string 1",
    "cpf": "sample string 2",
    "identificador_cliente": "f175b2e6-fff0-4153-be62-92979e6da5ce",
    "id_cliente": 1,
    "numero_documento": "sample string 3",
    "data_emissao": "2025-05-11T14:14:54.7389552-03:00",
    "numero_parcela": 1,
    "data_vencimento": "2025-05-11T14:14:54.7399545-03:00",
    "valor_original": 1.0,
    "saldo": 1.0,
    "data_pagamento": "2025-05-11T14:14:54.7399545-03:00",
    "data_transacao": "2025-05-11T14:14:54.7399545-03:00",
    "valor_pago": 1.0,
    "taxa": 1.0,
    "valor_liquido": 1.0,
    "desconto": 1.0,
    "juros": 1.0,
    "multa": 1.0,
    "forma_pagamento": "sample string 5",
    "documento_cartao": "sample string 6",
    "autorizacao_cartao": "sample string 7",
    "identificador_guia": "5164a6a1-5b08-47ae-823d-86661b0a6752"
  },
  {
    "nome_cliente": "sample string 1",
    "cpf": "sample string 2",
    "identificador_cliente": "f175b2e6-fff0-4153-be62-92979e6da5ce",
    "id_cliente": 1,
    "numero_documento": "sample string 3",
    "data_emissao": "2025-05-11T14:14:54.7389552-03:00",
    "numero_parcela": 1,
    "data_vencimento": "2025-05-11T14:14:54.7399545-03:00",
    "valor_original": 1.0,
    "saldo": 1.0,
    "data_pagamento": "2025-05-11T14:14:54.7399545-03:00",
    "data_transacao": "2025-05-11T14:14:54.7399545-03:00",
    "valor_pago": 1.0,
    "taxa": 1.0,
    "valor_liquido": 1.0,
    "desconto": 1.0,
    "juros": 1.0,
    "multa": 1.0,
    "forma_pagamento": "sample string 5",
    "documento_cartao": "sample string 6",
    "autorizacao_cartao": "sample string 7",
    "identificador_guia": "5164a6a1-5b08-47ae-823d-86661b0a6752"
  }
]

text/html

Sample: 
[{"nome_cliente":"sample string 1","cpf":"sample string 2","identificador_cliente":"f175b2e6-fff0-4153-be62-92979e6da5ce","id_cliente":1,"numero_documento":"sample string 3","data_emissao":"2025-05-11T14:14:54.7389552-03:00","numero_parcela":1,"data_vencimento":"2025-05-11T14:14:54.7399545-03:00","valor_original":1.0,"saldo":1.0,"data_pagamento":"2025-05-11T14:14:54.7399545-03:00","data_transacao":"2025-05-11T14:14:54.7399545-03:00","valor_pago":1.0,"taxa":1.0,"valor_liquido":1.0,"desconto":1.0,"juros":1.0,"multa":1.0,"forma_pagamento":"sample string 5","documento_cartao":"sample string 6","autorizacao_cartao":"sample string 7","identificador_guia":"5164a6a1-5b08-47ae-823d-86661b0a6752"},{"nome_cliente":"sample string 1","cpf":"sample string 2","identificador_cliente":"f175b2e6-fff0-4153-be62-92979e6da5ce","id_cliente":1,"numero_documento":"sample string 3","data_emissao":"2025-05-11T14:14:54.7389552-03:00","numero_parcela":1,"data_vencimento":"2025-05-11T14:14:54.7399545-03:00","valor_original":1.0,"saldo":1.0,"data_pagamento":"2025-05-11T14:14:54.7399545-03:00","data_transacao":"2025-05-11T14:14:54.7399545-03:00","valor_pago":1.0,"taxa":1.0,"valor_liquido":1.0,"desconto":1.0,"juros":1.0,"multa":1.0,"forma_pagamento":"sample string 5","documento_cartao":"sample string 6","autorizacao_cartao":"sample string 7","identificador_guia":"5164a6a1-5b08-47ae-823d-86661b0a6752"}]

application/xml, text/xml

Sample: 
<ArrayOfCobrancasController.Cobranca_Cliente xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SerodontoREST.Controllers">
  <CobrancasController.Cobranca_Cliente>
    <autorizacao_cartao>sample string 7</autorizacao_cartao>
    <data_emissao>2025-05-11T14:14:54.7389552-03:00</data_emissao>
    <data_pagamento>2025-05-11T14:14:54.7399545-03:00</data_pagamento>
    <data_transacao>2025-05-11T14:14:54.7399545-03:00</data_transacao>
    <data_vencimento>2025-05-11T14:14:54.7399545-03:00</data_vencimento>
    <desconto>1</desconto>
    <documento_cartao>sample string 6</documento_cartao>
    <forma_pagamento>sample string 5</forma_pagamento>
    <id_cliente>1</id_cliente>
    <identificador_cliente>f175b2e6-fff0-4153-be62-92979e6da5ce</identificador_cliente>
    <identificador_guia>5164a6a1-5b08-47ae-823d-86661b0a6752</identificador_guia>
    <juros>1</juros>
    <multa>1</multa>
    <numero_documento>sample string 3</numero_documento>
    <numero_parcela>1</numero_parcela>
    <saldo>1</saldo>
    <taxa>1</taxa>
    <valor_liquido>1</valor_liquido>
    <valor_original>1</valor_original>
    <valor_pago>1</valor_pago>
    <cpf>sample string 2</cpf>
    <nome_cliente>sample string 1</nome_cliente>
  </CobrancasController.Cobranca_Cliente>
  <CobrancasController.Cobranca_Cliente>
    <autorizacao_cartao>sample string 7</autorizacao_cartao>
    <data_emissao>2025-05-11T14:14:54.7389552-03:00</data_emissao>
    <data_pagamento>2025-05-11T14:14:54.7399545-03:00</data_pagamento>
    <data_transacao>2025-05-11T14:14:54.7399545-03:00</data_transacao>
    <data_vencimento>2025-05-11T14:14:54.7399545-03:00</data_vencimento>
    <desconto>1</desconto>
    <documento_cartao>sample string 6</documento_cartao>
    <forma_pagamento>sample string 5</forma_pagamento>
    <id_cliente>1</id_cliente>
    <identificador_cliente>f175b2e6-fff0-4153-be62-92979e6da5ce</identificador_cliente>
    <identificador_guia>5164a6a1-5b08-47ae-823d-86661b0a6752</identificador_guia>
    <juros>1</juros>
    <multa>1</multa>
    <numero_documento>sample string 3</numero_documento>
    <numero_parcela>1</numero_parcela>
    <saldo>1</saldo>
    <taxa>1</taxa>
    <valor_liquido>1</valor_liquido>
    <valor_original>1</valor_original>
    <valor_pago>1</valor_pago>
    <cpf>sample string 2</cpf>
    <nome_cliente>sample string 1</nome_cliente>
  </CobrancasController.Cobranca_Cliente>
</ArrayOfCobrancasController.Cobranca_Cliente>