Descrever a realização da utilização dos serviços do CRA21 API
Produção: http://craUF.api.crabr.com.br
- Autenticação básica: Usuário e senha do CRA21
- Headers:
- Accept: application/json
Serviço | Descrição | Envio |
url/titulo | Consulta de título | GET |
url/especie | Consulta de espécie | GET |
url/cartorio | Consulta de cartório | GET |
url/protesto-indevido | Consulta de protesto indevido | GET |
url/remessa | Serviço de consulta de remessas | GET |
url/cancelamento | Consulta de arquivo de cancelamento | GET |
url/cancelamento-titulo | Consulta as solicitações de cancelamentos de títulos | GET |
url/desistencia | Consulta de desistência | GET |
url/apresentante | Consulta de apresentantes com títulos no período informado. | GET |
url/titulo-ocorrencia | Quantidade de títulos por ocorrência 2º | GET |
url/produtividade-geral | Quantidade de títulos por ocorrência 1º | GET |
url/protesto-cancelamento | Quantidade de protestos e cancelamentos | GET |
url/titulo-especie | Quantidade de títulos por espécie | GET |
url/painel-controle/gestao-pendencias | Consultar os títulos pendentes de retorno | GET |
url/plataforma-batimento/pagamento-retido | Consulta todos títulos retidos na plataforma de batimento | GET |
url/plataforma-batimento/comprovantes-aberto | Consulta os comprovantes em abertos cadastrados na plataforma de batimento | GET |
url/pendencias/cartorio | Consulta as pendências do cartório | GET |
url/instrumento | Consulta e download dos instrumentos de protesto | GET |
url/cedente | Consulta de dados do cedente | GET |
url/relatorio-remessa | Consulta aos dados do relatório de remessa analítico detalhado | GET |
url/apresentantes | Consulta informações dos apresentantes. | GET |
Campo | Descrição | Opcional |
idCartorio | Recuperado após autenticação ou através do serviço URL/cartorio | X |
idApresentante | Recuperado após autenticação ou através do serviço URL/apresentante | X |
identificador | Número identificador do título | X |
numeroTitulo | Número do título | X |
protocolo | Protocolo do título | X |
dataProtocoloCartorio | Data do protocolo | X |
valorTitulo | Valor do título | X |
documentoDevedor | Documento do devedor do título | X |
documentoCredor | CPF/CNPJ do credor do título | X |
nomeCredor | Nome do credor do título | X |
ocorrenciaRetorno | Ocorrência do título, parâmetros de busca: protesto, pagamento, cacelamento, sustação, devolução, desistência | X |
Resposta
{ "_links": { "self": { "href": "http://craUF.api.crabr.com.br/titulo?idCartorio=&numeroTitulo=&documentoDevedor=00000000000 &ocorrenciaRetorno=protesto" } }, "_embedded": { "titulo": [ { "id": 1, "numeroTitulo": "00000", "nossoNumero": "000-00000000-0", "protocolo": "0000000000", "dataProtocolo": { "date": "2017-01-18 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataEmissao": { "date": "2016-12-07 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataVencimento": "00/00/2017", "valor": "000.00", "saldo": "000.00", "especie": "DMI", "descricaoEspecie": "Especie do título", "endosso": "M", "situacao": "RETORNADO", "nomeSacador": "TESTE 123", "tipoDocumentoSacador": "CNPJ", "documentoSacador": "00000000000000", "nomeCedente": "TESTE 123", "devedores": [ { "nome": "DEVEDOR DEVEDOR", "tipoDocumento": "CNPJ", "documento": "00000000000000" } ], "apresentante": { "id": 11, "nome": "APRESENTANTE", "codigo": "999", "endereco": { "endereco": "Endereco de testes", "bairro": "Centro", "cep": "99999999", "uf": "UF" }, "telefones": [ "6199999999", "61999999999" ], "fax": ["61888888888"], "emails": [ { "id": 00, "nome": "Email 1", "email": "teste.@gmail.com" }, { "id": 01, "nome": "Email 2", "email": "teste.@gmail.com" } ] }, "cartorio": { "id": 01, "nome": "1º Ofício de testes", "documento": "00000000000000", "uf": "UF", "tipo": "CARTORIO", "codigo": "01", "endereco": { "endereco": "Avenida Francisco Raulino, 2061-A", "bairro": "Centro", "cep": "64290000", "uf": "PI" }, "telefones": [ "6100000000" ], "fax": [ "6100000000" ], "emails": [ { "id": 1, "nome": "NOME QUALQUER", "email": "TESTE@TESTE.com.br" } ], "municipio": { "id": 1, "nome": "TESTELANDIA", "codigo": "1234567" } }, "retornos": [ { "id": 1234567, "dataApresentante": { "date": "2017-01-30 12:38:19.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataCartorio": { "date": "2017-01-30 12:38:19.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "ocorrencia": { "codigo": "2", "descricao": "Protestado", "data": { "date": "2017-01-27 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" } }, "valor": "000.00", "saldo": "000.00", "protocolo": "0000000000", "dataProtocolo": { "date": "2017-01-19 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "nossoNumero": "000-00000000-0", "sequencial": "000001", "status": "LIBERADO" } ], "confirmacao": { "id": 00000, "dataConfirmacao": { "date": "2017-01-18 11:41:35.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" } }, "remessa": { "id": 00000, "sequencial": "009999", "nomeArquivo": "B9999999.181", "data": { "date": "2018-04-17 08:29:27.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" } }, "custas":[ { "tipo": "cancelamento", "valor" : 10.34, "vigencia": { "date": "2022-04-17 08:29:27.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" } }, { "tipo": "desistencia", "valor" : 25.69, "vigencia": { "date": "2022-04-17 08:29:27.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" } }, ], "_links": { "self": { "href": "http://craUF.api.crabr.com.br/titulo/0000000000" } } } ] }, "total_items": 1 }
Campo | Descrição | Opcional |
idCartorio | Recuperado após autenticação ou através do serviço URL/cartorio | X |
Resposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 | { "_links": { "self": { "href": "http://craUF.api.crabr.com.br/protesto-indevido?idCartorio=68" } }, "_embedded": { "protesto_indevido": [ { "id": 1, "numeroTitulo": "1000", "nossoNumero": "000000000000001", "protocolo": "1000000000", "dataProtocolo": { "date": "2017-02-03 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataEmissao": { "date": "2016-11-24 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataVencimento": "23/01/2017", "valor": "1000.00", "saldo": "1000.00", "sigla": "DMI", "endosso": "M", "devedores": [ { "nome": "FULANO DE TAL", "documento": "00000000000000" } ], "cartorio": { "id": 1, "nome": "Cartório 1° Ofício", "documento": "00000000000000", "uf": "UF", "tipo": "CARTORIO", "codigo": "01", "telefones": [ "0000000000", "0000000000" ], "fax": [ "0000000000" ], "emails": [ { "id": 1, "nome": "CARTÓRIO", "email": "cartorio@cartorio.com" } ], "municipio": { "id": 1, "nome": "Município", "codigo": "0000000" } }, "apresentante": { "id": 1, "nome": "BANCO SA", "codigo": "000" }, "_links": { "self": { "href": "http://craUF.api.crabr.com.br/titulo/1" } } } ] }, "total_items": 1 } |
{ "_links": { "self": { "href": "http://craUF.api.crabr.com.br/protesto-indevido?idCartorio=68" } }, "_embedded": { "protesto_indevido": [ { "id": 1, "numeroTitulo": "1000", "nossoNumero": "000000000000001", "protocolo": "1000000000", "dataProtocolo": { "date": "2017-02-03 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataEmissao": { "date": "2016-11-24 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataVencimento": "23/01/2017", "valor": "1000.00", "saldo": "1000.00", "sigla": "DMI", "endosso": "M", "devedores": [ { "nome": "FULANO DE TAL", "documento": "00000000000000" } ], "cartorio": { "id": 1, "nome": "Cartório 1° Ofício", "documento": "00000000000000", "uf": "UF", "tipo": "CARTORIO", "codigo": "01", "telefones": [ "0000000000", "0000000000" ], "fax": [ "0000000000" ], "emails": [ { "id": 1, "nome": "CARTÓRIO", "email": "cartorio@cartorio.com" } ], "municipio": { "id": 1, "nome": "Município", "codigo": "0000000" } }, "apresentante": { "id": 1, "nome": "BANCO SA", "codigo": "000" }, "_links": { "self": { "href": "http://craUF.api.crabr.com.br/titulo/1" } } } ] }, "total_items": 1 }
Campo | Descrição | Opcional |
status | Preencher com 1.
|
|
titulos | Ao informar esse parâmetro com 1, o serviço irá retornar os títulos da remessa | X |
idCartorio | Recuperado após autenticação ou através do serviço URL/cartorio | X |
idApresentante | Recuperado após autenticação ou através do serviço URL/apresentante | X |
Resposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 | { "_links": { "self": { "href": "http://craUF.api.crabr.com.br/remessa?status=1&titulos=1" } }, "_embedded": { "remessa": [ { "id": 1, "sequencial": "000001", "nomeArquivo": "B90C2203.172", "data": { "date": "2017-03-22 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "titulos": [ { "id": 5, "numeroTitulo": "00000000000", "nossoNumero": "000000000000", "protocolo": null, "dataProtocolo": null, "dataEmissao": { "date": "2017-03-14 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataVencimento": "A VISTA", "valor": "00.00" "saldo": "00.00", "especie": "CDA", "endosso": null, "situacao": "ENVIADO", "nomeSacador": "BANCO FICTICIO", "tipoDocumentoSacador": "CNPJ", "documentoSacador": "00000000000000", "nomeCedente": "BANCO FICTICIO", "devedores": [ { "nome": "DEVEDOR", "tipoDocumento": "CNPJ", "documento": "00000000000000" } ], "apresentante": { "id": 1, "nome": "Banco Ficticio", "codigo": "00A" }, "cartorio": null, "retornos": [], "confirmacao": null } ], "cartorio": { "id": 2, "nome": "Cartório de Protesto", "documento": "00000000000000", "uf": "GO", "tipo": "CARTORIO", "codigo": "01", "telefones": [ "000000000" ], "fax": [], "emails": [ { "id": 1, "nome": "Cartório de Protesto", "email": "cartorio@cartorio.com.br" } ], "municipio": { "id": 2, "nome": "Município", "codigo": "0000000" } }, "apresentante": { "id": 1, "nome": "Banco Ficticio", "codigo": "00A" }, "_links": { "self": { "href": "http://craUF.api.crabr.com.br/remessa/1" } } } ] }, "total_items": 1 } |
{ "_links": { "self": { "href": "http://craUF.api.crabr.com.br/remessa?status=1&titulos=1" } }, "_embedded": { "remessa": [ { "id": 1, "sequencial": "000001", "nomeArquivo": "B90C2203.172", "data": { "date": "2017-03-22 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "titulos": [ { "id": 5, "numeroTitulo": "00000000000", "nossoNumero": "000000000000", "protocolo": null, "dataProtocolo": null, "dataEmissao": { "date": "2017-03-14 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataVencimento": "A VISTA", "valor": "00.00" "saldo": "00.00", "especie": "CDA", "endosso": null, "situacao": "ENVIADO", "nomeSacador": "BANCO FICTICIO", "tipoDocumentoSacador": "CNPJ", "documentoSacador": "00000000000000", "nomeCedente": "BANCO FICTICIO", "devedores": [ { "nome": "DEVEDOR", "tipoDocumento": "CNPJ", "documento": "00000000000000" } ], "apresentante": { "id": 1, "nome": "Banco Ficticio", "codigo": "00A" }, "cartorio": null, "retornos": [], "confirmacao": null } ], "cartorio": { "id": 2, "nome": "Cartório de Protesto", "documento": "00000000000000", "uf": "GO", "tipo": "CARTORIO", "codigo": "01", "telefones": [ "000000000" ], "fax": [], "emails": [ { "id": 1, "nome": "Cartório de Protesto", "email": "cartorio@cartorio.com.br" } ], "municipio": { "id": 2, "nome": "Município", "codigo": "0000000" } }, "apresentante": { "id": 1, "nome": "Banco Ficticio", "codigo": "00A" }, "_links": { "self": { "href": "http://craUF.api.crabr.com.br/remessa/1" } } } ] }, "total_items": 1 }
Campo | Descrição | Opcional |
status | Preencher com 2.
|
|
idCartorio | Recuperado após autenticação ou através do serviço URL/cartorio | X |
idApresentante | Recuperado após autenticação ou através do serviço URL/apresentante | X |
Resposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 | { "_links": { "self": { "href": "http://craUF.api.crabr.com.br/cancelamento?status=2" } }, "_embedded": { "cancelamento": [ { "id": 1, "nomeArquivo": "CP0000906.161", "data": { "date": "2016-06-09 10:34:21.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "cartorio": { "id": 1, "nome": "Cartório 1° Ofício", "documento": "00000000000000", "uf": "UF", "tipo": "CARTORIO", "codigo": "01", "telefones": [ "0000000000", "0000000000" ], "fax": [ "0000000000" ], "emails": [ { "id": 1, "nome": "CARTÓRIO", "email": "cartorio@cartorio.com" } ], "municipio": { "id": 1, "nome": "Município", "codigo": "0000000" } }, "apresentante": { "id": 1, "nome": "BANCO SA", "codigo": "000" }, "_links": { "self": { "href": "http://craUF.api.crabr.com.br/cancelamento/1" } } } ] }, "total_items": 1 } |
{ "_links": { "self": { "href": "http://craUF.api.crabr.com.br/cancelamento?status=2" } }, "_embedded": { "cancelamento": [ { "id": 1, "nomeArquivo": "CP0000906.161", "data": { "date": "2016-06-09 10:34:21.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "cartorio": { "id": 1, "nome": "Cartório 1° Ofício", "documento": "00000000000000", "uf": "UF", "tipo": "CARTORIO", "codigo": "01", "telefones": [ "0000000000", "0000000000" ], "fax": [ "0000000000" ], "emails": [ { "id": 1, "nome": "CARTÓRIO", "email": "cartorio@cartorio.com" } ], "municipio": { "id": 1, "nome": "Município", "codigo": "0000000" } }, "apresentante": { "id": 1, "nome": "BANCO SA", "codigo": "000" }, "_links": { "self": { "href": "http://craUF.api.crabr.com.br/cancelamento/1" } } } ] }, "total_items": 1 }
Campo | Descrição | Opcional |
status | Preencher com 2.
|
|
idCartorio | Recuperado após autenticação ou através do serviço URL/cartorio | X |
Resposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 | { "_links": { "self": { "href": "http://craUF.api.crabr.com.br/cancelamento-titulo?status=2" } }, "_embedded": { "cancelamento_titulo": [ { "id": 1, "dataCancelamento": { "date": "2017-04-06 13:48:43.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "protocolo": "0000949709", "dataProtocolo": { "date": "2013-09-12 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "devedor": "FULANO DE TAL", "numero": "1234567", "valor": "100.00", "cartorio": { "id": 1, "nome": "Cartório 1° Ofício", "documento": "00000000000000", "uf": "UF", "tipo": "CARTORIO", "codigo": "01", "telefones": [ "0000000000", "0000000000" ], "fax": [ "0000000000" ], "emails": [ { "id": 1, "nome": "CARTÓRIO", "email": "cartorio@cartorio.com" } ], "municipio": { "id": 1, "nome": "Município", "codigo": "0000000" } }, "_links": { "self": { "href": "http://craUF.api.crabr.com.br/cancelamento-titulo/1" } } } ] }, "total_items": 1 } |
{ "_links": { "self": { "href": "http://craUF.api.crabr.com.br/cancelamento-titulo?status=2" } }, "_embedded": { "cancelamento_titulo": [ { "id": 1, "dataCancelamento": { "date": "2017-04-06 13:48:43.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "protocolo": "0000949709", "dataProtocolo": { "date": "2013-09-12 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "devedor": "FULANO DE TAL", "numero": "1234567", "valor": "100.00", "cartorio": { "id": 1, "nome": "Cartório 1° Ofício", "documento": "00000000000000", "uf": "UF", "tipo": "CARTORIO", "codigo": "01", "telefones": [ "0000000000", "0000000000" ], "fax": [ "0000000000" ], "emails": [ { "id": 1, "nome": "CARTÓRIO", "email": "cartorio@cartorio.com" } ], "municipio": { "id": 1, "nome": "Município", "codigo": "0000000" } }, "_links": { "self": { "href": "http://craUF.api.crabr.com.br/cancelamento-titulo/1" } } } ] }, "total_items": 1 }
Campo | Descrição | Opcional |
status | Preencher com 2.
|
|
idCartorio | Recuperado após autenticação ou através do serviço URL/cartorio | X |
idApresentante | Recuperado após autenticação ou através do serviço URL/apresentante | X |
Resposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 | { "_links": { "self": { "href": "http://craUF.api.crabr.com.br/desistencia?status=2" } }, "_embedded": { "desistencia": [ { "id": 1, "nomeArquivo": "DP0003105.171", "data": { "date": "2017-05-31 15:09:35.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "cartorio": { "id": 1, "nome": "Cartório 1° Ofício", "documento": "00000000000000", "uf": "UF", "tipo": "CARTORIO", "codigo": "01", "telefones": [ "0000000000", "0000000000" ], "fax": [ "0000000000" ], "emails": [ { "id": 1, "nome": "CARTÓRIO", "email": "cartorio@cartorio.com" } ], "municipio": { "id": 1, "nome": "Município", "codigo": "0000000" } }, "apresentante": { "id": 1, "nome": "BANCO SA", "codigo": "000" }, "_links": { "self": { "href": "http://craUF.api.crabr.com.br/desistencia/1" } } } ] }, "total_items": 1 } |
{ "_links": { "self": { "href": "http://craUF.api.crabr.com.br/desistencia?status=2" } }, "_embedded": { "desistencia": [ { "id": 1, "nomeArquivo": "DP0003105.171", "data": { "date": "2017-05-31 15:09:35.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "cartorio": { "id": 1, "nome": "Cartório 1° Ofício", "documento": "00000000000000", "uf": "UF", "tipo": "CARTORIO", "codigo": "01", "telefones": [ "0000000000", "0000000000" ], "fax": [ "0000000000" ], "emails": [ { "id": 1, "nome": "CARTÓRIO", "email": "cartorio@cartorio.com" } ], "municipio": { "id": 1, "nome": "Município", "codigo": "0000000" } }, "apresentante": { "id": 1, "nome": "BANCO SA", "codigo": "000" }, "_links": { "self": { "href": "http://craUF.api.crabr.com.br/desistencia/1" } } } ] }, "total_items": 1 }
Campo | Descrição | Opcional |
dataInicial | Data inicial do período de apresentação dos títulos Preencher da seguinte forma: dmy Ex: 01012017 | |
dataFinal | Data final do período de apresentação dos títulos Preencher da seguinte forma: dmy Ex: 01012017 | |
idCartorio | Ao informar esse parâmetro, o serviço irá retornar somente os apresentante que possuam títulos no cartório informado | X |
tipoApresentante | Informando este parâmetro, o serviço irá retornar apresentantes do tipo informado Preencher com 1,2,3,4 ou 5.
|
X |
Resposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | { "_links": { "self": { "href": "http://craUF.api.crabr.com.br/apresentante?dataInicial=03012017&dataFinal=03012017" } }, "_embedded": { "apresentante": [ { "id": 91, "nome": "BANCO SA", "codigo": "777", "_links": { "self": { "href": "http://craUF.api.crabr.com.br/apresentante/91" } } }, { "id": 1, "nome": "Banco INC", "codigo": "000", "_links": { "self": { "href": "http://craUF.api.crabr.com.br/apresentante/1" } } } ] }, "total_items": 2 } |
{ "_links": { "self": { "href": "http://craUF.api.crabr.com.br/apresentante?dataInicial=03012017&dataFinal=03012017" } }, "_embedded": { "apresentante": [ { "id": 91, "nome": "BANCO SA", "codigo": "777", "_links": { "self": { "href": "http://craUF.api.crabr.com.br/apresentante/91" } } }, { "id": 1, "nome": "Banco INC", "codigo": "000", "_links": { "self": { "href": "http://craUF.api.crabr.com.br/apresentante/1" } } } ] }, "total_items": 2 }
Campo | Descrição | Opcional |
dataInicial | Data inicial do período de apresentação dos títulos Preencher da seguinte forma: dmy Ex: 01012017 | |
dataFinal | Data final do período de apresentação dos títulos Preencher da seguinte forma: dmy Ex: 01012017 | |
idCartorio | Recuperado após autenticação ou através do serviço URL/cartorio Ao informar esse parâmetro, o serviço irá retornar somente títulos do cartório informado | X |
tipoApresentante | Informando este parâmetro, o serviço irá retornar apresentantes do tipo informado Preencher com 1,2,3,4 ou 5.
|
X |
idApresentante | ATENÇÃO : Ao informar o idApresentante o campo tipoApresentante deve ser preenchido com 0 | X |
Resposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | { "_links": { "self": { "href": "http://craUF.api.crabr.com.br/titulo-ocorrencia?dataInicial=03012017&dataFinal=03012017" } }, "_embedded": { "titulo_ocorrencia": [ { "ocorrencia": "Pago", "total": "4066", "saldo": "4863246.97" }, { "ocorrencia": "Protestado", "total": "7889", "saldo": "15177935.09" }, { "ocorrencia": "Retirada por edital", "total": "23", "saldo": "73716.36" }, { "ocorrencia": "Retirado", "total": "964", "saldo": "3889964.85" } ] }, "total_items": 4 } |
{ "_links": { "self": { "href": "http://craUF.api.crabr.com.br/titulo-ocorrencia?dataInicial=03012017&dataFinal=03012017" } }, "_embedded": { "titulo_ocorrencia": [ { "ocorrencia": "Pago", "total": "4066", "saldo": "4863246.97" }, { "ocorrencia": "Protestado", "total": "7889", "saldo": "15177935.09" }, { "ocorrencia": "Retirada por edital", "total": "23", "saldo": "73716.36" }, { "ocorrencia": "Retirado", "total": "964", "saldo": "3889964.85" } ] }, "total_items": 4 }
Campo | Descrição | Opcional |
dataInicial | Data inicial do período de apresentação dos títulos Preencher da seguinte forma: dmy Ex: 01012017 | |
dataFinal | Data final do período de apresentação dos títulos Preencher da seguinte forma: dmy Ex: 01012017 | |
idCartorio | Recuperado após autenticação ou através do serviço URL/cartorio Ao informar esse parâmetro, o serviço irá retornar somente títulos do cartório informado | X |
tipoApresentante | Informando este parâmetro, o serviço irá retornar apresentantes do tipo informado Preencher com 1,2,3,4 ou 5.
|
X |
idApresentante | Recuperado após autenticação ou através do serviço URL/apresentante ATENÇÃO : Ao informar o idApresentante o campo tipoApresentante deve ser preenchido com 0 | X |
Resposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | { "_links": { "self": { "href": "http://craUF.api.crabr.com.br/produtividade-geral?dataInicial=03012017&dataFinal=03012017&tipoApresentante=3" } }, "_embedded": { "produtividade_geral": [ { "totalGeral": "5716", "valorTotal": "9391861.39", "processados": "5588", "valorProcessados": "9127033.69", "devolvidos": "128", "valorDevolvidos": "264827.70" } ] }, "total_items": 1 } |
{ "_links": { "self": { "href": "http://craUF.api.crabr.com.br/produtividade-geral?dataInicial=03012017&dataFinal=03012017&tipoApresentante=3" } }, "_embedded": { "produtividade_geral": [ { "totalGeral": "5716", "valorTotal": "9391861.39", "processados": "5588", "valorProcessados": "9127033.69", "devolvidos": "128", "valorDevolvidos": "264827.70" } ] }, "total_items": 1 }
Campo | Descrição | Opcional |
dataInicial | Data inicial do período de apresentação dos títulos Preencher da seguinte forma: dmy Ex: 01012017 | |
dataFinal | Data final do período de apresentação dos títulos Preencher da seguinte forma: dmy Ex: 01012017 | |
idCartorio | Recuperado após autenticação ou através do serviço URL/cartorio Ao informar esse parâmetro, o serviço irá retornar somente títulos do cartório informado | X |
tipoApresentante | Informando este parâmetro, o serviço irá retornar apresentantes do tipo informado Preencher com 1,2,3,4 ou 5.
|
X |
idApresentante | Recuperado após autenticação ou através do serviço URL/apresentante ATENÇÃO : Ao informar o idApresentante o campo tipoApresentante deve ser preenchido com 0 | X |
Resposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | { "_links": { "self": { "href": "http://craUF.api.crabr.com.br/protesto-cancelamento?dataInicial=03012017&dataFinal=03012017" } }, "_embedded": { "protesto_cancelamento": [ { "ocorrencia": "Com autorização cancelamento", "totalOcorrencia": "1118", "valorOcorrencia": "1434296.64" }, { "ocorrencia": "Com autorização desistência", "totalOcorrencia": "0", "valorOcorrencia": "0" }, { "ocorrencia": "Sem autorização", "totalOcorrencia": "6771", "valorOcorrencia": "13743638.45" } ] }, "total_items": 3 } |
{ "_links": { "self": { "href": "http://craUF.api.crabr.com.br/protesto-cancelamento?dataInicial=03012017&dataFinal=03012017" } }, "_embedded": { "protesto_cancelamento": [ { "ocorrencia": "Com autorização cancelamento", "totalOcorrencia": "1118", "valorOcorrencia": "1434296.64" }, { "ocorrencia": "Com autorização desistência", "totalOcorrencia": "0", "valorOcorrencia": "0" }, { "ocorrencia": "Sem autorização", "totalOcorrencia": "6771", "valorOcorrencia": "13743638.45" } ] }, "total_items": 3 }
Campo | Descrição | Opcional |
dataInicial | Data inicial do período de apresentação dos títulos Preencher da seguinte forma: dmy Ex: 01012017 | |
dataFinal | Data final do período de apresentação dos títulos Preencher da seguinte forma: dmy Ex: 01012017 | |
idCartorio | Recuperado após autenticação ou através do serviço URL/cartorio Ao informar esse parâmetro, o serviço irá retornar somente títulos do cartório informado | X |
tipoApresentante | Informando este parâmetro, o serviço irá retornar apresentantes do tipo informado Preencher com 1,2,3,4 ou 5.
|
X |
idApresentante | Recuperado após autenticação ou através do serviço URL/apresentante ATENÇÃO : Ao informar o idApresentante o campo tipoApresentante deve ser preenchido com 0 | X |
Resposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 | { "_links": { "self": { "href": "http://craUF.api.crabr.com.br/titulo-especie?dataInicial=03012017&dataFinal=03012017" } }, "_embedded": { "titulo_especie": [ { "especie": "DMI", "total": "7160" }, { "especie": "CDA", "total": "5582" }, { "especie": "DSI", "total": "195" }, { "especie": "CBI", "total": "5" } ] }, "total_items": 4 } |
{ "_links": { "self": { "href": "http://craUF.api.crabr.com.br/titulo-especie?dataInicial=03012017&dataFinal=03012017" } }, "_embedded": { "titulo_especie": [ { "especie": "DMI", "total": "7160" }, { "especie": "CDA", "total": "5582" }, { "especie": "DSI", "total": "195" }, { "especie": "CBI", "total": "5" } ] }, "total_items": 4 }
Campo | Descrição | Opcional |
dias | Dias para consulta | X |
novoPrazo | Preencher com 0 ou 1.
|
X |
Resposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 | { "_links": { "self": { "href": "http://craUF.api.crabr.com.br/painel-controle/gestao-pendencias" } }, "_embedded": { "gestao_pendencias": [ { "id": 1, "protocolo": "0000000001", "dataProtocolo": { "date": "2017-01-05 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "nossoNumero": "100000000000000", "numeroTitulo": "1000000000", "especie": "DMI", "saldo": "100.00", "remessa": { "sequencial": "00001", "data": { "date": "2017-01-05 09:47:03.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" } }, "cartorio": { "id": 1, "nome": "Cartório 1° Ofício", "documento": "00000000000000", "uf": "UF", "tipo": "CARTORIO", "codigo": "01", "telefones": [ "0000000000", "0000000000" ], "fax": [ "0000000000" ], "emails": [ { "id": 1, "nome": "CARTÓRIO", "email": "cartorio@cartorio.com" } ], "municipio": { "id": 1, "nome": "Município", "codigo": "0000000" } }, "apresentante": { "id": 1, "nome": "BANCO SA", "codigo": "000" }, "justificativas": [ { "id": 1, "dataRegistro": { "date": "2017-06-20 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "novoPrazo": { "date": "2017-06-20 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "texto": "Justificativas", "usuario": { "id": 2, "tipo": "CRA", "usuario": "crapi", "perfil": { "id": 2, "nome": "Administrador CRA" }, "cra": { "id": 1, "razaoSocial": "Instituto de Estudos de Protesto de Titulos do Brasil - Seção UF" } } } ], "_links": { "self": { "href": "http://craUF.api.crabr.com.br/painel-controle/gestao-pendencias" } } } ] }, "total_items": 1 } |
{ "_links": { "self": { "href": "http://craUF.api.crabr.com.br/painel-controle/gestao-pendencias" } }, "_embedded": { "gestao_pendencias": [ { "id": 1, "protocolo": "0000000001", "dataProtocolo": { "date": "2017-01-05 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "nossoNumero": "100000000000000", "numeroTitulo": "1000000000", "especie": "DMI", "saldo": "100.00", "remessa": { "sequencial": "00001", "data": { "date": "2017-01-05 09:47:03.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" } }, "cartorio": { "id": 1, "nome": "Cartório 1° Ofício", "documento": "00000000000000", "uf": "UF", "tipo": "CARTORIO", "codigo": "01", "telefones": [ "0000000000", "0000000000" ], "fax": [ "0000000000" ], "emails": [ { "id": 1, "nome": "CARTÓRIO", "email": "cartorio@cartorio.com" } ], "municipio": { "id": 1, "nome": "Município", "codigo": "0000000" } }, "apresentante": { "id": 1, "nome": "BANCO SA", "codigo": "000" }, "justificativas": [ { "id": 1, "dataRegistro": { "date": "2017-06-20 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "novoPrazo": { "date": "2017-06-20 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "texto": "Justificativas", "usuario": { "id": 2, "tipo": "CRA", "usuario": "crapi", "perfil": { "id": 2, "nome": "Administrador CRA" }, "cra": { "id": 1, "razaoSocial": "Instituto de Estudos de Protesto de Titulos do Brasil - Seção UF" } } } ], "_links": { "self": { "href": "http://craUF.api.crabr.com.br/painel-controle/gestao-pendencias" } } } ] }, "total_items": 1 }
Campo | Descrição | Opcional |
idCartorio | Solicitado através do serviço URL/cartorio | X |
idApresentante | Solicitado através do serviço URL/apresentante | X |
Resposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 | { "_links": { "self": { "href": "http://craUF.api.crabr.com.br/plataforma-batimento/pagamento-retido" } }, "_embedded": { "pagamento_retido": [ { "id": 25214, "data": { "date": "2017-02-07 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "valor": { "retorno": "968.87", "comprovado": "0.00", "liberado": "0.00" }, "comprovantes": [], "apresentante": { "id": 8, "nome": "BANCO SA", "codigo": "000" }, "cartorio": { "id": 64, "nome": "Cartorio 1º Oficio", "documento": "0000000000", "uf": "UF", "codigo": "00", "telefones": [], "fax": [], "emails": [ { "id": 26, "nome": "Usuário", "email": "email@email.com.br" } ], "municipio": { "id": 155, "nome": "Município", "codigo": "0000000" } }, "retornos": [ { "id": 31109, "data": { "date": "2017-02-08 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "sequencial": "000160", "status": "RETIDO", "repasse": 968.87, "titulos": [ { "id": 419194, "data": { "date": "2017-02-08 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "ocorrencia": { "codigo": "1", "descricao": "Pago", "data": { "date": "2017-01-27 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" } }, "valor": "968.87", "saldo": "968.87", "protocolo": "0000009966", "dataProtocolo": { "date": "2017-01-23 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "nossoNumero": "946730000347494", "sequencial": "000160", "status": "RETIDO" } ] } ], "_links": { "self": { "href": "http://craUF.api.crabr.com.br/plataforma-batimento/pagamento-retido" } } } ] }, "total_items": 1 } |
{ "_links": { "self": { "href": "http://craUF.api.crabr.com.br/plataforma-batimento/pagamento-retido" } }, "_embedded": { "pagamento_retido": [ { "id": 25214, "data": { "date": "2017-02-07 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "valor": { "retorno": "968.87", "comprovado": "0.00", "liberado": "0.00" }, "comprovantes": [], "apresentante": { "id": 8, "nome": "BANCO SA", "codigo": "000" }, "cartorio": { "id": 64, "nome": "Cartorio 1º Oficio", "documento": "0000000000", "uf": "UF", "codigo": "00", "telefones": [], "fax": [], "emails": [ { "id": 26, "nome": "Usuário", "email": "email@email.com.br" } ], "municipio": { "id": 155, "nome": "Município", "codigo": "0000000" } }, "retornos": [ { "id": 31109, "data": { "date": "2017-02-08 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "sequencial": "000160", "status": "RETIDO", "repasse": 968.87, "titulos": [ { "id": 419194, "data": { "date": "2017-02-08 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "ocorrencia": { "codigo": "1", "descricao": "Pago", "data": { "date": "2017-01-27 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" } }, "valor": "968.87", "saldo": "968.87", "protocolo": "0000009966", "dataProtocolo": { "date": "2017-01-23 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "nossoNumero": "946730000347494", "sequencial": "000160", "status": "RETIDO" } ] } ], "_links": { "self": { "href": "http://craUF.api.crabr.com.br/plataforma-batimento/pagamento-retido" } } } ] }, "total_items": 1 }
Campo | Descrição | Opcional |
idApresentante | Recuperado após autenticação ou através do serviço URL/apresentante | X |
idCartorio | Recuperado após autenticação ou através do serviço URL/cartorio | X |
Resposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 | { { "_links": { "self": { "href": "http://craUF.api.crabr.com.br/plataforma-batimento/comprovantes-aberto" } }, "_embedded": { "comprovantes_aberto": [ { "id": 1, "data": { "date": "2017-07-25 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "apresentante": { "id": 1, "nome": "BANCO SA", "codigo": "000" }, "cartorio": { "id": 1, "nome": "Cartório 1° Ofício", "documento": "00000000000000", "uf": "UF", "tipo": "CARTORIO", "codigo": "01", "telefones": [ "0000000000", "0000000000" ], "fax": [ "0000000000" ], "emails": [ { "id": 1, "nome": "CARTÓRIO", "email": "cartorio@cartorio.com" } ], "municipio": { "id": 1, "nome": "Município", "codigo": "0000000" } }, "comprovantes": [ { "id": 1, "operacao": "DOC", "valor": "1.000", "data": { "date": "2017-07-25 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataAlteracao": { "date": "2017-07-25 08:27:29.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "utilizado": false, "usuario": { "id": 2, "tipo": "CRA", "usuario": "cra", "perfil": { "id": 2, "nome": "Administrador CRA" }, "cra": { "id": 1, "razaoSocial": "Instituto de Estudos de Protesto de Titulos do Brasil - Seção UF" } } } ], "_links": { "self": { "href": "http://craUF.api.crabr.com.br/plataforma-batimento/comprovantes-aberto" } } } ] }, "total_items": 1 } |
{ { "_links": { "self": { "href": "http://craUF.api.crabr.com.br/plataforma-batimento/comprovantes-aberto" } }, "_embedded": { "comprovantes_aberto": [ { "id": 1, "data": { "date": "2017-07-25 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "apresentante": { "id": 1, "nome": "BANCO SA", "codigo": "000" }, "cartorio": { "id": 1, "nome": "Cartório 1° Ofício", "documento": "00000000000000", "uf": "UF", "tipo": "CARTORIO", "codigo": "01", "telefones": [ "0000000000", "0000000000" ], "fax": [ "0000000000" ], "emails": [ { "id": 1, "nome": "CARTÓRIO", "email": "cartorio@cartorio.com" } ], "municipio": { "id": 1, "nome": "Município", "codigo": "0000000" } }, "comprovantes": [ { "id": 1, "operacao": "DOC", "valor": "1.000", "data": { "date": "2017-07-25 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataAlteracao": { "date": "2017-07-25 08:27:29.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "utilizado": false, "usuario": { "id": 2, "tipo": "CRA", "usuario": "cra", "perfil": { "id": 2, "nome": "Administrador CRA" }, "cra": { "id": 1, "razaoSocial": "Instituto de Estudos de Protesto de Titulos do Brasil - Seção UF" } } } ], "_links": { "self": { "href": "http://craUF.api.crabr.com.br/plataforma-batimento/comprovantes-aberto" } } } ] }, "total_items": 1 }
Resposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 | { { "id": 1, "Remessas não visualizadas/baixadas": { "Arquivos": "1", "Títulos": "1" }, "Download imagens": "1", "Remessas não confirmadas": "1", "Desistências não visualizadas/baixadas": "1", "Desistências sem retorno": "1", "Provável protesto indevido": "1", "Cancelamentos não visualizados/baixados": "1", "Cancelamentos pendentes": "1", "Autorizações de cancelamento pendentes de impressão": "1", "Autorizações de desistência pendentes de impressão": "1", "Retornos em atraso": "1", "Retornos em atraso com novo prazo": "1", "Comprovação de repasse": { "Arquivos": "1", "Títulos": "1" }, "_links": { "self": { "href": "http://craUF.api.crabr.com.br/pendencias/cartorio" } } } |
{ { "id": 1, "Remessas não visualizadas/baixadas": { "Arquivos": "1", "Títulos": "1" }, "Download imagens": "1", "Remessas não confirmadas": "1", "Desistências não visualizadas/baixadas": "1", "Desistências sem retorno": "1", "Provável protesto indevido": "1", "Cancelamentos não visualizados/baixados": "1", "Cancelamentos pendentes": "1", "Autorizações de cancelamento pendentes de impressão": "1", "Autorizações de desistência pendentes de impressão": "1", "Retornos em atraso": "1", "Retornos em atraso com novo prazo": "1", "Comprovação de repasse": { "Arquivos": "1", "Títulos": "1" }, "_links": { "self": { "href": "http://craUF.api.crabr.com.br/pendencias/cartorio" } } }
Campo | Descrição | Opcional |
codigoAutenticacao | Código de autenticação gerado no upload do instrumento de protesto | |
imagem | 1 – Com imagem instrumento 0 – Sem imagem instrumento |
Reposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | { "_links": { "self": { "href": "http://uf.teste.craapi.com.br/instrumento?codigoAutenticacao=XXX-XXX-XXX&imagem=1" } }, "_embedded": { "instrumento": [ { "id": 479777, "devedores": [ { "nome": "DEVEDOR TESTE", "tipoDocumento": "CPF", "documento": "00000000000" } ], "cartorio": { "nome": "1º Tabelionato de Protesto de Títulos " }, "protocolo": "0000000000", "dataProtesto": { "date": "2018-07-17 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "numeroTitulo": "124511", "saldoTitulo": "264.97", "imagem": "JVBERi0xLjbmRzdHJlYW0KZW5kb2JqCjUg" "self": { "href": "http://uf.teste.craapi.com.br/instrumento/558844" } } } ] }, "total_items": 1 } |
{ "_links": { "self": { "href": "http://uf.teste.craapi.com.br/instrumento?codigoAutenticacao=XXX-XXX-XXX&imagem=1" } }, "_embedded": { "instrumento": [ { "id": 479777, "devedores": [ { "nome": "DEVEDOR TESTE", "tipoDocumento": "CPF", "documento": "00000000000" } ], "cartorio": { "nome": "1º Tabelionato de Protesto de Títulos " }, "protocolo": "0000000000", "dataProtesto": { "date": "2018-07-17 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "numeroTitulo": "124511", "saldoTitulo": "264.97", "imagem": "JVBERi0xLjbmRzdHJlYW0KZW5kb2JqCjUg" "self": { "href": "http://uf.teste.craapi.com.br/instrumento/558844" } } } ] }, "total_items": 1 }
Campo | Descrição | Opcional |
nome | Nome do cedente | |
tipoApresentante | Tipo do apresentante. Informar 1 para bancos e 2 para convênios. | |
codigoFebraban | Código do apresentante |
Reposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | { "_links": { "self": { "href": "http://craUF.api.crabr.com.br/cedente?nome=maria%20da%20guia&tipoApresentante=2&codigoFebraban=90L" } }, "_embedded": { "cedente": [ { "id": 11697, "codigo": "074", "nome": "MARIA DA GUIA", "documento": "09626431751", "cep": "23330193", "endereco": "RUA MONTE ALEGRE 26, 179 AP 104", "cidade": "CIDADE", "uf": "UF", "_links": { "self": { "href": "http://craUF.api.crabr.com.br/cedente/11697" } } }, ] }, "total_items": 1 } |
{ "_links": { "self": { "href": "http://craUF.api.crabr.com.br/cedente?nome=maria%20da%20guia&tipoApresentante=2&codigoFebraban=90L" } }, "_embedded": { "cedente": [ { "id": 11697, "codigo": "074", "nome": "MARIA DA GUIA", "documento": "09626431751", "cep": "23330193", "endereco": "RUA MONTE ALEGRE 26, 179 AP 104", "cidade": "CIDADE", "uf": "UF", "_links": { "self": { "href": "http://craUF.api.crabr.com.br/cedente/11697" } } }, ] }, "total_items": 1 }
Campo | Descrição | Opcional |
visao | Modelo do relatório “Analítico detalhado". Preencher com: “3" | |
dataInicial | Data inicial do relatório. Preencher da seguinte forma: dmy Ex: 10102017 | |
dataFinal | Data final do relatório. Preencher da seguinte forma: dmy Ex: 25102018 | |
tipoApresentante | Informando este parâmetro, o serviço retornará apresentantes do tipo informado. Preencher com 1, 2, 3, 4, 5 ou 0.
|
X |
idApresentante | Recuperado através do serviço URL/apresentante ATENÇÃO : Ao informar o idApresentante o campo tipoApresentante deve ser preenchido com 0. |
X |
Reposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | { "_links": { "self": { "href": "http://df.teste.craapi.com.br/relatorio-remessa?visao=3&dataInicial=10102017& dataFinal=24102017&idApresentante=11&tipoApresentante=0" } }, "_embedded": { "relatorio_remessa": [ { "id": 1779552, "devedores": [ { "nome": "DEVEDOR XXXXXXXXXX", "tipoDocumento": "CNPJ", "documento": "00000000000000" } ], "retornos": [ { "id": 0000000, "dataApresentante": { "date": "2018-06-05 12:15:25.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataCartorio": { "date": "2017-10-16 16:22:40.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "ocorrencia": { "codigo": "1", "descricao": "Pago", "data": { "date": "2017-10-16 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" } }, "valor": "175.11", "saldo": "175.11", "protocolo": "8005774633", "dataProtocolo": { "date": "2017-10-16 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "nossoNumero": "109-00401605-2", "sequencial": "004893", "status": "LIBERADO" } ], "cartorio": { "id": 10, "nome": "1º Ofício de Protesto de Títulos da P21", "documento": "04364134000142", "uf": "DF", "tipo": "CARTORIO", "codigo": "67", "telefones": [ "6100000000", "6100000000" ], "fax": [ "6100000000" ], "emails": [ { "id": 14, "nome": "fake", "email": "fake@p21sistemas.com.br" } ], "municipio": { "id": 1, "nome": "Brasília", "codigo": "5300108" } }, "apresentante": { "id": 11, "nome": "Itaú", "codigo": "341" }, "protocolo": "8005774633", "dataProtocolo": { "date": "2017-10-16 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataRemessa": { "date": "2017-10-16 15:44:48.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataConfirmacao": { "date": "2017-10-16 15:49:20.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataVencimento": "05/10/2017", "valor": "175.11", "saldo": "175.11", "situacao": "RETORNADO", "numeroTitulo": "997462", "dataOcorrencia": null, "valorCra": "10.00", "_links": { "self": { "href": "http://df.teste.craapi.com.br/relatorio-remessa/1779552" } } } ] } "total_items": 1 } |
{ "_links": { "self": { "href": "http://df.teste.craapi.com.br/relatorio-remessa?visao=3&dataInicial=10102017& dataFinal=24102017&idApresentante=11&tipoApresentante=0" } }, "_embedded": { "relatorio_remessa": [ { "id": 1779552, "devedores": [ { "nome": "DEVEDOR XXXXXXXXXX", "tipoDocumento": "CNPJ", "documento": "00000000000000" } ], "retornos": [ { "id": 0000000, "dataApresentante": { "date": "2018-06-05 12:15:25.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataCartorio": { "date": "2017-10-16 16:22:40.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "ocorrencia": { "codigo": "1", "descricao": "Pago", "data": { "date": "2017-10-16 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" } }, "valor": "175.11", "saldo": "175.11", "protocolo": "8005774633", "dataProtocolo": { "date": "2017-10-16 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "nossoNumero": "109-00401605-2", "sequencial": "004893", "status": "LIBERADO" } ], "cartorio": { "id": 10, "nome": "1º Ofício de Protesto de Títulos da P21", "documento": "04364134000142", "uf": "DF", "tipo": "CARTORIO", "codigo": "67", "telefones": [ "6100000000", "6100000000" ], "fax": [ "6100000000" ], "emails": [ { "id": 14, "nome": "fake", "email": "fake@p21sistemas.com.br" } ], "municipio": { "id": 1, "nome": "Brasília", "codigo": "5300108" } }, "apresentante": { "id": 11, "nome": "Itaú", "codigo": "341" }, "protocolo": "8005774633", "dataProtocolo": { "date": "2017-10-16 00:00:00.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataRemessa": { "date": "2017-10-16 15:44:48.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataConfirmacao": { "date": "2017-10-16 15:49:20.000000", "timezone_type": 3, "timezone": "America/Sao_Paulo" }, "dataVencimento": "05/10/2017", "valor": "175.11", "saldo": "175.11", "situacao": "RETORNADO", "numeroTitulo": "997462", "dataOcorrencia": null, "valorCra": "10.00", "_links": { "self": { "href": "http://df.teste.craapi.com.br/relatorio-remessa/1779552" } } } ] } "total_items": 1 }
Campo | Descrição | Opcional |
/apresentantes | Recupera dados dos apresentantes. | |
/apresentantes/código apresentante | Recupera dados do apresentante informado. | X |
/apresentantes/?categoria=nomecategoria | Recupera dados do apresentante conforme a categoria informada. | X |
Resposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | { "id": 1048, "nome": "13ª Vara do Trabalho do Rio de Janeiro", "codigo": "G48", "documento": "12345678912345", "endereco": { "endereco": "Rua ", "bairro": "Centro", "cep": "99999999", "uf": "RJ", "cidade": "Rio de Janeiro" }, "telefones": [ "9999999999" ], "fax": [], "emails": "", "tipo": "CONVENIO", "tipoConvenio": "PUBLICO", "momentoCobranca": "CANCELAMENTO", "situacao": "ATIVO", "intimacao": "NAO", "categoria": { "id": 2, "nome": "Categoria 1" }, "_links": { "self": { "href": "http://rj.teste.craapi.com.br/apresentante/1042" } } } |
{ "id": 1048, "nome": "13ª Vara do Trabalho do Rio de Janeiro", "codigo": "G48", "documento": "12345678912345", "endereco": { "endereco": "Rua ", "bairro": "Centro", "cep": "99999999", "uf": "RJ", "cidade": "Rio de Janeiro" }, "telefones": [ "9999999999" ], "fax": [], "emails": "", "tipo": "CONVENIO", "tipoConvenio": "PUBLICO", "momentoCobranca": "CANCELAMENTO", "situacao": "ATIVO", "intimacao": "NAO", "categoria": { "id": 2, "nome": "Categoria 1" }, "_links": { "self": { "href": "http://rj.teste.craapi.com.br/apresentante/1042" } } }
Status | Título | Detalhes |
400 | Bad Request | Parâmetros de busca não informados |
400 | Bad Request | O status da remessa informado é inválido (0) |
400 | Bad Request | Informe o período |
400 | Bad Request | Parâmetros de busca inválidos. |
400 | Bad Request | Data final no formato invalido. Data: xx/xx/xxxx, Formato: dmY |
400 | Bad Request | Data inicial no formato invalido. Data: xx-xx-xxxx, Formato: dmY |
400 | Bad Request | Informe a data final |
400 | Bad Request | Informe a data inicial |
401 | Unauthorized | Unauthorized (Autenticação básica incorreta) |
401 | Unauthorized | Usuário sem permissão de acesso |
403 | Forbidden | Usuário ou senha incorretos, verifique os dados informados |