POST Api/Bot/ListaBoletos
Este Endpoint tem como objetivo buscar os boletos vinculados ao cliente nos casos de PF e PFF ou contrato nos casos de emrpesa PJ.
Request Information
URI Parameters
None.
Body Parameters
ListaBoletosBotEntrada| Name | Description | Type | Additional information |
|---|---|---|---|
| protocolo | string |
None. |
|
| manifestacao | string |
None. |
|
| geraProtocolo | string |
None. |
|
| tipoCliente | string |
None. |
|
| tituloAbero | string |
None. |
|
| identificacao | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"protocolo": "sample string 1",
"manifestacao": "sample string 2",
"geraProtocolo": "sample string 3",
"tipoCliente": "sample string 4",
"tituloAbero": "sample string 5",
"identificacao": "sample string 6"
}
application/xml, text/xml
Sample:
<ListaBoletosBotEntrada xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UniCuiaba.UniBrasil.Modelo.ModeloEntrada.BOT"> <geraProtocolo>sample string 3</geraProtocolo> <identificacao>sample string 6</identificacao> <manifestacao>sample string 2</manifestacao> <protocolo>sample string 1</protocolo> <tipoCliente>sample string 4</tipoCliente> <tituloAbero>sample string 5</tituloAbero> </ListaBoletosBotEntrada>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ListaBoletosBot| Name | Description | Type | Additional information |
|---|---|---|---|
| boletos | Collection of BoletoBot |
None. |
|
| Result | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"boletos": [
{
"id": 1,
"status": "sample string 2",
"dataVencimento": "sample string 3",
"valor": "sample string 4",
"linhaDigitavel": "sample string 5",
"impressao": {
"nome": "sample string 1",
"mimeType": "sample string 2",
"file64": "sample string 3"
},
"composicoes": [
{
"id": 1,
"valor": "sample string 2",
"descricao": "sample string 3"
},
{
"id": 1,
"valor": "sample string 2",
"descricao": "sample string 3"
}
]
},
{
"id": 1,
"status": "sample string 2",
"dataVencimento": "sample string 3",
"valor": "sample string 4",
"linhaDigitavel": "sample string 5",
"impressao": {
"nome": "sample string 1",
"mimeType": "sample string 2",
"file64": "sample string 3"
},
"composicoes": [
{
"id": 1,
"valor": "sample string 2",
"descricao": "sample string 3"
},
{
"id": 1,
"valor": "sample string 2",
"descricao": "sample string 3"
}
]
}
],
"Result": 1,
"Message": "sample string 2"
}
application/xml, text/xml
Sample:
<ListaBoletosBot xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UniCuiaba.UniBrasil.Modelo.ModeloRetorno.BOT">
<Message>sample string 2</Message>
<Result>1</Result>
<boletos>
<BoletoBot>
<composicoes>
<BoletoBotComposicao>
<descricao>sample string 3</descricao>
<id>1</id>
<valor>sample string 2</valor>
</BoletoBotComposicao>
<BoletoBotComposicao>
<descricao>sample string 3</descricao>
<id>1</id>
<valor>sample string 2</valor>
</BoletoBotComposicao>
</composicoes>
<dataVencimento>sample string 3</dataVencimento>
<id>1</id>
<impressao>
<file64>sample string 3</file64>
<mimeType>sample string 2</mimeType>
<nome>sample string 1</nome>
</impressao>
<linhaDigitavel>sample string 5</linhaDigitavel>
<status>sample string 2</status>
<valor>sample string 4</valor>
</BoletoBot>
<BoletoBot>
<composicoes>
<BoletoBotComposicao>
<descricao>sample string 3</descricao>
<id>1</id>
<valor>sample string 2</valor>
</BoletoBotComposicao>
<BoletoBotComposicao>
<descricao>sample string 3</descricao>
<id>1</id>
<valor>sample string 2</valor>
</BoletoBotComposicao>
</composicoes>
<dataVencimento>sample string 3</dataVencimento>
<id>1</id>
<impressao>
<file64>sample string 3</file64>
<mimeType>sample string 2</mimeType>
<nome>sample string 1</nome>
</impressao>
<linhaDigitavel>sample string 5</linhaDigitavel>
<status>sample string 2</status>
<valor>sample string 4</valor>
</BoletoBot>
</boletos>
</ListaBoletosBot>