2.0info: 1.2.0 ig5_ordemcompra description: Serviço destinado a integração de ordem de compra G7 X G5 x-senior-domain: erp_sup x-senior-domain-path: erp_sup x-senior-service-path: ig5_ordemcompra 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_supsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /ig5_ordemcompra/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 /ig5_ordemcompra/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 /ig5_ordemcompra/actions/integrarOrdemCompra: post: description: Salva Ordem de Compra tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoFilial – tipo – codigoFornecedor – fecharOrdemCompra – itens properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Código da filial codigoTransacaoServico: type: string maxLength: 5 description: Código da transação de serviço codigoTransacaoProduto: type: string maxLength: 5 description: Código da transação de produto tipo: type: string allOf: – #/definitions/enumOrdemCompraTipo description: Tipo de ordem de compra codigoFornecedor: type: integer format: int64 description: Código do fornecedor fecharOrdemCompra: type: boolean description: Indicativo para fechar a OC tipoFrete: type: string allOf: – #/definitions/enumTipoFrete description: Tipo do frete somaFreteLiquido: type: string allOf: – #/definitions/enumSomaFreteLiquido description: Soma frete no valor lÃquido do item da ordem de compra usuarioComprador: type: string description: Usuario comprador enderecoEntrega: type: object allOf: – #/definitions/recEnderecoEntrada description: endereço de entrega itens: type: array items: type: object allOf: – #/definitions/recOrdemCompraItens minimum: 1 description: Itens da Ordem de Compra observacoes: type: array items: type: object allOf: – #/definitions/recIntegrarOrdemCompraObservacoes description: Sequencias observações da ordem de compra condicaoPagamento: type: string maxLength: 6 description: Condição de pagamento da ordem de compra observacao: type: string maxLength: 1000 description: Observação da ordem de compra responses: 200: description: Ok schema: type: object required: – codigoEmpresa – codigoFilial – codigoPedidoDeCompra properties: codigoEmpresa: type: integer format: int64 description: Código da empresa, retorna da G5 o valor do campo E420OCP.CodEmp codigoFilial: type: integer format: int64 description: código da filial, retorna da G5 o valor do campo E420OCP.CodFil codigoPedidoDeCompra: type: integer format: int64 description: Número do pedido de compra, retorna da G5 o valor do campo E420OCP.NumOcp default: description: Error response schema: #/definitions/genericError /ig5_ordemcompra/actions/alterarObservacaoItemOrdemCompra: post: description: Altera a observação do item de uma ordem de compra tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – itensOrdemCompra properties: itensOrdemCompra: type: array items: type: object allOf: – #/definitions/recObservacaoItemOrdemCompra minimum: 1 description: Lista de itens de uma ordem de compra responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError definitions: enumTipoProduto: description: Tipos de produtos type: string enum: – Produto – Servico enumTipoSKU: description: Enumerador de tipo de SKU type: string enum: – NaoClassificado – Mercadoria – MateriaPrima – Intermediario – Embalagem – Manufatura – EmFabricacao – Subproduto – UsoCosumo – AtivoImobilizado – Servico – OutrosInsumos – Outros enumOrdemCompraTipo: description: Tipo de ordem de compra type: string enum: – ServicoTerceirizacaoIndustrializacao – MaterialUsoConsumo – Servico enumTipoFrete: description: Tipos de frete type: string enum: – CIF – FOB – SemFrete – Terceiros enumSomaFreteLiquido: description: Possibilidades de soma do valor de frete no valor lÃquido da ordem de compra type: string enum: – Sim – Nao enumSubstituicaoTributaria: description: Substituição tributária type: string enum: – SIM – NAO – NAO_INFORMADO 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 recEnderecoEntrada: description: Endereço de entrega type: object required: – codigoEmpresa – codigoFilial – sequenciaEndereco properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Código da filial sequenciaEndereco: type: integer format: int64 description: Sequência recObservacaoItemOrdemCompra: description: Estrutura de um item de ordem de compra com seus valores informados type: object required: – codigoEmpresa – codigoFilial – numeroOrdemCompra – sequenciaItem – tipoProduto properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Código da filial numeroOrdemCompra: type: string description: Número da ordem de compra sequenciaItem: type: integer format: int64 description: Sequência do item tipoProduto: type: string allOf: – #/definitions/enumTipoProduto description: Tipo do produto (produto/serviço) observacao: type: string description: Observações do item recOrdemCompraItens: description: Itens da Ordem de Compra type: object required: – sequencia – preco – tipoSKU properties: sequencia: type: integer format: int64 description: Sequência do item da Ordem de Compra codigoSKU: type: string maxLength: 23 description: Código SKU codigoTransacao: type: string maxLength: 5 description: Código da transação do SKU quantidade: type: number format: double description: Quantidade do SKU preco: type: number format: double description: Preço unitário do SKU tipoSKU: type: string allOf: – #/definitions/enumTipoSKU description: Indicativo produto codigoDeposito: type: string description: Código Depósito idNecessidadeCompra: type: string description: Id necessidade de compra valorFrete: type: number format: double description: Valor do frete complemento: type: string description: Descrição complementar do item codigoUnidadeMedida: type: string maxLength: 3 description: Unidade de medida do item, obrigatória em caso de informação apenas da descrição complementar, sem SKU numeroSolicitacao: type: integer format: int64 description: Número da solicitação de compra sequenciaSolicitacao: type: integer format: int64 description: Sequência da solicitação de compra rateios: type: array items: type: object allOf: – #/definitions/recOrdemCompraRateio description: Rateios do item da ordem de compra impostos: type: object allOf: – #/definitions/recOrdemCompraItemImpostos description: Impostos do item dataPrevisaoEntrega: type: string format: date description: Previsão de entrega do item da ordem de compra observacao: type: string maxLength: 250 description: Observação do item da ordem de compra recOrdemCompraItemImpostos: description: Impostos do item da Ordem de compra type: object properties: cfop: type: string description: Código da CFOP origemMercadoria: type: integer format: int64 description: Origem fiscal da mercadoria/material aliquotaICMS: type: number format: double description: Aliquota do ICMS em percentual baseICMS: type: number format: double description: Base do ICMS aliquotaIPI: type: number format: double description: Aliquota do IPI em percentual baseIPI: type: number format: double description: Base do IPI ncm: type: string description: NCM substituicaoTributaria: type: string allOf: – #/definitions/enumSubstituicaoTributaria description: Indica se tem substituição tributária aliquotaINSS: type: number format: double description: Aliquota do INSS em percentual aliquotaISS: type: number format: double description: Aliquota do ISS em percentual aliquotaPIS: type: number format: double description: Aliquota do PIS em percentual aliquotaCOFINS: type: number format: double description: Aliquota do COFINS em percentual codigoIVA: type: string description: Código IVA baseICMSST: type: number format: double description: BaseICMSST recIntegrarOrdemCompraObservacoes: description: Sequências das observações da ordem de compra type: object required: – observacao properties: observacao: type: string maxLength: 250 description: Observação usuario: type: string description: Código do usuário responsável pela entrada da observação data: type: string format: date description: Data da observação hora: type: string description: Hora da observação solucaoObservacao: type: string maxLength: 250 description: Solução da observação solucaoUsuario: type: string description: Usuário responsável pela solução da observação solucaoData: type: string format: date description: Data solução da observação solucaoHora: type: string description: Hora solução da observação recOrdemCompraRateio: description: Rateios da ordem de compra type: object required: – sequencia – contaFinanceira – contaContabil – centroCusto – percentual – valor properties: sequencia: type: integer format: int64 description: Sequencia contaFinanceira: type: integer format: int64 description: Conta financeira contaContabil: type: integer format: int64 description: Conta contábil centroCusto: type: string description: Centro de custo projeto: type: integer format: int64 description: Número do Projeto fase: type: integer format: int64 description: Código da Fase percentual: type: number format: double description: Percentual de rateio valor: type: number format: double description: Valor de rateio 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 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