erpx_cpl_tri

apuracao_faturamento

7 views 24/06/2021 23/11/2021 integrador 0

2.0info: 1.5.0 apuracao_faturamento description: Serviço da contabilidade para nota fiscal de saída x-senior-domain: erpx_cpl_tri x-senior-domain-path: erpx_cpl_tri x-senior-service-path: apuracao_faturamento 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_cpl_trisecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /apuracao_faturamento/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 /apuracao_faturamento/queries/consultarSaldoFaturamento: post: description: Query para consultar as informações de saldo do faturamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro – pageRequest properties: filtro: type: object allOf: – #/definitions/recFiltrosSaldoFaturamento description: Filtros para obter informações do saldo do faturamento pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – totalSaldoFaturamento – existePeriodoFechado – saldoFaturamento – totalElements properties: totalSaldoFaturamento: type: array items: type: object allOf: – #/definitions/recTotalFaturamento minimum: 1 description: Totalizadores referentes aos filtros aplicados existePeriodoFechado: type: boolean description: Existe saldo fechado no período saldoFaturamento: type: array items: type: object allOf: – #/definitions/recSaldoFaturamento minimum: 1 description: Saldo do faturamento por empresa e filial totalElements: type: integer format: int64 description: Total de notas fiscais 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/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 /apuracao_faturamento/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /apuracao_faturamento/queries/exportE070fil: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /apuracao_faturamento/queries/exportE001tns: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /apuracao_faturamento/queries/exportParametrosFaturamento: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /apuracao_faturamento/queries/exportSaldoFaturamentoStatus: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /apuracao_faturamento/queries/exportCalculoFaturamento: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /apuracao_faturamento/queries/exportSaldoFaturamento: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /apuracao_faturamento/queries/exportCalculoFaturamentoStatus: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /apuracao_faturamento/queries/exportFilaDocumento: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /apuracao_faturamento/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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 /apuracao_faturamento/actions/fecharPeriodoFaturamento: post: description: Realiza o fechamento de um período tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro properties: filtro: type: object allOf: – #/definitions/recFiltrosSaldoFaturamento description: Filtros para obter informações do saldo do faturamento responses: 200: description: Ok schema: type: object required: – periodosNaoAtualizados properties: periodosNaoAtualizados: type: boolean description: Existem períodos não atualizados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/actions/exportarOrigensFaturamento: post: description: Exportar as origens dos valores do faturamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro properties: filtro: type: object allOf: – #/definitions/recFiltrosSaldoFaturamento description: Filtros para obter informações do saldo do faturamento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/actions/recalcularFaturamento: post: description: Realiza o recálculo de um período tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro properties: filtro: type: object allOf: – #/definitions/recFiltrosSaldoFaturamento description: Filtros para obter informações do saldo do faturamento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/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 /apuracao_faturamento/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /apuracao_faturamento/actions/importE070fil: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /apuracao_faturamento/actions/importE001tns: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /apuracao_faturamento/actions/importParametrosFaturamento: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /apuracao_faturamento/actions/importSaldoFaturamentoStatus: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /apuracao_faturamento/actions/importCalculoFaturamento: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /apuracao_faturamento/actions/importSaldoFaturamento: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /apuracao_faturamento/actions/importCalculoFaturamentoStatus: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /apuracao_faturamento/actions/importFilaDocumento: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /apuracao_faturamento/signals/calcularFaturamento: post: description: Inicia o processo de cálculo do faturamento tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/signals/excluirDocumentosFaturamento: post: description: Inicia o processo de exclusão do faturamento tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – documentoId properties: documentoId: type: array items: type: string minimum: 1 description: Lista de documentos a serem excluídos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/events/atualizacaoFaturamentoNotaSaidaFinalizado: post: description: Evento de finalização do processo de cálculo da nota de saída x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nfSaidaId properties: nfSaidaId: type: string description: Identificador da nota fiscal de saída responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/events/atualizacaoFaturamentoNotaEntradaFinalizado: post: description: Evento de finalização do processo de cálculo da nota de entrada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nfEntradaId properties: nfEntradaId: type: string description: Identificador da nota fiscal de entrada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/events/atualizacaoFaturamentoOutroDocumentoFinalizado: post: description: Evento de finalização do processo de cálculo dos outros documentos x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – outroDocumentoId properties: outroDocumentoId: type: string description: Identificador do documento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/events/atualizacaoFaturamentoNotaSaidaErro: post: description: Evento para realizar liberação da nota de saída x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nfSaidaId – tipoErro properties: nfSaidaId: type: string description: Identificador da nota fiscal de saída msgErro: type: string maxLength: 800 description: Mensagem de erro tipoErro: type: string allOf: – #/definitions/enumTipoErro description: Tipo erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/events/atualizacaoFaturamentoNotaEntradaErro: post: description: Evento para realizar liberação da nota de entrada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nfEntradaId – tipoErro properties: nfEntradaId: type: string description: Identificador da nota fiscal de entrada msgErro: type: string maxLength: 800 description: Mensagem de erro tipoErro: type: string allOf: – #/definitions/enumTipoErro description: Tipo erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/events/atualizacaoFaturamentoOutrosDocumentosErro: post: description: Evento para realizar liberação dos outros documentos x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – outrosDocumentoId – tipoErro properties: outrosDocumentoId: type: string description: Identificador dos outros documentos msgErro: type: string maxLength: 800 description: Mensagem de erro tipoErro: type: string allOf: – #/definitions/enumTipoErro description: Tipo erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/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 /apuracao_faturamento/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 /apuracao_faturamento/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 /apuracao_faturamento/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 /apuracao_faturamento/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 /apuracao_faturamento/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 /apuracao_faturamento/events/importParametrosFaturamentoCamposEvent: 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 /apuracao_faturamento/events/exportParametrosFaturamentoCamposEvent: 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 /apuracao_faturamento/events/importParametrosFaturamentoEvent: 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 /apuracao_faturamento/events/exportParametrosFaturamentoEvent: 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 /apuracao_faturamento/events/importSaldoFaturamentoStatusEvent: 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 /apuracao_faturamento/events/exportSaldoFaturamentoStatusEvent: 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 /apuracao_faturamento/events/importCalculoFaturamentoEvent: 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 /apuracao_faturamento/events/exportCalculoFaturamentoEvent: 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 /apuracao_faturamento/events/importSaldoFaturamentoEvent: 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 /apuracao_faturamento/events/exportSaldoFaturamentoEvent: 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 /apuracao_faturamento/events/importCalculoFaturamentoStatusEvent: 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 /apuracao_faturamento/events/exportCalculoFaturamentoStatusEvent: 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 /apuracao_faturamento/events/importFilaDocumentoEvent: 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 /apuracao_faturamento/events/exportFilaDocumentoEvent: 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 /apuracao_faturamento/events/importValorFaturamentoEvent: 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 /apuracao_faturamento/events/exportValorFaturamentoEvent: 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 /apuracao_faturamento/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 responses: 200: description: Ok schema: type: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/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 /apuracao_faturamento/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 responses: 200: description: Ok schema: type: array items: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/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 /apuracao_faturamento/entities/e001tns: 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 responses: 200: description: Ok schema: type: array items: #/definitions/e001tns 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/e001tns/{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/e001tns 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/parametrosFaturamentoCampos: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/parametrosFaturamentoCampos responses: 200: description: The created resource schema: #/definitions/parametrosFaturamentoCampos 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: entity in: body required: true schema: type: object allOf: – #/definitions/parametrosFaturamentoCampos responses: 200: description: The created resource schema: #/definitions/parametrosFaturamentoCampos 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: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/parametrosFaturamentoCampos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/parametrosFaturamentoCampos/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/parametrosFaturamentoCampos responses: 200: description: Ok schema: #/definitions/parametrosFaturamentoCampos 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/parametrosFaturamentoCampos responses: 200: description: Ok schema: #/definitions/parametrosFaturamentoCampos 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/parametrosFaturamentoCampos 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/parametrosFaturamento/{parentId}/parametrosFaturamentoCampos: 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/parametrosFaturamentoCampos responses: 200: description: The created resources schema: type: array items: #/definitions/parametrosFaturamentoCampos 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/parametrosFaturamentoCampos responses: 200: description: The created resources schema: type: array items: #/definitions/parametrosFaturamentoCampos 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 responses: 200: description: Ok schema: type: array items: #/definitions/parametrosFaturamentoCampos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/parametrosFaturamento/{parentId}/parametrosFaturamentoCampos/{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/parametrosFaturamentoCampos responses: 200: description: Ok schema: #/definitions/parametrosFaturamentoCampos 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/parametrosFaturamentoCampos responses: 200: description: Ok schema: #/definitions/parametrosFaturamentoCampos 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/parametrosFaturamentoCampos 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 /apuracao_faturamento/entities/parametrosFaturamentoCampos/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/parametrosFaturamentoCampos responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/parametrosFaturamento: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/parametrosFaturamento responses: 200: description: The created resource schema: #/definitions/parametrosFaturamento 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: entity in: body required: true schema: type: object allOf: – #/definitions/parametrosFaturamento responses: 200: description: The created resource schema: #/definitions/parametrosFaturamento 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: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/parametrosFaturamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/parametrosFaturamento/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/parametrosFaturamento responses: 200: description: Ok schema: #/definitions/parametrosFaturamento 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/parametrosFaturamento responses: 200: description: Ok schema: #/definitions/parametrosFaturamento 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/parametrosFaturamento 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/parametrosFaturamento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/parametrosFaturamento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/saldoFaturamentoStatus: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/saldoFaturamentoStatus responses: 200: description: The created resource schema: #/definitions/saldoFaturamentoStatus 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: entity in: body required: true schema: type: object allOf: – #/definitions/saldoFaturamentoStatus responses: 200: description: The created resource schema: #/definitions/saldoFaturamentoStatus 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: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/saldoFaturamentoStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/saldoFaturamentoStatus/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/saldoFaturamentoStatus responses: 200: description: Ok schema: #/definitions/saldoFaturamentoStatus 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/saldoFaturamentoStatus responses: 200: description: Ok schema: #/definitions/saldoFaturamentoStatus 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/saldoFaturamentoStatus 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/saldoFaturamentoStatus/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/saldoFaturamentoStatus responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/calculoFaturamento: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/calculoFaturamento responses: 200: description: The created resource schema: #/definitions/calculoFaturamento 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: entity in: body required: true schema: type: object allOf: – #/definitions/calculoFaturamento responses: 200: description: The created resource schema: #/definitions/calculoFaturamento 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: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/calculoFaturamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/calculoFaturamento/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/calculoFaturamento responses: 200: description: Ok schema: #/definitions/calculoFaturamento 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/calculoFaturamento responses: 200: description: Ok schema: #/definitions/calculoFaturamento 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/calculoFaturamento 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/calculoFaturamento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/calculoFaturamento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/saldoFaturamento: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/saldoFaturamento responses: 200: description: The created resource schema: #/definitions/saldoFaturamento 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: entity in: body required: true schema: type: object allOf: – #/definitions/saldoFaturamento responses: 200: description: The created resource schema: #/definitions/saldoFaturamento 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: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/saldoFaturamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/saldoFaturamento/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/saldoFaturamento responses: 200: description: Ok schema: #/definitions/saldoFaturamento 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/saldoFaturamento responses: 200: description: Ok schema: #/definitions/saldoFaturamento 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/saldoFaturamento 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/saldoFaturamento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/saldoFaturamento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/calculoFaturamentoStatus: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/calculoFaturamentoStatus responses: 200: description: The created resource schema: #/definitions/calculoFaturamentoStatus 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: entity in: body required: true schema: type: object allOf: – #/definitions/calculoFaturamentoStatus responses: 200: description: The created resource schema: #/definitions/calculoFaturamentoStatus 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: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/calculoFaturamentoStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/calculoFaturamentoStatus/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/calculoFaturamentoStatus responses: 200: description: Ok schema: #/definitions/calculoFaturamentoStatus 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/calculoFaturamentoStatus responses: 200: description: Ok schema: #/definitions/calculoFaturamentoStatus 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/calculoFaturamentoStatus 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/calculoFaturamentoStatus/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/calculoFaturamentoStatus responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/filaDocumento: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/filaDocumento responses: 200: description: The created resource schema: #/definitions/filaDocumento 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: entity in: body required: true schema: type: object allOf: – #/definitions/filaDocumento responses: 200: description: The created resource schema: #/definitions/filaDocumento 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: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/filaDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/filaDocumento/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/filaDocumento responses: 200: description: Ok schema: #/definitions/filaDocumento 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/filaDocumento responses: 200: description: Ok schema: #/definitions/filaDocumento 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/filaDocumento 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/filaDocumento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/filaDocumento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/valorFaturamento: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/valorFaturamento responses: 200: description: The created resource schema: #/definitions/valorFaturamento 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: entity in: body required: true schema: type: object allOf: – #/definitions/valorFaturamento responses: 200: description: The created resource schema: #/definitions/valorFaturamento 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: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/valorFaturamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/valorFaturamento/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/valorFaturamento responses: 200: description: Ok schema: #/definitions/valorFaturamento 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/valorFaturamento responses: 200: description: Ok schema: #/definitions/valorFaturamento 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/valorFaturamento 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/calculoFaturamento/{parentId}/valorFaturamento: 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/valorFaturamento responses: 200: description: The created resources schema: type: array items: #/definitions/valorFaturamento 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/valorFaturamento responses: 200: description: The created resources schema: type: array items: #/definitions/valorFaturamento 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 responses: 200: description: Ok schema: type: array items: #/definitions/valorFaturamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /apuracao_faturamento/entities/calculoFaturamento/{parentId}/valorFaturamento/{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/valorFaturamento responses: 200: description: Ok schema: #/definitions/valorFaturamento 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/valorFaturamento responses: 200: description: Ok schema: #/definitions/valorFaturamento 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/valorFaturamento 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 /apuracao_faturamento/entities/valorFaturamento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/valorFaturamento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: description: Up or down type: string enum: – UP – DOWN enumTipoFaturamento: description: Tipos de faturamento disponíveis type: string enum: – BRUTO – LIQUIDO enumTipoOperacaoFaturamento: description: Tipo de operação aplicada no campo para composição do faturamento type: string enum: – ADICIONAR – SUBTRAIR – NENHUM enumCampoFaturamentoComposicao: description: Campos que podem ser usados para compor o faturamento type: string enum: – VALOR_CONTABIL – VALOR_DESCONTOS – VALOR_FRETE – VALOR_SEGURO – VALOR_OUTRAS_DEPESAS_ACESSORIAS – VALOR_IPI – VALOR_IRRF – VALOR_ISS_RETIDO – VALOR_INSS – VALOR_COFINS_RETIDO – VALOR_PIS_RETIDO – VALOR_CSLL_RETIDO – VALOR_ICMS_ST_SUBSTITUTO – VALOR_FCP_ST_SUBSTITUTO enumLisMod: description: Módulo da transação type: string enum: – VVEP – VVEF – VVES – VESN – VCRE – VCRP – VCRB – VCOO – VCOF – VCOS – VCPE – VCPP – VCPB – VCPM – VCBC – VCBM – VPAT enumSitReg: description: Situação do registro type: string enum: – VA – VI enumSaldoFaturamentoStatus: description: Enumeração Status do saldo do faturamento type: string enum: – CALCULANDO – PROCESSADO – FECHADO – ERRO enumOrigemFaturamento: description: Origem do cálculo do faturamento type: string enum: – NOTA_SAIDA – NOTA_ENTRADA – OUTRO_DOCUMENTO enumTipoItem: description: Tipo do item type: string enum: – SERVICO – PRODUTO enumTipoErro: description: Tipo de erro type: string enum: – VALIDACAO – INTERNO enumTypeOrder: description: Enumeração para o tipo de ordenação type: string enum: – ASC – DESC userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recFiltrosSaldoFaturamento: description: Filtros para obter informações do saldo do faturamento type: object required: – competenciaInicial – competenciaFinal – empresa properties: competenciaInicial: type: string format: date description: Competência inicial competenciaFinal: type: string format: date description: Competência final empresa: type: string description: Identificador da empresa filiais: type: array items: type: string description: Identificadores das filiais transacao: type: string description: Transacao recSaldoFaturamento: description: Saldo do faturamento por empresa e filial type: object required: – e070emp – e070fil – valorBrutoProduto – valorLiquidoProduto – valorBrutoServico – valorLiquidoServico – valorTotalBruto – valorTotalLiquido – status properties: e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Filial valorBrutoProduto: type: string description: Valor bruto do produto valorLiquidoProduto: type: string description: Valor líquido do produto valorBrutoServico: type: string description: Valor bruto do serviço valorLiquidoServico: type: string description: Valor líquido do serviço valorTotalBruto: type: string description: Valor total bruto valorTotalLiquido: type: string description: Valor total líquido status: type: string allOf: – #/definitions/enumSaldoFaturamentoStatus description: Status do saldo do faturamento recTotalFaturamento: description: Valores totalizados do faturamento bruto e líquido por produto e serviço type: object required: – tipoFaturamento – valorProduto – valorServico – valorTotal properties: tipoFaturamento: type: string allOf: – #/definitions/enumTipoFaturamento description: Tipo do faturamento valorProduto: type: string description: Valor total do faturamento por produto valorServico: type: string description: Valor total do faturamento por serviço valorTotal: type: string description: Valor total do faturamento recPageRequest: description: Record para paginação e ordenação type: object required: – offset – size properties: offset: type: integer format: int64 description: Página atual size: type: integer format: int64 description: Total de registros da página orderBy: type: array items: type: object allOf: – #/definitions/recFieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados recFieldsOrderBy: description: Define o registro com os dados dos campos à serem ordenados type: object required: – field – order properties: field: type: string description: Nome do campo a ser ordenado order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação do campo (ASC / DESC) e070emp: description: Cadastros – Empresas type: object required: – codEmp – sigEmp properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 sigEmp: type: string maxLength: 100 description: Nome fantasia excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070fil: description: Filial type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 9999 sigFil: type: string maxLength: 100 description: Fantasia excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e001tns: description: Transação type: object 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 lisMod: type: string allOf: – #/definitions/enumLisMod description: Módulo sitTns: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: parametrosFaturamentoCampos: description: Campos de parametrização type: object required: – campoComposicao – tipoOperacao properties: id: type: string format: uuid description: Id da entidade parametrosFaturamento: type: object allOf: – #/definitions/parametrosFaturamento description: Parâmetro do faturamento campoComposicao: type: string allOf: – #/definitions/enumCampoFaturamentoComposicao description: Campo disponível para composição do faturamento tipoOperacao: type: string allOf: – #/definitions/enumTipoOperacaoFaturamento description: Tipo de operação do campo na composição do faturamento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: parametrosFaturamento: description: Parametrização do faturamento type: object required: – e070emp – tipoFaturamento – e001tns – competenciaInicial properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: código da empresa tipoFaturamento: type: string allOf: – #/definitions/enumTipoFaturamento description: Tipo de faturamento e001tns: type: object allOf: – #/definitions/e001tns description: Transação competenciaInicial: type: string format: date description: Competência inicial competenciaFinal: type: string format: date description: Competência final considerarFaturamentoLiquido: type: boolean description: Considerar no faturamento líquido default: false parametrosFaturamentoCampos: type: array items: type: object allOf: – #/definitions/parametrosFaturamentoCampos description: Campos de parametrização composicaoBruto: type: string maxLength: 500 description: Composição do valor bruto composicaoLiquido: type: string maxLength: 500 description: Composição do valor líquido usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: saldoFaturamentoStatus: description: Status do saldo do faturamento type: object required: – e070emp – e070fil – data – status – descricaoStatus properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Filial data: type: string format: date description: Data status: type: string allOf: – #/definitions/enumSaldoFaturamentoStatus description: Status do saldo do faturamento descricaoStatus: type: string maxLength: 800 description: Descrição do status do calculo do faturamento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: calculoFaturamento: description: Registra o valor bruto, líquido e a forma como os valores foram compostos para o item type: object required: – dataEmissao – e070emp – e070fil – documentoId – itemId – tipoItem – e001tns – cfop – origem – valorBruto – composicaoBruto – valorLiquido – composicaoLiquido properties: id: type: string format: uuid description: Id da entidade dataEmissao: type: string format: date description: Data de emissão e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Filial documentoId: type: string format: uuid description: Documento ID itemId: type: string format: uuid description: Item id tipoItem: type: string allOf: – #/definitions/enumTipoItem description: Tipo do item e001tns: type: object allOf: – #/definitions/e001tns description: Transação cfop: type: string maxLength: 5 description: CFOP origem: type: string allOf: – #/definitions/enumOrigemFaturamento description: Origem valorBruto: type: string description: Valor bruto composicaoBruto: type: string maxLength: 500 description: Composição do valor bruto valorLiquido: type: string description: Valor líquido composicaoLiquido: type: string maxLength: 500 description: Composição do valor líquido valorFaturamento: type: array items: type: object allOf: – #/definitions/valorFaturamento description: Valor de composição do cálculo do faturamento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: saldoFaturamento: description: Registra o saldo para a empresa, filial e período type: object required: – dataFaturamento – e070emp – e070fil – valorBrutoProduto – valorLiquidoProduto – valorBrutoServico – valorLiquidoServico properties: id: type: string format: uuid description: Id da entidade dataFaturamento: type: string format: date description: Data de saldo mês/ano e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Filial valorBrutoProduto: type: string description: Valor bruto do produto valorLiquidoProduto: type: string description: Valor líquido do produto valorBrutoServico: type: string description: Valor bruto do serviço valorLiquidoServico: type: string description: Valor líquido do serviço usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: calculoFaturamentoStatus: description: Status do cálculo do faturamento type: object required: – filaDocumento – e070emp – e070fil – dataEmissao – documentoId – itemId – tipoItem – e001tns – cfop – origem – valoresPayload – descricaoStatus properties: id: type: string format: uuid description: Id da entidade filaDocumento: type: object allOf: – #/definitions/filaDocumento description: Fila Documento e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Filial dataEmissao: type: string format: date description: Data de emissão documentoId: type: string format: uuid description: Documento itemId: type: string format: uuid description: Item tipoItem: type: string allOf: – #/definitions/enumTipoItem description: Tipo do item e001tns: type: object allOf: – #/definitions/e001tns description: Transação cfop: type: string maxLength: 5 description: CFOP origem: type: string allOf: – #/definitions/enumOrigemFaturamento description: Origem valoresPayload: type: string maxLength: 800 description: Payload de valores para o calculo descricaoStatus: type: string maxLength: 400 description: Descrição do status excluirValorSaldo: type: boolean description: Excluir valor calculado do saldo default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: filaDocumento: description: Gerencia a fila de cálculo do faturamento type: object required: – e070emp – e070fil – dataEmissao – documentoId – origem properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Filial dataEmissao: type: string format: date description: Data de emissão documentoId: type: string format: uuid description: Documento origem: type: string allOf: – #/definitions/enumOrigemFaturamento description: Origem loteProcessamento: type: string description: Lote Processamento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: valorFaturamento: description: Valor de composição do cálculo do faturamento type: object required: – valor – tipo properties: id: type: string format: uuid description: Id da entidade calculoFaturamento: type: object allOf: – #/definitions/calculoFaturamento description: Cálculo do faturamento valor: type: string description: Valor tipo: type: string allOf: – #/definitions/enumCampoFaturamentoComposicao description: Tipo do valor de composição do faturamento 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 description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment