2.0info: 1.2.0 Agro Invoice description: Micro Serviço Agro Invoice x-senior-domain: agro x-senior-domain-path: agro x-senior-service-path: invoice contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /agro/invoicesecurityDefinitions: 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: /invoiceCancel: post: description: Endpoint genérico de cancelamento de notas fiscais x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – eventControlItemId – invoiceCancelRecordIn properties: eventControlItemId: type: string description: Código do item no evento invoiceCancelRecordIn: type: array items: #/definitions/invoiceCancelRecordIn description: Registro de entrada de cancelamento de nota fiscal responses: 200: description: Ok schema: type: object required: – eventControlItemId – status – invoiceCancelRecordOut properties: eventControlItemId: type: string description: Id do item no evento status: #/definitions/statusIntegration message: type: string description: Mensagem de retorno invoiceCancelRecordOut: #/definitions/invoiceCancelRecordOut default: description: Error response schema: #/definitions/genericError /invoiceClose: post: description: Endpoint para solicitação de fechamento de nota fiscal x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – invoiceCloseRecord properties: invoiceCloseRecord: type: array items: #/definitions/invoiceCloseRecord description: Notas fiscais para fechamento responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /invoiceCreate: post: description: Endpoint genérico para criação de notas fiscais x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – eventControlItemId – invoiceCreateRecordIn properties: eventControlItemId: type: string description: Código do item no evento invoiceCreateRecordIn: type: array items: #/definitions/invoiceCreateRecordIn description: Registro de entrada de criação de nota fiscal responses: 200: description: Ok schema: type: object required: – eventControlItemId – status – invoiceCreateRecordOut properties: eventControlItemId: type: string description: Id do item no evento status: #/definitions/statusIntegration message: type: string description: Mensagem de retorno invoiceCreateRecordOut: #/definitions/invoiceCreateRecordOut default: description: Error response schema: #/definitions/genericError /linkUnlinkQuantity: post: description: Endpoint para adicionar vínculo de item de nota fiscal x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – itemId – quantity – operation properties: itemId: type: string description: Id do item a vincular quantity: type: string description: Quantidade a vincular operation: #/definitions/linkUnlinkOperation responses: 200: description: Ok default: description: Error response schema: #/definitions/genericErrordefinitions: linkUnlinkOperation: type: string enum: – LINK – UNLINK statusIntegration: type: string enum: – SUCCESS – IN_PROGRESS – ERROR invoiceType: type: string enum: – INCOMING – OUTGOING – RETURN – COMPLEMENT – SYMBOLIC_RETURN – ADJUSTMENT – SERVICE recordStatus: type: string enum: – OPEN – CLOSED operation: type: string enum: – INCLUSION – EXCLUSION – UPDATE invoiceStatus: type: string enum: – CLOSED – CANCELED – IN_TYPING – AUTHORIZED – REJECTED – IN_CANCELLATION – ERROR_ON_CREATING – ERROR_ON_CANCELING – ERROR_ON_REPROCESSING statusEntity: type: string enum: – VA – VI taxType: type: string enum: – FUNRURAL_INSS – FUNRURAL_RAT – FUNRURAL_SENAR invoiceCreateRecordIn: type: object required: – companyId – branchId – producerId – ruralEstateId – transactionId – invoiceType – recordStatus – items properties: invoiceId: type: string description: Id da nota fiscal companyId: type: string description: Empresa branchId: type: string description: Filial producerId: type: string description: Fornecedor ruralEstateId: type: string description: Imóvel Rural number: type: integer description: Número da nota fiscal series: type: string description: Código de cadastro da série seriesId: type: string description: Id de cadastro da série seriesLegal: type: string description: Série legal utilizada na SEFAZ key: type: string description: Chave da nota fiscal issuanceDate: type: string description: Data de emissão format: date-time transactionId: type: string description: Transação invoiceType: #/definitions/invoiceType recordStatus: #/definitions/recordStatus operation: #/definitions/operation transactionalId: type: string description: Id transacional para controle de terceiro eventControlItemId: type: string description: Id do evento generatesPrescription: type: boolean description: Gera receituário items: type: array items: #/definitions/invoiceItemRecord description: Items da nota fiscal referencedInvoiceRecord: type: array items: #/definitions/referencedInvoiceRecord description: Nota referenciada invoiceItemRecord: type: object required: – itemSequence – unitPrice – quantity properties: itemSequence: type: integer description: Sequência do item na nota fiscal productId: type: string description: Produto serviceId: type: string description: Serviço unitPrice: type: string description: Preço unitário quantity: type: number description: Quantidade do produto format: double warehouseId: type: string description: Depósito transactionId: type: string description: Transação do produto taxes: type: array items: #/definitions/invoiceItemTax description: Impostos discounts: type: string description: Descontos grossTotalValue: type: string description: Valor total bruto netTotalValue: type: string description: Valor total líquido invoiceItemTax: type: object required: – taxType properties: id: type: string description: format: uuid invoiceItem: #/definitions/invoiceItem taxType: #/definitions/taxType baseValue: type: string description: Valor da base de cálculo percentage: type: number description: Percentual do imposto format: double value: type: string description: Valor do imposto createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time invoiceItem: type: object required: – itemSequence – unitPrice – quantity properties: id: type: string description: format: uuid invoice: #/definitions/invoice itemSequence: type: integer description: Sequencia do item productId: #/definitions/e075der serviceItem: #/definitions/e080ser unitPrice: type: string description: Preço unitário quantity: type: number description: Quantidade format: double linkedQuantity: type: number description: Quantidade vinculada format: double fullyLinked: type: boolean description: Totalmente vinculado warehouseId: type: string description: format: uuid transactionId: type: string description: format: uuid contractExternalInvoice: type: string description: Id do contract_external_invoice invoiceItemTax: type: array items: #/definitions/invoiceItemTax description: Impostos discounts: type: string description: Descontos grossTotalValue: type: string description: Valor total bruto netTotalValue: type: string description: Valor total líquido createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time invoice: type: object required: – companyId – branchId – transactionId – invoiceType – recordStatus – invoiceStatus properties: id: type: string description: format: uuid companyId: #/definitions/e070emp branchId: #/definitions/e070fil producerId: type: string description: format: uuid ruralEstateId: type: string description: format: uuid number: type: integer description: Número series: type: string description: Código de cadastro da série seriesId: type: string description: Id de cadastro da série seriesLegal: type: string description: Série legal utilizada na SEFAZ issuanceDate: type: string description: Data de emissão format: date-time transactionId: type: string description: format: uuid invoiceType: #/definitions/invoiceType recordStatus: #/definitions/recordStatus invoiceStatus: #/definitions/invoiceStatus operation: #/definitions/operation transactionalId: type: string description: Id transacional key: type: string description: Chave eletrônica errorMessage: type: string description: Mensagem de erro payloadReceived: type: string description: Payload recebido eventControlItemId: type: string description: Id do item de evento externalId: type: string description: Id externo invoiceItems: type: array items: #/definitions/invoiceItem description: Itens da nota fiscal referencedInvoice: type: array items: #/definitions/referencedInvoice description: Notas fiscais referenciadas generatesPrescription: type: boolean description: Emite receituário createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time e070emp: type: object required: – codEmp – nomEmp – sigEmp properties: id: type: string description: format: uuid codEmp: type: integer description: Código da empresa nomEmp: type: string description: Nome da empresa sigEmp: type: string description: Nome fantasia / Sigla da empresa createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time e070fil: type: object required: – e070emp – codFil – nomFil – sigFil properties: id: type: string description: format: uuid e070emp: #/definitions/e070emp codFil: type: integer description: Código da filial nomFil: type: string description: Nome da filial sigFil: type: string description: Nome fantasia da filial numCgc: type: string description: CNPJ cidFil: type: string description: Cidade numFon: type: string description: Numero Telefone createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time referencedInvoice: type: object properties: id: type: string description: format: uuid invoiceOrigin: type: string description: format: uuid invoice: #/definitions/invoice itemSequence: type: integer description: Sequencia do item number: type: integer description: Número da nota fiscal series: type: string description: Série da nota fiscal key: type: string description: Chave da nota fiscal createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time e075der: type: object required: – e070emp – e012fam – codDer – desDer – sitDer properties: id: type: string description: format: uuid e070emp: #/definitions/e070emp e012fam: #/definitions/e012fam codDer: type: string description: Código da derivação desDer: type: string description: Descrição da derivação sitDer: #/definitions/statusEntity extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time e012fam: type: object required: – e070emp – codFam – desFam – sitFam properties: id: type: string description: format: uuid e070emp: #/definitions/e070emp codFam: type: string description: Código desFam: type: string description: Descrição sitFam: #/definitions/statusEntity extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time e080ser: type: object required: – e070emp – e012fam – codSer – desSer – sitSer properties: id: type: string description: format: uuid e070emp: #/definitions/e070emp e012fam: #/definitions/e012fam codSer: type: string description: Código do serviço desSer: type: string description: Descrição do serviço sitSer: #/definitions/statusEntity extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time referencedInvoiceRecord: type: object required: – itemSequence properties: id: type: string description: Id invoiceOriginId: type: string description: Id da nota fiscal referenciada itemSequence: type: integer description: Sequência do item na nota fiscal number: type: integer description: Número da nota fiscal series: type: string description: Série da nota fiscal key: type: string description: Chave da nota fiscal invoiceCreateRecordOut: type: object required: – invoiceId – invoiceStatus – status properties: eventControlItemId: type: string description: Código do item no evento invoiceId: type: string description: Id da nota fiscal no micro serviço Invoice number: type: integer description: Número da nota fiscal key: type: string description: Chave da nota fiscal transactionalId: type: string description: Id transacional invoiceStatus: #/definitions/invoiceStatus status: #/definitions/statusIntegration message: type: string description: Mensagem de retorno invoiceCancelRecordIn: type: object required: – invoiceId – branchId – reason properties: eventControlItemId: type: string description: Código do item no evento invoiceId: type: string description: Id da nota fiscal branchId: type: string description: Filial reason: type: string description: Motivo da solicitação do cancelamento transactionalId: type: string description: Id transacional invoiceCancelRecordOut: type: object required: – invoiceId – invoiceStatus – status properties: invoiceId: type: string description: Id da nota fiscal no micro serviço Invoice number: type: integer description: Número da nota fiscal key: type: string description: Chave da nota fiscal transactionalId: type: string description: Id transacional invoiceStatus: #/definitions/invoiceStatus status: #/definitions/statusIntegration message: type: string description: Mensagem de retorno invoiceCloseRecord: type: object required: – branchId – invoices properties: branchId: type: string description: Filial invoices: type: array items: type: string description: Ids das nota fiscais 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