erp_mer

gme_gerencial

11 views 22/10/2018 07/11/2018 integrador 0

2.0info: develop-SNAPSHOT gme_gerencial description: Documentação x-senior-domain: erp_mer x-senior-domain-path: erp_mer x-senior-service-path: gme_gerencial contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erp_mersecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /gme_gerencial/queries/buscarFaturamentoCorporacao: post: description: Retorna o faturamento de todas as empresas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: dataInicial: type: string format: date description: Data inicial para busca do valor de faturamento dataFinal: type: string format: date description: Data final para busca do valor de faturamento responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal – valor properties: dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valor: type: number format: double description: Valor faturamento pela corporação percentualCrescimento: type: number format: double description: Percentual de crescimento. Quando negativo, indica queda default: description: Error response schema: #/definitions/genericError get: description: Retorna o faturamento de todas as empresas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dataInicial in: query type: string format: date – name: dataFinal in: query type: string format: date responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal – valor properties: dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valor: type: number format: double description: Valor faturamento pela corporação percentualCrescimento: type: number format: double description: Percentual de crescimento. Quando negativo, indica queda default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/buscarFaturamentoEmpresa: post: description: Retorna o faturamento de uma empresa especifica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa properties: codigoEmpresa: type: integer format: int64 description: Código da empresa para buscar o faturamento dataInicial: type: string format: date description: Data inicial para busca do valor de faturamento dataFinal: type: string format: date description: Data final para busca do valor de faturamento responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal – valor – empresa properties: dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valor: type: number format: double description: Valor faturado pela empresa empresa: type: string maxLength: 100 description: Nome da empresa em que foi feita a busca do faturamento percentualCrescimento: type: number format: double description: Percentual de crescimento. Quando negativo, indica queda default: description: Error response schema: #/definitions/genericError get: description: Retorna o faturamento de uma empresa especifica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa in: query required: true type: integer format: int64 – name: dataInicial in: query type: string format: date – name: dataFinal in: query type: string format: date responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal – valor – empresa properties: dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valor: type: number format: double description: Valor faturado pela empresa empresa: type: string maxLength: 100 description: Nome da empresa em que foi feita a busca do faturamento percentualCrescimento: type: number format: double description: Percentual de crescimento. Quando negativo, indica queda default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/buscarFaturamentoFilial: post: description: Retorna o faturamento de uma filial especifica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoFilial properties: codigoEmpresa: type: integer format: int64 description: Código da empresa para buscar o faturamento codigoFilial: type: integer format: int64 description: Código da filial para buscar o faturamento dataInicial: type: string format: date description: Data inicial para busca do valor de faturamento dataFinal: type: string format: date description: Data final para busca do valor de faturamento responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal – valor – filial properties: dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valor: type: number format: double description: Valor faturado pela filial filial: type: string maxLength: 100 description: Nome da filial em que foi feita a busca do faturamento percentualCrescimento: type: number format: double description: Percentual de crescimento. Quando negativo, indica queda default: description: Error response schema: #/definitions/genericError get: description: Retorna o faturamento de uma filial especifica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa in: query required: true type: integer format: int64 – name: codigoFilial in: query required: true type: integer format: int64 – name: dataInicial in: query type: string format: date – name: dataFinal in: query type: string format: date responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal – valor – filial properties: dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valor: type: number format: double description: Valor faturado pela filial filial: type: string maxLength: 100 description: Nome da filial em que foi feita a busca do faturamento percentualCrescimento: type: number format: double description: Percentual de crescimento. Quando negativo, indica queda default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/buscarFaturamentoFamilia: post: description: Busca o faturamento de uma filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoFamilia properties: codigoEmpresa: type: integer format: int64 description: Código da empresa para buscar o faturamento codigoFilial: type: integer format: int64 description: Código da filial para buscar o faturamento codigoFamilia: type: string maxLength: 100 description: Código da família para buscar o faturamento dataInicial: type: string format: date description: Data inicial para busca do valor de faturamento dataFinal: type: string format: date description: Data final para busca do valor de faturamento responses: 200: description: Ok schema: type: object required: – empresa – filial properties: empresa: type: string maxLength: 100 description: Nome da empresa em que foi feita a busca do faturamento filial: type: string maxLength: 100 description: Nome da filial em que foi feita a busca do faturamento dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valor: type: number format: double description: Valor do faturamento percentualCrescimento: type: number format: double description: Percentual de crescimento. Quando negativo, indica queda default: description: Error response schema: #/definitions/genericError get: description: Busca o faturamento de uma filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa in: query type: integer format: int64 – name: codigoFilial in: query type: integer format: int64 – name: codigoFamilia in: query required: true type: string maxLength: 100 – name: dataInicial in: query type: string format: date – name: dataFinal in: query type: string format: date responses: 200: description: Ok schema: type: object required: – empresa – filial properties: empresa: type: string maxLength: 100 description: Nome da empresa em que foi feita a busca do faturamento filial: type: string maxLength: 100 description: Nome da filial em que foi feita a busca do faturamento dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valor: type: number format: double description: Valor do faturamento percentualCrescimento: type: number format: double description: Percentual de crescimento. Quando negativo, indica queda default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/buscarFaturamentoRepresentante: post: description: Buscar o faturamento por representante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoRepresentante properties: codigoEmpresa: type: integer format: int64 description: Código da empresa para buscar o faturamento codigoFilial: type: integer format: int64 description: Código da filial para buscar o faturamento codigoRepresentante: type: integer format: int64 description: Código do representante para buscar o faturamento dataInicial: type: string format: date description: Data inicial para busca do valor de faturamento dataFinal: type: string format: date description: Data final para busca do valor de faturamento responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal – valor – representante properties: dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valor: type: number format: double description: Valor de faturamento do representante empresa: type: string maxLength: 100 description: Nome da empresa utilizada na busca filial: type: string maxLength: 100 description: Nome da filial utilizada na busca representante: type: string maxLength: 100 description: Nome do representante em que se buscou o faturamento default: description: Error response schema: #/definitions/genericError get: description: Buscar o faturamento por representante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa in: query type: integer format: int64 – name: codigoFilial in: query type: integer format: int64 – name: codigoRepresentante in: query required: true type: integer format: int64 – name: dataInicial in: query type: string format: date – name: dataFinal in: query type: string format: date responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal – valor – representante properties: dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valor: type: number format: double description: Valor de faturamento do representante empresa: type: string maxLength: 100 description: Nome da empresa utilizada na busca filial: type: string maxLength: 100 description: Nome da filial utilizada na busca representante: type: string maxLength: 100 description: Nome do representante em que se buscou o faturamento default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/buscarEmpresaMelhorFaturamento: post: description: Retorna a empresa com melhor faturamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: dataInicial: type: string format: date description: Data inicial para busca do valor de faturamento dataFinal: type: string format: date description: Data final para busca do valor de faturamento responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal – valor – percentual – empresa properties: dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valor: type: number format: double description: Valor de faturamento da empresa percentual: type: number format: double description: Percentual de faturamento da empresa empresa: type: string maxLength: 100 description: Empresa localizada que obteve o melhor faturamento no período default: description: Error response schema: #/definitions/genericError get: description: Retorna a empresa com melhor faturamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dataInicial in: query type: string format: date – name: dataFinal in: query type: string format: date responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal – valor – percentual – empresa properties: dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valor: type: number format: double description: Valor de faturamento da empresa percentual: type: number format: double description: Percentual de faturamento da empresa empresa: type: string maxLength: 100 description: Empresa localizada que obteve o melhor faturamento no período default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/buscarMetaFaturamento: post: description: Retorna valor orçado e faturado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: dataInicial: type: string format: date description: Data inicial para busca do valor de faturamento dataFinal: type: string format: date description: Data final para busca do valor de faturamento responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal – valorOrcado – valorRealizado – percentualAtingimento properties: dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valorOrcado: type: number format: double description: Valor orçado no período valorRealizado: type: number format: double description: Valor realizado no período percentualAtingimento: type: number format: double description: Percentual de atingimento do valor orçado default: description: Error response schema: #/definitions/genericError get: description: Retorna valor orçado e faturado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dataInicial in: query type: string format: date – name: dataFinal in: query type: string format: date responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal – valorOrcado – valorRealizado – percentualAtingimento properties: dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valorOrcado: type: number format: double description: Valor orçado no período valorRealizado: type: number format: double description: Valor realizado no período percentualAtingimento: type: number format: double description: Percentual de atingimento do valor orçado default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/buscarResultado: post: description: Busca o resultado da corporação ou de uma empresa/filial específica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: codigoEmpresa: type: integer format: int64 description: Código da empresa para buscar o faturamento codigoFilial: type: integer format: int64 description: Código da filial para buscar o faturamento dataInicial: type: string format: date description: Data inicial para busca do valor de faturamento dataFinal: type: string format: date description: Data final para busca do valor de faturamento responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal – valorRealizado properties: empresa: type: string maxLength: 100 description: Nome da empresa pesquisada filial: type: string maxLength: 100 description: Nome da filial pesquisada dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valorOrcado: type: number format: double description: Valor orçado no período valorRealizado: type: number format: double description: Valor realizado no período percentualAtingimento: type: number format: double description: Percentual de atingimento do valor orçado percentualCrescimento: type: number format: double description: Percentual de crescimento em relação ao período anterior default: description: Error response schema: #/definitions/genericError get: description: Busca o resultado da corporação ou de uma empresa/filial específica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa in: query type: integer format: int64 – name: codigoFilial in: query type: integer format: int64 – name: dataInicial in: query type: string format: date – name: dataFinal in: query type: string format: date responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal – valorRealizado properties: empresa: type: string maxLength: 100 description: Nome da empresa pesquisada filial: type: string maxLength: 100 description: Nome da filial pesquisada dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valorOrcado: type: number format: double description: Valor orçado no período valorRealizado: type: number format: double description: Valor realizado no período percentualAtingimento: type: number format: double description: Percentual de atingimento do valor orçado percentualCrescimento: type: number format: double description: Percentual de crescimento em relação ao período anterior default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/buscarRepresentanteMelhorFaturamento: post: description: Busca o representante que teve o melhor faturamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: codigoEmpresa: type: integer format: int64 description: Código da empresa para buscar o faturamento codigoFilial: type: integer format: int64 description: Código da filial para buscar o faturamento dataInicial: type: string format: date description: Data inicial para busca do valor de faturamento dataFinal: type: string format: date description: Data final para busca do valor de faturamento responses: 200: description: Ok schema: type: object required: – representante properties: empresa: type: string maxLength: 100 description: Nome da empresa utilizada na busca filial: type: string maxLength: 100 description: Nome da filial utilizada na busca representante: type: string maxLength: 100 description: Nome do representante utilizado na busca dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valor: type: number format: double description: Valor faturado no período pelo representante default: description: Error response schema: #/definitions/genericError get: description: Busca o representante que teve o melhor faturamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa in: query type: integer format: int64 – name: codigoFilial in: query type: integer format: int64 – name: dataInicial in: query type: string format: date – name: dataFinal in: query type: string format: date responses: 200: description: Ok schema: type: object required: – representante properties: empresa: type: string maxLength: 100 description: Nome da empresa utilizada na busca filial: type: string maxLength: 100 description: Nome da filial utilizada na busca representante: type: string maxLength: 100 description: Nome do representante utilizado na busca dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: Data final utilizada para busca do valor de faturamento valor: type: number format: double description: Valor faturado no período pelo representante default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/buscarRankingFaturamentoEmpresa: post: description: Retorna listagem de empresas que mais faturaram no período tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: dataInicial: type: string format: date description: Data inicial para obter o ranking dataFinal: type: string format: date description: Data final para obter o ranking limite: type: integer format: int64 description: Quantidade de empresas para retornar (no máximo) responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal properties: dataInicial: type: string format: date description: Data inicial do ranking obtido dataFinal: type: string format: date description: Data final do ranking obtido ranking: type: array items: type: object allOf: – #/definitions/itemRanking description: Ranking obtido default: description: Error response schema: #/definitions/genericError get: description: Retorna listagem de empresas que mais faturaram no período tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dataInicial in: query type: string format: date – name: dataFinal in: query type: string format: date – name: limite in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal properties: dataInicial: type: string format: date description: Data inicial do ranking obtido dataFinal: type: string format: date description: Data final do ranking obtido ranking: type: array items: type: object allOf: – #/definitions/itemRanking description: Ranking obtido default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/buscarRankingFaturamentoFilial: post: description: Retorna listagem de filiais que mais faturaram no período tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: dataInicial: type: string format: date description: Data inicial utilizada para busca do valor de faturamento dataFinal: type: string format: date description: limite: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal properties: dataInicial: type: string format: date description: dataFinal: type: string format: date description: ranking: type: array items: type: object allOf: – #/definitions/itemRanking description: default: description: Error response schema: #/definitions/genericError get: description: Retorna listagem de filiais que mais faturaram no período tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dataInicial in: query type: string format: date – name: dataFinal in: query type: string format: date – name: limite in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – dataInicial – dataFinal properties: dataInicial: type: string format: date description: dataFinal: type: string format: date description: ranking: type: array items: type: object allOf: – #/definitions/itemRanking description: default: description: Error response schema: #/definitions/genericError /gme_gerencial/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: 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 in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/exportEmpresa: 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: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/exportFilial: 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: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/exportFamilia: 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: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/exportRepresentante: 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: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/exportFaturamentoEmpresa: 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: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/exportFaturamentoFilial: 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: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/exportFaturamentoFamilia: 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: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /gme_gerencial/queries/exportFaturamentoRepresentante: 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: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /gme_gerencial/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 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 default: description: Error response schema: #/definitions/genericError /gme_gerencial/actions/gravarFaturamento: post: description: Salva o faturamento da corporação para uma determinada competência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dados properties: dados: type: array items: type: object allOf: – #/definitions/recDadosFaturamentoFilial minimum: 1 description: Dados para gravação do faturamento responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /gme_gerencial/actions/importarArquivo: post: description: Importa um arquivo csv com os dados de faturamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – arquivo – tipo properties: arquivo: type: string description: Caminho do arquivo no servidor tipo: type: string description: Tipo de conteúdo do arquivo. responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: integer format: int64 description: Nada default: description: Error response schema: #/definitions/genericError /gme_gerencial/actions/importEmpresa: 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: default: description: Error response schema: #/definitions/genericError /gme_gerencial/actions/importFilial: 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: default: description: Error response schema: #/definitions/genericError /gme_gerencial/actions/importFamilia: 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: default: description: Error response schema: #/definitions/genericError /gme_gerencial/actions/importRepresentante: 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: default: description: Error response schema: #/definitions/genericError /gme_gerencial/actions/importFaturamentoEmpresa: 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: default: description: Error response schema: #/definitions/genericError /gme_gerencial/actions/importFaturamentoFilial: 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: default: description: Error response schema: #/definitions/genericError /gme_gerencial/actions/importFaturamentoFamilia: 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: default: description: Error response schema: #/definitions/genericError /gme_gerencial/actions/importFaturamentoRepresentante: 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: default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/empresa: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/empresa responses: 200: description: The created resource schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/empresa responses: 200: description: The created resource schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError get: 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/empresa default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/empresa/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/empresa responses: 200: description: Ok schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/empresa responses: 200: description: Ok schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/empresa/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/empresa responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/filial: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/filial responses: 200: description: The created resource schema: #/definitions/filial default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/filial responses: 200: description: The created resource schema: #/definitions/filial default: description: Error response schema: #/definitions/genericError get: 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/filial default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/filial/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/filial responses: 200: description: Ok schema: #/definitions/filial default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/filial responses: 200: description: Ok schema: #/definitions/filial default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/filial default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/filial/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/filial responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/familia: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/familia responses: 200: description: The created resource schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/familia responses: 200: description: The created resource schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError get: 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/familia default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/familia/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/familia responses: 200: description: Ok schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/familia responses: 200: description: Ok schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/familia/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/familia responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/representante: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/representante responses: 200: description: The created resource schema: #/definitions/representante default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/representante responses: 200: description: The created resource schema: #/definitions/representante default: description: Error response schema: #/definitions/genericError get: 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/representante default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/representante/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/representante responses: 200: description: Ok schema: #/definitions/representante default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/representante responses: 200: description: Ok schema: #/definitions/representante default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/representante default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/representante/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/representante responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/faturamentoEmpresa: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faturamentoEmpresa responses: 200: description: The created resource schema: #/definitions/faturamentoEmpresa default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faturamentoEmpresa responses: 200: description: The created resource schema: #/definitions/faturamentoEmpresa default: description: Error response schema: #/definitions/genericError get: 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/faturamentoEmpresa default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/faturamentoEmpresa/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faturamentoEmpresa responses: 200: description: Ok schema: #/definitions/faturamentoEmpresa default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faturamentoEmpresa responses: 200: description: Ok schema: #/definitions/faturamentoEmpresa default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/faturamentoEmpresa default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/faturamentoEmpresa/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/faturamentoEmpresa responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/faturamentoFilial: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faturamentoFilial responses: 200: description: The created resource schema: #/definitions/faturamentoFilial default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faturamentoFilial responses: 200: description: The created resource schema: #/definitions/faturamentoFilial default: description: Error response schema: #/definitions/genericError get: 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/faturamentoFilial default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/faturamentoFilial/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faturamentoFilial responses: 200: description: Ok schema: #/definitions/faturamentoFilial default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faturamentoFilial responses: 200: description: Ok schema: #/definitions/faturamentoFilial default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/faturamentoFilial default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/faturamentoFilial/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/faturamentoFilial responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/faturamentoFamilia: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faturamentoFamilia responses: 200: description: The created resource schema: #/definitions/faturamentoFamilia default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faturamentoFamilia responses: 200: description: The created resource schema: #/definitions/faturamentoFamilia default: description: Error response schema: #/definitions/genericError get: 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/faturamentoFamilia default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/faturamentoFamilia/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faturamentoFamilia responses: 200: description: Ok schema: #/definitions/faturamentoFamilia default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faturamentoFamilia responses: 200: description: Ok schema: #/definitions/faturamentoFamilia default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/faturamentoFamilia default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/faturamentoFamilia/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/faturamentoFamilia responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/faturamentoRepresentante: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faturamentoRepresentante responses: 200: description: The created resource schema: #/definitions/faturamentoRepresentante default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faturamentoRepresentante responses: 200: description: The created resource schema: #/definitions/faturamentoRepresentante default: description: Error response schema: #/definitions/genericError get: 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/faturamentoRepresentante default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/faturamentoRepresentante/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faturamentoRepresentante responses: 200: description: Ok schema: #/definitions/faturamentoRepresentante default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faturamentoRepresentante responses: 200: description: Ok schema: #/definitions/faturamentoRepresentante default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/faturamentoRepresentante default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /gme_gerencial/entities/faturamentoRepresentante/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/faturamentoRepresentante responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: 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 itemRanking: description: type: object required: – codigo – nome – posicao – valor – participacao properties: codigo: type: integer format: int64 description: nome: type: string maxLength: 100 description: posicao: type: integer format: int64 description: valor: type: number format: double description: participacao: type: number format: double description: recDadosFaturamentoFilial: description: Dados de faturamento type: object required: – codigoEmpresa – codigoFilial – data – valor properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Código da filial data: type: string format: date description: Competência valor: type: number format: double description: Valor do faturamento empresa: description: Cadastro de empresas type: object required: – id – codigo – nome properties: id: type: integer format: int64 description: codigo: type: integer format: int64 description: Código da empresa nome: type: string maxLength: 100 description: filial: description: Cadastro de filial type: object required: – id – empresa – codigo – nome properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: codigo: type: integer format: int64 description: Código da filial nome: type: string maxLength: 100 description: familia: description: Cadastro de família type: object required: – id – empresa – codigo – descricao properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: codigo: type: string maxLength: 6 description: Código da família descricao: type: string maxLength: 100 description: representante: description: Cadastro de representantes type: object required: – id – codigo – nome properties: id: type: integer format: int64 description: codigo: type: integer format: int64 description: Código do representante nome: type: string maxLength: 100 description: faturamentoEmpresa: description: Faturamento por empresa type: object required: – id – empresa – competencia – valorFaturamento properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: competencia: type: string format: date description: valorFaturamento: type: number format: double description: valorOrcamento: type: number format: double description: faturamentoFilial: description: Faturamento por filial type: object required: – empresa – filial – competencia – valorFaturamento properties: id: type: integer format: int64 description: Identificação do registro empresa: type: object allOf: – #/definitions/empresa description: filial: type: object allOf: – #/definitions/filial description: competencia: type: string format: date description: valorFaturamento: type: number format: double description: valorOrcamento: type: number format: double description: faturamentoFamilia: description: Faturamento for família type: object required: – id – empresa – filial – familia – competencia – valorFaturamento properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: filial: type: object allOf: – #/definitions/filial description: familia: type: object allOf: – #/definitions/familia description: competencia: type: string format: date description: valorFaturamento: type: number format: double description: valorOrcamento: type: number format: double description: faturamentoRepresentante: description: Faturamento por representante type: object required: – id – empresa – filial – representante – competencia – valorFaturamento properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: filial: type: object allOf: – #/definitions/filial description: representante: type: object allOf: – #/definitions/representante description: competencia: type: string format: date description: valorFaturamento: type: number format: double description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: 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