(PRIVATE) – Dependentes (dependent)

2.0info: 7.5.2 (PRIVATE) – 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: api.senior.com.br /private/hcm/dependentsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /dependentDraftSaveBatch: post: description: Salva o rascunho de vários dependentes onboarding x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – dependentDraftSaveData properties: dependentDraftSaveData: type: array items: #/definitions/dependentDraftSaveData description: lista de rascunhos de dependetes. responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /listJudicialPensionBankAccountQuery: post: description: Retorna uma lista de contas bancárias na competência informada x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – dependentId – dateWhen properties: dependentId: type: string description: Id do dependente dateWhen: type: string description: Data de referencia do historico responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/historicalJudicialPensionBankAccountData default: description: Error response schema: #/definitions/genericError /historicalJudicialPensionBankAccountIntegrationQuery: post: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do registro responses: 200: description: Ok schema: #/definitions/historicalJudicialPensionBankAccount default: description: Error response schema: #/definitions/genericError /dependentDraftQuery: post: description: Retorna o rascunho do dependente x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: #/definitions/dependentDraftData default: description: Error response schema: #/definitions/genericError /judicialPensionClosure: post: description: Encerramento da pensão judicial x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 description: Data de encerramento responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /dependentListQuery: post: description: Retorna os dependentes de um colaborador x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – employeeId – page properties: employeeId: type: string description: Id do colaborador page: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/dependentListQueryData default: description: Error response schema: #/definitions/genericError /historicalJudicialPensionBankAccountSave: post: description: Salva históricos de contas bancárias da pensão judicial x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – dependentId – dateWhen – listHistoricalBankAccount properties: dependentId: type: string description: Dependente dateWhen: type: string description: Data do histórico listHistoricalBankAccount: type: array items: #/definitions/historicalJudicialPensionBankAccountData description: Lista de contas bancárias responses: 200: description: Ok schema: type: object required: – result – createdItems properties: result: #/definitions/resultBaseData createdItems: #/definitions/historicalJudicialPensionBankAccountData default: description: Error response schema: #/definitions/genericError /dependentDraftList: post: description: Retorna uma lista de rascunhos do dependente x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/dependentDraftQueryData default: description: Error response schema: #/definitions/genericError /blobServiceDelete: post: description: Solicitação para apagar um arquivo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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) responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /getMetadata: post: description: Default 'getMetadata' query. Every service must handle this command and return metadata in the format requested. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: default: description: Error response schema: #/definitions/genericError /enumQuery: post: description: Retorna os itens das enumerações traduzidos x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – names properties: names: type: array items: type: string description: Nomes das enumerações responses: 200: description: Ok schema: type: object required: – results properties: results: #/definitions/enumInformationData default: description: Error response schema: #/definitions/genericError /healthcheck: post: description: HealthCheck Plataforma x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – status – checks properties: status: #/definitions/heathcheckDTO checks: #/definitions/checkDTO default: description: Error response schema: #/definitions/genericError /blobServiceRequestAccess: post: description: Solicitação para acessar um arquivo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 description: Tempo em minutos que o arquivo deve ficar disponível para download no link que será retornado (padrão 30 minutos) thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto e que deve ser retornado seu Thumbnail(128X128px) responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/blobServiceRequestAccessData default: description: Error response schema: #/definitions/genericError /dependentSave: post: description: Salvar um dependente x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – sheetPersona – sheetDocument – sheetControls properties: sheetPersona: #/definitions/dependentPersonaData sheetDocument: #/definitions/dependentDocumentData sheetControls: #/definitions/dependentControlsData dependentDraftId: type: string description: Id do rascunho do dependente responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/dependentAdditionData default: description: Error response schema: #/definitions/genericError /integrationSaveBatch: post: description: Salva um lote de entidades x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: #/definitions/integrationSaveBatchData default: description: Error response schema: #/definitions/genericError /dependentDraftSave: post: description: Salva o rascunho do dependente x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: #/definitions/originDraftType attachment: #/definitions/fileUploadedData 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: #/definitions/dependentDraftSaveReturn default: description: Error response schema: #/definitions/genericError /migrate: post: description: Realiza a migração da base de dados x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId 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 default: description: Error response schema: #/definitions/genericError /odata: post: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /listDependentDraftSave: post: description: Salva uma lista de dependentes x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: #/definitions/resultSaveList default: description: Error response schema: #/definitions/genericError /dependentDependenciesQuery: post: description: Consulta de dependente e suas dependências x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: #/definitions/dependentDependenciesData default: description: Error response schema: #/definitions/genericError /blobServiceRequestUpload: post: description: Solicitação para realizar o upload de um arquivo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/blobServiceRequestUploadData default: description: Error response schema: #/definitions/genericError /historicalJudicialPensionBankAccountQuery: post: description: Retorna os históricos de contas bancárias por dependente x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – dependentId – page properties: dependentId: type: string description: Id do dependente page: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/pagedHistoricalJudicialPensionBankAccountQueryData default: description: Error response schema: #/definitions/genericError /dependentExistsCpfByEmployee: post: description: Retorna se existe um dependente do mesmo colaborador com o cpf passado por parâmetro x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: string description: Id do colaborador dependentId: type: string description: Id do dependente para ser ignorado 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 default: description: Error response schema: #/definitions/genericError /dependentBasicInformations: post: description: Informações básicas do dependente x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: #/definitions/dependentBasicInformationsData default: description: Error response schema: #/definitions/genericError /blobServiceCommit: post: description: Realiza o commit de um arquivo que foi carregado anteriormente x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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) responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /historicalJudicialPensionBankAccountDelete: post: description: Deleta históricos de contas bancárias do colaborador x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – dependentId – dateWhen properties: dependentId: type: string description: Dependente dateWhen: type: string description: Data do histórico responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /serviceStarted: post: description: Default 'serviceStarted' event. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – domain – service properties: domain: type: string description: service: type: string description: responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /notifyUserEvent: post: description: Default 'notifyUser' event. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/notifyUserEventPayload responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/company: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/company responses: 200: description: The created resource schema: #/definitions/company default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/company responses: 200: description: The created resource schema: #/definitions/company default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/company default: description: Error response schema: #/definitions/genericError /entities/company/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/company default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/company/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/company responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/dependentDraft: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/dependentDraft responses: 200: description: The created resource schema: #/definitions/dependentDraft default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/dependentDraft responses: 200: description: The created resource schema: #/definitions/dependentDraft default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/dependentDraft default: description: Error response schema: #/definitions/genericError /entities/dependentDraft/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentDraft responses: 200: description: Ok schema: #/definitions/dependentDraft default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentDraft responses: 200: description: Ok schema: #/definitions/dependentDraft default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dependentDraft default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/dependentDraft/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/dependentDraft responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/bank: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: The created resource schema: #/definitions/bank default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: The created resource schema: #/definitions/bank default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/bank default: description: Error response schema: #/definitions/genericError /entities/bank/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: Ok schema: #/definitions/bank default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: Ok schema: #/definitions/bank default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/bank default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/bank/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/bank responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/educationdegree: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/educationdegree responses: 200: description: The created resource schema: #/definitions/educationdegree default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/educationdegree responses: 200: description: The created resource schema: #/definitions/educationdegree default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/educationdegree default: description: Error response schema: #/definitions/genericError /entities/educationdegree/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/educationdegree responses: 200: description: Ok schema: #/definitions/educationdegree default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/educationdegree responses: 200: description: Ok schema: #/definitions/educationdegree default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/educationdegree default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/educationdegree/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/educationdegree responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/address: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/address responses: 200: description: The created resource schema: #/definitions/address default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/address responses: 200: description: The created resource schema: #/definitions/address default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/address default: description: Error response schema: #/definitions/genericError /entities/address/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/address responses: 200: description: Ok schema: #/definitions/address default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/address responses: 200: description: Ok schema: #/definitions/address default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/address default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/address/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/address responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/wagetype: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/wagetype responses: 200: description: The created resource schema: #/definitions/wagetype default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/wagetype responses: 200: description: The created resource schema: #/definitions/wagetype default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/wagetype default: description: Error response schema: #/definitions/genericError /entities/wagetype/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/wagetype responses: 200: description: Ok schema: #/definitions/wagetype default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/wagetype responses: 200: description: Ok schema: #/definitions/wagetype default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/wagetype default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/wagetype/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/wagetype responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/judicialBase: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/judicialBase responses: 200: description: The created resource schema: #/definitions/judicialBase default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/judicialBase responses: 200: description: The created resource schema: #/definitions/judicialBase default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/judicialBase default: description: Error response schema: #/definitions/genericError /entities/judicialBase/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialBase responses: 200: description: Ok schema: #/definitions/judicialBase default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialBase responses: 200: description: Ok schema: #/definitions/judicialBase default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/judicialBase default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/judicialBase/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/judicialBase responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/attachment: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/attachment responses: 200: description: The created resource schema: #/definitions/attachment default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/attachment responses: 200: description: The created resource schema: #/definitions/attachment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/attachment default: description: Error response schema: #/definitions/genericError /entities/attachment/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/attachment responses: 200: description: Ok schema: #/definitions/attachment default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/attachment responses: 200: description: Ok schema: #/definitions/attachment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/attachment default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/attachment/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/attachment responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/document: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/document responses: 200: description: The created resource schema: #/definitions/document default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/document responses: 200: description: The created resource schema: #/definitions/document default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/document default: description: Error response schema: #/definitions/genericError /entities/document/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/document responses: 200: description: Ok schema: #/definitions/document default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/document responses: 200: description: Ok schema: #/definitions/document default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/document default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/document/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/document responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/judicialPayeeItem: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/judicialPayeeItem responses: 200: description: The created resource schema: #/definitions/judicialPayeeItem default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/judicialPayeeItem responses: 200: description: The created resource schema: #/definitions/judicialPayeeItem default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/judicialPayeeItem default: description: Error response schema: #/definitions/genericError /entities/judicialPayeeItem/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialPayeeItem responses: 200: description: Ok schema: #/definitions/judicialPayeeItem default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialPayeeItem responses: 200: description: Ok schema: #/definitions/judicialPayeeItem default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/judicialPayeeItem default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/judicialPayeeItem/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/judicialPayeeItem responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/phone: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/phone responses: 200: description: The created resource schema: #/definitions/phone default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/phone responses: 200: description: The created resource schema: #/definitions/phone default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/phone default: description: Error response schema: #/definitions/genericError /entities/phone/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/phone responses: 200: description: Ok schema: #/definitions/phone default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/phone responses: 200: description: Ok schema: #/definitions/phone default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/phone default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/phone/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/phone responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/historicalJudicialPensionBankAccount: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/historicalJudicialPensionBankAccount default: description: Error response schema: #/definitions/genericError /entities/professionalcouncil: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/professionalcouncil responses: 200: description: The created resource schema: #/definitions/professionalcouncil default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/professionalcouncil responses: 200: description: The created resource schema: #/definitions/professionalcouncil default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/professionalcouncil default: description: Error response schema: #/definitions/genericError /entities/professionalcouncil/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/professionalcouncil responses: 200: description: Ok schema: #/definitions/professionalcouncil default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/professionalcouncil responses: 200: description: Ok schema: #/definitions/professionalcouncil default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/professionalcouncil default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/professionalcouncil/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/professionalcouncil responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/judicialBaseItem: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/judicialBaseItem responses: 200: description: The created resource schema: #/definitions/judicialBaseItem default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/judicialBaseItem responses: 200: description: The created resource schema: #/definitions/judicialBaseItem default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/judicialBaseItem default: description: Error response schema: #/definitions/genericError /entities/judicialBaseItem/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialBaseItem responses: 200: description: Ok schema: #/definitions/judicialBaseItem default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialBaseItem responses: 200: description: Ok schema: #/definitions/judicialBaseItem default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/judicialBaseItem default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/judicialBaseItem/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/judicialBaseItem responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/wageTypeTable: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/wageTypeTable responses: 200: description: The created resource schema: #/definitions/wageTypeTable default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/wageTypeTable responses: 200: description: The created resource schema: #/definitions/wageTypeTable default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/wageTypeTable default: description: Error response schema: #/definitions/genericError /entities/wageTypeTable/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/wageTypeTable responses: 200: description: Ok schema: #/definitions/wageTypeTable default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/wageTypeTable responses: 200: description: Ok schema: #/definitions/wageTypeTable default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/wageTypeTable default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/wageTypeTable/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/wageTypeTable responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/judicialPayment: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/judicialPayment responses: 200: description: The created resource schema: #/definitions/judicialPayment default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/judicialPayment responses: 200: description: The created resource schema: #/definitions/judicialPayment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/judicialPayment default: description: Error response schema: #/definitions/genericError /entities/judicialPayment/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialPayment responses: 200: description: Ok schema: #/definitions/judicialPayment default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialPayment responses: 200: description: Ok schema: #/definitions/judicialPayment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/judicialPayment default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/judicialPayment/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/judicialPayment responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/payrollcalculation: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/payrollcalculation responses: 200: description: The created resource schema: #/definitions/payrollcalculation default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/payrollcalculation responses: 200: description: The created resource schema: #/definitions/payrollcalculation default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/payrollcalculation default: description: Error response schema: #/definitions/genericError /entities/payrollcalculation/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/payrollcalculation responses: 200: description: Ok schema: #/definitions/payrollcalculation default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/payrollcalculation responses: 200: description: Ok schema: #/definitions/payrollcalculation default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/payrollcalculation default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/payrollcalculation/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/payrollcalculation responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/financialIndex: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/financialIndex responses: 200: description: The created resource schema: #/definitions/financialIndex default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/financialIndex responses: 200: description: The created resource schema: #/definitions/financialIndex default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/financialIndex default: description: Error response schema: #/definitions/genericError /entities/financialIndex/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/financialIndex responses: 200: description: Ok schema: #/definitions/financialIndex default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/financialIndex responses: 200: description: Ok schema: #/definitions/financialIndex default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/financialIndex default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/financialIndex/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/financialIndex responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/bankAccount: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/bankAccount responses: 200: description: The created resource schema: #/definitions/bankAccount default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/bankAccount responses: 200: description: The created resource schema: #/definitions/bankAccount default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/bankAccount default: description: Error response schema: #/definitions/genericError /entities/bankAccount/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bankAccount responses: 200: description: Ok schema: #/definitions/bankAccount default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bankAccount responses: 200: description: Ok schema: #/definitions/bankAccount default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/bankAccount default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/bankAccount/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/bankAccount responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/city: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/city responses: 200: description: The created resource schema: #/definitions/city default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/city responses: 200: description: The created resource schema: #/definitions/city default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/city default: description: Error response schema: #/definitions/genericError /entities/city/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/city responses: 200: description: Ok schema: #/definitions/city default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/city responses: 200: description: Ok schema: #/definitions/city default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/city default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/city/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/city responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/variableJudicialValue: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/variableJudicialValue responses: 200: description: The created resource schema: #/definitions/variableJudicialValue default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/variableJudicialValue responses: 200: description: The created resource schema: #/definitions/variableJudicialValue default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/variableJudicialValue default: description: Error response schema: #/definitions/genericError /entities/variableJudicialValue/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/variableJudicialValue responses: 200: description: Ok schema: #/definitions/variableJudicialValue default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/variableJudicialValue responses: 200: description: Ok schema: #/definitions/variableJudicialValue default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/variableJudicialValue default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/variableJudicialValue/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/variableJudicialValue responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/companyIndication: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/companyIndication default: description: Error response schema: #/definitions/genericError /entities/neighborhood: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/neighborhood responses: 200: description: The created resource schema: #/definitions/neighborhood default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/neighborhood responses: 200: description: The created resource schema: #/definitions/neighborhood default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/neighborhood default: description: Error response schema: #/definitions/genericError /entities/neighborhood/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/neighborhood responses: 200: description: Ok schema: #/definitions/neighborhood default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/neighborhood responses: 200: description: Ok schema: #/definitions/neighborhood default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/neighborhood default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/neighborhood/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/neighborhood responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/judicialAdjustment: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/judicialAdjustment responses: 200: description: The created resource schema: #/definitions/judicialAdjustment default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/judicialAdjustment responses: 200: description: The created resource schema: #/definitions/judicialAdjustment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/judicialAdjustment default: description: Error response schema: #/definitions/genericError /entities/judicialAdjustment/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialAdjustment responses: 200: description: Ok schema: #/definitions/judicialAdjustment default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialAdjustment responses: 200: description: Ok schema: #/definitions/judicialAdjustment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/judicialAdjustment default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/judicialAdjustment/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/judicialAdjustment responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/fixedJudicialValue: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/fixedJudicialValue responses: 200: description: The created resource schema: #/definitions/fixedJudicialValue default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/fixedJudicialValue responses: 200: description: The created resource schema: #/definitions/fixedJudicialValue default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/fixedJudicialValue default: description: Error response schema: #/definitions/genericError /entities/fixedJudicialValue/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/fixedJudicialValue responses: 200: description: Ok schema: #/definitions/fixedJudicialValue default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/fixedJudicialValue responses: 200: description: Ok schema: #/definitions/fixedJudicialValue default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/fixedJudicialValue default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/fixedJudicialValue/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/fixedJudicialValue responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/judicialPayee: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/judicialPayee responses: 200: description: The created resource schema: #/definitions/judicialPayee default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/judicialPayee responses: 200: description: The created resource schema: #/definitions/judicialPayee default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/judicialPayee default: description: Error response schema: #/definitions/genericError /entities/judicialPayee/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialPayee responses: 200: description: Ok schema: #/definitions/judicialPayee default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/judicialPayee responses: 200: description: Ok schema: #/definitions/judicialPayee default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/judicialPayee default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/judicialPayee/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/judicialPayee responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/bankBranch: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/bankBranch responses: 200: description: The created resource schema: #/definitions/bankBranch default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/bankBranch responses: 200: description: The created resource schema: #/definitions/bankBranch default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/bankBranch default: description: Error response schema: #/definitions/genericError /entities/bankBranch/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bankBranch responses: 200: description: Ok schema: #/definitions/bankBranch default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bankBranch responses: 200: description: Ok schema: #/definitions/bankBranch default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/bankBranch default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/bankBranch/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/bankBranch responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/employee: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/employee responses: 200: description: The created resource schema: #/definitions/employee default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/employee responses: 200: description: The created resource schema: #/definitions/employee default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/employee default: description: Error response schema: #/definitions/genericError /entities/employee/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employee responses: 200: description: Ok schema: #/definitions/employee default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employee responses: 200: description: Ok schema: #/definitions/employee default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employee default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/employee/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/employee responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/state: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/state responses: 200: description: The created resource schema: #/definitions/state default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/state responses: 200: description: The created resource schema: #/definitions/state default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/state default: description: Error response schema: #/definitions/genericError /entities/state/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/state responses: 200: description: Ok schema: #/definitions/state default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/state responses: 200: description: Ok schema: #/definitions/state default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/state default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/state/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/state responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/dependentrequestupdate: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/dependentrequestupdate responses: 200: description: The created resource schema: #/definitions/dependentrequestupdate default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/dependentrequestupdate responses: 200: description: The created resource schema: #/definitions/dependentrequestupdate default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/dependentrequestupdate default: description: Error response schema: #/definitions/genericError /entities/dependentrequestupdate/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentrequestupdate responses: 200: description: Ok schema: #/definitions/dependentrequestupdate default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentrequestupdate responses: 200: description: Ok schema: #/definitions/dependentrequestupdate default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dependentrequestupdate default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/dependentrequestupdate/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/dependentrequestupdate responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/othercompany: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/othercompany responses: 200: description: The created resource schema: #/definitions/othercompany default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/othercompany responses: 200: description: The created resource schema: #/definitions/othercompany default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/othercompany default: description: Error response schema: #/definitions/genericError /entities/othercompany/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/othercompany responses: 200: description: Ok schema: #/definitions/othercompany default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/othercompany responses: 200: description: Ok schema: #/definitions/othercompany default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/othercompany default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/othercompany/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/othercompany responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/country: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/country responses: 200: description: The created resource schema: #/definitions/country default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/country responses: 200: description: The created resource schema: #/definitions/country default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/country default: description: Error response schema: #/definitions/genericError /entities/country/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/country responses: 200: description: Ok schema: #/definitions/country default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/country responses: 200: description: Ok schema: #/definitions/country default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/country default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/country/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/country responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/admissionDraft: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/admissionDraft responses: 200: description: The created resource schema: #/definitions/admissionDraft default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/admissionDraft responses: 200: description: The created resource schema: #/definitions/admissionDraft default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/admissionDraft default: description: Error response schema: #/definitions/genericError /entities/admissionDraft/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/admissionDraft responses: 200: description: Ok schema: #/definitions/admissionDraft default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/admissionDraft responses: 200: description: Ok schema: #/definitions/admissionDraft default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/admissionDraft default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/admissionDraft/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/admissionDraft responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/person: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/person responses: 200: description: The created resource schema: #/definitions/person default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/person responses: 200: description: The created resource schema: #/definitions/person default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/person default: description: Error response schema: #/definitions/genericError /entities/person/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/person responses: 200: description: Ok schema: #/definitions/person default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/person responses: 200: description: Ok schema: #/definitions/person default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/person default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/person/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/person responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericErrordefinitions: heathcheckDTO: type: string enum: – UP – DOWN originDraftType: type: string enum: – PAYROLL – RECRUITMENT – ONBOARDING – WORKFLOW directionType: type: string enum: – ASC – DESC employeeType: type: string enum: – NULL – EMPLOYEE – THIRD – PARTNER actionType: type: string enum: – SAVE – EDIT – DELETE genderType: type: string enum: – Male – Female kinshipDegreeType: 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: type: string enum: – DontTakeDependent – Spouse – Partner – SonStepson – SonStepsonStudent – SiblingGrandsonGreat – SiblingGrandsonGreatStudent – ParentsGrandparentsGreat – PoorMinor – IncapablePerson – ExSpouse – AggregateOthers maritalStatusType: type: string enum: – Single – Married – Divorced – Widower – Concubinage – Separated – StableUnion – Others degreeInstructionType: type: string enum: – Illiterate – ElementarySchoolIncomplete – ElementarySchoolComplete – MiddleSchoolIncomplete – MiddleSchoolComplete – HighSchoolIncomplete – HighSchoolComplete – BachelorIncomplete – BachelorComplete – Postgraduate – Master – Doctoral civilCertificateType: type: string enum: – BIRTH_CERTIFICATE – MARRIAGE_CERTIFICATE – INDIGENOUS_PERSONS_BIRTH_CERTIFICATE – DEATH_CERTIFICATE classOrganType: type: string enum: – CRM – RMS – CRO professionalCouncilSituationType: type: string enum: – DEFINITIVE – TEMPORARY documentType: 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 subscriptionType: type: string enum: – CNPJ – CEI – CPF – INCRA schoolGradeType: 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 requestStatus: 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 addressType: 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 phoneType: type: string enum: – PERSONAL – PROFESSIONAL – MOBILE – BUSINESS_FAX – PERSONAL_FAX – OTHER accountType: type: string enum: – CURRENT_ACCOUNT – SAVING_ACCOUNT – SALARY_ACCOUNT – OTHER salary13Type: type: string enum: – YES – NO – PARTIAL salaryAdvancedType: type: string enum: – YES – NO – PERCENTAGE decisionType: type: string enum: – YES – NO informationType: type: string enum: – CUMULATIVE – PERCENTAGE – FIXED_PERCENTEGE – DAILY_VALUE – MONTHLY_VALUE indexType: type: string enum: – OTHER – UFIR – URV – ITRD – SELIC – CONTRIBUTION_SALARY_CORRECTION – SAVINGS_CORRECTION – CURRENCY fgtsPensionType: type: string enum: – NOT_APPLICABLE – VALUE – PERCENTAGE originType: type: string enum: – NORMAL_CALCULATION – VACATION – TERMINATION – COMPLEMENTARY_TERMINATION – INDEMNITY – THIRD judicialPaymentType: type: string enum: – NORMAL – VACATION – SALARY_13 – WAGE_BONUS – THIRD calculationType: 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 calculationSituationType: type: string enum: – CALCULATION_CANCELED – INITIALIZED – TOTAL_CALCULATION – PARTIAL_CALCULATION – SIMULATED_CALCULATION operationType: type: string enum: – ADD – SUBTRACT – CHANGE – SUBTRACT_WITH_EVENT – DEDUCT_WITH_EVENT judicialBaseType: type: string enum: – MONTHLY – VACATION – PLR – SALARY_13 baseType: 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 signalType: type: string enum: – POSITIVE – NEGATIVE wageTypeCategoryType: type: string enum: – PROCEEDS – ADVANTAGE – DEDUCTION – INFORMATIVE – OTHER_PROCEEDS – OTHER_DEDUCTION wageValueType: type: string enum: – VALUE – HOUR userNotificationKind: type: string enum: – Operational – Management – News userNotificationPriority: type: string enum: – Error – Alert – None checkDTO: type: object required: – name – status properties: name: type: string description: Nome do status status: #/definitions/heathcheckDTO enumInformationData: type: object required: – enumName – items properties: enumName: type: string description: Nome da enumeração items: type: array items: #/definitions/enumInformationItemData description: Lista com os items das enumerações enumInformationItemData: 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 pagination: type: object required: – current – size properties: current: type: integer description: Página de inicio size: type: integer description: Quantidade de páginas (iniciando por 1) orderBy: type: array items: #/definitions/ordination description: Ordenar por ordination: type: object required: – field properties: field: type: string description: Campo que será ordenado direction: #/definitions/directionType resultBaseData: type: object required: – ok properties: ok: type: boolean description: Flag para indicar sucesso warning: type: boolean description: Flag para indicar sucesso com alerta message: type: string description: Mensagem de retorno dependentDraftSaveReturn: type: object required: – ok – dependentDraftId properties: ok: type: boolean description: Flag para indicar sucesso warning: type: boolean description: Flag para indicar sucesso com alerta message: type: string description: Mensagem de retorno dependentDraftId: type: string description: ID do Rascunho salvo dependentDraftSaveData: type: object required: – jsonDraft properties: name: type: string description: Nome do depentend jsonDraft: type: string description: JSON do rascunho originType: #/definitions/originDraftType admissionDraftId: type: string description: Rascunho de admissao employeeId: type: string description: Colaborador externalId: type: string description: Identificador Externo resultSaveList: type: object properties: warning: type: boolean description: Flag para indicar sucesso com alerta message: type: string description: Mensagem de retorno dependentPersonaData: type: object required: – employeeId – name – degreeOfKinship – eSocialDependentType properties: attachment: #/definitions/fileUploadedData employeeId: #/definitions/employee dependentId: type: string description: Id do dependente name: type: string description: Nome gender: #/definitions/autocompleteEnumData degreeOfKinship: #/definitions/autocompleteEnumData eSocialDependentType: #/definitions/autocompleteEnumData motherName: type: string description: Nome da mae birthday: type: string description: Data de nascimento da pessoa format: date maritalStatus: #/definitions/autocompleteEnumData degreeOfEducation: #/definitions/autocompleteData cityOfBirth: #/definitions/autocompleteData stateOfBirth: #/definitions/autocompleteData countryOfBirth: #/definitions/autocompleteData customFieldsDependent: type: array items: #/definitions/customData description: Campos do usuário da entidade person disabilityDate: type: string description: Data da invalidez format: date fileUploadedData: type: object properties: attachmentId: type: string 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 employee: type: object properties: id: type: string description: Id do colaborador companynumber: type: integer description: Empresa do colaborador: NUMEMP employeetype: #/definitions/employeeType registernumber: type: integer description: Código do colaborador: NUMCAD person: #/definitions/person employer: #/definitions/company hiredate: type: string description: Data de admissão format: date person: type: object required: – firstname – lastname properties: id: type: string 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 company: type: object required: – cnpj – companyname properties: id: type: string description: Id da entidade. code: type: integer 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 autocompleteEnumData: type: object required: – key properties: key: type: string description: Chave do enum value: type: string description: Valor do enum autocompleteData: type: object required: – tableId properties: tableId: type: string description: Id da tabela name: type: string description: Descrição da tabela customData: 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 dependentDocumentData: type: object properties: dependentCpfDocumentsGroup: #/definitions/dependentCpfDocumentsGroup dependentIdentityRegistryDocumentsGroup: #/definitions/dependentIdentityRegistryDocumentsGroup dependentNationalHealthDocumentsGroup: #/definitions/dependentNationalHealthDocumentsGroup dependentRgNumberDocumentsGroup: #/definitions/dependentRgNumberDocumentsGroup dependentCivilCertificateDocumentsGroup: #/definitions/dependentCivilCertificateDocumentsGroup dependentDeathCertificateDocumentsGroup: #/definitions/dependentDeathCertificateDocumentsGroup dependentCpfDocumentsGroup: type: object properties: cpfNumber: type: string description: CPF da pessoa dependentIdentityRegistryDocumentsGroup: type: object properties: civilianIdentityRegistry: type: string description: Registro de identidade civil dependentNationalHealthDocumentsGroup: type: object properties: nationalHealthCard: type: string description: Cartão nacional de saúde dependentRgNumberDocumentsGroup: type: object properties: rgNumberEmissionDate: type: string description: Data de emissão format: date rgNumberState: #/definitions/autocompleteData rgNumberIssuer: type: string description: Orgão emissor rgNumber: type: string description: Número do rg dependentCivilCertificateDocumentsGroup: type: object properties: civilCertificate: #/definitions/autocompleteEnumData civilCertificateRegistry: type: string description: Matrícula do certidão civil civilCertificateTerm: type: string description: Termo da certidão civil declarationOfLiveBirth: type: string description: Declaração de nascido vivo civilCertificateNotaryOffice: type: string description: Cartório da certidão civil civilCertificatePage: type: string description: Folha da certidão civil civilCertificateBook: type: string description: Livro do certidão civil dependentDeathCertificateDocumentsGroup: type: object properties: deathDate: type: string description: Data do óbito format: date deathCertificateRegistry: type: string description: Número da certidão de óbito deathCertificateTerm: type: string description: Termo da certidão de óbito dependentControlsData: type: object properties: tutelageGroup: #/definitions/tutelageData childcareAssistanceGroup: #/definitions/childcareAssistanceData familySalaryGroup: #/definitions/familySalaryData familySalaryDocumentGroup: #/definitions/familySalaryDocumentData isIncomeTaxRequired: type: boolean description: Se o dependente deve ter os campos obrigatários do imposto de renda preenchidos dependentIncomeTaxGroup: #/definitions/dependentIncomeTaxData dependentHealthInsuranceGroup: #/definitions/dependentHealthInsuranceData tutelageData: type: object properties: id: type: string description: Id do tutelado startDate: type: string description: Data de inicio da tutela format: date endDate: type: string description: Data final da tutela format: date childcareAssistanceData: type: object properties: id: type: string description: Id do auxílio creche childcareAssistance: type: boolean description: Se tem auxílio creche months: type: integer description: Meses familySalaryData: type: object properties: id: type: string description: Id do salário familia ageLimitSalaryFamily: type: integer description: Idade limite do salário familia certificateSubmission: type: string description: Data de entrega da certidão format: date printedNotice: type: boolean description: Aviso impresso familySalaryDocument: type: array items: #/definitions/familySalaryDocumentData description: Documentos do salário familia familySalaryDocumentData: type: object required: – referenceYear – actionType properties: id: type: string description: Id da entidade referenceYear: type: integer description: Ano de referência school: #/definitions/autocompleteData scholarship: type: boolean description: É bolsista? schoolGrade: #/definitions/autocompleteEnumData frequencyInMay: type: string description: Frequência em maio format: date percentageInMay: type: number description: Percentual em maio format: double frequencyInNovember: type: string description: Frequência em novembro format: date percentageInNovember: type: number description: Percentual em novembro format: double vaccination: type: string description: Vacinação format: date actionType: #/definitions/actionType dependentIncomeTaxData: type: object properties: id: type: string description: Id da entidade ageLimitIncomeTax: type: integer description: Idade limite imposto de renda beginCompetence: type: string description: Inicio da competência format: date endCompetence: type: string description: Fim da competência format: date dependentHealthInsuranceData: type: object properties: id: type: string description: Id da entidade registration: type: integer description: Matrícula startDate: type: string description: Data da inclusão format: date endDate: type: string description: Data da exclusão format: date dependentDependenciesData: type: object required: – dependent – documents – tutelage – childcareAssistance – familySalary – familySalaryDocuments – dependentIncomeTax – dependentHealthInsurance properties: dependent: #/definitions/dependent documents: type: array items: #/definitions/document description: Documentos tutelage: #/definitions/tutelage childcareAssistance: #/definitions/childcareAssistance familySalary: #/definitions/familySalary familySalaryDocuments: type: array items: #/definitions/familySalaryDocument description: Comprovantes de salário família dependentIncomeTax: #/definitions/dependentIncomeTax dependentHealthInsurance: #/definitions/dependentHealthInsurance dependent: 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 description: Id do dependente birthdate: type: string description: Data de nascimento format: date employee: #/definitions/employee fullname: type: string description: Nome completo gender: #/definitions/genderType 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: #/definitions/kinshipDegreeType eSocialDependentType: #/definitions/eSocialDependentType birthcertificate: type: string description: Certidão de nascimento cpf: type: string description: CPF rg: type: string description: RG deathcertificate: type: string description: Certidão de óbito deathdate: type: string description: Data de óbito format: date maritalstatus: #/definitions/maritalStatusType educationdegree: #/definitions/educationdegree mothersname: type: string description: Nome da mãe placeofbirth: #/definitions/city livebirthdeclaration: type: string description: Declaração de nascimento agelimitir: type: integer description: Limite de idade para IR agelimitfamilysalary: type: integer description: Limite de idade para pensão familiar nameNotary: 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 attachment: #/definitions/attachment disabilityDate: type: string description: Data da invalidez format: date educationdegree: type: object properties: id: type: string description: Id do grau de instrução code: type: integer description: Código do grau de instrução name: type: string description: Nome do grau de instrução nameRais: #/definitions/degreeInstructionType city: type: object required: – name properties: id: type: string description: Id da cidade name: type: string description: Nome da cidade stateId: #/definitions/state state: type: object properties: id: type: string description: Id do estado name: type: string description: Nome do estado abbreviation: type: string description: Abreviação do nome do estado countryId: #/definitions/country country: type: object properties: id: type: string description: Id do país name: type: string description: Nome do país abbreviation: type: string description: Abreviação do nome do país attachment: 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 description: Pessoa sourceId: type: string description: Identificador do anexo sourceType: type: string description: Tipo do anexo createdat: type: string description: Data de criação format: date updatedat: type: string description: Data de alteração format: date status: type: integer description: Status document: 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 description: Id do documento documentNumber: type: string description: Número do documento issuer: type: string description: Orgão emissor issuerState: #/definitions/state issuerCity: #/definitions/city issuerCountry: #/definitions/country dateOfIssue: type: string description: Data da expedição format: date expirationDate: type: string description: Data de validade format: date category: type: string description: Categoria civilCertificate: #/definitions/civilCertificateType termOfCivilCertificate: type: string description: Termo da certidão de nascimento notaryOffice: type: string 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: #/definitions/professionalcouncil professionalRegistry: type: string description: Registro profissional councilRegistry: type: string description: Registro do conselho professionalCouncilSituation: #/definitions/professionalCouncilSituationType professionalCouncilExpeditionDate: type: string description: Data da expedição do conselho profissional format: date professionalCouncilExpirationDate: type: string description: Data de validade do conselho profissional format: date firstDriverLicenceDate: type: string description: Data da primeira habilitação format: date documentType: #/definitions/documentType person: type: string description: Id da pessoa do documento dependent: #/definitions/dependent professionalcouncil: type: object required: – id – code – abbreviation – name – region – classOrganType properties: id: type: string description: Identificador conselho profissional code: type: integer description: Código conselho profissional abbreviation: type: string description: Abreviação conselho profissional name: type: string description: Descrição conselho profissional headquarter: #/definitions/city region: type: string description: Região conselho profissional classOrganType: #/definitions/classOrganType tutelage: type: object required: – startDate – endDate – dependent properties: id: type: string description: Id do tutelado startDate: type: string description: Data de inicio da tutela format: date endDate: type: string description: Data final da tutela format: date dependent: #/definitions/dependent childcareAssistance: type: object required: – childcareAssistance – months – dependent properties: id: type: string description: Id do auxílio creche childcareAssistance: type: boolean description: Se tem auxílio creche months: type: integer description: Meses dependent: #/definitions/dependent familySalary: type: object required: – ageLimitSalaryFamily – certificateSubmission – printedNotice – dependent properties: id: type: string description: Id do salário familia ageLimitSalaryFamily: type: integer description: Idade limite do salário familia certificateSubmission: type: string description: Data de entrega da certidão format: date printedNotice: type: boolean description: Aviso impresso dependent: #/definitions/dependent externalId: type: string description: Identificador Externo familySalaryDocument: type: object required: – referenceYear – school – scholarship – schoolGrade – frequencyInMay – percentageInMay – frequencyInNovember – percentageInNovember – vaccination – dependent properties: id: type: string description: Id da entidade referenceYear: type: integer description: Ano de referência school: #/definitions/othercompany scholarship: type: boolean description: É bolsista? schoolGrade: #/definitions/schoolGradeType frequencyInMay: type: string description: Frequência em maio format: date percentageInMay: type: number description: Percentual em maio format: double frequencyInNovember: type: string description: Frequência em novembro format: date percentageInNovember: type: number description: Percentual em novembro format: double vaccination: type: string description: Vacinação format: date dependent: #/definitions/dependent othercompany: type: object required: – name – nickname – subscriptionType – subscriptionNumber – subscriptionNumberCNO – subscriptionNumberCAEPF – startDate – endDate properties: id: type: string description: Id da outra empresa name: type: string description: Nome da outra empresa nickname: type: string description: Apelido da outra empresa subscriptionType: #/definitions/subscriptionType subscriptionNumber: type: integer description: Número da inscrição subscriptionNumberCNO: type: integer description: Número inscrição CNO subscriptionNumberCAEPF: type: integer description: Inscrição no CAEPF (número) startDate: type: string description: Data de inicio da validade format: date endDate: type: string description: Data fim da validade format: date dependentIncomeTax: type: object required: – beginCompetence – endCompetence – dependent properties: id: type: string description: Id da entidade ageLimitIncomeTax: type: integer description: Idade limite imposto de renda beginCompetence: type: string description: Inicio da competência format: date endCompetence: type: string description: Fim da competência format: date dependent: #/definitions/dependent dependentHealthInsurance: type: object required: – registration – startDate – endDate – dependent properties: id: type: string description: Id da entidade registration: type: integer description: Matrícula startDate: type: string description: Data da inclusão format: date endDate: type: string description: Data da exclusão format: date dependent: #/definitions/dependent dependentListQueryData: type: object required: – countResult – numberPages – dependents properties: countResult: type: integer description: Indica quantos registros foram encontrados numberPages: type: integer description: Indica o número de páginas da consulta (incluindo a atual) dependents: type: array items: #/definitions/dependentData description: Lista de dependentes dependentData: type: object required: – dependentName – kinshipDegree properties: id: type: string description: Id do dependente dependentName: type: string description: Nome do dependente kinshipDegree: #/definitions/autocompleteEnumData genderType: #/definitions/autocompleteEnumData birthdayDate: type: string description: Data de nascimento format: date mothersName: type: string description: Nome da mãe maritalStatusType: #/definitions/autocompleteEnumData educationDegree: #/definitions/autocompleteData countryOfBirth: #/definitions/autocompleteData stateOfBirth: #/definitions/autocompleteData cityOfBirth: #/definitions/autocompleteData 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: #/definitions/customData description: Campos customizados da entidade Dependent dependentAdditionData: type: object required: – ok – dependentId properties: ok: type: boolean description: Flag para indicar sucesso warning: type: boolean description: Flag para indicar sucesso com alerta message: type: string description: Mensagem de retorno dependentId: type: string description: Id do dependente blobServiceRequestUploadData: type: object required: – ok – fileId – version – locationURI properties: ok: type: boolean description: Flag para indicar sucesso warning: type: boolean description: Flag para indicar sucesso com alerta message: type: string description: Mensagem de retorno 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: type: object required: – ok – locationURI properties: ok: type: boolean description: Flag para indicar sucesso warning: type: boolean description: Flag para indicar sucesso com alerta message: type: string description: Mensagem de retorno locationURI: type: string description: URI onde o arquivo está disponível para download dependentBasicInformationsData: type: object required: – ok – name – pictureId – birthdate – degreeOfKinship – employeeName properties: ok: type: boolean description: Flag para indicar sucesso warning: type: boolean description: Flag para indicar sucesso com alerta message: type: string description: Mensagem de retorno name: type: string description: Nome do dependente pictureId: type: string description: Id da foto birthdate: type: string description: Data de nascimento format: date degreeOfKinship: type: string description: Grau de parentesco employeeName: type: string description: Nome do colaborador do qual é dependente integrationSaveBatchData: 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: type: object required: – countResult – numberPages – drafts properties: countResult: type: integer description: Indica quantos registros foram encontrados numberPages: type: integer description: Indica o número de páginas da consulta (incluindo a atual) drafts: type: array items: #/definitions/dependentDraftData description: Rascunhos dependentDraftData: 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: #/definitions/originDraftType attachment: #/definitions/fileUploadedData admissionDraftId: type: string description: Rascunho de admissao employeeId: type: string description: Colaborador withWarning: type: boolean description: Tem inconsistências messageError: type: string description: Mensagem de erro da inserção da lista historicalJudicialPensionBankAccountData: type: object required: – bankBranch – accountType – bankAccount – percentage properties: id: type: string description: Id do registro dependent: #/definitions/autocompleteData dateWhen: type: string description: Data Início format: date bank: #/definitions/autocompleteData bankBranch: #/definitions/autocompleteData accountType: #/definitions/autocompleteEnumData bankAccount: type: string description: Conta bancária digit: type: string description: Digito da conta percentage: type: number description: Percentual livre format: double numberOfBankAccount: type: integer description: Quantidade de contas vinculado a esta data de histórico customFields: type: array items: #/definitions/customData description: Campos customizados pagedHistoricalJudicialPensionBankAccountQueryData: type: object required: – countResult – numberPages – historicalJudicialPensionBankAccounts properties: countResult: type: integer description: Indica quantos registros foram encontrados numberPages: type: integer description: Indica o número de páginas da consulta (incluindo a atual) historicalJudicialPensionBankAccounts: type: array items: #/definitions/historicalJudicialPensionBankAccountData description: Históricos de contas bancárias dependentrequestupdate: 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 description: Id do dependente request update requester: type: string description: Solicitante approver: type: string description: Aprovador dependentid: #/definitions/dependent daterequest: type: string description: Data da requisição format: date-time requeststatus: #/definitions/requestStatus requestcomment: type: string description: Comentário da requisição reviewcomment: type: string description: Revisão do comentário requesttype: type: integer description: Tipo da requisição dateanalysis: type: string description: Data da Análise format: date-time requestip: type: string description: Requestip analysisip: type: string description: Analysisip birthdate: type: string description: Data de nascimento format: date employee: #/definitions/employee fullname: type: string description: Nome completo gender: #/definitions/genderType 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: #/definitions/kinshipDegreeType eSocialDependentType: #/definitions/eSocialDependentType birthcertificate: type: string description: Certidão de nascimento cpf: type: string description: CPF rg: type: string description: RG deathcertificate: type: string description: Certidão de óbito deathdate: type: string description: Data de óbito format: date maritalstatus: #/definitions/maritalStatusType educationdegree: #/definitions/educationdegree mothersname: type: string description: Nome da mãe placeofbirth: #/definitions/city livebirthdeclaration: type: string description: Declaração de nascimento integrationcomment: type: string description: Comentário da integração agelimitir: type: integer description: Limite de idade para IR agelimitfamilysalary: type: integer description: Limite de idade para pensão familiar address: type: object required: – addresstype – neighborhoodId – address – number properties: id: type: string description: Id da entidade cityId: #/definitions/city addresstype: #/definitions/addressType postalcode: type: string description: Código postal do endereço (CEP) neighborhoodId: #/definitions/neighborhood 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: type: object required: – code – name properties: id: type: string description: Id do bairro. code: type: integer description: Código do bairro name: type: string description: Nome do bairro. city: #/definitions/city phone: type: object required: – phoneType – internationalCode – localCode – number properties: id: type: string description: Id da entidade phoneType: #/definitions/phoneType internationalCode: type: string description: Código do país (DDI) localCode: type: string description: Código da localidade (DDD) number: type: string description: Número do telefone extention: type: string description: Ramal do telefone bankAccount: type: object required: – bank – bankBranch – accountType – bankAccount properties: id: type: string description: Id da entidade bank: #/definitions/bank bankBranch: #/definitions/bankBranch accountType: #/definitions/accountType bankAccount: type: string description: Conta bancária. digit: type: string description: Digito da conta bank: type: object required: – code – name properties: id: type: string description: Id do banco code: type: integer description: Número do banco name: type: string description: Descrição bankBranch: type: object required: – code – name – bank properties: id: type: string description: Id da entidade code: type: integer description: Número da agência name: type: string description: Nome da agência bank: #/definitions/bank fixedJudicialValue: type: object required: – initialValue – salary13Type – salaryAdvancedType – wageBonusType – vacationType properties: id: type: string description: Id da entidade initialValue: type: number description: Valor inicial format: double salary13Type: #/definitions/salary13Type salaryAdvancedType: #/definitions/salaryAdvancedType salaryAdvancedPercentage: type: integer description: Porcentagem do adiantamento salarial para a pensão wageBonusType: #/definitions/decisionType vacationType: #/definitions/decisionType startCorrection: type: string description: Data de inicio da correção format: date financialIndex: #/definitions/financialIndex correctionDay: type: integer description: Dia da correção periodicityCorrection: type: integer description: Periodicidade da correção financialIndex: type: object required: – code – name – informationType – indexType – numberOfDigits – numberOfDecimals properties: id: type: string description: Id do índice code: type: integer description: Código do índice name: type: string description: Nome do índice informationType: #/definitions/informationType indexType: #/definitions/indexType numberOfDigits: type: integer description: Quantidade de dígitos numberOfDecimals: type: integer description: Quantidade de decimais variableJudicialValue: type: object required: – minimumValue – judicialPensionPercentage – judicialPensionVacation – judicialPension13Salary – judicialPensionWageBonus – judicialPensionFgts – fgtsPensionType properties: id: type: string description: Id da entidade minimumValue: type: number description: Valor mínimo format: double judicialPensionPercentage: type: number description: Percentual da pensão judicial format: double judicialPensionVacation: type: number description: Percentual de férias da pensão format: double judicialPension13Salary: type: number description: Percentual de 13o salário da pensão format: double judicialPensionWageBonus: type: number description: Percentual de bônus do salário (PLR) da pensão format: double judicialPensionFgts: type: number description: Percentual de FGTS da pensão format: double fgtsPensionType: #/definitions/fgtsPensionType judicialPayment: type: object required: – dependent – originType – judicialPaymentType – value properties: id: type: string description: Id da entidade dependent: #/definitions/dependent originType: #/definitions/originType judicialPaymentType: #/definitions/judicialPaymentType dateOne: type: string description: Data 1 para uso diverso format: date dateTwo: type: string description: Data 2 para uso diverso format: date dateThree: type: string description: Data 3 para uso diverso format: date payrollcalculation: #/definitions/payrollcalculation baseValue: type: number description: Valor base do pagamento format: double value: type: number description: Valor do pagamento format: double payrollcalculation: type: object required: – company – calculationcode properties: id: type: string description: Id da entidade availableforreference: type: boolean description: Liberar folha no Portal. name: type: string description: Descrição. paymentdate: type: string description: Data de pagamento. format: date periodend: type: string description: Data final do período da folha. format: date periodstart: type: string description: Data inicial do período da folha. format: date referencedate: type: string description: Competência do cálculo. format: date calculationtype: #/definitions/calculationType company: #/definitions/company calculationend: type: string description: Data do fim da apuração do cálculo. format: date calculationstart: type: string description: Data do início da apuração do cálculo. format: date calculationcode: type: integer description: Código do cálculo. calculationSituation: #/definitions/calculationSituationType judicialAdjustment: type: object required: – dependent – originType – judicialPaymentType – operationType – value properties: id: type: string description: Id da entidade dependent: #/definitions/dependent originType: #/definitions/originType judicialPaymentType: #/definitions/judicialPaymentType dateOne: type: string description: Data 1 para uso diverso format: date dateTwo: type: string description: Data 2 para uso diverso format: date payrollcalculation: #/definitions/payrollcalculation operationType: #/definitions/operationType value: type: number description: Valor do pagamento format: double judicialPayee: type: object required: – dependent – startDate – items properties: id: type: string description: Id da entidade dependent: #/definitions/dependent startDate: type: string description: Data de inicio format: date endDate: type: string description: Data de término format: date items: type: array items: #/definitions/judicialPayeeItem description: Item dos beneficiários (Alimentandos) da pensão judicial judicialPayeeItem: type: object required: – judicialPayee – payee – percentageValue properties: id: type: string description: Id da entidade judicialPayee: type: string description: Beneficiários (Alimentandos) da pensão judicial dependent: #/definitions/dependent startDate: type: string description: Data de inicio format: date payee: #/definitions/dependent percentageValue: type: number description: Valor da percentagem format: double judicialBase: type: object required: – judicialBaseType – dependent – startDate – items properties: id: type: string description: Id da entidade judicialBaseType: #/definitions/judicialBaseType dependent: #/definitions/dependent startDate: type: string description: Data de inicio format: date endDate: type: string description: Data de término format: date items: type: array items: #/definitions/judicialBaseItem description: Item das bases da pensão judicial judicialBaseItem: type: object required: – judicialBase – baseType – signalType – wagetype properties: id: type: string description: Id da entidade judicialBase: type: string description: Bases da pensão judicial judicialBaseType: #/definitions/judicialBaseType dependent: #/definitions/dependent startDate: type: string description: Data de inicio format: date baseType: #/definitions/baseType signalType: #/definitions/signalType wagetype: #/definitions/wagetype wagetype: type: object required: – wageTypeTable – code – name – type – wageValueType properties: id: type: string description: Id do evento. wageTypeTable: #/definitions/wageTypeTable code: type: integer description: Código do evento. name: type: string description: Descrição do evento. type: #/definitions/wageTypeCategoryType wageValueType: #/definitions/wageValueType wageTypeTable: type: object required: – code – name – validity properties: id: type: string description: Id da tabela de evento. code: type: integer description: Código da tabela de evento. name: type: string description: Descrição da tabela de evento. validity: type: string description: Indicador de validade. companyIndication: type: object required: – company – useHistoricalBankAccount properties: id: type: string description: Id do assinalamento por empresa company: #/definitions/company useHistoricalBankAccount: type: boolean description: Usa histórico de contas bancárias admissionDraft: type: object required: – company – name – hiringDate – documentNumber – jsonDraft – originType properties: id: type: string description: Id do rascunho company: #/definitions/company name: type: string description: Nome do colaborador hiringDate: type: string description: Data de contratação format: date documentNumber: type: string description: Número do documento jsonDraft: type: string description: JSON do rascunho originType: #/definitions/originDraftType externalId: type: string description: Identificador Externo attachment: #/definitions/attachment historicalJudicialPensionBankAccount: type: object required: – dependent – dateWhen – bankBranch – accountType – percentage properties: id: type: string description: Id do histórico dependent: #/definitions/dependent dateWhen: type: string description: Data início format: date bankBranch: #/definitions/bankBranch accountType: #/definitions/accountType bankAccount: type: string description: Conta bancária digit: type: string description: Digito da conta percentage: type: number description: Percentual livre format: double externalId: type: string description: Id externo dependentDraft: 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: #/definitions/originDraftType externalId: type: string description: Identificador Externo attachment: #/definitions/attachment admissionDraft: #/definitions/admissionDraft employee: #/definitions/employee withWarning: type: boolean description: Caso dê algum problema de validação na inserção da lista messageError: type: string description: Mensagem de erro da inserção da lista notifyUserEventPayload: type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: #/definitions/userNotificationKind notificationPriority: #/definitions/userNotificationPriority 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 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