Mais pesquisados:Customização, Tutorial, Documentação

recebiveis_cartao_cred

5 views 0 01/08/2025 integrador

2.0info: 1.4.0 recebiveis_cartao_cred description: Serviço de recebíveis de cartão de crédito x-senior-domain: Domínio do financeiro do banking x-senior-domain-path: erpx_bnk_fin x-senior-service-path: recebiveis_cartao_cred 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: /recebiveis_cartao_cred/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 properties: status: type: string allOf: – #/definitions/upDown description: Status checks: type: array items: type: object allOf: – #/definitions/checkData 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 properties: status: type: string allOf: – #/definitions/upDown description: Status checks: type: array items: type: object allOf: – #/definitions/checkData description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recebiveis_cartao_cred/queries/listHistoricoAntecipacao: post: description: Query responsável por retornar o histórico de antecipações de recebíveis cartão de crédito tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentoFilial – pageRequest properties: documentoFilial: type: string description: CNPJ da empresa realizando a requisição pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – antecipacoes – totalElements properties: antecipacoes: type: array items: type: object allOf: – #/definitions/recAntecipacao minimum: 1 description: Lista de antecipações totalElements: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recebiveis_cartao_cred/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 /recebiveis_cartao_cred/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 /recebiveis_cartao_cred/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 /recebiveis_cartao_cred/queries/exportAntecipacaoCartaoDados: 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 /recebiveis_cartao_cred/queries/exportAntecipacaoCartaoItem: 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 /recebiveis_cartao_cred/queries/exportAntecipacaoCartaoItemHistorico: 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 /recebiveis_cartao_cred/queries/exportAntecipacaoCartaoErro: 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 /recebiveis_cartao_cred/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 /recebiveis_cartao_cred/actions/listarUnidadesRecebiveis: post: description: API responsável por consultar recebíveis de cartão de crédito de um estabelecimento comercial disponíveis para antecipação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentoFilial properties: documentoFilial: type: string description: CNPJ da empresa realizando a requisição. credenciadora: type: array items: type: string allOf: – #/definitions/enumCredenciadoraCartao description: Credenciadora/Maquininha de cartão de crédito bandeiraCartaoCredito: type: array items: type: string allOf: – #/definitions/enumBandeiraCartaoCredito description: Bandeira do cartão de crédito vencimentoInicial: type: string format: date description: Data de vencimento inicial do recebível vencimentoFinal: type: string format: date description: Data de vencimento final do recebível pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – totalizacaoRecebiveis – unidadesRecebiveis properties: totalizacaoRecebiveis: type: object allOf: – #/definitions/recTotalizacaoRecebiveis description: Totalização dos recebíveis unidadesRecebiveis: type: array items: type: object allOf: – #/definitions/recUnidadesRecebiveis minimum: 1 description: Lista de recebíveis ainda disponíveis para antecipar hoje 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recebiveis_cartao_cred/actions/consultarValoresAntecipar: post: description: API responsável por consultar limite de antecipação disponível e total para um estabelecimento comercial tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentoFilial properties: documentoFilial: type: string description: CNPJ da empresa realizando a requisição. responses: 200: description: Ok schema: type: object required: – valoresDisponiveis properties: valoresDisponiveis: type: object allOf: – #/definitions/recValoresDisponiveisAntecipacao description: Valores máximo, disponível e mínimo para antecipar recebíveis de cartão de crédito 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recebiveis_cartao_cred/actions/anteciparRecebiveisCartaoCredito: post: description: API responsável por antecipar uma lista recebíveis de cartão de crédito de um estabelecimento comercial tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentoFilial – contaBancariaDesembolso – valorSolicitado – unidadesRecebiveis properties: documentoFilial: type: string description: CNPJ da empresa realizando a requisição contaBancariaDesembolso: type: object allOf: – #/definitions/recContaBancariaDesembolso description: Dados da conta bancária de desembolso valorSolicitado: type: string description: Valor solicitado para antecipar unidadesRecebiveis: type: array items: type: object allOf: – #/definitions/btgReceivable minimum: 1 description: Unidades recebíveis selecionadas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recebiveis_cartao_cred/actions/obterResumoValoresAntecipacao: post: description: Primitiva responsável por obter o resumo dos valores da antecipação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentoFilial – valorSolicitado – usuarioOperacao properties: documentoFilial: type: string description: CNPJ da empresa realizando a requisição credenciadora: type: array items: type: string allOf: – #/definitions/enumCredenciadoraCartao description: Credenciadora/Maquininha de cartão de crédito bandeiraCartaoCredito: type: array items: type: string allOf: – #/definitions/enumBandeiraCartaoCredito description: Bandeira do cartão de crédito vencimentoInicial: type: string format: date description: Data de vencimento inicial do recebível vencimentoFinal: type: string format: date description: Data de vencimento final do recebível valorSolicitado: type: string description: Valor solicitado para antecipar minimum: 0.00 usuarioOperacao: type: string description: Usuário da operação responses: 200: description: Ok schema: type: object required: – resumoOperacao properties: resumoOperacao: type: object allOf: – #/definitions/recResumoAntecipacao description: Resumo dos dados da antecipação de recebíveis de cartão de crédito 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recebiveis_cartao_cred/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 /recebiveis_cartao_cred/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 /recebiveis_cartao_cred/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 /recebiveis_cartao_cred/actions/importAntecipacaoCartaoDados: 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 /recebiveis_cartao_cred/actions/importAntecipacaoCartaoItem: 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 /recebiveis_cartao_cred/actions/importAntecipacaoCartaoItemHistorico: 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 /recebiveis_cartao_cred/actions/importAntecipacaoCartaoErro: 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 /recebiveis_cartao_cred/signals/executarIntegracaoParceiro: post: description: Signal responsável pela chamada do parceiro bancário tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – lotesId properties: lotesId: type: array items: type: string minimum: 1 description: Identificador único do lote de processamento. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /recebiveis_cartao_cred/signals/processarRetornoAntecipacaoCartao: post: description: API responsável pelo retorno da antecipação de recebíveis cartão de crédito no parceiro tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – data properties: data: type: object allOf: – #/definitions/recRetornoAntecipacaoCartaoCredito description: Dados do status do recebível responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /recebiveis_cartao_cred/events/iniciarIntegracaoAntecipacaoCartaoBtg: post: description: Evento disparado para envio de uma nova antecipação de cartão de crédito ao BTG x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – disbursementBankAccount – receivables properties: disbursementBankAccount: type: object allOf: – #/definitions/recDisbursementBankAccount description: Informações das unidades recebíveis para antecipar receivables: type: array items: type: object allOf: – #/definitions/btgReceivable minimum: 1 description: Identificadores dos recebíveis cartão enviados ao banco BTG para antecipação responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /recebiveis_cartao_cred/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 /recebiveis_cartao_cred/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 /recebiveis_cartao_cred/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 /recebiveis_cartao_cred/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 /recebiveis_cartao_cred/events/importAntecipacaoCartaoDadosEvent: 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 /recebiveis_cartao_cred/events/exportAntecipacaoCartaoDadosEvent: 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 /recebiveis_cartao_cred/events/importAntecipacaoCartaoItemEvent: 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 /recebiveis_cartao_cred/events/exportAntecipacaoCartaoItemEvent: 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 /recebiveis_cartao_cred/events/importAntecipacaoCartaoItemHistoricoEvent: 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 /recebiveis_cartao_cred/events/exportAntecipacaoCartaoItemHistoricoEvent: 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 /recebiveis_cartao_cred/events/importAntecipacaoCartaoErroEvent: 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 /recebiveis_cartao_cred/events/exportAntecipacaoCartaoErroEvent: 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 /recebiveis_cartao_cred/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 /recebiveis_cartao_cred/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 /recebiveis_cartao_cred/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 /recebiveis_cartao_cred/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 /recebiveis_cartao_cred/entities/antecipacaoCartaoDados: 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/antecipacaoCartaoDados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recebiveis_cartao_cred/entities/antecipacaoCartaoItem: 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/antecipacaoCartaoItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recebiveis_cartao_cred/entities/antecipacaoCartaoDados/{parentId}/unidadesRecebiveis: 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/antecipacaoCartaoItem responses: 200: description: The created resources schema: type: array items: #/definitions/antecipacaoCartaoItem 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/antecipacaoCartaoItem responses: 200: description: The created resources schema: type: array items: #/definitions/antecipacaoCartaoItem 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/antecipacaoCartaoItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recebiveis_cartao_cred/entities/antecipacaoCartaoDados/{parentId}/unidadesRecebiveis/{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/editAntecipacaoCartaoItem responses: 200: description: Ok schema: #/definitions/editAntecipacaoCartaoItem 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/antecipacaoCartaoItem responses: 200: description: Ok schema: #/definitions/antecipacaoCartaoItem 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/antecipacaoCartaoItem 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 /recebiveis_cartao_cred/entities/antecipacaoCartaoItemHistorico: 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/antecipacaoCartaoItemHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recebiveis_cartao_cred/entities/antecipacaoCartaoItem/{parentId}/antecipacaoCartaoItemHistorico: 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/antecipacaoCartaoItemHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/antecipacaoCartaoItemHistorico 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/antecipacaoCartaoItemHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/antecipacaoCartaoItemHistorico 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/antecipacaoCartaoItemHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recebiveis_cartao_cred/entities/antecipacaoCartaoItem/{parentId}/antecipacaoCartaoItemHistorico/{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/editAntecipacaoCartaoItemHistorico responses: 200: description: Ok schema: #/definitions/editAntecipacaoCartaoItemHistorico 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/antecipacaoCartaoItemHistorico responses: 200: description: Ok schema: #/definitions/antecipacaoCartaoItemHistorico 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/antecipacaoCartaoItemHistorico 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 /recebiveis_cartao_cred/entities/antecipacaoCartaoErro: 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/antecipacaoCartaoErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recebiveis_cartao_cred/entities/antecipacaoCartaoDados/{parentId}/antecipacaoCartaoErro: 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/antecipacaoCartaoErro responses: 200: description: The created resources schema: type: array items: #/definitions/antecipacaoCartaoErro 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/antecipacaoCartaoErro responses: 200: description: The created resources schema: type: array items: #/definitions/antecipacaoCartaoErro 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/antecipacaoCartaoErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recebiveis_cartao_cred/entities/antecipacaoCartaoDados/{parentId}/antecipacaoCartaoErro/{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/editAntecipacaoCartaoErro responses: 200: description: Ok schema: #/definitions/editAntecipacaoCartaoErro 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/antecipacaoCartaoErro responses: 200: description: Ok schema: #/definitions/antecipacaoCartaoErro 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/antecipacaoCartaoErro 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 enumCredenciadoraCartao: type: string enum: – CIELO – REDECARD – GETNET – STONE description: Credenciadoras de cartão de crédito: * `CIELO` – CIELO S.A. – 01027058000191 * `REDECARD` – REDECARD S/A – 01425787000104 * `GETNET` – GETNET – 10440482000154 * `STONE` – STONE – 16501555000157 enumBandeiraCartaoCredito: type: string enum: – VISA – MASTERCARD – ELO – AMERICAN_EXPRESS – HIPERCARD description: Bandeira do cartão de crédito: * `VISA` – Visa * `MASTERCARD` – MasterCard * `ELO` – Elo * `AMERICAN_EXPRESS` – AmericanExpress * `HIPERCARD` – HiperCard enumEstadoRecebivel: type: string enum: – AGUARDANDO_ENVIO_ANTECIPACAO – PROCESSANDO_ENVIO_ANTECIPACAO – ANTECIPACAO_ENVIADA – DISPONIVEL – AGUARDANDO_ASSINATURAS – AGUARDANDO_REGISTRO – EM_DESEMBOLSO – DESEMBOLSADO – LIQUIDADO – ATRASADO – CANCELADO – ANTECIPACAO_COM_PROBLEMAS description: Estado do recebível: * `AGUARDANDO_ENVIO_ANTECIPACAO` – Aguardando envio antecipação * `PROCESSANDO_ENVIO_ANTECIPACAO` – Processando envio para antecipação * `ANTECIPACAO_ENVIADA` – Antecipação enviada ao Banco * `DISPONIVEL` – Disponível * `AGUARDANDO_ASSINATURAS` – Aguardando assinaturas * `AGUARDANDO_REGISTRO` – Aguardando registro * `EM_DESEMBOLSO` – Em desembolso * `DESEMBOLSADO` – Desembolsado * `LIQUIDADO` – Liquidado * `ATRASADO` – Atrasado * `CANCELADO` – Cancelado * `ANTECIPACAO_COM_PROBLEMAS` – Antecipação com problemas enumEstadoOperacao: type: string enum: – PENDENTE – AGUARDANDO_ASSINATURAS_CONTRATO – AGUARDANDO_REGISTRO – EM_DESEMBOLSO – DESEMBOLSADO – DESEMBOLSADO_COM_ALGUNS_CANCELAMENTOS – LIQUIDADO – ATRASADO – CANCELADO – ANTECIPACAO_COM_PROBLEMAS description: Estado da operação: * `PENDENTE` – Pendente * `AGUARDANDO_ASSINATURAS_CONTRATO` – Aguardando assinaturas de contrato * `AGUARDANDO_REGISTRO` – Aguardando registro * `EM_DESEMBOLSO` – Em desembolso * `DESEMBOLSADO` – Desembolsado * `DESEMBOLSADO_COM_ALGUNS_CANCELAMENTOS` – Desembolsado com alguns cancelamentos * `LIQUIDADO` – Liquidado * `ATRASADO` – Atrasado * `CANCELADO` – Cancelado * `ANTECIPACAO_COM_PROBLEMAS` – Antecipação com problemas 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 enumBancoRecebiveisCartaoCredito: type: string enum: – BTG_PACTUAL description: Enumeration dos bancos: * `BTG_PACTUAL` – BTG PACTUAL – 208 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 properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recUnidadesRecebiveis: description: Record com as informações dos recebíveis type: object required: – dataSolicitacao – cnpjEstabelecimentoComercial – credenciadora – bandeiraCartaoCredito – recebivelId – vencimentoRecebivel – valorDisponivelAntecipar – valorMaximoReceber – estadoRecebivel – valorRegistrado – diasCorridos – taxaMensal – valorDesconto properties: dataSolicitacao: type: string format: date description: Data da solicitação cnpjEstabelecimentoComercial: type: string description: CNPJ do estabelecimento comercial credenciadora: type: string allOf: – #/definitions/enumCredenciadoraCartao description: Credenciadora/Maquininha de cartão de crédito bandeiraCartaoCredito: type: string allOf: – #/definitions/enumBandeiraCartaoCredito description: Bandeira do cartão de crédito recebivelId: type: integer format: int64 description: Identificador do recebível vencimentoRecebivel: type: string format: date description: Data de vencimento do recebível seguindo a norma ISO-8601 valorDisponivelAntecipar: type: string description: Valor máximo do recebível disponível para antecipar valorMaximoReceber: type: string description: Valor máximo do recebível descontado da taxa de operação acordada estadoRecebivel: type: string allOf: – #/definitions/enumEstadoRecebivel description: Estado do recebível valorRegistrado: type: string description: Valor do recebível que foi possível ser registrado na Registradora diasCorridos: type: integer format: int64 description: Dias corridos para o vencimento do recebível taxaMensal: type: string description: Taxa de desconto efetiva para 30 dias valorDesconto: type: string description: Valor do desconto 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) recValoresDisponiveisAntecipacao: description: Record com os valores máximo, disponível e mínimo para antecipar recebíveis de cartão de crédito type: object required: – valorParaAntecipar – antecipacaoMaxima – valorMinimoParaAntecipar properties: valorParaAntecipar: type: string description: Valor disponível para o cliente antecipar nesse momento antecipacaoMaxima: type: string description: Valor máximo que o cliente pode antecipar de recebíveis de cartão de crédito valorMinimoParaAntecipar: type: string description: Valor mínimo que uma operação precisa ter para ser aceita recTotalizacaoRecebiveis: description: Record com a totalização dos recebíveis type: object required: – dataSolicitacao – totalAgenda – agendaLivre – taxaMediaMensal – taxaEfetiva – prazoMedio – valorDesconto – totalizacaoCredenciadora – totalizacaoBandeiraCartao properties: dataSolicitacao: type: string format: date description: Data da solicitação totalAgenda: type: string description: Agenda disponível agendaLivre: type: string description: Agenda livre taxaMediaMensal: type: string description: Média das taxas de desconto dos recebíveis taxaEfetiva: type: string description: Taxa de desconto efetiva para 30 dias prazoMedio: type: string description: Prazo médio em dias valorDesconto: type: string description: Valor do desconto totalizacaoCredenciadora: type: array items: type: object allOf: – #/definitions/recTotalizacaoCredenciadora minimum: 1 description: Totalização por maquininha de cartão de crédito totalizacaoBandeiraCartao: type: array items: type: object allOf: – #/definitions/recTotalizacaoBandeiraCartao minimum: 1 description: Totalização por bandeira do cartão de crédito recTotalizacaoCredenciadora: description: Record com a totalização por maquininha de cartão de crédito type: object required: – dataSolicitacao – credenciadora – bandeiraCartaoCredito – totalAgenda – agendaLivre – taxaMediaMensal – taxaEfetiva – prazoMedio – valorDesconto properties: dataSolicitacao: type: string format: date description: Data da solicitação credenciadora: type: string allOf: – #/definitions/enumCredenciadoraCartao description: Credenciadora/Maquininha de cartão de crédito bandeiraCartaoCredito: type: array items: type: string allOf: – #/definitions/enumBandeiraCartaoCredito minimum: 1 description: Bandeira do cartão de crédito totalAgenda: type: string description: Agenda disponível agendaLivre: type: string description: Agenda livre taxaMediaMensal: type: string description: Média das taxas de desconto dos recebíveis taxaEfetiva: type: string description: Taxa de desconto efetiva para 30 dias prazoMedio: type: string description: Prazo médio em dias em dias valorDesconto: type: string description: Valor do desconto recTotalizacaoBandeiraCartao: description: Record com a totalização por bandeira do cartão de crédito type: object required: – dataSolicitacao – bandeiraCartaoCredito – credenciadora – totalAgenda – agendaLivre – taxaMediaMensal – taxaEfetiva – prazoMedio – valorDesconto properties: dataSolicitacao: type: string format: date description: Data da solicitação bandeiraCartaoCredito: type: string allOf: – #/definitions/enumBandeiraCartaoCredito description: Bandeira do cartão de crédito credenciadora: type: array items: type: string allOf: – #/definitions/enumCredenciadoraCartao minimum: 1 description: Credenciadora/Maquininha de cartão de crédito totalAgenda: type: string description: Agenda disponível agendaLivre: type: string description: Agenda livre taxaMediaMensal: type: string description: Média das taxas de desconto dos recebíveis taxaEfetiva: type: string description: Taxa de desconto efetiva para 30 dias prazoMedio: type: string description: Prazo médio em dias em dias valorDesconto: type: string description: Valor do desconto recContaBancariaDesembolso: description: Record com os dados da conta bancária de desembolso type: object required: – banco – agencia – contaDesembolso – digitoVerificador properties: banco: type: string description: O código do banco da conta do estabelecimento comercial agencia: type: string description: Agência da conta do estabelecimento comercial contaDesembolso: type: string description: Número da conta do estabelecimento comercial digitoVerificador: type: string description: Dígito da conta do estabelecimento comercial recResumoAntecipacao: description: Record com o resumo dos dados da antecipação de recebíveis de cartão de crédito type: object required: – dadosGerais – valores – unidadesRecebiveis 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õ unidadesRecebiveis: type: array items: type: object allOf: – #/definitions/recUnidadesRecebiveis minimum: 1 description: Unidades recebíveis selecionadas recDadosGerais: description: Record com os dados gerais da antecipação type: object required: – empresa – filial – usuarioOperacao – bandeiraCartaoCredito – credenciadora – vencimentoInicial – vencimentoFinal properties: empresa: type: object allOf: – #/definitions/recGenerico description: Dados da empresa filial: type: object allOf: – #/definitions/recGenerico description: Dados da filial usuarioOperacao: type: string description: Usuário da operação bandeiraCartaoCredito: type: array items: type: string allOf: – #/definitions/enumBandeiraCartaoCredito minimum: 1 description: Bandeira do cartão de crédito credenciadora: type: array items: type: string allOf: – #/definitions/enumCredenciadoraCartao minimum: 1 description: Credenciadora/Maquininha de cartão de crédito vencimentoInicial: type: string format: date description: Data de vencimento inicial do recebível vencimentoFinal: type: string format: date description: Data de vencimento final do recebível 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 recValores: description: Resumo dos valores da antecipação type: object required: – valorBruto – taxaMediaMensal – taxaEfetiva – valorDesconto – valorTotalReceber properties: valorBruto: type: string description: Valor bruto da antecipação taxaMediaMensal: type: string description: Taxa média mensal de desconto da operação taxaEfetiva: type: string description: Taxa de desconto efetiva proporcional ao período valorDesconto: type: string description: Valor do desconto valorTotalReceber: type: string description: Valor líquido da antecipação recAntecipacao: description: Record com as informações do histórico de antecipações type: object required: – id – data – credenciadora – taxaMensal – valorBruto – valorRecebido – situacao – loteId properties: id: type: string description: Id da antecipação data: type: string format: date description: Data da antecipação credenciadora: type: string allOf: – #/definitions/enumCredenciadoraCartao description: Credenciadora/Maquininha de cartão de crédito taxaMensal: type: string description: Taxa de desconto efetiva para 30 dias valorBruto: type: string description: Valor bruto da antecipação valorRecebido: type: string description: Valor líquido da antecipação situacao: type: string allOf: – #/definitions/enumEstadoOperacao description: Estado da operação loteId: type: string description: Lote de processamento btgReceivable: description: Record com o identificador do recebível cartão enviado ao banco BTG para antecipação type: object required: – id properties: id: type: integer format: int64 description: Identificador do recebível recDisbursementBankAccount: description: Record com os dados da conta bancária de desembolso type: object required: – bankCode – branchCode – accountNumber – accountDigit properties: bankCode: type: string description: O código do banco da conta do estabelecimento comercial branchCode: type: string description: Agência da conta do estabelecimento comercial accountNumber: type: string description: Número da conta do estabelecimento comercial accountDigit: type: string description: Dígito da conta do estabelecimento comercial recRetornoAntecipacaoCartaoCredito: description: Record com o retorno do pedido de antecipação type: object required: – unidadeRecebivel – valorMaximoReceber – valorRegistrado properties: unidadeRecebivel: type: object allOf: – #/definitions/recRecebivelCartaoRetornado description: Dados de retorno dos recebíveis enviados para antecipação valorMaximoReceber: type: string description: Valor real a ser recebido pelo estabelecimento comercial valorRegistrado: type: string description: Valor do recebível que foi possível ser registrado na Registradora recRecebivelCartaoRetornado: description: Record com os dados de retorno dos recebíveis enviados para antecipação type: object required: – recebivelId – cnpjEstabelecimentoComercial – credenciadora – vencimentoRecebivel – bandeiraCartaoCredito – valorDisponivelAntecipar – estadoRecebivel properties: recebivelId: type: integer format: int64 description: Identificador do recebível cnpjEstabelecimentoComercial: type: string description: CNPJ do estabelecimento comercial credenciadora: type: string allOf: – #/definitions/enumCredenciadoraCartao description: Credenciadora/Maquininha de cartão de crédito vencimentoRecebivel: type: string format: date description: Data de vencimento do recebível seguindo a norma ISO-8601 bandeiraCartaoCredito: type: string allOf: – #/definitions/enumBandeiraCartaoCredito description: Bandeira do cartão de crédito valorDisponivelAntecipar: type: string description: Valor máximo que poderá ser registrado na Registradora estadoRecebivel: type: string allOf: – #/definitions/enumEstadoRecebivel description: Estado do recebível 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: antecipacaoCartaoDados: description: Armazena os dados de antecipação de cartão enviados ao banco BTG type: object required: – id – loteId – dataSolicitacao – filialId – credenciadora – taxaMediaMensal – taxaEfetiva – valorBruto – valorRecebido – valorDesconto – prazoMedio – estadoOperacao – banco – agencia – contaDesembolso – digitoVerificadorConta properties: id: type: string format: uuid description: Identificador do registro loteId: type: string format: uuid description: Lote de processamento dataSolicitacao: type: string format: date description: Data do pedido de antecipação filialId: type: string format: uuid description: Identificador da filial credenciadora: type: string allOf: – #/definitions/enumCredenciadoraCartao description: Credenciadora/Maquininha de cartão de crédito taxaMediaMensal: type: string description: Média das taxas de desconto dos recebíveis taxaEfetiva: type: string description: Taxa de desconto efetiva para 30 dias valorBruto: type: string description: Soma bruta das unidades recebíveis valorRecebido: type: string description: Soma líquida das unidades recebíveis valorDesconto: type: string description: Diferença entre o valor bruto e o valor recebido prazoMedio: type: integer format: int64 description: Prazo médio de recebimento das unidades recebíveis estadoOperacao: type: string allOf: – #/definitions/enumEstadoOperacao description: Estado da operação banco: type: string maxLength: 5 description: O código do banco da conta do estabelecimento comercial agencia: type: string maxLength: 5 description: Agência da conta do estabelecimento comercial contaDesembolso: type: string maxLength: 15 description: Número da conta do estabelecimento comercial digitoVerificadorConta: type: string maxLength: 2 description: Dígito da conta do estabelecimento comercial unidadesRecebiveis: type: array items: type: object allOf: – #/definitions/antecipacaoCartaoItem description: Dados das Unidades Recebíveis enviadas ao banco BTG antecipacaoCartaoErro: type: array items: type: object allOf: – #/definitions/antecipacaoCartaoErro description: Erros no envio da antecipação ao banco BTG usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: antecipacaoCartaoItem: description: Armazena os dados das Unidades Recebíveis enviadas ao banco BTG type: object required: – id – dataSolicitacao – filialId – credenciadora – bandeiraCartao – recebivelId – vencimentoRecebivel – valorDisponivelAntecipar – valorMaximoReceber – diasCorridos – taxaMensal – valorDesconto – estadoRecebivel properties: id: type: string format: uuid description: Identificador do registro dataSolicitacao: type: string format: date description: Data do pedido de antecipação filialId: type: string format: uuid description: Identificador da filial credenciadora: type: string allOf: – #/definitions/enumCredenciadoraCartao description: Credenciadora/Maquininha de cartão de crédito bandeiraCartao: type: string allOf: – #/definitions/enumBandeiraCartaoCredito description: Bandeira do cartão de crédito recebivelId: type: integer format: int64 description: Identificador do recebível vencimentoRecebivel: type: string format: date description: Data de vencimento do recebível valorDisponivelAntecipar: type: string description: Valor do recebível valorMaximoReceber: type: string description: Valor máximo a receber valorRegistrado: type: string description: Parte do valorDisponivelAntecipar que foi possível ser registrado na Registradora diasCorridos: type: integer format: int64 description: Diferença entre a data de vencimento e a data de antecipação taxaMensal: type: string description: Taxa de desconto efetiva para 30 dias valorDesconto: type: string description: Diferença entre o valorDisponivelAntecipar e o valorMaximoReceber estadoRecebivel: type: string allOf: – #/definitions/enumEstadoRecebivel description: Estado da Unidade Recebível antecipacaoCartaoDados: type: object allOf: – #/definitions/antecipacaoCartaoDados description: Dados de antecipação de cartão enviados ao banco BTG antecipacaoCartaoItemHistorico: type: array items: type: object allOf: – #/definitions/antecipacaoCartaoItemHistorico description: Histórico de antecipação das Unidades Recebíveis enviadas ao banco BTG usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editAntecipacaoCartaoItem: type: object required: – id allOf: – #/definitions/antecipacaoCartaoItem antecipacaoCartaoItemHistorico: description: Armazena o histórico de antecipação das Unidades Recebíveis enviadas ao banco BTG type: object required: – id – estadoRecebivel properties: id: type: string format: uuid description: Identificador do registro estadoRecebivel: type: string allOf: – #/definitions/enumEstadoRecebivel description: Estado da Unidade Recebível mensagem: type: string description: Mensagem unidadeRecebivel: type: object allOf: – #/definitions/antecipacaoCartaoItem description: Unidade Recebível usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editAntecipacaoCartaoItemHistorico: type: object required: – id allOf: – #/definitions/antecipacaoCartaoItemHistorico antecipacaoCartaoErro: description: Armazena os códigos de erros que a API do BTG devolve quando falha em operar type: object required: – id – codigo – descricao properties: id: type: string format: uuid description: Identificador do registro codigo: type: string description: Código do erro descricao: type: string description: Descrição do erro antecipacaoCartaoDados: type: object allOf: – #/definitions/antecipacaoCartaoDados description: Dados 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: editAntecipacaoCartaoErro: type: object required: – id allOf: – #/definitions/antecipacaoCartaoErro 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

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação