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

foundation

12 views 0 09/11/2026 integrador

2.0info: 3.2.0 foundation description: foundation x-senior-domain: edocsx_common x-senior-domain-path: edocsx_common x-senior-service-path: foundation 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/edocsx_commonsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /foundation/queries/helloWorld: post: description: Primitiva de exemplo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – helloWorldMessage properties: helloWorldMessage: type: string description: Retorno da primitiva 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva de exemplo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – helloWorldMessage properties: helloWorldMessage: type: string description: Retorno da primitiva 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/queries/getUrlById: post: description: Retorna uma URL pelo ID tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string maxLength: 255 description: Identificação unica do registro responses: 200: description: Ok schema: type: object allOf: – #/definitions/urlShared 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma URL pelo ID tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificação unica do registro in: query required: true type: string maxLength: 255 responses: 200: description: Ok schema: type: object allOf: – #/definitions/urlShared 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/queries/getUrls: post: description: Lista URLs com paginação, filtros e ordenação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getUrlsInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/getUrlsOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista URLs com paginação, filtros e ordenação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documentType description: Filtro por tipo de documento in: query type: string maxLength: 255 – name: urlType description: Filtro por tipo de URL in: query type: string maxLength: 255 – name: environmentType description: Filtro por ambiente in: query type: string allOf: – #/definitions/environmentType – name: ibgeStateCode description: Filtro por código IBGE do estado in: query type: integer format: int64 – name: url description: Filtro por texto da URL (busca parcial, case insensitive) in: query type: string – name: offset description: Deslocamento para paginação in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 – name: orderBy description: Campo para ordenação (url, documentType, urlType, environmentType, ibgeStateCode, createdDate) in: query type: string – name: orderDirection description: Direção da ordenação (ASC, DESC) in: query type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/getUrlsOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/queries/getUrlByParams: post: description: Busca uma URL específica pelos parâmetros obrigatórios tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getUrlByParamsInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/urlShared 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca uma URL específica pelos parâmetros obrigatórios tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documentType description: Tipo de documento in: query required: true type: string maxLength: 255 – name: urlType description: Tipo de URL in: query required: true type: string maxLength: 255 – name: environmentType description: Tipo de aplicação do ambiente in: query required: true type: string allOf: – #/definitions/environmentType – name: ibgeStateCode description: Código IBGE do estado in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object allOf: – #/definitions/urlShared 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/queries/getTechnicalResponsibleByParams: post: description: Busca o CSRT (Responsável Técnico) por UF e ambiente (uso serviço a serviço) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ibgeStateCode – environmentType properties: ibgeStateCode: type: integer format: int64 description: Código IBGE do estado environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de aplicação do ambiente responses: 200: description: Ok schema: type: object allOf: – #/definitions/technicalResponsibleCsrt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca o CSRT (Responsável Técnico) por UF e ambiente (uso serviço a serviço) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ibgeStateCode description: Código IBGE do estado in: query required: true type: integer format: int64 – name: environmentType description: Tipo de aplicação do ambiente in: query required: true type: string allOf: – #/definitions/environmentType responses: 200: description: Ok schema: type: object allOf: – #/definitions/technicalResponsibleCsrt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/queries/findUrl: post: description: Busca uma URL pelos parâmetros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – environmentType – documentType – urlType – ibgeStateCode properties: environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente documentType: type: string maxLength: 255 description: Tipo de documento documentVersion: type: string maxLength: 255 description: Versão do documento urlType: type: string maxLength: 255 description: Tipo de URL ibgeStateCode: type: integer format: int64 description: Código IBGE do estado responses: 200: description: Ok schema: type: object allOf: – #/definitions/urlShared 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca uma URL pelos parâmetros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: environmentType description: Tipo de ambiente in: query required: true type: string allOf: – #/definitions/environmentType – name: documentType description: Tipo de documento in: query required: true type: string maxLength: 255 – name: documentVersion description: Versão do documento in: query type: string maxLength: 255 – name: urlType description: Tipo de URL in: query required: true type: string maxLength: 255 – name: ibgeStateCode description: Código IBGE do estado in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object allOf: – #/definitions/urlShared 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/queries/listXsdFiles: post: description: Lista arquivos XSD com paginação e filtros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/listXsdFilesInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/listXsdFilesOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista arquivos XSD com paginação e filtros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fileName description: Filtro por nome do arquivo in: query type: string maxLength: 500 – name: offset description: Deslocamento para paginação in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 – name: orderBy description: Campo para ordenação (fileName, description, createdDate) in: query type: string maxLength: 255 – name: orderDirection description: Direção da ordenação (ASC, DESC) in: query type: string maxLength: 10 responses: 200: description: Ok schema: type: object allOf: – #/definitions/listXsdFilesOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/queries/getXsdFileContent: post: description: Obtém o conteúdo de um arquivo XSD tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getXsdFileContentInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/getXsdFileContentOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o conteúdo de um arquivo XSD tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificação única do arquivo in: query required: true type: string maxLength: 255 responses: 200: description: Ok schema: type: object allOf: – #/definitions/getXsdFileContentOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/queries/listXsdPackages: post: description: Lista pacotes XSD com paginação e filtros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/listXsdPackagesInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/listXsdPackagesOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista pacotes XSD com paginação e filtros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documentType description: Filtro por tipo de documento in: query type: string allOf: – #/definitions/xsdDocumentType – name: operationType description: Filtro por tipo de operação in: query type: string allOf: – #/definitions/xsdOperationType – name: description description: Filtro por descrição in: query type: string maxLength: 1000 – name: offset description: Deslocamento para paginação in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 – name: orderBy description: Campo para ordenação (documentType, operationType, environmentType, versionNumber, description, active, createdDate) in: query type: string maxLength: 255 – name: orderDirection description: Direção da ordenação (ASC, DESC) in: query type: string maxLength: 10 responses: 200: description: Ok schema: type: object allOf: – #/definitions/listXsdPackagesOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/queries/listXsdPackageCompositions: post: description: Lista composições de um pacote XSD tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/listXsdPackageCompositionsInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/listXsdPackageCompositionsOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista composições de um pacote XSD tags: – Queries x-senior-visibility: PRIVATE parameters: – name: packageId description: ID do pacote XSD in: query required: true type: string maxLength: 255 – name: offset description: Deslocamento para paginação in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 – name: orderBy description: Campo para ordenação (fileName, createdDate) in: query type: string maxLength: 255 – name: orderDirection description: Direção da ordenação (ASC, DESC) in: query type: string maxLength: 10 responses: 200: description: Ok schema: type: object allOf: – #/definitions/listXsdPackageCompositionsOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/queries/getXsdFilesByDocumentType: post: description: Retorna todos os arquivos XSD do pacote ativo para um tipo de documento e ambiente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getXsdFilesByDocumentTypeInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/getXsdFilesByDocumentTypeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna todos os arquivos XSD do pacote ativo para um tipo de documento e ambiente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documentType description: Tipo de documento XSD in: query required: true type: string allOf: – #/definitions/xsdDocumentType – name: environmentType description: Tipo de ambiente in: query required: true type: string allOf: – #/definitions/xsdEnvironmentType responses: 200: description: Ok schema: type: object allOf: – #/definitions/getXsdFilesByDocumentTypeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/queries/getReceitaIntegraCredentials: post: description: Obtem as credenciais Receita Integra configuradas para uma empresa ou filial (uso da tela, secret nao e retornado) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getReceitaIntegraCredentialsInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/getReceitaIntegraCredentialsOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtem as credenciais Receita Integra configuradas para uma empresa ou filial (uso da tela, secret nao e retornado) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: e070empId description: Identificador da empresa (e070emp). Opcional quando e070filId e informado. in: query type: string maxLength: 255 – name: e070filId description: Identificador da filial (e070fil). Nulo para obter as da empresa. in: query type: string maxLength: 255 responses: 200: description: Ok schema: type: object allOf: – #/definitions/getReceitaIntegraCredentialsOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/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 /foundation/queries/exportE070empReceitaIntegraCredentials: 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 /foundation/queries/exportE070filReceitaIntegraCredentials: 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 /foundation/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 /foundation/actions/createUrl: post: description: Realiza o cadastro de uma nova URL tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/createUrlRecord responses: 200: description: Ok schema: type: object allOf: – #/definitions/urlShared 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/actions/updateUrl: post: description: Atualiza uma URL tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/updateUrlRecord responses: 200: description: Ok schema: type: object allOf: – #/definitions/urlShared 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/actions/deleteUrl: post: description: Deleta uma URL tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – token properties: id: type: string maxLength: 255 description: Identificação unica do registro token: type: string maxLength: 255 description: Token de autorização responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/actions/createXsdFile: post: description: Cria um novo arquivo XSD tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/createXsdFileInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/xsdFileRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/actions/createXsdFilesFromZip: post: description: Cria múltiplos arquivos XSD a partir de um ZIP tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/createXsdFilesFromZipInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/createXsdFilesFromZipOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/actions/deleteXsdFile: post: description: Deleta um arquivo XSD tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – token properties: id: type: string maxLength: 255 description: Identificação única do registro token: type: string maxLength: 255 description: Token de autorização responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/actions/createXsdPackage: post: description: Cria um novo pacote XSD tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/createXsdPackageInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/xsdPackageRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/actions/updateXsdPackage: post: description: Atualiza um pacote XSD tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/updateXsdPackageInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/xsdPackageRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/actions/deleteXsdPackage: post: description: Deleta um pacote XSD tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – token properties: id: type: string maxLength: 255 description: Identificação única do registro token: type: string maxLength: 255 description: Token de autorização responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/actions/cloneXsdPackage: post: description: Clona um pacote XSD gerando nova versão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/cloneXsdPackageInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/cloneXsdPackageOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/actions/createXsdPackageComposition: post: description: Cria composições de pacote XSD (vincula arquivos ao pacote) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/createXsdPackageCompositionInput responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/actions/deleteXsdPackageComposition: post: description: Deleta uma composição de pacote XSD tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – token properties: id: type: string maxLength: 255 description: Identificação única do registro token: type: string maxLength: 255 description: Token de autorização responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/actions/saveReceitaIntegraCredentials: post: description: Salva (cria ou atualiza) as credenciais Receita Integra de uma empresa ou filial tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/saveReceitaIntegraCredentialsInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/receitaIntegraCredentialsRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/actions/deleteReceitaIntegraCredentials: post: description: Remove as credenciais Receita Integra de uma empresa ou filial tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – e070empId properties: e070empId: type: string maxLength: 255 description: Identificador da empresa (e070emp) e070filId: type: string maxLength: 255 description: Identificador da filial (e070fil). Nulo para remover as da empresa. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/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 /foundation/actions/importE070empReceitaIntegraCredentials: 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 /foundation/actions/importE070filReceitaIntegraCredentials: 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 /foundation/events/urlChanged: post: description: Notifica a alteração de uma URL para invalidação de cache x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – environmentChanged properties: environmentChanged: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente alterado responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation/events/xsdChanged: post: description: Notifica a alteração de um pacote XSD para invalidação de cache x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – environmentChanged properties: environmentChanged: type: string allOf: – #/definitions/xsdEnvironmentType description: Tipo de ambiente do pacote XSD alterado responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation/events/dereXsdChanged: post: description: Notifica a alteração de um pacote XSD do tipo DERE para invalidação de cache direcionada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – environmentChanged properties: environmentChanged: type: string allOf: – #/definitions/xsdEnvironmentType description: Tipo de ambiente do pacote XSD DERE alterado responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation/events/credentialsChanged: post: description: Notifica a alteração (criação, atualização ou remoção) das credenciais Receita Integra de uma empresa ou filial, para invalidação de cache e token x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – e070empId properties: e070empId: type: string maxLength: 255 description: Identificador da empresa (e070emp) cuja credencial foi alterada e070filId: type: string maxLength: 255 description: Identificador da filial (e070fil) cuja credencial foi alterada; nulo quando a alteração é da empresa responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation/events/importE070empReceitaIntegraCredentialsEvent: 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 /foundation/events/exportE070empReceitaIntegraCredentialsEvent: 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 /foundation/events/importE070filReceitaIntegraCredentialsEvent: 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 /foundation/events/exportE070filReceitaIntegraCredentialsEvent: 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 /foundation/entities/e070empReceitaIntegraCredentials: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070empReceitaIntegraCredentials 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/entities/e070empReceitaIntegraCredentials/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070empReceitaIntegraCredentials 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/entities/e070filReceitaIntegraCredentials: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070filReceitaIntegraCredentials 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/entities/e070filReceitaIntegraCredentials/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070filReceitaIntegraCredentials 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down environmentType: type: string enum: – PROD – HOMOLOG – DISABLED – MOCK description: Tipo de aplicação do ambiente: * `PROD` – Produção * `HOMOLOG` – Homolog * `DISABLED` – Desativado * `MOCK` – Utilizado para mockar urls em ambiente de desenvolvimento communicationType: type: string enum: – SOAP – REST description: Tipo de comunicação utilizado pela URL: * `SOAP` – Comunicação via SOAP * `REST` – Comunicação via REST restVerb: type: string enum: – GET – POST – DELETE description: Verbo HTTP utilizado em comunicações REST: * `GET` – HTTP GET * `POST` – HTTP POST * `DELETE` – HTTP DELETE xsdDocumentType: type: string enum: – NFE – CTE – NFEABI – DERE description: Tipo de documento XSD: * `NFE` – NFe * `CTE` – CTe * `NFEABI` – NFeABI * `DERE` – DeRe xsdOperationType: type: string enum: – AUTHORIZATION – NULLIFICATION – CANCELLATION – CORRECTION_LETTER description: Tipo de operação XSD: * `AUTHORIZATION` – Autorização * `NULLIFICATION` – Inutilização * `CANCELLATION` – Cancelamento * `CORRECTION_LETTER` – Carta de correção xsdEnvironmentType: type: string enum: – PROD – HOMOLOG description: Tipo de ambiente XSD: * `PROD` – Produção * `HOMOLOG` – Homologação userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck createUrlRecord: description: Modelo requisitado para criação de uma nova URL type: object required: – url – documentType – urlType – documentVersion – ibgeStateCode – environmentType – communicationType – token properties: url: type: string maxLength: 255 description: URL documentType: type: string maxLength: 255 description: Tipo do documento urlType: type: string maxLength: 255 description: Tipo de URL documentVersion: type: string maxLength: 255 description: Versão do documento ibgeStateCode: type: integer format: int64 description: Código IBGE do estado environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de aplicação do ambiente communicationType: type: string allOf: – #/definitions/communicationType description: Tipo de comunicação (SOAP ou REST) restVerb: type: string allOf: – #/definitions/restVerb description: Verbo HTTP utilizado em comunicações REST soapAction: type: string maxLength: 255 description: Soap Action utilizada pelo envio dinâmico token: type: string maxLength: 255 description: Token de autorização updateUrlRecord: description: Modelo requisitado para atualização de uma URL type: object required: – id – url – documentType – urlType – documentVersion – ibgeStateCode – environmentType – communicationType – token properties: id: type: string maxLength: 255 description: identificação única do registro url: type: string maxLength: 255 description: URL documentType: type: string maxLength: 255 description: Tipo do documento urlType: type: string maxLength: 255 description: Tipo de URL documentVersion: type: string maxLength: 255 description: Versão do documento ibgeStateCode: type: integer format: int64 description: Código IBGE do estado environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de aplicação do ambiente communicationType: type: string allOf: – #/definitions/communicationType description: Tipo de comunicação (SOAP ou REST) restVerb: type: string allOf: – #/definitions/restVerb description: Verbo HTTP utilizado em comunicações REST soapAction: type: string maxLength: 255 description: Soap Action utilizada pelo envio dinâmico token: type: string maxLength: 255 description: Token de autorização urlShared: description: URL compartilhada type: object required: – id – url – documentType – urlType – documentVersion – ibgeStateCode – environmentType – communicationType properties: id: type: string maxLength: 255 description: identificação única do registro url: type: string maxLength: 255 description: URL documentType: type: string maxLength: 255 description: Tipo do documento urlType: type: string maxLength: 255 description: Tipo de URL documentVersion: type: string maxLength: 255 description: Versão do documento ibgeStateCode: type: integer format: int64 description: Código IBGE do estado environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de aplicação do ambiente communicationType: type: string allOf: – #/definitions/communicationType description: Tipo de comunicação (SOAP ou REST) restVerb: type: string allOf: – #/definitions/restVerb description: Verbo HTTP utilizado em comunicações REST soapAction: type: string maxLength: 255 description: Soap Action utilizada pelo envio dinâmico getUrlsInput: description: Filtros para listagem de URLs type: object properties: documentType: type: string maxLength: 255 description: Filtro por tipo de documento urlType: type: string maxLength: 255 description: Filtro por tipo de URL environmentType: type: string allOf: – #/definitions/environmentType description: Filtro por ambiente ibgeStateCode: type: integer format: int64 description: Filtro por código IBGE do estado url: type: string description: Filtro por texto da URL (busca parcial, case insensitive) offset: type: integer format: int64 description: Deslocamento para paginação size: type: integer format: int64 description: Tamanho da página orderBy: type: string description: Campo para ordenação (url, documentType, urlType, environmentType, ibgeStateCode, createdDate) orderDirection: type: string description: Direção da ordenação (ASC, DESC) getUrlsOutput: description: Retorno paginado de URLs type: object required: – totalElements – totalPages – content properties: totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas content: type: array items: type: object allOf: – #/definitions/urlShared minimum: 1 description: Conteúdo da página getUrlByParamsInput: description: Parâmetros obrigatórios para busca de URL type: object required: – documentType – urlType – environmentType – ibgeStateCode properties: documentType: type: string maxLength: 255 description: Tipo de documento urlType: type: string maxLength: 255 description: Tipo de URL environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de aplicação do ambiente ibgeStateCode: type: integer format: int64 description: Código IBGE do estado technicalResponsibleCsrt: description: Dados do CSRT (Código de Segurança do Responsável Técnico) de uma UF e ambiente type: object required: – idCsrt – codeCsrt properties: idCsrt: type: string maxLength: 2 description: Identificador do CSRT codeCsrt: type: string maxLength: 36 description: Código do CSRT (sigiloso) createXsdFileInput: description: Modelo para criação de arquivo XSD type: object required: – fileContent – fileName – token properties: fileContent: type: string description: Conteúdo do arquivo em Base64 fileName: type: string maxLength: 500 description: Nome do arquivo description: type: string maxLength: 1000 description: Descrição do arquivo (NT Sefaz) token: type: string maxLength: 255 description: Token de autorização xsdFileRecord: description: Modelo de retorno do arquivo XSD type: object required: – id – fileName properties: id: type: string maxLength: 255 description: Identificação única fileName: type: string maxLength: 500 description: Nome do arquivo description: type: string maxLength: 1000 description: Descrição do arquivo (NT Sefaz) createdDate: type: string description: Data de criação createXsdFilesFromZipInput: description: Modelo para upload de arquivo ZIP com múltiplos XSDs type: object required: – zipContent – zipFileName – token properties: zipContent: type: string description: Conteúdo do arquivo ZIP em Base64 zipFileName: type: string maxLength: 500 description: Nome do arquivo ZIP (será usado como descrição) token: type: string maxLength: 255 description: Token de autorização createXsdFilesFromZipOutput: description: Retorno do upload de ZIP type: object required: – fileIds properties: fileIds: type: array items: type: string minimum: 1 description: Lista de IDs dos arquivos criados listXsdFilesInput: description: Filtros para listagem de arquivos XSD type: object properties: fileName: type: string maxLength: 500 description: Filtro por nome do arquivo offset: type: integer format: int64 description: Deslocamento para paginação size: type: integer format: int64 description: Tamanho da página orderBy: type: string maxLength: 255 description: Campo para ordenação (fileName, description, createdDate) orderDirection: type: string maxLength: 10 description: Direção da ordenação (ASC, DESC) listXsdFilesOutput: description: Retorno paginado de arquivos XSD type: object required: – totalElements – totalPages – content properties: totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas content: type: array items: type: object allOf: – #/definitions/xsdFileRecord minimum: 1 description: Conteúdo da página getXsdFileContentInput: description: Parâmetros para obter conteúdo de arquivo XSD type: object required: – id properties: id: type: string maxLength: 255 description: Identificação única do arquivo getXsdFileContentOutput: description: Retorno do conteúdo de arquivo XSD type: object required: – fileContent – fileName properties: fileContent: type: string description: Conteúdo do arquivo em Base64 fileName: type: string maxLength: 500 description: Nome do arquivo description: type: string maxLength: 1000 description: Descrição do arquivo (NT Sefaz) createXsdPackageInput: description: Modelo para criação de pacote XSD type: object required: – documentType – operationType – environmentType – token properties: documentType: type: string allOf: – #/definitions/xsdDocumentType description: Tipo de documento operationType: type: string allOf: – #/definitions/xsdOperationType description: Tipo de operação environmentType: type: string allOf: – #/definitions/xsdEnvironmentType description: Tipo de ambiente description: type: string maxLength: 1000 description: Descrição do pacote token: type: string maxLength: 255 description: Token de autorização updateXsdPackageInput: description: Modelo para atualização de pacote XSD type: object required: – id – token properties: id: type: string maxLength: 255 description: Identificação única environmentType: type: string allOf: – #/definitions/xsdEnvironmentType description: Tipo de ambiente active: type: boolean description: Flag de ativação token: type: string maxLength: 255 description: Token de autorização xsdPackageRecord: description: Modelo de retorno do pacote XSD type: object required: – id – documentType – operationType – environmentType – versionNumber – active properties: id: type: string maxLength: 255 description: Identificação única documentType: type: string allOf: – #/definitions/xsdDocumentType description: Tipo de documento operationType: type: string allOf: – #/definitions/xsdOperationType description: Tipo de operação environmentType: type: string allOf: – #/definitions/xsdEnvironmentType description: Tipo de ambiente versionNumber: type: integer format: int64 description: Número da versão active: type: boolean description: Flag de ativação description: type: string maxLength: 1000 description: Descrição do pacote createdDate: type: string description: Data de criação listXsdPackagesInput: description: Filtros para listagem de pacotes XSD type: object properties: documentType: type: string allOf: – #/definitions/xsdDocumentType description: Filtro por tipo de documento operationType: type: string allOf: – #/definitions/xsdOperationType description: Filtro por tipo de operação description: type: string maxLength: 1000 description: Filtro por descrição offset: type: integer format: int64 description: Deslocamento para paginação size: type: integer format: int64 description: Tamanho da página orderBy: type: string maxLength: 255 description: Campo para ordenação (documentType, operationType, environmentType, versionNumber, description, active, createdDate) orderDirection: type: string maxLength: 10 description: Direção da ordenação (ASC, DESC) listXsdPackagesOutput: description: Retorno paginado de pacotes XSD type: object required: – totalElements – totalPages – content properties: totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas content: type: array items: type: object allOf: – #/definitions/xsdPackageRecord minimum: 1 description: Conteúdo da página cloneXsdPackageInput: description: Modelo para clonagem de pacote XSD type: object required: – sourcePackageId – targetEnvironmentType – token properties: sourcePackageId: type: string maxLength: 255 description: ID do pacote de origem targetEnvironmentType: type: string allOf: – #/definitions/xsdEnvironmentType description: Ambiente de destino token: type: string maxLength: 255 description: Token de autorização cloneXsdPackageOutput: description: Retorno da clonagem de pacote XSD type: object required: – newPackageId properties: newPackageId: type: string maxLength: 255 description: ID do novo pacote criado createXsdPackageCompositionInput: description: Modelo para criação de composição de pacote XSD type: object required: – packageId – fileIds – token properties: packageId: type: string maxLength: 255 description: ID do pacote XSD fileIds: type: array items: type: string minimum: 1 description: Lista de IDs dos arquivos XSD token: type: string maxLength: 255 description: Token de autorização xsdPackageCompositionRecord: description: Modelo de retorno da composição type: object required: – id – packageId – fileId properties: id: type: string maxLength: 255 description: Identificação única packageId: type: string maxLength: 255 description: ID do pacote XSD fileId: type: string maxLength: 255 description: ID do arquivo XSD fileName: type: string maxLength: 500 description: Nome do arquivo XSD createdDate: type: string description: Data de criação listXsdPackageCompositionsInput: description: Filtros para listagem de composições type: object required: – packageId properties: packageId: type: string maxLength: 255 description: ID do pacote XSD offset: type: integer format: int64 description: Deslocamento para paginação size: type: integer format: int64 description: Tamanho da página orderBy: type: string maxLength: 255 description: Campo para ordenação (fileName, createdDate) orderDirection: type: string maxLength: 10 description: Direção da ordenação (ASC, DESC) listXsdPackageCompositionsOutput: description: Retorno paginado de composições type: object required: – totalElements – totalPages – content properties: totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas content: type: array items: type: object allOf: – #/definitions/xsdPackageCompositionRecord minimum: 1 description: Conteúdo da página getXsdFilesByDocumentTypeInput: description: Input para consulta batch de arquivos XSD por tipo de documento type: object required: – documentType – environmentType properties: documentType: type: string allOf: – #/definitions/xsdDocumentType description: Tipo de documento XSD environmentType: type: string allOf: – #/definitions/xsdEnvironmentType description: Tipo de ambiente getXsdFilesByDocumentTypeOutput: description: Output da consulta batch de arquivos XSD type: object required: – files properties: files: type: array items: type: object allOf: – #/definitions/xsdFileContentRecord minimum: 1 description: Lista de arquivos XSD com conteúdo xsdFileContentRecord: description: Registro de arquivo XSD com conteúdo type: object required: – fileName – fileContent properties: fileName: type: string maxLength: 500 description: Nome do arquivo fileContent: type: string description: Conteúdo do arquivo em Base64 saveReceitaIntegraCredentialsInput: description: Dados para salvar as credenciais Receita Integra de uma empresa ou filial type: object required: – e070empId – clientId – clientSecret properties: id: type: string maxLength: 255 description: Identificacao unica do registro (informar para atualizar; nulo para criar) e070empId: type: string maxLength: 255 description: Identificador da empresa (e070emp) e070filId: type: string maxLength: 255 description: Identificador da filial (e070fil). Nulo quando a credencial e da empresa. clientId: type: string maxLength: 255 description: Client ID gerado pelo portal da Receita Federal clientSecret: type: string maxLength: 255 description: Client Secret gerado pelo portal da Receita Federal receitaIntegraCredentialsRecord: description: Registro de credenciais Receita Integra (sem o secret em claro) type: object required: – id – e070empId – clientId – hasClientSecret properties: id: type: string maxLength: 255 description: Identificacao unica do registro e070empId: type: string maxLength: 255 description: Identificador da empresa (e070emp) e070filId: type: string maxLength: 255 description: Identificador da filial (e070fil) clientId: type: string maxLength: 255 description: Client ID gerado pelo portal da Receita Federal hasClientSecret: type: boolean description: Indica se ha um client secret configurado getReceitaIntegraCredentialsInput: description: Parametros para obter as credenciais Receita Integra de uma empresa ou filial. Informe e070empId (empresa), e070filId (filial), ou ambos (filial com fallback para empresa). type: object properties: e070empId: type: string maxLength: 255 description: Identificador da empresa (e070emp). Opcional quando e070filId e informado. e070filId: type: string maxLength: 255 description: Identificador da filial (e070fil). Nulo para obter as da empresa. getReceitaIntegraCredentialsOutput: description: Retorno da consulta de credenciais Receita Integra (sem o secret em claro) type: object properties: credentials: type: object allOf: – #/definitions/receitaIntegraCredentialsRecord description: Credenciais configuradas (nulo quando nao ha configuracao) e070empReceitaIntegraCredentials: description: Credenciais Receita Integra configuradas por empresa. O id e compartilhado com a e070emp. type: object required: – clientId – clientSecret properties: id: type: string format: uuid description: Identificacao unica do registro (igual ao id da empresa) clientId: type: string maxLength: 255 description: Client ID gerado pelo portal da Receita Federal clientSecret: type: string maxLength: 1024 description: Client Secret gerado pelo portal da Receita Federal (armazenado em Base64) usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070filReceitaIntegraCredentials: description: Credenciais Receita Integra configuradas por filial. O id e compartilhado com a e070fil. type: object required: – clientId – clientSecret properties: id: type: string format: uuid description: Identificacao unica do registro (igual ao id da filial) clientId: type: string maxLength: 255 description: Client ID gerado pelo portal da Receita Federal clientSecret: type: string maxLength: 1024 description: Client Secret gerado pelo portal da Receita Federal (armazenado em Base64) usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: 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 enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage

Este artigo foi útil para você?

Sim  Não
Leave A Comment Cancelar resposta

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

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