antecipacao_duplicatas

2.0info: 1.8.1 antecipacao_duplicatas description: Serviço de antecipação de duplicatas x-senior-domain: Domínio de antecipação de duplicatas do banking x-senior-domain-path: erpx_bnk_fin x-senior-service-path: antecipacao_duplicatas contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erpx_bnk_finsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /antecipacao_duplicatas/queries/healthcheck: post: description: Query for health check – SRE tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query for health check – SRE tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/queries/listOperacoesAntecipacao: post: description: API responsável por retornar as operações de solicitação de antecipação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentosFiliais – pageRequest properties: documentosFiliais: type: array items: type: string minimum: 1 description: Documentos das filiais pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – operacoes – totalElements properties: operacoes: type: array items: type: object allOf: – #/definitions/recOperacao minimum: 1 description: Operações de antecipação totalElements: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/queries/visualizarResumoAntecipacao: post: description: API responsável por visualizar o resumo da antecipação antes de efetivar a operação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentosFiliais – usuarioOperacao properties: codigosBarras: type: array items: type: string description: Códigos de barras das duplicatas disponíveis selecionadas para antecipação valorAntecipacao: type: string description: Valor solicitado para antecipação documentosFiliais: type: array items: type: string minimum: 1 description: Documentos das filiais usuarioOperacao: type: string description: Usuário da operação responses: 200: description: Ok schema: type: object properties: resumoAntecipacao: type: object allOf: – #/definitions/recResumoAntecipacao description: Resumo da antecipação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/queries/getValoresTotaisDisponiveis: post: description: API responsável por retornar os valores totais dos boletos e disponível para antecipação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentosFiliais properties: documentosFiliais: type: array items: type: string minimum: 1 description: Documentos das filiais responses: 200: description: Ok schema: type: object required: – valoTotalBoletos – valorTotalAntecipacao properties: valoTotalBoletos: type: string description: Total dos boletos disponíves valorTotalAntecipacao: type: string description: Total disponível para antecipar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/queries/verificarContratacaoServico: post: description: API responsável por verificar a contratação do serviço de Desconto de duplicatas junto ao banco BTG tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cnpjs properties: cnpjs: type: array items: type: string minimum: 1 description: CNPJs enviados para consulta da contratação do serviço de Desconto de duplicatas responses: 200: description: Ok schema: type: object required: – resultados properties: resultados: type: array items: type: object allOf: – #/definitions/recContratacaoServico minimum: 1 description: Retorna se o documento enviado possui o serviço de Desconto de duplicatas contratado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/queries/exportE070fil: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/queries/exportDuplicataDisponivel: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/queries/exportDescontoDuplicataOperacao: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/queries/exportDescontoDuplicataItem: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/queries/exportDescontoDuplicataErro: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/actions/anteciparDuplicatas: post: description: API responsável por antecipar as duplicatas disponíveis tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigosBarras properties: codigosBarras: type: array items: type: string minimum: 1 description: Códigos de barras das duplicatas disponíveis selecionadas para antecipação responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/actions/reenviarAntecipacaoDuplicatas: post: description: API responsável por reenviar a antecipação das duplicatas disponíveis tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – descontoDuplicataOperacaoId properties: descontoDuplicataOperacaoId: type: string description: Id da operação que obteve problemas ao tentar antecipar lote de duplicatas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/actions/importE070fil: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/actions/importDuplicataDisponivel: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/actions/importDescontoDuplicataOperacao: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/actions/importDescontoDuplicataItem: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/actions/importDescontoDuplicataErro: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/signals/retornoAprovacaoDuplicata: post: description: API responsável pelo retorno da aprovação do Desconto de duplicatas no parceiro tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – codigoBarras – valorAntecipacao – documentoFilial properties: codigoBarras: type: string description: Código de barras do boleto para antecipação valorAntecipacao: type: string description: Valor disponível para antecipação do boleto documentoFilial: type: string description: Documento da filial responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/signals/retornoCancelamentoDuplicata: post: description: API responsável pelo retorno do cancelamento do Desconto de duplicatas no parceiro tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – codigoBarras properties: codigoBarras: type: string description: Código de barras do boleto a antecipar responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/signals/retornoAntecipacaoDuplicata: post: description: API responsável pelo retorno do processo de antecipação da duplicata no banco tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – codigoBarras – situacao properties: codigoBarras: type: string description: Código de barras do boleto a antecipar situacao: type: string allOf: – #/definitions/enumSituacaoDescontaDuplicataItem description: Situação da duplicata enviada para antecipação operacaoId: type: string description: Id da operação da antecipação responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/events/iniciarIntegracaoDescontoDuplicatasBtg: post: description: Evento disparado para comunicação com o banco BTG x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – payerTaxId – payeeTaxId – receivables properties: payerTaxId: type: string description: Documento do sacado payeeTaxId: type: string description: Documento do cedente receivables: type: array items: type: object allOf: – #/definitions/recReceivable minimum: 1 description: Recebíveis enviados pra antecipação responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/events/importE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/events/exportE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/events/importE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/events/exportE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/events/importDuplicataDisponivelEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/events/exportDuplicataDisponivelEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/events/importDescontoDuplicataOperacaoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/events/exportDescontoDuplicataOperacaoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/events/importDescontoDuplicataItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/events/exportDescontoDuplicataItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/events/importDescontoDuplicataErroEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/events/exportDescontoDuplicataErroEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/entities/e070emp: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/entities/e070emp/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/entities/e070fil: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/entities/e070fil/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/entities/duplicataDisponivel: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/duplicataDisponivel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/entities/descontoDuplicataOperacao: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/descontoDuplicataOperacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/entities/descontoDuplicataItem: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/descontoDuplicataItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/entities/descontoDuplicataOperacao/{parentId}/descontoDuplicataItens: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/descontoDuplicataItem responses: 200: description: The created resources schema: type: array items: #/definitions/descontoDuplicataItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/descontoDuplicataItem responses: 200: description: The created resources schema: type: array items: #/definitions/descontoDuplicataItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/descontoDuplicataItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/entities/descontoDuplicataOperacao/{parentId}/descontoDuplicataItens/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDescontoDuplicataItem responses: 200: description: Ok schema: #/definitions/editDescontoDuplicataItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/descontoDuplicataItem responses: 200: description: Ok schema: #/definitions/descontoDuplicataItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/descontoDuplicataItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/entities/descontoDuplicataErro: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/descontoDuplicataErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/entities/descontoDuplicataOperacao/{parentId}/descontoDuplicataErros: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/descontoDuplicataErro responses: 200: description: The created resources schema: type: array items: #/definitions/descontoDuplicataErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/descontoDuplicataErro responses: 200: description: The created resources schema: type: array items: #/definitions/descontoDuplicataErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/descontoDuplicataErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /antecipacao_duplicatas/entities/descontoDuplicataOperacao/{parentId}/descontoDuplicataErros/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDescontoDuplicataErro responses: 200: description: Ok schema: #/definitions/editDescontoDuplicataErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/descontoDuplicataErro responses: 200: description: Ok schema: #/definitions/descontoDuplicataErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/descontoDuplicataErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumTypeOrder: type: string enum: – ASC – DESC description: Enumeração para o tipo de ordenação: * `ASC` – Tipo de ordenação – Crescente * `DESC` – Tipo de ordenação – Decrescente enumSituacaoDescontaDuplicataItem: type: string enum: – APROVADO – CANCELADO – PROCESSANDO_ENVIO_ANTECIPACAO – EM_ANTECIPACAO – ANTECIPADO – LIQUIDADO – EM_ATRASO – DUPLICATA_COM_PROBLEMAS – INATIVADO description: Situação do Desconto de duplicata item: * `APROVADO` – Aprovado * `CANCELADO` – Cancelado * `PROCESSANDO_ENVIO_ANTECIPACAO` – Processando envio para antecipação * `EM_ANTECIPACAO` – Em antecipação * `ANTECIPADO` – Antecipado * `LIQUIDADO` – Liquidado * `EM_ATRASO` – Em atraso * `DUPLICATA_COM_PROBLEMAS` – Duplicata com problemas * `INATIVADO` – Inativado enumSituacaoOperacaoAntecipacao: type: string enum: – PENDENTE – ERRO – CANCELADO – PROCESSANDO – AGUARDANDO_ASSINATURA – ANTECIPADO – LIQUIDADO – EM_ATRASO description: Valores das situações da operação de antecipação: * `PENDENTE` – Pendente * `ERRO` – Erro * `CANCELADO` – Cancelado * `PROCESSANDO` – Processando * `AGUARDANDO_ASSINATURA` – Aguardando assinatura do contrato * `ANTECIPADO` – Antecipado * `LIQUIDADO` – Liquidado * `EM_ATRASO` – Em atraso userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recReceivable: description: Dados do recebível type: object required: – identification – maturityDate – maturityAmount – disbursementAmount properties: identification: type: string description: Código de barras do boleto maturityDate: type: string format: date description: Data de vencimento maturityAmount: type: string description: Valor do boleto disbursementAmount: type: string description: Valor de desembolso recResumoAntecipacao: description: Resumo da antecipação type: object required: – dadosGerais – valores – duplicatas properties: dadosGerais: type: object allOf: – #/definitions/recDadosGerais description: Dados gerais da antecipação valores: type: object allOf: – #/definitions/recValores description: Resumo dos valores da antecipaçaõ duplicatas: type: array items: type: object allOf: – #/definitions/duplicataDisponivel minimum: 1 description: Duplicatas selecionadas recValores: description: Valores da antecipação type: object required: – totalDuplicatas – valorBruto – valorAntecipacao – custoEfetivo properties: totalDuplicatas: type: integer format: int64 description: Total de duplicatas selecionadas valorBruto: type: string description: Valor bruto valorAntecipacao: type: string description: Valor da antecipação custoEfetivo: type: string description: Custo efetivo total da antecipação recDadosGerais: description: Dados gerais da antecipação type: object required: – empresa – usuarioOperacao properties: empresa: type: object allOf: – #/definitions/recGenerico description: Dados da empresa usuarioOperacao: type: string description: Usuário da operação recGenerico: description: Record para retorno das informações principais de uma entidade type: object required: – id properties: id: type: string description: Identificador da entidade codigo: type: string description: Código de negócio descricao: type: string description: Descrição de negócio label: type: string description: Descrição do label recPageRequest: description: Record para paginação e ordenação type: object required: – offset – size properties: offset: type: integer format: int64 description: Página atual size: type: integer format: int64 description: Total de registros da página orderBy: type: array items: type: object allOf: – #/definitions/recFieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados recFieldsOrderBy: description: Define o registro com os dados dos campos à serem ordenados type: object required: – field – order properties: field: type: string description: Nome do campo a ser ordenado order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação do campo (ASC / DESC) recOperacao: description: Dados da operação type: object required: – id – data – valorBruto – valorAntecipado – nomeCliente – documentoCliente – status properties: id: type: string description: Id da operação data: type: string format: date description: Data da operação valorBruto: type: string description: Valor total dos boletos da antecipação valorAntecipado: type: string description: Valor total solicitado para antecipação nomeCliente: type: string description: Nome do cliente documentoCliente: type: string description: Documento do cliente status: type: string allOf: – #/definitions/enumSituacaoOperacaoAntecipacao description: Status da operação recContratacaoServico: description: Dados da contratação do serviço de Desconto de duplicatas type: object required: – cnpj – possuiServicoContratado properties: cnpj: type: string description: CNPJ consultado para verificar a contratação do serviço de Desconto de duplicatas possuiServicoContratado: type: boolean description: Retorna se o CNPJ possui ou não o serviço de Desconto de duplicatas contratado e070emp: description: Empresa type: object properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome da empresa sigEmp: type: string maxLength: 100 description: Nome fantasia da empresa excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070fil: description: Filial type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 9999 nomFil: type: string maxLength: 100 description: Nome sigFil: type: string maxLength: 100 description: Fantasia numCgc: type: string maxLength: 18 description: CPF/CNPJ numIdf: type: string maxLength: 40 description: Número identificação fiscal excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: duplicataDisponivel: description: Armazena as duplicatas disponíveis para antecipação type: object required: – numeroTitulo – documentoFilial – nomeCliente – documentoCliente – dataVencimento – dataEmissao – valorLiquido – valorAntecipacao – codigoBarras – numeroConta properties: id: type: string format: uuid description: Identificador do registro numeroTitulo: type: string description: Numero do título documentoFilial: type: string description: Documento da filial nomeCliente: type: string description: Nome Cliente documentoCliente: type: string description: Documento do cliente dataVencimento: type: string format: date description: Data vencimento dataEmissao: type: string format: date description: Data emissão valorLiquido: type: string description: Valor liquido valorAntecipacao: type: string description: Valor disponível para antecipação do boleto codigoBarras: type: string description: Código de barras do boleto numeroConta: type: string description: Número da conta bancária usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: descontoDuplicataOperacao: description: Armazena os lotes das operações do Desconto de duplicatas enviados ao banco BTG type: object required: – documentoFilial – nomeCliente – documentoCliente – valorBruto – valorAntecipado properties: id: type: string format: uuid description: Identificador do registro documentoFilial: type: string description: Documento da filial nomeCliente: type: string description: Nome Cliente documentoCliente: type: string description: Documento do cliente valorBruto: type: string description: Valor bruto das duplicatas valorAntecipado: type: string description: Valor total antecipado operacaoId: type: string description: Id do lote de antecipação no banco descontoDuplicataItens: type: array items: type: object allOf: – #/definitions/descontoDuplicataItem description: Duplicatas enviadas para antecipação descontoDuplicataErros: type: array items: type: object allOf: – #/definitions/descontoDuplicataErro description: Erros no envio da antecipação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: descontoDuplicataItem: description: Armazena as duplicatas enviadas para antecipação type: object required: – numeroTitulo – dataVencimento – dataEmissao – valorLiquido – valorAntecipacao – codigoBarras – situacao properties: id: type: string format: uuid description: Identificador do registro numeroTitulo: type: string description: Numero dataVencimento: type: string format: date description: Data vencimento dataEmissao: type: string format: date description: Data emissão valorLiquido: type: string description: Valor liquido valorAntecipacao: type: string description: Valor disponível para antecipação do boleto codigoBarras: type: string description: Código de barras do boleto situacao: type: string allOf: – #/definitions/enumSituacaoDescontaDuplicataItem description: Situação descontoDuplicataOperacao: type: object allOf: – #/definitions/descontoDuplicataOperacao description: Lote de operações usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editDescontoDuplicataItem: type: object required: – id allOf: – #/definitions/descontoDuplicataItem descontoDuplicataErro: description: Armazena os erros ocorridos durante no lote de antecipação type: object required: – dado – motivo properties: id: type: string format: uuid description: Identificador do registro dado: type: string description: Dado responsável pelo erro motivo: type: string description: Motivo do erro descontoDuplicataOperacao: type: object allOf: – #/definitions/descontoDuplicataOperacao description: Lote de antecipação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editDescontoDuplicataErro: type: object required: – id allOf: – #/definitions/descontoDuplicataErro notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage