2.0info: 1.2.0 facade description: Suprimentos (facade) x-senior-domain: ERPX – Suprimentos para integração (erpx_sup_int) x-senior-domain-path: erpx_sup_int x-senior-service-path: facade contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /erpx_sup_int/facadesecurityDefinitions: 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: /invoiceIntegratedSuccess: post: description: Evento que indica a integração com sucesso de uma nota fiscal x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – ticketId – company – branch – invoiceId – invoiceNumber – invoiceKey – series – invoiceType properties: ticketId: type: string description: Identificador do Ticket company: type: string description: Identificador da Empresa branch: type: string description: Identificador da Filial invoiceId: type: string description: Identificador da Nota Fiscal invoiceNumber: type: string description: Número da Nota Fiscal invoiceKey: type: string description: Chave da Nota Fiscal series: type: string description: Série da Nota Fiscal invoiceType: #/definitions/enumTipNfe responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /invoiceIntegratedError: post: description: Evento que indica a integração com erro de uma nota fiscal x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – ticketId – invoiceType – message properties: ticketId: type: string description: Identificador do Ticket invoiceType: #/definitions/enumTipNfe message: type: string description: Mensagem de erro ao gerar uma nota stackTrace: type: string description: Stacktrace responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/incomingInvoice/{id}: get: description: The retrieve request primitive for the incomingInvoice facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/incomingInvoiceFacade default: description: Error response schema: #/definitions/genericError /apis/integrateThirdPartyIncomingInvoice: post: description: The create request primitive for the integrateThirdPartyIncomingInvoice facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/integrateThirdPartyIncomingInvoiceFacadeInput responses: 200: description: Ok schema: #/definitions/integrateThirdPartyIncomingInvoiceFacadeOutput default: description: Error response schema: #/definitions/genericErrordefinitions: enumTipNfe: type: string enum: – V1 – V2 – V4 – V6 – V8 – V9 – V10 – V12 enumBaseDueDate: type: string enum: – ISSUE_DATE – ENTRY_DATE incomingInvoiceFacade: type: object required: – id – company – branch – sender – fiscalSeries – invoiceNumber – entryDate – issueDate – items properties: id: type: string description: format: uuid company: #/definitions/genericRecord branch: #/definitions/person sender: #/definitions/person fiscalSeries: #/definitions/genericRecord invoiceNumber: type: string description: Número da Nota Fiscal entryDate: type: string description: Data de Entrada format: date issueDate: type: string description: Data de Emissão format: date productTransaction: #/definitions/transaction serviceTransaction: #/definitions/transaction invoiceKey: type: string description: Chave da Nota Fiscal observation: type: string description: Observação payment: #/definitions/paymentData items: type: array items: #/definitions/invoiceItem description: Itens da Nota Fiscal (produtos ou serviços) message: type: string description: Mensagem genericRecord: type: object properties: id: type: string description: Identificador code: type: string description: Código de registro name: type: string description: Nome do registro shortName: type: string description: Descrição curta person: type: object properties: id: type: string description: Identificador code: type: string description: Código de registro name: type: string description: Nome do registro shortName: type: string description: Descrição curta documentNumber: type: string description: CPF, CNPJ ou NIF (Número de Identificação Fiscal) transaction: type: object properties: id: type: string description: Identificador code: type: string description: Código de registro name: type: string description: Nome do registro shortName: type: string description: Descrição curta cfop: type: string description: paymentData: type: object required: – paymentCondition – expirationDateIndicator properties: paymentCondition: type: string description: Código da condição de pagamento expirationDateIndicator: #/definitions/enumBaseDueDate invoiceItem: type: object required: – transaction – quantity – unitPrice properties: id: type: string description: Identificador code: type: string description: Código de registro name: type: string description: Nome do registro shortName: type: string description: Descrição curta transaction: #/definitions/transaction entryUnit: type: string description: Código da unidade de entrada quantity: type: string description: Quantidade do item unitPrice: type: string description: Preço unitário do item warehouse: #/definitions/genericRecord discountValue: type: string description: Valor do desconto batch: type: array items: #/definitions/batch description: Informações do lote distributionSeries: type: array items: #/definitions/distribuitionSeries description: Informações da Série de Distribuição batch: type: object required: – code – batchQuantity properties: code: type: string description: Código do lote (obrigatório se o lote for fornecido) batchQuantity: type: string description: Quantidade do lote manufactureDate: type: string description: Data de fabricação do lote format: date expirationDate: type: string description: Data de validade do lote format: date distribuitionSeries: type: object required: – seriesNumber properties: seriesNumber: type: string description: Número da série manufactureDate: type: string description: Data de fabricação da série format: date expirationDate: type: string description: Data de validade da série format: date integrateThirdPartyIncomingInvoiceFacadeInput: type: object required: – company – branch – sender – series – invoiceNumber – entryDate – issueDate – items properties: id: type: string description: format: uuid company: #/definitions/genericRecord branch: #/definitions/person sender: #/definitions/person series: #/definitions/genericRecord invoiceNumber: type: integer description: Número da Nota Fiscal entryDate: type: string description: Data de Entrada format: date-time issueDate: type: string description: Data de Emissão format: date-time productTransaction: #/definitions/transaction serviceTransaction: #/definitions/transaction invoiceKey: type: string description: Chave da Nota Fiscal observation: type: string description: Observação payment: #/definitions/paymentData items: type: array items: #/definitions/invoiceItem description: Itens da Nota Fiscal (produtos ou serviços) integrateThirdPartyIncomingInvoiceFacadeOutput: type: object required: – ticket properties: ticket: type: string description: Id do processo assíncrono 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