Foundation (foundation)

Foundation (foundation)

277 views 17/05/2021 23/11/2021 integrador 0

2.0info: 1.2.2 Foundation description: Foundation x-senior-domain: ERPX – Foundation para integração x-senior-domain-path: erpx x-senior-service-path: foundation contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /erpx/foundation/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonpaths: /productCreated: post: description: Event of product create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/product responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /productDeleted: post: description: Event of product delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/product responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /productMerged: post: description: Event of product merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/product responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /productUpdated: post: description: Event of product update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/product responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /personCreated: post: description: Event of person create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/person responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /personDeleted: post: description: Event of person delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/person responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /personMerged: post: description: Event of person merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/person responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /personUpdated: post: description: Event of person update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/person responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /serviceitemCreated: post: description: Event of serviceitem create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/serviceitem responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /serviceitemDeleted: post: description: Event of serviceitem delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/serviceitem responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /serviceitemMerged: post: description: Event of serviceitem merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/serviceitem responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /serviceitemUpdated: post: description: Event of serviceitem update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/serviceitem responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/product: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/product responses: 200: description: The created resource schema: #/definitions/product default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/product responses: 200: description: The created resource schema: #/definitions/product default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/product default: description: Error response schema: #/definitions/genericError /entities/product/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/product responses: 200: description: Ok schema: #/definitions/product default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/product responses: 200: description: Ok schema: #/definitions/product default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/product default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/product/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/product responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/serviceitem: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/serviceitem responses: 200: description: The created resource schema: #/definitions/serviceitem default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/serviceitem responses: 200: description: The created resource schema: #/definitions/serviceitem default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/serviceitem default: description: Error response schema: #/definitions/genericError /entities/serviceitem/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/serviceitem responses: 200: description: Ok schema: #/definitions/serviceitem default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/serviceitem responses: 200: description: Ok schema: #/definitions/serviceitem default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/serviceitem default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/serviceitem/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/serviceitem responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/person: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/person responses: 200: description: The created resource schema: #/definitions/person default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/person responses: 200: description: The created resource schema: #/definitions/person default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/person default: description: Error response schema: #/definitions/genericError /entities/person/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/person responses: 200: description: Ok schema: #/definitions/person default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/person responses: 200: description: Ok schema: #/definitions/person default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/person default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/person/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/person responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericErrordefinitions: product: type: object required: – company – family – code – description – status properties: id: type: string description: format: uuid company: #/definitions/company family: #/definitions/family code: type: string description: Código description: type: string description: Descrição additionalDescription: type: string description: Descrição complementar barcode: type: string description: Código de barras freeBarcode: type: string description: Código barras livre gtin: type: string description: GTIN unidade tributável productIdentification: type: string description: Identificação produto grossWeight: type: number description: Peso bruto format: double netWeight: type: number description: Peso líquido format: double referenceCode: type: string description: Código da Referência spendingNature: #/definitions/spendingNature status: type: string description: Situação statusReason: #/definitions/statusReason productFramework: type: string description: Enquadramento de produto específico deleted: type: boolean description: Indica se o registro foi excluído commercialProduct: #/definitions/commercialProduct taxProduct: #/definitions/taxProduct stockProduct: #/definitions/stockProduct purchaseProduct: #/definitions/purchaseProduct apportionmentProduct: #/definitions/apportionmentProduct company: type: object properties: id: type: string description: format: uuid family: type: object properties: id: type: string description: format: uuid spendingNature: type: object properties: id: type: string description: format: uuid statusReason: type: object properties: id: type: string description: format: uuid commercialProduct: type: object properties: id: type: string description: format: uuid gtinCodeSearchType: type: string description: Forma de busca do código GTIN para gerar as tags cEAN e cEANTrib groupingSalesQuotas: #/definitions/groupingSalesQuotas baseQuantityForPriceCalculation: type: number description: Quantidade Base para Cálculo de Preço format: double productSoldSeparately: type: boolean description: Produto vendido separadamente? anvisaRegistrationNumber: type: string description: Número registro Anvisa reasonForAnvisaExemption: type: string description: Motivo da isenção da Anvisa productCanBeSold: type: boolean description: Indicativo se o produto pode ser vendido productPerCustomer: type: boolean description: Produto por Cliente multiSalesQuantity: type: number description: Quantidade Múltipla Vendas format: double priceGrouping: type: string description: Agrupamento Preço commissioned: type: boolean description: Comissionado ? measureUnitPriceCalculation: type: string description: Unidade Medida (Cálculo de preço) percentageNaturalGas: type: number description: % Gás Natural format: double customProduct: type: boolean description: Produto Sob Encomenda percentageInGLPProduct: type: number description: Percentual do GLP derivado do petróleo no produto GLP format: double percentageOfImportedNaturalGas: type: number description: Percentual de Gás Natural Importado – GLGNi para o produto GLP format: double measureUnit: #/definitions/measureUnit invoiceDescription: type: string description: Descrição p/ Nota Fiscal additionalInformationForInvoice: type: string description: Informações adicionais do produto para NF-e groupingSalesQuotas: type: object properties: id: type: string description: format: uuid measureUnit: type: object properties: id: type: string description: format: uuid taxProduct: type: object properties: id: type: string description: format: uuid taxCode: type: string description: Código fiscal taxDescription: type: string description: Descrição fiscal ncm: #/definitions/ncm taxProductType: type: string description: Tipo Produto para Impostos productCodeForANP: type: integer description: Código de produto ANP productDescriptionForANP: type: string description: Descrição do produto conforme ANP taxOriginOfGoods: type: string description: Origem fiscal da mercadoria cest: type: string description: Especificador substituição tributária generateTransferGroupWithCST60: type: boolean description: Gerar grupo de repasse de ICMS ST na NF-e mesmo com CST 60 pepsControl: type: boolean description: Controla PEPS producedOnRelevantScale: type: boolean description: Produzido em escala relevante ncm: type: object properties: id: type: string description: format: uuid stockProduct: type: object properties: id: type: string description: format: uuid serialControl: type: boolean description: Controla por Série? batchControl: type: boolean description: Controla por Lote? validityControl: type: string description: Controle Validade measureUnit: #/definitions/measureUnit batchValidityDays: type: integer description: Dias Cálculo Validade Lote averagePrice: type: string description: Valor/Data Preço Médio averagePriceDate: type: string description: Data Preço Médio format: date canBeRequested: type: boolean description: Indicativo se o produto pode ser requisitado (movimento estoque) abcCurve: type: string description: Curva ABC abcCurveValue: type: string description: Curva ABC (Valor) abcCurveConsumptionQuantity: type: string description: Curva ABC (Consumo/Quantidade) abcCurveConsumptionValue: type: string description: Curva ABC (Consumo/Valor) costPrice: type: string description: Valor do preço de custo para entrada via produção purchaseProduct: type: object properties: id: type: string description: format: uuid canBePurchased: type: boolean description: Pode Ser Comprado? isLinkedToSupplier: type: boolean description: Indicativo se tem ligação com o fornecedor apportionmentProduct: type: object properties: id: type: string description: format: uuid expenseAccount: #/definitions/account revenueAccount: #/definitions/account inventoryLedgerAccount: #/definitions/account directCostAccount: #/definitions/account account5: #/definitions/account indirectCostAccount: #/definitions/account revenueFinancialAccount: #/definitions/financialAccount expenseFinancialAccount: #/definitions/financialAccount account: type: object properties: id: type: string description: format: uuid financialAccount: type: object properties: id: type: string description: format: uuid person: type: object required: – code – name – tradeName – personType – marketType properties: id: type: string description: format: uuid code: type: integer description: Código name: type: string description: Nome tradeName: type: string description: Nome fantasia personType: type: string description: Tipo de pessoa documentNumber: type: string description: CNPJ/CPF rgNumber: type: string description: Número do RG rgIssuanceDate: type: string description: Data de emissão do RG format: date rgIssuer: type: string description: Órgão emissor do RG stateRegistration: type: string description: Inscrição estadual municipalRegistration: type: string description: Inscrição municipal useTaxIdentificationNumber: type: string description: Utilização do número de identificação fiscal (NIF) taxIdentificationNumber: type: string description: Número de identificação fiscal (NIF) marketType: type: string description: Tipo de mercado do cliente companyType: type: string description: Tipo de ramo de atividade companyGroup: #/definitions/companyGroup taxBenefit: type: string description: Indicativo de qual o benefício fiscal do cliente suframaCode: type: string description: Código do SUFRAMA suframaValidity: type: string description: Validade do registro do SUFRAMA format: date cep: #/definitions/cep address: type: string description: Endereço addressNumber: type: string description: Número addressComplement: type: string description: Complemento neighborhood: type: string description: Bairro country: #/definitions/country state: #/definitions/state city: #/definitions/city mailbox: type: integer description: Caixa postal zipCode: type: string description: Zip code phoneNumber: type: string description: Telefone phoneNumber2: type: string description: Telefone 2 fax: type: string description: Fax email: type: string description: E-mail emailForElectronicDocuments: type: string description: E-mail para envio de documentos eletrônicos birthDate: type: string description: Data de nascimento format: date customerExpirationDate: type: string description: Vencimento do cadastro do cliente format: date cadastralRenewalsAmount: type: integer description: Quantidade de renovações cadastrais cboNumber: #/definitions/cbo insuredRegistration: type: string description: Número de inscrição do segurado (NIS, NIT e PIS/PASEP) numberOfDependents: type: integer description: Quantidade de dependentes alimonyValue: type: string description: Valor da Pensão judicial/alimentícia caepf: type: string description: Cadastro da atividade econômica da pessoa física (CAEPF) industry: #/definitions/industry status: type: string description: Situação shippingCompany: #/definitions/shippingCompany favored: #/definitions/favored customer: #/definitions/customer representative: #/definitions/representative provider: #/definitions/provider deleted: type: boolean description: Indica se o registro foi excluído companyGroup: type: object properties: id: type: string description: format: uuid cep: type: object properties: id: type: string description: format: uuid country: type: object properties: id: type: string description: format: uuid state: type: object properties: id: type: string description: format: uuid city: type: object properties: id: type: string description: format: uuid cbo: type: object properties: id: type: string description: format: uuid industry: type: object properties: id: type: string description: format: uuid shippingCompany: type: object properties: id: type: string description: format: uuid freightType: type: string description: Indicativo se o frete da transportadora é CIF ou FOB contactName: type: string description: Nome da pessoa de contato na transportadora rntrc: type: string description: Registro nacional de transportadores rodoviários de carga – RNTRC taf: type: string description: Termo de autorização dos serviços em regime de fretamento – TAF registrationNumber: type: string description: Número de registro adquirido junto a administração estadual status: type: string description: Situação da transportadora favored: type: object required: – status properties: id: type: string description: format: uuid bank: #/definitions/bank accountType: type: string description: Tipo de conta bankBranch: #/definitions/bankBranch accountNumber: type: string description: Número da conta corrente do favorecido no banco status: type: string description: Situação do favorecido bank: type: object properties: id: type: string description: format: uuid bankBranch: type: object properties: id: type: string description: format: uuid customer: type: object required: – status properties: id: type: string description: format: uuid status: type: string description: Situação do cliente statusReason: #/definitions/statusReason statusReasonNote: type: string description: Observação do motivo da situação do cliente statusReasonDate: type: string description: Data do motivo da situação do cliente format: date-time statusReasonUser: type: string description: Usuário responsável pelo motivo da situação do cliente propertyRight: type: string description: Tipo do direito de propriedade da empresa brand: type: string description: Marca do cliente roundindType: type: string description: Tipo de acerto (arredondamento) do cliente representative: type: object required: – commissionPaymentType – status properties: id: type: string description: format: uuid commissionPaymentType: type: string description: Forma de pagamento da comissão do portador status: type: string description: Situação statusReason: #/definitions/statusReason statusReasonNote: type: string description: Observação do motivo statusReasonUpdateDate: type: string description: Data da alteração do motivo format: date-time statusReasonUpdatedBy: type: string description: Usuário da alteração do motivo provider: type: object required: – status properties: id: type: string description: format: uuid brand: type: string description: Marca propertyRight: type: string description: Tipo do direito de propriedade da empresa website: type: string description: Site useAbntRounding: type: boolean description: Utilizar a regra de arredondamento da ABNT supplierType: type: string description: Tipo do fornecedor status: type: string description: Situação do fornecedor statusReason: #/definitions/statusReason statusReasonNote: type: string description: Observação do motivo da situação do fornecedor statusReasonDate: type: string description: Data do motivo da situação do fornecedor format: date statusReasonUser: type: string description: Usuário responsável pelo motivo da situação do fornecedor serviceitem: type: object required: – company – family – code – description – measureUnit properties: id: type: string description: format: uuid company: #/definitions/company family: #/definitions/family code: type: string description: Serviço description: type: string description: Descrição additionalDescription: type: string description: Complemento measureUnit: #/definitions/measureUnit standardQuantity: type: number description: Quantidade padrão format: double note: type: string description: Observação do serviço branch: #/definitions/branch shippingCompany: #/definitions/shippingCompany linkType: type: string description: Tipo de ligação tensionGroup: type: string description: Cód. do grupo de tensão energyClass: type: string description: Classe cons. energia/gás waterClass: type: string description: Classe fornec. Água maintenanceCategory: #/definitions/maintenanceCategory spendingNature: #/definitions/spendingNature purchasePrice: type: string description: Preço unitário do serviço para compras status: type: string description: Situação deleted: type: boolean description: Indica se o registro foi excluído commercialService: #/definitions/commercialService taxService: #/definitions/taxService apportionmentService: #/definitions/apportionmentService purchaseService: #/definitions/purchaseService branch: type: object properties: id: type: string description: format: uuid maintenanceCategory: type: object properties: id: type: string description: format: uuid commercialService: type: object required: – invoiceDescription properties: id: type: string description: format: uuid invoiceDescription: type: string description: Descrição do serviço para impressão na nota fiscal serviceType: type: string description: Tipo de Serviço Comércio discountPercentage: type: number description: Percentual de desconto previsto para venda do serviço format: double commissionPercentage: type: number description: Percentual de comissão previsto para venda do serviço format: double taxService: type: object properties: id: type: string description: format: uuid taxCode: type: string description: Código fiscal taxDescription: type: string description: Descrição fiscal ncm: #/definitions/ncm law1162003: #/definitions/law1162003 nbs: #/definitions/nbs serviceActivityCode: type: string description: Código da atividade do item de serviço taxDevice: #/definitions/taxDevice taxOriginOfGoods: type: string description: Origem fiscal da mercadoria cest: type: string description: Especificador substituição tributária law1162003: type: object properties: id: type: string description: format: uuid nbs: type: object properties: id: type: string description: format: uuid taxDevice: type: object properties: id: type: string description: format: uuid apportionmentService: type: object properties: id: type: string description: format: uuid expenseAccount: #/definitions/account revenueAccount: #/definitions/account directCostAccount: #/definitions/account indirectCostAccount: #/definitions/account costCenter: #/definitions/costCenter revenueFinancialAccount: #/definitions/financialAccount expenseFinancialAccount: #/definitions/financialAccount costCenter: type: object properties: id: type: string description: format: uuid purchaseService: type: object properties: id: type: string description: format: uuid isLinkedToSupplier: type: boolean description: Indicativo se tem ligação com o fornecedor 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