2.0info: 3.2.0 Gerador de etiquetas description: Serviço de manutenção e impressão de etiquetas x-senior-domain: Tms x-senior-domain-path: tms x-senior-service-path: etiquetas 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/tmssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /etiquetas/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/enumUpDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/recCheckData 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/enumUpDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/recCheckData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/queries/buscaNotafiscal: post: description: Busca dados da Nota Fiscal tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – remetente – numero – serie properties: remetente: type: string description: Remetente numero: type: string description: Número da NF serie: type: string description: Série responses: 200: description: Ok schema: type: object required: – id – remetente – descricaoRemetente – serie – numero – status – idDocumento – qtdVolumes properties: id: type: string description: ID da Nota Fiscal remetente: type: string description: Remetente descricaoRemetente: type: string description: Descrição – Remetente serie: type: string description: Série numero: type: string description: Numero status: type: string allOf: – #/definitions/enumStatusNf description: Status idDocumento: type: string description: ID do Documento qtdVolumes: type: integer format: int64 description: Volumes 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Recurso não encontrado default: description: Error response schema: #/definitions/genericError get: description: Busca dados da Nota Fiscal tags: – Queries x-senior-visibility: PRIVATE parameters: – name: remetente description: Remetente in: query required: true type: string – name: numero description: Número da NF in: query required: true type: string – name: serie description: Série in: query required: true type: string responses: 200: description: Ok schema: type: object required: – id – remetente – descricaoRemetente – serie – numero – status – idDocumento – qtdVolumes properties: id: type: string description: ID da Nota Fiscal remetente: type: string description: Remetente descricaoRemetente: type: string description: Descrição – Remetente serie: type: string description: Série numero: type: string description: Numero status: type: string allOf: – #/definitions/enumStatusNf description: Status idDocumento: type: string description: ID do Documento qtdVolumes: type: integer format: int64 description: Volumes 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Recurso não encontrado default: description: Error response schema: #/definitions/genericError /etiquetas/queries/buscaRespostasPorTipo: post: description: Lista Respostas por tipo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipo properties: tipo: type: string allOf: – #/definitions/enumTipoResposta description: Tipo da resposta responses: 200: description: Ok schema: type: object required: – respostas properties: respostas: type: array items: type: object allOf: – #/definitions/recRetornoResposta minimum: 1 description: Respostas do tipo 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Recurso não encontrado default: description: Error response schema: #/definitions/genericError /etiquetas/queries/buscaScriptEtiqueta: post: description: Busca Script por Etiqueta tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idDocumento – sequencia properties: idDocumento: type: string description: Id do Documento sequencia: type: integer format: int64 description: Sequencia responses: 200: description: Ok schema: type: object required: – idDocumento – idScript – urlDownload – etiquetas properties: idDocumento: type: string description: Id do Documento idScript: type: string description: Id do Script urlDownload: type: string description: URL para download do script etiquetas: type: array items: type: object allOf: – #/definitions/recScriptEtiqueta minimum: 1 description: Etiquetas no script 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Recurso não encontrado default: description: Error response schema: #/definitions/genericError get: description: Busca Script por Etiqueta tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idDocumento description: Id do Documento in: query required: true type: string – name: sequencia description: Sequencia in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – idDocumento – idScript – urlDownload – etiquetas properties: idDocumento: type: string description: Id do Documento idScript: type: string description: Id do Script urlDownload: type: string description: URL para download do script etiquetas: type: array items: type: object allOf: – #/definitions/recScriptEtiqueta minimum: 1 description: Etiquetas no script 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Recurso não encontrado default: description: Error response schema: #/definitions/genericError /etiquetas/queries/buscaScriptEtiquetaDocumento: post: description: Busca script da etiqueta do documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idDocumento properties: idDocumento: type: string description: Id do Documento sequencia: type: integer format: int64 description: Sequencia responses: 200: description: Ok schema: type: object required: – listaScript properties: listaScript: type: array items: type: object allOf: – #/definitions/recScriptEtiquetaDocumento minimum: 1 description: Lista de URL para download do scripts 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Recurso não encontrado default: description: Error response schema: #/definitions/genericError get: description: Busca script da etiqueta do documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idDocumento description: Id do Documento in: query required: true type: string – name: sequencia description: Sequencia in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaScript properties: listaScript: type: array items: type: object allOf: – #/definitions/recScriptEtiquetaDocumento minimum: 1 description: Lista de URL para download do scripts 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Recurso não encontrado default: description: Error response schema: #/definitions/genericError /etiquetas/queries/buscaEtiquetaNotafiscal: post: description: Busca etiquetas da nota fiscal tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: remetente: type: string description: Remetente da nota fiscal numero: type: string description: Número da nota fiscal serie: type: string description: Série da nota fiscal sequenciaVolume: type: integer format: int64 description: Número do volume minimum: 1 statusEtiqueta: type: array items: type: string allOf: – #/definitions/enumStatusEtiqueta description: Lista de status da etiqueta pageRequest: type: object allOf: – #/definitions/recPageRequest description: Informações para realizar o request dos dados responses: 200: description: Ok schema: type: object required: – etiquetasNotafiscal – totalRegistros properties: etiquetasNotafiscal: type: array items: type: object allOf: – #/definitions/recEtiquetaNotafiscal minimum: 1 description: Lista das etiquetas encontradas totalRegistros: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Recurso não encontrado default: description: Error response schema: #/definitions/genericError /etiquetas/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 /etiquetas/queries/exportDocumento: 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 /etiquetas/queries/exportNotafiscal: 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 /etiquetas/queries/exportVariavel: 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 /etiquetas/queries/exportGrupoVariavel: 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 /etiquetas/queries/exportVariavelDocumento: 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 /etiquetas/queries/exportEtiqueta: 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 /etiquetas/queries/exportModeloScript: 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 /etiquetas/queries/exportConfiguracoesGerais: 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 /etiquetas/queries/exportEtiquetaScript: 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 /etiquetas/queries/exportScript: 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 /etiquetas/queries/exportHistoricoImpressao: 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 /etiquetas/queries/exportResposta: 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 /etiquetas/queries/exportLinguagemScript: 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 /etiquetas/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 /etiquetas/actions/salvaNotafiscal: post: description: Salvar nota fiscal tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – remetente – serie – numero properties: remetente: type: string description: Remetente descricaoRemetente: type: string description: Descrição – Remetente serie: type: string description: Série numero: type: string description: Numero chaveAcesso: type: string description: Chave de acesso status: type: string allOf: – #/definitions/enumStatusNf description: Status qtdVolumes: type: integer format: int64 description: Quantidade de volumes variaveis: type: array items: type: object allOf: – #/definitions/recVariaveis description: Variáveis responses: 200: description: Ok schema: type: object required: – id – idDocumento – variaveisNaoProcessadas properties: id: type: string description: Id da Nota Fiscal idDocumento: type: string description: Id do Documento variaveisNaoProcessadas: type: array items: type: object allOf: – #/definitions/recRetornoVariaveisNaoProcessadas minimum: 1 description: Lista de Variáveis Não Processadas 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /etiquetas/actions/salvaVariaveis: post: description: Inserir variáveis tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idDocumento properties: idDocumento: type: string description: Id do documento variaveis: type: array items: type: object allOf: – #/definitions/recVariaveis description: Variáveis responses: 200: description: Ok schema: type: object required: – idDocumento – variaveisNaoProcessadas properties: idDocumento: type: string description: Documento variaveisNaoProcessadas: type: array items: type: object allOf: – #/definitions/recRetornoVariaveisNaoProcessadas minimum: 1 description: Lista de Variáveis Não Processadas 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /etiquetas/actions/deletaVariaveisDocumento: post: description: Deletar Variáveis Documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idDocumento properties: idDocumento: type: string description: Id do documento variaveis: type: array items: type: object allOf: – #/definitions/recVariaveis description: Variáveis responses: 200: description: Ok schema: type: object required: – idDocumento – variaveisNaoProcessadas properties: idDocumento: type: string description: Documento variaveisNaoProcessadas: type: array items: type: object allOf: – #/definitions/recRetornoVariaveisNaoProcessadas minimum: 1 description: Lista de Variáveis Não Processadas 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /etiquetas/actions/salvaVolumesDocumento: post: description: Salva quantidade de volumes do documento (etiquetas a serem impressas) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idDocumento – qtdVolumes properties: idDocumento: type: string description: Documento qtdVolumes: type: integer format: int64 description: Quantidade de etiquetas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /etiquetas/actions/geraScriptImpressao: post: description: Gera script de impressão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idDocumento – intervalosImpressao properties: idDocumento: type: string description: ID do Documento intervalosImpressao: type: array items: type: object allOf: – #/definitions/recIntervalo minimum: 1 description: Intervalos de Impressão codigoModeloScript: type: string description: Código do modelo de script variaveis: type: array items: type: object allOf: – #/definitions/recVariaveis description: Variáveis responses: 200: description: Ok schema: type: object required: – idDocumento – idScript – url – linguagem – volumesScript properties: idDocumento: type: string description: ID do Documento idScript: type: string description: ID do Script url: type: string description: URL do arquivo no Blob Service linguagem: type: string description: Linguagem do Script volumesScript: type: array items: type: integer format: int64 minimum: 1 description: Lista de volumes no script 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /etiquetas/actions/geraScriptImpressaoNotaFiscal: post: description: Gera script de impressão da nota fiscal tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: remetente: type: string description: Remetente numeroDocumento: type: string description: Número da nota fiscal serieDocumento: type: string description: Série da nota fiscal chaveAcesso: type: string description: Chave de acesso da nota fiscal dadosScriptImpressao: type: object allOf: – #/definitions/recDadosScriptImpressao description: Dados para gerar o script de impressão responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /etiquetas/actions/salvaHistoricoImpressaoScript: post: description: Salva histórico de impressão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idScript – tipoHistorico properties: idScript: type: string description: Id do script tipoHistorico: type: string allOf: – #/definitions/enumTipoHistorico description: Tipo do histórico idRespostaErro: type: string description: Id da Resposta observacao: type: string description: Observação responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /etiquetas/actions/salvaHistoricoImpressaoDocumento: post: description: Salva histórico de impressão do documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idDocumento – tipoHistorico properties: idDocumento: type: string description: Id do documento tipoHistorico: type: string allOf: – #/definitions/enumTipoHistorico description: Tipo do histórico idRespostaErro: type: string description: Id da Resposta observacao: type: string description: Observação responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /etiquetas/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 /etiquetas/actions/importDocumento: 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 /etiquetas/actions/importNotafiscal: 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 /etiquetas/actions/importVariavel: 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 /etiquetas/actions/importGrupoVariavel: 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 /etiquetas/actions/importVariavelDocumento: 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 /etiquetas/actions/importEtiqueta: 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 /etiquetas/actions/importModeloScript: 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 /etiquetas/actions/importConfiguracoesGerais: 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 /etiquetas/actions/importEtiquetaScript: 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 /etiquetas/actions/importScript: 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 /etiquetas/actions/importHistoricoImpressao: 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 /etiquetas/actions/importResposta: 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 /etiquetas/actions/importLinguagemScript: 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 /etiquetas/events/importDocumentoEvent: 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 /etiquetas/events/exportDocumentoEvent: 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 /etiquetas/events/importNotafiscalEvent: 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 /etiquetas/events/exportNotafiscalEvent: 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 /etiquetas/events/importVariavelEvent: 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 /etiquetas/events/exportVariavelEvent: 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 /etiquetas/events/importGrupoVariavelEvent: 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 /etiquetas/events/exportGrupoVariavelEvent: 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 /etiquetas/events/importVariavelDocumentoEvent: 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 /etiquetas/events/exportVariavelDocumentoEvent: 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 /etiquetas/events/importEtiquetaEvent: 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 /etiquetas/events/exportEtiquetaEvent: 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 /etiquetas/events/importModeloScriptEvent: 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 /etiquetas/events/exportModeloScriptEvent: 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 /etiquetas/events/importConfiguracoesGeraisEvent: 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 /etiquetas/events/exportConfiguracoesGeraisEvent: 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 /etiquetas/events/importEtiquetaScriptEvent: 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 /etiquetas/events/exportEtiquetaScriptEvent: 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 /etiquetas/events/importScriptEvent: 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 /etiquetas/events/exportScriptEvent: 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 /etiquetas/events/importHistoricoImpressaoEvent: 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 /etiquetas/events/exportHistoricoImpressaoEvent: 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 /etiquetas/events/importRespostaEvent: 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 /etiquetas/events/exportRespostaEvent: 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 /etiquetas/events/importLinguagemScriptEvent: 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 /etiquetas/events/exportLinguagemScriptEvent: 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 /etiquetas/entities/documento: 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/documento responses: 200: description: The created resource schema: #/definitions/documento 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/documento responses: 200: description: The created resource schema: #/definitions/documento 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 responses: 200: description: Ok schema: type: array items: #/definitions/documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/documento/{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/documento responses: 200: description: Ok schema: #/definitions/documento 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/documento responses: 200: description: Ok schema: #/definitions/documento 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/documento 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 /etiquetas/entities/documento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/notafiscal: 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/notafiscal responses: 200: description: The created resource schema: #/definitions/notafiscal 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/notafiscal responses: 200: description: The created resource schema: #/definitions/notafiscal 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 responses: 200: description: Ok schema: type: array items: #/definitions/notafiscal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/notafiscal/{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/notafiscal responses: 200: description: Ok schema: #/definitions/notafiscal 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/notafiscal responses: 200: description: Ok schema: #/definitions/notafiscal 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/notafiscal 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 /etiquetas/entities/notafiscal/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/notafiscal responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/variavel: 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/variavel responses: 200: description: The created resource schema: #/definitions/variavel 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/variavel responses: 200: description: The created resource schema: #/definitions/variavel 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 responses: 200: description: Ok schema: type: array items: #/definitions/variavel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/variavel/{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/variavel responses: 200: description: Ok schema: #/definitions/variavel 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/variavel responses: 200: description: Ok schema: #/definitions/variavel 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/variavel 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 /etiquetas/entities/variavel/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/variavel responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/grupoVariavel: 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/grupoVariavel responses: 200: description: The created resource schema: #/definitions/grupoVariavel 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/grupoVariavel responses: 200: description: The created resource schema: #/definitions/grupoVariavel 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 responses: 200: description: Ok schema: type: array items: #/definitions/grupoVariavel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/grupoVariavel/{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/grupoVariavel responses: 200: description: Ok schema: #/definitions/grupoVariavel 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/grupoVariavel responses: 200: description: Ok schema: #/definitions/grupoVariavel 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/grupoVariavel 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 /etiquetas/entities/grupoVariavel/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/grupoVariavel responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/variavelDocumento: 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/variavelDocumento responses: 200: description: The created resource schema: #/definitions/variavelDocumento 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/variavelDocumento responses: 200: description: The created resource schema: #/definitions/variavelDocumento 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 responses: 200: description: Ok schema: type: array items: #/definitions/variavelDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/variavelDocumento/{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/variavelDocumento responses: 200: description: Ok schema: #/definitions/variavelDocumento 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/variavelDocumento responses: 200: description: Ok schema: #/definitions/variavelDocumento 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/variavelDocumento 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 /etiquetas/entities/variavelDocumento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/variavelDocumento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/etiqueta: 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/etiqueta responses: 200: description: The created resource schema: #/definitions/etiqueta 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/etiqueta responses: 200: description: The created resource schema: #/definitions/etiqueta 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 responses: 200: description: Ok schema: type: array items: #/definitions/etiqueta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/etiqueta/{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/etiqueta responses: 200: description: Ok schema: #/definitions/etiqueta 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/etiqueta responses: 200: description: Ok schema: #/definitions/etiqueta 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/etiqueta 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 /etiquetas/entities/etiqueta/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/etiqueta responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/modeloScript: 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/modeloScript responses: 200: description: The created resource schema: #/definitions/modeloScript 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/modeloScript responses: 200: description: The created resource schema: #/definitions/modeloScript 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 responses: 200: description: Ok schema: type: array items: #/definitions/modeloScript 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/modeloScript/{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/modeloScript responses: 200: description: Ok schema: #/definitions/modeloScript 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/modeloScript responses: 200: description: Ok schema: #/definitions/modeloScript 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/modeloScript 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 /etiquetas/entities/modeloScript/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/modeloScript responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/configuracoesGerais: 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/configuracoesGerais responses: 200: description: The created resource schema: #/definitions/configuracoesGerais 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/configuracoesGerais responses: 200: description: The created resource schema: #/definitions/configuracoesGerais 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 responses: 200: description: Ok schema: type: array items: #/definitions/configuracoesGerais 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/configuracoesGerais/{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/configuracoesGerais responses: 200: description: Ok schema: #/definitions/configuracoesGerais 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/configuracoesGerais responses: 200: description: Ok schema: #/definitions/configuracoesGerais 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/configuracoesGerais 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 /etiquetas/entities/configuracoesGerais/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/configuracoesGerais responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/etiquetaScript: 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/etiquetaScript responses: 200: description: The created resource schema: #/definitions/etiquetaScript 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/etiquetaScript responses: 200: description: The created resource schema: #/definitions/etiquetaScript 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 responses: 200: description: Ok schema: type: array items: #/definitions/etiquetaScript 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/etiquetaScript/{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/etiquetaScript responses: 200: description: Ok schema: #/definitions/etiquetaScript 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/etiquetaScript responses: 200: description: Ok schema: #/definitions/etiquetaScript 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/etiquetaScript 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 /etiquetas/entities/etiquetaScript/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/etiquetaScript responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/script: 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/script responses: 200: description: The created resource schema: #/definitions/script 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/script responses: 200: description: The created resource schema: #/definitions/script 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 responses: 200: description: Ok schema: type: array items: #/definitions/script 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/script/{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/script responses: 200: description: Ok schema: #/definitions/script 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/script responses: 200: description: Ok schema: #/definitions/script 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/script 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 /etiquetas/entities/script/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/script responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/historicoImpressao: 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/historicoImpressao responses: 200: description: The created resource schema: #/definitions/historicoImpressao 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/historicoImpressao responses: 200: description: The created resource schema: #/definitions/historicoImpressao 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 responses: 200: description: Ok schema: type: array items: #/definitions/historicoImpressao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/historicoImpressao/{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/historicoImpressao responses: 200: description: Ok schema: #/definitions/historicoImpressao 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/historicoImpressao responses: 200: description: Ok schema: #/definitions/historicoImpressao 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/historicoImpressao 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 /etiquetas/entities/historicoImpressao/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/historicoImpressao responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/resposta: 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/resposta responses: 200: description: The created resource schema: #/definitions/resposta 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/resposta responses: 200: description: The created resource schema: #/definitions/resposta 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 responses: 200: description: Ok schema: type: array items: #/definitions/resposta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/resposta/{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/resposta responses: 200: description: Ok schema: #/definitions/resposta 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/resposta responses: 200: description: Ok schema: #/definitions/resposta 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/resposta 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 /etiquetas/entities/resposta/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/resposta responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/linguagemScript: 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/linguagemScript responses: 200: description: The created resource schema: #/definitions/linguagemScript 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/linguagemScript responses: 200: description: The created resource schema: #/definitions/linguagemScript 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 responses: 200: description: Ok schema: type: array items: #/definitions/linguagemScript 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /etiquetas/entities/linguagemScript/{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/linguagemScript responses: 200: description: Ok schema: #/definitions/linguagemScript 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/linguagemScript responses: 200: description: Ok schema: #/definitions/linguagemScript 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/linguagemScript 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 /etiquetas/entities/linguagemScript/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/linguagemScript responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumStatusEtiqueta: description: Status de etiqueta type: string enum: – CRIADA – PROCESSANDO – AGUARDANDO_IMPRESSAO – IMPRESSO – REIMPRESSO – IMPRESSAO_CANCELADA – ERRO enumTipoEtiqueta: description: Tipo de Etiqueta type: string enum: – VOLUMES enumLinguagem: description: Linguagem type: string enum: – ZPL – DPL – EPL enumTipoDocumento: description: Tipo do documento type: string enum: – NOTAFISCAL – OUTROS enumStatusNf: description: Status da nota fiscal type: string enum: – ATIVA – CANCELADA enumOrigem: description: Origem dos dados da etiqueta type: string enum: – BASE_DADOS – INTEGRACAO enumTipoHistorico: description: Tipo historico Script type: string enum: – CRIADO – SUCESSO – CANCELADO – REIMPRESSO – ERRO – ERRO_IMPRESSAO enumUpDown: description: Up or down type: string enum: – UP – DOWN enumTipoResposta: description: Tipos de Resposta type: string enum: – ERRO_IMPRESSAO enumTypeOrder: description: Enumeração para o tipo de ordenação type: string enum: – ASC – DESC userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR recCheckData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/enumUpDown description: Status do healthcheck recVariaveis: description: Variáveis type: object required: – tag – origem – detalhes properties: tag: type: string description: Tag valor: type: string description: Valor grupoVariavel: type: object allOf: – #/definitions/recGrupoVariavel description: Relacionamento Grupo Variavel origem: type: string allOf: – #/definitions/enumOrigem description: Origem do dado detalhes: type: string description: Detalhes recGrupoVariavel: description: Grupo de variáveis type: object required: – codigo – nome – cor properties: codigo: type: integer format: int64 description: Código nome: type: string description: Nome do Grupo cor: type: string description: Cor recRetornoVariaveisNaoProcessadas: description: Retorno de Variáveis Salvas type: object required: – tag – motivo properties: tag: type: string description: Tag motivo: type: string description: Motivo pra não ter processado recIntervalo: description: Intervalo de impressão type: object required: – sequenciaInicial – sequenciaFinal properties: sequenciaInicial: type: integer format: int64 description: Sequência inicial minimum: 1 sequenciaFinal: type: integer format: int64 description: Sequência final minimum: 1 recRetObterUploadAnexo: description: Retorno Obter UploadAnexo type: object required: – id – url – nome – versao properties: id: type: string description: id unico do arquivo no serviço url: type: string description: URL para upload do arquivo nome: type: string description: nome do arquivo, informado no input versao: type: string description: versão do arquivo criado recSalvarAnexo: description: Salvar Anexo type: object required: – nomeAnexo – versao properties: nomeAnexo: type: string description: nome do arquivo, informado no input versao: type: string description: versão do arquivo criado recRetSalvarAnexo: description: Retorno Salvar Anexo type: object required: – result properties: result: type: string description: Resultado Salvar anexo recEnvArquivoBlobService: description: Informações sobre o acesso ao arquivo type: object required: – chave – tipoArquivo properties: chave: type: string description: Chave do arquivo tipoArquivo: type: string allOf: – #/definitions/enumLinguagem description: Extensão do arquivo recRetArquivoBlobService: description: Informações de retorno do arquivo sobre o blobservice type: object required: – idBlobServiceFile – urlAcesso – nomeArquivo – versao – dataLimiteArquivoDisponivel – arquivoExiste – ok – msgErro properties: idBlobServiceFile: type: string description: id unico do arquivo no serviço urlAcesso: type: string description: URL para realizar o upload/download do arquivo nomeArquivo: type: string description: nome do arquivo versao: type: string description: versão do arquivo criado dataLimiteArquivoDisponivel: type: string format: date-time description: Data limite para acessar realizar o download arquivoExiste: type: boolean description: Indica se o arquivo já existe ok: type: boolean description: Sucesso na operação msgErro: type: string description: Mensagem de erro, caso ocorra recDownloadAnexo: description: Informações da URL para download do anexo type: object required: – nomeAnexo – url properties: nomeAnexo: type: string description: Nome do anexo url: type: string description: URL Download recRetornoResposta: description: Retorno de resposta type: object required: – id – descricao properties: id: type: string description: Identificador descricao: type: string description: Descrição exigeObservacao: type: boolean description: Exige observação? recScriptEtiqueta: description: Etiqueta em um script type: object required: – sequencia – status properties: sequencia: type: integer format: int64 description: Sequência status: type: string allOf: – #/definitions/enumStatusEtiqueta description: Status da Etiqueta recDadosScriptImpressao: description: Dados para gerar o script de impressão type: object properties: intervalosImpressao: type: array items: type: object allOf: – #/definitions/recIntervalo description: Intervalos de Impressão codigoModeloScript: type: string description: Código do modelo de script variaveis: type: array items: type: object allOf: – #/definitions/recVariaveis description: Variáveis recEtiqueta: description: Dados referentes a etiqueta type: object required: – idDocumento – sequenciaVolume – statusEtiqueta properties: idDocumento: type: string description: ID do documento sequenciaVolume: type: integer format: int64 description: Número do volume statusEtiqueta: type: string allOf: – #/definitions/enumStatusEtiqueta description: Status da etiqueta recEtiquetaNotafiscal: description: Dados referentes a etiqueta da nota fiscal type: object required: – idDocumento – remetente – numero – serie – quantidadeVolume – statusEtiquetas properties: idDocumento: type: string description: ID do documento remetente: type: string description: Remetente da nota fiscal numero: type: string description: Número da nota fiscal serie: type: string description: Série da nota fiscal chaveAcesso: type: string description: Chave de acesso da nota fiscal quantidadeVolume: type: integer format: int64 description: Quantidade de volume statusEtiquetas: type: string allOf: – #/definitions/enumStatusEtiqueta description: Status das etiquetas erroProcesso: type: string description: Erro de processamento recScriptEtiquetaDocumento: description: Dados referentes ao script da etiqueta type: object required: – urlDownload properties: idScript: type: string description: ID do script urlDownload: type: string description: URL para download recPageRequest: description: Define a paginação da query type: object required: – offset – size properties: offset: type: integer format: int64 description: Número da página minimum: 0 size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 orderBy: type: array items: type: object allOf: – #/definitions/recFieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados recFieldsOrderBy: description: Define o registro com os dados dos campos à serem ordenados type: object required: – field – order properties: field: type: string description: Nome do campo a ser ordenado order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação do campo (ASC / DESC) documento: description: Documento type: object properties: id: type: string format: uuid description: Chave da tabela quantidadeEtiquetas: type: integer format: int64 description: Quantidade de etiquetas a serem impressas (volumes) ativo: type: boolean description: Ativo default: true tipo: type: string allOf: – #/definitions/enumTipoDocumento description: Tipo do documento statusEtiquetas: type: string allOf: – #/definitions/enumStatusEtiqueta description: Status das etiquetas erroProcesso: type: string description: Erro de processamento dataCriacaoScript: type: string format: date-time description: Data da criação do script usuarioCriacaoScript: type: string description: Usuário que criou o script createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notafiscal: description: Nota Fiscal type: object required: – remetente – serie – numero properties: id: type: string format: uuid description: Chave da tabela remetente: type: string description: Remetente descricaoRemetente: type: string description: Descrição – Remetente serie: type: string description: Série numero: type: string description: Numero chaveAcesso: type: string description: Chave de acesso documento: type: object allOf: – #/definitions/documento description: Documento status: type: string allOf: – #/definitions/enumStatusNf description: Status createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: variavel: description: Variavel type: object required: – tag – descricao – grupoVariavel – origem – detalhes properties: id: type: string format: uuid description: Chave da tabela tag: type: string description: Tag descricao: type: string description: Descrição grupoVariavel: type: object allOf: – #/definitions/grupoVariavel description: Relacionamento Grupo Variavel origem: type: string allOf: – #/definitions/enumOrigem description: Origem do dado detalhes: type: string description: Detalhes createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: grupoVariavel: description: Grupo Variavel type: object required: – codigo – nome – cor properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código nome: type: string description: Nome do Grupo cor: type: string description: Cor createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: variavelDocumento: description: Variável x Documento type: object required: – documento – variavel – valor properties: id: type: string format: uuid description: Chave da tabela documento: type: object allOf: – #/definitions/documento description: Documento variavel: type: object allOf: – #/definitions/variavel description: Variavel valor: type: string description: Valor createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: etiqueta: description: Etiqueta type: object required: – sequencia – documento properties: id: type: string format: uuid description: Chave da tabela sequencia: type: integer format: int64 description: Sequância documento: type: object allOf: – #/definitions/documento description: Documento status: type: string allOf: – #/definitions/enumStatusEtiqueta description: Status da Etiqueta createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: modeloScript: description: Modelo Script type: object required: – codigo – linguagem – descricao – scriptVariaveis – tipoEtiqueta properties: id: type: string format: uuid description: Chave da tabela codigo: type: string description: Código linguagem: type: string allOf: – #/definitions/enumLinguagem description: Linguagem descricao: type: string description: Descrição tempreatura: type: integer format: int64 description: Temperatura distanciaCorte: type: integer format: int64 description: Distância de corte posicaoInicialLinha: type: integer format: int64 description: Posição inicial (linha) posicaoInicialColuna: type: integer format: int64 description: Posição inicial (coluna) observacao: type: string description: Observação scriptVariaveis: type: string description: Script contendo as variáveis a serem substituídas tipoEtiqueta: type: string allOf: – #/definitions/enumTipoEtiqueta description: Tipo de etiqueta ativo: type: boolean description: Ativo default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: configuracoesGerais: description: Configurações Gerais type: object required: – modeloScript properties: id: type: string format: uuid description: Chave da tabela modeloScript: type: object allOf: – #/definitions/modeloScript description: Script padrão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: etiquetaScript: description: Etiqueta type: object required: – script – etiqueta properties: id: type: string format: uuid description: Chave da tabela script: type: object allOf: – #/definitions/script description: Código do Script etiqueta: type: object allOf: – #/definitions/etiqueta description: Etiqueta createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: script: description: Script type: object required: – idBlob – status – jsonSequencia properties: id: type: string format: uuid description: Chave da tabela idBlob: type: string description: Id Blob Service status: type: string allOf: – #/definitions/enumStatusEtiqueta description: Status do script (mesmo da etiqueta) jsonSequencia: type: string description: Json da Sequência impressa modeloScript: type: object allOf: – #/definitions/modeloScript description: Modelo utilizado para criar o script createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: historicoImpressao: description: Historico Script type: object required: – etiquetaScript – tipoHistorico properties: id: type: string format: uuid description: Chave da tabela etiquetaScript: type: object allOf: – #/definitions/etiquetaScript description: Id Script tipoHistorico: type: string allOf: – #/definitions/enumTipoHistorico description: Tipo do Histórico respostaErro: type: object allOf: – #/definitions/resposta description: Resposta para Erro observacao: type: string description: Observação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: resposta: description: Resposta type: object required: – descricao – tipo properties: id: type: string format: uuid description: Chave da tabela descricao: type: string description: Descrição exigeObservacao: type: boolean description: Exibe Observação? tipo: type: string allOf: – #/definitions/enumTipoResposta description: Tipo de Resposta createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: linguagemScript: description: Definições da linguagem do script type: object required: – tipoLinguagem properties: id: type: string format: uuid description: Chave da tabela tipoLinguagem: type: string allOf: – #/definitions/enumLinguagem description: Tipo de linguagem padraoNovoScript: type: string description: Padrão para o cadastro de novos scripts createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE