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

contas

1 views 0 11/09/2025 integrador

2.0info: 2.1.0 contas x-senior-domain: erpx_bnk_tes x-senior-domain-path: erpx_bnk_tes x-senior-service-path: contas 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_tessecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /contas/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 /contas/queries/listContas: post: description: Lista contas bancárias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cnpj – pageRequest properties: cnpj: type: string maxLength: 14 description: CNPJ filtro: type: object allOf: – #/definitions/recListContaFiltro description: Filtro pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – contas – totalElements properties: contas: type: array items: type: object allOf: – #/definitions/recConta minimum: 1 description: Contas totalElements: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas/queries/getSaldoTotal: post: description: Retorna saldo total de todas as contas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string maxLength: 14 description: CNPJ filtro: type: array items: type: object allOf: – #/definitions/recFiltroConta description: Filtro responses: 200: description: Ok schema: type: object required: – valorTotalDisponivel – valorTotalBloqueado properties: valorTotalDisponivel: type: string description: Valor total disponível valorTotalBloqueado: type: string description: Valor total bloqueado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas/queries/listSaldoBancos: post: description: Lista o saldo de cada banco tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cnpj – pageRequest properties: cnpj: type: string maxLength: 14 description: CNPJ filtro: type: array items: type: object allOf: – #/definitions/recFiltroConta description: Filtro pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – saldos – totalElements properties: saldos: type: array items: type: object allOf: – #/definitions/recSaldoBanco minimum: 1 description: Saldos totalElements: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas/queries/listSaldoContas: post: description: Lista o saldo das contas de cada banco tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cnpj – pageRequest properties: cnpj: type: string maxLength: 14 description: CNPJ filtro: type: object allOf: – #/definitions/recFiltroSaldoConta description: Saldos pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – saldos – totalElements properties: saldos: type: array items: type: object allOf: – #/definitions/recSaldoConta minimum: 1 description: Saldos totalElements: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas/queries/listConsolidadoDiario: post: description: Lista o consolidado diário das movimentações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cnpj – dataInicial – dataFinal – pageRequest properties: cnpj: type: string maxLength: 14 description: CNPJ dataInicial: type: string format: date description: Data inicial dataFinal: type: string format: date description: Data final filtro: type: array items: type: object allOf: – #/definitions/recFiltroConta description: Filtro pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – consolidados – totalElements properties: consolidados: type: array items: type: object allOf: – #/definitions/recConsolidadoDiario minimum: 1 description: Dados dos extratos consolidados diários totalElements: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas/queries/eligibleToExclude: post: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: id description: Id do registro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas/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 /contas/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 /contas/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 /contas/queries/exportCargaInicial: 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 /contas/queries/exportConta: 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 /contas/queries/exportSaldoConta: 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 /contas/queries/exportExtratoConta: 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 /contas/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 /contas/actions/atualizarExtrato: post: description: API responsável por atualizar o extrato de acordo com as movimentações financeiras da conta tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/movimentoConta responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas/actions/atualizarSaldo: post: description: API responsável por atualizar o saldo da conta tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/saldoDisponivel responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas/actions/softExclude: post: description: Realiza a exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas/actions/undoSoftExclude: post: description: Realiza a compensação da exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas/actions/getTablesWithForeignKeyReferences: post: description: Retorna quais tabelas possuem Foreign Keys para a tabela informada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tableNames properties: tableNames: type: array items: type: string minimum: 1 description: Nomes das tabelas responses: 200: description: Ok schema: type: object required: – tablesReferences properties: tablesReferences: type: array items: type: object allOf: – #/definitions/tableForeignKeyReference minimum: 1 description: Lista de tabelas referenciadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas/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 /contas/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 /contas/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 /contas/actions/importCargaInicial: 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 /contas/actions/importConta: 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 /contas/actions/importSaldoConta: 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 /contas/actions/importExtratoConta: 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 /contas/events/statementUpdated: post: description: Evento público responsável por informar a atualização do extrato de acordo com as movimentações financeiras da conta x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/accountMovement responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contas/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 /contas/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 /contas/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 /contas/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 /contas/events/importCargaInicialEvent: 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 /contas/events/exportCargaInicialEvent: 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 /contas/events/importContaEvent: 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 /contas/events/exportContaEvent: 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 /contas/events/importSaldoContaEvent: 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 /contas/events/exportSaldoContaEvent: 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 /contas/events/importExtratoContaEvent: 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 /contas/events/exportExtratoContaEvent: 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 /contas/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 /contas/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 /contas/entities/cargaInicial: 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/cargaInicial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas/entities/conta: 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/conta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas/entities/saldoConta: 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/saldoConta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas/entities/conta/{parentId}/saldoConta: 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: object allOf: – #/definitions/saldoConta responses: 200: description: The created resource schema: #/definitions/saldoConta 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: object allOf: – #/definitions/saldoConta responses: 200: description: The created resource schema: #/definitions/saldoConta 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/saldoConta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas/entities/conta/{parentId}/saldoConta/{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/editSaldoConta responses: 200: description: Ok schema: #/definitions/editSaldoConta 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/saldoConta responses: 200: description: Ok schema: #/definitions/saldoConta 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/saldoConta 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 /contas/entities/extratoConta: 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/extratoConta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas/entities/conta/{parentId}/extratoConta: 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/extratoConta responses: 200: description: The created resources schema: type: array items: #/definitions/extratoConta 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/extratoConta responses: 200: description: The created resources schema: type: array items: #/definitions/extratoConta 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/extratoConta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas/entities/conta/{parentId}/extratoConta/{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/editExtratoConta responses: 200: description: Ok schema: #/definitions/editExtratoConta 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/extratoConta responses: 200: description: Ok schema: #/definitions/extratoConta 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/extratoConta 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 enumBanco: type: string enum: – AILOS – AGIBANK – ASAAS – BANCO_ABC – BANCO_BMG – BANCO_BV – BANCO_DA_AMAZONIA – BANCO_DO_BRASIL – BANCO_FIBRA – BANCO_INTER – BANCO_MERCANTIL – BANCO_NORDESTE_BRASIL – BANCO_ORIGINAL – BANCO_PAN – BANCO_PAULISTA – BANCO_SAFRA – BANCO_SOFISA – BANCO_XP – BANPARA – BANRISUL – BRADESCO – BTG_PACTUAL – C6_BANK – CAIXA_ECONOMICA_FEDERAL – CITIBANK – CREFISA – CRESOL – DAYCOVAL – DIGIO – ITAU – NEON – NUBANK – PARANA_BANCO – PICPAY – SANTANDER – SICREDI – SICOOB – UNICRED description: Enumeration de bancos de recebimento: * `AILOS` – Ailos – 085 * `AGIBANK` – Agibank – 121 * `ASAAS` – Asaas – 461 * `BANCO_ABC` – Banco ABC – 246 * `BANCO_BMG` – Banco BMG – 318 * `BANCO_BV` – Banco BV – 413 * `BANCO_DA_AMAZONIA` – Banco da Amazônia – 003 * `BANCO_DO_BRASIL` – Banco do Brasil – 001 * `BANCO_FIBRA` – Banco Fibra – 224 * `BANCO_INTER` – Banco Inter – 077 * `BANCO_MERCANTIL` – Banco Mercantil – 389 * `BANCO_NORDESTE_BRASIL` – Banco do Nordeste do Brasil – 004 * `BANCO_ORIGINAL` – Banco Original – 212 * `BANCO_PAN` – Banco Pan – 623 * `BANCO_PAULISTA` – Banco Paulista – 611 * `BANCO_SAFRA` – Banco Safra – 422 * `BANCO_SOFISA` – Banco Sofisa – 637 * `BANCO_XP` – Banco XP – 348 * `BANPARA` – Banpará – 037 * `BANRISUL` – Banrisul – 041 * `BRADESCO` – Bradesco – 237 * `BTG_PACTUAL` – BTG Pactual – 208 * `C6_BANK` – C6 Bank – 336 * `CAIXA_ECONOMICA_FEDERAL` – Caixa Econômica Federal – 104 * `CITIBANK` – Citibank – 745 * `CREFISA` – Crefisa – 069 * `CRESOL` – Cresol – 133 * `DAYCOVAL` – Daycoval – 707 * `DIGIO` – Digio – 335 * `ITAU` – Itaú – 341 * `NEON` – Neon – 536 * `NUBANK` – Nubank – 260 * `PARANA_BANCO` – Paraná Banco – 254 * `PICPAY` – PicPay – 380 * `SANTANDER` – Santander – 033 * `SICREDI` – Sicredi – 748 * `SICOOB` – Sicoob – 756 * `UNICRED` – Unicred – 126 enumTipoConta: type: string enum: – CONTA_CORRENTE – CONTA_INVESTIMENTO – OPEN_FINANCE description: Enumeration de tipos de conta: * `CONTA_CORRENTE` – Conta Corrente * `CONTA_INVESTIMENTO` – Conta Investimento * `OPEN_FINANCE` – Open Finance enumEscopo: type: string enum: – SALDO – EXTRATO – CONTA description: Escopos disponiveis no banco BTG: * `SALDO` – Saldo * `EXTRATO` – Extrato * `CONTA` – Conta enumSituacaoCargaInicial: type: string enum: – PENDENTE – PROCESSANDO – SUCESSO – ERRO description: Situação da carga inicial: * `PENDENTE` – Pendente * `PROCESSANDO` – Processando * `SUCESSO` – Sucesso * `ERRO` – Erro enumOperacao: type: string enum: – DEBITO – CREDITO description: Tipo da operação: * `DEBITO` – Débito * `CREDITO` – Crédito enumCreditDebitIndicator: type: string enum: – DEBIT – CREDIT description: Tipo da operação: * `DEBIT` – Débito * `CREDIT` – Crédito enumMovementType: type: string enum: – PIX – BOLETO – OUTROS description: Tipo da operação: * `PIX` – Pix * `BOLETO` – Boleto * `OUTROS` – Outros 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 movimentoConta: description: Dados da movimentação type: object required: – data properties: webhookId: type: string description: Id do webhook event: type: string description: Evento publicado data: type: object allOf: – #/definitions/detalhesMovimentacao description: Detalhes da movimentação detalhesMovimentacao: description: Detalhes da movimentação type: object required: – accountId – date – creditDebitIndicator – amount – currency properties: accountId: type: string description: Id da conta date: type: string description: Data da movimentação creditDebitIndicator: type: string description: Indica se é crédito ou débito amount: type: string description: Valor da movimentação currency: type: string description: Moeda transactionId: type: string description: Id da transação type: type: string description: Tipo de pagamento/cobrança reason: type: string description: Razão relatedParty: type: object allOf: – #/definitions/recRelatedParty description: Dados da conta payload: type: object allOf: – #/definitions/recTransaction description: Dados de transação description: type: string description: Descrição febrabanCode: type: string description: Código de ocorrência accountMovement: description: Dados da movimentação type: object required: – account – movementDate – creditDebitIndicator – amount – currency properties: account: type: object allOf: – #/definitions/recAccount description: Dados da conta movementDate: type: string format: date-time description: Data da movimentação creditDebitIndicator: type: string allOf: – #/definitions/enumCreditDebitIndicator description: Indica se é crédito ou débito amount: type: string description: Valor da movimentação currency: type: string description: Moeda documentNumber: type: string description: Número do documento movementType: type: string allOf: – #/definitions/enumMovementType description: Tipo de pagamento/cobrança reason: type: string description: Razão relatedParty: type: object allOf: – #/definitions/recRelatedParty description: Dados da parte relacionada transaction: type: object allOf: – #/definitions/recTransaction description: Dados de transação description: type: string description: Descrição febrabanCode: type: string description: Código de ocorrência saldoDisponivel: description: Dados de saldo disponível type: object properties: webhookId: type: string description: Id do webhook event: type: string description: Evento publicado data: type: object allOf: – #/definitions/detalhesSaldoDisponivel description: Detalhes do saldo disponível detalhesSaldoDisponivel: description: Dados de saldo disponível type: object required: – accountId – bankCode – taxId – branchCode – number – timestamp – available properties: accountId: type: string description: Id da conta bankCode: type: string description: Cóigo do banco taxId: type: string description: Documento CNPJ/CPF branchCode: type: string description: Agência number: type: string description: Número da conta timestamp: type: string description: Data/hora da atualização do saldo available: type: object allOf: – #/definitions/recAvailable description: Dados do valor disponível recAccount: description: Dados da conta type: object required: – taxId – bankCode – branchCode – number properties: taxId: type: string description: Número do documento bankCode: type: string description: Código do banco branchCode: type: string description: Agência number: type: string description: Número da conta recRelatedParty: description: Dados da parte relacionada type: object properties: taxId: type: string description: Número do documento bankCode: type: string description: Código do banco name: type: string description: Nome currency: type: string description: Moeda branchCode: type: string description: Agência number: type: string description: Número da conta recTransaction: description: Dados de transação type: object properties: txId: type: string description: Id da transação endToEndId: type: string description: Id da transação pix barCode: type: string description: Código de barras ourNumber: type: string description: Nosso número recAvailable: description: Dados do valor disponível type: object required: – amount properties: amount: type: string description: Valor disponível 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 recConsolidadoDiario: description: Dados dos extratos consolidados diários type: object properties: data: type: string format: date description: Data das movimentações saldo: type: string description: Saldo total do dia recConta: description: Dados da conta type: object properties: banco: type: string allOf: – #/definitions/enumBanco description: Banco tipo: type: string allOf: – #/definitions/enumTipoConta description: Tipo de conta numero: type: string maxLength: 15 description: Número da Conta agencia: type: string maxLength: 7 description: Agência da conta recListContaFiltro: description: Record para filtro da listagem de contas type: object properties: banco: type: array items: type: string allOf: – #/definitions/enumBanco description: Banco tipo: type: array items: type: string allOf: – #/definitions/enumTipoConta description: Tipo de conta numero: type: string maxLength: 15 description: Número da Conta agencia: type: string maxLength: 7 description: Agência da conta 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) recFiltroConta: description: Dados do saldo type: object properties: banco: type: string allOf: – #/definitions/enumBanco description: Banco numero: type: string maxLength: 15 description: Número da Conta recSaldoBanco: description: Dados do saldo dos bancos type: object properties: banco: type: string allOf: – #/definitions/enumBanco description: Banco valorDisponivel: type: string description: Valor Disponivel valorBloqueado: type: string description: Valor Bloqueado recFiltroSaldoConta: description: Dados do saldo das contas type: object required: – banco properties: banco: type: string allOf: – #/definitions/enumBanco description: Banco numeros: type: array items: type: string description: Contas recSaldoConta: description: Dados do saldo das contas type: object required: – valorDisponivel – valorBloqueado properties: banco: type: string allOf: – #/definitions/enumBanco description: Banco numero: type: string maxLength: 15 description: Número da Conta agencia: type: string maxLength: 7 description: Agência da conta valorDisponivel: type: string description: Valor Disponivel valorBloqueado: type: string description: Valor Bloqueado tableForeignKeyReference: description: Resulado da consulta de tabelas referenciada por uma Foreign Key type: object required: – referenceTableName – tableName – columnName – constraintName properties: referenceTableName: type: string description: Referenced table tableName: type: string description: Tabela referenciada columnName: type: string description: Coluna referenciada pela FK exclusionField: type: string description: Coluna com o campo de exclusão constraintName: type: string description: Nome da ForeignKey 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 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: cargaInicial: description: Carga inicial de contas, saldos e extratos type: object required: – cnpj – escopo – situacao properties: id: type: string format: uuid description: Id da entidade cnpj: type: string maxLength: 14 description: CNPJ escopo: type: string allOf: – #/definitions/enumEscopo description: Escopo situacao: type: string allOf: – #/definitions/enumSituacaoCargaInicial description: Situação mensagemErro: type: string description: Mensagem de erro usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: conta: description: Conta bancária type: object required: – cnpj – banco – agencia – numero properties: id: type: string format: uuid description: Id da entidade cnpj: type: string maxLength: 14 description: CNPJ banco: type: string allOf: – #/definitions/enumBanco description: Banco agencia: type: string maxLength: 19 description: Agência numero: type: string maxLength: 15 description: Número tipo: type: string allOf: – #/definitions/enumTipoConta description: Tipo da conta saldoConta: type: object allOf: – #/definitions/saldoConta description: Saldo da conta extratoConta: type: array items: type: object allOf: – #/definitions/extratoConta description: Extratos da conta usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: saldoConta: description: Saldo da conta bancária type: object required: – saldoDisponivel – saldoBloqueado properties: id: type: string format: uuid description: Id da entidade conta: type: object allOf: – #/definitions/conta description: Conta saldoDisponivel: type: string description: Saldo disponível saldoBloqueado: type: string description: Saldo bloqueado usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editSaldoConta: type: object required: – id allOf: – #/definitions/saldoConta extratoConta: description: Extrato da conta bancária type: object required: – data – operacao – valor properties: id: type: string format: uuid description: Id da entidade conta: type: object allOf: – #/definitions/conta description: Conta data: type: string format: date-time description: Data da movimentação operacao: type: string allOf: – #/definitions/enumOperacao description: Operação descricao: type: string description: Descrição valor: type: string description: Valor da movimentação codigoFebraban: type: string description: Código de ocorrência da FEBRABAN usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editExtratoConta: type: object required: – id allOf: – #/definitions/extratoConta 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