{ "info": { "_postman_id": "a6bf23ab-c4a6-4379-838b-0683bc3647a9", "name": "BankPlus.APIRestV3", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "46943735", "_collection_link": "https://go.postman.co/collection/46943735-a6bf23ab-c4a6-4379-838b-0683bc3647a9?source=collection_link" }, "item": [ { "name": "api", "item": [ { "name": "v3", "item": [ { "name": "Cobrancas", "item": [ { "name": "{id}", "item": [ { "name": "pdf", "item": [ { "name": "/api/v3/Cobrancas/:id/pdf", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:id/pdf", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":id", "pdf" ], "variable": [ { "key": "id", "value": "2813" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:id/pdf", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":id", "pdf" ], "variable": [ { "key": "id", "value": "2813" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "cancelar", "item": [ { "name": "/api/v3/Cobrancas/:id/cancelar", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:id/cancelar", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":id", "cancelar" ], "variable": [ { "key": "id", "value": "2813" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:id/cancelar", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":id", "cancelar" ], "variable": [ { "key": "id", "value": "2813" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "atualizar", "item": [ { "name": "/api/v3/Cobrancas/:id/atualizar", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dataDoVencimento\": \"2019-03-20T14:25:39.610Z\",\n \"valorDoDesconto\": 8500.967963910549,\n \"valorDeAbatimento\": 4214.228023412745,\n \"valorDeJuros\": 934.4025179239368,\n \"valorDeMulta\": 1382.9094203606096,\n \"status\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:id/atualizar", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":id", "atualizar" ], "variable": [ { "key": "id", "value": "2813" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"dataDoVencimento\": \"2019-03-20T14:25:39.610Z\",\n \"valorDoDesconto\": 8500.967963910549,\n \"valorDeAbatimento\": 4214.228023412745,\n \"valorDeJuros\": 934.4025179239368,\n \"valorDeMulta\": 1382.9094203606096,\n \"status\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:id/atualizar", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":id", "atualizar" ], "variable": [ { "key": "id", "value": "2813" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "/api/v3/Cobrancas/:id", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":id" ], "variable": [ { "key": "id", "value": "2813" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":id" ], "variable": [ { "key": "id", "value": "2813" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "avulso", "item": [ { "name": "Gera um boleto avulso, sem documento de origem no SAP", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/pdf" } ], "body": { "mode": "raw", "raw": "{\n \"gerarPdf\": true,\n \"boletoAvulso\": {\n \"parcelaId\": 9237,\n \"data\": \"1956-02-12T03:14:36.414Z\",\n \"statusId\": 6529,\n \"parceiroCodigo\": \"string\",\n \"parceiroNome\": \"string\",\n \"contratoId\": 7652,\n \"empresaId\": 888,\n \"dataVencimento\": \"1974-05-31T18:54:39.219Z\",\n \"valorDaParcela\": 3480.5455875682655,\n \"valoMulta\": 2518.5006122124255,\n \"jurosContratual\": 8278.144851231236,\n \"desconto\": 1449.117629213479,\n \"observacoes\": \"string\",\n \"nossoNumero\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/avulso", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", "avulso" ] }, "description": "Gera um boleto avulso, sem nota fiscal, adiantamento ou LCM de origem no SAP. A empresa é a de `boletoAvulso.empresaId`; não há código de empresa na rota.\n\n**Regras**\n- Campos obrigatórios em `boletoAvulso`: `contratoId`, `parceiroCodigo`, `parcelaId`, `dataVencimento` e `valorDaParcela`.\n- O contrato deve existir e estar ativo.\n- `gerarPdf` fica na raiz do body, fora de `boletoAvulso`.\n\n**Retornos**\n- `201` JSON: boleto gerado (`gerarPdf = false`).\n- `200` `application/pdf`: PDF do boleto (`gerarPdf = true`).\n- `400` texto simples (não é ProblemDetails):\n - `boletoAvulso` não enviado;\n - campo obrigatório de `boletoAvulso` ausente;\n - empresa ou contrato inexistente; contrato inativo;\n - falha na geração do boleto.\n- `422` ProblemDetails: boleto gerado, mas o PDF falhou. O `detail` traz o Id e o nosso número para consulta em `GET /api/v3/Cobrancas/{id}/pdf`." }, "response": [ { "name": "OK\n\n`application/pdf`: PDF do boleto gerado, quando `gerarPdf = true`.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/pdf" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"gerarPdf\": true,\n \"boletoAvulso\": {\n \"parcelaId\": 9237,\n \"data\": \"1956-02-12T03:14:36.414Z\",\n \"statusId\": 6529,\n \"parceiroCodigo\": \"string\",\n \"parceiroNome\": \"string\",\n \"contratoId\": 7652,\n \"empresaId\": 888,\n \"dataVencimento\": \"1974-05-31T18:54:39.219Z\",\n \"valorDaParcela\": 3480.5455875682655,\n \"valoMulta\": 2518.5006122124255,\n \"jurosContratual\": 8278.144851231236,\n \"desconto\": 1449.117629213479,\n \"observacoes\": \"string\",\n \"nossoNumero\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/avulso", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", "avulso" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/pdf" } ], "cookie": [], "body": "Arquivo PDF (conteúdo binário, Content-Type application/pdf)" }, { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"gerarPdf\": true,\n \"boletoAvulso\": {\n \"parcelaId\": 9237,\n \"data\": \"1956-02-12T03:14:36.414Z\",\n \"statusId\": 6529,\n \"parceiroCodigo\": \"string\",\n \"parceiroNome\": \"string\",\n \"contratoId\": 7652,\n \"empresaId\": 888,\n \"dataVencimento\": \"1974-05-31T18:54:39.219Z\",\n \"valorDaParcela\": 3480.5455875682655,\n \"valoMulta\": 2518.5006122124255,\n \"jurosContratual\": 8278.144851231236,\n \"desconto\": 1449.117629213479,\n \"observacoes\": \"string\",\n \"nossoNumero\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/avulso", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", "avulso" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"selecionado\": false,\n \"codigo\": 5149,\n \"nossoNumero\": \"string\",\n \"status\": 1696,\n \"statusEnum\": 5,\n \"situacao\": 3184,\n \"tipoDeDocumento\": 778,\n \"tipoDoObjetoDoSap\": 5304,\n \"tipoDeDocumentoEnum\": 203,\n \"documentoId\": 5130,\n \"parcelaId\": 9404,\n \"parceiroCodigo\": \"string\",\n \"parceiroNome\": \"string\",\n \"contratoId\": 3772,\n \"empresaId\": 7866,\n \"meioDePagamento\": \"string\",\n \"dataLancamento\": \"1993-12-23T17:49:59.212Z\",\n \"mesAnoReferencia\": \"string\",\n \"dataVencimento\": \"2001-07-06T02:36:29.490Z\",\n \"valorDaParcela\": 8387.714786539591,\n \"valorDeCorrecao\": 187.09395141296548,\n \"jurosContratual\": 4513.910582961455,\n \"jurosDeMoraDoContrato\": 4112.269088834331,\n \"multaContratual\": 9950.721865304644,\n \"valorDeAbatimento\": 6224.096344423172,\n \"desconto\": 5112.350703111478,\n \"multaPorAtraso\": 2506.6410603694167,\n \"jurosPorAtraso\": 5266.112558783622,\n \"outrasTaxas\": 448.4161457050939,\n \"valorDocumento\": 5371.903949726706,\n \"linhaDigitavel\": \"string\",\n \"serialDaNf\": \"string\",\n \"numeroDeControle\": \"string\",\n \"modalidadeId\": 3704,\n \"modalidadeEnum\": 7,\n \"observacoes\": \"string\",\n \"codigoDoContasReceber\": 4771,\n \"situacaoManual\": false,\n \"parcelasAgrupadas\": true,\n \"nrImpressao\": 4107,\n \"nrEmailEnviado\": 6448,\n \"nrBoletoEnviado\": 5862,\n \"nrDanfeEnviado\": 9307,\n \"nrXmlEnviado\": 8829,\n \"moedaDoBoleto\": \"string\",\n \"moedaEstrangeira\": true,\n \"boletoGeradoPor\": 6163,\n \"geradoPorEnum\": 0,\n \"boletoSalvoPeloServico\": true,\n \"impostoRetinoNoPagamento\": 2054.0328239818086,\n \"dataGeracaoBoleto\": \"2023-05-05T04:49:57.294Z\",\n \"projeto\": \"string\",\n \"uf\": \"string\",\n \"documentoSap\": {\n \"documentoId\": 4947,\n \"documentoTipo\": 5388,\n \"documentoTipoEnum\": 14,\n \"status\": \"string\",\n \"docStatusEnum\": 3,\n \"parcelas\": [\n {\n \"docEntry\": 9610,\n \"objType\": 4599,\n \"instlmntID\": 1970,\n \"status\": \"string\",\n \"docStatusEnum\": 3,\n \"insTotal\": 954.541590616308,\n \"paid\": 1632.6939275527452,\n \"dueDate\": \"2005-09-30T04:56:52.930Z\",\n \"camposDeUsuario\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\"\n },\n \"insTotalFC\": 2685.172360313245,\n \"paidFC\": 3867.3533154421116,\n \"paidToDate\": 3614.4555514736307,\n \"wtSum\": 8626.338176850893,\n \"instPrcnt\": 5137.407885832395,\n \"gerarBoleto\": \"string\",\n \"formaDePagamento\": \"string\",\n \"ehGerarBoleto\": true,\n \"parcelamentoCartao\": 9266,\n \"informacaoCobranca\": \"string\"\n },\n {\n \"docEntry\": 1259,\n \"objType\": 4986,\n \"instlmntID\": 6052,\n \"status\": \"string\",\n \"docStatusEnum\": 2,\n \"insTotal\": 5806.300332821821,\n \"paid\": 9208.560667571457,\n \"dueDate\": \"1992-10-11T18:55:15.976Z\",\n \"camposDeUsuario\": {\n \"key_0\": \"\"\n },\n \"insTotalFC\": 4737.2256597686,\n \"paidFC\": 6100.9080754200995,\n \"paidToDate\": 1846.0439250707595,\n \"wtSum\": 1315.7710112735765,\n \"instPrcnt\": 7135.330560971279,\n \"gerarBoleto\": \"string\",\n \"formaDePagamento\": \"string\",\n \"ehGerarBoleto\": false,\n \"parcelamentoCartao\": 3959,\n \"informacaoCobranca\": \"string\"\n }\n ],\n \"numeroDocumento\": 714,\n \"numeroSerial\": 6714,\n \"serie\": \"string\",\n \"modeloId\": 4784,\n \"sequenciaId\": 4869,\n \"nrParcelas\": 9718,\n \"numeroRefCliente\": \"string\",\n \"dataDoDocumento\": \"2019-01-05T05:50:49.173Z\",\n \"dataDoLancamento\": \"2016-04-02T23:56:30.548Z\",\n \"dataDeVencimento\": \"2020-02-11T06:23:19.974Z\",\n \"parceiroCodigo\": \"string\",\n \"parceiroNome\": \"string\",\n \"observacao\": \"string\",\n \"formaDePagamento\": \"string\",\n \"valorTotal\": 334.87457884696425,\n \"filialId\": 2462,\n \"cancelado\": \"string\",\n \"endereco\": \"string\",\n \"camposDeUsuario\": {\n \"key_0\": \"\"\n },\n \"statusBoletoServico\": 2745,\n \"statusBoleto\": 6887,\n \"statusDanfe\": 2786,\n \"statusDanfeEnum\": 0,\n \"statusXml\": 1040,\n \"statusXmlEnum\": 3,\n \"boletoSalvo\": 7993,\n \"nrTentativaGerarBoleto\": 615,\n \"danfeImpresso\": 1431,\n \"geracaoAutomaticaBoleto\": 3917,\n \"nrImpressaoNfeNfse\": 9476,\n \"projeto\": \"string\",\n \"valorTotalFc\": 2912.8850335391166,\n \"moedaCodigo\": \"string\",\n \"condicaoDePagamentoCodigo\": 9604,\n \"taxaMoeda\": 767.1401326840621,\n \"boletoGeradoPeloServico\": 9654,\n \"pagoAteData\": 2920.2787483585957,\n \"transacaoId\": 2351,\n \"descontoPercentual\": 4904.689209341565,\n \"tipoDeTransporte\": 5038,\n \"numeroDaRota\": \"string\",\n \"tipoDeItemServicoId\": \"string\",\n \"tipoDeItemServicoEnum\": 0,\n \"codigoVendendor\": 1757,\n \"impostoRetido\": 3556.3204563432714,\n \"consolidadorCodigo\": \"string\",\n \"consolidadorTipo\": \"string\",\n \"consolidadorNome\": \"string\",\n \"bloqueioDePagamento\": \"string\",\n \"ehBloqueioPagamento\": true,\n \"observacaoAbertura\": \"string\",\n \"observacaoEncerramento\": \"string\",\n \"pdfModelo2122Gerado\": true,\n \"numeroDaFatura\": \"string\",\n \"codigoDoEnderecoDeEntrega\": \"string\",\n \"linhas\": [\n {\n \"documentoId\": 4255,\n \"tipoDocumento\": 3410,\n \"linhaId\": 9072,\n \"status\": \"string\",\n \"itemCodigo\": \"string\",\n \"itemNome\": \"string\",\n \"siglaMoeda\": \"string\",\n \"quantidade\": 3875.012748925413,\n \"valorUnitario\": 2091.368775714928,\n \"valorTotal\": 152.607325893086\n },\n {\n \"documentoId\": 3517,\n \"tipoDocumento\": 3393,\n \"linhaId\": 4381,\n \"status\": \"string\",\n \"itemCodigo\": \"string\",\n \"itemNome\": \"string\",\n \"siglaMoeda\": \"string\",\n \"quantidade\": 7715.845208242389,\n \"valorUnitario\": 9289.440152206098,\n \"valorTotal\": 5347.345932509481\n }\n ],\n \"anexoId\": 1487,\n \"contaControle\": \"string\",\n \"numeroNfeNfse\": \"string\",\n \"valorTotalMax\": 9423.110640416302\n },\n \"parcelas\": [\n {\n \"id\": 4231,\n \"boletoId\": 3922,\n \"documentoId\": 6127,\n \"tipoDocumento\": 5658,\n \"serialNota\": \"string\",\n \"parcela\": 9194,\n \"valorDaParcela\": 8352.085043341876,\n \"valorDoDesconto\": 1999.295019634505,\n \"valorDoDocumento\": 7411.463751139491,\n \"valorDeJuros\": 566.9944226894307,\n \"valorImpostoRetidoPagamento\": 9388.087043692223,\n \"empresaId\": 1945,\n \"status\": 4585,\n \"statusEnum\": 6,\n \"filialId\": 8421,\n \"numeroNfse\": \"string\",\n \"chaveAcesso\": \"string\",\n \"dataEmissao\": \"2013-09-01T18:22:30.412Z\",\n \"valorNota\": 6422.1373250095985,\n \"valorDeMulta\": 6476.364033238899,\n \"tipoDocumentoNome\": \"string\",\n \"tipoDoObjetoDoSap\": 3045,\n \"tipoDeDocumentoEnum\": 30\n },\n {\n \"id\": 2293,\n \"boletoId\": 8569,\n \"documentoId\": 2698,\n \"tipoDocumento\": 7332,\n \"serialNota\": \"string\",\n \"parcela\": 5613,\n \"valorDaParcela\": 3930.2893245403047,\n \"valorDoDesconto\": 2802.193268059313,\n \"valorDoDocumento\": 864.7366303726689,\n \"valorDeJuros\": 761.0959036650988,\n \"valorImpostoRetidoPagamento\": 991.4770621138603,\n \"empresaId\": 5644,\n \"status\": 1479,\n \"statusEnum\": 15,\n \"filialId\": 9521,\n \"numeroNfse\": \"string\",\n \"chaveAcesso\": \"string\",\n \"dataEmissao\": \"1968-04-06T22:59:41.407Z\",\n \"valorNota\": 7455.706223252279,\n \"valorDeMulta\": 6500.142090795013,\n \"tipoDocumentoNome\": \"string\",\n \"tipoDoObjetoDoSap\": 4681,\n \"tipoDeDocumentoEnum\": 203\n }\n ],\n \"parceiroNomeFantasia\": \"string\",\n \"linhaDigitavelRecalculada\": false,\n \"historicos\": [\n {\n \"id\": 3588,\n \"boletoId\": 1941,\n \"status\": 4414,\n \"statusEnum\": 14,\n \"statusNome\": \"string\",\n \"situacao\": 1126,\n \"situacaoDescricao\": \"string\",\n \"mensagem\": \"string\",\n \"obervacao\": \"string\",\n \"usuario\": \"string\",\n \"data\": \"1950-01-25T06:21:12.786Z\",\n \"tipoDocumento\": 6257,\n \"docContasReceber\": 5927,\n \"empresaId\": 5175,\n \"empresaDescricao\": \"string\",\n \"dataDeEnvio\": \"2022-08-29T10:04:11.158Z\",\n \"tipoDeAmbiente\": 5548,\n \"templateId\": 8240,\n \"erroEnvioEmailTemplate\": false,\n \"ocorrenciaBanco\": \"string\",\n \"tipoDeAmbienteEnum\": 2,\n \"tipoDeAmbienteNome\": \"string\",\n \"jsonEnviadoNaApi\": \"string\",\n \"jsonRetornoApi\": \"string\"\n },\n {\n \"id\": 2416,\n \"boletoId\": 4018,\n \"status\": 8714,\n \"statusEnum\": 7,\n \"statusNome\": \"string\",\n \"situacao\": 1700,\n \"situacaoDescricao\": \"string\",\n \"mensagem\": \"string\",\n \"obervacao\": \"string\",\n \"usuario\": \"string\",\n \"data\": \"1963-04-27T14:21:22.317Z\",\n \"tipoDocumento\": 3476,\n \"docContasReceber\": 9933,\n \"empresaId\": 7154,\n \"empresaDescricao\": \"string\",\n \"dataDeEnvio\": \"1965-08-18T09:54:14.669Z\",\n \"tipoDeAmbiente\": 7935,\n \"templateId\": 8303,\n \"erroEnvioEmailTemplate\": false,\n \"ocorrenciaBanco\": \"string\",\n \"tipoDeAmbienteEnum\": 2,\n \"tipoDeAmbienteNome\": \"string\",\n \"jsonEnviadoNaApi\": \"string\",\n \"jsonRetornoApi\": \"string\"\n }\n ],\n \"dataDeEnvio\": \"1964-07-17T07:32:28.552Z\",\n \"codigoDoAdiantamento\": 3291,\n \"erroAoEnviarEmail\": true,\n \"numeroNfse\": \"string\",\n \"chaveAcesso\": \"string\",\n \"dataEmissao\": \"2012-05-11T21:42:17.517Z\",\n \"valorNota\": 9892.494062833039,\n \"tipoDeAmbiente\": 1,\n \"desconto2\": 475.89581196880835,\n \"desconto3\": 4401.766452383091,\n \"erroAoEnviarRemessa\": true,\n \"mensagemErroRemessa\": \"string\",\n \"dataDoPagamento\": \"1962-08-09T05:47:09.432Z\",\n \"queryNfse\": \"string\",\n \"descontoFinanceiro\": 9071.163662866822,\n \"qrCodePix\": \"string\",\n \"linkUrlPix\": \"string\",\n \"txIdPix\": \"string\",\n \"diasDeAtraso\": 5076,\n \"empresaIdDocumento\": 5290,\n \"motivoAlteracao\": \"string\",\n \"ehNotaFiscalTipoServico\": false,\n \"tipoCobranca\": 7024,\n \"tipoCobrancaEnum\": 1,\n \"erroProcessamentoOnLine\": \"string\",\n \"condicaoDePagamentoCodigo\": 283,\n \"ufCobranca\": \"string\",\n \"codigoMunicipioCobranca\": \"string\",\n \"informacoesParcelas\": \"string\",\n \"valorBrutoParcelas\": 2472.9615451104683,\n \"beneficiarioFinalCodigo\": \"string\",\n \"beneficiarioFinalNome\": \"string\",\n \"dataProtesto\": \"1985-05-07T06:18:44.286Z\",\n \"parcelamentoCartao\": 7897,\n \"dataEnvioRecorrente\": \"1994-04-29T21:20:13.004Z\",\n \"inscricaoParceiro\": \"string\",\n \"contrato\": \"string\",\n \"empresa\": \"string\",\n \"statusNome\": \"string\",\n \"situacaoNome\": \"string\",\n \"tipoCobrancaNome\": \"string\",\n \"projetoNome\": \"string\",\n \"tipoDocumentoNome\": \"string\",\n \"modalidadeNome\": \"string\",\n \"boletoGeradoPorNome\": \"string\",\n \"ufCobrancaNome\": \"string\",\n \"municipioCobranca\": \"string\",\n \"informacaoCobranca\": \"string\",\n \"observacaoAbertura\": \"string\",\n \"observacaoEncerramento\": \"string\",\n \"jsonEnviadoNaApi\": \"string\",\n \"taxaMoeda\": 9212.816969753103,\n \"numeroDaFatura\": \"string\",\n \"jsonRetornoApi\": \"string\",\n \"dataDocumento\": \"2009-06-10T05:31:23.060Z\",\n \"nossoNumeroCorrespondente\": \"string\",\n \"despesaCartorio\": 8992.310191577644,\n \"codigoLcmDespesasCartorio\": 8670,\n \"empresaDescricao\": \"string\",\n \"boletoRenegociacao\": true,\n \"boletoRenegociacaoAlternativa\": false,\n \"modeloDaNota\": 772,\n \"codigoModeloDaNota\": \"string\",\n \"ultimaOcorrenciaErroEnvioEmail\": \"string\",\n \"codigoRetorno\": 5632,\n \"chaveBoletoApi\": \"string\",\n \"dataCredito\": \"2000-01-19T05:50:09.268Z\",\n \"valorPago\": 7607.82818151907,\n \"valorJurosPago\": 8773.497324992732,\n \"valorMultaPaga\": 9384.549031451774,\n \"valorDescontoConcedido\": 3583.985985417657,\n \"valorAbatimentoConcedido\": 533.0151836884156,\n \"taxaBancaria\": 5947.5533993421,\n \"contaVinculadaRetorno\": \"string\",\n \"dataOcorrencia\": \"2024-01-20T01:41:54.764Z\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"gerarPdf\": true,\n \"boletoAvulso\": {\n \"parcelaId\": 9237,\n \"data\": \"1956-02-12T03:14:36.414Z\",\n \"statusId\": 6529,\n \"parceiroCodigo\": \"string\",\n \"parceiroNome\": \"string\",\n \"contratoId\": 7652,\n \"empresaId\": 888,\n \"dataVencimento\": \"1974-05-31T18:54:39.219Z\",\n \"valorDaParcela\": 3480.5455875682655,\n \"valoMulta\": 2518.5006122124255,\n \"jurosContratual\": 8278.144851231236,\n \"desconto\": 1449.117629213479,\n \"observacoes\": \"string\",\n \"nossoNumero\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/avulso", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", "avulso" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "Nenhum boleto avulso enviado na requisição" }, { "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"gerarPdf\": true,\n \"boletoAvulso\": {\n \"parcelaId\": 9237,\n \"data\": \"1956-02-12T03:14:36.414Z\",\n \"statusId\": 6529,\n \"parceiroCodigo\": \"string\",\n \"parceiroNome\": \"string\",\n \"contratoId\": 7652,\n \"empresaId\": 888,\n \"dataVencimento\": \"1974-05-31T18:54:39.219Z\",\n \"valorDaParcela\": 3480.5455875682655,\n \"valoMulta\": 2518.5006122124255,\n \"jurosContratual\": 8278.144851231236,\n \"desconto\": 1449.117629213479,\n \"observacoes\": \"string\",\n \"nossoNumero\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/avulso", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", "avulso" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"UnprocessableEntity\",\n \"status\": 422,\n \"detail\": \"Boleto(s) gerado(s), mas não foi possível gerar o PDF. Ids [2060], nosso(s) número(s) [000020540]. Consulte o PDF por GET /api/v3/Cobrancas/{id}/pdf\",\n \"instance\": \"/api/v3/Cobrancas/avulso\"\n}" } ] } ] }, { "name": "{codigoDaEmpresa}", "item": [ { "name": "agrupado", "item": [ { "name": "Gera um único boleto agrupando 2 ou mais parcelas", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" } ], "body": { "mode": "raw", "raw": "[\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 2,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"adiantamento\",\n \"numeroDaNota\": 4120,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"lcm\",\n \"numeroDaNota\": 0,\n \"numeroDoDocumento\": 52310,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:codigoDaEmpresa/agrupado", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":codigoDaEmpresa", "agrupado" ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" } ] }, "description": "Gera **um único boleto** com 2 ou mais parcelas distintas. A operação é tudo ou nada: se uma parcela for inválida, nenhum boleto é gerado. Para gerar um boleto por parcela, use `POST /api/v3/Cobrancas/{codigoDaEmpresa}/individual`.\n\n**Identificação da parcela**\n\n| tipoDeDocumento | Documento | Parcela |\n| --- | --- | --- |\n| `notafiscal` | `numeroDaNota` (DocEntry da OINV) | `numeroDaParcela` ≥ 1 |\n| `adiantamento` | `numeroDaNota` (DocEntry da ODPI) | `numeroDaParcela` ≥ 1 |\n| `lcm` | `numeroDoDocumento` (TransId da OJDT) | `numeroDaParcela` ≥ 0 |\n\n**Regras da requisição**\n- `empresaId` no body é opcional; se informado, deve ser igual ao código da empresa da rota.\n- `gerarPdf` deve ter o mesmo valor em todos os itens.\n- Contrato: `contratoId` tem prioridade e deve ser o mesmo em todos os itens. Sem `contratoId`, o contrato é obtido pela `formaDePagamento`, que também deve ser a mesma em todos os itens. Sem nenhum dos dois, o contrato vem da forma de pagamento do documento no SAP e, se o documento não tiver forma de pagamento, do parâmetro \"NF sem forma de pagamento usar:\" da empresa.\n- O contrato informado em `contratoId` ou obtido pela `formaDePagamento` do body é validado antes da geração: deve existir, estar ativo e estar vinculado à empresa.\n\n**Retornos**\n- `200` JSON: lista com o boleto agrupado gerado (`gerarPdf = false`). No boleto agrupado, `notaFiscal` vem `0` e `numeroDaParcela` vem `-1`.\n- `200` `application/pdf`: PDF do boleto (`gerarPdf = true`).\n- `400` ProblemDetails, motivo no `detail` (vários erros vêm juntos, separados por ` | `):\n - requisição: menos de 2 parcelas distintas; lista vazia; JSON inválido; parcela informada mais de uma vez; `empresaId` do body diferente da rota; `gerarPdf` diferente entre os itens; `contratoId` diferente entre os itens; `formaDePagamento` diferente entre os itens (quando não há `contratoId`);\n - item: campo obrigatório ausente, com o nome do campo; `tipoDeDocumento` fora de `notafiscal`, `adiantamento`, `lcm`; `numeroDaParcela` menor que 1 (`notafiscal`, `adiantamento`) ou menor que 0 (`lcm`);\n - cadastro: empresa inexistente; contrato inexistente, inativo ou não vinculado à empresa; `formaDePagamento` sem contrato ou com mais de um contrato;\n - parcela: parcela que já possui boleto ativo, com o nosso número e o Id; parcela não encontrada ou indisponível para geração; erro de geração devolvido pelo BankPlus.\n- `422` ProblemDetails: boleto gerado, mas o PDF falhou. O `detail` traz o Id e o nosso número para consulta em `GET /api/v3/Cobrancas/{id}/pdf`." }, "response": [ { "name": "OK\n\n`application/pdf`: PDF do boleto agrupado, quando `gerarPdf = true`. Com `gerarPdf = false`, o retorno é o JSON.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 2,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"adiantamento\",\n \"numeroDaNota\": 4120,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"lcm\",\n \"numeroDaNota\": 0,\n \"numeroDoDocumento\": 52310,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:codigoDaEmpresa/agrupado", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":codigoDaEmpresa", "agrupado" ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 2064,\n \"nossoNumero\": \"000020544\",\n \"notaFiscal\": 0,\n \"numeroDaParcela\": -1,\n \"tipoDeDocumento\": \"notafiscal\",\n \"codigoDoParceiro\": \"C000434\",\n \"nomeDoParceiro\": \"Cliente Exemplo\",\n \"valorDoBoleto\": 12176.24,\n \"dataDoVencimento\": \"2026-10-26T00:00:00\",\n \"valorDoDesconto\": 0,\n \"valorDeAbatimento\": 0,\n \"valorDeJuros\": 0,\n \"valorDeMulta\": 0,\n \"linhaDigitavel\": \"34191.09008 00205.441246 54451.810003 6 15490001217624\",\n \"statusId\": 1,\n \"situacaoId\": 0,\n \"statusDescricao\": \"Gerado\",\n \"tipoCobranca\": \"Boleto\",\n \"dataDoDocumento\": \"2026-09-28T00:00:00\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 2,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"adiantamento\",\n \"numeroDaNota\": 4120,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"lcm\",\n \"numeroDaNota\": 0,\n \"numeroDoDocumento\": 52310,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:codigoDaEmpresa/agrupado", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":codigoDaEmpresa", "agrupado" ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"Solicitação inválida\",\n \"status\": 400,\n \"detail\": \"O endpoint agrupado exige 2 ou mais parcelas distintas. Para gerar o boleto de uma parcela, utilize POST /api/v3/Cobrancas/{codigoDaEmpresa}/individual\",\n \"instance\": \"/api/v3/Cobrancas/12/agrupado\"\n}" }, { "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 2,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"adiantamento\",\n \"numeroDaNota\": 4120,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"lcm\",\n \"numeroDaNota\": 0,\n \"numeroDoDocumento\": 52310,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:codigoDaEmpresa/agrupado", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":codigoDaEmpresa", "agrupado" ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"UnprocessableEntity\",\n \"status\": 422,\n \"detail\": \"Boleto(s) gerado(s), mas não foi possível gerar o PDF. Ids [2060], nosso(s) número(s) [000020540]. Consulte o PDF por GET /api/v3/Cobrancas/{id}/pdf\",\n \"instance\": \"/api/v3/Cobrancas/12/agrupado\"\n}" } ] } ] }, { "name": "individual", "item": [ { "name": "Gera um boleto por parcela, sem agrupamento", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/pdf" } ], "body": { "mode": "raw", "raw": "[\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 2,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"adiantamento\",\n \"numeroDaNota\": 4120,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"lcm\",\n \"numeroDaNota\": 0,\n \"numeroDoDocumento\": 52310,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:codigoDaEmpresa/individual", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":codigoDaEmpresa", "individual" ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" } ] }, "description": "Gera **um boleto para cada parcela** informada, sem agrupamento. Cada item da lista é uma parcela. Se uma parcela falhar, as demais são geradas, e o retorno traz o resultado de cada item na mesma ordem da requisição.\n\n**Identificação da parcela**\n\n| tipoDeDocumento | Documento | Parcela |\n| --- | --- | --- |\n| `notafiscal` | `numeroDaNota` (DocEntry da OINV) | `numeroDaParcela` ≥ 1 |\n| `adiantamento` | `numeroDaNota` (DocEntry da ODPI) | `numeroDaParcela` ≥ 1 |\n| `lcm` | `numeroDoDocumento` (TransId da OJDT) | `numeroDaParcela` ≥ 0 |\n\n**Regras da requisição**\n- `empresaId` no body é opcional; se informado, deve ser igual ao código da empresa da rota.\n- `gerarPdf` deve ter o mesmo valor em todos os itens.\n- Contrato: `contratoId` tem prioridade e deve ser o mesmo em todos os itens. Sem `contratoId`, o contrato é obtido pela `formaDePagamento`, que também deve ser a mesma em todos os itens. Sem nenhum dos dois, o contrato vem da forma de pagamento do documento no SAP e, se o documento não tiver forma de pagamento, do parâmetro \"NF sem forma de pagamento usar:\" da empresa.\n- O contrato informado em `contratoId` ou obtido pela `formaDePagamento` do body é validado antes da geração: deve existir, estar ativo e estar vinculado à empresa.\n\n**Resultado por item**: cada item da lista de resultados traz a identificação da parcela, `sucesso`, `mensagem` e, quando gerado, `boleto`.\n\n**Retornos**\n- Todas as parcelas geradas:\n - `201` JSON (`gerarPdf = false`): lista de resultados com o boleto de cada parcela;\n - `200` `application/pdf` (`gerarPdf = true`): PDF dos boletos.\n- Parte das parcelas gerada: `207` JSON com a lista de resultados. Mesmo com `gerarPdf = true` o retorno é JSON; o PDF dos boletos gerados sai em `GET /api/v3/Cobrancas/{id}/pdf`.\n- Nenhuma parcela gerada: `400` JSON com a lista de resultados. Motivos por item:\n - campo obrigatório ausente, com o nome do campo; `tipoDeDocumento` fora de `notafiscal`, `adiantamento`, `lcm`; `numeroDaParcela` menor que 1 (`notafiscal`, `adiantamento`) ou menor que 0 (`lcm`);\n - parcela que já possui boleto ativo, com o nosso número e o Id; parcela não encontrada ou indisponível para geração; erro de geração devolvido pelo BankPlus.\n- Requisição rejeitada como um todo: `400` ProblemDetails, motivo no `detail`:\n - requisição: lista vazia; JSON inválido; parcela informada mais de uma vez; `empresaId` do body diferente da rota; `gerarPdf` diferente entre os itens; `contratoId` diferente entre os itens; `formaDePagamento` diferente entre os itens (quando não há `contratoId`);\n - cadastro: empresa inexistente; contrato inexistente, inativo ou não vinculado à empresa; `formaDePagamento` sem contrato ou com mais de um contrato.\n- `422` ProblemDetails: boletos gerados, mas o PDF falhou. O `detail` traz os Ids e os nossos números para consulta em `GET /api/v3/Cobrancas/{id}/pdf`." }, "response": [ { "name": "OK\n\n`application/pdf`: PDF dos boletos, quando todas as parcelas são geradas e `gerarPdf = true`.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/pdf" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 2,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"adiantamento\",\n \"numeroDaNota\": 4120,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"lcm\",\n \"numeroDaNota\": 0,\n \"numeroDoDocumento\": 52310,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:codigoDaEmpresa/individual", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":codigoDaEmpresa", "individual" ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/pdf" } ], "cookie": [], "body": "Arquivo PDF (conteúdo binário, Content-Type application/pdf)" }, { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 2,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"adiantamento\",\n \"numeroDaNota\": 4120,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"lcm\",\n \"numeroDaNota\": 0,\n \"numeroDoDocumento\": 52310,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:codigoDaEmpresa/individual", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":codigoDaEmpresa", "individual" ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"sucesso\": true,\n \"mensagem\": \"Boleto de nosso número [000020540] gerado com sucesso\",\n \"boleto\": {\n \"id\": 2060,\n \"nossoNumero\": \"000020540\",\n \"notaFiscal\": 763574,\n \"numeroDaParcela\": 1,\n \"tipoDeDocumento\": \"notafiscal\",\n \"codigoDoParceiro\": \"C000434\",\n \"nomeDoParceiro\": \"Cliente Exemplo\",\n \"valorDoBoleto\": 6088.12,\n \"dataDoVencimento\": \"2026-10-26T00:00:00\",\n \"valorDoDesconto\": 0,\n \"valorDeAbatimento\": 0,\n \"valorDeJuros\": 0,\n \"valorDeMulta\": 0,\n \"linhaDigitavel\": \"34191.09008 00205.391246 54451.810003 5 15490000608812\",\n \"statusId\": 1,\n \"situacaoId\": 0,\n \"statusDescricao\": \"Gerado\",\n \"tipoCobranca\": \"Boleto\",\n \"dataDoDocumento\": \"2026-09-28T00:00:00\"\n }\n },\n {\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 2,\n \"sucesso\": true,\n \"mensagem\": \"Boleto de nosso número [000020541] gerado com sucesso\",\n \"boleto\": {\n \"id\": 2061,\n \"nossoNumero\": \"000020541\",\n \"notaFiscal\": 763574,\n \"numeroDaParcela\": 2,\n \"tipoDeDocumento\": \"notafiscal\",\n \"codigoDoParceiro\": \"C000434\",\n \"nomeDoParceiro\": \"Cliente Exemplo\",\n \"valorDoBoleto\": 6088.12,\n \"dataDoVencimento\": \"2026-11-26T00:00:00\",\n \"valorDoDesconto\": 0,\n \"valorDeAbatimento\": 0,\n \"valorDeJuros\": 0,\n \"valorDeMulta\": 0,\n \"linhaDigitavel\": \"34191.09008 00205.391246 54451.810003 5 15490000608812\",\n \"statusId\": 1,\n \"situacaoId\": 0,\n \"statusDescricao\": \"Gerado\",\n \"tipoCobranca\": \"Boleto\",\n \"dataDoDocumento\": \"2026-09-28T00:00:00\"\n }\n },\n {\n \"tipoDeDocumento\": \"adiantamento\",\n \"numeroDaNota\": 4120,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"sucesso\": true,\n \"mensagem\": \"Boleto de nosso número [000020542] gerado com sucesso\",\n \"boleto\": {\n \"id\": 2062,\n \"nossoNumero\": \"000020542\",\n \"notaFiscal\": 4120,\n \"numeroDaParcela\": 1,\n \"tipoDeDocumento\": \"adiantamento\",\n \"codigoDoParceiro\": \"C000434\",\n \"nomeDoParceiro\": \"Cliente Exemplo\",\n \"valorDoBoleto\": 6088.12,\n \"dataDoVencimento\": \"2026-10-26T00:00:00\",\n \"valorDoDesconto\": 0,\n \"valorDeAbatimento\": 0,\n \"valorDeJuros\": 0,\n \"valorDeMulta\": 0,\n \"linhaDigitavel\": \"34191.09008 00205.391246 54451.810003 5 15490000608812\",\n \"statusId\": 1,\n \"situacaoId\": 0,\n \"statusDescricao\": \"Gerado\",\n \"tipoCobranca\": \"Boleto\",\n \"dataDoDocumento\": \"2026-09-28T00:00:00\"\n }\n },\n {\n \"tipoDeDocumento\": \"lcm\",\n \"numeroDaNota\": 0,\n \"numeroDoDocumento\": 52310,\n \"numeroDaParcela\": 1,\n \"sucesso\": true,\n \"mensagem\": \"Boleto de nosso número [000020543] gerado com sucesso\",\n \"boleto\": {\n \"id\": 2063,\n \"nossoNumero\": \"000020543\",\n \"notaFiscal\": 52310,\n \"numeroDaParcela\": 1,\n \"tipoDeDocumento\": \"lcm\",\n \"codigoDoParceiro\": \"C000434\",\n \"nomeDoParceiro\": \"Cliente Exemplo\",\n \"valorDoBoleto\": 6088.12,\n \"dataDoVencimento\": \"2026-10-26T00:00:00\",\n \"valorDoDesconto\": 0,\n \"valorDeAbatimento\": 0,\n \"valorDeJuros\": 0,\n \"valorDeMulta\": 0,\n \"linhaDigitavel\": \"34191.09008 00205.391246 54451.810003 5 15490000608812\",\n \"statusId\": 1,\n \"situacaoId\": 0,\n \"statusDescricao\": \"Gerado\",\n \"tipoCobranca\": \"Boleto\",\n \"dataDoDocumento\": \"2026-09-28T00:00:00\"\n }\n }\n]" }, { "name": "Multi-Status", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 2,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"adiantamento\",\n \"numeroDaNota\": 4120,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"lcm\",\n \"numeroDaNota\": 0,\n \"numeroDoDocumento\": 52310,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:codigoDaEmpresa/individual", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":codigoDaEmpresa", "individual" ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" } ] } }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"sucesso\": true,\n \"mensagem\": \"Boleto de nosso número [000020540] gerado com sucesso\",\n \"boleto\": {\n \"id\": 2060,\n \"nossoNumero\": \"000020540\",\n \"notaFiscal\": 763574,\n \"numeroDaParcela\": 1,\n \"tipoDeDocumento\": \"notafiscal\",\n \"codigoDoParceiro\": \"C000434\",\n \"nomeDoParceiro\": \"Cliente Exemplo\",\n \"valorDoBoleto\": 6088.12,\n \"dataDoVencimento\": \"2026-10-26T00:00:00\",\n \"valorDoDesconto\": 0,\n \"valorDeAbatimento\": 0,\n \"valorDeJuros\": 0,\n \"valorDeMulta\": 0,\n \"linhaDigitavel\": \"34191.09008 00205.391246 54451.810003 5 15490000608812\",\n \"statusId\": 1,\n \"situacaoId\": 0,\n \"statusDescricao\": \"Gerado\",\n \"tipoCobranca\": \"Boleto\",\n \"dataDoDocumento\": \"2026-09-28T00:00:00\"\n }\n },\n {\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 2,\n \"sucesso\": false,\n \"mensagem\": \"A parcela [2] do documento [763574] do tipo [notafiscal] já possui boleto ativo de nosso número [000020539] e Id [2053]\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 2,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"adiantamento\",\n \"numeroDaNota\": 4120,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"lcm\",\n \"numeroDaNota\": 0,\n \"numeroDoDocumento\": 52310,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:codigoDaEmpresa/individual", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":codigoDaEmpresa", "individual" ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"sucesso\": false,\n \"mensagem\": \"A parcela [1] do documento [763574] do tipo [notafiscal] não foi encontrada ou não está disponível para geração de boleto na empresa [12 - Empresa Exemplo]\"\n },\n {\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 3,\n \"sucesso\": false,\n \"mensagem\": \"O campo numeroDaParcela é obrigatório e deve ser maior ou igual a 1 para o tipoDeDocumento [notafiscal]\"\n }\n]" }, { "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"notafiscal\",\n \"numeroDaNota\": 763574,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 2,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"adiantamento\",\n \"numeroDaNota\": 4120,\n \"numeroDoDocumento\": 0,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n },\n {\n \"empresaId\": 12,\n \"tipoDeDocumento\": \"lcm\",\n \"numeroDaNota\": 0,\n \"numeroDoDocumento\": 52310,\n \"numeroDaParcela\": 1,\n \"gerarPdf\": false,\n \"contratoId\": 11,\n \"formaDePagamento\": \"Bol-Bradesco\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas/:codigoDaEmpresa/individual", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas", ":codigoDaEmpresa", "individual" ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"UnprocessableEntity\",\n \"status\": 422,\n \"detail\": \"Boleto(s) gerado(s), mas não foi possível gerar o PDF. Ids [2060], nosso(s) número(s) [000020540]. Consulte o PDF por GET /api/v3/Cobrancas/{id}/pdf\",\n \"instance\": \"/api/v3/Cobrancas/12/individual\"\n}" } ] } ] } ] }, { "name": "/api/v3/Cobrancas", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas?EmpresaIds=5707&EmpresaIds=1067&LimitarLinha=2813&PularLinhas=2813&ParceiroCodigo=string&ContratoId=2813&ParcelaId=2813&VencimentoInicio=1947-10-17T03:52:23.290Z&VencimentoFinal=1947-10-17T03:52:23.290Z&StatusIds=5707&StatusIds=1067&DataDoPagamentoInicio=1947-10-17T03:52:23.290Z&DataDoPagamentoFinal=1947-10-17T03:52:23.290Z&TipoOrdenacao=1&DocumentosIds=5707&DocumentosIds=1067&InscricaoParceiro=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas" ], "query": [ { "key": "EmpresaIds", "value": "5707" }, { "key": "EmpresaIds", "value": "1067" }, { "key": "LimitarLinha", "value": "2813" }, { "key": "PularLinhas", "value": "2813" }, { "key": "ParceiroCodigo", "value": "string" }, { "key": "ContratoId", "value": "2813" }, { "key": "ParcelaId", "value": "2813" }, { "key": "VencimentoInicio", "value": "1947-10-17T03:52:23.290Z" }, { "key": "VencimentoFinal", "value": "1947-10-17T03:52:23.290Z" }, { "key": "StatusIds", "value": "5707" }, { "key": "StatusIds", "value": "1067" }, { "key": "DataDoPagamentoInicio", "value": "1947-10-17T03:52:23.290Z" }, { "key": "DataDoPagamentoFinal", "value": "1947-10-17T03:52:23.290Z" }, { "key": "TipoOrdenacao", "value": "1" }, { "key": "DocumentosIds", "value": "5707" }, { "key": "DocumentosIds", "value": "1067" }, { "key": "InscricaoParceiro", "value": "string" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v3/Cobrancas?EmpresaIds=1067&LimitarLinha=2813&PularLinhas=2813&ParceiroCodigo=string&ContratoId=2813&ParcelaId=2813&VencimentoInicio=1947-10-17T03:52:23.290Z&VencimentoFinal=1947-10-17T03:52:23.290Z&StatusIds=1067&DataDoPagamentoInicio=1947-10-17T03:52:23.290Z&DataDoPagamentoFinal=1947-10-17T03:52:23.290Z&TipoOrdenacao=1&DocumentosIds=1067&InscricaoParceiro=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Cobrancas" ], "query": [ { "key": "EmpresaIds", "value": "1067" }, { "key": "LimitarLinha", "value": "2813" }, { "key": "PularLinhas", "value": "2813" }, { "key": "ParceiroCodigo", "value": "string" }, { "key": "ContratoId", "value": "2813" }, { "key": "ParcelaId", "value": "2813" }, { "key": "VencimentoInicio", "value": "1947-10-17T03:52:23.290Z" }, { "key": "VencimentoFinal", "value": "1947-10-17T03:52:23.290Z" }, { "key": "StatusIds", "value": "1067" }, { "key": "DataDoPagamentoInicio", "value": "1947-10-17T03:52:23.290Z" }, { "key": "DataDoPagamentoFinal", "value": "1947-10-17T03:52:23.290Z" }, { "key": "TipoOrdenacao", "value": "1" }, { "key": "DocumentosIds", "value": "1067" }, { "key": "InscricaoParceiro", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Empresas", "item": [ { "name": "{id}", "item": [ { "name": "/api/v3/Empresas/:id", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/Empresas/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Empresas", ":id" ], "variable": [ { "key": "id", "value": "2813" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v3/Empresas/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Empresas", ":id" ], "variable": [ { "key": "id", "value": "2813" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "/api/v3/Empresas", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/Empresas?Codigos=5707&Codigos=1067&CodigosDeFilial=5707&CodigosDeFilial=1067", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Empresas" ], "query": [ { "key": "Codigos", "value": "5707" }, { "key": "Codigos", "value": "1067" }, { "key": "CodigosDeFilial", "value": "5707" }, { "key": "CodigosDeFilial", "value": "1067" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v3/Empresas?Codigos=1067&CodigosDeFilial=1067", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Empresas" ], "query": [ { "key": "Codigos", "value": "1067" }, { "key": "CodigosDeFilial", "value": "1067" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Login", "item": [ { "name": "login", "item": [ { "name": "/api/v3/Login/login", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"clientId\": \"string\",\n \"clientSecret\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Login/login", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Login", "login" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"clientId\": \"string\",\n \"clientSecret\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Login/login", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Login", "login" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "Pagamento", "item": [ { "name": "{usuarioAprovador}", "item": [ { "name": "aprovar", "item": [ { "name": "/api/v3/Pagamento/:usuarioAprovador/aprovar", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"codigoChave\": 6622,\n \"numero\": \"string\",\n \"origemPag\": \"string\",\n \"contratoOrigem\": \"string\",\n \"contratoDestino\": \"string\",\n \"bancoOrigem\": \"string\",\n \"agenciaOrigem\": \"string\",\n \"contaOrigem\": \"string\",\n \"status\": \"string\",\n \"situacao\": \"string\",\n \"assinaturas\": 7632,\n \"dataGeracao\": \"1970-05-08T16:33:01.457Z\",\n \"dataLancamento\": \"1983-02-08T22:47:41.276Z\",\n \"dataVencimento\": \"1948-02-11T04:24:25.375Z\",\n \"meioDePagamento\": \"string\",\n \"totalPagamento\": 8540.212544700733,\n \"bancoCodigo\": \"string\",\n \"numeroAgencia\": \"string\",\n \"numeroDaConta\": \"string\",\n \"numeroDaContaNome\": \"string\",\n \"tipoChavePix\": \"string\",\n \"chavePix\": \"string\",\n \"txIdPix\": \"string\",\n \"qrCodePix\": \"string\",\n \"parceiroCodigo\": \"string\",\n \"parceiroNome\": \"string\",\n \"nomeTerceiro\": \"string\",\n \"inscricaoTerceiro\": \"string\",\n \"valorExtenso\": \"string\",\n \"codigoBarras\": \"string\",\n \"linhaDigitavel\": \"string\",\n \"tipoTransferencia\": \"string\",\n \"formaPagamentoBanco\": \"string\",\n \"codigoReceita\": \"string\",\n \"identificadorFgts\": \"string\",\n \"valorPrincipal\": 2095.4335561920443,\n \"valorMulta\": 8713.970779837662,\n \"valorJuros\": 25.139170796413257,\n \"filial\": \"string\",\n \"segmentoBoleto\": \"string\",\n \"codigoBeneficiario\": 5581,\n \"contasPagar\": 7796,\n \"situacaoEnum\": 4,\n \"dataPagamento\": \"1998-06-27T20:56:48.732Z\",\n \"observacao\": \"string\",\n \"centrosDeCusto\": \"string\"\n },\n {\n \"codigoChave\": 9795,\n \"numero\": \"string\",\n \"origemPag\": \"string\",\n \"contratoOrigem\": \"string\",\n \"contratoDestino\": \"string\",\n \"bancoOrigem\": \"string\",\n \"agenciaOrigem\": \"string\",\n \"contaOrigem\": \"string\",\n \"status\": \"string\",\n \"situacao\": \"string\",\n \"assinaturas\": 8262,\n \"dataGeracao\": \"1967-09-26T08:44:31.779Z\",\n \"dataLancamento\": \"2008-03-29T21:10:03.167Z\",\n \"dataVencimento\": \"2004-06-27T03:07:03.545Z\",\n \"meioDePagamento\": \"string\",\n \"totalPagamento\": 5510.751554647447,\n \"bancoCodigo\": \"string\",\n \"numeroAgencia\": \"string\",\n \"numeroDaConta\": \"string\",\n \"numeroDaContaNome\": \"string\",\n \"tipoChavePix\": \"string\",\n \"chavePix\": \"string\",\n \"txIdPix\": \"string\",\n \"qrCodePix\": \"string\",\n \"parceiroCodigo\": \"string\",\n \"parceiroNome\": \"string\",\n \"nomeTerceiro\": \"string\",\n \"inscricaoTerceiro\": \"string\",\n \"valorExtenso\": \"string\",\n \"codigoBarras\": \"string\",\n \"linhaDigitavel\": \"string\",\n \"tipoTransferencia\": \"string\",\n \"formaPagamentoBanco\": \"string\",\n \"codigoReceita\": \"string\",\n \"identificadorFgts\": \"string\",\n \"valorPrincipal\": 2385.3672696077065,\n \"valorMulta\": 2739.1099098086615,\n \"valorJuros\": 799.1970175746587,\n \"filial\": \"string\",\n \"segmentoBoleto\": \"string\",\n \"codigoBeneficiario\": 5288,\n \"contasPagar\": 6351,\n \"situacaoEnum\": 9,\n \"dataPagamento\": \"1964-03-02T03:25:51.124Z\",\n \"observacao\": \"string\",\n \"centrosDeCusto\": \"string\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Pagamento/:usuarioAprovador/aprovar", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Pagamento", ":usuarioAprovador", "aprovar" ], "variable": [ { "key": "usuarioAprovador", "value": "string" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"codigoChave\": 6622,\n \"numero\": \"string\",\n \"origemPag\": \"string\",\n \"contratoOrigem\": \"string\",\n \"contratoDestino\": \"string\",\n \"bancoOrigem\": \"string\",\n \"agenciaOrigem\": \"string\",\n \"contaOrigem\": \"string\",\n \"status\": \"string\",\n \"situacao\": \"string\",\n \"assinaturas\": 7632,\n \"dataGeracao\": \"1970-05-08T16:33:01.457Z\",\n \"dataLancamento\": \"1983-02-08T22:47:41.276Z\",\n \"dataVencimento\": \"1948-02-11T04:24:25.375Z\",\n \"meioDePagamento\": \"string\",\n \"totalPagamento\": 8540.212544700733,\n \"bancoCodigo\": \"string\",\n \"numeroAgencia\": \"string\",\n \"numeroDaConta\": \"string\",\n \"numeroDaContaNome\": \"string\",\n \"tipoChavePix\": \"string\",\n \"chavePix\": \"string\",\n \"txIdPix\": \"string\",\n \"qrCodePix\": \"string\",\n \"parceiroCodigo\": \"string\",\n \"parceiroNome\": \"string\",\n \"nomeTerceiro\": \"string\",\n \"inscricaoTerceiro\": \"string\",\n \"valorExtenso\": \"string\",\n \"codigoBarras\": \"string\",\n \"linhaDigitavel\": \"string\",\n \"tipoTransferencia\": \"string\",\n \"formaPagamentoBanco\": \"string\",\n \"codigoReceita\": \"string\",\n \"identificadorFgts\": \"string\",\n \"valorPrincipal\": 2095.4335561920443,\n \"valorMulta\": 8713.970779837662,\n \"valorJuros\": 25.139170796413257,\n \"filial\": \"string\",\n \"segmentoBoleto\": \"string\",\n \"codigoBeneficiario\": 5581,\n \"contasPagar\": 7796,\n \"situacaoEnum\": 4,\n \"dataPagamento\": \"1998-06-27T20:56:48.732Z\",\n \"observacao\": \"string\",\n \"centrosDeCusto\": \"string\"\n },\n {\n \"codigoChave\": 9795,\n \"numero\": \"string\",\n \"origemPag\": \"string\",\n \"contratoOrigem\": \"string\",\n \"contratoDestino\": \"string\",\n \"bancoOrigem\": \"string\",\n \"agenciaOrigem\": \"string\",\n \"contaOrigem\": \"string\",\n \"status\": \"string\",\n \"situacao\": \"string\",\n \"assinaturas\": 8262,\n \"dataGeracao\": \"1967-09-26T08:44:31.779Z\",\n \"dataLancamento\": \"2008-03-29T21:10:03.167Z\",\n \"dataVencimento\": \"2004-06-27T03:07:03.545Z\",\n \"meioDePagamento\": \"string\",\n \"totalPagamento\": 5510.751554647447,\n \"bancoCodigo\": \"string\",\n \"numeroAgencia\": \"string\",\n \"numeroDaConta\": \"string\",\n \"numeroDaContaNome\": \"string\",\n \"tipoChavePix\": \"string\",\n \"chavePix\": \"string\",\n \"txIdPix\": \"string\",\n \"qrCodePix\": \"string\",\n \"parceiroCodigo\": \"string\",\n \"parceiroNome\": \"string\",\n \"nomeTerceiro\": \"string\",\n \"inscricaoTerceiro\": \"string\",\n \"valorExtenso\": \"string\",\n \"codigoBarras\": \"string\",\n \"linhaDigitavel\": \"string\",\n \"tipoTransferencia\": \"string\",\n \"formaPagamentoBanco\": \"string\",\n \"codigoReceita\": \"string\",\n \"identificadorFgts\": \"string\",\n \"valorPrincipal\": 2385.3672696077065,\n \"valorMulta\": 2739.1099098086615,\n \"valorJuros\": 799.1970175746587,\n \"filial\": \"string\",\n \"segmentoBoleto\": \"string\",\n \"codigoBeneficiario\": 5288,\n \"contasPagar\": 6351,\n \"situacaoEnum\": 9,\n \"dataPagamento\": \"1964-03-02T03:25:51.124Z\",\n \"observacao\": \"string\",\n \"centrosDeCusto\": \"string\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Pagamento/:usuarioAprovador/aprovar", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Pagamento", ":usuarioAprovador", "aprovar" ], "variable": [ { "key": "usuarioAprovador", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "reprovar", "item": [ { "name": "/api/v3/Pagamento/:usuarioAprovador/reprovar", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"motivoReprovacao\": \"string\",\n \"documentosPagamento\": [\n {\n \"codigoChave\": 9028,\n \"numero\": \"string\",\n \"origemPag\": \"string\",\n \"contratoOrigem\": \"string\",\n \"contratoDestino\": \"string\",\n \"bancoOrigem\": \"string\",\n \"agenciaOrigem\": \"string\",\n \"contaOrigem\": \"string\",\n \"status\": \"string\",\n \"situacao\": \"string\",\n \"assinaturas\": 1040,\n \"dataGeracao\": \"2007-03-10T14:39:06.017Z\",\n \"dataLancamento\": \"1962-08-04T08:33:37.545Z\",\n \"dataVencimento\": \"1976-04-22T03:54:31.591Z\",\n \"meioDePagamento\": \"string\",\n \"totalPagamento\": 9123.864581786656,\n \"bancoCodigo\": \"string\",\n \"numeroAgencia\": \"string\",\n \"numeroDaConta\": \"string\",\n \"numeroDaContaNome\": \"string\",\n \"tipoChavePix\": \"string\",\n \"chavePix\": \"string\",\n \"txIdPix\": \"string\",\n \"qrCodePix\": \"string\",\n \"parceiroCodigo\": \"string\",\n \"parceiroNome\": \"string\",\n \"nomeTerceiro\": \"string\",\n \"inscricaoTerceiro\": \"string\",\n \"valorExtenso\": \"string\",\n \"codigoBarras\": \"string\",\n \"linhaDigitavel\": \"string\",\n \"tipoTransferencia\": \"string\",\n \"formaPagamentoBanco\": \"string\",\n \"codigoReceita\": \"string\",\n \"identificadorFgts\": \"string\",\n \"valorPrincipal\": 2156.38082305197,\n \"valorMulta\": 3234.889674101904,\n \"valorJuros\": 5422.305332379506,\n \"filial\": \"string\",\n \"segmentoBoleto\": \"string\",\n \"codigoBeneficiario\": 1978,\n \"contasPagar\": 428,\n \"situacaoEnum\": 3,\n \"dataPagamento\": \"2011-07-17T23:40:46.867Z\",\n \"observacao\": \"string\",\n \"centrosDeCusto\": \"string\"\n },\n {\n \"codigoChave\": 9768,\n \"numero\": \"string\",\n \"origemPag\": \"string\",\n \"contratoOrigem\": \"string\",\n \"contratoDestino\": \"string\",\n \"bancoOrigem\": \"string\",\n \"agenciaOrigem\": \"string\",\n \"contaOrigem\": \"string\",\n \"status\": \"string\",\n \"situacao\": \"string\",\n \"assinaturas\": 2224,\n \"dataGeracao\": \"1974-03-23T22:21:43.331Z\",\n \"dataLancamento\": \"1955-11-11T04:06:08.861Z\",\n \"dataVencimento\": \"2013-06-19T13:37:32.880Z\",\n \"meioDePagamento\": \"string\",\n \"totalPagamento\": 586.2712016312744,\n \"bancoCodigo\": \"string\",\n \"numeroAgencia\": \"string\",\n \"numeroDaConta\": \"string\",\n \"numeroDaContaNome\": \"string\",\n \"tipoChavePix\": \"string\",\n \"chavePix\": \"string\",\n \"txIdPix\": \"string\",\n \"qrCodePix\": \"string\",\n \"parceiroCodigo\": \"string\",\n \"parceiroNome\": \"string\",\n \"nomeTerceiro\": \"string\",\n \"inscricaoTerceiro\": \"string\",\n \"valorExtenso\": \"string\",\n \"codigoBarras\": \"string\",\n \"linhaDigitavel\": \"string\",\n \"tipoTransferencia\": \"string\",\n \"formaPagamentoBanco\": \"string\",\n \"codigoReceita\": \"string\",\n \"identificadorFgts\": \"string\",\n \"valorPrincipal\": 1309.6854129115143,\n \"valorMulta\": 2245.870125516315,\n \"valorJuros\": 3885.945121904445,\n \"filial\": \"string\",\n \"segmentoBoleto\": \"string\",\n \"codigoBeneficiario\": 3477,\n \"contasPagar\": 8181,\n \"situacaoEnum\": 2,\n \"dataPagamento\": \"1994-04-27T00:39:11.978Z\",\n \"observacao\": \"string\",\n \"centrosDeCusto\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Pagamento/:usuarioAprovador/reprovar", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Pagamento", ":usuarioAprovador", "reprovar" ], "variable": [ { "key": "usuarioAprovador", "value": "string" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"motivoReprovacao\": \"string\",\n \"documentosPagamento\": [\n {\n \"codigoChave\": 9028,\n \"numero\": \"string\",\n \"origemPag\": \"string\",\n \"contratoOrigem\": \"string\",\n \"contratoDestino\": \"string\",\n \"bancoOrigem\": \"string\",\n \"agenciaOrigem\": \"string\",\n \"contaOrigem\": \"string\",\n \"status\": \"string\",\n \"situacao\": \"string\",\n \"assinaturas\": 1040,\n \"dataGeracao\": \"2007-03-10T14:39:06.017Z\",\n \"dataLancamento\": \"1962-08-04T08:33:37.545Z\",\n \"dataVencimento\": \"1976-04-22T03:54:31.591Z\",\n \"meioDePagamento\": \"string\",\n \"totalPagamento\": 9123.864581786656,\n \"bancoCodigo\": \"string\",\n \"numeroAgencia\": \"string\",\n \"numeroDaConta\": \"string\",\n \"numeroDaContaNome\": \"string\",\n \"tipoChavePix\": \"string\",\n \"chavePix\": \"string\",\n \"txIdPix\": \"string\",\n \"qrCodePix\": \"string\",\n \"parceiroCodigo\": \"string\",\n \"parceiroNome\": \"string\",\n \"nomeTerceiro\": \"string\",\n \"inscricaoTerceiro\": \"string\",\n \"valorExtenso\": \"string\",\n \"codigoBarras\": \"string\",\n \"linhaDigitavel\": \"string\",\n \"tipoTransferencia\": \"string\",\n \"formaPagamentoBanco\": \"string\",\n \"codigoReceita\": \"string\",\n \"identificadorFgts\": \"string\",\n \"valorPrincipal\": 2156.38082305197,\n \"valorMulta\": 3234.889674101904,\n \"valorJuros\": 5422.305332379506,\n \"filial\": \"string\",\n \"segmentoBoleto\": \"string\",\n \"codigoBeneficiario\": 1978,\n \"contasPagar\": 428,\n \"situacaoEnum\": 3,\n \"dataPagamento\": \"2011-07-17T23:40:46.867Z\",\n \"observacao\": \"string\",\n \"centrosDeCusto\": \"string\"\n },\n {\n \"codigoChave\": 9768,\n \"numero\": \"string\",\n \"origemPag\": \"string\",\n \"contratoOrigem\": \"string\",\n \"contratoDestino\": \"string\",\n \"bancoOrigem\": \"string\",\n \"agenciaOrigem\": \"string\",\n \"contaOrigem\": \"string\",\n \"status\": \"string\",\n \"situacao\": \"string\",\n \"assinaturas\": 2224,\n \"dataGeracao\": \"1974-03-23T22:21:43.331Z\",\n \"dataLancamento\": \"1955-11-11T04:06:08.861Z\",\n \"dataVencimento\": \"2013-06-19T13:37:32.880Z\",\n \"meioDePagamento\": \"string\",\n \"totalPagamento\": 586.2712016312744,\n \"bancoCodigo\": \"string\",\n \"numeroAgencia\": \"string\",\n \"numeroDaConta\": \"string\",\n \"numeroDaContaNome\": \"string\",\n \"tipoChavePix\": \"string\",\n \"chavePix\": \"string\",\n \"txIdPix\": \"string\",\n \"qrCodePix\": \"string\",\n \"parceiroCodigo\": \"string\",\n \"parceiroNome\": \"string\",\n \"nomeTerceiro\": \"string\",\n \"inscricaoTerceiro\": \"string\",\n \"valorExtenso\": \"string\",\n \"codigoBarras\": \"string\",\n \"linhaDigitavel\": \"string\",\n \"tipoTransferencia\": \"string\",\n \"formaPagamentoBanco\": \"string\",\n \"codigoReceita\": \"string\",\n \"identificadorFgts\": \"string\",\n \"valorPrincipal\": 1309.6854129115143,\n \"valorMulta\": 2245.870125516315,\n \"valorJuros\": 3885.945121904445,\n \"filial\": \"string\",\n \"segmentoBoleto\": \"string\",\n \"codigoBeneficiario\": 3477,\n \"contasPagar\": 8181,\n \"situacaoEnum\": 2,\n \"dataPagamento\": \"1994-04-27T00:39:11.978Z\",\n \"observacao\": \"string\",\n \"centrosDeCusto\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Pagamento/:usuarioAprovador/reprovar", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Pagamento", ":usuarioAprovador", "reprovar" ], "variable": [ { "key": "usuarioAprovador", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "/api/v3/Pagamento", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/Pagamento?FilialIds=5707&FilialIds=1067&DataDeInicio=1947-10-17T03:52:23.290Z&DataDeTermino=1947-10-17T03:52:23.290Z&Usuario=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Pagamento" ], "query": [ { "key": "FilialIds", "value": "5707" }, { "key": "FilialIds", "value": "1067" }, { "key": "DataDeInicio", "value": "1947-10-17T03:52:23.290Z" }, { "key": "DataDeTermino", "value": "1947-10-17T03:52:23.290Z" }, { "key": "Usuario", "value": "string" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v3/Pagamento?FilialIds=1067&DataDeInicio=1947-10-17T03:52:23.290Z&DataDeTermino=1947-10-17T03:52:23.290Z&Usuario=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Pagamento" ], "query": [ { "key": "FilialIds", "value": "1067" }, { "key": "DataDeInicio", "value": "1947-10-17T03:52:23.290Z" }, { "key": "DataDeTermino", "value": "1947-10-17T03:52:23.290Z" }, { "key": "Usuario", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Parceiros", "item": [ { "name": "contatos", "item": [ { "name": "{id}", "item": [ { "name": "/api/v3/Parceiros/contatos/:id", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/Parceiros/contatos/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Parceiros", "contatos", ":id" ], "variable": [ { "key": "id", "value": "2813" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v3/Parceiros/contatos/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Parceiros", "contatos", ":id" ], "variable": [ { "key": "id", "value": "2813" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "/api/v3/Parceiros/contatos", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/Parceiros/contatos?ParceiroCodigo=string&Email=string&Telefone=string&Celular=string&TipoDeParceiro=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Parceiros", "contatos" ], "query": [ { "key": "ParceiroCodigo", "value": "string" }, { "key": "Email", "value": "string" }, { "key": "Telefone", "value": "string" }, { "key": "Celular", "value": "string" }, { "key": "TipoDeParceiro", "value": "0" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v3/Parceiros/contatos?ParceiroCodigo=string&Email=string&Telefone=string&Celular=string&TipoDeParceiro=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Parceiros", "contatos" ], "query": [ { "key": "ParceiroCodigo", "value": "string" }, { "key": "Email", "value": "string" }, { "key": "Telefone", "value": "string" }, { "key": "Celular", "value": "string" }, { "key": "TipoDeParceiro", "value": "0" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "{parceiroCodigo}", "item": [ { "name": "notas", "item": [ { "name": "/api/v3/Parceiros/:parceiroCodigo/notas", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/Parceiros/:parceiroCodigo/notas?DocumentosIds=5707&DocumentosIds=1067&ParceiroCodigo=string&Status=string&Status=string&LimitarLinha=2813&PularLinhas=2813&TipoOrdenacao=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Parceiros", ":parceiroCodigo", "notas" ], "query": [ { "key": "DocumentosIds", "value": "5707" }, { "key": "DocumentosIds", "value": "1067" }, { "key": "ParceiroCodigo", "value": "string" }, { "key": "Status", "value": "string" }, { "key": "Status", "value": "string" }, { "key": "LimitarLinha", "value": "2813" }, { "key": "PularLinhas", "value": "2813" }, { "key": "TipoOrdenacao", "value": "1" } ], "variable": [ { "key": "parceiroCodigo", "value": "string" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v3/Parceiros/:parceiroCodigo/notas?DocumentosIds=1067&ParceiroCodigo=string&Status=string&LimitarLinha=2813&PularLinhas=2813&TipoOrdenacao=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Parceiros", ":parceiroCodigo", "notas" ], "query": [ { "key": "DocumentosIds", "value": "1067" }, { "key": "ParceiroCodigo", "value": "string" }, { "key": "Status", "value": "string" }, { "key": "LimitarLinha", "value": "2813" }, { "key": "PularLinhas", "value": "2813" }, { "key": "TipoOrdenacao", "value": "1" } ], "variable": [ { "key": "parceiroCodigo", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "/api/v3/Parceiros", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/Parceiros?Codigo=string&Email=string&Telefone=string&Celular=string&CnpjCpf=string&LimitarLinha=2813&PularLinhas=2813", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Parceiros" ], "query": [ { "key": "Codigo", "value": "string" }, { "key": "Email", "value": "string" }, { "key": "Telefone", "value": "string" }, { "key": "Celular", "value": "string" }, { "key": "CnpjCpf", "value": "string" }, { "key": "LimitarLinha", "value": "2813" }, { "key": "PularLinhas", "value": "2813" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v3/Parceiros?Codigo=string&Email=string&Telefone=string&Celular=string&CnpjCpf=string&LimitarLinha=2813&PularLinhas=2813", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Parceiros" ], "query": [ { "key": "Codigo", "value": "string" }, { "key": "Email", "value": "string" }, { "key": "Telefone", "value": "string" }, { "key": "Celular", "value": "string" }, { "key": "CnpjCpf", "value": "string" }, { "key": "LimitarLinha", "value": "2813" }, { "key": "PularLinhas", "value": "2813" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Renegociacao", "item": [ { "name": "{codigoDaEmpresa}", "item": [ { "name": "{codigoDoCliente}", "item": [ { "name": "parcelas", "item": [ { "name": "/api/v3/Renegociacao/:codigoDaEmpresa/:codigoDoCliente/parcelas", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/Renegociacao/:codigoDaEmpresa/:codigoDoCliente/parcelas?DataVencientoDe=1947-10-17T03:52:23.290Z&DataVencimentoAte=1947-10-17T03:52:23.290Z&DataDocumentoDe=1947-10-17T03:52:23.290Z&DataDocumentoAte=1947-10-17T03:52:23.290Z&LimitarLinha=2813&PularLinhas=2813", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Renegociacao", ":codigoDaEmpresa", ":codigoDoCliente", "parcelas" ], "query": [ { "key": "DataVencientoDe", "value": "1947-10-17T03:52:23.290Z" }, { "key": "DataVencimentoAte", "value": "1947-10-17T03:52:23.290Z" }, { "key": "DataDocumentoDe", "value": "1947-10-17T03:52:23.290Z" }, { "key": "DataDocumentoAte", "value": "1947-10-17T03:52:23.290Z" }, { "key": "LimitarLinha", "value": "2813" }, { "key": "PularLinhas", "value": "2813" } ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" }, { "key": "codigoDoCliente", "value": "string" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v3/Renegociacao/:codigoDaEmpresa/:codigoDoCliente/parcelas?DataVencientoDe=1947-10-17T03:52:23.290Z&DataVencimentoAte=1947-10-17T03:52:23.290Z&DataDocumentoDe=1947-10-17T03:52:23.290Z&DataDocumentoAte=1947-10-17T03:52:23.290Z&LimitarLinha=2813&PularLinhas=2813", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Renegociacao", ":codigoDaEmpresa", ":codigoDoCliente", "parcelas" ], "query": [ { "key": "DataVencientoDe", "value": "1947-10-17T03:52:23.290Z" }, { "key": "DataVencimentoAte", "value": "1947-10-17T03:52:23.290Z" }, { "key": "DataDocumentoDe", "value": "1947-10-17T03:52:23.290Z" }, { "key": "DataDocumentoAte", "value": "1947-10-17T03:52:23.290Z" }, { "key": "LimitarLinha", "value": "2813" }, { "key": "PularLinhas", "value": "2813" } ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" }, { "key": "codigoDoCliente", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "{id}", "item": [ { "name": "aprovar", "item": [ { "name": "/api/v3/Renegociacao/:codigoDaEmpresa/:id/aprovar", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/Renegociacao/:codigoDaEmpresa/:id/aprovar?motivo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Renegociacao", ":codigoDaEmpresa", ":id", "aprovar" ], "query": [ { "key": "motivo", "value": "string" } ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" }, { "key": "id", "value": "2813" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v3/Renegociacao/:codigoDaEmpresa/:id/aprovar?motivo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Renegociacao", ":codigoDaEmpresa", ":id", "aprovar" ], "query": [ { "key": "motivo", "value": "string" } ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" }, { "key": "id", "value": "2813" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "reprovar", "item": [ { "name": "/api/v3/Renegociacao/:codigoDaEmpresa/:id/reprovar", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/Renegociacao/:codigoDaEmpresa/:id/reprovar?motivo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Renegociacao", ":codigoDaEmpresa", ":id", "reprovar" ], "query": [ { "key": "motivo", "value": "string" } ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" }, { "key": "id", "value": "2813" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v3/Renegociacao/:codigoDaEmpresa/:id/reprovar?motivo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Renegociacao", ":codigoDaEmpresa", ":id", "reprovar" ], "query": [ { "key": "motivo", "value": "string" } ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" }, { "key": "id", "value": "2813" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "/api/v3/Renegociacao/:codigoDaEmpresa", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"aprovar\": false,\n \"motivo\": \"string\",\n \"renegociacao\": {\n \"codigoParceiro\": \"string\",\n \"data\": \"1997-08-03T00:37:15.835Z\",\n \"dataVencimentoProposta\": \"1954-02-04T08:11:33.897Z\",\n \"formaDePagamento\": \"string\",\n \"valorTotalRenegociado\": 9085.471733721764,\n \"quantidadeParcela\": 8446,\n \"percentualTaxa\": 7656.547094234414,\n \"percentualMulta\": 9765.03239393739,\n \"percentualJuros\": 3936.5200492678664,\n \"percentualDesconto\": 3743.814189028979,\n \"observacao\": \"string\",\n \"diasIntervaloParcela\": 8649,\n \"aplicarDiaFixo\": false,\n \"formaDePagamentoProposta\": \"string\",\n \"parcelaRenegociadas\": [\n {\n \"tipoDocumento\": 4685,\n \"documentoId\": 2820,\n \"parcelaId\": 6196,\n \"valorTaxa\": 7176.296801249481,\n \"valorMulta\": 5046.145319128232,\n \"valorJuros\": 6000.730703631063,\n \"valorDesconto\": 14.509988845073929,\n \"percentualTaxa\": 9986.18897814921,\n \"percentualMulta\": 944.9436862553529,\n \"percentualJuros\": 8422.983016669814,\n \"percentualDesconto\": 373.8499117419225\n },\n {\n \"tipoDocumento\": 8496,\n \"documentoId\": 9963,\n \"parcelaId\": 3747,\n \"valorTaxa\": 9874.136701850184,\n \"valorMulta\": 4338.124606732297,\n \"valorJuros\": 8120.162106866245,\n \"valorDesconto\": 9968.887578894657,\n \"percentualTaxa\": 9359.905983043165,\n \"percentualMulta\": 3804.7009995687577,\n \"percentualJuros\": 399.53520196289725,\n \"percentualDesconto\": 9312.122980347178\n }\n ],\n \"propostas\": [\n {\n \"parcelaId\": 4570,\n \"valorParcela\": 5385.278651352464,\n \"dataVencimento\": \"2011-09-12T01:11:09.192Z\",\n \"codigoFormaDePgto\": \"string\",\n \"gerarBoleto\": 6275\n },\n {\n \"parcelaId\": 7509,\n \"valorParcela\": 5428.4253559464205,\n \"dataVencimento\": \"1991-05-05T18:47:46.114Z\",\n \"codigoFormaDePgto\": \"string\",\n \"gerarBoleto\": 2476\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Renegociacao/:codigoDaEmpresa", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Renegociacao", ":codigoDaEmpresa" ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"aprovar\": false,\n \"motivo\": \"string\",\n \"renegociacao\": {\n \"codigoParceiro\": \"string\",\n \"data\": \"1997-08-03T00:37:15.835Z\",\n \"dataVencimentoProposta\": \"1954-02-04T08:11:33.897Z\",\n \"formaDePagamento\": \"string\",\n \"valorTotalRenegociado\": 9085.471733721764,\n \"quantidadeParcela\": 8446,\n \"percentualTaxa\": 7656.547094234414,\n \"percentualMulta\": 9765.03239393739,\n \"percentualJuros\": 3936.5200492678664,\n \"percentualDesconto\": 3743.814189028979,\n \"observacao\": \"string\",\n \"diasIntervaloParcela\": 8649,\n \"aplicarDiaFixo\": false,\n \"formaDePagamentoProposta\": \"string\",\n \"parcelaRenegociadas\": [\n {\n \"tipoDocumento\": 4685,\n \"documentoId\": 2820,\n \"parcelaId\": 6196,\n \"valorTaxa\": 7176.296801249481,\n \"valorMulta\": 5046.145319128232,\n \"valorJuros\": 6000.730703631063,\n \"valorDesconto\": 14.509988845073929,\n \"percentualTaxa\": 9986.18897814921,\n \"percentualMulta\": 944.9436862553529,\n \"percentualJuros\": 8422.983016669814,\n \"percentualDesconto\": 373.8499117419225\n },\n {\n \"tipoDocumento\": 8496,\n \"documentoId\": 9963,\n \"parcelaId\": 3747,\n \"valorTaxa\": 9874.136701850184,\n \"valorMulta\": 4338.124606732297,\n \"valorJuros\": 8120.162106866245,\n \"valorDesconto\": 9968.887578894657,\n \"percentualTaxa\": 9359.905983043165,\n \"percentualMulta\": 3804.7009995687577,\n \"percentualJuros\": 399.53520196289725,\n \"percentualDesconto\": 9312.122980347178\n }\n ],\n \"propostas\": [\n {\n \"parcelaId\": 4570,\n \"valorParcela\": 5385.278651352464,\n \"dataVencimento\": \"2011-09-12T01:11:09.192Z\",\n \"codigoFormaDePgto\": \"string\",\n \"gerarBoleto\": 6275\n },\n {\n \"parcelaId\": 7509,\n \"valorParcela\": 5428.4253559464205,\n \"dataVencimento\": \"1991-05-05T18:47:46.114Z\",\n \"codigoFormaDePgto\": \"string\",\n \"gerarBoleto\": 2476\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/Renegociacao/:codigoDaEmpresa", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Renegociacao", ":codigoDaEmpresa" ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "{id}", "item": [ { "name": "cancelar", "item": [ { "name": "/api/v3/Renegociacao/:id/cancelar", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/Renegociacao/:id/cancelar?motivo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Renegociacao", ":id", "cancelar" ], "query": [ { "key": "motivo", "value": "string" } ], "variable": [ { "key": "id", "value": "2813" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v3/Renegociacao/:id/cancelar?motivo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Renegociacao", ":id", "cancelar" ], "query": [ { "key": "motivo", "value": "string" } ], "variable": [ { "key": "id", "value": "2813" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "/api/v3/Renegociacao/:id", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/Renegociacao/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Renegociacao", ":id" ], "variable": [ { "key": "id", "value": "2813" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v3/Renegociacao/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Renegociacao", ":id" ], "variable": [ { "key": "id", "value": "2813" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "empresa", "item": [ { "name": "{codigoDaEmpresa}", "item": [ { "name": "/api/v3/Renegociacao/empresa/:codigoDaEmpresa", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/Renegociacao/empresa/:codigoDaEmpresa?ParceiroId=string&DataInicio=1947-10-17T03:52:23.290Z&DataFinal=1947-10-17T03:52:23.290Z&StatusId=2813&FilialId=2813", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Renegociacao", "empresa", ":codigoDaEmpresa" ], "query": [ { "key": "ParceiroId", "value": "string" }, { "key": "DataInicio", "value": "1947-10-17T03:52:23.290Z" }, { "key": "DataFinal", "value": "1947-10-17T03:52:23.290Z" }, { "key": "StatusId", "value": "2813" }, { "key": "FilialId", "value": "2813" } ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v3/Renegociacao/empresa/:codigoDaEmpresa?ParceiroId=string&DataInicio=1947-10-17T03:52:23.290Z&DataFinal=1947-10-17T03:52:23.290Z&StatusId=2813&FilialId=2813", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "Renegociacao", "empresa", ":codigoDaEmpresa" ], "query": [ { "key": "ParceiroId", "value": "string" }, { "key": "DataInicio", "value": "1947-10-17T03:52:23.290Z" }, { "key": "DataFinal", "value": "1947-10-17T03:52:23.290Z" }, { "key": "StatusId", "value": "2813" }, { "key": "FilialId", "value": "2813" } ], "variable": [ { "key": "codigoDaEmpresa", "value": "2813" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "/" } ] }