ERP senior X Faturamento (erpx_com_fat)

2.0info: 1.0.0 integration description: integration x-senior-domain: erpx_com_fat x-senior-domain-path: erpx_com_fat x-senior-service-path: integration contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /erpx_com_fat/integrationsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /createPointOfSaleInvoice: post: description: Cria uma nota fiscal de consumidor com os dados informados ### Resources - res://senior.com.br/erpx_com_fat/integration/actions/manageInvoice x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – pointOfSaleInvoice properties: pointOfSaleInvoice: #/definitions/pointOfSaleInvoice responses: 200: description: Ok 404: description: Registro não localizado através do ID ERPX ou chave de negócio informados 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericErrordefinitions: taxType: type: string enum: – IPI – IPI_PRESUMIDO – IPI_DEVOLVIDO – IPI_CREDITADO – ICMS – ICMS_SIMPLES – ICMS_FUTURO – ICMS_DIFERIDO – ICMS_DESONERADO – ICMS_ST – ICMS_UF_DESTINO – ICMS_ISENTAS_OUTRAS – ICMS_CREDITADO – ICMS_EFETIVO – ICMS_ST_RETIDO_ANT – ICMS_ST_FUTURO – ICMS_ST_SOLIDARIO – ICMS_IMPORTACAO – ICMS_DESTINO – FCP – FCP_ST – FCP_UF_DESTINO – FCP_ST_RETIDO_ANT – ISS – COFINS – COFINS_RETIDO – COFINS_RECUPERAR_IMPORTACAO – COFINS_RECUPERAR – COFINS_DEVOLVIDO – PIS – PIS_RETIDO – PIS_RECUPERAR_IMPORTACAO – PIS_RECUPERAR – PIS_DEVOLVIDO – CSLL – ISS_RETIDO – IRRF – INSS – INSS_PATRONAL – IMPOSTO_IMPORTACAO – DIFAL – DIFAL_DEVOLVIDO – CIDE_TECNOLOGIA productTaxOrigin: type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 consumerPresence: type: string enum: – NOT_APPLY – PRESENTIAL – NOT_PRESENTIAL_INTERNET – NOT_PRESENTIAL_TELESERVICE – NFCE_DELIVERY – PRESENTIAL_OUTSIDE – NOT_PRESENTIAL_OTHERS integrationTypeInstallment: type: string enum: – TEF – POS – ECOMMERCE cardBrand: type: string enum: – VISA – MASTERCARD – AMERICAN_EXPRESS – SOROCRED – DINERS_CLUB – ELO – HIPERCARD – AURA – CABAL – ALELO – BANES_CARD – CALCARD – CREDZ – DISCOVER – GOODCARD – GREENCARD – HIPER – JCB – MAIS – MAXVAN – POLICARD – REDECOMPRAS – SODEXO – VALECARD – VEROCHEQUE – VR – TICKET – OUTROS paymentMethodType: type: string enum: – CASH_PAYMENT – TERM_PAYMENT pointOfSaleInvoice: type: object required: – externalInvoiceId – branch – issueDate – customer – serie – items – accessKey – protocolNumber – authorizationDate properties: externalInvoiceId: type: string description: Identificador externo da nota fiscal proveniente de integração company: #/definitions/company branch: #/definitions/branch issueDate: type: string description: Data e hora da emissão da nota fiscal format: date-time productTransaction: #/definitions/transaction customer: #/definitions/customer saleRepresentative: #/definitions/representative serie: #/definitions/serie number: type: string description: Número da nota items: type: array items: #/definitions/item description: Itens da nota fiscal invoiceNote: type: string description: Observação consumerPresence: #/definitions/consumerPresence additionalValues: #/definitions/additionalValues invoiceAdditionalInformation: type: string description: Informações complementares para documento fiscal paymentTermId: type: string description: Id da condição de pagamento installments: type: array items: #/definitions/invoiceInstallment description: Parcelas accessKey: type: string description: Chave do documento eletrônico protocolNumber: type: string description: Número do protocolo de autorização do documento eletrônico authorizationDate: type: string description: Data e hora de autorização do documento eletrônico format: date-time company: type: object properties: id: type: string description: Id da empresa code: type: string description: Código da empresa branch: type: object properties: id: type: string description: Id da filial code: type: string description: Código da filial transaction: type: object properties: id: type: string description: Id da transação code: type: string description: Código da transação customer: type: object properties: id: type: string description: Id da pessoa code: type: string description: Código da pessoa taxNumber: type: string description: CPF/CNPJ representative: type: object properties: id: type: string description: Id da pessoa code: type: string description: Código da pessoa serie: type: object properties: id: type: string description: Id da série code: type: string description: Código da série item: type: object required: – productId – saleMeasureUnit – saleQuantity – salePrice properties: productId: type: string description: Id do produto do item transaction: #/definitions/transaction saleMeasureUnit: #/definitions/measureUnit saleQuantity: type: number description: Quantidade de venda format: double salePrice: type: string description: Preço de venda do item discountPercentage: type: number description: Percentual de desconto do item format: double discountValue: type: string description: Valor de desconto do item saleRepresentative: #/definitions/representative comissionPercentage: type: number description: Percentual de comissão do item format: double itemAdditionalDescription: type: string description: Descrição complementar do item itemNote: type: string description: Observação do item ncm: #/definitions/ncm productCESTCode: type: string description: Especificador de substituição tributária fci: type: string description: Código FCI costCenter: #/definitions/costCenter financialAccount: #/definitions/financialAccount additionalValues: #/definitions/additionalValues taxes: type: array items: #/definitions/taxes description: Impostos do item batches: type: array items: #/definitions/batch description: Lotes serial: type: array items: #/definitions/serial description: Serial measureUnit: type: object properties: id: type: string description: Id da unidade de medida code: type: string description: Código da unidade de medida ncm: type: object properties: id: type: string description: Id do ncm code: type: string description: Código do ncm costCenter: type: object properties: id: type: string description: Id do centro de custo code: type: string description: Código do centro de custo financialAccount: type: object properties: id: type: string description: Id da conta financeira code: type: string description: Código da conta financeira additionalValues: type: object properties: additionalDiscountPercent: type: number description: Percentual de desconto adicional format: double additionalDiscountValue: type: string description: Valor de desconto adicional chargesValue: type: string description: Valor dos encargos otherExpensesValue: type: string description: Valor das outras despesas statedOtherExpensesValue: type: string description: Valor das outras despesas destacado importOtherExpensesValue: type: string description: Valor das outras despesas de importação taxes: type: object required: – taxType properties: taxType: #/definitions/taxType taxCalculationBasis: type: string description: Base de cálculo do imposto taxRate: type: number description: Alíquota do imposto format: double taxValue: type: string description: Valor do imposto taxReduction: type: number description: Percentual de redução da base do imposto format: double otherValue: type: string description: Valor de outras exemptedValue: type: string description: Valor de isentas productTaxOrigin: #/definitions/productTaxOrigin cst: type: string description: situação tributária amountCollection: type: number description: Valor recolhido pelo substituto format: double batch: type: object required: – quantity properties: id: type: string description: Id do lote code: type: string description: Código do lote quantity: type: number description: Quantidade de venda do lote format: double serial: type: object properties: id: type: string description: Id do serial code: type: string description: Código do serial invoiceInstallment: type: object required: – installmentDueDate properties: installmentIndex: type: integer description: Sequência installmentDays: type: integer description: Quantidade de dias para a parcela integrationType: #/definitions/integrationTypeInstallment changeValue: type: number description: Valor do troco format: double installmentDueDate: type: string description: Data de vencimento da parcela format: date installmentPercentage: type: number description: Percentual da parcela format: double installmentValue: type: string description: Valor da parcela paymentMethodId: type: string description: Id da forma de pagamento installmentNote: type: string description: Observação da parcela cardCompanyTaxNumber: type: string description: CNPJ da credenciadora de cartão de crédito/débito cardBrand: #/definitions/cardBrand authorizationNumber: type: string description: Número de autorização da operação cartão de crédito/débito nsu: type: string description: Número sequencial único da transação TEF paymentMethodType: #/definitions/paymentMethodType accountsReceivableGroupId: type: string description: Id do grupo a receber accountsReceivableTypeId: type: string description: Id do tipo do título bearerId: type: string description: Id do portador portfolioId: type: string description: Id da carteira expenseNatureId: type: string description: Id da natureza de gasto billNumber: type: string description: Número do título 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