v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB

CobrancaCarne

Consulta Cobrança do tipo carnê

Esta API permite realizar consulta dos carnês através do Id.

Campo	Tipo	Descrição	Obrigatório
CarneId	GUID	ID do carnê já cadastrado	Sim

Campo	Tipo	Descrição
CarneId	GUID	Identificador único do carnê gerado
Estado	Texto	Estado que o carnê se encontra
ImgBase64	Texto	Base64 do PDF completo do carnê
Parcelas	CarneParcelas	Lista com o detalhamento de cada parcela
CobrancaId	GUID	Identificador único da Cobrança gerada
Estado	Texto	Estado da cobrança
Valor	Numérico	Valor da parcela
Vencimento	Data	Data de vencimento da parcela
NossoNumero	Texto	Nosso Número do boleto gerado
LinhaDigitavel	Texto	Linha digitável do boleto gerado
CodigoBarras	Texto	Código de Barras do boleto gerado
QRCodeTexto	Texto	Copia e cola do pix (se for gerado como Boleto Híbrido)
QRCodeImagem	Texto	Imagem do QRCode do pix (se for gerado como Boleto Híbrido)

get/api/CobrancaCarne/ConsultaCarne

Idstring required

Id do cliente

Aeskeystring required

Cobrança do tipo Carnê consultada

CarneIdstring uuid

Estado'Todos' | 'EmDia' | 'Finalizada' | 'Cancelada' | 'GerandoCarne'

ImgBase64string

{
  "CarneId": "00000000-0000-0000-0000-000000000000",
  "Parcelas": [
    {
      "CobrancaId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}