Agro Invoice (invoice)

2.0info: 1.3.2 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: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/agrosecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /invoice/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: 401: description: Invalid Credentials 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 description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportE070fil: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportInvoice: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportInvoiceItem: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportInvoiceItemTax: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportE070filAgrDef: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportE032edc: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportE075der: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportE080ser: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportE012fam: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportE001pes: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportE095pes: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportE031smo: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportE031moe: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportE006pai: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportE007ufs: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportE008rai: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportReferencedInvoice: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/exportRuralEstate: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE 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 401: description: Invalid Credentials 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: PRIVATE 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/reprocessIncomingInvoice: post: description: Reprocessamento de notas fiscais de entrada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – transactionalId – eventControlItemId properties: transactionalId: type: string description: Id transacional da operação eventControlItemId: type: string description: Id do evento de controle responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/invoiceCreate: post: description: Endpoint genérico para criação de notas fiscais tags: – Actions x-senior-visibility: PUBLIC parameters: – 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: type: object allOf: – #/definitions/invoiceCreateRecordIn minimum: 1 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: type: string allOf: – #/definitions/statusIntegration description: Status da integração message: type: string description: Mensagem de retorno invoiceCreateRecordOut: type: array items: type: object allOf: – #/definitions/invoiceCreateRecordOut minimum: 1 description: Registro de saída de criação de nota fiscal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/invoiceCancel: post: description: Endpoint genérico de cancelamento de notas fiscais tags: – Actions x-senior-visibility: PUBLIC parameters: – 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: type: object allOf: – #/definitions/invoiceCancelRecordIn minimum: 1 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: type: string allOf: – #/definitions/statusIntegration description: Status da integração message: type: string description: Mensagem de retorno invoiceCancelRecordOut: type: array items: type: object allOf: – #/definitions/invoiceCancelRecordOut minimum: 1 description: Registros de saída de cancelamento de nota fiscal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/linkUnlinkQuantity: post: description: Endpoint para adicionar vínculo de item de nota fiscal tags: – Actions x-senior-visibility: PUBLIC parameters: – 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: type: string allOf: – #/definitions/linkUnlinkOperation description: Tipo de operação responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/invoiceClose: post: description: Endpoint para solicitação de fechamento de nota fiscal tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – eventControlItemId – invoiceCloseRecord properties: eventControlItemId: type: string description: Código do item no evento invoiceCloseRecord: type: array items: type: object allOf: – #/definitions/invoiceCloseRecord minimum: 1 description: Notas fiscais para fechamento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/invoiceReopening: post: description: Endpoint para solicitação de reabertura de nota fiscal tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – eventControlItemId – invoiceReopeningRecord properties: eventControlItemId: type: string description: Código do item no evento invoiceReopeningRecord: type: array items: type: object allOf: – #/definitions/invoiceReopeningRecord minimum: 1 description: Notas fiscais para reabertura responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importE070fil: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importInvoice: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importInvoiceItem: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importInvoiceItemTax: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importE070filAgrDef: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importE032edc: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importE075der: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importE080ser: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importE012fam: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importE001pes: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importE095pes: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importE031smo: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importE031moe: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importE006pai: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importE007ufs: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importE008rai: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importReferencedInvoice: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/actions/importRuralEstate: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/events/invoiceEvents: post: description: Evento de nota fiscal x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/invoiceEventsDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/invoiceUpdate: post: description: Evento genérico de atualização de nota fiscal x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/invoiceUpdatePayload responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importInvoiceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportInvoiceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importInvoiceItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportInvoiceItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importInvoiceItemTaxEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportInvoiceItemTaxEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importE070filAgrDefEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportE070filAgrDefEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importE032edcEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportE032edcEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importE075derEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportE075derEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importE080serEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportE080serEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importE012famEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportE012famEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importE001pesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportE001pesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importE095pesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportE095pesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importE031smoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportE031smoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importE031moeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportE031moeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importE006paiEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportE006paiEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importE007ufsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportE007ufsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importE008raiEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportE008raiEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importReferencedInvoiceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportReferencedInvoiceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/importRuralEstateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/events/exportRuralEstateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /invoice/entities/e070emp: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e070emp/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e070fil: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e070fil/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/invoice: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/invoice responses: 200: description: The created resource schema: #/definitions/invoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/invoice responses: 200: description: The created resource schema: #/definitions/invoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/invoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/invoice/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editInvoice responses: 200: description: Ok schema: #/definitions/editInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/invoice responses: 200: description: Ok schema: #/definitions/invoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/invoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/invoice/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/invoice responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/invoiceItem: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/invoiceItem responses: 200: description: The created resource schema: #/definitions/invoiceItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/invoiceItem responses: 200: description: The created resource schema: #/definitions/invoiceItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/invoiceItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/invoiceItem/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editInvoiceItem responses: 200: description: Ok schema: #/definitions/editInvoiceItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/invoiceItem responses: 200: description: Ok schema: #/definitions/invoiceItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/invoiceItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/invoice/{parentId}/invoiceItems: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/invoiceItem responses: 200: description: The created resources schema: type: array items: #/definitions/invoiceItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/invoiceItem responses: 200: description: The created resources schema: type: array items: #/definitions/invoiceItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/invoiceItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/invoice/{parentId}/invoiceItems/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editInvoiceItem responses: 200: description: Ok schema: #/definitions/editInvoiceItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/invoiceItem responses: 200: description: Ok schema: #/definitions/invoiceItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/invoiceItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/invoiceItem/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/invoiceItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/invoiceItemTax: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/invoiceItemTax responses: 200: description: The created resource schema: #/definitions/invoiceItemTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/invoiceItemTax responses: 200: description: The created resource schema: #/definitions/invoiceItemTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/invoiceItemTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/invoiceItemTax/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editInvoiceItemTax responses: 200: description: Ok schema: #/definitions/editInvoiceItemTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/invoiceItemTax responses: 200: description: Ok schema: #/definitions/invoiceItemTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/invoiceItemTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/invoiceItem/{parentId}/invoiceItemTax: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/invoiceItemTax responses: 200: description: The created resources schema: type: array items: #/definitions/invoiceItemTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/invoiceItemTax responses: 200: description: The created resources schema: type: array items: #/definitions/invoiceItemTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/invoiceItemTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/invoiceItem/{parentId}/invoiceItemTax/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editInvoiceItemTax responses: 200: description: Ok schema: #/definitions/editInvoiceItemTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/invoiceItemTax responses: 200: description: Ok schema: #/definitions/invoiceItemTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/invoiceItemTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/invoiceItemTax/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/invoiceItemTax responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e070filAgrDef: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e070filAgrDef responses: 200: description: The created resource schema: #/definitions/e070filAgrDef 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e070filAgrDef responses: 200: description: The created resource schema: #/definitions/e070filAgrDef 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070filAgrDef 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e070filAgrDef/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editE070filAgrDef responses: 200: description: Ok schema: #/definitions/editE070filAgrDef 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e070filAgrDef responses: 200: description: Ok schema: #/definitions/e070filAgrDef 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070filAgrDef 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e070filAgrDef/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e070filAgrDef responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e032edc: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e032edc 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e032edc/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e032edc 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e075der: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e075der 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e075der/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e075der 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e080ser: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e080ser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e080ser/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e080ser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e012fam: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e012fam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e012fam/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e012fam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e001pes: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e001pes/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e095pes: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e095pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e095pes/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e095pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e031smo: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e031smo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e031smo/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e031smo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e031moe: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e031moe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e031moe/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e031moe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e006pai: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e006pai/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e007ufs: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e007ufs/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e008rai: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/e008rai/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/referencedInvoice: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/referencedInvoice responses: 200: description: The created resource schema: #/definitions/referencedInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/referencedInvoice responses: 200: description: The created resource schema: #/definitions/referencedInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/referencedInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/referencedInvoice/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editReferencedInvoice responses: 200: description: Ok schema: #/definitions/editReferencedInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/referencedInvoice responses: 200: description: Ok schema: #/definitions/referencedInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/referencedInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/invoice/{parentId}/referencedInvoice: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/referencedInvoice responses: 200: description: The created resources schema: type: array items: #/definitions/referencedInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/referencedInvoice responses: 200: description: The created resources schema: type: array items: #/definitions/referencedInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/referencedInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/invoice/{parentId}/referencedInvoice/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editReferencedInvoice responses: 200: description: Ok schema: #/definitions/editReferencedInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/referencedInvoice responses: 200: description: Ok schema: #/definitions/referencedInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/referencedInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/referencedInvoice/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/referencedInvoice responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/ruralEstate: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/ruralEstate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /invoice/entities/ruralEstate/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/ruralEstate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: linkUnlinkOperation: type: string enum: – LINK – UNLINK description: Operação de vínculo ou desvínculo: * `LINK` – Vincular * `UNLINK` – Desvincular statusEntity: type: string enum: – VA – VI description: Status da Entidade: * `VA` – Ativo * `VI` – Inativo statusIntegration: type: string enum: – SUCCESS – IN_PROGRESS – ERROR description: Status da Integração: * `SUCCESS` – Sucesso * `IN_PROGRESS` – Progresso * `ERROR` – Erro enumTipMoe: type: string enum: – VV – VD – VP – VE – VH description: Tipo da moeda: * `VV` – Valor * `VD` – Índice * `VP` – Percentual * `VE` – Especial * `VH` – Hora enumTipCot: type: string enum: – VD – VM description: Tipo de cotação: * `VD` – Diária * `VM` – Mensal taxType: type: string enum: – FUNRURAL_INSS – FUNRURAL_RAT – FUNRURAL_SENAR description: Tipo de imposto: * `FUNRURAL_INSS` – FUNRURAL INSS * `FUNRURAL_RAT` – FUNRURAL RAT * `FUNRURAL_SENAR` – FUNRURAL SENAR enumJurFis: type: string enum: – VJ – VF description: Tipo da pessoa: * `VJ` – Pessoa Jurídica * `VF` – Pessoa Física logType: type: string enum: – INFO – WARNING – ERROR description: Tipo do log: * `INFO` – Informação * `WARNING` – Aviso * `ERROR` – Erro upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumCifFob: type: string enum: – V0 – V1 – V2 – V3 – V4 – V9 description: Tipo de frete: * `V0` – Contratação do frete por conta do remetente (CIF) * `V1` – Contratação do frete por conta do destinatário (FOB) * `V2` – Contratação do frete por conta de terceiros * `V3` – Transporte próprio por conta do remetente * `V4` – Transporte próprio por conta do destinatário * `V9` – Sem ocorrência de transporte freightTypeIncomingErpx: type: string enum: – V0 – V1 – V2 – V3 – V4 – V9 description: Tipo de frete: * `V0` – Contratação do frete por conta do remetente (CIF) * `V1` – Contratação do frete por conta do destinatário (FOB) * `V2` – Contratação do frete por conta de terceiros * `V3` – Transporte próprio por conta do remetente * `V4` – Transporte próprio por conta do destinatário * `V9` – Sem ocorrência de transporte invoiceTypeIncomingErpx: type: string enum: – V1 – V2 – V4 – V6 – V8 – V9 – V10 – V12 description: Tipo de nota fiscal para notas fiscais de entrada: * `V1` – Nota de entrada * `V2` – Devolução * `V4` – Retorno de terceiros/serviços agregados * `V6` – NF Produtor – Contranota * `V8` – Frete * `V9` – Nota complementar * `V10` – Nota de ajuste * `V12` – Estorno emissionType: type: string enum: – EmissaoTerceiro – EmissaoPropria description: Tipo de emissão de nota fiscal para notas fiscais de entrada ERPX: * `EmissaoTerceiro` – Emissão de terceiro * `EmissaoPropria` – Emissão própria invoiceStatus: type: string enum: – CLOSED – CANCELED – IN_TYPING – AUTHORIZED – REJECTED – IN_CANCELLATION – ERROR_ON_CREATING – ERROR_ON_CANCELING – ERROR_ON_REPROCESSING description: Status da nota fiscal: * `CLOSED` – Fechada * `CANCELED` – Cancelada * `IN_TYPING` – Em digitação * `AUTHORIZED` – Autorizada * `REJECTED` – Rejeitada * `IN_CANCELLATION` – Em cancelamento * `ERROR_ON_CREATING` – Erro ao criar nota fiscal * `ERROR_ON_CANCELING` – Erro ao cancelar nota fiscal * `ERROR_ON_REPROCESSING` – Erro ao reprocessar nota fiscal invoiceType: type: string enum: – INCOMING – OUTGOING – RETURN – COMPLEMENT – SYMBOLIC_RETURN – ADJUSTMENT – SERVICE description: Tipo da nota fiscal: * `INCOMING` – Entrada * `OUTGOING` – Saída * `RETURN` – Devolução * `COMPLEMENT` – Complemento * `SYMBOLIC_RETURN` – Devolução de Simbólica * `ADJUSTMENT` – Nota de Acerto * `SERVICE` – Serviço operation: type: string enum: – INCLUSION – EXCLUSION – UPDATE description: Tipo de operação da nota fiscal: * `INCLUSION` – Inclusão de nota fiscal * `EXCLUSION` – Exclusão de nota fiscal * `UPDATE` – Atualização de nota fiscal recordStatus: type: string enum: – OPEN – CLOSED description: Indicativo do status da nota fiscal: * `OPEN` – Aberta * `CLOSED` – Fechada invoiceIssuerType: type: string enum: – NATIVE – EXTERNAL – MOCK – MOCK_ERROR description: Tipo de emissor de nota fiscal: * `NATIVE` – ERP X * `EXTERNAL` – ERP externo * `MOCK` – MOCK * `MOCK_ERROR` – MOCK ERROR userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck invoiceCreateRecordIn: description: Registro de entrada de criação de nota fiscal 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 format: int64 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 format: date-time description: Data de emissão transactionId: type: string description: Transação invoiceType: type: string allOf: – #/definitions/invoiceType description: Tipo da nota fiscal recordStatus: type: string allOf: – #/definitions/recordStatus description: Status da nota fiscal operation: type: string allOf: – #/definitions/operation description: Tipo de operação transactionalId: type: string description: Id transacional para controle de terceiro eventControlItemId: type: string description: Id do evento generatesPrescription: type: boolean description: Gera receituário default: false items: type: array items: type: object allOf: – #/definitions/invoiceItemRecord minimum: 1 description: Items da nota fiscal referencedInvoiceRecord: type: array items: type: object allOf: – #/definitions/referencedInvoiceRecord description: Nota referenciada invoiceItemRecord: description: Registro dos itens da consulta de notas fiscais type: object required: – itemSequence – unitPrice – quantity properties: itemSequence: type: integer format: int64 description: Sequência do item na nota fiscal minimum: 1 productId: type: string description: Produto serviceId: type: string description: Serviço unitPrice: type: string description: Preço unitário quantity: type: number format: double description: Quantidade do produto warehouseId: type: string description: Depósito transactionId: type: string description: Transação do produto taxes: type: array items: type: object allOf: – #/definitions/invoiceItemTax description: Impostos discounts: type: string description: Descontos default: 0.00 grossTotalValue: type: string description: Valor total bruto default: 0.00 netTotalValue: type: string description: Valor total líquido default: 0.00 referencedInvoiceRecord: description: Informações da nota fiscal referenciada type: object required: – itemSequence properties: id: type: string description: Id invoiceOriginId: type: string description: Id da nota fiscal referenciada itemSequence: type: integer format: int64 description: Sequência do item na nota fiscal minimum: 1 number: type: integer format: int64 description: Número da nota fiscal series: type: string description: Série da nota fiscal key: type: string description: Chave da nota fiscal invoiceCreateRecordOut: description: Registro de saída de criação de nota fiscal 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 format: int64 description: Número da nota fiscal key: type: string description: Chave da nota fiscal transactionalId: type: string description: Id transacional invoiceStatus: type: string allOf: – #/definitions/invoiceStatus description: Status da nota fiscal status: type: string allOf: – #/definitions/statusIntegration description: Status da integração message: type: string description: Mensagem de retorno invoiceCancelRecordIn: description: Registro de entrada de cancelamento de nota fiscal 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: description: Registro de saída de criação de nota fiscal type: object required: – invoiceId – invoiceStatus – status properties: invoiceId: type: string description: Id da nota fiscal no micro serviço Invoice number: type: integer format: int64 description: Número da nota fiscal key: type: string description: Chave da nota fiscal transactionalId: type: string description: Id transacional invoiceStatus: type: string allOf: – #/definitions/invoiceStatus description: Status da nota fiscal status: type: string allOf: – #/definitions/statusIntegration description: Status da integração message: type: string description: Mensagem de retorno invoiceCloseRecord: description: Registro de fechamento de nota fiscal type: object required: – branchId – invoiceIds properties: eventControlItemId: type: string description: Código do item no evento branchId: type: string description: Filial invoiceIds: type: array items: type: string minimum: 1 description: Ids das nota fiscais invoiceReopeningRecord: description: Registro de reabertura de nota fiscal type: object required: – branchId – invoiceIds properties: eventControlItemId: type: string description: Código do item no evento branchId: type: string description: Filial invoiceIds: type: array items: type: string minimum: 1 description: Ids das nota fiscais invoiceCreateDataResponse: description: Registro de resposta da criação de nota fiscal – Integration – Envio type: object required: – eventControlItemId – status – invoiceCreateRecordOut properties: eventControlItemId: type: string description: Id do item no evento status: type: string allOf: – #/definitions/statusIntegration description: Status da integração message: type: string description: Mensagem de retorno invoiceCreateRecordOut: type: array items: type: object allOf: – #/definitions/invoiceCreateResponse minimum: 1 description: Lista dos dados do conteúdo do registro invoiceCreateResponse: description: Dados do conteúdo de resposta da criação de nota fiscal – Integration – Retorno type: object required: – eventControlItemId – invoiceId – invoiceStatus – status properties: eventControlItemId: type: string description: Id do item no evento invoiceId: type: string description: Id da nota fiscal number: type: integer format: int64 description: Número da nota fiscal key: type: string description: Chave da nota fiscal transactionalId: type: string description: Id transacional da operação invoiceStatus: type: string allOf: – #/definitions/invoiceStatus description: Status da nota fiscal status: type: string allOf: – #/definitions/statusIntegration description: Status da integração message: type: string description: Mensagem de retorno invoiceCancelDataResponse: description: Registro de resposta da criação de nota fiscal type: object required: – eventControlItemId – status – invoiceCancelRecordOut properties: eventControlItemId: type: string description: Id do item no evento status: type: string allOf: – #/definitions/statusIntegration description: Status da integração message: type: string description: Mensagem de retorno invoiceCancelRecordOut: type: array items: type: object allOf: – #/definitions/invoiceCancelRecordOut minimum: 1 description: Lista dos dados do conteúdo do registro transport: description: Transporte type: object required: – freightType properties: freightType: type: string allOf: – #/definitions/freightTypeIncomingErpx description: Tipo de frete referencedInvoiceLegacy: description: Notas fiscais referenciadas type: object required: – supplierId – number – series – supplierStateId – issuanceDate – stateRegistration – documentModel properties: supplierId: type: string description: Id do fornecedor number: type: string description: Número da nota fiscal series: type: string description: Série da nota fiscal supplierStateId: type: string description: Id do estado do fornecedor issuanceDate: type: string format: date-time description: Data de emissão stateRegistration: type: string description: Inscrição estadual documentModel: type: string description: Modelo de documento generalData: description: Dados gerais da nota fiscal type: object required: – companyId – branchId – emissionType – invoiceType – recipientId – series – productTransactionId – transactionalId properties: companyId: type: string description: Id da empresa branchId: type: string description: Id da filial emissionType: type: string allOf: – #/definitions/emissionType description: Tipo de emissão invoiceType: type: string allOf: – #/definitions/invoiceTypeIncomingErpx description: Tipo de nota fiscal para nota de entrada recipientId: type: string description: Id do destinatário series: type: string description: Id da série padrão para notas de emissão própria productTransactionId: type: string description: Id da transação do produto transactionalId: type: string description: Id transacional da operação invoiceEventsDTO: description: Record de dados de evento de nota fiscal type: object properties: number: type: string description: Número da nota fiscal seriesCode: type: string description: Código da série da nota fiscal key: type: string description: Chave da nota fiscal status: type: string allOf: – #/definitions/invoiceStatus description: Status da nota fiscal transactionalId: type: string description: Id transacional invoiceErpxId: type: string description: Id da nota fiscal no ERPX invoiceUpdatePayload: description: Payload de atualização de nota fiscal type: object required: – invoiceId – status – issuanceDate properties: invoiceId: type: string description: Id da nota fiscal transactionalId: type: string description: Id transacional number: type: integer format: int64 description: Número da nota fiscal series: type: string description: Série da nota fiscal key: type: string description: Chave da nota fiscal status: type: string allOf: – #/definitions/invoiceStatus description: Status da nota fiscal issuanceDate: type: string format: date-time description: Data da emissão cancellationDate: type: string format: date-time description: Data de cancelamento sefazMessage: type: string description: Mensagem da SEFAZ getDefinitionProviderSupGerInput: description: Payload para consulta de definição do fornecedor de comercial type: object properties: e095pesId: type: string description: Identificador do fornecedor e070filId: type: string description: Identificador da filial getDefinitionProviderSupGerOutput: description: Retorna a definição do fornecedor de comercial type: object properties: e095hfoSupGer: type: object allOf: – #/definitions/e095hfo_sup_ger description: Definição do fornecedor de comercial e095hfo_sup_ger: description: Cadastros – Fornecedores – Históricos type: object properties: id: type: string description: Id da entidade e028cpg: type: object allOf: – #/definitions/e028cpg description: Condição de pagamento cifFob: type: string allOf: – #/definitions/enumCifFob description: Tipo de frete e028cpg: description: Condição de pagamento – Foundation type: object properties: id: type: string description: Id da entidade e075derSupEstInput: description: Produtos – Estoque type: object properties: id: type: string description: Id da entidade displayFields: type: array items: type: string description: Campos a serem exibidos e075derSupEst: description: Produtos – Estoque type: object properties: e015med: type: object allOf: – #/definitions/e015med description: Unidade de medida (estoque) e015med: description: Unidade de medida (estoque) type: object properties: id: type: string description: ID da unidade de medida setSuccessStatusInput: description: Record de controle de eventos indicando que o evento foi processado com sucesso type: object properties: eventControlItemId: type: string description: id da item de controle de evento setFailedStatusInput: description: Record de controle de eventos indicando que o evento falhou type: object properties: eventControlItemId: type: string description: id da item de controle de evento message: type: string description: Mensagem de erro setProcessingStatusInput: description: Record de controle de eventos indicando que o evento está sendo processado type: object properties: eventControlItemId: type: string description: id da item de controle de evento listE070filSupRcbPayload: description: Record referente ao envio de dados na integração erpx_sup_rcb/nota_fiscal/listE070filSupRcb type: object properties: id: type: string description: Id displayFields: type: array items: type: string description: Campos listE070filSupRcb: description: Record E070filSupRcb type: object properties: contents: type: array items: type: object allOf: – #/definitions/e070filSupRcb description: Lista de e020snfEmisProp e070filSupRcb: description: Record e070filSupRcb type: object properties: id: type: string description: Id e020snfEmisProp: type: object allOf: – #/definitions/e020snf description: e020snfEmisProp e020snf: description: Record e020snf type: object properties: id: type: string description: Id e070emp: description: Empresa type: object required: – codEmp – nomEmp – sigEmp properties: id: type: string format: uuid description: Id codEmp: type: integer format: int64 description: Código da empresa nomEmp: type: string maxLength: 100 description: Nome da empresa sigEmp: type: string maxLength: 100 description: Nome fantasia / Sigla da empresa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e070fil: description: Filial type: object required: – e070emp – codFil – nomFil – sigFil properties: id: type: string format: uuid description: Id e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa codFil: type: integer format: int64 description: Código da filial nomFil: type: string maxLength: 100 description: Nome da filial sigFil: type: string maxLength: 100 description: Nome fantasia da filial numCgc: type: string maxLength: 18 description: CNPJ cidFil: type: string maxLength: 60 description: Cidade numFon: type: string maxLength: 20 description: Numero Telefone createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: invoice: description: Nota fiscal type: object required: – companyId – branchId – transactionId – invoiceType – recordStatus – invoiceStatus properties: id: type: string format: uuid description: Id companyId: type: object allOf: – #/definitions/e070emp description: Empresa branchId: type: object allOf: – #/definitions/e070fil description: Filial producerId: type: string format: uuid description: Fornecedor ruralEstateId: type: string format: uuid description: Imóvel Rural number: type: integer format: int64 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 format: date-time description: Data de emissão transactionId: type: string format: uuid description: Transação da nota fiscal invoiceType: type: string allOf: – #/definitions/invoiceType description: Tipo da nota fiscal recordStatus: type: string allOf: – #/definitions/recordStatus description: Status do registro invoiceStatus: type: string allOf: – #/definitions/invoiceStatus description: Status da nota fiscal operation: type: string allOf: – #/definitions/operation description: Tipo de operação transactionalId: type: string description: Id transacional key: type: string maxLength: 44 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: type: object allOf: – #/definitions/invoiceItem description: Itens da nota fiscal referencedInvoice: type: array items: type: object allOf: – #/definitions/referencedInvoice description: Notas fiscais referenciadas generatesPrescription: type: boolean description: Emite receituário default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editInvoice: type: object required: – id allOf: – #/definitions/invoice invoiceItem: description: Itens de nota fiscal type: object required: – itemSequence – unitPrice – quantity properties: id: type: string format: uuid description: Id invoice: type: object allOf: – #/definitions/invoice description: Id da nota fiscal itemSequence: type: integer format: int64 description: Sequencia do item minimum: 1 productId: type: object allOf: – #/definitions/e075der description: Id do produto serviceItem: type: object allOf: – #/definitions/e080ser description: Id do serviço unitPrice: type: string description: Preço unitário quantity: type: number format: double description: Quantidade linkedQuantity: type: number format: double description: Quantidade vinculada default: 0.000 fullyLinked: type: boolean description: Totalmente vinculado default: false warehouseId: type: string format: uuid description: Depósito transactionId: type: string format: uuid description: Transação do produto contractExternalInvoice: type: string maxLength: 50 description: Id do contract_external_invoice invoiceItemTax: type: array items: type: object allOf: – #/definitions/invoiceItemTax description: Impostos discounts: type: string description: Descontos default: 0.00 grossTotalValue: type: string description: Valor total bruto default: 0.00 netTotalValue: type: string description: Valor total líquido default: 0.00 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editInvoiceItem: type: object required: – id allOf: – #/definitions/invoiceItem invoiceItemTax: description: Impostos dos itens de nota fiscal type: object required: – taxType properties: id: type: string format: uuid description: Id invoiceItem: type: object allOf: – #/definitions/invoiceItem description: Id do item de nota fiscal taxType: type: string allOf: – #/definitions/taxType description: Tipo de imposto baseValue: type: string description: Valor da base de cálculo minimum: 0.00 maximum: 9999999999999.99 default: 0.00 percentage: type: number format: double description: Percentual do imposto minimum: 0.00 maximum: 100.00 default: 0.00 value: type: string description: Valor do imposto minimum: 0.00 maximum: 9999999999999.99 default: 0.00 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editInvoiceItemTax: type: object required: – id allOf: – #/definitions/invoiceItemTax e070filAgrDef: description: Definições da filial para emissão de nota fiscal type: object required: – branch – invoiceIssuerType properties: id: type: string format: uuid description: Id branch: type: object allOf: – #/definitions/e070fil description: Filial invoiceIssuerType: type: string allOf: – #/definitions/invoiceIssuerType description: Tipo emissor de nota fiscal createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editE070filAgrDef: type: object required: – id allOf: – #/definitions/e070filAgrDef e032edc: description: Modelo de documento fiscal type: object required: – codEdc – desEdc – abrEdc properties: id: type: string format: uuid description: Id da entidade codEdc: type: string maxLength: 3 description: Código desEdc: type: string maxLength: 30 description: Descrição abrEdc: type: string maxLength: 5 description: Abreviatura indCgc: type: boolean description: Exige CNPJ/CPF default: false excluido: type: boolean description: Indica se o registro foi excluído default: false 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 format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e075der: description: Produto type: object required: – e070emp – e012fam – codDer – desDer – sitDer properties: id: type: string format: uuid description: Id e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa e012fam: type: object allOf: – #/definitions/e012fam description: Código da família codDer: type: string maxLength: 23 description: Código da derivação desDer: type: string maxLength: 120 description: Descrição da derivação sitDer: type: string allOf: – #/definitions/statusEntity description: Situação da derivação 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 format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e080ser: description: Serviço type: object required: – e070emp – e012fam – codSer – desSer – sitSer properties: id: type: string format: uuid description: Id e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa e012fam: type: object allOf: – #/definitions/e012fam description: Código da família codSer: type: string maxLength: 23 description: Código do serviço desSer: type: string maxLength: 120 description: Descrição do serviço sitSer: type: string allOf: – #/definitions/statusEntity description: Situação do serviço 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 format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e012fam: description: Família type: object required: – e070emp – codFam – desFam – sitFam properties: id: type: string format: uuid description: Id e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa codFam: type: string maxLength: 6 description: Código desFam: type: string maxLength: 50 description: Descrição sitFam: type: string allOf: – #/definitions/statusEntity description: Status 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 format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e001pes: description: Pessoa type: object required: – nomPes – sitPes properties: id: type: string format: uuid description: Id Pessoa e095pes: type: object allOf: – #/definitions/e095pes description: Produtor nomPes: type: string maxLength: 100 description: Nome cnpCpf: type: string maxLength: 18 description: CNPJ/CPF tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa sitPes: type: string allOf: – #/definitions/statusEntity description: Status 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 format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e095pes: description: Fornecedor type: object required: – sitFor properties: id: type: string format: uuid description: Id Pessoa e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa sitFor: type: string allOf: – #/definitions/statusEntity description: Status 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 format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e031smo: description: Série de cotação da moeda type: object required: – codSmo properties: id: type: string format: uuid description: Id codSmo: type: integer format: int64 description: Código minimum: 0 maximum: 9999999 desSmo: type: string maxLength: 250 description: Descrição excluido: type: boolean description: Indica se o registro foi excluído default: false 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 format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e031moe: description: Moedas type: object required: – codMoe – desMoe – sigMoe – tipMoe – tipCot properties: id: type: string format: uuid description: Id codMoe: type: string maxLength: 3 description: Código da moeda desMoe: type: string maxLength: 30 description: Descrição da moeda sigMoe: type: string maxLength: 5 description: Sigla da moeda tipMoe: type: string allOf: – #/definitions/enumTipMoe description: Tipo da moeda tipCot: type: string allOf: – #/definitions/enumTipCot description: Tipo de cotação diaBas: type: integer format: int64 description: Dia base de cotação minimum: 0 maximum: 31 qtdInt: type: integer format: int64 description: Quantidade de inteiros minimum: 0 maximum: 13 qtdDec: type: integer format: int64 description: Quantidade de decimais minimum: 1 maximum: 10 separadorMilhar: type: string maxLength: 1 description: Separador de Milhar separadorDecimal: type: string maxLength: 1 description: Separador de decimal codBac: type: integer format: int64 description: Código BACEN minimum: 0 maximum: 999 e031smoIdeSmo: type: object allOf: – #/definitions/e031smo description: Série de cotação da moeda excluido: type: boolean description: Indica se o registro foi excluído default: false 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 format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e006pai: description: Países type: object required: – codPai – nomPai – e031moe properties: id: type: string format: uuid description: Id da entidade codPai: type: string maxLength: 4 description: Código nomPai: type: string maxLength: 150 description: Nome e031moe: type: object allOf: – #/definitions/e031moe description: Id da moeda excluido: type: boolean description: Indica se o registro foi excluído default: false 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 format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e007ufs: description: Estados type: object required: – sigUfs – nomUfs – e006pai properties: id: type: string format: uuid description: Id da entidade sigUfs: type: string maxLength: 2 description: Sigla nomUfs: type: string maxLength: 20 description: Nome e006pai: type: object allOf: – #/definitions/e006pai description: País excluido: type: boolean description: Indica se o registro foi excluído default: false 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 format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e008rai: description: Cidades para RAIS – SIG type: object required: – codRai – nomCid – e007ufs properties: id: type: string format: uuid description: Id da entidade codRai: type: integer format: int64 description: Código Cidade minimum: 0 maximum: 9999999 nomCid: type: string maxLength: 60 description: Nome Cidade e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado codIbg: type: integer format: int64 description: Código IBGE do município minimum: 0 maximum: 9999999 excluido: type: boolean description: Indica se o registro foi excluído default: false 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 format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: referencedInvoice: description: Nota fiscal referenciada type: object properties: id: type: string format: uuid description: Id invoiceOrigin: type: string format: uuid description: Id da nota fiscal referenciada invoice: type: object allOf: – #/definitions/invoice description: Id da nota fiscal itemSequence: type: integer format: int64 description: Sequencia do item minimum: 1 number: type: integer format: int64 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 format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editReferencedInvoice: type: object required: – id allOf: – #/definitions/referencedInvoice ruralEstate: description: Imóvel Rural type: object required: – company – branch – name – cep – address – status properties: id: type: string format: uuid description: Id sequential: type: integer format: int64 description: Sequencial company: type: object allOf: – #/definitions/e070emp description: Empresa branch: type: object allOf: – #/definitions/e070fil description: Filial code: type: string maxLength: 13 description: Código do Imóvel Rural name: type: string description: Nome do Imóvel ie: type: string maxLength: 25 description: Inscrição Estadual cep: type: string maxLength: 8 description: CEP address: type: string description: Endereço number: type: integer format: int64 description: Número complement: type: string description: Complemento district: type: string description: Bairro country: type: object allOf: – #/definitions/e006pai description: País state: type: object allOf: – #/definitions/e007ufs description: Estado city: type: object allOf: – #/definitions/e008rai description: Cidade latitude: type: string description: Latitude longitude: type: string description: Longitude status: type: string allOf: – #/definitions/statusEntity description: Situação do Imóvel producers: type: array items: type: object allOf: – #/definitions/e001pes description: Lista de Produtores producersQuantity: type: integer format: int64 description: Quantidade de Produtores default: 0 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 format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification 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 blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: 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 checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage