2.0info: 2.4.0 Tax Obligation – Shared description: Tax Obligation – Shared x-senior-domain: Tax Obligation x-senior-domain-path: tax_obligation x-senior-service-path: shared 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/tax_obligationsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /shared/queries/healthcheck: post: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/queries/getEntity: post: description: Lista o conteúdo de todas as entidades requisitadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName properties: entityName: type: array items: type: string allOf: – #/definitions/entityType minimum: 1 description: responses: 200: description: Ok schema: type: object properties: irrfInformationList: type: array items: type: object allOf: – #/definitions/irrfInformation description: Lista de informações de IRRF irrfTableList: type: array items: type: object allOf: – #/definitions/irrfTable description: Lista de tabela de IRRF naturePayrollRubricaList: type: array items: type: object allOf: – #/definitions/naturePayrollRubrica description: Lista de natureza da rubrica da folha de pagamento fgtsTaxationGroupList: type: array items: type: object allOf: – #/definitions/fgtsTaxationGroup description: Lista dos grupos de Tributação de FGTS fgtsTaxationList: type: array items: type: object allOf: – #/definitions/fgtsTaxation description: Lista dos códigos de tributação FGTS inssTaxationGroupList: type: array items: type: object allOf: – #/definitions/inssTaxationGroup description: Lista dos grupos de tributação de INSS inssTaxationList: type: array items: type: object allOf: – #/definitions/inssTaxation description: Lista dos códigos de tributação de INSS irrfTaxationGroupList: type: array items: type: object allOf: – #/definitions/irrfTaxationGroup description: Lista dos grupos de tributação de IRRF irrfTaxationList: type: array items: type: object allOf: – #/definitions/irrfTaxation description: Lista dos códigos de tributação de IRRF inssDefinitionsList: type: array items: type: object allOf: – #/definitions/inssDefinitions description: Lista de definições do INSS eSocialCategoryFgtsList: type: array items: type: object allOf: – #/definitions/eSocialCategoryFgts description: Lista de FGTS inssTaxRangeList: type: array items: type: object allOf: – #/definitions/inssTaxRange description: Lista de INSS – Faixas de Tributação inssFamilySalaryList: type: array items: type: object allOf: – #/definitions/inssFamilySalary description: Lista de INSS – Salário Família 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/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 /shared/queries/exportIrrfInformation: 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 /shared/queries/exportIrrfTable: 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 /shared/queries/exportNaturePayrollRubrica: 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 /shared/queries/exportFgtsTaxationGroup: 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 /shared/queries/exportFgtsTaxation: 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 /shared/queries/exportInssTaxationGroup: 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 /shared/queries/exportInssTaxation: 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 /shared/queries/exportIrrfTaxationGroup: 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 /shared/queries/exportIrrfTaxation: 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 /shared/queries/exportInssDefinitions: 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 /shared/queries/exportESocialCategory: 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 /shared/queries/exportESocialCategoryFgts: 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 /shared/queries/exportInssTaxRange: 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 /shared/queries/exportInssFamilySalary: 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 /shared/queries/exportInssAliquotaRAT: 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 /shared/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 /shared/actions/migrateSchemaReport: post: description: Executa a migração de base para o serviço no tenant repassado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant que deverá ter a base migrada responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso ou falha para a migração da base 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/actions/importIrrfInformation: 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 /shared/actions/importIrrfTable: 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 /shared/actions/importNaturePayrollRubrica: 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 /shared/actions/importFgtsTaxationGroup: 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 /shared/actions/importFgtsTaxation: 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 /shared/actions/importInssTaxationGroup: 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 /shared/actions/importInssTaxation: 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 /shared/actions/importIrrfTaxationGroup: 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 /shared/actions/importIrrfTaxation: 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 /shared/actions/importInssDefinitions: 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 /shared/actions/importESocialCategory: 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 /shared/actions/importESocialCategoryFgts: 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 /shared/actions/importInssTaxRange: 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 /shared/actions/importInssFamilySalary: 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 /shared/actions/importInssAliquotaRAT: 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 /shared/events/importIrrfInformationEvent: 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 /shared/events/exportIrrfInformationEvent: 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 /shared/events/importIrrfTableEvent: 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 /shared/events/exportIrrfTableEvent: 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 /shared/events/importNaturePayrollRubricaEvent: 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 /shared/events/exportNaturePayrollRubricaEvent: 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 /shared/events/importFgtsTaxationGroupEvent: 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 /shared/events/exportFgtsTaxationGroupEvent: 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 /shared/events/importFgtsTaxationEvent: 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 /shared/events/exportFgtsTaxationEvent: 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 /shared/events/importInssTaxationGroupEvent: 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 /shared/events/exportInssTaxationGroupEvent: 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 /shared/events/importInssTaxationEvent: 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 /shared/events/exportInssTaxationEvent: 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 /shared/events/importIrrfTaxationGroupEvent: 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 /shared/events/exportIrrfTaxationGroupEvent: 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 /shared/events/importIrrfTaxationEvent: 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 /shared/events/exportIrrfTaxationEvent: 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 /shared/events/importInssDefinitionsEvent: 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 /shared/events/exportInssDefinitionsEvent: 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 /shared/events/importESocialCategoryEvent: 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 /shared/events/exportESocialCategoryEvent: 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 /shared/events/importESocialCategoryFgtsEvent: 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 /shared/events/exportESocialCategoryFgtsEvent: 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 /shared/events/importInssTaxRangeEvent: 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 /shared/events/exportInssTaxRangeEvent: 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 /shared/events/importInssFamilySalaryEvent: 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 /shared/events/exportInssFamilySalaryEvent: 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 /shared/events/importInssAliquotaRATEvent: 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 /shared/events/exportInssAliquotaRATEvent: 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 /shared/entities/irrfInformation: get: 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/irrfInformation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/irrfTable: get: 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/irrfTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/naturePayrollRubrica: get: 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/naturePayrollRubrica 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/fgtsTaxationGroup: get: 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/fgtsTaxationGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/fgtsTaxation: get: 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/fgtsTaxation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/inssTaxationGroup: get: 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/inssTaxationGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/inssTaxation: get: 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/inssTaxation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/irrfTaxationGroup: get: 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/irrfTaxationGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/irrfTaxation: get: 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/irrfTaxation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/inssDefinitions: get: 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/inssDefinitions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/eSocialCategory: get: 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/eSocialCategory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/eSocialCategoryFgts: get: 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/eSocialCategoryFgts 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/inssTaxRange: get: 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/inssTaxRange 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/inssFamilySalary: get: 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/inssFamilySalary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/inssAliquotaRAT: get: 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/inssAliquotaRAT 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/inssDefinitions/{parentId}/inssAliquotaRAT: post: 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/inssAliquotaRAT responses: 200: description: The created resource schema: #/definitions/inssAliquotaRAT 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/inssAliquotaRAT responses: 200: description: The created resource schema: #/definitions/inssAliquotaRAT 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/inssAliquotaRAT 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /shared/entities/inssDefinitions/{parentId}/inssAliquotaRAT/{id}: put: 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/inssAliquotaRAT responses: 200: description: Ok schema: #/definitions/inssAliquotaRAT 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/inssAliquotaRAT responses: 200: description: Ok schema: #/definitions/inssAliquotaRAT 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/inssAliquotaRAT 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 definitions: healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN irrfType: description: Tipo de IRRF type: string enum: – GENERAL – PLR accumulatorType: description: Tipo do acumulador type: string enum: – MONTHLY_PAYROLL – VACATION – THIRTEENTH_SALARY – PLR – NOT_APPLICABLE – DEDUCTION_IRRF_MONTHLY – DEDUCTION_IRRF_VACATION – DEDUCTION_IRRF_THIRTEENTH_SALARY entityType: description: Tipo da entidade type: string enum: – IRRF_INFORMATION – IRRF_TABLE – NATURE_PAYROLL_RUBRICA – FGTS_TAXATION_GROUP – FGTS_TAXATION – INSS_TAXATION_GROUP – INSS_TAXATION – IRRF_TAXATION_GROUP – IRRF_TAXATION – INSS_DEFINITIONS – ESOCIAL_CATEGORY_FGTS – INSS_TAX_RANGE – INSS_FAMILY_SALARY inssCalculationMethodType: description: Forma de cálculo do INSS type: string enum: – SINGLE_ALIQUOT – PROGRESSIVE_ALIQUOT 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 checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status irrfInformationAndTable: description: Informações e tabelas de IRRF localizadas por competência type: object required: – irrfInformation – listTable properties: irrfInformation: type: object allOf: – #/definitions/irrfInformation description: Informações de IRRF listTable: type: array items: type: object allOf: – #/definitions/irrfTable minimum: 1 description: Tabela de IRRF irrfInformation: description: Informações de IRRF type: object required: – dateCompetence – irrfType – dependentDeduction – minimumDiscount – minimum13SalaryDiscount – simplifiedIRRFDeduction – simplifiedIRRF13SalaryDeduction properties: id: type: string format: uuid description: Identificador único dateCompetence: type: string format: date description: Competência irrfType: type: string allOf: – #/definitions/irrfType description: Tipo de IRRF dependentDeduction: type: string description: Dedução por dependente minimumDiscount: type: string description: Desconto mínimo minimum13SalaryDiscount: type: string description: Desconto mínimo 13º salário simplifiedIRRFDeduction: type: string description: Dedução IRRF simplificado minimum: 0.0 simplifiedIRRF13SalaryDeduction: type: string description: Dedução IRRF 13º salário simplificado minimum: 0.0 irrfTable: description: Tabela de IRRF type: object required: – irrfInformation – startingTrack – finalTrack – percentage – deduction properties: id: type: string format: uuid description: Identificador único irrfInformation: type: object allOf: – #/definitions/irrfInformation description: Informação IRRF startingTrack: type: string description: Faixa inicial finalTrack: type: string description: Faixa final percentage: type: number format: double description: Percentual deduction: type: string description: Dedução naturePayrollRubrica: description: Natureza da rubrica da folha de pagamento type: object required: – code – name – startDate properties: id: type: string format: uuid description: Identificador único code: type: string description: Código name: type: string description: Nome startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final fgtsTaxationGroup: description: Grupos de Tributação de FGTS type: object required: – code – description – calculateBase properties: id: type: string format: uuid description: Identificador único code: type: string description: Código do grupo description: type: string description: Descrição do grupo calculateBase: type: boolean description: Considera Base fgtsTaxation: description: Códigos de tributação FGTS type: object required: – fgtsTaxationGroup – code – description – startDate properties: id: type: string format: uuid description: Identificador único fgtsTaxationGroup: type: object allOf: – #/definitions/fgtsTaxationGroup description: Grupo Tributação FGTS code: type: string description: Código de Tributação description: type: string description: Descrição accumulatorType: type: string allOf: – #/definitions/accumulatorType description: Acumulador startDate: type: string format: date description: Data Inicial endDate: type: string format: date description: Data Final inssTaxationGroup: description: Grupos de tributação de INSS type: object required: – code – description – calculateBase properties: id: type: string format: uuid description: Identificador único code: type: string description: Código do grupo description: type: string description: Descrição do grupo calculateBase: type: boolean description: Considera base inssTaxation: description: Códigos de tributação de INSS type: object required: – inssTaxationGroup – code – description – accumulatorType – startDate properties: id: type: string format: uuid description: Identificador único inssTaxationGroup: type: object allOf: – #/definitions/inssTaxationGroup description: Grupo tributação INSS code: type: string description: Código de tributação description: type: string description: Descrição accumulatorType: type: string allOf: – #/definitions/accumulatorType description: Acumulador startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final irrfTaxationGroup: description: Grupos de tributação de IRRF type: object required: – code – description – calculateBase properties: id: type: string format: uuid description: Identificador único code: type: string description: Código do grupo description: type: string description: Descrição do grupo calculateBase: type: boolean description: Considera base irrfTaxation: description: Códigos de tributação de IRRF type: object required: – irrfTaxationGroup – code – description – accumulatorType – startDate properties: id: type: string format: uuid description: Identificador único irrfTaxationGroup: type: object allOf: – #/definitions/irrfTaxationGroup description: Grupo tributação IRRF code: type: string description: Código de tributação description: type: string description: Descrição accumulatorType: type: string allOf: – #/definitions/accumulatorType description: Acumulador startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final inssDefinitions: description: Definições do INSS type: object required: – competenceDate – minimumWage – minimumCollection – inssCalculationMethodType – ageLimitEnableDependentFamilySalary – ageLimitDisableDependentFamilySalary properties: id: type: string format: uuid description: Identificador único competenceDate: type: string format: date description: Competência minimumWage: type: string description: Salário mínimo minimumCollection: type: string description: Recolhimento mínimo inssCalculationMethodType: type: string allOf: – #/definitions/inssCalculationMethodType description: Forma de cálculo do INSS inssAliquotaRAT: type: object allOf: – #/definitions/inssAliquotaRAT description: Alíquota Contribuição RAT ageLimitEnableDependentFamilySalary: type: integer format: int64 description: Idade limite salário família ageLimitDisableDependentFamilySalary: type: integer format: int64 description: Idade limite salário família para incapaz eSocialCategory: description: Categorias eSocial type: object required: – code properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código description: type: string maxLength: 300 description: Descrição eSocialCategoryFgts: description: FGTS type: object required: – eSocialCategory – startDate properties: id: type: string format: uuid description: Identificador único eSocialCategory: type: object allOf: – #/definitions/eSocialCategory description: Categoria ESocial percentFgtsMonth: type: number format: double description: % FGTS Mensal percentFgtsDismissal: type: number format: double description: % FGTS Multa Rescisão percentFgtsSocialContributionDismissal: type: number format: double description: % FGTS Contribuição Social Rescisão startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final inssTaxRange: description: INSS – Faixas de Tributação type: object required: – inssDefinitions – startingTrack – finalTrack – percentage properties: id: type: string format: uuid description: Identificador único inssDefinitions: type: object allOf: – #/definitions/inssDefinitions description: INSS – Definições startingTrack: type: string description: Faixa inicial finalTrack: type: string description: Faixa final percentage: type: number format: double description: % INSS inssFamilySalary: description: INSS – Salário Família type: object required: – inssDefinitions – startingTrack – finalTrack – valueFamilySalary properties: id: type: string format: uuid description: Identificador único inssDefinitions: type: object allOf: – #/definitions/inssDefinitions description: INSS – Definições startingTrack: type: string description: Faixa inicial finalTrack: type: string description: Faixa final valueFamilySalary: type: string description: Valor salário família inssAliquotaRAT: description: Alíquota Contribuição RAT type: object required: – aliquotRetired15 – aliquotRetired20 – aliquotRetired25 properties: id: type: string format: uuid description: Identificador único inssDefinitions: type: object allOf: – #/definitions/inssDefinitions description: INSS – Definições aliquotRetired15: type: number format: double description: % Acréscimo RAT Aposentadoria Especial após 15 anos de trabalho aliquotRetired20: type: number format: double description: % Acréscimo RAT Aposentadoria Especial após 20 anos de trabalho aliquotRetired25: type: number format: double description: % Acréscimo RAT Aposentadoria Especial após 25 anos de trabalho 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