tms_fms

cotacao

5 views 22/12/2020 18/03/2021 integrador 0

2.0info: 1.0.2 cotacao description: Serviço da Cotação do FMS x-senior-domain: tms_fms x-senior-domain-path: tms_fms x-senior-service-path: cotacao 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/tms_fmssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /cotacao/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PUBLIC 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 default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PUBLIC 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 default: description: Error response schema: #/definitions/genericError /cotacao/queries/buscaOrcamentos: post: description: Responsável por buscar orcamentos tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa do orçamento descEmpresa: type: string description: Descrição da Empresa Solicitante descricao: type: string description: Descrição do Orçamento responses: 200: description: Ok schema: type: object required: – ok – erro – listaOrcamentos properties: ok: type: boolean description: erro: type: string description: listaOrcamentos: type: object allOf: – #/definitions/orcamento description: default: description: Error response schema: #/definitions/genericError get: description: Responsável por buscar orcamentos tags: – Queries x-senior-visibility: PUBLIC parameters: – name: cdOrcamento description: Código do Orçamento Softran in: query type: integer format: int64 – name: cdEmpresa description: Empresa do orçamento in: query type: integer format: int64 – name: descEmpresa description: Descrição da Empresa Solicitante in: query type: string – name: descricao description: Descrição do Orçamento in: query type: string responses: 200: description: Ok schema: type: object required: – ok – erro – listaOrcamentos properties: ok: type: boolean description: erro: type: string description: listaOrcamentos: type: object allOf: – #/definitions/orcamento description: default: description: Error response schema: #/definitions/genericError /cotacao/queries/buscaItemOrcamento: post: description: Responsável por buscar Itens tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: cdItem: type: integer format: int64 description: Código do Item cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa da orçamento responses: 200: description: Ok schema: type: object required: – ok – erro – listaItens properties: ok: type: boolean description: erro: type: string description: listaItens: type: object allOf: – #/definitions/itemOrcamento description: default: description: Error response schema: #/definitions/genericError get: description: Responsável por buscar Itens tags: – Queries x-senior-visibility: PUBLIC parameters: – name: cdItem description: Código do Item in: query type: integer format: int64 – name: cdOrcamento description: Código do Orçamento Softran in: query type: integer format: int64 – name: cdEmpresa description: Empresa da orçamento in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – erro – listaItens properties: ok: type: boolean description: erro: type: string description: listaItens: type: object allOf: – #/definitions/itemOrcamento description: default: description: Error response schema: #/definitions/genericError /cotacao/queries/buscaItensOrcamento: post: description: Responsável por buscar Itens tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa da orçamento responses: 200: description: Ok schema: type: object required: – ok – erro – listaItens properties: ok: type: boolean description: erro: type: string description: listaItens: type: array items: type: object allOf: – #/definitions/itemOrcamento minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: Responsável por buscar Itens tags: – Queries x-senior-visibility: PUBLIC parameters: – name: cdOrcamento description: Código do Orçamento Softran in: query type: integer format: int64 – name: cdEmpresa description: Empresa da orçamento in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – erro – listaItens properties: ok: type: boolean description: erro: type: string description: listaItens: type: array items: type: object allOf: – #/definitions/itemOrcamento minimum: 1 description: default: description: Error response schema: #/definitions/genericError /cotacao/queries/buscaFornecedorOrcamento: post: description: Responsável por buscar Fornecedores tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa da orçamento cdInscricao: type: string description: Inscrição do Fornecedor responses: 200: description: Ok schema: type: object required: – ok – erro – listaFornecedores properties: ok: type: boolean description: erro: type: string description: listaFornecedores: type: object allOf: – #/definitions/fornecedorOrcamento description: default: description: Error response schema: #/definitions/genericError get: description: Responsável por buscar Fornecedores tags: – Queries x-senior-visibility: PUBLIC parameters: – name: cdOrcamento description: Código do Orçamento Softran in: query type: integer format: int64 – name: cdEmpresa description: Empresa da orçamento in: query type: integer format: int64 – name: cdInscricao description: Inscrição do Fornecedor in: query type: string responses: 200: description: Ok schema: type: object required: – ok – erro – listaFornecedores properties: ok: type: boolean description: erro: type: string description: listaFornecedores: type: object allOf: – #/definitions/fornecedorOrcamento description: default: description: Error response schema: #/definitions/genericError /cotacao/queries/buscaFornecedoresOrcamento: post: description: Responsável por buscar Fornecedores tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa da orçamento responses: 200: description: Ok schema: type: object required: – ok – erro – listaFornecedores properties: ok: type: boolean description: erro: type: string description: listaFornecedores: type: array items: type: object allOf: – #/definitions/fornecedorOrcamento minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: Responsável por buscar Fornecedores tags: – Queries x-senior-visibility: PUBLIC parameters: – name: cdOrcamento description: Código do Orçamento Softran in: query type: integer format: int64 – name: cdEmpresa description: Empresa da orçamento in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – erro – listaFornecedores properties: ok: type: boolean description: erro: type: string description: listaFornecedores: type: array items: type: object allOf: – #/definitions/fornecedorOrcamento minimum: 1 description: default: description: Error response schema: #/definitions/genericError /cotacao/queries/buscaCotacoesItem: post: description: Responsável por buscar Cotações tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cdOrcamento – cdEmpresa – cdItem properties: cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa da orçamento cdItem: type: integer format: int64 description: Código do Item cdInscricao: type: string description: Inscrição do Fornecedor responses: 200: description: Ok schema: type: object required: – ok – erro – listaCotacoes properties: ok: type: boolean description: erro: type: string description: listaCotacoes: type: array items: type: object allOf: – #/definitions/cotacaoItem minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: Responsável por buscar Cotações tags: – Queries x-senior-visibility: PUBLIC parameters: – name: cdOrcamento description: Código do Orçamento Softran in: query required: true type: integer format: int64 – name: cdEmpresa description: Empresa da orçamento in: query required: true type: integer format: int64 – name: cdItem description: Código do Item in: query required: true type: integer format: int64 – name: cdInscricao description: Inscrição do Fornecedor in: query type: string responses: 200: description: Ok schema: type: object required: – ok – erro – listaCotacoes properties: ok: type: boolean description: erro: type: string description: listaCotacoes: type: array items: type: object allOf: – #/definitions/cotacaoItem minimum: 1 description: default: description: Error response schema: #/definitions/genericError /cotacao/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 description: 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 /cotacao/queries/exportOrcamento: 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 /cotacao/queries/exportItemOrcamento: 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 /cotacao/queries/exportFornecedorOrcamento: 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 /cotacao/queries/exportCotacaoItem: 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 /cotacao/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 /cotacao/actions/adicionaOrcamento: post: description: Responsável por adicionar um orçamento tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cdOrcamento – cdEmpresa properties: cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa do orçamento descEmpresa: type: string description: Descrição da Empresa Solicitante descricao: type: string description: Descrição do Orçamento itens: type: array items: type: object allOf: – #/definitions/itemOrcamento description: Lista de Itens fornecedores: type: array items: type: object allOf: – #/definitions/fornecedorOrcamento description: Lista de Fornecedores responses: 200: description: Ok schema: type: object required: – ok – erro properties: ok: type: boolean description: erro: type: string description: default: description: Error response schema: #/definitions/genericError /cotacao/actions/adicionaItemOrcamento: post: description: Responsável por Adicionar Itens do Orçamento tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cdItem – cdOrcamento – cdEmpresa properties: cdItem: type: integer format: int64 description: Código do Item cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa da orçamento descricao: type: string description: Descrição do Item complemento: type: string description: Complemento da Descrição do Item quatidade: type: number format: double description: Quantidade do Item unidadeMedida: type: string description: Descrição da Unidade de Medida responses: 200: description: Ok schema: type: object required: – ok – erro properties: ok: type: boolean description: erro: type: string description: default: description: Error response schema: #/definitions/genericError /cotacao/actions/adicionaFornecedorOrcamento: post: description: Responsável por Adicionar Fornecedores tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cdOrcamento – cdEmpresa – cdInscricao properties: cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa da orçamento cdInscricao: type: string description: Inscrição do Fornecedor vencimento: type: integer format: int64 description: Condição de Vencimento descVencimento: type: string description: Descrição da Condição de Vencimento tipoFrete: type: string allOf: – #/definitions/enumTpFrete description: Tipo de Frete responses: 200: description: Ok schema: type: object required: – ok – erro properties: ok: type: boolean description: erro: type: string description: default: description: Error response schema: #/definitions/genericError /cotacao/actions/adicionaCotacaoItem: post: description: Responsável por Adicionar Cotações tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cdOrcamento – cdEmpresa – cdItem – cdInscricao – quatidadeCotado – vlUnitario – vlTotal properties: cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa da orçamento cdItem: type: integer format: int64 description: Código do Item cdInscricao: type: string description: Inscrição do Fornecedor quatidadeCotado: type: number format: double description: Quantidade do Item Cotado vlUnitario: type: number format: double description: Valor Unitário vlIPI: type: number format: double description: Valor IPI vlDesconto: type: number format: double description: Valor Desconto vlTotal: type: number format: double description: Valor Total descricaoMarca: type: string description: Marca do Item responses: 200: description: Ok schema: type: object required: – ok – erro properties: ok: type: boolean description: erro: type: string description: default: description: Error response schema: #/definitions/genericError /cotacao/actions/removeOrcamento: post: description: Responsável por Remover Orçamentos tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cdOrcamento – cdEmpresa properties: cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa do orçamento responses: 200: description: Ok schema: type: object required: – ok – erro properties: ok: type: boolean description: erro: type: string description: default: description: Error response schema: #/definitions/genericError /cotacao/actions/removeItem: post: description: Responsável por Remover Itens tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cdOrcamento – cdEmpresa – cdItem properties: cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa da orçamento cdItem: type: integer format: int64 description: Código do Item responses: 200: description: Ok schema: type: object required: – ok – erro properties: ok: type: boolean description: erro: type: string description: default: description: Error response schema: #/definitions/genericError /cotacao/actions/removeFornecedor: post: description: Responsável por Remover Fornecedores tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cdOrcamento – cdEmpresa – cdInscricao properties: cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa da orçamento cdInscricao: type: string description: Inscrição do Fornecedor responses: 200: description: Ok schema: type: object required: – ok – erro properties: ok: type: boolean description: erro: type: string description: default: description: Error response schema: #/definitions/genericError /cotacao/actions/removeCotacao: post: description: Responsável por Remover Cotações tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cdOrcamento – cdEmpresa – cdItem – cdInscricao properties: cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa da orçamento cdItem: type: integer format: int64 description: Código do Item cdInscricao: type: string description: Inscrição do Fornecedor responses: 200: description: Ok schema: type: object required: – ok – erro properties: ok: type: boolean description: erro: type: string description: default: description: Error response schema: #/definitions/genericError /cotacao/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response default: description: Error response schema: #/definitions/genericError /cotacao/actions/importOrcamento: 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 /cotacao/actions/importItemOrcamento: 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 /cotacao/actions/importFornecedorOrcamento: 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 /cotacao/actions/importCotacaoItem: 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 /cotacao/entities/orcamento: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/orcamento responses: 200: description: The created resource schema: #/definitions/orcamento default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/orcamento responses: 200: description: The created resource schema: #/definitions/orcamento default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/orcamento default: description: Error response schema: #/definitions/genericError /cotacao/entities/orcamento/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/orcamento responses: 200: description: Ok schema: #/definitions/orcamento default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/orcamento responses: 200: description: Ok schema: #/definitions/orcamento default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/orcamento default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /cotacao/entities/orcamento/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/orcamento responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /cotacao/entities/itemOrcamento: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/itemOrcamento responses: 200: description: The created resource schema: #/definitions/itemOrcamento default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/itemOrcamento responses: 200: description: The created resource schema: #/definitions/itemOrcamento default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/itemOrcamento default: description: Error response schema: #/definitions/genericError /cotacao/entities/itemOrcamento/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/itemOrcamento responses: 200: description: Ok schema: #/definitions/itemOrcamento default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/itemOrcamento responses: 200: description: Ok schema: #/definitions/itemOrcamento default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/itemOrcamento default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /cotacao/entities/itemOrcamento/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/itemOrcamento responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /cotacao/entities/fornecedorOrcamento: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/fornecedorOrcamento responses: 200: description: The created resource schema: #/definitions/fornecedorOrcamento default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/fornecedorOrcamento responses: 200: description: The created resource schema: #/definitions/fornecedorOrcamento default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/fornecedorOrcamento default: description: Error response schema: #/definitions/genericError /cotacao/entities/fornecedorOrcamento/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/fornecedorOrcamento responses: 200: description: Ok schema: #/definitions/fornecedorOrcamento default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/fornecedorOrcamento responses: 200: description: Ok schema: #/definitions/fornecedorOrcamento default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/fornecedorOrcamento default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /cotacao/entities/fornecedorOrcamento/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/fornecedorOrcamento responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /cotacao/entities/cotacaoItem: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cotacaoItem responses: 200: description: The created resource schema: #/definitions/cotacaoItem default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cotacaoItem responses: 200: description: The created resource schema: #/definitions/cotacaoItem default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/cotacaoItem default: description: Error response schema: #/definitions/genericError /cotacao/entities/cotacaoItem/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cotacaoItem responses: 200: description: Ok schema: #/definitions/cotacaoItem default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cotacaoItem responses: 200: description: Ok schema: #/definitions/cotacaoItem default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/cotacaoItem default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /cotacao/entities/cotacaoItem/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/cotacaoItem responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: upDown: description: Up or down type: string enum: – UP – DOWN enumTpFrete: description: Tipo do Frete type: string enum: – Pago – A – Pagar 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 orcamento: description: Orçamentos a Serem Cotados type: object required: – cdOrcamento – cdEmpresa – descEmpresa properties: id: type: string format: uuid description: Código único do Orçamento cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa do orçamento descEmpresa: type: string description: Descrição da Empresa Solicitante descricao: type: string description: Descrição do Orçamento itemOrcamento: type: array items: type: object allOf: – #/definitions/itemOrcamento description: Lista de Itens fornecedorOrcamento: type: array items: type: object allOf: – #/definitions/fornecedorOrcamento description: Lista de Fornecedores itemOrcamento: description: Itens do Orçamento type: object required: – cdItem – cdOrcamento – cdEmpresa – descricao properties: id: type: string format: uuid description: Código único do Item cdItem: type: integer format: int64 description: Código do Item cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa da orçamento descricao: type: string description: Descrição do Item complemento: type: string description: Complemento da Descrição do Item quatidade: type: number format: double description: Quantidade do Item unidadeMedida: type: string description: Descrição da Unidade de Medida orcamento: type: object allOf: – #/definitions/orcamento description: Orçamento cotacaoItem: type: array items: type: object allOf: – #/definitions/cotacaoItem description: Cotações fornecedorOrcamento: description: Fornecedores do Orçamento type: object required: – cdOrcamento – cdEmpresa – cdInscricao – vencimento – descVencimento properties: id: type: string format: uuid description: Código único do Fornecedor cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa da orçamento cdInscricao: type: string description: Inscrição do Fornecedor vencimento: type: integer format: int64 description: Condição de Vencimento descVencimento: type: string description: Descrição da Condição de Vencimento tipoFrete: type: string allOf: – #/definitions/enumTpFrete description: Tipo de Frete orcamento: type: object allOf: – #/definitions/orcamento description: Orçamento cotacaoItem: type: array items: type: object allOf: – #/definitions/cotacaoItem description: Cotações cotacaoItem: description: Cotação do Fornecedores para o Item type: object required: – cdOrcamento – cdEmpresa – cdItem – cdInscricao – quatidadeCotado – vlUnitario – vlTotal properties: id: type: string format: uuid description: Código único da Cotação cdOrcamento: type: integer format: int64 description: Código do Orçamento Softran cdEmpresa: type: integer format: int64 description: Empresa da orçamento cdItem: type: integer format: int64 description: Código do Item cdInscricao: type: string description: Inscrição do Fornecedor quatidadeCotado: type: number format: double description: Quantidade do Item Cotado vlUnitario: type: number format: double description: Valor Unitário vlIPI: type: number format: double description: Valor IPI vlDesconto: type: number format: double description: Valor Desconto vlTotal: type: number format: double description: Valor Total descricaoMarca: type: string description: Marca do Item itemOrcamento: type: object allOf: – #/definitions/itemOrcamento description: Item do Orçamento fornecedorOrcamento: type: object allOf: – #/definitions/fornecedorOrcamento description: Fornecedor Orcamento 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