Mais pesquisados:Customização, Tutorial, Documentação

sped

39 views 0 09/07/2020 Atualizado em 31/07/2024 integrador

2.0info: 4.7.0 sped description: Sped x-senior-domain: erpx_cpl x-senior-domain-path: erpx_cpl x-senior-service-path: sped 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/erpx_cplsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /sped/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 /sped/queries/obterArquivoSped: post: description: Retorna uma URL para download do arquivo Sped gerado. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Ticket de geração do arquivo Sped responses: 200: description: Ok schema: type: object properties: urlArquivo: type: string description: Url para download do arquivo texto do SPED gerado. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma URL para download do arquivo Sped gerado. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ticket description: Ticket de geração do arquivo Sped in: query required: true type: string responses: 200: description: Ok schema: type: object properties: urlArquivo: type: string description: Url para download do arquivo texto do SPED gerado. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/queries/obterGeracaoArquivoSpedStatus: post: description: Permite obter a situação da geração de multiplos arquivos de SPED através dos seus respectivos tickets de geração. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tickets properties: tickets: type: array items: type: string minimum: 1 description: Lista com os tickets de geração. responses: 200: description: Ok schema: type: object required: – geracaoSpedStatusResult properties: geracaoSpedStatusResult: type: array items: type: object allOf: – #/definitions/geracaoSpedStatusResult minimum: 1 description: Lista com a situação dos tickets passados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Permite obter a situação da geração de multiplos arquivos de SPED através dos seus respectivos tickets de geração. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tickets description: Lista com os tickets de geração. in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – geracaoSpedStatusResult properties: geracaoSpedStatusResult: type: array items: type: object allOf: – #/definitions/geracaoSpedStatusResult minimum: 1 description: Lista com a situação dos tickets passados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/queries/obterLeiautesComSugestao: post: description: Sugere o último leiaute executado conforme os parâmetros passados.\nTambém retorna a lista de leiautes disponível.\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – filial – dataInicial – dataFinal properties: empresa: type: string description: Empresa filial: type: string description: Filial dataInicial: type: string format: date description: Data inicial dataFinal: type: string format: date description: Data final responses: 200: description: Ok schema: type: object required: – leiautes properties: sugestao: type: object allOf: – #/definitions/recGeracaoArquivoSped description: Sugestão de parâmetros de geração de um arquivo do SPED leiautes: type: array items: type: object allOf: – #/definitions/recLeiaute minimum: 1 description: Árvore de leiautes disponíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Sugere o último leiaute executado conforme os parâmetros passados.\nTambém retorna a lista de leiautes disponível.\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa description: Empresa in: query required: true type: string – name: filial description: Filial in: query required: true type: string – name: dataInicial description: Data inicial in: query required: true type: string format: date – name: dataFinal description: Data final in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – leiautes properties: sugestao: type: object allOf: – #/definitions/recGeracaoArquivoSped description: Sugestão de parâmetros de geração de um arquivo do SPED leiautes: type: array items: type: object allOf: – #/definitions/recLeiaute minimum: 1 description: Árvore de leiautes disponíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/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 /sped/queries/exportEmpresa: 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 /sped/queries/exportFilial: 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 /sped/queries/exportGeracaoSped: 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 /sped/queries/exportGeracaoSpedParams: 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 /sped/queries/exportLeiaute: 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 /sped/queries/exportLeiauteRegistro: 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 /sped/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 /sped/actions/reprocessarArquivosSped: post: description: Permite reprocessar uma lista de arquivos do SPED. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tickets properties: tickets: type: array items: type: string minimum: 1 description: Lista com os tickets a serem reprocessados. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/actions/gerarArquivoSped: post: description: Gerar o arquivo do SPED tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – recArquivoSped properties: recArquivoSped: type: object allOf: – #/definitions/recGeracaoArquivoSped description: Parâmetros de geração de um arquivo do SPED responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: Identificador do processo de geração do arquivo do SPED. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/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 /sped/actions/importEmpresa: 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 /sped/actions/importFilial: 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 /sped/actions/importGeracaoSped: 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 /sped/actions/importGeracaoSpedParams: 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 /sped/actions/importLeiaute: 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 /sped/actions/importLeiauteRegistro: 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 /sped/events/gerarArquivoSpedStarted: post: description: Gerar o arquivo do SPED x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Ticket/id da entidade do processamento da geração do arquivo. É produto da action gerarArquivoSped. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sped/events/reprocessarArquivoSpedRequested: post: description: Evento que inicia o reprocessamento de um arquivo do SPED. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Ticket/id da entidade do processamento do arquivo SPED. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sped/events/importEmpresaEvent: 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 /sped/events/exportEmpresaEvent: 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 /sped/events/importFilialEvent: 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 /sped/events/exportFilialEvent: 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 /sped/events/importGeracaoSpedEvent: 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 /sped/events/exportGeracaoSpedEvent: 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 /sped/events/importGeracaoSpedParamsEvent: 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 /sped/events/exportGeracaoSpedParamsEvent: 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 /sped/events/importLeiauteEvent: 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 /sped/events/exportLeiauteEvent: 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 /sped/events/importLeiauteRegistroEvent: 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 /sped/events/exportLeiauteRegistroEvent: 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 /sped/entities/empresa: 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/empresa responses: 200: description: The created resource schema: #/definitions/empresa 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/empresa responses: 200: description: The created resource schema: #/definitions/empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/entities/empresa/{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/empresa responses: 200: description: Ok schema: #/definitions/empresa 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/empresa responses: 200: description: Ok schema: #/definitions/empresa 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/empresa 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 /sped/entities/empresa/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/empresa responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/entities/filial: 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/filial responses: 200: description: The created resource schema: #/definitions/filial 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/filial responses: 200: description: The created resource schema: #/definitions/filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/entities/filial/{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/filial responses: 200: description: Ok schema: #/definitions/filial 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/filial responses: 200: description: Ok schema: #/definitions/filial 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/filial 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 /sped/entities/filial/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/filial responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/entities/geracaoSped: 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/geracaoSped responses: 200: description: The created resource schema: #/definitions/geracaoSped 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/geracaoSped responses: 200: description: The created resource schema: #/definitions/geracaoSped 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/geracaoSped 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/entities/geracaoSped/{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/geracaoSped responses: 200: description: Ok schema: #/definitions/geracaoSped 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/geracaoSped responses: 200: description: Ok schema: #/definitions/geracaoSped 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/geracaoSped 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 /sped/entities/geracaoSped/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/geracaoSped responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/entities/geracaoSpedParams: 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/geracaoSpedParams responses: 200: description: The created resource schema: #/definitions/geracaoSpedParams 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/geracaoSpedParams responses: 200: description: The created resource schema: #/definitions/geracaoSpedParams 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/geracaoSpedParams 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/entities/geracaoSpedParams/{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/geracaoSpedParams responses: 200: description: Ok schema: #/definitions/geracaoSpedParams 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/geracaoSpedParams responses: 200: description: Ok schema: #/definitions/geracaoSpedParams 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/geracaoSpedParams 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 /sped/entities/geracaoSped/{parentId}/parametros: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/geracaoSpedParams responses: 200: description: The created resource schema: #/definitions/geracaoSpedParams 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/geracaoSpedParams responses: 200: description: The created resource schema: #/definitions/geracaoSpedParams 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/geracaoSpedParams 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/entities/geracaoSped/{parentId}/parametros/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/geracaoSpedParams responses: 200: description: Ok schema: #/definitions/geracaoSpedParams 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/geracaoSpedParams responses: 200: description: Ok schema: #/definitions/geracaoSpedParams 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/geracaoSpedParams 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/entities/geracaoSpedParams/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/geracaoSpedParams responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/entities/leiaute: 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/leiaute responses: 200: description: The created resource schema: #/definitions/leiaute 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/leiaute responses: 200: description: The created resource schema: #/definitions/leiaute 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/leiaute 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/entities/leiaute/{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/leiaute responses: 200: description: Ok schema: #/definitions/leiaute 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/leiaute responses: 200: description: Ok schema: #/definitions/leiaute 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/leiaute 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 /sped/entities/leiaute/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/leiaute responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/entities/leiauteRegistro: 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/leiauteRegistro responses: 200: description: The created resource schema: #/definitions/leiauteRegistro 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/leiauteRegistro responses: 200: description: The created resource schema: #/definitions/leiauteRegistro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/leiauteRegistro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sped/entities/leiauteRegistro/{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/leiauteRegistro responses: 200: description: Ok schema: #/definitions/leiauteRegistro 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/leiauteRegistro responses: 200: description: Ok schema: #/definitions/leiauteRegistro 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/leiauteRegistro 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 /sped/entities/leiauteRegistro/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/leiauteRegistro responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN contaContabil: description: Conta Contábil type: string enum: – REDUZIDA – EXPANDIDA perfilApresentacao: description: Perfil de Apresentação type: string enum: – PERFIL_A – PERFIL_B – PERFIL_C classificacaoEstabelecimentoIndustrial: description: Classificação do estabelecimento industrial type: string enum: – CEI_00 – CEI_01 – CEI_02 – CEI_03 – CEI_04 – CEI_05 – CEI_06 – CEI_07 – CEI_08 – CEI_09 finalidadeArquivo: description: Finalidade do Arquivo type: string enum: – ORIGINAL – SUBSTITUTO documentoExportado: description: Movimento a ser exportado type: string enum: – ENTRADA – SAIDA – AMBOS situacaoProcessamento: description: Situação do processamento da geração do arquivo SPED. type: string enum: – INICIANDO – PROCESSANDO – CONCLUIDO – CONCLUIDO_COM_ERRO formaValorizacaoH010: description: Forma de valorização do campo VL_ITEM registro H010 type: string enum: – VALOR_MEDIO_ENTRADAS – PRECO_CUSTO_MEDIO 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 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 recGeracaoArquivoSped: description: Parâmetros de geração de um arquivo do SPED type: object required: – empresa – filial – dataInicial – dataFinal – documentosExportados – finalidadeArquivo – perfilApresentacao – contaContabil – lancCredICMSSimpNac – indiValFCPPropSomaICMS – geraRegC170NFeEmiProp – efdContribuicaoEntregue – leiaute – formaValorizacaoH010VlItem properties: empresa: type: object allOf: – #/definitions/recEmpresa description: Empresa filial: type: object allOf: – #/definitions/recFilial description: Filial dataInicial: type: string format: date description: Data inicial dataFinal: type: string format: date description: Data final documentosExportados: type: string allOf: – #/definitions/documentoExportado description: Quais documentos serão exportados finalidadeArquivo: type: string allOf: – #/definitions/finalidadeArquivo description: Finalidade do arquivo perfilApresentacao: type: string allOf: – #/definitions/perfilApresentacao description: Perfil de apresentação contaContabil: type: string allOf: – #/definitions/contaContabil description: Conta contábil classEstabInd: type: string allOf: – #/definitions/classificacaoEstabelecimentoIndustrial description: Classificação do estabelecimento industrial dataInventario: type: string format: date description: Data de inventario produtoInventarioZerado: type: boolean description: Considerar produtos do invetário zerados lancCredICMSSimpNac: type: boolean description: Lanças créditos do ICMS do simples nacional nos campos de ICMS indiValFCPPropSomaICMS: type: boolean description: Indicativo se o valor de FCP próprio deve ser somando ao ICMS geraRegC170NFeEmiProp: type: boolean description: Gerar o registro C170 para NF-e de emissão própria efdContribuicaoEntregue: type: boolean description: EFD Contribuições entregue no período leiaute: type: object allOf: – #/definitions/recLeiaute description: Árvore do leiaute do SPED com os items selecionados gerarNotasC100: type: boolean description: Gerar notas inutilizadas e denegadas formaValorizacaoH010VlItem: type: string allOf: – #/definitions/formaValorizacaoH010 description: Forma de valorização do campo VL_ITEM registro H010 recLeiaute: description: Leiaute do Sped type: object required: – id – item properties: id: type: string description: Identificador único do item. codigo: type: string description: Código de identificação do leiaute versao: type: string description: Versão do leiaute descricao: type: string description: Descrição do item item: type: object allOf: – #/definitions/recLeiauteRegistro description: Nó principal dos registros do leiaute recLeiauteRegistro: description: Leiaute do SPED type: object required: – id – leiaute properties: id: type: string description: Identificador único do item. Pode ser um UUID leiaute: type: string description: Identificador do leiaute Sped codigo: type: string description: Código de identificação do leiaute, exemplo: 014 leiauteRegistroPai: type: string description: Node pai descricao: type: string description: Descrição do item selecionado: type: boolean description: Indicativo se o item do leiaute está selecionado itens: type: array items: type: object allOf: – #/definitions/recLeiauteRegistro description: Blocos/registros do leiaute recEmpresa: description: Empresa type: object required: – id – codEmp – nomEmp properties: id: type: string description: Id da empresa codEmp: type: integer format: int64 description: Código da empresa nomEmp: type: string description: Nome da empresa recFilial: description: Filial type: object required: – id – codFil – nomFil properties: id: type: string description: Id da filial codFil: type: integer format: int64 description: Código da filial nomFil: type: string description: Nome da filial geracaoSpedStatusResult: description: Payload de resultado da situação de uma geração de arquivo do Sped. type: object required: – ticket – situacaoProcessamento properties: ticket: type: string description: Ticket/id do processamento da geração do arquivo. situacaoProcessamento: type: string allOf: – #/definitions/situacaoProcessamento description: Situação do processamento da geração do arquivo SPED. mensagem: type: string maxLength: 1000 description: Mensagem urlArquivo: type: string description: Url do arquivo gerado empresa: description: Empresa type: object required: – codEmp – nomEmp properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome da empresa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: filial: description: Filial type: object required: – codFil – nomFil – empresa properties: id: type: string format: uuid description: Id da filial codFil: type: integer format: int64 description: Código da filial minimum: 0 maximum: 99999 nomFil: type: string maxLength: 100 description: Nome da filial empresa: type: object allOf: – #/definitions/empresa description: Empresa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: geracaoSped: description: Dados do processamento da geração de um arquivo do SPED type: object required: – dataInicial – dataFinal – situacao properties: id: type: string format: uuid description: Id pid: type: string format: uuid description: Id do processo de geração do arquivo dataInicialProcessamento: type: string format: date-time description: Data de processamento inicial dataFinalProcessamento: type: string format: date-time description: Data de processamento final dataHoraKeepAlive: type: string format: date-time description: Data/hora última gravação filial: type: object allOf: – #/definitions/filial description: Filial dataInicial: type: string format: date description: Data inicial dataFinal: type: string format: date description: Data final situacao: type: string allOf: – #/definitions/situacaoProcessamento description: Situação mensagem: type: string maxLength: 1000 description: Mensagem parametros: type: object allOf: – #/definitions/geracaoSpedParams description: Parametros de geração arquivoUrl: type: string description: Url do arquivo gerado arquivoNome: type: string description: Nome do arquivo gerado arquivoVersao: type: string description: Versão do arquivo gerado arquivoTargetObjectId: type: string description: Versão do arquivo gerado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: geracaoSpedParams: description: Parametros de geração type: object required: – documentosExportados – finalidadeArquivo – perfilApresentacao – contaContabil – lancCredICMSSimpNac – indiValFCPPropSomaICMS – geraRegC170NFeEmiProp – efdContribuicaoEntregue – leiauteTree – formaValorizacaoH010VlItem properties: id: type: string format: uuid description: Id geracaoSped: type: object allOf: – #/definitions/geracaoSped description: Registro de geração pai documentosExportados: type: string allOf: – #/definitions/documentoExportado description: Quais documentos serão exportados finalidadeArquivo: type: string allOf: – #/definitions/finalidadeArquivo description: Finalidade do arquivo perfilApresentacao: type: string allOf: – #/definitions/perfilApresentacao description: Perfil de apresentação contaContabil: type: string allOf: – #/definitions/contaContabil description: Conta contábil classEstabInd: type: string allOf: – #/definitions/classificacaoEstabelecimentoIndustrial description: Classificação do estabelecimento industrial lancCredICMSSimpNac: type: boolean description: Lanças créditos do ICMS do simples nacional nos campos de ICMS indiValFCPPropSomaICMS: type: boolean description: Indicativo se o valor de FCP próprio deve ser somando ao ICMS geraRegC170NFeEmiProp: type: boolean description: Gerar o registro C170 para NF-e de emissão própria efdContribuicaoEntregue: type: boolean description: EFD Contribuições entregue no período leiaute: type: object allOf: – #/definitions/leiaute description: Leiaute Sped leiauteTree: type: string format: byte description: Árvore do leiaute Sped dataInventario: type: string format: date description: Data de inventario produtoInventarioZerado: type: boolean description: Considerar produtos do invetário zerados gerarNotasC100: type: boolean description: Gerar notas inutilizadas e denegadas formaValorizacaoH010VlItem: type: string allOf: – #/definitions/formaValorizacaoH010 description: Forma de valorização do campo VL_ITEM registro H010 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: leiaute: description: Leiaute Sped type: object properties: id: type: string format: uuid description: Identificador único do leiaute. codigo: type: string description: Código do leiaute versao: type: string description: Versão do leiaute descricao: type: string description: Descrição do leiaute createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: leiauteRegistro: description: Registros do leiaute type: object required: – customOrder properties: id: type: string format: uuid description: Identificador único do item. leiaute: type: string format: uuid description: Leiaute codigo: type: string description: Código de identificação do leiaute, exemplo: 014 descricao: type: string description: Descrição do item leiauteRegistroPai: type: string format: uuid description: Item pai do leiaute selecionado: type: boolean description: Indicativo se o item do leiaute está selecionado customOrder: type: integer format: int64 description: Ordem customizada para leiaute 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

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação