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

pagamento_escritural

35 views 0 14/09/2022 Atualizado em 24/11/2025 integrador

2.0info: 2.0.3 pagamento_escritural description: Serviço do Pagamento Escritural x-senior-domain: Dominio do Finanças x-senior-domain-path: erpx_fin x-senior-service-path: pagamento_escritural 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_finsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /pagamento_escritural/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço 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 geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço 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 geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/queries/obterUrlUploadAnexo: post: description: Cria o local para armazenamento e busca URL para upload do anexo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/recArquivo responses: 200: description: Ok schema: type: object allOf: – #/definitions/recArquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Cria o local para armazenamento e busca URL para upload do anexo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: targetObject description: targetObject do arquivo necessário no blobService in: query type: string – name: nome description: nome do arquivo, informado no input in: query required: true type: string – name: url description: URL para upload do arquivo in: query type: string – name: versao description: versão do arquivo criado in: query type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/recArquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/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 /pagamento_escritural/queries/exportArquivoRemessaDados: 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 /pagamento_escritural/queries/exportArquivoRemessaItem: 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 /pagamento_escritural/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 /pagamento_escritural/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 /pagamento_escritural/queries/exportE007ufs: 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 /pagamento_escritural/queries/exportE600cco: 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 /pagamento_escritural/queries/exportE030ban: 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 /pagamento_escritural/queries/exportE030age: 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 /pagamento_escritural/queries/exportE501tcp: 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 /pagamento_escritural/queries/exportE002tpt: 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 /pagamento_escritural/queries/exportE001pes: 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 /pagamento_escritural/queries/exportE008rai: 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 /pagamento_escritural/queries/exportE077pes: 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 /pagamento_escritural/queries/exportDadosPagamentoEletronico: 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 /pagamento_escritural/queries/exportFinalidadeTedDoc: 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 /pagamento_escritural/queries/exportPagamentoValoresImpostos: 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 /pagamento_escritural/queries/exportPagamentoValoresAdicionais: 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 /pagamento_escritural/queries/exportArquivoRemessaRetornoDados: 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 /pagamento_escritural/queries/exportArquivoRemessaRetornoItem: 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 /pagamento_escritural/queries/exportOcorrenciaBanco: 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 /pagamento_escritural/queries/exportE600ccoFinCpa: 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 /pagamento_escritural/queries/exportE001tns: 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 /pagamento_escritural/queries/exportE070filFinCpa: 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 /pagamento_escritural/queries/exportE070filFinTes: 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 /pagamento_escritural/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 /pagamento_escritural/actions/importarArquivoRetorno: post: description: Importar arquivos retorno pagamento eletrônico tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – arquivos properties: arquivos: type: array items: type: object allOf: – #/definitions/recArquivo minimum: 1 description: Url do arquivo responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: Ticket de processamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/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 /pagamento_escritural/actions/importArquivoRemessaDados: 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 /pagamento_escritural/actions/importArquivoRemessaItem: 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 /pagamento_escritural/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 /pagamento_escritural/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 /pagamento_escritural/actions/importE007ufs: 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 /pagamento_escritural/actions/importE600cco: 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 /pagamento_escritural/actions/importE030ban: 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 /pagamento_escritural/actions/importE030age: 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 /pagamento_escritural/actions/importE501tcp: 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 /pagamento_escritural/actions/importE002tpt: 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 /pagamento_escritural/actions/importE001pes: 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 /pagamento_escritural/actions/importE008rai: 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 /pagamento_escritural/actions/importE077pes: 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 /pagamento_escritural/actions/importDadosPagamentoEletronico: 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 /pagamento_escritural/actions/importFinalidadeTedDoc: 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 /pagamento_escritural/actions/importPagamentoValoresImpostos: 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 /pagamento_escritural/actions/importPagamentoValoresAdicionais: 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 /pagamento_escritural/actions/importArquivoRemessaRetornoDados: 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 /pagamento_escritural/actions/importArquivoRemessaRetornoItem: 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 /pagamento_escritural/actions/importOcorrenciaBanco: 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 /pagamento_escritural/actions/importE600ccoFinCpa: 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 /pagamento_escritural/actions/importE001tns: 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 /pagamento_escritural/actions/importE070filFinCpa: 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 /pagamento_escritural/actions/importE070filFinTes: 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 /pagamento_escritural/signals/gerarArquivoRemessaPagamentoEletronico: post: description: Inicia a geração do arquivo de remessa para o pagamento eletrônico tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – arquivoRemessaDadosId – callback properties: processId: type: string description: Identificador do processo arquivoRemessaDadosId: type: string description: Identificador do arquivo de remessa callback: type: object allOf: – #/definitions/callback description: Primitiva de retorno para este serviço responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /pagamento_escritural/signals/importarArquivoRetornoAsync: post: description: Signal de processamento assincrono tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – arquivoRemessaRetornoDadosId properties: arquivoRemessaRetornoDadosId: type: string description: ID ta tabela responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /pagamento_escritural/signals/gerarLoteArquivoRetornoRemessaRetorno: post: description: Gerar lote arquivos remessa retorno remessa tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – arquivoRetornoRemessaDadosId – loteFinanceiroId properties: processId: type: string description: Process id asyncCaller arquivoRetornoRemessaDadosId: type: string description: Id do arquivo retorno remessa dados loteFinanceiroId: type: string description: Lote financeiro gerado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /pagamento_escritural/signals/baixarTituloPagamentoEletronicoAutomaticamenteRetorno: post: description: Retorno da Baixa Automatica da remessa de retorno tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – arquivoRetornoRemessaDadosId – recTitulos properties: processId: type: string description: Process id asyncCaller arquivoRetornoRemessaDadosId: type: string description: Id do arquivo retorno remessa dados recTitulos: type: array items: type: object allOf: – #/definitions/recTitulos minimum: 1 description: Ocorreu erro nas baixas automaticas responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /pagamento_escritural/events/importArquivoRemessaDadosEvent: 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 /pagamento_escritural/events/exportArquivoRemessaDadosEvent: 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 /pagamento_escritural/events/importArquivoRemessaItemEvent: 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 /pagamento_escritural/events/exportArquivoRemessaItemEvent: 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 /pagamento_escritural/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 /pagamento_escritural/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 /pagamento_escritural/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 /pagamento_escritural/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 /pagamento_escritural/events/importE007ufsEvent: 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 /pagamento_escritural/events/exportE007ufsEvent: 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 /pagamento_escritural/events/importE600ccoEvent: 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 /pagamento_escritural/events/exportE600ccoEvent: 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 /pagamento_escritural/events/importE030banEvent: 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 /pagamento_escritural/events/exportE030banEvent: 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 /pagamento_escritural/events/importE030ageEvent: 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 /pagamento_escritural/events/exportE030ageEvent: 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 /pagamento_escritural/events/importE501tcpEvent: 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 /pagamento_escritural/events/exportE501tcpEvent: 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 /pagamento_escritural/events/importE002tptEvent: 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 /pagamento_escritural/events/exportE002tptEvent: 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 /pagamento_escritural/events/importE001pesEvent: 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 /pagamento_escritural/events/exportE001pesEvent: 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 /pagamento_escritural/events/importE008raiEvent: 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 /pagamento_escritural/events/exportE008raiEvent: 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 /pagamento_escritural/events/importE077pesEvent: 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 /pagamento_escritural/events/exportE077pesEvent: 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 /pagamento_escritural/events/importDadosPagamentoEletronicoEvent: 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 /pagamento_escritural/events/exportDadosPagamentoEletronicoEvent: 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 /pagamento_escritural/events/importFinalidadeTedDocEvent: 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 /pagamento_escritural/events/exportFinalidadeTedDocEvent: 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 /pagamento_escritural/events/importPagamentoValoresImpostosEvent: 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 /pagamento_escritural/events/exportPagamentoValoresImpostosEvent: 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 /pagamento_escritural/events/importPagamentoValoresAdicionaisEvent: 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 /pagamento_escritural/events/exportPagamentoValoresAdicionaisEvent: 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 /pagamento_escritural/events/importArquivoRemessaRetornoDadosEvent: 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 /pagamento_escritural/events/exportArquivoRemessaRetornoDadosEvent: 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 /pagamento_escritural/events/importArquivoRemessaRetornoItemEvent: 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 /pagamento_escritural/events/exportArquivoRemessaRetornoItemEvent: 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 /pagamento_escritural/events/importOcorrenciaBancoEvent: 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 /pagamento_escritural/events/exportOcorrenciaBancoEvent: 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 /pagamento_escritural/events/importE600ccoFinCpaEvent: 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 /pagamento_escritural/events/exportE600ccoFinCpaEvent: 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 /pagamento_escritural/events/importE001tnsEvent: 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 /pagamento_escritural/events/exportE001tnsEvent: 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 /pagamento_escritural/events/importE070filFinCpaEvent: 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 /pagamento_escritural/events/exportE070filFinCpaEvent: 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 /pagamento_escritural/events/importE070filFinTesEvent: 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 /pagamento_escritural/events/exportE070filFinTesEvent: 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 /pagamento_escritural/entities/arquivoRemessaDados/{parentId}/itens: 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/arquivoRemessaItem responses: 200: description: The created resources schema: type: array items: #/definitions/arquivoRemessaItem 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/arquivoRemessaItem responses: 200: description: The created resources schema: type: array items: #/definitions/arquivoRemessaItem 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/arquivoRemessaItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/arquivoRemessaDados/{parentId}/itens/{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/editArquivoRemessaItem responses: 200: description: Ok schema: #/definitions/editArquivoRemessaItem 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/arquivoRemessaItem responses: 200: description: Ok schema: #/definitions/arquivoRemessaItem 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/arquivoRemessaItem 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 /pagamento_escritural/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 /pagamento_escritural/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 /pagamento_escritural/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 /pagamento_escritural/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 /pagamento_escritural/entities/e007ufs: 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/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/e007ufs/{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/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/e030ban: 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/e030ban 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/e030ban/{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/e030ban 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/e030age: 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/e030age 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/e030age/{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/e030age 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/e501tcp: get: 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/e501tcp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/e002tpt: 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/e002tpt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/e001pes: 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/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/e001pes/{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/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/e008rai: 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/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/e077pes: 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/e077pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/e077pes/{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/e077pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/dadosPagamentoEletronico: 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/dadosPagamentoEletronico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/finalidadeTedDoc: 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/finalidadeTedDoc 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/pagamentoValoresImpostos: 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/pagamentoValoresImpostos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/pagamentoValoresAdicionais: 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/pagamentoValoresAdicionais 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/arquivoRemessaRetornoDados: 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/arquivoRemessaRetornoDados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/arquivoRemessaRetornoItem: 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/arquivoRemessaRetornoItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/arquivoRemessaRetornoDados/{parentId}/arquivoRemessaRetornoItens: 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/arquivoRemessaRetornoItem responses: 200: description: The created resources schema: type: array items: #/definitions/arquivoRemessaRetornoItem 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/arquivoRemessaRetornoItem responses: 200: description: The created resources schema: type: array items: #/definitions/arquivoRemessaRetornoItem 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/arquivoRemessaRetornoItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/arquivoRemessaRetornoDados/{parentId}/arquivoRemessaRetornoItens/{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/editArquivoRemessaRetornoItem responses: 200: description: Ok schema: #/definitions/editArquivoRemessaRetornoItem 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/arquivoRemessaRetornoItem responses: 200: description: Ok schema: #/definitions/arquivoRemessaRetornoItem 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/arquivoRemessaRetornoItem 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 /pagamento_escritural/entities/e600cco/{parentId}/e600ccoFinCpa: 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/e600ccoFinCpa responses: 200: description: The created resource schema: #/definitions/e600ccoFinCpa 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/e600ccoFinCpa responses: 200: description: The created resource schema: #/definitions/e600ccoFinCpa 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/e600ccoFinCpa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento_escritural/entities/e600cco/{parentId}/e600ccoFinCpa/{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/editE600ccoFinCpa responses: 200: description: Ok schema: #/definitions/editE600ccoFinCpa 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/e600ccoFinCpa responses: 200: description: Ok schema: #/definitions/e600ccoFinCpa 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/e600ccoFinCpa 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: enumAplGrp: type: string enum: – VA – VR – VP description: Tipo de Aplicação: * `VA` – Ambos * `VR` – Contas a Receber * `VP` – Contas a Pagar upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumSitReg: type: string enum: – VA – VI description: Situação do registro: * `VA` – Ativo * `VI` – Inativo enumTipoPagamentoEletronico: type: string enum: – PIX_QRCODE – BOLETO – PIX_TRANSFERENCIA – TED – GUIA_CODIGO_BARRAS – GRU – DARF – GPS description: Enum do tipo de pagamento: * `PIX_QRCODE` – PIX QRCODE * `BOLETO` – Boleto * `PIX_TRANSFERENCIA` – Pix Transferencia * `TED` – Transferencia TED * `GUIA_CODIGO_BARRAS` – Guia com código de barras * `GRU` – Guia de Recolhimento da União(GRU) * `DARF` – Documento de Arrecadação de Receitas Federais(DARF) * `GPS` – Guia da Previdência Social(GPS) enumSituacaoGeracaoPagamentoEletronico: type: string enum: – PENDENTE – SUCESSO – ERRO – CANCELADO – PROCESSANDO description: Situação da Geração do Arquivo de Pagamento Eletrônico: * `PENDENTE` – Pendente * `SUCESSO` – Sucesso * `ERRO` – Erro * `CANCELADO` – Cancelado * `PROCESSANDO` – Processando enumSituacaoItemGeracaoPagamentoEletronico: type: string enum: – INICIADO – AGENDADO – ATUALIZACAO_TITULO – GERACAO_LOTE_FINANCEIRO – CALCULANDO_JUROS_MULTA_DESCONTOS – CALCULANDO_IMPOSTO – GERANDO_ARQUIVO – ARQUIVO_FINALIZADO – ERRO_AGENDADO – ERRO_ATUALIZACAO_TITULO – ERRO_GERACAO_LOTE_FINANCEIRO – ERRO_CALCULO_JUROS_MULTA_DESCONTOS – ERRO_CALCULO_IMPOSTO – ERRO_GERACAO_ARQUIVO – CANCELADO – ERRO_INESPERADO – ERRO_CANCELAMENTO – ERRO_CANCELAMENTO_MANUAL – PROCESSANDO_CANCELAMENTO_MANUAL – PROCESSANDO_CANCELAMENTO – CANCELADO_MANUAL description: Status da geração do arquivo de pagamento eletrônico: * `INICIADO` – Iniciado * `AGENDADO` – Agendado * `ATUALIZACAO_TITULO` – Atualização da situação do título * `GERACAO_LOTE_FINANCEIRO` – Geração do lote financeiro * `CALCULANDO_JUROS_MULTA_DESCONTOS` – Calculando juros, multas e descontos * `CALCULANDO_IMPOSTO` – Calculando Imposto * `GERANDO_ARQUIVO` – Gerando arquivo * `ARQUIVO_FINALIZADO` – Arquivo finalizado * `ERRO_AGENDADO` – Erro no agendado * `ERRO_ATUALIZACAO_TITULO` – Erro na atualização da situação do título * `ERRO_GERACAO_LOTE_FINANCEIRO` – Erro na geração do lote financeiro * `ERRO_CALCULO_JUROS_MULTA_DESCONTOS` – Erro no cálculo de juros, multas e descontos * `ERRO_CALCULO_IMPOSTO` – Erro no cálculo de imposto * `ERRO_GERACAO_ARQUIVO` – Erro na geração do arquivo * `CANCELADO` – Cancelado * `ERRO_INESPERADO` – Erro inesperado * `ERRO_CANCELAMENTO` – Erro cancelamento automático * `ERRO_CANCELAMENTO_MANUAL` – Erro cancelamento manual * `PROCESSANDO_CANCELAMENTO_MANUAL` – Processando Cancelamento Manual * `PROCESSANDO_CANCELAMENTO` – Processando Cancelamento automático * `CANCELADO_MANUAL` – Cancelado Manual enumTipTcc: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 description: Tipo da conta bancária: * `V1` – Conta Corrente * `V2` – Conta Poupança * `V3` – Conta Investimento * `V4` – Conta Aplicação Financeira * `V5` – Conta Empréstimo * `V6` – Cota Capital * `V7` – Conta de Retenção * `V8` – Conta da Loja * `V9` – Conta Salário * `V10` – Outros enumTipoChavePix: type: string enum: – CNPJ – CPF – EMAIL – TELEFONE – ALEATORIA description: Tipo de Chave PIX: * `CNPJ` – CNPJ * `CPF` – CPF * `EMAIL` – E-Mail * `TELEFONE` – Telefone * `ALEATORIA` – Aleatória enumSitTit: type: string enum: – VAO – VAN – VAA – VAB – VAC – VAE – VAI – VAJ – VAP – VAR – VAS – VAV – VAX – VCA – VCE – VCO – VLQ – VLC – VLI – VLM – VLO – VLP – VLS – VLV – VLX – VPE – VPB description: Situação do Título: * `VAO` – Aberto ao órgão de proteção ao crédito * `VAN` – Aberto Negociação * `VAA` – Aberto Advogado * `VAB` – Aberto Normal * `VAC` – Aberto Cartório * `VAE` – Aberto Encontro Contas * `VAI` – Aberto Impostos * `VAJ` – Aberto Retorno Jurídico * `VAP` – Aberto Protestado * `VAR` – Aberto Representante * `VAS` – Aberto Suspenso * `VAV` – Aberto Gestão de Pessoas * `VAX` – Aberto Externo * `VCA` – Cancelado * `VCE` – Aberto Cobrança Escritural * `VCO` – Aberto Cobrança * `VLQ` – Liquidado Normal * `VLC` – Liquidado Cartório * `VLI` – Liquidado Impostos * `VLM` – Liquidado Compensado * `VLO` – Liquidado Cobrança * `VLP` – Liquidado Prestado * `VLS` – Liquidado Substituído * `VLV` – Liquidado Gestão de Pessoas * `VLX` – Liquidado Externo * `VPE` – Aberto Pagamento Eletrônico * `VPB` – Em Processo de Baixa enumJurFis: type: string enum: – VJ – VF description: Tipo da pessoa: * `VJ` – Pessoa Jurídica * `VF` – Pessoa Física enumSituacaoDadosBancario: type: string enum: – ACEITA_SUGESTAO – PAGAMENTO_SUGERIDO – PAGAMENTO_MANUAL description: Situação da Informação Bancáriaa: * `ACEITA_SUGESTAO` – Aceita Sugestão * `PAGAMENTO_SUGERIDO` – Pagamento Sugerido * `PAGAMENTO_MANUAL` – Pagamento Manual enumTipoTransacao: type: string enum: – TED – DOC description: Tipo da Transação: * `TED` – Transferência Eletrônica Disponível * `DOC` – Documento de Ordem de Crédito enumSituacaoItemArquivo: type: string enum: – ERRO – PROCESSADO – TITULO_NAO_LOCALIZADO – CANCELADO description: Enum Situação item arquivo: * `ERRO` – ERRO * `PROCESSADO` – PROCESSADO * `TITULO_NAO_LOCALIZADO` – Titulo não Localizado * `CANCELADO` – CANCELADO enumOcorrenciaSistema: type: string enum: – ERRO – AGENDADO – PAGO – CANCELADO description: Enum Ocorrencia Sistema: * `ERRO` – ERRO * `AGENDADO` – AGENDADO * `PAGO` – PAGO * `CANCELADO` – CANCELADO enumSituacaoArquivo: type: string enum: – PENDENTE – SUCESSO – ERRO – CANCELADO – PROCESSANDO – AGUARDANDO_PROCESSAMENTO description: Enum Situação arquivo: * `PENDENTE` – Pendente * `SUCESSO` – Sucesso * `ERRO` – Erro * `CANCELADO` – Cancelado * `PROCESSANDO` – Processando * `AGUARDANDO_PROCESSAMENTO` – Aguardando processamento 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 recArquivo: description: record de arquivo type: object required: – nome properties: targetObject: type: string description: targetObject do arquivo necessário no blobService nome: type: string description: nome do arquivo, informado no input url: type: string description: URL para upload do arquivo versao: type: string description: versão do arquivo criado 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 callback: description: Record de Chamada de retorno type: object required: – dominio – servico – primitiva properties: dominio: type: string description: Dominio do service de retorno servico: type: string description: Serviço do service de retorno primitiva: type: string description: Primitiva do service de retorno recTitulos: description: Record lista de títulos pertencentes ao arquivo (callback) allOf: – #/definitions/recTitulosErro – type: object required: – ocorreuErro properties: ocorreuErro: type: boolean description: Indicador se ocorreu algum erro recTitulosErro: description: Record lista de títulos pertencentes ao arquivo (callback) discriminator: _discriminator type: object required: – e501tcpId – _discriminator properties: e501tcpId: type: string description: ID dos títulos de retorno mensagem: type: string description: Mensagem de erro de retorno do título _discriminator: type: string description: arquivoRemessaDados: description: Arquivo de remessa de envio para pagamento eletrônico type: object required: – ticket – nomeArquivo – e070fil – e600cco – data – situacao – arquivoPix – banco properties: id: type: string format: uuid description: Id da entidade ticket: type: string format: uuid description: Ticket de geração nomeArquivo: type: string description: Nome do arquivo gerado url: type: string description: URL de download do arquivo e070fil: type: object allOf: – #/definitions/e070fil description: Filial retentora do arquivo e070emp: type: object allOf: – #/definitions/e070emp description: Empresa retentora do arquivo e600cco: type: object allOf: – #/definitions/e600cco description: Banco retentor do arquivo data: type: string format: date-time description: Data e Hora do Agendamento da geração do arquivo situacao: type: string allOf: – #/definitions/enumSituacaoGeracaoPagamentoEletronico description: Situação do processo de geração do arquivo mensagem: type: string description: Mensagem de erro da geração do arquivo loteFinanceiro: type: string format: uuid description: Lote financeiro arquivoPix: type: boolean description: Arquivo referente a pagamentos PIX banco: type: string maxLength: 3 description: Banco ao qual o arquivo pertence itens: type: array items: type: object allOf: – #/definitions/arquivoRemessaItem description: Itens do Arquivo de Remessa de envio para pagamento eletrônico usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: arquivoRemessaItem: description: Itens do Arquivo de Remessa de envio para pagamento eletrônico type: object required: – e501tcpId – situacao properties: id: type: string format: uuid description: Id da entidade arquivoRemessaDados: type: object allOf: – #/definitions/arquivoRemessaDados description: Arquivo ao qual o item pertence e501tcpId: type: string format: uuid description: Id do Titulo dataPagamento: type: string format: date description: Data de Pagamento utilizada na geração do arquivo situacao: type: string allOf: – #/definitions/enumSituacaoItemGeracaoPagamentoEletronico description: Situação do Item do arquivo mensagem: type: string description: Mensagem de erro do item na geração do arquivo numeroTituloBanco: type: string maxLength: 20 description: Número do título no banco usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editArquivoRemessaItem: type: object required: – id allOf: – #/definitions/arquivoRemessaItem e070emp: description: Replicacao – Empresa type: object required: – codEmp – nomEmp properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome 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: Replicacao – Filiais type: object required: – e070emp – numcgc – codFil – nomFil – sigFil properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa numcgc: type: string maxLength: 18 description: CPF/CNPJ codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 99999 nomFil: type: string maxLength: 100 description: Nome sigFil: type: string maxLength: 100 description: Sigla endFil: type: string maxLength: 100 description: Endereço nenFil: type: string maxLength: 60 description: Número cplEnd: type: string maxLength: 200 description: Complemento filMat: type: boolean description: Filial matriz cidFil: type: string maxLength: 60 description: Cidade e007ufsSigUfs: type: object allOf: – #/definitions/e007ufs description: Estado postalCodeFil: type: string maxLength: 20 description: CEP e070filFinCpa: type: object allOf: – #/definitions/e070filFinCpa description: Cadastros – Filiais – Especialização Contas a Pagar excluido: type: boolean description: Indica se o registro foi excluído default: false e070filFinTes: type: object allOf: – #/definitions/e070filFinTes description: Especialização de tesouraria da filial 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: e007ufs: description: Estado type: object required: – sigUfs properties: id: type: string format: uuid description: Id da entidade sigUfs: type: string maxLength: 2 description: Sigla 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: e600cco: description: Tesouraria – Conta – Cadastro type: object required: – e070emp – numCco – desCco – abrCco – sitCco properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa numCco: type: string maxLength: 14 description: Conta Interna desCco: type: string maxLength: 30 description: Descrição abrCco: type: string maxLength: 10 description: Abreviatura e030ban: type: object allOf: – #/definitions/e030ban description: Banco e030age: type: object allOf: – #/definitions/e030age description: Agência numCta: type: string maxLength: 14 description: Conta Banco digCta: type: string maxLength: 2 description: Dígito verificador floBan: type: integer format: int64 description: Float Bancário (D+) minimum: 0 maximum: 9 datLim: type: string format: date description: Limite Crédito: Data vlrLim: type: string description: Valor minimum: 0.00 maximum: 9999999999999.99 utiTal: type: boolean description: Utiliza controle de Talonário default: false sitCco: type: string allOf: – #/definitions/enumSitReg description: Situação Conta excluido: type: boolean description: Indica se o registro foi excluído default: false datIni: type: string format: date description: Data base do saldo inicial da conta e600ccoFinCpa: type: object allOf: – #/definitions/e600ccoFinCpa description: Especialização Contas Pagar Conta Interna usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e030ban: description: Replicacao – Banco type: object required: – codBan – nomBan properties: id: type: string format: uuid description: Id da entidade codBan: type: string maxLength: 3 description: Banco nomBan: type: string maxLength: 100 description: Nome ispb: type: integer format: int64 description: Código Identificador do Sistema de Pagamento Brasileiro valorMinimoTed: type: string description: Valor mínimo TED minimum: 0.00 maximum: 999999999.99 excluido: type: boolean description: Indica se o registro foi excluído default: false possuiCodigoCompensacao: type: boolean description: Indicativo se possui código de compensação 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: e030age: description: Cadastros – bancos – agências type: object required: – e030ban – codAge – nomAge properties: id: type: string format: uuid description: Id da entidade e030ban: type: object allOf: – #/definitions/e030ban description: Banco codAge: type: string maxLength: 7 description: Agência nomAge: type: string maxLength: 30 description: Nome da agência digAge: type: string maxLength: 2 description: Digito verificador da agência 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: e501tcp: description: C. Pagar – Títulos – Dados Gerais type: object required: – e070emp – e070filCodFil – numTit – e002tptCodTpt – e001pesCodFor – sitTit – datEmi – datEnt – vctOri – vlrOri – datPpt properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070filCodFil: type: object allOf: – #/definitions/e070fil description: Filial numTit: type: string maxLength: 15 description: Nº Título e002tptCodTpt: type: object allOf: – #/definitions/e002tpt description: Tipo Título e001pesCodFor: type: object allOf: – #/definitions/e001pes description: Fornecedor obsTcp: type: string maxLength: 250 description: Observação sitTit: type: string allOf: – #/definitions/enumSitTit description: Situação codTri: type: string maxLength: 5 description: Código Tributação p/ DARF e001pesCodFav: type: object allOf: – #/definitions/e001pes description: Favorecido datEmi: type: string format: date description: Data Emissão datEnt: type: string format: date description: Data Entrada vctOri: type: string format: date description: Vencimento Original vlrOri: type: string description: Valor Original minimum: 0.00 maximum: 9999999999999.99 vctPro: type: string format: date description: Vencimento Prorrogado/Juros vlrAbe: type: string description: Valor Aberto minimum: 0.00 maximum: 9999999999999.99 datPpt: type: string format: date description: Data Provável Pagamento titBan: type: string maxLength: 20 description: Número Título Banco numArb: type: integer format: int64 description: Nº Arquivo Banco minimum: 0 maximum: 999999999 gerTep: type: boolean description: Gerou título estorno pagamento numPge: type: string maxLength: 10 description: Título PE excluido: type: boolean description: Indica se o registro foi excluído default: false e600ccoSugestaoTitulo: type: object allOf: – #/definitions/e600cco description: Sugestão conta interna usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e002tpt: description: Tipo de Título type: object required: – codTpt – desTpt – abrTpt – aplTpt – sitTpt properties: id: type: string format: uuid description: Id da entidade codTpt: type: string maxLength: 3 description: Codigo interno do tipo de título desTpt: type: string maxLength: 40 description: Descrição do tipo de título abrTpt: type: string maxLength: 5 description: Abreviatura do tipo de título aplTpt: type: string allOf: – #/definitions/enumAplGrp description: Aplicação do tipo de título sitTpt: type: string allOf: – #/definitions/enumSitReg description: Indicativo da situação do tipo de título excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e001pes: description: Pessoa type: object required: – codPes – nomPes – apePes – sitPes – tipPes properties: id: type: string format: uuid description: Id da entidade codPes: type: integer format: int64 description: Código minimum: 0 maximum: 999999999 nomPes: type: string maxLength: 100 description: Nome apePes: type: string maxLength: 80 description: Nome fantasia cnpCpf: type: string maxLength: 14 description: CNPJ/CPF sitPes: type: string allOf: – #/definitions/enumSitReg description: Situação tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa endPes: type: string maxLength: 100 description: Endereço numEnd: type: string maxLength: 60 description: Número cplEnd: type: string maxLength: 200 description: Complemento nomBai: type: string maxLength: 75 description: Bairro e008rai: type: object allOf: – #/definitions/e008rai description: Cidade e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado zipCod: type: string maxLength: 20 description: Zip code excluido: type: boolean description: Indica se o registro foi excluído default: false e077pes: type: object allOf: – #/definitions/e077pes description: Favorecido postalCode: type: string maxLength: 20 description: Código postal 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: e008rai: description: Cidade type: object required: – codRai – nomCid properties: id: type: string format: uuid description: Id da entidade codRai: type: integer format: int64 description: Código cidade minimum: 0 maximum: 9999999 nomCid: type: string maxLength: 60 description: Nome cidade 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: e077pes: description: Transação financeiro contas a pagar Favorecido type: object properties: id: type: string format: uuid description: Id da entidade e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa e030ban: type: object allOf: – #/definitions/e030ban description: Código do banco da conta corrente do favorecido tipTcc: type: string allOf: – #/definitions/enumTipTcc description: Tipo de conta e030age: type: object allOf: – #/definitions/e030age description: Código da agência do banco da conta corrente do favorecido ccbFav: type: string maxLength: 14 description: Número da conta corrente do favorecido no banco sitFav: type: string allOf: – #/definitions/enumSitReg description: Situação do favorecido 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: dadosPagamentoEletronico: description: Dados pagamento eletrônico type: object required: – tipoPagamento – descricaoPagamento properties: id: type: string format: uuid description: Id da entidade tipoPagamento: type: string allOf: – #/definitions/enumTipoPagamentoEletronico description: Tipo de Pagamento descricaoPagamento: type: string maxLength: 250 description: Descrição Pagamento documentoDebito: type: string description: Documento Débito codigoSeuDocumento: type: string description: Código Seu Documento e030ban: type: object allOf: – #/definitions/e030ban description: Banco depositoAgencia: type: string maxLength: 5 description: Agência depositoDigitoAgencia: type: string maxLength: 1 description: Dígito verificador agência depositoNumeroDocumento: type: string maxLength: 14 description: Numero do documento do favorecido (CPF/CNPJ) depositoNomeFavorecido: type: string maxLength: 255 description: Nome do favorecido depositoContaCorrente: type: integer format: int64 description: Conta Corrente depositoDigitoVerificador: type: string maxLength: 100 description: Digito Verificador depositoTipoConta: type: string allOf: – #/definitions/enumTipTcc description: Tipo Conta finalidadeTedDoc: type: object allOf: – #/definitions/finalidadeTedDoc description: Finalidade TED/DOC boletoCodigoBarras: type: string maxLength: 48 description: Código de Barras boletoCodigoNossoDocumento: type: string description: Código Nosso Documento guiaCodigoBarras: type: string maxLength: 48 description: Código de Barras gruCodigoBarras: type: string maxLength: 48 description: Código de Barras gruNumeroReferencia: type: string description: Número Referencia darfNumeroDocumentoDebito: type: integer format: int64 description: Número Documento Débito darfCodigoReceitaTributo: type: string description: Código Receita Tributo darfCodigoIdentificadorTributo: type: string description: Código Identificador Tributo darfNumeroReferencia: type: string description: Número Referencia gpsCodigoReceitaTributo: type: string description: Código Receita Tributo gpsCodigoIdentificadorTributo: type: string description: Código Identificador Tributo pixTipoChave: type: string allOf: – #/definitions/enumTipoChavePix description: Tipo da Chave pixChave: type: string description: Pix pixNomeFavorecido: type: string description: Pix nome do favorecido pixNumeroDocumento: type: string maxLength: 14 description: Pix documento do favorecido pixQrcode: type: string description: Pix Pagamento situacaoDadosBancario: type: string allOf: – #/definitions/enumSituacaoDadosBancario description: Situação do Registro e077pes: type: object allOf: – #/definitions/e077pes description: Pessoa avalista boletoNumeroBanco: type: string maxLength: 3 description: Número do banco do boleto usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: finalidadeTedDoc: description: Replicacao – Cadastro da finalidade de TED/DOC type: object required: – tipoTransacao – codigoFinalidade – descricaoFinalidade – situacaoFinalidade properties: id: type: string format: uuid description: Id da entidade tipoTransacao: type: string allOf: – #/definitions/enumTipoTransacao description: Tipo da transação bancária codigoFinalidade: type: integer format: int64 description: Código Finalidade do TED/DOC minimum: 1 descricaoFinalidade: type: string maxLength: 100 description: Descrição Finalidade do TED/DOC situacaoFinalidade: type: string allOf: – #/definitions/enumSitReg description: Indica a situação atual do registro excluido: type: boolean description: Indica se o registro foi excluido ? default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: pagamentoValoresImpostos: description: Valores de impostos referentes ao pagamento eletrônico no agendamento type: object required: – basePIS – aliquotaPIS – valorPIS – baseCOFINS – aliquotaCOFINS – valorCOFINS – baseCSLL – aliquotaCSLL – valorCSLL – baseIRRF – aliquotaIRRF – valorIRRF – baseISSRetido – aliquotaISSRetido – valorISSRetido – valorLiquidoComImpostos properties: id: type: string format: uuid description: id da entidade basePIS: type: string description: Base PIS aliquotaPIS: type: number format: double description: Alíquota PIS valorPIS: type: string description: Valor PIS baseCOFINS: type: string description: Base COFINS aliquotaCOFINS: type: number format: double description: Alíquota COFINS valorCOFINS: type: string description: Valor COFINS baseCSLL: type: string description: Base CSLL aliquotaCSLL: type: number format: double description: Alíquota CSLL valorCSLL: type: string description: Valor CSLL baseIRRF: type: string description: Base IRRF aliquotaIRRF: type: number format: double description: Alíquota IRRF valorIRRF: type: string description: Valor IRRF baseISSRetido: type: string description: Base ISS Retido aliquotaISSRetido: type: number format: double description: Alíquota ISS Retido valorISSRetido: type: string description: Valor ISS Retido valorLiquidoComImpostos: type: string description: Valor Líquido sem Impostos usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: pagamentoValoresAdicionais: description: Valores referentes ao pagamento eletrônico no agendamento type: object required: – juros – multa – correcao – encargos – outrosAcrescimos – descontos – outrosDescontos – valorLiquidoSemImpostos properties: id: type: string format: uuid description: Id da entidade juros: type: string description: Juros multa: type: string description: Multa correcao: type: string description: Correção encargos: type: string description: Encargos outrosAcrescimos: type: string description: Outros Acréscimos descontos: type: string description: Descontos outrosDescontos: type: string description: Outros Descontos valorLiquidoSemImpostos: type: string description: Valor Líquido sem Impostos usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: arquivoRemessaRetornoDados: description: Arquivo Remessa Retorno Dados type: object required: – ticket – targetObject – versao – situacao properties: id: type: string format: uuid description: Id da entidade ticket: type: string format: uuid description: Ticket nomeArquivo: type: string description: Nome arquivo targetObject: type: string description: target Object versao: type: string description: Versão banco: type: string description: Banco situacao: type: string allOf: – #/definitions/enumSituacaoArquivo description: Situação urlArquivo: type: string maxLength: 2000 description: URL do arquivo loteFinanceiro: type: string format: uuid description: Lote Financeiro arquivoRemessaRetornoItens: type: array items: type: object allOf: – #/definitions/arquivoRemessaRetornoItem description: Arquivo Remessa Retorno Itens empresaId: type: string format: uuid description: Empresa do retorno mensagem: type: string maxLength: 2000 description: Mensagem usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: arquivoRemessaRetornoItem: description: Arquivo Remessa Retorno Itens type: object required: – numeroTituloBanco – situacao – ocorrenciaBanco – ocorrenciaSistema – linhaArquivo properties: id: type: string format: uuid description: Id da entidade arquivoRemessaRetornoDados: type: object allOf: – #/definitions/arquivoRemessaRetornoDados description: Arquivo Remessa Retorno Dados numeroTituloBanco: type: string maxLength: 20 description: Número Título Banco situacao: type: string allOf: – #/definitions/enumSituacaoItemArquivo description: Situação ocorrenciaBanco: type: string description: Ocorrencia Banco ocorrenciaSistema: type: string allOf: – #/definitions/enumOcorrenciaSistema description: Ocorrencia Sistema linhaArquivo: type: string description: Linha Arquivo mensagem: type: string maxLength: 2000 description: Menssagem arquivoRemessaItemId: type: string format: uuid description: Id do Arquivo Remessa Item desse Retorno usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editArquivoRemessaRetornoItem: type: object required: – id allOf: – #/definitions/arquivoRemessaRetornoItem ocorrenciaBanco: description: Ocorrência Banco type: object required: – codBanco – ocorrencia – ocorrenciaSistema – descricao – situacao properties: id: type: string format: uuid description: Id da entidade codBanco: type: string maxLength: 3 description: Código banco ocorrencia: type: string maxLength: 10 description: Ocorrência ocorrenciaSistema: type: string allOf: – #/definitions/enumOcorrenciaSistema description: Ocorrência Sistema descricao: type: string maxLength: 250 description: Descrição da Ocorrencia bancária situacao: type: string allOf: – #/definitions/enumSitReg description: Situação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e600ccoFinCpa: description: Especialização Contas Pagar Conta Interna type: object required: – numeroConvenio properties: id: type: string format: uuid description: Id da entidade e600cco: type: object allOf: – #/definitions/e600cco description: Conta interna numeroConvenio: type: string description: Número convênio usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editE600ccoFinCpa: type: object required: – id allOf: – #/definitions/e600ccoFinCpa e001tns: description: Tabelas – Transações type: object required: – e070emp – codTns – desTns – aceMan properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codTns: type: string maxLength: 5 description: Transação desTns: type: string maxLength: 60 description: Descrição aceMan: type: boolean description: Aceita Manual sitTns: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070filFinCpa: description: Cadastros – Filiais – Especialização Contas a Pagar type: object properties: id: type: string format: uuid description: Id da entidade e070fil: type: object allOf: – #/definitions/e070fil description: Filial pagPdi: type: string format: date description: Período Inicial/Final CP pagPdf: type: string format: date description: Período Final CP pagDpr: type: integer format: int64 description: Dias Prorrogação CP minimum: 0 maximum: 9999 default: 0 comTdv: type: boolean description: Comp.Tit.Dev. e001tnsBaixaAutomaticaPagamentoEletronico: type: object allOf: – #/definitions/e001tns description: Transação de baixa automática para pagamento eletrônico excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070filFinTes: description: Cadastros – Especialização de tesouraria da filial type: object properties: id: type: string format: uuid description: Id da entidade e070fil: type: object allOf: – #/definitions/e070fil description: Filial cxbPdi: type: string format: date description: Período Inicial/Final Tesouraria cxbPdf: type: string format: date description: Período Final Tesouraria e001tnsDebitoPagamentoEletronico: type: object allOf: – #/definitions/e001tns description: Transação de débito do pagamento eletrônico excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: 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