• Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
  • Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
home/APIs Privadas/rcbx_ai/document
Mais pesquisados:Customização, Tutorial, Documentação

document

10 views 0 09/11/2026 integrador

2.0info: 1.3.0 document x-senior-domain: rcbx_ai x-senior-domain-path: rcbx_ai x-senior-service-path: document 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/rcbx_aisecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /document/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/queries/eligibleToExclude: post: description: Query para verificar se um registro de uma tabela e elegivel para exclusao tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro e elegivel para exclusao notEligibleMessage: type: string description: Mensagem quando o registro nao estiver elegivel para exclusao unkownEntity: type: boolean description: Indica se a entidade e desconhecida pelo servico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar se um registro de uma tabela e elegivel para exclusao tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: id description: Id do registro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro e elegivel para exclusao notEligibleMessage: type: string description: Mensagem quando o registro nao estiver elegivel para exclusao unkownEntity: type: boolean description: Indica se a entidade e desconhecida pelo servico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/queries/getWorkflowManualSteps: post: description: Retorna os steps manuais do workflow com habilitacao e ordem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – steps properties: steps: type: array items: type: object allOf: – #/definitions/workflowManualStepData minimum: 1 description: Steps manuais configurados, ordenados por stepOrder 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os steps manuais do workflow com habilitacao e ordem tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – steps properties: steps: type: array items: type: object allOf: – #/definitions/workflowManualStepData minimum: 1 description: Steps manuais configurados, ordenados por stepOrder 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/queries/getCandidateExceptionsToHandle: post: description: Returns candidate options for the active exception stage of a fiscal document. An item is pending when the agent declared PENDING_SELECTION or NOT_FOUND for the dimension and no candidate is selected (items with a null status, from the legacy signal, are pending only when they have candidates and none is selected). While at least one item is pending, all items that have candidates of the active type are returned, including resolved ones, plus the items without candidates that require user selection (NOT_FOUND), so the front can offer a lookup. Purchase order groups are evaluated only after every item group is resolved and follow the same rule. When nothing is pending, no exception is returned tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Fiscal document id responses: 200: description: Ok schema: type: object required: – candidateType properties: candidateType: type: string allOf: – #/definitions/enumCandidateExceptionType description: Active candidate type pending treatment in the document items: type: array items: type: object allOf: – #/definitions/documentItemCandidateData description: Document items of the active type, ordered by itemNumber: items with candidates (resolved and pending) and items without candidates that require user selection. Empty when there is nothing to handle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns candidate options for the active exception stage of a fiscal document. An item is pending when the agent declared PENDING_SELECTION or NOT_FOUND for the dimension and no candidate is selected (items with a null status, from the legacy signal, are pending only when they have candidates and none is selected). While at least one item is pending, all items that have candidates of the active type are returned, including resolved ones, plus the items without candidates that require user selection (NOT_FOUND), so the front can offer a lookup. Purchase order groups are evaluated only after every item group is resolved and follow the same rule. When nothing is pending, no exception is returned tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documentId description: Fiscal document id in: query required: true type: string responses: 200: description: Ok schema: type: object required: – candidateType properties: candidateType: type: string allOf: – #/definitions/enumCandidateExceptionType description: Active candidate type pending treatment in the document items: type: array items: type: object allOf: – #/definitions/documentItemCandidateData description: Document items of the active type, ordered by itemNumber: items with candidates (resolved and pending) and items without candidates that require user selection. Empty when there is nothing to handle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/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 /document/queries/exportCurrency: 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 /document/queries/exportCountry: 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 /document/queries/exportCompany: 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 /document/queries/exportBranch: 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 /document/queries/exportPerson: 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 /document/queries/exportDocument: 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 /document/queries/exportDocumentItem: 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 /document/queries/exportDocumentItemTax: 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 /document/queries/exportCandidatePurchaseOrder: 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 /document/queries/exportCandidateItem: 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 /document/queries/exportDocumentItemInconsistency: 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 /document/queries/exportDocumentWorkflowStep: 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 /document/queries/exportWorkflowManualStep: 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 /document/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 /document/actions/softExclude: post: description: Realiza a exclusao logica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro esta/foi excluido errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/actions/undoSoftExclude: post: description: Realiza a compensacao da exclusao logica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro esta/foi excluido errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/actions/saveWorkflowManualSteps: post: description: Persiste (upsert) os steps manuais do workflow em uma unica transacao tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – steps properties: steps: type: array items: type: object allOf: – #/definitions/workflowManualStepData minimum: 1 description: Lista ordenada dos steps manuais a persistir responses: 200: description: Ok schema: type: object required: – steps properties: steps: type: array items: type: object allOf: – #/definitions/workflowManualStepData minimum: 1 description: Steps manuais persistidos, ordenados por stepOrder 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/actions/saveCandidateSelections: post: description: Persiste parcialmente as escolhas de candidatos do documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentId – candidateType – selections properties: documentId: type: string description: Id do documento fiscal candidateType: type: string allOf: – #/definitions/enumCandidateExceptionType description: Tipo de candidato selecionado selections: type: array items: type: object allOf: – #/definitions/candidateSelectionData minimum: 1 description: Escolhas associadas aos itens do documento responses: 200: description: Ok schema: type: object required: – savedSelections – remainingCandidateType – remainingItems – allCandidatesResolved – reprocessingScheduled properties: savedSelections: type: integer format: int64 description: Quantidade de grupos salvos remainingCandidateType: type: string allOf: – #/definitions/enumCandidateExceptionType description: Proximo tipo de candidato pendente remainingItems: type: integer format: int64 description: Quantidade de grupos pendentes no proximo tipo allCandidatesResolved: type: boolean description: Indica se todos os candidatos foram resolvidos reprocessingScheduled: type: boolean description: Indica que o documento esta pronto e o ponto de reprocessamento foi alcancado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/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 /document/actions/importCurrency: 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 /document/actions/importCountry: 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 /document/actions/importCompany: 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 /document/actions/importBranch: 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 /document/actions/importPerson: 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 /document/actions/importDocument: 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 /document/actions/importDocumentItem: 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 /document/actions/importDocumentItemTax: 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 /document/actions/importCandidatePurchaseOrder: 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 /document/actions/importCandidateItem: 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 /document/actions/importDocumentItemInconsistency: 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 /document/actions/importDocumentWorkflowStep: 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 /document/actions/importWorkflowManualStep: 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 /document/events/importCurrencyEvent: 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 /document/events/exportCurrencyEvent: 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 /document/events/importCountryEvent: 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 /document/events/exportCountryEvent: 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 /document/events/importCompanyEvent: 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 /document/events/exportCompanyEvent: 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 /document/events/importBranchEvent: 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 /document/events/exportBranchEvent: 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 /document/events/importPersonEvent: 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 /document/events/exportPersonEvent: 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 /document/events/importDocumentEvent: 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 /document/events/exportDocumentEvent: 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 /document/events/importDocumentItemEvent: 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 /document/events/exportDocumentItemEvent: 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 /document/events/importDocumentItemTaxEvent: 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 /document/events/exportDocumentItemTaxEvent: 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 /document/events/importCandidatePurchaseOrderEvent: 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 /document/events/exportCandidatePurchaseOrderEvent: 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 /document/events/importCandidateItemEvent: 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 /document/events/exportCandidateItemEvent: 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 /document/events/importDocumentItemInconsistencyEvent: 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 /document/events/exportDocumentItemInconsistencyEvent: 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 /document/events/importDocumentWorkflowStepEvent: 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 /document/events/exportDocumentWorkflowStepEvent: 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 /document/events/importWorkflowManualStepEvent: 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 /document/events/exportWorkflowManualStepEvent: 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 /document/entities/company: 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/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/entities/branch: 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/branch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/entities/document: 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/document responses: 200: description: The created resource schema: #/definitions/document 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/document responses: 200: description: The created resource schema: #/definitions/document 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/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/entities/document/{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/editDocument responses: 200: description: Ok schema: #/definitions/editDocument 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/document responses: 200: description: Ok schema: #/definitions/document 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/document 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 /document/entities/document/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/document responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/entities/documentItem: 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/documentItem responses: 200: description: The created resource schema: #/definitions/documentItem 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/documentItem responses: 200: description: The created resource schema: #/definitions/documentItem 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/documentItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/entities/documentItem/{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/editDocumentItem responses: 200: description: Ok schema: #/definitions/editDocumentItem 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/documentItem responses: 200: description: Ok schema: #/definitions/documentItem 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/documentItem 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 /document/entities/document/{parentId}/documentItems: 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/documentItem responses: 200: description: The created resources schema: type: array items: #/definitions/documentItem 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/documentItem responses: 200: description: The created resources schema: type: array items: #/definitions/documentItem 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/documentItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/entities/document/{parentId}/documentItems/{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/editDocumentItem responses: 200: description: Ok schema: #/definitions/editDocumentItem 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/documentItem responses: 200: description: Ok schema: #/definitions/documentItem 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/documentItem 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 /document/entities/documentItem/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/entities/documentItemTax: 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/documentItemTax responses: 200: description: The created resource schema: #/definitions/documentItemTax 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/documentItemTax responses: 200: description: The created resource schema: #/definitions/documentItemTax 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/documentItemTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/entities/documentItemTax/{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/editDocumentItemTax responses: 200: description: Ok schema: #/definitions/editDocumentItemTax 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/documentItemTax responses: 200: description: Ok schema: #/definitions/documentItemTax 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/documentItemTax 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 /document/entities/documentItemTax/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentItemTax responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/entities/documentItemInconsistency: 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/documentItemInconsistency responses: 200: description: The created resource schema: #/definitions/documentItemInconsistency 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/documentItemInconsistency responses: 200: description: The created resource schema: #/definitions/documentItemInconsistency 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/documentItemInconsistency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/entities/documentItemInconsistency/{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/editDocumentItemInconsistency responses: 200: description: Ok schema: #/definitions/editDocumentItemInconsistency 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/documentItemInconsistency responses: 200: description: Ok schema: #/definitions/documentItemInconsistency 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/documentItemInconsistency 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 /document/entities/documentItemInconsistency/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentItemInconsistency responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/entities/documentWorkflowStep: 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/documentWorkflowStep responses: 200: description: The created resource schema: #/definitions/documentWorkflowStep 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/documentWorkflowStep responses: 200: description: The created resource schema: #/definitions/documentWorkflowStep 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/documentWorkflowStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/entities/documentWorkflowStep/{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/editDocumentWorkflowStep responses: 200: description: Ok schema: #/definitions/editDocumentWorkflowStep 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/documentWorkflowStep responses: 200: description: Ok schema: #/definitions/documentWorkflowStep 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/documentWorkflowStep 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 /document/entities/documentWorkflowStep/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentWorkflowStep responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/entities/workflowManualStep: 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/workflowManualStep responses: 200: description: The created resource schema: #/definitions/workflowManualStep 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/workflowManualStep responses: 200: description: The created resource schema: #/definitions/workflowManualStep 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/workflowManualStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document/entities/workflowManualStep/{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/editWorkflowManualStep responses: 200: description: Ok schema: #/definitions/editWorkflowManualStep 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/workflowManualStep responses: 200: description: Ok schema: #/definitions/workflowManualStep 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/workflowManualStep 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 /document/entities/workflowManualStep/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workflowManualStep responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumDocumentType: type: string enum: – NFE – CTE – NFSE description: Document type: * `NFE` – Nota Fiscal Eletronica * `CTE` – Conhecimento de Transporte Eletronico * `NFSE` – Nota Fiscal de Servico Eletronica enumSituationDocument: type: string enum: – MATCH_SARA – MATCH_SARA_INCONSISTENCY – MATCH_SARA_EXCEPTION – GATE – FISCAL_CONFERENCE – PHYSICAL_RECEIPT – MANAGERIAL_APPROVAL – SUSPENDED – ERP_INTEGRATION description: Enumeration for the fiscal document situation: * `MATCH_SARA` – Match SARA * `MATCH_SARA_INCONSISTENCY` – Match SARA inconsistency * `MATCH_SARA_EXCEPTION` – Match SARA exception * `GATE` – Gate * `FISCAL_CONFERENCE` – Fiscal conference * `PHYSICAL_RECEIPT` – Physical receipt * `MANAGERIAL_APPROVAL` – Managerial approval * `SUSPENDED` – Suspended * `ERP_INTEGRATION` – ERP integration enumSubSituationDocument: type: string enum: – TO_DO – DOING – DONE description: Enumeration for the fiscal document sub situation: * `TO_DO` – To do * `DOING` – Doing * `DONE` – Done enumSituationDocumentItem: type: string enum: – DONE – ERROR description: Enumeration for the fiscal document item situation: * `DONE` – Done * `ERROR` – Error enumSituationDocumentItemTax: type: string enum: – DONE – ERROR description: Enumeration for the fiscal document item tax situation: * `DONE` – Done * `ERROR` – Error enumItemMatchStatus: type: string enum: – MATCHED – PENDING_SELECTION – INCONSISTENT – NOT_FOUND – PENDING_PRODUCT_MATCH – NOT_APPLICABLE – NOT_EVALUATED description: Match veredict reported by the AI agent for one dimension (product/service or purchase order) of a document item: * `MATCHED` – Dimension resolved automatically, no pendency * `PENDING_SELECTION` – Candidates found, human selection required * `INCONSISTENT` – Candidate resolved, but with divergence * `NOT_FOUND` – No candidate found * `PENDING_PRODUCT_MATCH` – Not evaluated: depends on the product resolution (purchase order dimension only) * `NOT_APPLICABLE` – Dimension does not apply to the item * `NOT_EVALUATED` – The agent did not evaluate the dimension enumInconsistencyScope: type: string enum: – PRODUCT – PURCHASE_ORDER – QUANTITY_VALUE – TAX description: Dimension a document item inconsistency belongs to: * `PRODUCT` – Product/service * `PURCHASE_ORDER` – Purchase order * `QUANTITY_VALUE` – Quantities and values * `TAX` – Tax enumInconsistencySeverity: type: string enum: – BLOCKING – WARNING description: Severity of a document item inconsistency: * `BLOCKING` – Prevents the document from advancing automatically * `WARNING` – Informative; allows the document to advance automatically enumItemInconsistencyType: type: string enum: – PRODUCT_NOT_FOUND – PRODUCT_LOW_CONFIDENCE – PRODUCT_MULTIPLE_CANDIDATES – SUPPLIER_MAPPING_MISSING – SUPPLIER_DIVERGENCE – NCM_DIVERGENCE – UNIT_OF_MEASURE_DIVERGENCE – PURCHASE_ORDER_NOT_FOUND – PURCHASE_ORDER_MULTIPLE_CANDIDATES – PURCHASE_ORDER_CLOSED – PURCHASE_ORDER_BALANCE_INSUFFICIENT – PURCHASE_ORDER_BALANCE_OVERALLOCATED – PURCHASE_ORDER_OTHER_BRANCH – QUANTITY_DIVERGENCE – UNIT_PRICE_DIVERGENCE – TOTAL_VALUE_DIVERGENCE – CURRENCY_DIVERGENCE – CFOP_UNEXPECTED – TAX_DIVERGENCE – AGENT_ERROR – OTHER description: Type of inconsistency found by the AI agent for a document item: * `PRODUCT_NOT_FOUND` – Product/service not found * `PRODUCT_LOW_CONFIDENCE` – Product/service found with low confidence * `PRODUCT_MULTIPLE_CANDIDATES` – Multiple product/service candidates * `SUPPLIER_MAPPING_MISSING` – Supplier product mapping missing * `SUPPLIER_DIVERGENCE` – Supplier divergence between document and purchase order * `NCM_DIVERGENCE` – NCM divergence * `UNIT_OF_MEASURE_DIVERGENCE` – Unit of measure divergence * `PURCHASE_ORDER_NOT_FOUND` – Purchase order not found * `PURCHASE_ORDER_MULTIPLE_CANDIDATES` – Multiple purchase order candidates * `PURCHASE_ORDER_CLOSED` – Purchase order closed * `PURCHASE_ORDER_BALANCE_INSUFFICIENT` – Purchase order balance insufficient * `PURCHASE_ORDER_BALANCE_OVERALLOCATED` – Purchase order balance over allocated among the document items * `PURCHASE_ORDER_OTHER_BRANCH` – Purchase order belongs to another branch * `QUANTITY_DIVERGENCE` – Quantity divergence * `UNIT_PRICE_DIVERGENCE` – Unit price divergence * `TOTAL_VALUE_DIVERGENCE` – Total value divergence * `CURRENCY_DIVERGENCE` – Currency divergence * `CFOP_UNEXPECTED` – Unexpected CFOP * `TAX_DIVERGENCE` – Tax divergence * `AGENT_ERROR` – Agent error * `OTHER` – Other: type not yet mapped, explained in the detail field enumWorkflowStepStatus: type: string enum: – PENDING – PROCESSING – DONE – ERROR description: Status de processamento de um step do workflow do documento fiscal: * `PENDING` – Pendente * `PROCESSING` – Em processamento * `DONE` – Concluido * `ERROR` – Erro enumWorkflowManualStep: type: string enum: – GATE – FISCAL_CONFERENCE – MANAGERIAL_APPROVAL – PHYSICAL_RECEIPT description: Steps manuais do workflow (reordenaveis e habilitaveis): * `GATE` – Portaria * `FISCAL_CONFERENCE` – Conferencia fiscal * `MANAGERIAL_APPROVAL` – Aprovacao gerencial * `PHYSICAL_RECEIPT` – Recebimento fisico enumPersonType: type: string enum: – VJ – VF description: Person type: * `VJ` – Legal entity * `VF` – Individual enumStatus: type: string enum: – VA – VI description: Registration status: * `VA` – Active * `VI` – Inactive enumMarketType: type: string enum: – VI – VE description: Market type: * `VI` – Domestic * `VE` – Foreign enumTipImpDoc: type: string enum: – IPI – IPI_CREDITADO – ISS – ISS_RETIDO – PIS_RECUPERAR – PIS_DEVOLVIDO – COFINS_RECUPERAR – COFINS_DEVOLVIDO – PIS_RETIDO – COFINS_RETIDO – CSLL – IRRF – INSS – IMPOSTO_IMPORTACAO – PIS_RECUPERAR_IMPORTACAO – COFINS_RECUPERAR_IMPORTACAO – ICMS – ICMS_CREDITADO – FCP – ICMS_DIFERIDO – ICMS_DESONERADO – DIFAL – ICMS_ST – FCP_ST – ICMS_COBRADO_ANTERIORMENTE_ST – FCP_COBRADO_ANTERIORMENTE_ST – ICMS_FUTURO – ICMS_SIMPLES – FCP_UF_DESTINO – PIS – COFINS – IPI_PRESUMIDO – IPI_DEVOLVIDO – CIDE_TECNOLOGIA – INSS_PATRONAL – ICMS_ST_SOLIDARIO – FCP_ST_RETIDO_ANT – ICMS_ST_FUTURO – ICMS_ST_RETIDO_ANT – ICMS_UF_DESTINO_DEVOLVIDO – FCP_UF_DESTINO_DEVOLVIDO – ICMS_EFETIVO – ICMS_ISENTAS_OUTRAS – FUNRURAL_INSS – FUNRURAL_RAT – FUNRURAL_SENAR – FUNRURAL_TOTAL – IPI_OUTRAS_DESPESAS – ICMS_CREDITO_PRESUMIDO – CBS – IBS_ESTADUAL – IBS_MUNICIPAL – IS – CBS_DIFERIDO – CBS_TRIBUTACAO_REGULAR – IBS_MUNICIPAL_DIFERIDO – IBS_MUNICIPAL_TRIBUTACAO_REGULAR – IBS_ESTADUAL_DIFERIDO – IBS_ESTADUAL_TRIBUTACAO_REGULAR – CBS_CREDITO_PRESUMIDO – IBS_ESTADUAL_CREDITO_PRESUMIDO – IBS_CREDITO_PRESUMIDO – CBS_GOVERNAMENTAL – IBS_ESTADUAL_GOVERNAMENTAL – IBS_MUNICIPAL_GOVERNAMENTAL – CBS_ESTORNO_CREDITO – IBS_ESTORNO_CREDITO – CBS_TRANSFERENCIA_CREDITO – IBS_TRANSFERENCIA_CREDITO – CBS_A_APROPRIAR – IBS_ESTADUAL_A_APROPRIAR – IBS_MUNICIPAL_A_APROPRIAR description: Tipo de imposto documento: * `IPI` – IPI * `IPI_CREDITADO` – IPI Efetivamente Creditado * `ISS` – ISS * `ISS_RETIDO` – ISS Retido * `PIS_RECUPERAR` – PIS a recuperar * `PIS_DEVOLVIDO` – PIS Devolvido * `COFINS_RECUPERAR` – COFINS a Recuperar * `COFINS_DEVOLVIDO` – COFINS Devolvido * `PIS_RETIDO` – PIS Retido * `COFINS_RETIDO` – COFINS Retido * `CSLL` – CSLL Retido * `IRRF` – IRRF Retido * `INSS` – INSS Retido * `IMPOSTO_IMPORTACAO` – Imposto Importação * `PIS_RECUPERAR_IMPORTACAO` – PIS a Recuperar na Importação * `COFINS_RECUPERAR_IMPORTACAO` – COFINS a Recuperar na Importação * `ICMS` – ICMS * `ICMS_CREDITADO` – ICMS Efetivamente Creditado * `FCP` – Fundo de Combate a Pobreza * `ICMS_DIFERIDO` – ICMS Diferido * `ICMS_DESONERADO` – ICMS Desonerado * `DIFAL` – Diferencial de alíquota interestadual * `ICMS_ST` – ICMS com cobrança por ST * `FCP_ST` – FCP com cobrança por ST * `ICMS_COBRADO_ANTERIORMENTE_ST` – ICMS Cobrando Anteriormente por ST * `FCP_COBRADO_ANTERIORMENTE_ST` – FCP cobrando Anteriormente por ST * `ICMS_FUTURO` – ICMS futuro * `ICMS_SIMPLES` – ICMS simples nacional * `FCP_UF_DESTINO` – FCP UF destino * `PIS` – PIS Faturamento * `COFINS` – COFINS Faturamento * `IPI_PRESUMIDO` – IPI presumido * `IPI_DEVOLVIDO` – IPI Devolvido * `CIDE_TECNOLOGIA` – CIDE Tecnologia * `INSS_PATRONAL` – INSS Patronal * `ICMS_ST_SOLIDARIO` – ICMS ST Solidario * `FCP_ST_RETIDO_ANT` – FCP Retido cobrado anteriormente * `ICMS_ST_FUTURO` – ICMS ST FUTURO * `ICMS_ST_RETIDO_ANT` – ICMS ST RETIDO ANT * `ICMS_UF_DESTINO_DEVOLVIDO` – ICMS UF DESTINO DEVOLVIDO * `FCP_UF_DESTINO_DEVOLVIDO` – FCP UF DESTINO DEVOLVIDO * `ICMS_EFETIVO` – ICMS EFETIVO * `ICMS_ISENTAS_OUTRAS` – ICMS Isentas/Outras * `FUNRURAL_INSS` – FUNRURAL INSS * `FUNRURAL_RAT` – FUNRURAL RAT * `FUNRURAL_SENAR` – FUNRURAL SENAR * `FUNRURAL_TOTAL` – FUNRURAL_TOTAL * `IPI_OUTRAS_DESPESAS` – IPI OUTRAS DESPESAS * `ICMS_CREDITO_PRESUMIDO` – ICMS – Crédito presumido * `CBS` – CBS * `IBS_ESTADUAL` – IBS Estadual * `IBS_MUNICIPAL` – IBS Municipal * `IS` – IS * `CBS_DIFERIDO` – CBS Diferido * `CBS_TRIBUTACAO_REGULAR` – CBS Tributação Regular * `IBS_MUNICIPAL_DIFERIDO` – IBS Municipal Diferido * `IBS_MUNICIPAL_TRIBUTACAO_REGULAR` – CBS MUNICIPAL Tributação Regular * `IBS_ESTADUAL_DIFERIDO` – IBS Estadual Diferido * `IBS_ESTADUAL_TRIBUTACAO_REGULAR` – IBS ESTADUAL Tributação Regular * `CBS_CREDITO_PRESUMIDO` – CBS crédito presumido * `IBS_ESTADUAL_CREDITO_PRESUMIDO` – IBS Estadual crédito presumido * `IBS_CREDITO_PRESUMIDO` – IBS Crédito Presumido * `CBS_GOVERNAMENTAL` – CBS governamental * `IBS_ESTADUAL_GOVERNAMENTAL` – IBS Estadual governamental * `IBS_MUNICIPAL_GOVERNAMENTAL` – IBS Municipal governamental * `CBS_ESTORNO_CREDITO` – CBS Estorno Crédito * `IBS_ESTORNO_CREDITO` – IBS Estorno Crédito * `CBS_TRANSFERENCIA_CREDITO` – CBS – Transferência de Crédito * `IBS_TRANSFERENCIA_CREDITO` – IBS – Transferência de Crédito * `CBS_A_APROPRIAR` – CBS a Apropriar * `IBS_ESTADUAL_A_APROPRIAR` – IBS Estadual a Apropriar * `IBS_MUNICIPAL_A_APROPRIAR` – IBS Municipal a Apropriar enumCandidateExceptionType: type: string enum: – NONE – CANDIDATE_ITEM – CANDIDATE_PURCHASE_ORDER description: Candidate exception type pending treatment in a document: * `NONE` – No pending candidate exception * `CANDIDATE_ITEM` – Internal item candidates pending selection * `CANDIDATE_PURCHASE_ORDER` – Purchase order candidates pending selection 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 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 tableForeignKeyReference: description: Resulado da consulta de tabelas referenciada por uma Foreign Key type: object required: – referenceTableName – tableName – columnName – constraintName properties: referenceTableName: type: string description: Referenced table tableName: type: string description: Tabela referenciada columnName: type: string description: Coluna referenciada pela FK exclusionField: type: string description: Coluna com o campo de exclusão constraintName: type: string description: Nome da ForeignKey workflowManualStepData: description: Step manual do workflow com habilitacao e ordem type: object required: – step – enabled – stepOrder properties: step: type: string allOf: – #/definitions/enumWorkflowManualStep description: Step manual enabled: type: boolean description: Indica se o step esta habilitado stepOrder: type: integer format: int64 description: Ordem relativa entre os steps manuais candidateSelectionData: description: Escolha de candidato associada explicitamente ao item do documento. Em CANDIDATE_PURCHASE_ORDER o mesmo item pode receber varias escolhas (rateio entre pedidos) type: object required: – documentItemId – candidateId properties: documentItemId: type: string description: Id do item do documento candidateId: type: string description: Id do candidato selecionado allocatedQuantity: type: number format: double description: Quantidade do item atendida por este pedido. Apenas para CANDIDATE_PURCHASE_ORDER (ignorada em CANDIDATE_ITEM). Obrigatoria quando o item recebe mais de um pedido; com um unico pedido, quando omitida, assume a quantidade total do item candidateItemData: description: Internal item candidate pending selection for the document item type: object required: – id – selected properties: id: type: string description: Candidate id erpItemCode: type: string description: ERP item code erpItemDescription: type: string description: ERP item description erpUnitOfMeasure: type: string description: ERP unit of measure ncm: type: string description: NCM code supplierProductCode: type: string description: Supplier product code accuracyPercentage: type: number format: double description: Match accuracy percentage selected: type: boolean description: Whether this candidate is selected candidatePurchaseOrderData: description: Purchase order candidate pending selection for the document item type: object required: – id – selected properties: id: type: string description: Candidate id purchaseOrderNumber: type: string description: Purchase order number purchaseOrderItemCode: type: string description: Purchase order item code purchaseOrderItemDesc: type: string description: Purchase order item description purchaseOrderIssueDate: type: string format: date-time description: Purchase order issue date purchaseOrderStatus: type: string description: Purchase order status currency: type: string description: Purchase order currency purchaseOrderUnitOfMeasure: type: string description: Purchase order unit of measure orderedQuantity: type: number format: double description: Ordered quantity availableBalance: type: number format: double description: Available balance unitPrice: type: number format: double description: Unit price accuracyPercentage: type: number format: double description: Match accuracy percentage selected: type: boolean description: Whether this candidate is selected allocatedQuantity: type: number format: double description: How much of the item quantity is drawn from this purchase order documentItemInconsistencyData: description: Inconsistency reported by the AI agent for a document item type: object required: – id – inconsistencyScope – inconsistencyType – severity properties: id: type: string description: Inconsistency id inconsistencyScope: type: string allOf: – #/definitions/enumInconsistencyScope description: Dimension the inconsistency belongs to inconsistencyType: type: string allOf: – #/definitions/enumItemInconsistencyType description: Inconsistency type severity: type: string allOf: – #/definitions/enumInconsistencySeverity description: Inconsistency severity referenceField: type: string description: Field of the item or candidate the inconsistency refers to expectedValue: type: string description: Expected value (from the purchase order or the ERP registry) foundValue: type: string description: Value found in the fiscal document detail: type: string description: Additional explanation provided by the agent documentItemCandidateData: description: Fiscal document item with all candidates of the active exception type type: object required: – id – itemNumber properties: id: type: string description: Document item id itemNumber: type: integer format: int64 description: Item sequential number supplierProductCode: type: string description: Supplier product code description: type: string description: Product/service description ncm: type: string description: NCM code unitOfMeasure: type: string description: Unit of measure quantity: type: number format: double description: Quantity unitValue: type: number format: double description: Unit value totalValue: type: string description: Total item value productMatchStatus: type: string allOf: – #/definitions/enumItemMatchStatus description: Match veredict of the product/service dimension (null when not evaluated) purchaseOrderMatchStatus: type: string allOf: – #/definitions/enumItemMatchStatus description: Match veredict of the purchase order dimension (null when not evaluated) inconsistencies: type: array items: type: object allOf: – #/definitions/documentItemInconsistencyData description: Inconsistencies reported by the AI agent for the item, of every scope candidateItems: type: array items: type: object allOf: – #/definitions/candidateItemData description: All internal item candidates of the item, resolved or pending (empty when the active type is not CANDIDATE_ITEM) candidatePurchaseOrders: type: array items: type: object allOf: – #/definitions/candidatePurchaseOrderData description: All purchase order candidates of the item, resolved or pending (empty when the active type is not CANDIDATE_PURCHASE_ORDER) currency: description: Currency type: object required: – deleted properties: id: type: string format: uuid description: Id code: type: string maxLength: 20 description: Code description: type: string maxLength: 30 description: Description abbreviation: type: string maxLength: 5 description: Abbreviation deleted: type: boolean description: Deleted extIntSts: type: string maxLength: 100 description: Integration status extIntMsg: type: string maxLength: 100 description: Integration message createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: country: description: Country type: object required: – code – deleted properties: id: type: string format: uuid description: Id code: type: string maxLength: 20 description: Code name: type: string maxLength: 100 description: Name currency: type: object allOf: – #/definitions/currency description: Currency deleted: type: boolean description: Deleted extIntSts: type: string maxLength: 100 description: Integration status extIntMsg: type: string maxLength: 100 description: Integration message createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: company: description: Company type: object required: – code – name – tradeName – deleted properties: id: type: string format: uuid description: Id code: type: integer format: int64 description: Code minimum: 0 maximum: 9999 name: type: string maxLength: 100 description: Name tradeName: type: string maxLength: 100 description: Trade name country: type: object allOf: – #/definitions/country description: Country currency: type: object allOf: – #/definitions/currency description: Currency deleted: type: boolean description: Deleted extIntSts: type: string maxLength: 100 description: Integration status extIntMsg: type: string maxLength: 100 description: Integration message createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: branch: description: Branch type: object required: – code – name – tradeName – deleted properties: id: type: string format: uuid description: Id company: type: object allOf: – #/definitions/company description: Company code: type: integer format: int64 description: Code minimum: 0 maximum: 9999 name: type: string maxLength: 100 description: Name tradeName: type: string maxLength: 100 description: Trade name deleted: type: boolean description: Deleted extIntSts: type: string maxLength: 100 description: Integration status extIntMsg: type: string maxLength: 100 description: Integration message createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: person: description: Person type: object required: – code – name – deleted properties: id: type: string format: uuid description: Id code: type: integer format: int64 description: Code minimum: 0 name: type: string maxLength: 255 description: Name tradeName: type: string maxLength: 255 description: Trade name personType: type: string allOf: – #/definitions/enumPersonType description: Person type documentNumber: type: string maxLength: 18 description: Document number (CNPJ/CPF) status: type: string allOf: – #/definitions/enumStatus description: Status marketType: type: string allOf: – #/definitions/enumMarketType description: Market type stateRegistration: type: string maxLength: 25 description: State Registration taxIdentificationNumber: type: string maxLength: 40 description: Tax identification number (NIF) deleted: type: boolean description: Deleted extIntSts: type: string maxLength: 100 description: Integration status extIntMsg: type: string maxLength: 100 description: Integration message createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: document: description: Fiscal document type: object required: – branch – documentType – accessKey – documentNumber – issueDate – issuerDocumentNumber – issuerName – recipientDocumentNumber – recipientName properties: id: type: string format: uuid description: Id branch: type: object allOf: – #/definitions/branch description: Branch (recipient/taker) person: type: object allOf: – #/definitions/person description: Person (issuer/provider) – optional, may not exist yet documentType: type: string allOf: – #/definitions/enumDocumentType description: Document type (NFE, CTE, NFSE) accessKey: type: string maxLength: 50 description: Access key documentNumber: type: string maxLength: 20 description: Document number series: type: string maxLength: 5 description: Series issueDate: type: string format: date-time description: Issue date authorizationDate: type: string format: date-time description: Authorization date natureOfOperation: type: string maxLength: 255 description: Nature of operation issuerDocumentNumber: type: string maxLength: 18 description: Issuer document number (CNPJ/CPF) issuerName: type: string maxLength: 255 description: Issuer name issuerTradeName: type: string maxLength: 255 description: Issuer trade name issuerStateRegistration: type: string maxLength: 20 description: Issuer state registration (IE) issuerMunicipalRegistration: type: string maxLength: 20 description: Issuer municipal registration (IM) issuerState: type: string maxLength: 2 description: Issuer state (UF) issuerCityCode: type: string maxLength: 10 description: Issuer city code recipientDocumentNumber: type: string maxLength: 18 description: Recipient document number (CNPJ/CPF) recipientName: type: string maxLength: 255 description: Recipient name recipientState: type: string maxLength: 2 description: Recipient state (UF) totalValue: type: string description: Total document value totalProductsValue: type: string description: Total products/services value totalFreightValue: type: string description: Total freight value totalInsuranceValue: type: string description: Total insurance value totalDiscountValue: type: string description: Total discount value totalOtherExpenses: type: string description: Total other expenses fiscalModel: type: string maxLength: 5 description: Fiscal model (55=NFe, 57=CTe, etc) taxRegime: type: string maxLength: 5 description: Tax regime (CRT) xmlOriginal: type: string description: Original XML content situation: type: string allOf: – #/definitions/enumSituationDocument description: Situation subSituation: type: string allOf: – #/definitions/enumSubSituationDocument description: Sub situation itemsWithInconsistencyCount: type: integer format: int64 description: Number of items with at least one blocking inconsistency (warnings are not counted) matchEvaluatedAt: type: string format: date-time description: Date and time of the last match evaluation documentItems: type: array items: type: object allOf: – #/definitions/documentItem description: Document items createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDocument: type: object required: – id allOf: – #/definitions/document documentItem: description: Document item (product or service line) type: object required: – itemNumber properties: id: type: string format: uuid description: Id document: type: object allOf: – #/definitions/document description: Parent document itemNumber: type: integer format: int64 description: Item sequential number supplierProductCode: type: string maxLength: 60 description: Supplier product code description: type: string maxLength: 500 description: Product/service description ncm: type: string maxLength: 10 description: NCM code (merchandise) cfop: type: string maxLength: 5 description: CFOP code unitOfMeasure: type: string maxLength: 10 description: Unit of measure quantity: type: number format: double description: Quantity unitValue: type: number format: double description: Unit value totalValue: type: string description: Total item value discountValue: type: string description: Discount value freightValue: type: string description: Freight value (apportioned) netValue: type: string description: Net value ean: type: string maxLength: 14 description: EAN/GTIN barcode purchaseOrderItem: type: string maxLength: 20 description: Purchase order item number municipalTaxCode: type: string maxLength: 20 description: Municipal tax code (NFS-e) serviceDescription: type: string description: Full service description (NFS-e) situation: type: string allOf: – #/definitions/enumSituationDocumentItem description: Situation productMatchStatus: type: string allOf: – #/definitions/enumItemMatchStatus description: Match veredict of the product/service dimension (null when not evaluated) purchaseOrderMatchStatus: type: string allOf: – #/definitions/enumItemMatchStatus description: Match veredict of the purchase order dimension (null when not evaluated) matchStatus: type: string allOf: – #/definitions/enumItemMatchStatus description: Aggregated match veredict of the item (null when not evaluated) matchEvaluatedAt: type: string format: date-time description: Date and time of the last match evaluation of the item createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDocumentItem: type: object required: – id allOf: – #/definitions/documentItem documentItemTax: description: Tax applied to a document item type: object required: – documentItem – taxType properties: id: type: string format: uuid description: Id documentItem: type: object allOf: – #/definitions/documentItem description: Parent document item taxType: type: string allOf: – #/definitions/enumTipImpDoc description: Tax type cst: type: string maxLength: 5 description: Tax situation code (CST/CSOSN) calculationBase: type: string description: Calculation base rate: type: number format: double description: Tax rate value: type: string description: Tax value exemptValue: type: string description: Exempt value otherValue: type: string description: Other values withholding: type: boolean description: Withholding (tax retained at source) default: false situation: type: string allOf: – #/definitions/enumSituationDocumentItemTax description: Situation createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDocumentItemTax: type: object required: – id allOf: – #/definitions/documentItemTax candidatePurchaseOrder: description: Purchase order candidate matched to a document item type: object required: – documentItem properties: id: type: string format: uuid description: Id documentItem: type: object allOf: – #/definitions/documentItem description: Parent document item purchaseOrderNumber: type: string maxLength: 255 description: Purchase order number purchaseOrderItemCode: type: string maxLength: 255 description: Purchase order item code purchaseOrderItemDesc: type: string maxLength: 255 description: Purchase order item description purchaseOrderIssueDate: type: string format: date-time description: Purchase order issue date purchaseOrderStatus: type: string maxLength: 255 description: Purchase order status currency: type: string maxLength: 255 description: Currency purchaseOrderUnitOfMeasure: type: string maxLength: 255 description: Purchase order unit of measure orderedQuantity: type: number format: double description: Ordered quantity availableBalance: type: number format: double description: Available balance unitPrice: type: number format: double description: Unit price accuracyPercentage: type: number format: double description: Match accuracy percentage selected: type: boolean description: Whether this candidate is selected default: false allocatedQuantity: type: number format: double description: How much of the item quantity is drawn from this purchase order createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: candidateItem: description: Internal item candidate matched to a document item type: object required: – documentItem properties: id: type: string format: uuid description: Id documentItem: type: object allOf: – #/definitions/documentItem description: Parent document item erpItemCode: type: string maxLength: 255 description: ERP item code erpItemDescription: type: string maxLength: 255 description: ERP item description erpUnitOfMeasure: type: string maxLength: 255 description: ERP unit of measure ncm: type: string maxLength: 255 description: NCM code supplierProductCode: type: string maxLength: 255 description: Supplier product code accuracyPercentage: type: number format: double description: Match accuracy percentage selected: type: boolean description: Whether this candidate is selected default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documentItemInconsistency: description: Inconsistency reported by the AI agent for a document item (read only) type: object required: – documentItem – inconsistencyScope – inconsistencyType – severity properties: id: type: string format: uuid description: Id documentItem: type: object allOf: – #/definitions/documentItem description: Parent document item inconsistencyScope: type: string allOf: – #/definitions/enumInconsistencyScope description: Dimension the inconsistency belongs to inconsistencyType: type: string allOf: – #/definitions/enumItemInconsistencyType description: Inconsistency type severity: type: string allOf: – #/definitions/enumInconsistencySeverity description: Inconsistency severity referenceField: type: string maxLength: 255 description: Field of the item or candidate the inconsistency refers to expectedValue: type: string maxLength: 255 description: Expected value (from the purchase order or the ERP registry) foundValue: type: string maxLength: 255 description: Value found in the fiscal document detail: type: string description: Additional explanation provided by the agent createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDocumentItemInconsistency: type: object required: – id allOf: – #/definitions/documentItemInconsistency documentWorkflowStep: description: Workflow step materialized per fiscal document (read only) type: object required: – document – step – stepOrder – status properties: id: type: string format: uuid description: Id document: type: object allOf: – #/definitions/document description: Fiscal document step: type: string allOf: – #/definitions/enumSituationDocument description: Workflow step (MATCH_SARA, enabled manual steps and ERP_INTEGRATION) stepOrder: type: integer format: int64 description: Step order in the document workflow status: type: string allOf: – #/definitions/enumWorkflowStepStatus description: Step processing status errorMessage: type: string description: Step error message (when there is one) transactionId: type: string maxLength: 255 description: Correlation id with the asynchronous processing (for MATCH_SARA, the agent jobId) createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDocumentWorkflowStep: type: object required: – id allOf: – #/definitions/documentWorkflowStep workflowManualStep: description: Workflow manual step configuration (global per tenant) type: object required: – step – stepOrder properties: id: type: string format: uuid description: Id step: type: string allOf: – #/definitions/enumWorkflowManualStep description: Manual step enabled: type: boolean description: Whether the step is enabled default: false stepOrder: type: integer format: int64 description: Relative order among manual steps createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editWorkflowManualStep: type: object required: – id allOf: – #/definitions/workflowManualStep 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 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

Este artigo foi útil para você?

Sim  Não
Leave A Comment Cancelar resposta

Você precisa fazer o login para publicar um comentário.

© 2022 Senior. Todos os direitos reservados.
Mais pesquisados:Customização, Tutorial, Documentação