2.0info: 6.5.4 Dependentes description: HCM – Gestão de dependentes x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: dependent 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/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /dependent/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/heathcheckDTO 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/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/queries/migrate: post: description: Realiza a migração da base de dados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – errorMessage properties: status: type: boolean description: Status da migração errorMessage: type: string description: Mensagem de erro da migração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Realiza a migração da base de dados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – errorMessage properties: status: type: boolean description: Status da migração errorMessage: type: string description: Mensagem de erro da migração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/queries/enumQuery: post: description: Retorna os itens das enumerações traduzidos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – names properties: names: type: array items: type: string minimum: 1 description: Nomes das enumerações responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/enumInformationData minimum: 1 description: Lista com as enumerações traduzidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os itens das enumerações traduzidos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: names description: Nomes das enumerações in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/enumInformationData minimum: 1 description: Lista com as enumerações traduzidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/queries/dependentListQuery: post: description: Retorna os dependentes de um colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – page properties: employeeId: type: string description: Id do colaborador page: type: object allOf: – #/definitions/pagination description: Paginação da busca responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dependentListQueryData description: Retorno da consulta com lista de dependentes do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/queries/dependentExistsCpfByEmployee: post: description: Retorna se existe um dependente do mesmo colaborador com o cpf passado por parâmetro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: string description: Id do colaborador dependentId: type: string maxLength: 32 description: Id do dependente para ser ignorado default: dependentCpf: type: string description: Cpf do dependente responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Se existe ou não um dependente com o mesmo cpf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna se existe um dependente do mesmo colaborador com o cpf passado por parâmetro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employeeId description: Id do colaborador in: query required: true type: string – name: dependentId description: Id do dependente para ser ignorado in: query type: string maxLength: 32 – name: dependentCpf description: Cpf do dependente in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Se existe ou não um dependente com o mesmo cpf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/queries/dependentQuery: post: description: Retorna as informações do dependente tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – dependentId properties: dependentId: type: string description: Id do dependente responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dependentQueryData description: Retorno com os dados do dependente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do dependente tags: – Queries x-senior-visibility: PUBLIC parameters: – name: dependentId description: Id do dependente in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dependentQueryData description: Retorno com os dados do dependente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/queries/dependentDependenciesQuery: post: description: Consulta de dependente e suas dependências tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dependentId properties: dependentId: type: string description: Id do dependente responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dependentDependenciesData description: Retorno do endpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta de dependente e suas dependências tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dependentId description: Id do dependente in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dependentDependenciesData description: Retorno do endpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/queries/dependentBasicInformations: post: description: Informações básicas do dependente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dependentId properties: dependentId: type: string description: Dependente Id responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dependentBasicInformationsData description: Retorno do endpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Informações básicas do dependente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dependentId description: Dependente Id in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dependentBasicInformationsData description: Retorno do endpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/queries/dependentDraftList: post: description: Retorna uma lista de rascunhos do dependente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page properties: admissionDraftId: type: string description: Rascunho da admissao employeeId: type: string description: Colaborador page: type: object allOf: – #/definitions/pagination description: Paginaçao da busca responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dependentDraftQueryData description: Lista de rascunho do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/queries/dependentDraftQuery: post: description: Retorna o rascunho do dependente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Número do documento do dependente responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dependentDraftData description: Rascunho do dependente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o rascunho do dependente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Número do documento do dependente in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dependentDraftData description: Rascunho do dependente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/queries/historicalJudicialPensionBankAccountQuery: post: description: Retorna os históricos de contas bancárias por dependente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dependentId – page properties: dependentId: type: string description: Id do dependente page: type: object allOf: – #/definitions/pagination description: Paginação responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/pagedHistoricalJudicialPensionBankAccountQueryData description: Históricos de contas bancárias da pensão judicial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/queries/listJudicialPensionBankAccountQuery: post: description: Retorna uma lista de contas bancárias na competência informada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dependentId – dateWhen properties: dependentId: type: string description: Id do dependente dateWhen: type: string format: date description: Data de referencia do historico responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/historicalJudicialPensionBankAccountData minimum: 1 description: Lista com as contas bancárias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de contas bancárias na competência informada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dependentId description: Id do dependente in: query required: true type: string – name: dateWhen description: Data de referencia do historico in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/historicalJudicialPensionBankAccountData minimum: 1 description: Lista com as contas bancárias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/queries/historicalJudicialPensionBankAccountIntegrationQuery: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do registro responses: 200: description: Ok schema: type: object allOf: – #/definitions/historicalJudicialPensionBankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Id do registro in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/historicalJudicialPensionBankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/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 /dependent/queries/exportOthercompany: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportDependent: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportDependentrequestupdate: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportEmployee: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportEducationdegree: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportTutelage: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportChildcareAssistance: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportFamilySalary: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportFamilySalaryDocument: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportDependentIncomeTax: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportDependentHealthInsurance: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportDocument: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportCountry: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportState: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportCity: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportProfessionalcouncil: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportAttachment: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportPerson: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportAddress: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportNeighborhood: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportPhone: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportBankAccount: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportBank: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportBankBranch: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportJudicialPension: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportFixedJudicialValue: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportVariableJudicialValue: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportJudicialPayment: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportJudicialAdjustment: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportJudicialPayee: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportJudicialPayeeItem: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportJudicialBase: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportJudicialBaseItem: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportPayrollcalculation: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportWageTypeTable: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportWagetype: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportCompany: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportFinancialIndex: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportCompanyIndication: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportAdmissionDraft: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportHistoricalJudicialPensionBankAccount: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/exportDependentDraft: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /dependent/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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 /dependent/actions/historicalJudicialPensionBankAccountSave: post: description: Salva históricos de contas bancárias da pensão judicial tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dependentId – dateWhen – listHistoricalBankAccount properties: dependentId: type: string description: Dependente dateWhen: type: string format: date description: Data do histórico listHistoricalBankAccount: type: array items: type: object allOf: – #/definitions/historicalJudicialPensionBankAccountData minimum: 1 description: Lista de contas bancárias responses: 200: description: Ok schema: type: object required: – result – createdItems properties: result: type: object allOf: – #/definitions/resultBaseData description: Resposta da criação do histórico de contas bancárias createdItems: type: array items: type: object allOf: – #/definitions/historicalJudicialPensionBankAccountData minimum: 1 description: DTO dos históricos salvos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/actions/historicalJudicialPensionBankAccountDelete: post: description: Deleta históricos de contas bancárias do colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dependentId – dateWhen properties: dependentId: type: string description: Dependente dateWhen: type: string format: date description: Data do histórico responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/actions/judicialPensionClosure: post: description: Encerramento da pensão judicial tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – judicialPensionId – closureDate properties: judicialPensionId: type: string description: Id da pensão judicial closureDate: type: string format: date description: Data de encerramento responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado no encerramento da pensão judicial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/actions/dependentSave: post: description: Salvar um dependente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – sheetPersona – sheetDocument – sheetControls properties: sheetPersona: type: object allOf: – #/definitions/dependentPersonaData description: Aba pessoais sheetDocument: type: object allOf: – #/definitions/dependentDocumentData description: Aba documentos sheetControls: type: object allOf: – #/definitions/dependentControlsData description: Aba controles dependentDraftId: type: string description: Id do rascunho do dependente responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dependentAdditionData description: Retorno do endpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/actions/blobServiceRequestUpload: post: description: Solicitação para realizar o upload de um arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome do arquivo que será carregado thumbnail: type: boolean description: Condicional se será salvo um thumbnail default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/blobServiceRequestUploadData description: Retorno do upload de um arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/actions/blobServiceCommit: post: description: Realiza o commit de um arquivo que foi carregado anteriormente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileId – version properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) type: string description: Versão do arquivo thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto, e que deve ser criada a foto e seu Thumbnail(128X128px) default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Retorno do commit de um arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/actions/blobServiceRequestAccess: post: description: Solicitação para acessar um arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) ttl: type: integer format: int64 description: Tempo em minutos que o arquivo deve ficar disponível para download no link que será retornado (padrão 30 minutos) default: 30 thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto e que deve ser retornado seu Thumbnail(128X128px) default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/blobServiceRequestAccessData description: Retorno do acesso do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/actions/blobServiceDelete: post: description: Solicitação para apagar um arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto e que deve ser apagado seu Thumbnail(128X128px) default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Retorno de delete do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/actions/integrationSaveBatch: post: description: Salva um lote de entidades tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – className – jsonText – serviceName – collectionName – ids properties: className: type: string description: Classe da entidade jsonText: type: string description: Json da entidade serviceName: type: string description: Nome do serviço collectionName: type: string description: Nome da coleção na meta ids: type: string description: Lista de g7Ids e g5Ids responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/integrationSaveBatchData minimum: 1 description: Resultado da ação de salvar o lote 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/actions/dependentDraftSave: post: description: Salva o rascunho do dependente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – jsonDraft – originType properties: id: type: string description: Id do rascunho name: type: string description: Nome do depentend jsonDraft: type: string description: JSON do rascunho originType: type: string allOf: – #/definitions/originDraftType description: Origem do rascunho attachment: type: object allOf: – #/definitions/fileUploadedData description: Foto do dependente admissionDraftId: type: string description: Rascunho de admissao employeeId: type: string description: Colaborador externalId: type: string description: Identificador Externo responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dependentDraftSaveReturn description: Retorno do rascunho 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/actions/dependentDraftSaveBatch: post: description: Salva o rascunho de vários dependentes onboarding tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dependentDraftSaveData properties: dependentDraftSaveData: type: array items: type: object allOf: – #/definitions/dependentDraftSaveData minimum: 1 description: lista de rascunhos de dependetes. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Retorno da action 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/actions/listDependentDraftSave: post: description: Salva uma lista de dependentes tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: string description: Id do colaborador responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultSaveList description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/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 /dependent/actions/importOthercompany: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importDependent: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importDependentrequestupdate: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importEmployee: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importEducationdegree: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importTutelage: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importChildcareAssistance: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importFamilySalary: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importFamilySalaryDocument: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importDependentIncomeTax: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importDependentHealthInsurance: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importDocument: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importCountry: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importState: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importCity: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importProfessionalcouncil: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importAttachment: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importPerson: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importAddress: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importNeighborhood: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importPhone: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importBankAccount: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importBank: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importBankBranch: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importJudicialPension: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importFixedJudicialValue: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importVariableJudicialValue: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importJudicialPayment: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importJudicialAdjustment: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importJudicialPayee: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importJudicialPayeeItem: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importJudicialBase: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importJudicialBaseItem: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importPayrollcalculation: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importWageTypeTable: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importWagetype: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importCompany: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importFinancialIndex: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importCompanyIndication: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importAdmissionDraft: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importHistoricalJudicialPensionBankAccount: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/actions/importDependentDraft: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /dependent/entities/othercompany: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/othercompany responses: 200: description: The created resource schema: #/definitions/othercompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/othercompany responses: 200: description: The created resource schema: #/definitions/othercompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/othercompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/othercompany/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/othercompany responses: 200: description: Ok schema: #/definitions/othercompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/othercompany responses: 200: description: Ok schema: #/definitions/othercompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/othercompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/othercompany/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/othercompany responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/dependent: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependent responses: 200: description: The created resource schema: #/definitions/dependent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependent responses: 200: description: The created resource schema: #/definitions/dependent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/dependent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/dependent/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependent responses: 200: description: Ok schema: #/definitions/dependent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependent responses: 200: description: Ok schema: #/definitions/dependent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dependent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/dependent/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dependent responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/dependentrequestupdate: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentrequestupdate responses: 200: description: The created resource schema: #/definitions/dependentrequestupdate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentrequestupdate responses: 200: description: The created resource schema: #/definitions/dependentrequestupdate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/dependentrequestupdate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/dependentrequestupdate/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentrequestupdate responses: 200: description: Ok schema: #/definitions/dependentrequestupdate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentrequestupdate responses: 200: description: Ok schema: #/definitions/dependentrequestupdate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dependentrequestupdate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /dependent/entities/dependentrequestupdate/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dependentrequestupdate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/employee: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employee responses: 200: description: The created resource schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employee responses: 200: description: The created resource schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/employee/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employee responses: 200: description: Ok schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employee responses: 200: description: Ok schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/employee/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employee responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/educationdegree: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/educationdegree responses: 200: description: The created resource schema: #/definitions/educationdegree 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/educationdegree responses: 200: description: The created resource schema: #/definitions/educationdegree 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/educationdegree 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/educationdegree/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/educationdegree responses: 200: description: Ok schema: #/definitions/educationdegree 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/educationdegree responses: 200: description: Ok schema: #/definitions/educationdegree 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/educationdegree 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/educationdegree/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/educationdegree responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/tutelage: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tutelage responses: 200: description: The created resource schema: #/definitions/tutelage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tutelage responses: 200: description: The created resource schema: #/definitions/tutelage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/tutelage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/tutelage/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tutelage responses: 200: description: Ok schema: #/definitions/tutelage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tutelage responses: 200: description: Ok schema: #/definitions/tutelage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tutelage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/tutelage/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tutelage responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/childcareAssistance: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/childcareAssistance responses: 200: description: The created resource schema: #/definitions/childcareAssistance 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/childcareAssistance responses: 200: description: The created resource schema: #/definitions/childcareAssistance 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/childcareAssistance 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/childcareAssistance/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/childcareAssistance responses: 200: description: Ok schema: #/definitions/childcareAssistance 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/childcareAssistance responses: 200: description: Ok schema: #/definitions/childcareAssistance 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/childcareAssistance 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/childcareAssistance/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/childcareAssistance responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/familySalary: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/familySalary responses: 200: description: The created resource schema: #/definitions/familySalary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/familySalary responses: 200: description: The created resource schema: #/definitions/familySalary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/familySalary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/familySalary/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/familySalary responses: 200: description: Ok schema: #/definitions/familySalary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/familySalary responses: 200: description: Ok schema: #/definitions/familySalary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/familySalary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/familySalary/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/familySalary responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/familySalaryDocument: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/familySalaryDocument responses: 200: description: The created resource schema: #/definitions/familySalaryDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/familySalaryDocument responses: 200: description: The created resource schema: #/definitions/familySalaryDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/familySalaryDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/familySalaryDocument/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/familySalaryDocument responses: 200: description: Ok schema: #/definitions/familySalaryDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/familySalaryDocument responses: 200: description: Ok schema: #/definitions/familySalaryDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/familySalaryDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/familySalaryDocument/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/familySalaryDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/dependentIncomeTax: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentIncomeTax responses: 200: description: The created resource schema: #/definitions/dependentIncomeTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentIncomeTax responses: 200: description: The created resource schema: #/definitions/dependentIncomeTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/dependentIncomeTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/dependentIncomeTax/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentIncomeTax responses: 200: description: Ok schema: #/definitions/dependentIncomeTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentIncomeTax responses: 200: description: Ok schema: #/definitions/dependentIncomeTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dependentIncomeTax 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/dependentIncomeTax/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dependentIncomeTax responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/dependentHealthInsurance: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentHealthInsurance responses: 200: description: The created resource schema: #/definitions/dependentHealthInsurance 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentHealthInsurance responses: 200: description: The created resource schema: #/definitions/dependentHealthInsurance 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/dependentHealthInsurance 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/dependentHealthInsurance/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentHealthInsurance responses: 200: description: Ok schema: #/definitions/dependentHealthInsurance 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentHealthInsurance responses: 200: description: Ok schema: #/definitions/dependentHealthInsurance 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dependentHealthInsurance 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/dependentHealthInsurance/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dependentHealthInsurance responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/document: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/document responses: 200: description: The created resource schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/document responses: 200: description: The created resource schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/document/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/document responses: 200: description: Ok schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/document responses: 200: description: Ok schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/document/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/document responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/country: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/country responses: 200: description: The created resource schema: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/country responses: 200: description: The created resource schema: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/country/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/country responses: 200: description: Ok schema: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/country responses: 200: description: Ok schema: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/country/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/country responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/state: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/state responses: 200: description: The created resource schema: #/definitions/state 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/state responses: 200: description: The created resource schema: #/definitions/state 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/state 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/state/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/state responses: 200: description: Ok schema: #/definitions/state 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/state responses: 200: description: Ok schema: #/definitions/state 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/state 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/state/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/state responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/city: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/city responses: 200: description: The created resource schema: #/definitions/city 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/city responses: 200: description: The created resource schema: #/definitions/city 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/city 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/city/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/city responses: 200: description: Ok schema: #/definitions/city 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/city responses: 200: description: Ok schema: #/definitions/city 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/city 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/city/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/city responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/professionalcouncil: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/professionalcouncil responses: 200: description: The created resource schema: #/definitions/professionalcouncil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/professionalcouncil responses: 200: description: The created resource schema: #/definitions/professionalcouncil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/professionalcouncil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/professionalcouncil/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/professionalcouncil responses: 200: description: Ok schema: #/definitions/professionalcouncil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/professionalcouncil responses: 200: description: Ok schema: #/definitions/professionalcouncil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/professionalcouncil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/professionalcouncil/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/professionalcouncil responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/attachment: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/attachment responses: 200: description: The created resource schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/attachment responses: 200: description: The created resource schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/attachment/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/attachment responses: 200: description: Ok schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/attachment responses: 200: description: Ok schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/attachment/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/attachment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/person: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/person responses: 200: description: The created resource schema: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/person responses: 200: description: The created resource schema: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/person/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/person responses: 200: description: Ok schema: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/person responses: 200: description: Ok schema: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/person/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/person responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/address: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/address responses: 200: description: The created resource schema: #/definitions/address 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/address responses: 200: description: The created resource schema: #/definitions/address 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/address 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/address/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/address responses: 200: description: Ok schema: #/definitions/address 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/address responses: 200: description: Ok schema: #/definitions/address 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/address 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/address/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/address responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/neighborhood: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/neighborhood responses: 200: description: The created resource schema: #/definitions/neighborhood 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/neighborhood responses: 200: description: The created resource schema: #/definitions/neighborhood 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/neighborhood 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/neighborhood/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/neighborhood responses: 200: description: Ok schema: #/definitions/neighborhood 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/neighborhood responses: 200: description: Ok schema: #/definitions/neighborhood 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/neighborhood 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/neighborhood/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/neighborhood responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/phone: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/phone responses: 200: description: The created resource schema: #/definitions/phone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/phone responses: 200: description: The created resource schema: #/definitions/phone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/phone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/phone/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/phone responses: 200: description: Ok schema: #/definitions/phone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/phone responses: 200: description: Ok schema: #/definitions/phone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/phone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/phone/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/phone responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/bankAccount: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/bankAccount responses: 200: description: The created resource schema: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/bankAccount responses: 200: description: The created resource schema: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/bankAccount/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bankAccount responses: 200: description: Ok schema: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bankAccount responses: 200: description: Ok schema: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/bankAccount/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/bankAccount responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/bank: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/bank responses: 200: description: The created resource schema: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/bank responses: 200: description: The created resource schema: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/bank/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: Ok schema: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: Ok schema: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/bank/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/bank responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/bankBranch: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/bankBranch responses: 200: description: The created resource schema: #/definitions/bankBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/bankBranch responses: 200: description: The created resource schema: #/definitions/bankBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/bankBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/bankBranch/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bankBranch responses: 200: description: Ok schema: #/definitions/bankBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bankBranch responses: 200: description: Ok schema: #/definitions/bankBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/bankBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/bankBranch/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/bankBranch responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/judicialPension: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/judicialPension responses: 200: description: The created resource schema: #/definitions/judicialPension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/judicialPension responses: 200: description: The created resource schema: #/definitions/judicialPension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/judicialPension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/judicialPension/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialPension responses: 200: description: Ok schema: #/definitions/judicialPension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialPension responses: 200: description: Ok schema: #/definitions/judicialPension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/judicialPension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/judicialPension/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/judicialPension responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/fixedJudicialValue: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/fixedJudicialValue responses: 200: description: The created resource schema: #/definitions/fixedJudicialValue 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/fixedJudicialValue responses: 200: description: The created resource schema: #/definitions/fixedJudicialValue 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/fixedJudicialValue 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/fixedJudicialValue/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/fixedJudicialValue responses: 200: description: Ok schema: #/definitions/fixedJudicialValue 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/fixedJudicialValue responses: 200: description: Ok schema: #/definitions/fixedJudicialValue 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/fixedJudicialValue 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/fixedJudicialValue/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/fixedJudicialValue responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/variableJudicialValue: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/variableJudicialValue responses: 200: description: The created resource schema: #/definitions/variableJudicialValue 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/variableJudicialValue responses: 200: description: The created resource schema: #/definitions/variableJudicialValue 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/variableJudicialValue 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/variableJudicialValue/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/variableJudicialValue responses: 200: description: Ok schema: #/definitions/variableJudicialValue 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/variableJudicialValue responses: 200: description: Ok schema: #/definitions/variableJudicialValue 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/variableJudicialValue 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/variableJudicialValue/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/variableJudicialValue responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/judicialPayment: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/judicialPayment responses: 200: description: The created resource schema: #/definitions/judicialPayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/judicialPayment responses: 200: description: The created resource schema: #/definitions/judicialPayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/judicialPayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/judicialPayment/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialPayment responses: 200: description: Ok schema: #/definitions/judicialPayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialPayment responses: 200: description: Ok schema: #/definitions/judicialPayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/judicialPayment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/judicialPayment/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/judicialPayment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/judicialAdjustment: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/judicialAdjustment responses: 200: description: The created resource schema: #/definitions/judicialAdjustment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/judicialAdjustment responses: 200: description: The created resource schema: #/definitions/judicialAdjustment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/judicialAdjustment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/judicialAdjustment/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialAdjustment responses: 200: description: Ok schema: #/definitions/judicialAdjustment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialAdjustment responses: 200: description: Ok schema: #/definitions/judicialAdjustment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/judicialAdjustment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/judicialAdjustment/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/judicialAdjustment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/judicialPayee: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/judicialPayee responses: 200: description: The created resource schema: #/definitions/judicialPayee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/judicialPayee responses: 200: description: The created resource schema: #/definitions/judicialPayee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/judicialPayee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/judicialPayee/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialPayee responses: 200: description: Ok schema: #/definitions/judicialPayee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialPayee responses: 200: description: Ok schema: #/definitions/judicialPayee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/judicialPayee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/judicialPayee/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/judicialPayee responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/judicialPayeeItem: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/judicialPayeeItem responses: 200: description: The created resource schema: #/definitions/judicialPayeeItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/judicialPayeeItem responses: 200: description: The created resource schema: #/definitions/judicialPayeeItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/judicialPayeeItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/judicialPayeeItem/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialPayeeItem responses: 200: description: Ok schema: #/definitions/judicialPayeeItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialPayeeItem responses: 200: description: Ok schema: #/definitions/judicialPayeeItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/judicialPayeeItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/judicialPayeeItem/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/judicialPayeeItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/judicialBase: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/judicialBase responses: 200: description: The created resource schema: #/definitions/judicialBase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/judicialBase responses: 200: description: The created resource schema: #/definitions/judicialBase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/judicialBase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/judicialBase/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialBase responses: 200: description: Ok schema: #/definitions/judicialBase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialBase responses: 200: description: Ok schema: #/definitions/judicialBase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/judicialBase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/judicialBase/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/judicialBase responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/judicialBaseItem: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/judicialBaseItem responses: 200: description: The created resource schema: #/definitions/judicialBaseItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/judicialBaseItem responses: 200: description: The created resource schema: #/definitions/judicialBaseItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/judicialBaseItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/judicialBaseItem/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialBaseItem responses: 200: description: Ok schema: #/definitions/judicialBaseItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialBaseItem responses: 200: description: Ok schema: #/definitions/judicialBaseItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/judicialBaseItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/judicialBaseItem/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/judicialBaseItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/payrollcalculation: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/payrollcalculation responses: 200: description: The created resource schema: #/definitions/payrollcalculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/payrollcalculation responses: 200: description: The created resource schema: #/definitions/payrollcalculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/payrollcalculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/payrollcalculation/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/payrollcalculation responses: 200: description: Ok schema: #/definitions/payrollcalculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/payrollcalculation responses: 200: description: Ok schema: #/definitions/payrollcalculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/payrollcalculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/payrollcalculation/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/payrollcalculation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/wageTypeTable: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/wageTypeTable responses: 200: description: The created resource schema: #/definitions/wageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/wageTypeTable responses: 200: description: The created resource schema: #/definitions/wageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/wageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/wageTypeTable/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/wageTypeTable responses: 200: description: Ok schema: #/definitions/wageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/wageTypeTable responses: 200: description: Ok schema: #/definitions/wageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/wageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/wageTypeTable/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/wageTypeTable responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/wagetype: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/wagetype responses: 200: description: The created resource schema: #/definitions/wagetype 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/wagetype responses: 200: description: The created resource schema: #/definitions/wagetype 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/wagetype 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/wagetype/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/wagetype responses: 200: description: Ok schema: #/definitions/wagetype 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/wagetype responses: 200: description: Ok schema: #/definitions/wagetype 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/wagetype 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/wagetype/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/wagetype responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/company: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/company/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/company/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/company responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/financialIndex: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/financialIndex responses: 200: description: The created resource schema: #/definitions/financialIndex 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/financialIndex responses: 200: description: The created resource schema: #/definitions/financialIndex 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/financialIndex 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/financialIndex/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/financialIndex responses: 200: description: Ok schema: #/definitions/financialIndex 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/financialIndex responses: 200: description: Ok schema: #/definitions/financialIndex 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/financialIndex 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/financialIndex/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/financialIndex responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/companyIndication: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/companyIndication 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/admissionDraft: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/admissionDraft responses: 200: description: The created resource schema: #/definitions/admissionDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/admissionDraft responses: 200: description: The created resource schema: #/definitions/admissionDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/admissionDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/admissionDraft/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/admissionDraft responses: 200: description: Ok schema: #/definitions/admissionDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/admissionDraft responses: 200: description: Ok schema: #/definitions/admissionDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/admissionDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/admissionDraft/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/admissionDraft responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/historicalJudicialPensionBankAccount: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/historicalJudicialPensionBankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/dependentDraft: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentDraft responses: 200: description: The created resource schema: #/definitions/dependentDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentDraft responses: 200: description: The created resource schema: #/definitions/dependentDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/dependentDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dependent/entities/dependentDraft/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentDraft responses: 200: description: Ok schema: #/definitions/dependentDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentDraft responses: 200: description: Ok schema: #/definitions/dependentDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dependentDraft 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /dependent/entities/dependentDraft/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dependentDraft responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: heathcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN operationType: description: Tipo da operação do ajuste type: string enum: – ADD – SUBTRACT – CHANGE – SUBTRACT_WITH_EVENT – DEDUCT_WITH_EVENT judicialPaymentType: description: Tipo do pagamento type: string enum: – NORMAL – VACATION – SALARY_13 – WAGE_BONUS – THIRD fgtsPensionType: description: Tipo pensão FGTS type: string enum: – NOT_APPLICABLE – VALUE – PERCENTAGE originType: description: Origem do pagamento type: string enum: – NORMAL_CALCULATION – VACATION – TERMINATION – COMPLEMENTARY_TERMINATION – INDEMNITY – THIRD decisionType: description: Tipo de decisão type: string enum: – YES – NO salaryAdvancedType: description: Tipo do adiantamento salarial para a pensão type: string enum: – YES – NO – PERCENTAGE salary13Type: description: Tipo do 13o salário para a pensão type: string enum: – YES – NO – PARTIAL baseCalculationType: description: Tipo de base de cálculo type: string enum: – FIXED – VARIABLE methodPaymentType: description: Tipo do método pagamento type: string enum: – BANK_CHECK – MONEY – MONEY_ORDER – BANKING_RELATIONSHIP – EXTERNAL accountType: description: Forma de Pagamento. type: string enum: – CURRENT_ACCOUNT – SAVING_ACCOUNT – SALARY_ACCOUNT – OTHER phoneType: description: Tipo de telefone. type: string enum: – PERSONAL – PROFESSIONAL – MOBILE – BUSINESS_FAX – PERSONAL_FAX – OTHER addressType: description: Tipo de endereço. type: string enum: – Others – Airport – Lane – Area – Avenue – Balneary – Block – Field – Farmstead – Cologne – Condominium – Set – District – Terrace – Season – Road – ShantyTown – Farm – Market – Gallery – Granja – Garden – Slope – Lake – Lagoon – Long – Allotment – Hill – Core – Park – Footbridge – Courtyard – Square – Beach – Court – Nook – Residential – Highway – Street – Sector – Site – Bystreet – Excerpt – Clover – Valley – Path – Via – Viaduct – Alley – Village – Access – Camp – LocalAccess – Churchyard – SpecialArea – RightMarginalAvenue – LeftMarginalAvenue – RingRoad – LaterRoadBetween – Artery – High – Shortcut – GreenArea – ContourAvenue – MarginalAvenue – OldAvenue – Alleyway – Hole – Belvedere – Balloon – Blocks – Bulevar – Forest – Boulevard – Low – Pier – Sidewalk – Way – Channel – Chapadao – BicyclePath – CircularRoad – HousingComplex – RoadComplex – Community – Hall – Stream – Contour – Descent – Detour – BetweenBlock – IntermunicipalRoad – Cove – PrivateEntrance – BetweenQuarter – Ladder – Staircase – StateHighway – VicinalRoad – RoadConnection – MunicipalRoad – RoadToSerfdom – OldRoad – LaterRoad – Stadium – Office – PrivateRoad – Parking – Evangelical – Lofty – IndustrialAxis – Railroad – Source – Strong – HousingNucleus – Island – Undetermined – Islet – Window – Lot – Marketplace – Marina – Module – Projection – Mount – RuralNucleus – Knoll – Parallel – Tour – SportsSquare – Stop – RestArea – Tip – Prolonging – CityPark – ResidentialPark – Passage – PedestrianWalkway – UndergroundPassage – Bridge – Port – Fifth – Farms – IntegrationStreet – LinkStreet – PrivateStreet – OldStreet – Branch – Playground – Retreat – Straight – SideStreet – Ramp – RodoRing – Kneecap – PedestrianStreet – Margin – Return – Roundabout – SecondAvenue – Bondage – Uploading – Trench – Terminal – Tunnel – PrivateBystreet – OldBystreet – Unity – CollectorRoad – LocalWay – AccessWay – Ditch – CoastalWay – Expressway – HighRoad – CoastalRoad – Walkway – Variant – Zigzag signalType: description: Sinal de operação type: string enum: – POSITIVE – NEGATIVE baseType: description: Tipo da base type: string enum: – TYPE_1 – TYPE_2 – TYPE_3 – TYPE_4 – TYPE_5 – TYPE_6 – TYPE_7 – TYPE_8 – TYPE_9 – TYPE_10 – TYPE_11 – TYPE_12 – TYPE_13 – TYPE_14 – TYPE_15 – TYPE_16 – TYPE_17 – TYPE_18 – TYPE_19 – TYPE_20 – TYPE_21 – TYPE_22 – TYPE_23 – TYPE_24 – TYPE_25 – TYPE_26 – TYPE_27 – TYPE_28 – TYPE_29 – TYPE_30 – TYPE_31 – TYPE_32 judicialBaseType: description: Tipo da pensão judicial type: string enum: – MONTHLY – VACATION – PLR – SALARY_13 calculationSituationType: description: Situação do cálculo. type: string enum: – CALCULATION_CANCELED – INITIALIZED – TOTAL_CALCULATION – PARTIAL_CALCULATION – SIMULATED_CALCULATION wageTypeCategoryType: description: Tipo do evento. type: string enum: – PROCEEDS – ADVANTAGE – DEDUCTION – INFORMATIVE – OTHER_PROCEEDS – OTHER_DEDUCTION wageValueType: description: Tipo de valor do evento. type: string enum: – VALUE – HOUR calculationType: description: Tipo de cálculo da folha de pagamento. type: string enum: – MONTHLY_CALCULATION – COMPLEMENTARY_PAYROLL – COMPLEMENTARY_AGREEMENT – AGREEMENT_PAYMENT – COMPLEMENTARY_RESCISSION – FIRST_WEEK – INTERMEDIATE_WEEK – LAST_WEEK – THIRTEENTH_PAYDAY_ADVANCE – THIRTEENTH_FULL_SALARY – GRATIFICATION – FIRST_FORTNIGHT – SECOND_FORTNIGHT – SALARY_ADVANCE – PROFT_PARTICIPATION – SPECIAL – LABOR_CLAIM employeeType: description: Tipo do colaborador type: string enum: – NULL – EMPLOYEE – THIRD – PARTNER subscriptionType: description: Tipo da inscrição type: string enum: – CNPJ – CEI – CPF – INCRA genderType: description: Gênero da pessoa type: string enum: – Male – Female maritalStatusType: description: Estado civil type: string enum: – Single – Married – Divorced – Widower – Concubinage – Separated – StableUnion – Others kinshipDegreeType: description: Tipo de dependentes type: string enum: – Adopted – Child – Concubine – ExSpouse – ExPartner – Grandparent – Grandchild – GreatGrandparent – GreatGrandchild – Guardianship – NephewNiece – Other – Parent – FatherInLaw – Partner – Pensioners – Pupil – Sibling – SonDaughterInLaw – Spouse – Stepfather – Stepmother – Stepchild – Trusted – UncleAunt – Tutor eSocialDependentType: description: Tipo de dependente eSocial type: string enum: – DontTakeDependent – Spouse – Partner – SonStepson – SonStepsonStudent – SiblingGrandsonGreat – SiblingGrandsonGreatStudent – ParentsGrandparentsGreat – PoorMinor – IncapablePerson – ExSpouse – AggregateOthers directionType: description: Tipo de ordenação type: string enum: – ASC – DESC actionType: description: Tipo da ação CRUD type: string enum: – SAVE – EDIT – DELETE schoolGradeType: description: Grade escolar type: string enum: – TYPE_1 – TYPE_2 – TYPE_3 – TYPE_4 – TYPE_5 – TYPE_6 – TYPE_7 – TYPE_8 – TYPE_9 – TYPE_10 – TYPE_11 – TYPE_12 – TYPE_13 – TYPE_14 – TYPE_15 – TYPE_16 – TYPE_17 civilCertificateType: description: Tipo de certidão civil type: string enum: – BIRTH_CERTIFICATE – MARRIAGE_CERTIFICATE – INDIGENOUS_PERSONS_BIRTH_CERTIFICATE – DEATH_CERTIFICATE classOrganType: description: Tipo do órgão de classe type: string enum: – CRM – RMS – CRO professionalCouncilSituationType: description: Situação do conselho profissional type: string enum: – DEFINITIVE – TEMPORARY documentType: description: Tipo de documento type: string enum: – VOTER_REGISTRATION_CARD – DRIVERS_LICENSE – RESERVIST_CERTIFICATE – CIVIL_CERTIFICATE – PASSPORT – CIVILIAN_IDENTITY_REGISTRY – NATURALIZATION_DECREE – NATIONAL_HEALTH_CARD – DECLARATION_OF_LIVE_BIRTH – PROFESSIONAL_COUNCIL – RG – CPF – DEATH_CERTIFICATE degreeInstructionType: description: Tipo de grau de instrução type: string enum: – Illiterate – ElementarySchoolIncomplete – ElementarySchoolComplete – MiddleSchoolIncomplete – MiddleSchoolComplete – HighSchoolIncomplete – HighSchoolComplete – BachelorIncomplete – BachelorComplete – Postgraduate – Master – Doctoral informationType: description: Tipo da informação type: string enum: – CUMULATIVE – PERCENTAGE – FIXED_PERCENTEGE – DAILY_VALUE – MONTHLY_VALUE indexType: description: Tipo do index type: string enum: – OTHER – UFIR – URV – ITRD – SELIC – CONTRIBUTION_SALARY_CORRECTION – SAVINGS_CORRECTION – CURRENCY originDraftType: description: Origem do rascunho type: string enum: – PAYROLL – RECRUITMENT – ONBOARDING – WORKFLOW requestStatus: description: Estado da requisição type: string enum: – AWAITING_REVIEW – UNDER_ANALYSIS – APPROVED – REJECTED – RETURNED_TO_ADJUSTMENTS – CANCELED – WAITING_INTEGRATION – RETURN_INTEGRATION – WAITING_EFETIVATION – INTEGRATION_ERROR – AWAITING_LEADER_REVIEW – RETURNED_TO_LEADER_ADJUSTMENTS – WAITING_INTEGRATION_CONSISTENCY – CANCELED_BY_EXCLUSION_IN_THE_LEGACY_SYSTEM 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 – 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/heathcheckDTO description: Status enumInformationData: description: DTO de lista com as enumerações traduzidas type: object required: – enumName – items properties: enumName: type: string description: Nome da enumeração items: type: array items: type: object allOf: – #/definitions/enumInformationItemData minimum: 1 description: Lista com os items das enumerações enumInformationItemData: description: DTO de lista com os items das enumerações type: object required: – key – value properties: key: type: string description: Chave do item da enumeração value: type: string description: Valor traduzido do item da enumeração paged: description: Retorno paginado discriminator: _discriminator type: object required: – countResult – numberPages – _discriminator properties: countResult: type: integer format: int64 description: Indica quantos registros foram encontrados numberPages: type: integer format: int64 description: Indica o número de páginas da consulta (incluindo a atual) _discriminator: type: string description: pagination: description: Dados da paginação type: object required: – current – size properties: current: type: integer format: int64 description: Página de inicio size: type: integer format: int64 description: Quantidade de páginas (iniciando por 1) orderBy: type: array items: type: object allOf: – #/definitions/ordination description: Ordenar por ordination: description: Dados da ordenação type: object required: – field properties: field: type: string description: Campo que será ordenado direction: type: string allOf: – #/definitions/directionType description: Tipo da ordenação resultBaseData: description: Retorno base para os endpoints discriminator: _discriminator type: object required: – ok – _discriminator properties: ok: type: boolean description: Flag para indicar sucesso warning: type: boolean description: Flag para indicar sucesso com alerta default: false message: type: string description: Mensagem de retorno default: _discriminator: type: string description: dependentDraftSaveReturn: description: Retorno de salvar um Rascunho de Dependene type: object required: – ok – dependentDraftId properties: ok: type: boolean description: Flag para indicar sucesso warning: type: boolean description: Flag para indicar sucesso com alerta default: false message: type: string description: Mensagem de retorno default: dependentDraftId: type: string description: ID do Rascunho salvo dependentDraftSaveData: description: type: object required: – jsonDraft properties: name: type: string description: Nome do depentend jsonDraft: type: string description: JSON do rascunho originType: type: string allOf: – #/definitions/originDraftType description: Origem do rascunho admissionDraftId: type: string description: Rascunho de admissao employeeId: type: string description: Colaborador externalId: type: string description: Identificador Externo resultSaveList: description: Retorno de salvar lista de dependentes type: object properties: warning: type: boolean description: Flag para indicar sucesso com alerta default: false message: type: string description: Mensagem de retorno dependentQueryData: description: Dados de retorno da query de dependente allOf: – #/definitions/resultBaseData – type: object required: – dependentPersonaData – dependentDocumentData – dependentControlsData properties: dependentPersonaData: type: object allOf: – #/definitions/dependentPersonaData description: Dados pessoais dependentDocumentData: type: object allOf: – #/definitions/dependentDocumentData description: Documentos dependentControlsData: type: object allOf: – #/definitions/dependentControlsData description: Controles do dependente dependentPersonaData: description: Cartão com os dados da guia pessoais type: object required: – employeeId – name – degreeOfKinship – eSocialDependentType properties: attachment: type: object allOf: – #/definitions/fileUploadedData description: Foto do colaborador employeeId: type: object allOf: – #/definitions/employee description: Id do colaborador dependentId: type: string maxLength: 32 description: Id do dependente name: type: string maxLength: 70 description: Nome gender: type: object allOf: – #/definitions/autocompleteEnumData description: Gênero da pessoa degreeOfKinship: type: object allOf: – #/definitions/autocompleteEnumData description: Grau de parentesco eSocialDependentType: type: object allOf: – #/definitions/autocompleteEnumData description: Tipo de Dependente eSocial motherName: type: string maxLength: 70 description: Nome da mae birthday: type: string format: date description: Data de nascimento da pessoa maritalStatus: type: object allOf: – #/definitions/autocompleteEnumData description: Estado civil da pessoa degreeOfEducation: type: object allOf: – #/definitions/autocompleteData description: Grau de instrução da pessoa cityOfBirth: type: object allOf: – #/definitions/autocompleteData description: Cidade de nascimento da pessoa stateOfBirth: type: object allOf: – #/definitions/autocompleteData description: Estado de nascimento countryOfBirth: type: object allOf: – #/definitions/autocompleteData description: País de nascimento customFieldsDependent: type: array items: type: object allOf: – #/definitions/customData description: Campos do usuário da entidade person disabilityDate: type: string format: date description: Data da invalidez fileUploadedData: description: Informações de commit da imagem type: object properties: attachmentId: type: string maxLength: 32 description: Id do anexo na base de dados fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo, separados por / type: string description: Versão do arquivo thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto, e que deve ser criada a foto e seu Thumbnail(128X128px) permanentUrl: type: string description: Url do arquivo permanente dependentDocumentData: description: Cartão com os dados da guia documentos do dependente type: object properties: dependentCpfDocumentsGroup: type: object allOf: – #/definitions/dependentCpfDocumentsGroup description: Campos do cpf dependentIdentityRegistryDocumentsGroup: type: object allOf: – #/definitions/dependentIdentityRegistryDocumentsGroup description: Registro identidade civil dependentNationalHealthDocumentsGroup: type: object allOf: – #/definitions/dependentNationalHealthDocumentsGroup description: Cartão nacional de saúde dependentRgNumberDocumentsGroup: type: object allOf: – #/definitions/dependentRgNumberDocumentsGroup description: Documento rg dependentCivilCertificateDocumentsGroup: type: object allOf: – #/definitions/dependentCivilCertificateDocumentsGroup description: Dados referentes ao documento de certificado civil dependentDeathCertificateDocumentsGroup: type: object allOf: – #/definitions/dependentDeathCertificateDocumentsGroup description: Dados do certidão de óbito dependentCpfDocumentsGroup: description: Campos relacionados com cpf type: object properties: cpfNumber: type: string description: CPF da pessoa dependentIdentityRegistryDocumentsGroup: description: Registro de identidade civil type: object properties: civilianIdentityRegistry: type: string description: Registro de identidade civil dependentNationalHealthDocumentsGroup: description: Cartão nacional de saúde type: object properties: nationalHealthCard: type: string maxLength: 16 description: Cartão nacional de saúde dependentRgNumberDocumentsGroup: description: Documento rg type: object properties: rgNumberEmissionDate: type: string format: date description: Data de emissão rgNumberState: type: object allOf: – #/definitions/autocompleteData description: Estado emissor rgNumberIssuer: type: string maxLength: 20 description: Orgão emissor rgNumber: type: string maxLength: 16 description: Número do rg dependentCivilCertificateDocumentsGroup: description: Dados referentes ao documento de certificado civil type: object properties: civilCertificate: type: object allOf: – #/definitions/autocompleteEnumData description: Certidão civil civilCertificateRegistry: type: string maxLength: 40 description: Matrícula do certidão civil civilCertificateTerm: type: string maxLength: 10 description: Termo da certidão civil declarationOfLiveBirth: type: string maxLength: 20 description: Declaração de nascido vivo civilCertificateNotaryOffice: type: string maxLength: 40 description: Cartório da certidão civil civilCertificatePage: type: string maxLength: 10 description: Folha da certidão civil civilCertificateBook: type: string maxLength: 10 description: Livro do certidão civil dependentDeathCertificateDocumentsGroup: description: Certidão de óbito type: object properties: deathDate: type: string format: date description: Data do óbito deathCertificateRegistry: type: string maxLength: 40 description: Número da certidão de óbito deathCertificateTerm: type: string maxLength: 10 description: Termo da certidão de óbito dependentControlsData: description: Aba controles type: object properties: tutelageGroup: type: object allOf: – #/definitions/tutelageData description: Tutela childcareAssistanceGroup: type: object allOf: – #/definitions/childcareAssistanceData description: Auxílio creche familySalaryGroup: type: object allOf: – #/definitions/familySalaryData description: Salário familia familySalaryDocumentGroup: type: object allOf: – #/definitions/familySalaryDocumentData description: Documentos do salário familia isIncomeTaxRequired: type: boolean description: Se o dependente deve ter os campos obrigatários do imposto de renda preenchidos dependentIncomeTaxGroup: type: object allOf: – #/definitions/dependentIncomeTaxData description: Controles do dependente no imposto de renda dependentHealthInsuranceGroup: type: object allOf: – #/definitions/dependentHealthInsuranceData description: Controles do dependente para plano de saúde tutelageData: description: Dto da tabela tutela type: object properties: id: type: string maxLength: 32 description: Id do tutelado startDate: type: string format: date description: Data de inicio da tutela endDate: type: string format: date description: Data final da tutela childcareAssistanceData: description: Auxílio creche type: object properties: id: type: string maxLength: 32 description: Id do auxílio creche childcareAssistance: type: boolean description: Se tem auxílio creche months: type: integer format: int64 description: Meses minimum: 0 maximum: 999 familySalaryData: description: Salário familia type: object properties: id: type: string maxLength: 32 description: Id do salário familia ageLimitSalaryFamily: type: integer format: int64 description: Idade limite do salário familia certificateSubmission: type: string format: date description: Data de entrega da certidão printedNotice: type: boolean description: Aviso impresso familySalaryDocument: type: array items: type: object allOf: – #/definitions/familySalaryDocumentData description: Documentos do salário familia familySalaryDocumentData: description: Documentos do salário familia type: object required: – referenceYear – actionType properties: id: type: string maxLength: 32 description: Id da entidade referenceYear: type: integer format: int64 description: Ano de referência maximum: 9999 school: type: object allOf: – #/definitions/autocompleteData description: Escola scholarship: type: boolean description: É bolsista? schoolGrade: type: object allOf: – #/definitions/autocompleteEnumData description: Série escolar frequencyInMay: type: string format: date description: Frequência em maio percentageInMay: type: number format: double description: Percentual em maio frequencyInNovember: type: string format: date description: Frequência em novembro percentageInNovember: type: number format: double description: Percentual em novembro vaccination: type: string format: date description: Vacinação actionType: type: string allOf: – #/definitions/actionType description: Tipo da ação na base dependentIncomeTaxData: description: Controles do dependente no imposto de renda type: object properties: id: type: string maxLength: 32 description: Id da entidade ageLimitIncomeTax: type: integer format: int64 description: Idade limite imposto de renda beginCompetence: type: string format: date description: Inicio da competência endCompetence: type: string format: date description: Fim da competência dependentHealthInsuranceData: description: Controles do dependente para plano de saúde type: object properties: id: type: string maxLength: 32 description: Id da entidade registration: type: integer format: int64 description: Matrícula startDate: type: string format: date description: Data da inclusão endDate: type: string format: date description: Data da exclusão dependentDependenciesData: description: Dados do dependente e suas dependências type: object required: – dependent – documents – tutelage – childcareAssistance – familySalary – familySalaryDocuments – dependentIncomeTax – dependentHealthInsurance properties: dependent: type: object allOf: – #/definitions/dependent description: Dependente documents: type: array items: type: object allOf: – #/definitions/document minimum: 1 description: Documentos tutelage: type: object allOf: – #/definitions/tutelage description: Tutela childcareAssistance: type: object allOf: – #/definitions/childcareAssistance description: Auxílio creche familySalary: type: object allOf: – #/definitions/familySalary description: Salário família familySalaryDocuments: type: array items: type: object allOf: – #/definitions/familySalaryDocument minimum: 1 description: Comprovantes de salário família dependentIncomeTax: type: object allOf: – #/definitions/dependentIncomeTax description: Imposto de renda dependentHealthInsurance: type: object allOf: – #/definitions/dependentHealthInsurance description: Plano de saúde dependentListQueryData: description: DTO de retorno dos dependentes allOf: – #/definitions/paged – type: object required: – dependents properties: dependents: type: array items: type: object allOf: – #/definitions/dependentData minimum: 1 description: Lista de dependentes dependentAdditionData: description: Retorno da primitiva de salvar um dependente allOf: – #/definitions/resultBaseData – type: object required: – dependentId properties: dependentId: type: string description: Id do dependente dependentData: description: Dados de um dependente type: object required: – dependentName – kinshipDegree properties: id: type: string maxLength: 32 description: Id do dependente dependentName: type: string maxLength: 70 description: Nome do dependente kinshipDegree: type: object allOf: – #/definitions/autocompleteEnumData description: Grau de parentesco genderType: type: object allOf: – #/definitions/autocompleteEnumData description: Gênero birthdayDate: type: string format: date description: Data de nascimento mothersName: type: string description: Nome da mãe maritalStatusType: type: object allOf: – #/definitions/autocompleteEnumData description: Estado civil educationDegree: type: object allOf: – #/definitions/autocompleteData description: Grau de instrução countryOfBirth: type: object allOf: – #/definitions/autocompleteData description: País de nascimento stateOfBirth: type: object allOf: – #/definitions/autocompleteData description: Estado de nascimento cityOfBirth: type: object allOf: – #/definitions/autocompleteData description: Cidade de nascimento cpfNumber: type: string description: Número do CPF notaryOffice: type: string description: Nome do cartório bookNumber: type: string description: Número do livro sheetNumber: type: string description: Número da folha registerNumber: type: string description: Número do registro customFieldsDependent: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados da entidade Dependent customData: description: Mapa de campos customizados type: object required: – field properties: value: type: string description: Valor do campo field: type: string description: Nome do campo label: type: string description: Label do campo type: type: string description: Tipo do campo regex: type: string description: Regex de validação tooltip: type: string description: Tooltip do campo mask: type: string description: Máscara do campo autocompleteEnumData: description: DTO para o autocompleteEnum selecionado e retorno type: object required: – key properties: key: type: string description: Chave do enum value: type: string description: Valor do enum autocompleteData: description: DTO com os dados selecionados do autocomplete type: object required: – tableId properties: tableId: type: string description: Id da tabela name: type: string description: Descrição da tabela blobServiceRequestUploadData: description: Dados de retorno do upload de um arquivo allOf: – #/definitions/resultBaseData – type: object required: – fileId – version – locationURI properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) type: string description: Versão do arquivo locationURI: type: string description: URI onde o upload deve ser realizado blobServiceRequestAccessData: description: Dados de retorno do acesso do arquivo allOf: – #/definitions/resultBaseData – type: object required: – locationURI properties: locationURI: type: string description: URI onde o arquivo está disponível para download dependentBasicInformationsData: description: DTO com informações básicas do dependente allOf: – #/definitions/resultBaseData – type: object required: – name – pictureId – birthdate – degreeOfKinship – employeeName properties: name: type: string description: Nome do dependente pictureId: type: string description: Id da foto birthdate: type: string format: date description: Data de nascimento degreeOfKinship: type: string description: Grau de parentesco employeeName: type: string description: Nome do colaborador do qual é dependente integrationSaveBatchData: description: DTO com para integração em lotes type: object required: – id – success – errorMessage properties: id: type: string description: Id da entidade success: type: boolean description: Informa se a ação foi realizada com sucesso errorMessage: type: string description: Mensagem de erro dependentDraftQueryData: description: Dados do rascunho do colaborador allOf: – #/definitions/paged – type: object required: – drafts properties: drafts: type: array items: type: object allOf: – #/definitions/dependentDraftData minimum: 1 description: Rascunhos dependentDraftData: description: DTO de rascunho type: object required: – name – jsonDraft – originType properties: id: type: string description: Id do rascunho name: type: string description: Nome do depentend jsonDraft: type: string description: JSON do rascunho originType: type: string allOf: – #/definitions/originDraftType description: Origem do rascunho attachment: type: object allOf: – #/definitions/fileUploadedData description: Foto do dependente admissionDraftId: type: string description: Rascunho de admissao employeeId: type: string description: Colaborador withWarning: type: boolean description: Tem inconsistências default: false messageError: type: string description: Mensagem de erro da inserção da lista historicalJudicialPensionBankAccountData: description: DTO de histórico de contas bancárias type: object required: – bankBranch – accountType – bankAccount – percentage properties: id: type: string description: Id do registro dependent: type: object allOf: – #/definitions/autocompleteData description: Dependente dateWhen: type: string format: date description: Data Início bank: type: object allOf: – #/definitions/autocompleteData description: Banco bankBranch: type: object allOf: – #/definitions/autocompleteData description: Agência accountType: type: object allOf: – #/definitions/autocompleteEnumData description: Tipo da conta bankAccount: type: string description: Conta bancária digit: type: string description: Digito da conta percentage: type: number format: double description: Percentual livre numberOfBankAccount: type: integer format: int64 description: Quantidade de contas vinculado a esta data de histórico customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados pagedHistoricalJudicialPensionBankAccountQueryData: description: DTO de histórico de contas bancárias paginado allOf: – #/definitions/paged – type: object required: – historicalJudicialPensionBankAccounts properties: historicalJudicialPensionBankAccounts: type: array items: type: object allOf: – #/definitions/historicalJudicialPensionBankAccountData minimum: 1 description: Históricos de contas bancárias othercompany: description: Outra empresa type: object required: – name – nickname – subscriptionType – subscriptionNumber – subscriptionNumberCNO – subscriptionNumberCAEPF – startDate – endDate properties: id: type: string maxLength: 32 description: Id da outra empresa name: type: string description: Nome da outra empresa nickname: type: string description: Apelido da outra empresa subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo da inscrição subscriptionNumber: type: integer format: int64 description: Número da inscrição subscriptionNumberCNO: type: integer format: int64 description: Número inscrição CNO subscriptionNumberCAEPF: type: integer format: int64 description: Inscrição no CAEPF (número) startDate: type: string format: date description: Data de inicio da validade endDate: type: string format: date description: Data fim da validade dependent: description: Dependente type: object required: – employee – fullname – isaccountedforirrf – iseligibletoalimony – iseligibletofamilyallowence – type – eSocialDependentType – birthcertificate – cpf – rg – deathcertificate – deathdate – maritalstatus – educationdegree – mothersname – livebirthdeclaration – agelimitir – agelimitfamilysalary – nameNotary – bookNumber – sheetNumber – registerNumber properties: id: type: string maxLength: 32 description: Id do dependente birthdate: type: string format: date description: Data de nascimento employee: type: object allOf: – #/definitions/employee description: Colaborador fullname: type: string maxLength: 70 description: Nome completo gender: type: string allOf: – #/definitions/genderType description: Gênero isaccountedforirrf: type: boolean description: Representa se o dependente é contabilizado no IRRF iseligibletoalimony: type: boolean description: Representa se o dependente é elegível a pensão alimentícia iseligibletofamilyallowence: type: boolean description: Representa se o dependente é elegível para subsídio familiar (Salário família) type: type: string allOf: – #/definitions/kinshipDegreeType description: Grau de parentesco eSocialDependentType: type: string allOf: – #/definitions/eSocialDependentType description: Tipo de dependente eSocial birthcertificate: type: string maxLength: 10 description: Certidão de nascimento cpf: type: string description: CPF rg: type: string description: RG deathcertificate: type: string maxLength: 40 description: Certidão de óbito deathdate: type: string format: date description: Data de óbito maritalstatus: type: string allOf: – #/definitions/maritalStatusType description: Estado civil educationdegree: type: object allOf: – #/definitions/educationdegree description: Id do grau de instrução mothersname: type: string description: Nome da mãe placeofbirth: type: object allOf: – #/definitions/city description: Id da cidade de nascimento livebirthdeclaration: type: string maxLength: 20 description: Declaração de nascimento agelimitir: type: integer format: int64 description: Limite de idade para IR agelimitfamilysalary: type: integer format: int64 description: Limite de idade para pensão familiar nameNotary: type: string maxLength: 40 description: Nome do cartório bookNumber: type: string maxLength: 10 description: Número do livro sheetNumber: type: string maxLength: 10 description: Número da folha registerNumber: type: string maxLength: 10 description: Número do registro attachment: type: object allOf: – #/definitions/attachment description: Foto do dependente disabilityDate: type: string format: date description: Data da invalidez dependentrequestupdate: description: Dependente Request Update type: object required: – id – requester – dependentid – daterequest – requeststatus – requesttype – dateanalysis – employee – fullname – isaccountedforirrf – iseligibletoalimony – iseligibletofamilyallowence – type – eSocialDependentType – birthcertificate – cpf – rg – deathcertificate – deathdate – maritalstatus – educationdegree – mothersname – livebirthdeclaration – integrationcomment – agelimitir – agelimitfamilysalary properties: id: type: string maxLength: 32 description: Id do dependente request update requester: type: string maxLength: 32 description: Solicitante approver: type: string maxLength: 32 description: Aprovador dependentid: type: object allOf: – #/definitions/dependent description: Id do dependente daterequest: type: string format: date-time description: Data da requisição requeststatus: type: string allOf: – #/definitions/requestStatus description: Status da requisição requestcomment: type: string maxLength: 1000 description: Comentário da requisição reviewcomment: type: string maxLength: 1000 description: Revisão do comentário requesttype: type: integer format: int64 description: Tipo da requisição dateanalysis: type: string format: date-time description: Data da Análise requestip: type: string maxLength: 32 description: Requestip analysisip: type: string maxLength: 32 description: Analysisip birthdate: type: string format: date description: Data de nascimento employee: type: object allOf: – #/definitions/employee description: Colaborador fullname: type: string maxLength: 70 description: Nome completo gender: type: string allOf: – #/definitions/genderType description: Gênero isaccountedforirrf: type: boolean description: Representa se o dependente é contabilizado no IRRF iseligibletoalimony: type: boolean description: Representa se o dependente é elegível a pensão alimentícia iseligibletofamilyallowence: type: boolean description: Representa se o dependente é elegível para subsídio familiar (Salário família) type: type: string allOf: – #/definitions/kinshipDegreeType description: Grau de parentesco eSocialDependentType: type: string allOf: – #/definitions/eSocialDependentType description: Tipo de dependente eSocial birthcertificate: type: string maxLength: 10 description: Certidão de nascimento cpf: type: string description: CPF rg: type: string description: RG deathcertificate: type: string maxLength: 40 description: Certidão de óbito deathdate: type: string format: date description: Data de óbito maritalstatus: type: string allOf: – #/definitions/maritalStatusType description: Estado civil educationdegree: type: object allOf: – #/definitions/educationdegree description: Id do grau de instrução mothersname: type: string description: Nome da mãe placeofbirth: type: object allOf: – #/definitions/city description: Id da cidade de nascimento livebirthdeclaration: type: string maxLength: 20 description: Declaração de nascimento integrationcomment: type: string maxLength: 2000 description: Comentário da integração agelimitir: type: integer format: int64 description: Limite de idade para IR agelimitfamilysalary: type: integer format: int64 description: Limite de idade para pensão familiar employee: description: Colaborador type: object properties: id: type: string maxLength: 32 description: Id do colaborador companynumber: type: integer format: int64 description: Empresa do colaborador: NUMEMP employeetype: type: string allOf: – #/definitions/employeeType description: Tipo do colaborador: TIPCOL registernumber: type: integer format: int64 description: Código do colaborador: NUMCAD person: type: object allOf: – #/definitions/person description: Relacionamento com a pessoa employer: type: object allOf: – #/definitions/company description: Empresa do colaborador hiredate: type: string format: date description: Data de admissão educationdegree: description: Grau de instrução (r022gra) type: object properties: id: type: string maxLength: 32 description: Id do grau de instrução code: type: integer format: int64 description: Código do grau de instrução name: type: string description: Nome do grau de instrução x-i18n: true nameRais: type: string allOf: – #/definitions/degreeInstructionType description: Tipo do grau de instrução translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. tutelage: description: Tutela type: object required: – startDate – endDate – dependent properties: id: type: string maxLength: 32 description: Id do tutelado startDate: type: string format: date description: Data de inicio da tutela endDate: type: string format: date description: Data final da tutela dependent: type: object allOf: – #/definitions/dependent description: Dependente childcareAssistance: description: Auxílio creche type: object required: – childcareAssistance – months – dependent properties: id: type: string maxLength: 32 description: Id do auxílio creche childcareAssistance: type: boolean description: Se tem auxílio creche months: type: integer format: int64 description: Meses minimum: 0 maximum: 999 dependent: type: object allOf: – #/definitions/dependent description: Dependente familySalary: description: Salário familia type: object required: – ageLimitSalaryFamily – certificateSubmission – printedNotice – dependent properties: id: type: string maxLength: 32 description: Id do salário familia ageLimitSalaryFamily: type: integer format: int64 description: Idade limite do salário familia minimum: 0 maximum: 99 certificateSubmission: type: string format: date description: Data de entrega da certidão printedNotice: type: boolean description: Aviso impresso dependent: type: object allOf: – #/definitions/dependent description: Dependente familySalaryDocument: description: Documentos do salário familia type: object required: – referenceYear – school – scholarship – schoolGrade – frequencyInMay – percentageInMay – frequencyInNovember – percentageInNovember – vaccination – dependent properties: id: type: string maxLength: 32 description: Id da entidade referenceYear: type: integer format: int64 description: Ano de referência maximum: 9999 school: type: object allOf: – #/definitions/othercompany description: Outra empresa (Escola) scholarship: type: boolean description: É bolsista? schoolGrade: type: string allOf: – #/definitions/schoolGradeType description: Série escolar frequencyInMay: type: string format: date description: Frequência em maio percentageInMay: type: number format: double description: Percentual em maio minimum: 0 maximum: 100 frequencyInNovember: type: string format: date description: Frequência em novembro percentageInNovember: type: number format: double description: Percentual em novembro minimum: 0 maximum: 100 vaccination: type: string format: date description: Vacinação dependent: type: object allOf: – #/definitions/dependent description: Dependente dependentIncomeTax: description: Controles do dependente no imposto de renda type: object required: – ageLimitIncomeTax – beginCompetence – endCompetence – dependent properties: id: type: string maxLength: 32 description: Id da entidade ageLimitIncomeTax: type: integer format: int64 description: Idade limite imposto de renda beginCompetence: type: string format: date description: Inicio da competência endCompetence: type: string format: date description: Fim da competência dependent: type: object allOf: – #/definitions/dependent description: Dependente dependentHealthInsurance: description: Controles do dependente para plano de saúde type: object required: – registration – startDate – endDate – dependent properties: id: type: string maxLength: 32 description: Id da entidade registration: type: integer format: int64 description: Matrícula startDate: type: string format: date description: Data da inclusão endDate: type: string format: date description: Data da exclusão dependent: type: object allOf: – #/definitions/dependent description: Dependente document: description: Tabela de documento type: object required: – id – documentNumber – issuer – issuerState – issuerCity – issuerCountry – dateOfIssue – expirationDate – category – civilCertificate – termOfCivilCertificate – notaryOffice – pageOfCivilCertificate – bookOfCivilCertificate – naturalizationDecree – votingDistrict – serialOfVoterRegistrationCard – professionalCouncil – professionalRegistry – councilRegistry – professionalCouncilSituation – professionalCouncilExpeditionDate – professionalCouncilExpirationDate – firstDriverLicenceDate – documentType – person – dependent properties: id: type: string maxLength: 32 description: Id do documento documentNumber: type: string description: Número do documento issuer: type: string description: Orgão emissor issuerState: type: object allOf: – #/definitions/state description: Estado emissor issuerCity: type: object allOf: – #/definitions/city description: Cidade emissora issuerCountry: type: object allOf: – #/definitions/country description: País emissor dateOfIssue: type: string format: date description: Data da expedição expirationDate: type: string format: date description: Data de validade category: type: string description: Categoria civilCertificate: type: string allOf: – #/definitions/civilCertificateType description: Certificado civil termOfCivilCertificate: type: string description: Termo da certidão de nascimento notaryOffice: type: string maxLength: 40 description: Cartório da certidão de nascimento pageOfCivilCertificate: type: string description: Folha da certidão de nascimento bookOfCivilCertificate: type: string description: Livro da certidão de nascimento naturalizationDecree: type: string description: Portaria de naturalização votingDistrict: type: string description: Zona eleitoral serialOfVoterRegistrationCard: type: string description: Série do título de eleitor professionalCouncil: type: object allOf: – #/definitions/professionalcouncil description: Conselho profissional professionalRegistry: type: string description: Registro profissional councilRegistry: type: string description: Registro do conselho professionalCouncilSituation: type: string allOf: – #/definitions/professionalCouncilSituationType description: Situação do conselho profissional professionalCouncilExpeditionDate: type: string format: date description: Data da expedição do conselho profissional professionalCouncilExpirationDate: type: string format: date description: Data de validade do conselho profissional firstDriverLicenceDate: type: string format: date description: Data da primeira habilitação documentType: type: string allOf: – #/definitions/documentType description: Tipo do documento person: type: string maxLength: 32 description: Id da pessoa do documento dependent: type: object allOf: – #/definitions/dependent description: Dependente do documento country: description: País do estado type: object properties: id: type: string maxLength: 32 description: Id do país name: type: string description: Nome do país x-i18n: true abbreviation: type: string description: Abreviação do nome do país translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. state: description: Estado da cidade type: object properties: id: type: string maxLength: 32 description: Id do estado name: type: string description: Nome do estado x-i18n: true abbreviation: type: string description: Abreviação do nome do estado countryId: type: object allOf: – #/definitions/country description: Relacionamento com país translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. city: description: Cidade type: object required: – name properties: id: type: string maxLength: 32 description: Id da cidade name: type: string description: Nome da cidade x-i18n: true stateId: type: object allOf: – #/definitions/state description: Relacionamento com estado da cidade translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. professionalcouncil: description: Conselho profissional type: object required: – id – code – abbreviation – name – region – classOrganType properties: id: type: string description: Identificador conselho profissional code: type: integer format: int64 description: Código conselho profissional abbreviation: type: string description: Abreviação conselho profissional name: type: string description: Descrição conselho profissional x-i18n: true headquarter: type: object allOf: – #/definitions/city description: Sede conselho profissional region: type: string description: Região conselho profissional classOrganType: type: string allOf: – #/definitions/classOrganType description: Órgão da classe translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. attachment: description: Anexo type: object required: – id – name properties: id: type: string description: Identificador name: type: string description: Nome do arquivo type: string description: Versão do arquivo temporário permanentUrl: type: string description: Caminho permanente do arquivo person: type: string maxLength: 32 description: Pessoa sourceId: type: string maxLength: 32 description: Identificador do anexo sourceType: type: string description: Tipo do anexo createdat: type: string format: date description: Data de criação updatedat: type: string format: date description: Data de alteração status: type: integer format: int64 description: Status person: description: Pessoa type: object required: – firstname – lastname properties: id: type: string maxLength: 32 description: Id da pessoa firstname: type: string description: Primeiro nome middlename: type: string description: Segundo nome lastname: type: string description: Último nome attachment: type: string description: Id do upload da foto da g7 address: description: Endereço type: object required: – addresstype – neighborhoodId – address – number properties: id: type: string maxLength: 32 description: Id da entidade cityId: type: object allOf: – #/definitions/city description: Cidade addresstype: type: string allOf: – #/definitions/addressType description: Tipo do endereço postalcode: type: string description: Código postal do endereço (CEP) neighborhoodId: type: object allOf: – #/definitions/neighborhood description: Bairro/Distrito a qual pertence este endereço address: type: string description: Endereço. number: type: string description: Número do endereço. additional: type: string description: Informação adicional referente ao endereço. neighborhood: description: Bairro. type: object required: – code – name properties: id: type: string maxLength: 32 description: Id do bairro. code: type: integer format: int64 description: Código do bairro name: type: string description: Nome do bairro. city: type: object allOf: – #/definitions/city description: Cidade do bairro. phone: description: Telefones de contato type: object required: – phoneType – internationalCode – localCode – number properties: id: type: string maxLength: 32 description: Id da entidade phoneType: type: string allOf: – #/definitions/phoneType description: Tipo do contato de telefone internationalCode: type: string maxLength: 10 description: Código do país (DDI) localCode: type: string maxLength: 10 description: Código da localidade (DDD) number: type: string description: Número do telefone extention: type: string description: Ramal do telefone bankAccount: description: Conta bancária type: object required: – bank – bankBranch – accountType – bankAccount properties: id: type: string maxLength: 32 description: Id da entidade bank: type: object allOf: – #/definitions/bank description: Banco bankBranch: type: object allOf: – #/definitions/bankBranch description: Agência accountType: type: string allOf: – #/definitions/accountType description: Tipo da conta bankAccount: type: string maxLength: 100 description: Conta bancária. digit: type: string maxLength: 10 description: Digito da conta bank: description: Banco type: object required: – code – name properties: id: type: string maxLength: 32 description: Id do banco code: type: integer format: int64 description: Número do banco name: type: string description: Descrição x-i18n: true translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. bankBranch: description: Agência type: object required: – code – name – bank properties: id: type: string maxLength: 32 description: Id da entidade code: type: integer format: int64 description: Número da agência name: type: string description: Nome da agência x-i18n: true bank: type: object allOf: – #/definitions/bank description: Banco da agência translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. judicialPension: description: Pensão judicial type: object required: – dependent – startDate – methodPaymentType – baseCalculationType properties: id: type: string maxLength: 32 description: Id da entidade dependent: type: object allOf: – #/definitions/dependent description: Dependente da pensão judicial startDate: type: string format: date description: Data de inicio endDate: type: string format: date description: Data de encerramento sequence: type: integer format: int64 description: Sequência do cadastro methodPaymentType: type: string allOf: – #/definitions/methodPaymentType description: Tipo do método pagamento address: type: object allOf: – #/definitions/address description: Endereço do dependente ou responsável phone: type: array items: type: object allOf: – #/definitions/phone description: Telefones de contato bankAccount: type: object allOf: – #/definitions/bankAccount description: Conta bancária judicialDistrict: type: object allOf: – #/definitions/city description: Comarca bookAccount: type: string maxLength: 30 description: Conta contábil familySalaryQuota: type: integer format: int64 description: Cota salário família maximum: 9 default: 0 baseCalculationType: type: string allOf: – #/definitions/baseCalculationType description: Tipo de base de cálculo fixedJudicialValue: type: object allOf: – #/definitions/fixedJudicialValue description: Valores fixos da pensão judicial variableJudicialValue: type: object allOf: – #/definitions/variableJudicialValue description: Valores variáveis da pensão judicial fixedJudicialValue: description: Valores fixos para a pensão judicial type: object required: – initialValue – salary13Type – salaryAdvancedType – wageBonusType – vacationType properties: id: type: string maxLength: 32 description: Id da entidade initialValue: type: number format: double description: Valor inicial salary13Type: type: string allOf: – #/definitions/salary13Type description: Tipo do 13o salário para a pensão salaryAdvancedType: type: string allOf: – #/definitions/salaryAdvancedType description: Tipo do adiantamento salarial para a pensão salaryAdvancedPercentage: type: integer format: int64 description: Porcentagem do adiantamento salarial para a pensão minimum: 0 maximum: 99 wageBonusType: type: string allOf: – #/definitions/decisionType description: Tipo do bônus de salário (PLR) para a pensão vacationType: type: string allOf: – #/definitions/decisionType description: Tipo de férias para a pensão startCorrection: type: string format: date description: Data de inicio da correção financialIndex: type: object allOf: – #/definitions/financialIndex description: Índice de correção correctionDay: type: integer format: int64 description: Dia da correção minimum: 1 maximum: 31 periodicityCorrection: type: integer format: int64 description: Periodicidade da correção minimum: 1 maximum: 12 variableJudicialValue: description: Valores variáveis para a pensão judicial type: object required: – minimumValue – judicialPensionPercentage – judicialPensionVacation – judicialPension13Salary – judicialPensionWageBonus – judicialPensionFgts – fgtsPensionType properties: id: type: string maxLength: 32 description: Id da entidade minimumValue: type: number format: double description: Valor mínimo judicialPensionPercentage: type: number format: double description: Percentual da pensão judicial minimum: 0.01 maximum: 100 judicialPensionVacation: type: number format: double description: Percentual de férias da pensão minimum: 0.01 maximum: 100 judicialPension13Salary: type: number format: double description: Percentual de 13o salário da pensão minimum: 0.01 maximum: 100 judicialPensionWageBonus: type: number format: double description: Percentual de bônus do salário (PLR) da pensão minimum: 0.01 maximum: 100 judicialPensionFgts: type: number format: double description: Percentual de FGTS da pensão minimum: 0.01 maximum: 100 fgtsPensionType: type: string allOf: – #/definitions/fgtsPensionType description: Tipo pensão FGTS judicialPayment: description: Pagamentos da pensão judicial type: object required: – dependent – originType – judicialPaymentType – value properties: id: type: string maxLength: 32 description: Id da entidade dependent: type: object allOf: – #/definitions/dependent description: Dependente da pensão judicial originType: type: string allOf: – #/definitions/originType description: Origem do pagamento judicialPaymentType: type: string allOf: – #/definitions/judicialPaymentType description: Tipo do pagamento dateOne: type: string format: date description: Data 1 para uso diverso dateTwo: type: string format: date description: Data 2 para uso diverso dateThree: type: string format: date description: Data 3 para uso diverso payrollcalculation: type: object allOf: – #/definitions/payrollcalculation description: Cálculo e pagamento baseValue: type: number format: double description: Valor base do pagamento value: type: number format: double description: Valor do pagamento judicialAdjustment: description: Ajustes da pensão judicial type: object required: – dependent – originType – judicialPaymentType – operationType – value properties: id: type: string maxLength: 32 description: Id da entidade dependent: type: object allOf: – #/definitions/dependent description: Dependente da pensão judicial originType: type: string allOf: – #/definitions/originType description: Origem do pagamento judicialPaymentType: type: string allOf: – #/definitions/judicialPaymentType description: Tipo do pagamento dateOne: type: string format: date description: Data 1 para uso diverso dateTwo: type: string format: date description: Data 2 para uso diverso payrollcalculation: type: object allOf: – #/definitions/payrollcalculation description: Cálculo e pagamento operationType: type: string allOf: – #/definitions/operationType description: Tipo da operação do ajuste value: type: number format: double description: Valor do pagamento judicialPayee: description: Beneficiários (Alimentandos) da pensão judicial type: object required: – dependent – startDate – items properties: id: type: string maxLength: 32 description: Id da entidade dependent: type: object allOf: – #/definitions/dependent description: Dependente da pensão judicial startDate: type: string format: date description: Data de inicio endDate: type: string format: date description: Data de término items: type: array items: type: object allOf: – #/definitions/judicialPayeeItem minimum: 1 description: Item dos beneficiários (Alimentandos) da pensão judicial judicialPayeeItem: description: Item dos beneficiários (Alimentandos) da pensão judicial type: object required: – judicialPayee – payee – percentageValue properties: id: type: string maxLength: 32 description: Id da entidade judicialPayee: type: string maxLength: 32 description: Beneficiários (Alimentandos) da pensão judicial dependent: type: object allOf: – #/definitions/dependent description: Dependente da pensão judicial startDate: type: string format: date description: Data de inicio payee: type: object allOf: – #/definitions/dependent description: Alimentando da pensão judicial percentageValue: type: number format: double description: Valor da percentagem judicialBase: description: Bases da pensão judicial type: object required: – judicialBaseType – dependent – startDate – items properties: id: type: string maxLength: 32 description: Id da entidade judicialBaseType: type: string allOf: – #/definitions/judicialBaseType description: Tipo da base de pensão judicial dependent: type: object allOf: – #/definitions/dependent description: Dependente da pensão judicial startDate: type: string format: date description: Data de inicio endDate: type: string format: date description: Data de término items: type: array items: type: object allOf: – #/definitions/judicialBaseItem minimum: 1 description: Item das bases da pensão judicial judicialBaseItem: description: Item das bases da pensão judicial type: object required: – judicialBase – baseType – signalType – wagetype properties: id: type: string maxLength: 32 description: Id da entidade judicialBase: type: string maxLength: 32 description: Bases da pensão judicial judicialBaseType: type: string allOf: – #/definitions/judicialBaseType description: Tipo da base de pensão judicial dependent: type: object allOf: – #/definitions/dependent description: Dependente da pensão judicial startDate: type: string format: date description: Data de inicio baseType: type: string allOf: – #/definitions/baseType description: Tipo da base signalType: type: string allOf: – #/definitions/signalType description: Sinal de operação wagetype: type: object allOf: – #/definitions/wagetype description: Evento da folha de pagamento payrollcalculation: description: Cálculo da folha de pagamento. type: object required: – company – calculationcode properties: id: type: string maxLength: 32 description: Id da entidade availableforreference: type: boolean description: Liberar folha no Portal. name: type: string description: Descrição. paymentdate: type: string format: date description: Data de pagamento. periodend: type: string format: date description: Data final do período da folha. periodstart: type: string format: date description: Data inicial do período da folha. referencedate: type: string format: date description: Competência do cálculo. calculationtype: type: string allOf: – #/definitions/calculationType description: Tipo do cálculo. company: type: object allOf: – #/definitions/company description: Empresa. calculationend: type: string format: date description: Data do fim da apuração do cálculo. calculationstart: type: string format: date description: Data do início da apuração do cálculo. calculationcode: type: integer format: int64 description: Código do cálculo. calculationSituation: type: string allOf: – #/definitions/calculationSituationType description: Situação do cálculo. wageTypeTable: description: Tabela de evento da folha de pagamento. type: object required: – code – name – validity properties: id: type: string maxLength: 32 description: Id da tabela de evento. code: type: integer format: int64 description: Código da tabela de evento. name: type: string description: Descrição da tabela de evento. validity: type: string description: Indicador de validade. wagetype: description: Evento da folha de pagamento. type: object required: – wageTypeTable – code – name – type – wageValueType properties: id: type: string maxLength: 32 description: Id do evento. wageTypeTable: type: object allOf: – #/definitions/wageTypeTable description: Relacionamento com tabelas de eventos. code: type: integer format: int64 description: Código do evento. name: type: string description: Descrição do evento. type: type: string allOf: – #/definitions/wageTypeCategoryType description: Tipo do evento. wageValueType: type: string allOf: – #/definitions/wageValueType description: Tipo de valor do evento. company: description: Empresa. type: object required: – cnpj – companyname properties: id: type: string maxLength: 32 description: Id da entidade. code: type: integer format: int64 description: Código da empresa. cnpj: type: string description: Cnpj da empresa. companyname: type: string description: Nome da empresa. headquarter: type: string description: Relacionamento com a sede da empresa financialIndex: description: Índice de correção type: object required: – code – name – informationType – indexType – numberOfDigits – numberOfDecimals properties: id: type: string maxLength: 32 description: Id do índice code: type: integer format: int64 description: Código do índice name: type: string description: Nome do índice informationType: type: string allOf: – #/definitions/informationType description: Tipo informação indexType: type: string allOf: – #/definitions/indexType description: Tipo do índice numberOfDigits: type: integer format: int64 description: Quantidade de dígitos numberOfDecimals: type: integer format: int64 description: Quantidade de decimais companyIndication: description: Assinalamentos por empresa type: object required: – company – useHistoricalBankAccount properties: id: type: string maxLength: 32 description: Id do assinalamento por empresa company: type: object allOf: – #/definitions/company description: Empresa, useHistoricalBankAccount: type: boolean description: Usa histórico de contas bancárias admissionDraft: description: Rascunho de admissão type: object required: – company – name – hiringDate – documentNumber – jsonDraft – originType properties: id: type: string maxLength: 32 description: Id do rascunho company: type: object allOf: – #/definitions/company description: Empresa name: type: string description: Nome do colaborador hiringDate: type: string format: date description: Data de contratação documentNumber: type: string description: Número do documento jsonDraft: type: string description: JSON do rascunho originType: type: string allOf: – #/definitions/originDraftType description: Origem do rascunho externalId: type: string maxLength: 32 description: Identificador Externo attachment: type: object allOf: – #/definitions/attachment description: Foto do colaborador historicalJudicialPensionBankAccount: description: Historico de contas bancárias da pensão judicial type: object required: – dependent – dateWhen – bankBranch – accountType – percentage properties: id: type: string maxLength: 32 description: Id do histórico dependent: type: object allOf: – #/definitions/dependent description: Dependente dateWhen: type: string format: date description: Data início bankBranch: type: object allOf: – #/definitions/bankBranch description: Agência accountType: type: string allOf: – #/definitions/accountType description: Tipo da conta bankAccount: type: string maxLength: 12 description: Conta bancária digit: type: string maxLength: 3 description: Digito da conta percentage: type: number format: double description: Percentual livre minimum: 0.01 maximum: 100 externalId: type: string description: Id externo dependentDraft: description: Rascunho de dependente type: object required: – name – jsonDraft – originType properties: id: type: string maxLength: 32 description: Id do rascunho name: type: string description: Nome do depentend jsonDraft: type: string description: JSON do rascunho originType: type: string allOf: – #/definitions/originDraftType description: Origem do rascunho externalId: type: string description: Identificador Externo attachment: type: object allOf: – #/definitions/attachment description: Foto do dependente admissionDraft: type: object allOf: – #/definitions/admissionDraft description: Rascunho de admissao employee: type: object allOf: – #/definitions/employee description: Colaborador withWarning: type: boolean description: Caso dê algum problema de validação na inserção da lista default: false messageError: type: string description: Mensagem de erro da inserção da lista 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