Gestão de Pessoas (hcm)

Lançamentos (entry)

96 views 28/06/2019 16/11/2020 integrador 0

2.0info: 4.9.0 Lançamentos description: HCM – Lançamentos da folha de pagamento x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: entry contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /entry/queries/healthcheck: post: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/migrate: post: description: Realiza a migração da base de dados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – errorMessage properties: status: type: boolean description: Status da migração errorMessage: type: string description: Mensagem de erro da migração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Realiza a migração da base de dados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – errorMessage properties: status: type: boolean description: Status da migração errorMessage: type: string description: Mensagem de erro da migração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/validateEntryCustomizationScriptQuery: post: description: Primitiva para validar um script na customização de importação de lançamentos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – row – script properties: row: type: string description: Linha de importação script: type: string description: Script da customização responses: 200: description: Ok schema: type: object allOf: – #/definitions/resultBaseData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para validar um script na customização de importação de lançamentos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: row description: Linha de importação in: query required: true type: string – name: script description: Script da customização in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/resultBaseData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/variableEntryItemBatchQuery: post: description: Primitiva para obter um lote de entries importados para o integrador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: identificador do lote responses: 200: description: Ok schema: type: object allOf: – #/definitions/variableEntryItemBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para obter um lote de entries importados para o integrador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: identificador do lote in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/variableEntryItemBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/autocompleteFilterWageType: post: description: Primitiva para obtenção de informações consumidas pelo campo de lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para obtenção de informações consumidas pelo campo de lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/enumQuery: post: description: Retorna os itens das enumerações traduzidos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – names properties: names: type: array items: type: string minimum: 1 description: Nomes das enumerações responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/enumInformationData minimum: 1 description: Lista com as enumerações traduzidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os itens das enumerações traduzidos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: names description: Nomes das enumerações in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/enumInformationData minimum: 1 description: Lista com as enumerações traduzidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/entryVerifyConflict: post: description: Verifica se existe conflito com o lançamento da folha de pagamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – entryType – formType – conflictType – entryItem properties: id: type: string description: Identificador do lançamento entryType: type: object allOf: – #/definitions/autocompleteEnumData description: Tipos do lançamento formType: type: object allOf: – #/definitions/autocompleteEnumData description: Forma do lançamento conflictType: type: object allOf: – #/definitions/autocompleteEnumData description: Tipo de solução para o conflito entryItem: type: object allOf: – #/definitions/entryItemData description: Item do lançamento responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/entryVerifyConflictData description: Retorna de houve conflito e mostra o registro conflitante 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/entryItemValidateQuery: post: description: Chama as validações de negócio referentes aos itens dos lançamentos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entryItem properties: entryItem: type: object allOf: – #/definitions/entryItemData description: Item do lançamento responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/entryItemValidateQueryData description: Retorna e 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/entryItemValidateAndVerifyConflict: post: description: Verifica se existe conflito com o lançamento da folha de pagamento ou está sobre um evento vencido tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – entryType – formType – conflictType – entryItem properties: id: type: string description: Identificador do lançamento entryType: type: object allOf: – #/definitions/autocompleteEnumData description: Tipos do lançamento formType: type: object allOf: – #/definitions/autocompleteEnumData description: Forma do lançamento conflictType: type: object allOf: – #/definitions/autocompleteEnumData description: Tipo de solução para o conflito entryItem: type: object allOf: – #/definitions/entryItemData description: Item do lançamento responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/entryItemValidateAndVerifyConflictData description: Retorna se houve um conflito ou se está sobre um evento vencido. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/entryItemListQuery: post: description: Retorna uma lista de lançamentos a partir de um filtro simples tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – referencePeriod – limitPeriodType – employee properties: referencePeriod: type: string format: date description: Período de referência finalPeriod: type: string format: date description: Período final limitPeriodType: type: object allOf: – #/definitions/autocompleteEnumData description: Tipo de limitação do período employee: type: string description: Colaborador wageType: type: string description: Evento payrollCalculation: type: string description: Cálculo responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/entryItemListQueryData description: Lançamentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/apportionmentEntriesQuery: post: description: Consulta de lançametos de rateio tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate properties: employeeId: type: string description: Id co colaborador departmentId: type: string description: Id do local jobpositionId: type: string description: Id do cargo companyId: type: string description: Id da empresa startDate: type: string format: date description: Data inicial responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/apportionmentEntriesQueryData description: Retorno do endpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta de lançametos de rateio tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employeeId description: Id co colaborador in: query type: string – name: departmentId description: Id do local in: query type: string – name: jobpositionId description: Id do cargo in: query type: string – name: companyId description: Id da empresa in: query type: string – name: startDate description: Data inicial in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/apportionmentEntriesQueryData description: Retorno do endpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/entry13SalaryListQuery: post: description: Consulta de lançamento 13º Salário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – company – companyBranch – competence properties: company: type: object allOf: – #/definitions/autocompleteData description: Empresa companyBranch: type: object allOf: – #/definitions/autocompleteData description: Filial competence: type: string format: date description: Ano Competência responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/entry13SalaryListQueryData minimum: 1 description: Retorno do endpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/autocompleteWagetypeQuery: post: description: Autocomplete Eventos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId properties: searchText: type: string description: Texto para consulta default: companyId: type: string description: Empresa entryReferenceStartDate: type: string format: date description: Data inicial de referência para o filtro entryReferenceEndDate: type: string format: date description: Data final de referência para o filtro responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/autocompleteResult minimum: 1 description: Retorno do endpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Autocomplete Eventos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Texto para consulta in: query type: string – name: companyId description: Empresa in: query required: true type: string – name: entryReferenceStartDate description: Data inicial de referência para o filtro in: query type: string format: date – name: entryReferenceEndDate description: Data final de referência para o filtro in: query type: string format: date responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/autocompleteResult minimum: 1 description: Retorno do endpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/totalPayrollCalculationInPeriodByCompanyQuery: post: description: Possui cálculo totalizado no período informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – referenceDate – companyId properties: referenceDate: type: string format: date description: Data de competência companyId: type: string description: Id da empresa responses: 200: description: Ok schema: type: object required: – hasTotalCalculation properties: hasTotalCalculation: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Possui cálculo totalizado no período informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: referenceDate description: Data de competência in: query required: true type: string format: date – name: companyId description: Id da empresa in: query required: true type: string responses: 200: description: Ok schema: type: object required: – hasTotalCalculation properties: hasTotalCalculation: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportPerson: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportWageTypeTable: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportValidCalculationType: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportWagetype: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportEmployee: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportPayrollcalculation: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportApportionment: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportEntry: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportEntryItem: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportEmployeeCalculationBasis: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportDepartment: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportJobposition: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportApportionmentEntry: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportApportionmentEntryException: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportEntry13Salary: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportCompanyWageTypeTable: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportEntryImportation: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportEntryItemLotIntegration: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/exportEntryCustomization: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/blobServiceRequestUpload: post: description: Solicitação para realizar o upload de um arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome do arquivo que será carregado thumbnail: type: boolean description: Condicional se será salvo um thumbnail default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/blobServiceRequestUploadData description: Retorno do upload de um arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/blobServiceCommit: post: description: Realiza o commit de um arquivo que foi carregado anteriormente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileId – version properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) type: string description: Versão do arquivo thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto, e que deve ser criada a foto e seu Thumbnail(128X128px) default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/blobServiceCommitData description: Retorno do commit de um arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/blobServiceDelete: post: description: Solicitação para apagar um arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto e que deve ser apagado seu Thumbnail(128X128px) default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Retorno de delete do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/blobServiceRequestAccess: post: description: Solicitação para acessar um arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) ttl: type: integer format: int64 description: Tempo em minutos que o arquivo deve ficar disponível para download no link que será retornado (padrão 30 minutos) default: 30 thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto e que deve ser retornado seu Thumbnail(128X128px) default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/blobServiceRequestAccessData description: Retorno do acesso do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/entry13salarySave: post: description: Salva uma lista de lançamentos de 13o salário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – company – companyBranch – entries properties: company: type: object allOf: – #/definitions/autocompleteData description: Empresa companyBranch: type: object allOf: – #/definitions/autocompleteData description: Filial da empresa entries: type: array items: type: object allOf: – #/definitions/entry13salaryItemData minimum: 1 description: Lançamentos de 13o salário responses: 200: description: Ok schema: type: object required: – results properties: results: type: object allOf: – #/definitions/resultBaseData description: Retorno do endpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/manageEntryItems: post: description: Gerencia uma lista lançamentos(Salva, edita e deleta) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entryItems properties: entryItems: type: array items: type: object allOf: – #/definitions/entryItemData minimum: 1 description: Lançamentos responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/manageEntryItemsData description: Resultado da ação de salvar os lançamentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/employeeVariableEntrySave: post: description: Salva o lançamento da folha de pagamento variavel por colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – company – conflictType – entries properties: id: type: string description: Identificador do lançamento company: type: object allOf: – #/definitions/autocompleteData description: Empresa employee: type: object allOf: – #/definitions/autocompleteData description: Colaborador do lançamento conflictType: type: object allOf: – #/definitions/autocompleteEnumData description: Tipo de solução para o conflito entries: type: array items: type: object allOf: – #/definitions/employeeVariableEntryItemData minimum: 1 description: Itens do lançamento da folha responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/entrySaveData description: Retorno do salvar lançamentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/employeeFixedEntrySave: post: description: Salva o lançamento da folha de pagamento fixo por colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – company – entries properties: id: type: string description: Identificador do lançamento company: type: object allOf: – #/definitions/autocompleteData description: Empresa employee: type: object allOf: – #/definitions/autocompleteData description: Colaborador do lançamento entries: type: array items: type: object allOf: – #/definitions/employeeFixedEntryItemData minimum: 1 description: Itens do lançamento da folha responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/entrySaveData description: Retorno do salvar lançamentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/wageVariableEntrySave: post: description: Salva o lançamento da folha de pagamento variável por evento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – company – wageType – conflictType – entries properties: id: type: string description: Identificador do lançamento company: type: object allOf: – #/definitions/autocompleteData description: Empresa wageType: type: object allOf: – #/definitions/autocompleteData description: Evento do lançamento conflictType: type: object allOf: – #/definitions/autocompleteEnumData description: Comportamento para duplicados entries: type: array items: type: object allOf: – #/definitions/wageVariableEntryItemData minimum: 1 description: Itens do lançamento da folha responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/entrySaveData description: Retorno do salvar lançamentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/wageFixedEntrySave: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – company – wageType – entries properties: id: type: string description: Identificador do lançamento company: type: object allOf: – #/definitions/autocompleteData description: Empresa wageType: type: object allOf: – #/definitions/autocompleteData description: Evento do lançamento entries: type: array items: type: object allOf: – #/definitions/wageFixedEntryItemData minimum: 1 description: Itens do lançamento da folha responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/entrySaveData description: Retorno do salvar lançamentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/apportionmentEntrySave: post: description: Lançamentos de rateio tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – apportionmentEntries properties: employee: type: object allOf: – #/definitions/autocompleteData description: Colaborador department: type: object allOf: – #/definitions/autocompleteData description: Local jobPosition: type: object allOf: – #/definitions/autocompleteData description: Cargo company: type: object allOf: – #/definitions/autocompleteData description: Empresa startDate: type: string format: date description: Data de início apportionmentEntries: type: array items: type: object allOf: – #/definitions/apportionmentEntryData minimum: 1 description: Lançamentos de rateio apportionmentEntryExceptions: type: array items: type: object allOf: – #/definitions/apportionmentEntryExceptionData description: Exceções dos lançamentos de rateio responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Retorno do endpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/integrationSaveBatch: post: description: Salva um lote de entidades tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – className – jsonText – serviceName – collectionName – ids properties: className: type: string description: Classe da entidade jsonText: type: string description: Json da entidade serviceName: type: string description: Nome do serviço collectionName: type: string description: Nome da coleção na meta ids: type: string description: Lista de g7Ids e g5Ids responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/integrationSaveBatchData minimum: 1 description: Resultado da ação de salvar o lote 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importPerson: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importWageTypeTable: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importValidCalculationType: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importWagetype: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importEmployee: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importPayrollcalculation: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importApportionment: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importEntry: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importEntryItem: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importEmployeeCalculationBasis: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importDepartment: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importJobposition: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importApportionmentEntry: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importApportionmentEntryException: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importEntry13Salary: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importCompanyWageTypeTable: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importEntryImportation: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importEntryItemLotIntegration: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/actions/importEntryCustomization: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/signals/importEntries: post: description: Importação de lançamentos tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – conflictType – file properties: conflictType: type: object allOf: – #/definitions/autocompleteEnumData description: Tipo de solução para o conflito file: type: object allOf: – #/definitions/fileUploadData description: Arquivo a ser importado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /entry/entities/attachment: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/attachment responses: 200: description: The created resource schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/attachment responses: 200: description: The created resource schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/attachment/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/attachment responses: 200: description: Ok schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/attachment responses: 200: description: Ok schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entryImportation/{parentId}/importedFile: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/attachment responses: 200: description: The created resource schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/attachment responses: 200: description: The created resource schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entryImportation/{parentId}/errorFile: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/attachment responses: 200: description: The created resource schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/attachment responses: 200: description: The created resource schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entryImportation/{parentId}/importedFile/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/attachment responses: 200: description: Ok schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/attachment responses: 200: description: Ok schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entryImportation/{parentId}/errorFile/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/attachment responses: 200: description: Ok schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/attachment responses: 200: description: Ok schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/attachment/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/attachment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/person: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/person responses: 200: description: The created resource schema: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/person responses: 200: description: The created resource schema: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/person/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/person responses: 200: description: Ok schema: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/person responses: 200: description: Ok schema: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/person/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/person responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/company: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/company/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/companyWageTypeTable/{parentId}/company: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/companyWageTypeTable/{parentId}/company/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/company/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/company responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/wageTypeTable: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/wageTypeTable responses: 200: description: The created resource schema: #/definitions/wageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/wageTypeTable responses: 200: description: The created resource schema: #/definitions/wageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/wageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/wageTypeTable/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/wageTypeTable responses: 200: description: Ok schema: #/definitions/wageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/wageTypeTable responses: 200: description: Ok schema: #/definitions/wageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/wageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/wageTypeTable/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/wageTypeTable responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/validCalculationType: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/validCalculationType responses: 200: description: The created resource schema: #/definitions/validCalculationType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/validCalculationType responses: 200: description: The created resource schema: #/definitions/validCalculationType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/validCalculationType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/validCalculationType/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/validCalculationType responses: 200: description: Ok schema: #/definitions/validCalculationType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/validCalculationType responses: 200: description: Ok schema: #/definitions/validCalculationType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/validCalculationType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/validCalculationType/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/validCalculationType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/wagetype: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/wagetype responses: 200: description: The created resource schema: #/definitions/wagetype 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/wagetype responses: 200: description: The created resource schema: #/definitions/wagetype 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/wagetype 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/wagetype/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/wagetype responses: 200: description: Ok schema: #/definitions/wagetype 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/wagetype responses: 200: description: Ok schema: #/definitions/wagetype 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/wagetype 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/wagetype/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/wagetype responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/employee: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employee responses: 200: description: The created resource schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employee responses: 200: description: The created resource schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/employee/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employee responses: 200: description: Ok schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employee responses: 200: description: Ok schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/employee/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employee responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/payrollcalculation: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/payrollcalculation responses: 200: description: The created resource schema: #/definitions/payrollcalculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/payrollcalculation responses: 200: description: The created resource schema: #/definitions/payrollcalculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/payrollcalculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/payrollcalculation/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/payrollcalculation responses: 200: description: Ok schema: #/definitions/payrollcalculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/payrollcalculation responses: 200: description: Ok schema: #/definitions/payrollcalculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/payrollcalculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/payrollcalculation/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/payrollcalculation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/apportionment: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/apportionment responses: 200: description: The created resource schema: #/definitions/apportionment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/apportionment responses: 200: description: The created resource schema: #/definitions/apportionment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/apportionment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/apportionment/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/apportionment responses: 200: description: Ok schema: #/definitions/apportionment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/apportionment responses: 200: description: Ok schema: #/definitions/apportionment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/apportionment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/apportionment/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/apportionment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entry: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entry responses: 200: description: The created resource schema: #/definitions/entry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entry responses: 200: description: The created resource schema: #/definitions/entry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entry/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entry responses: 200: description: Ok schema: #/definitions/entry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entry responses: 200: description: Ok schema: #/definitions/entry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entry/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entry responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entryItem: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entryItem responses: 200: description: The created resource schema: #/definitions/entryItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entryItem responses: 200: description: The created resource schema: #/definitions/entryItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entryItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entryItem/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entryItem responses: 200: description: Ok schema: #/definitions/entryItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entryItem responses: 200: description: Ok schema: #/definitions/entryItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entryItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entryItem/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entryItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/employeeCalculationBasis: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeCalculationBasis responses: 200: description: The created resource schema: #/definitions/employeeCalculationBasis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeCalculationBasis responses: 200: description: The created resource schema: #/definitions/employeeCalculationBasis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/employeeCalculationBasis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/employeeCalculationBasis/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeCalculationBasis responses: 200: description: Ok schema: #/definitions/employeeCalculationBasis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeCalculationBasis responses: 200: description: Ok schema: #/definitions/employeeCalculationBasis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employeeCalculationBasis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/employeeCalculationBasis/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeCalculationBasis responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/department: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/department responses: 200: description: The created resource schema: #/definitions/department 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/department responses: 200: description: The created resource schema: #/definitions/department 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/department 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/department/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/department responses: 200: description: Ok schema: #/definitions/department 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/department responses: 200: description: Ok schema: #/definitions/department 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/department 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/department/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/department responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/jobposition: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/jobposition responses: 200: description: The created resource schema: #/definitions/jobposition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/jobposition responses: 200: description: The created resource schema: #/definitions/jobposition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/jobposition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/jobposition/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/jobposition responses: 200: description: Ok schema: #/definitions/jobposition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/jobposition responses: 200: description: Ok schema: #/definitions/jobposition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/jobposition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/jobposition/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/jobposition responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/apportionmentEntry: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/apportionmentEntry responses: 200: description: The created resource schema: #/definitions/apportionmentEntry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/apportionmentEntry responses: 200: description: The created resource schema: #/definitions/apportionmentEntry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/apportionmentEntry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/apportionmentEntry/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/apportionmentEntry responses: 200: description: Ok schema: #/definitions/apportionmentEntry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/apportionmentEntry responses: 200: description: Ok schema: #/definitions/apportionmentEntry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/apportionmentEntry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/apportionmentEntry/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/apportionmentEntry responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/apportionmentEntryException: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/apportionmentEntryException responses: 200: description: The created resource schema: #/definitions/apportionmentEntryException 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/apportionmentEntryException responses: 200: description: The created resource schema: #/definitions/apportionmentEntryException 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/apportionmentEntryException 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/apportionmentEntryException/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/apportionmentEntryException responses: 200: description: Ok schema: #/definitions/apportionmentEntryException 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/apportionmentEntryException responses: 200: description: Ok schema: #/definitions/apportionmentEntryException 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/apportionmentEntryException 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/apportionmentEntryException/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/apportionmentEntryException responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entry13Salary: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entry13Salary responses: 200: description: The created resource schema: #/definitions/entry13Salary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entry13Salary responses: 200: description: The created resource schema: #/definitions/entry13Salary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entry13Salary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entry13Salary/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entry13Salary responses: 200: description: Ok schema: #/definitions/entry13Salary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entry13Salary responses: 200: description: Ok schema: #/definitions/entry13Salary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entry13Salary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entry13Salary/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entry13Salary responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/companyWageTypeTable: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyWageTypeTable responses: 200: description: The created resource schema: #/definitions/companyWageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyWageTypeTable responses: 200: description: The created resource schema: #/definitions/companyWageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/companyWageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/companyWageTypeTable/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companyWageTypeTable responses: 200: description: Ok schema: #/definitions/companyWageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companyWageTypeTable responses: 200: description: Ok schema: #/definitions/companyWageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companyWageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/companyWageTypeTable/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/companyWageTypeTable responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entryImportation: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entryImportation responses: 200: description: The created resource schema: #/definitions/entryImportation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entryImportation responses: 200: description: The created resource schema: #/definitions/entryImportation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entryImportation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entryImportation/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entryImportation responses: 200: description: Ok schema: #/definitions/entryImportation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entryImportation responses: 200: description: Ok schema: #/definitions/entryImportation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entryImportation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entryImportation/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entryImportation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entryItemLotIntegration: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entryItemLotIntegration responses: 200: description: The created resource schema: #/definitions/entryItemLotIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entryItemLotIntegration responses: 200: description: The created resource schema: #/definitions/entryItemLotIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entryItemLotIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entryItemLotIntegration/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entryItemLotIntegration responses: 200: description: Ok schema: #/definitions/entryItemLotIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entryItemLotIntegration responses: 200: description: Ok schema: #/definitions/entryItemLotIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entryItemLotIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entryItemLotIntegration/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entryItemLotIntegration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entryCustomization: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entryCustomization responses: 200: description: The created resource schema: #/definitions/entryCustomization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entryCustomization responses: 200: description: The created resource schema: #/definitions/entryCustomization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entryCustomization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entryCustomization/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entryCustomization responses: 200: description: Ok schema: #/definitions/entryCustomization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entryCustomization responses: 200: description: Ok schema: #/definitions/entryCustomization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entryCustomization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entry/entities/entryCustomization/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entryCustomization responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: heathcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN operationType: description: Tipo da operaão do lançamento de 13o salário type: string enum: – SAVE – DELETE wageValueType: description: Tipo de valor do evento type: string enum: – VALUE – HOUR limitPeriodType: description: Tipo de limitação de período para filtro type: string enum: – CONSIDER_BEGINNING – CONSIDER_END – CONSIDER_CONTAINED payrollCalculationSituationType: description: Situação do cálculo de folha type: string enum: – OPEN_CALCULATION – CLOSED_CALCULATION – PARTIAL_CALCULATION – CALCULATION_NOT_EXISTS entryType: description: Tipos do lançamento da folha de pagamento type: string enum: – EVENT – EMPLOYEE formType: description: Formas do lançamento da folha de pagamento type: string enum: – FIXED – VARIABLE conflictType: description: Tipo de solução para o conflito type: string enum: – LAST – DESPISE – SUM – CONSIST – DUPLICATE employeeType: description: Tipo do colaborador type: string enum: – NULL – EMPLOYEE – THIRD – PARTNER calculationType: description: Tipo de cálculo da folha de pagamento type: string enum: – MONTHLY_CALCULATION – COMPLEMENTARY_PAYROLL – COMPLEMENTARY_AGREEMENT – AGREEMENT_PAYMENT – COMPLEMENTARY_RESCISSION – FIRST_WEEK – INTERMEDIATE_WEEK – LAST_WEEK – THIRTEENTH_PAYDAY_ADVANCE – THIRTEENTH_FULL_SALARY – GRATIFICATION – FIRST_FORTNIGHT – SECOND_FORTNIGHT – SALARY_ADVANCE – PROFT_PARTICIPATION – SPECIAL – LABOR_CLAIM calculationSituationType: description: Situação do cálculo type: string enum: – CALCULATION_CANCELED – INITIALIZED – TOTAL_CALCULATION – PARTIAL_CALCULATION – SIMULATED_CALCULATION expenseType: description: Tipo de despesa type: string enum: – ADMINISTRATIVE – COMMERCIAL – OPERATIONAL subscriptionType: description: Tipo da inscrição type: string enum: – EMPTY – CNPJ – CEI – CPF – INCRA subscriptionCalculationBasisType: description: Tipo da inscrição type: string enum: – CNPJ – CPF eSocialCategory: description: Categoria do eSocial type: string enum: – Category_101 – Category_102 – Category_103 – Category_104 – Category_105 – Category_106 – Category_111 – Category_201 – Category_202 – Category_301 – Category_302 – Category_303 – Category_305 – Category_306 – Category_307 – Category_308 – Category_309 – Category_401 – Category_410 – Category_701 – Category_711 – Category_712 – Category_721 – Category_722 – Category_723 – Category_731 – Category_734 – Category_738 – Category_741 – Category_751 – Category_761 – Category_771 – Category_781 – Category_901 – Category_902 – Category_903 – Category_904 – Category_905 – Category_997 – Category_998 – Category_999 companyType: description: Tipo da empresa type: string enum: – BRANCH_OFFICE – HEAD_OFFICE – WORK – TEMPORARY – WORK_COOPERATIVELY – DOMESTIC_WORKER – EMPLOYER_ESOCIAL controlPointType: description: Contador Controle de Ponto e Refeitório type: string enum: – TYPE_1 – TYPE_2 – TYPE_3 – TYPE_4 apportionmentUseType: description: Tipo de uso de rateio type: string enum: – DONT_USE_APPORTIONMENT – APPORTIONMENT_BY_DEPARTMENT – APPORTIONMENT_BY_COST_CENTER takersRoutineUseType: description: Tipo de uso de Rotina tomadores type: string enum: – BY_COMPANY_BRANCH – BY_APPORTIONMENT apportionmentDiscountType: description: Tipo de desconto do adiantamento de rateio type: string enum: – TYPE_1 – TYPE_2 wageTypeCategory: description: Tipo do evento type: string enum: – PROCEEDS – DEDUCTION – INFORMATIVE – ADVANTAGE – OTHER_PROCEEDS – OTHER_DEDUCTION actionType: description: Tipo da ação CRUD type: string enum: – SAVE – EDIT – DELETE wageTypeCharacteristic: description: Característica do evento type: string enum: – C01A – C01B – C01C – C01D – C01E – C01F – C01G – C01H – C01I – C01J – C01K – C01L – C01M – C01N – C01O – C01P – C01Q – C01R – C01S – C01T – C01U – C01V – C01W – C01X – C01Y – C01Z – C02A – C02B – C02C – C02D – C02E – C02F – C02G – C02H – C02I – C02J – C02K – C02L – C02M – C02N – C02O – C02P – C02Q – C02R – C02S – C02T – C02U – C02V – C02W – C02X – C02Y – C02Z – C03A – C03B – C03C – C03D – C03E – C03F – C03G – C03H – C03I – C03J – C03K – C03L – C03M – C03N – C03O – C03P – C03Q – C03R – C03S – C03T – C03U – C03V – C03W – C03X – C03Y – C03Z – C05A – C05B – C05C – C05D – C05E – C05F – C05G – C05H – C05I – C05J – C05K – C05L – C05M – C05N – C11A – C11B – C11C – C11D – C11E – C11F – C11G – C11H – C11I – C11J – C11K – C11L – C11M – C11N – C11O – C11P – C11Q – C11R – C12A – C12B – C12C – C12D – C12E – C12F – C12G – C12H – C12I – C12J – C13A – C13B – C13C – C13D – C13E – C13F – C13G – C13H – C13I – C13J – C14A – C14B – C14C – C14D – C14G – C14J – C14K – C14L – C14M – C14N – C14O – C14P – C14Q – C15A – C15B – C15C – C15D – C15E – C16A – C16B – C16C – C16D – C16E – C16F – C16G – C16H – C16I – C16J – C17A – C17B – C17C – C17D – C17E – C17G – C17H – C18A – C18B – C18C – C18D – C19A – C19B – C19C – C19D – C19E – C19F – C19G – C19H – C20A – C20B – C20C – C20D – C20E – C21A – C21B – C21C – C21D – C21E – C21F – C21G – C22A – C22B – C22C – C22D – C22E – C23A – C23B – C23C – C23D – C23E – C24A – C24B – C24C – C24D – C24E – C25A – C25B – C25C – C25D – C25E – C25F – C25G – C26A – C26B – C26C – C26D – C26E – C26F – C26G – C27A – C27B – C27C – C27D – C28A – C28C – C28D – C28E – C28F – C28G – C28H – C30A – C31A – C31B – C31C – C31D – C31E – C31F – C31G – C31H – C31I – C31J – C31K – C31L – C31M – C31N – C31O – C32A – C32B – C32C – C32D – C32E – C32F – C32G – C33A – C33B – C34A – C34B – C34C – C35A – C35B – C35C – C35D – C35E – C35F – C35G – C35H – C35I – C35J – C35K – C35L – C35M – C35N – C35O – C35P – C35Q – C35R – C36A – C36B – C36C – C36D – C36E – C36F – C37A – C37B – C37C – C37D – C37E – C38A – C38B – C38C – C38D – C38E – C38F – C38G – C38H – C38I – C38K – C38J – C38L – C38M – C38N – C38O – C38Q – C38R – C39A – C39B – C39C – C39D – C39E – C39F – C39G – C39H – C39I – C39J – C39K – C39L – C39M – C39N – C39O – C39P – C39Q – C39R – C39S – C39T – C39U – C39V – C39Y – C39Z – C40A – C40B – C40C – C40D – C40E – C40F – C40G – C40H – C40I – C40J – C40K – C40L – C40M – C40N – C40O – C40P – C40Q – C40R – C40S – C40T – C40U – C40V – C40W – C40X – C40Y – C40Z – C41A – C41B – C41C – C41D – C41E – C42A – C42B – C42C – C42D – C42E – C42F – C42G – C43A – C43B – C43C – C44A – C44B – C44C – C44D – C44E – C44G – C44H – C44I – C44J – C44K – C45A – C45B – C45C – C45D – C45E – C45F – C45G – C45H – C45I – C45J – C45K – C45L – C45M – C45N – C46A – C48A – C48B – C48C – C48D – C48E – C48F – C48G – C48H – C48I – C48J – C48K – C48L – C48M – C48N – C48O – C48P – C48Q – C48R – C48S – C48T – C49A – C49B – C49C – C49D – C49E – C49F – C49G – C49H – C49I – C49J – C49K – C49L – C49M – C49N – C49O – C49Z – C50A – C50B – C50C – C50D – C50E – C50F – C50G – C50H – C50I – C50J – C50K – C50L – C50M – C50N – C50O – C50P – C50Q – C50R – C50S – C50T – C50U – C50V – C50W – C50X – C50Y – C50Z – C51A – C51B – C51C – C51D – C51E – C51F – C51G – C51H – C51I – C51J – C51K – C51L – C51M – C51N – C51O – C51P – C51Q – C51R – C51S – C51T – C51U – C51V – C51W – C51X – C51Y – C51Z – C52A – C52B – C52C – C52D – C52E – C52F – C52G – C52H – C52I – C52J – C52K – C52L – C52M – C52N – C52O – C52P – C52Q – C52R – C52S – C52T – C52U – C52V – C52W – C52X – C52Y – C52Z – C53A – C53B – C53C – C53D – C53E – C53F – C53G – C53H – C53I – C53J – C53K – C53L – C53M – C53N – C53O – C53P – C53Q – C53R – C53S – C53T – C53U – C53V – C53W – C53X – C53Y – C53Z – C54A – C54B – C54C – C54D – C54E – C54F – C54G – C54H – C54I – C54J – C54K – C54L – C54M – C54N – C54O – C54P – C54Q – C54R – C54S – C54T – C54U – C54V – C54W – C54X – C54Y – C54Z – C55A – C55B – C55C – C55D – C55E – C55F – C55G – C55H – C55I – C55J – C55K – C55L – C55M – C55N – C55O – C55P – C55Q – C55R – C55S – C55T – C55U – C55V – C55W – C55X – C55Y – C55Z – C56A – C56B – C56C – C56D – C56E – C56F – C56G – C56H – C56I – C56J – C56K – C56L – C56M – C56N – C56O – C56P – C56Q – C56R – C56S – C56T – C56U – C56V – C56W – C56X – C56Y – C56Z – C57A – C57B – C57C – C57D – C57E – C58A – C58B – C58C – C58D – C58E – C58F – C58G – C58H – C58I – C58J – C58K – C58L – C61A – C61B – C61D – C62A – C62B – C62D – C63A – C63B – C63D userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR entrySaveData: description: Dados de retorno do entrySave allOf: – #/definitions/resultBaseData – type: object required: – entryItems properties: entryItems: type: array items: type: object allOf: – #/definitions/entryItem minimum: 1 description: variableEntryItemBatch: description: Lote de integração de lançamentos type: object required: – entries properties: entries: type: array items: type: object allOf: – #/definitions/entryItem minimum: 1 description: blobServiceCommitData: description: Dados de retorno do commit de um arquivo allOf: – #/definitions/resultBaseData – type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) blobServiceRequestUploadData: description: Dados de retorno do upload de um arquivo allOf: – #/definitions/resultBaseData – type: object required: – fileId – version – locationURI properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) type: string description: Versão do arquivo locationURI: type: string description: URI onde o upload deve ser realizado blobServiceRequestAccessData: description: Dados de retorno do acesso do arquivo allOf: – #/definitions/resultBaseData – type: object required: – locationURI properties: locationURI: type: string description: URI onde o arquivo está disponível para download fileUploadData: description: type: object 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) permanentUrl: type: string description: Url do arquivo permanente checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/heathcheckDTO description: Status autocompleteFilter: description: DTO com informações do lookup type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro keyValue: description: Objeto chave valor para map type: object required: – key – value properties: key: type: string description: Nome do campo filtro que está sendo enviado como parâmetro value: type: string description: Valor do campo filtro que está sendo enviado como parâmetro entry13salaryItemData: description: DTO da lista de lançamentos de 13o salário type: object required: – employeeType – employee – competence – value – operationType properties: entry13salaryId: type: string maxLength: 32 description: Id do lançamento já salvo employeeType: type: object allOf: – #/definitions/autocompleteEnumData description: Tipo do colaborador employee: type: object allOf: – #/definitions/autocompleteData description: Colaborador competence: type: string format: date description: Competência do lançamento value: type: string description: Valor de adiantamento do lançamento operationType: type: string allOf: – #/definitions/operationType description: Tipo da operação do lançamento enumInformationData: description: DTO de lista com as enumerações traduzidas type: object required: – enumName – items properties: enumName: type: string description: Nome da enumeração items: type: array items: type: object allOf: – #/definitions/enumInformationItemData minimum: 1 description: Lista com os items das enumerações enumInformationItemData: description: DTO de lista com os items das enumerações type: object required: – key – value properties: key: type: string description: Chave do item da enumeração value: type: string description: Valor traduzido do item da enumeração autocompleteData: description: DTO com os dados selecionados do autocomplete type: object required: – tableId properties: tableId: type: string description: Id da tabela name: type: string description: Descrição da tabela autocompleteEnumData: description: DTO para o autocompleteEnum selecionado e retorno type: object required: – key properties: key: type: string description: Chave do enum value: type: string description: Valor do enum entryItemData: description: DTO com os dados do lançamento da folha de pagamento type: object properties: id: type: string description: Id do item actionType: type: string description: Tipo da ação crud payrollCalculation: type: object allOf: – #/definitions/autocompleteData description: Cálculo da folha de pagamento wageType: type: object allOf: – #/definitions/autocompleteData description: Evento do item de lançamento wageValueType: type: object allOf: – #/definitions/autocompleteEnumData description: Tipo de valor do evento employee: type: object allOf: – #/definitions/autocompleteData description: Colaborador do item de lançamento startDate: type: string format: date description: Data de lançamento endDate: type: string format: date description: Data de validate do lançamento apportionment: type: object allOf: – #/definitions/autocompleteData description: Rateio do lançamento reference: type: number format: double description: Referência do lançamento value: type: number format: double description: Valor do lançamento employeeVariableEntryItemData: description: DTO com os dados do lançamento da folha de pagamento (Colaborador – Variável) type: object properties: id: type: string description: Id do item actionType: type: string description: Tipo da ação crud payrollCalculation: type: object allOf: – #/definitions/autocompleteData description: Cálculo da folha de pagamento wageType: type: object allOf: – #/definitions/autocompleteData description: Evento do item de lançamento wageValueType: type: object allOf: – #/definitions/autocompleteEnumData description: Tipo de valor do evento apportionment: type: object allOf: – #/definitions/autocompleteData description: Data de lançamento reference: type: number format: double description: Referência do lançamento value: type: number format: double description: Valor do lançamento employeeFixedEntryItemData: description: DTO com os dados do lançamento da folha de pagamento (Colaborador – Fixo) type: object properties: id: type: string description: Id do item actionType: type: string description: Tipo da ação crud wageType: type: object allOf: – #/definitions/autocompleteData description: Evento do item de lançamento wageValueType: type: object allOf: – #/definitions/autocompleteEnumData description: Tipo de valor do evento startDate: type: string format: date description: Data de lançamento endDate: type: string format: date description: Data de validate do lançamento apportionment: type: object allOf: – #/definitions/autocompleteData description: Rateio do lançamento reference: type: number format: double description: Referência do lançamento value: type: number format: double description: Valor do lançamento wageVariableEntryItemData: description: DTO com os dados do lançamento da folha de pagamento (Evento – Variável) type: object properties: id: type: string description: Id do item actionType: type: string description: Tipo da ação crud payrollCalculation: type: object allOf: – #/definitions/autocompleteData description: Cálculo da folha de pagamento wageValueType: type: object allOf: – #/definitions/autocompleteEnumData description: Tipo de valor do evento employee: type: object allOf: – #/definitions/autocompleteData description: Colaborador do item de lançamento apportionment: type: object allOf: – #/definitions/autocompleteData description: Rateio do lançamento reference: type: number format: double description: Referência do lançamento value: type: number format: double description: Valor do lançamento wageFixedEntryItemData: description: DTO com os dados do lançamento da folha de pagamento (Evento – Fixed) type: object properties: id: type: string description: Id do item actionType: type: string description: Tipo da ação crud wageValueType: type: object allOf: – #/definitions/autocompleteEnumData description: Tipo de valor do evento employee: type: object allOf: – #/definitions/autocompleteData description: Colaborador do item de lançamento startDate: type: string format: date description: Data de lançamento endDate: type: string format: date description: Data de validate do lançamento apportionment: type: object allOf: – #/definitions/autocompleteData description: Rateio do lançamento reference: type: number format: double description: Referência do lançamento value: type: number format: double description: Valor do lançamento resultBaseData: description: Retorno base para os endpoints discriminator: _discriminator type: object required: – ok – _discriminator properties: ok: type: boolean description: Flag para indicar sucesso warning: type: boolean description: Flag para indicar sucesso com alerta default: false message: type: string description: Mensagem de retorno default: _discriminator: type: string description: entryVerifyConflictData: description: DTO com os dados de retorno da verificação de conflito allOf: – #/definitions/resultBaseData – type: object required: – entry properties: entry: type: object allOf: – #/definitions/entryItemData description: Item do lançamento da folha de pagamento entryItemValidateQueryData: description: DTO de retorno das validações de lançamentos type: object required: – message – entryItem properties: message: type: string description: Mensagens com as validações entryItem: type: object allOf: – #/definitions/entryItemData description: Lançamento entryItemValidateAndVerifyConflictData: description: DTO com os dados de retorno da verificação de conflito e vencimento do evento allOf: – #/definitions/resultBaseData – type: object required: – entryItem properties: entryItem: type: object allOf: – #/definitions/entryItemData description: Lançamento entryItemListQueryData: description: DTO de retorno de uma lista de lançamentos type: object required: – entryItems properties: entryItems: type: array items: type: object allOf: – #/definitions/entryItemData minimum: 1 description: Lançamentos manageEntryItemsData: description: DTO de retorno da primitiva de manutenção de lançamentos type: object required: – message – entityId properties: message: type: string description: Mensagem entityId: type: string description: Id Entidade que ocorreu o problema apportionmentEntryData: description: DTO do lançamento de rateio type: object required: – apportionment – percentage – actionType properties: id: type: string description: Id do rateio apportionment: type: object allOf: – #/definitions/autocompleteData description: Rateio percentage: type: number format: double description: Percentual; actionType: type: string allOf: – #/definitions/actionType description: Tipo de ação apportionmentEntryExceptionData: description: DTO da exceção do lançamento de rateio type: object required: – wageType – apportionment – percentage – actionType properties: id: type: string description: Id da exceção wageType: type: object allOf: – #/definitions/autocompleteData description: Evento apportionment: type: object allOf: – #/definitions/autocompleteData description: Rateio percentage: type: number format: double description: Percentual actionType: type: string allOf: – #/definitions/actionType description: Tipo de ação apportionmentEntriesQueryData: description: Dados da consulta de lançamento de rateio type: object required: – startDate – apportionmentEntries – apportionmentEntryExceptions – payrollCalculationSituationType properties: employee: type: object allOf: – #/definitions/autocompleteData description: Colaborador department: type: object allOf: – #/definitions/autocompleteData description: Id do local jobPosition: type: object allOf: – #/definitions/autocompleteData description: Id do cargo startDate: type: string format: date description: Data de inicio apportionmentEntries: type: array items: type: object allOf: – #/definitions/apportionmentEntryData minimum: 1 description: Lançamentos de rateio apportionmentEntryExceptions: type: array items: type: object allOf: – #/definitions/apportionmentEntryExceptionData minimum: 1 description: Exceções dos lançamentos de rateio payrollCalculationSituationType: type: string allOf: – #/definitions/payrollCalculationSituationType description: Situação do cálculo de folha entry13SalaryListQueryData: description: Dados da consulta de lançamento de 13º Salário type: object required: – company – employeeType – employee – competence – hiredate – value properties: entry13salaryId: type: string maxLength: 32 description: Id do lançamento company: type: object allOf: – #/definitions/autocompleteData description: Empresa employeeType: type: object allOf: – #/definitions/autocompleteEnumData description: Tipo do colaborador employee: type: object allOf: – #/definitions/autocompleteData description: Colaborador competence: type: string format: date description: Competência hiredate: type: string format: date description: Data de admissão value: type: string description: Valor integrationSaveBatchData: description: Resultado da integração em lotes type: object required: – id – success – errorMessage properties: id: type: string description: Id da entidade success: type: boolean description: Informa se a ação foi realizada com sucesso errorMessage: type: string description: Mensagem de erro autocompleteResult: description: Retorno autocomplete allOf: – #/definitions/resultBaseData – type: object required: – tableId – fields properties: tableId: type: string description: Id do registro pesquisado fields: type: array items: type: object allOf: – #/definitions/autocompleteResultFields minimum: 1 description: Descrição do registro pesquisado autocompleteResultFields: description: Campos para o retorno do autocomplete type: object required: – name – value properties: name: type: string description: Nome do campo de retorno value: type: string description: Valor do campo de retorno attachment: description: Anexo type: object required: – name properties: id: type: string maxLength: 32 description: Identificador name: type: string description: Nome do arquivo person: description: Pessoa 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 username: type: string description: Nome de usuário cpf: type: string description: Número de CPF company: description: Empresa type: object required: – cnpj – subscriptionType – companyname – place – companytype – apportionmentUseType – takersRoutineUseType – apportionmentDiscountType – takersRoutineStartDate – useJudicialPensionHistory properties: id: type: string description: Id da empresa code: type: integer format: int64 description: Código da empresa cnpj: type: string description: Cnpj da empresa subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo de Inscrição companyname: type: string description: Nome da empresa headquarter: type: string description: Relacionamento com a sede da empresa place: type: string description: Relacionamento com cidade companytype: type: string allOf: – #/definitions/companyType description: Tipo da empresa apportionmentUseType: type: string allOf: – #/definitions/apportionmentUseType description: Tipo de uso de rateio takersRoutineUseType: type: string allOf: – #/definitions/takersRoutineUseType description: Tipo de uso de Rotina tomadores apportionmentDiscountType: type: string allOf: – #/definitions/apportionmentDiscountType description: Tipo de desconto do adiantamento de rateio takersRoutineStartDate: type: string format: date description: Início rotina tomadores por rateio useJudicialPensionHistory: type: boolean description: Usa histórico pensão judicial tradingname: type: string description: Nome fantasia da empresa wageTypeTable: description: Tabela de evento da folha de pagamento type: object required: – code – name – validity properties: id: type: string maxLength: 32 description: Id da tabela de evento code: type: integer format: int64 description: Código da tabela de evento name: type: string description: Descrição da tabela de evento validity: type: string description: Indicador de validade validCalculationType: description: Eventos – Tipos de Cálculo valido (R008CAL) type: object required: – id – wageTypeTable – wageType – calculationType properties: id: type: string maxLength: 32 description: Id da tabela wageTypeTable: type: object allOf: – #/definitions/wageTypeTable description: Tabela de evento (CodTab) wageType: type: object allOf: – #/definitions/wagetype description: Evento (CodEve) calculationType: type: string allOf: – #/definitions/calculationType description: Tipo do cálculo valido (TipCal) wagetype: description: Evento da folha de pagamento type: object required: – id – wageTypeTable – code – name – wageValueType – type – characteristic properties: id: type: string description: Id do evento wageTypeTable: type: object allOf: – #/definitions/wageTypeTable description: Relacionamento com tabelas de eventos code: type: integer format: int64 description: Código do evento name: type: string description: Descrição do evento wageValueType: type: string allOf: – #/definitions/wageValueType description: Tipo de valor do evento type: type: string allOf: – #/definitions/wageTypeCategory description: Tipo do evento characteristic: type: string allOf: – #/definitions/wageTypeCharacteristic description: Categoria do Evento creationdate: type: string format: date description: Data de criação expirationdate: type: string format: date description: Data de extinção syndicate: type: string maxLength: 32 description: Identificador do sindicato do da contribuição sindical employee: description: Colaborador type: object required: – hiredate – employer – companynumber – employeetype – registernumber – registrationnumber – person properties: id: type: string description: Id do colaborador hiredate: type: string format: date description: Data de admissão employer: type: object allOf: – #/definitions/company description: Filial matriz da empresa companynumber: type: integer format: int64 description: Empresa do colaborador: NUMEMP employeetype: type: string allOf: – #/definitions/employeeType description: Tipo do colaborador: TIPCOL registernumber: type: integer format: int64 description: Código do colaborador: NUMCAD registrationnumber: type: integer format: int64 description: Número de registro do colaborador person: type: object allOf: – #/definitions/person description: Relacionamento com a pessoa payrollcalculation: description: Cálculo da folha de pagamento type: object required: – id – company – calculationcode properties: id: type: string description: Id do cálculo da folha de pagamento availableforreference: type: boolean description: Liberar folha no Portal name: type: string description: Nome paymentdate: type: string format: date description: Data de pagamento periodend: type: string format: date description: Data final do período da folha periodstart: type: string format: date description: Data inicial do período da folha referencedate: type: string format: date description: Competência do cálculo calculationtype: type: string allOf: – #/definitions/calculationType description: Tipo do cálculo company: type: object allOf: – #/definitions/company description: Empresa calculationend: type: string format: date description: Data do fim da apuração do cálculo calculationstart: type: string format: date description: Data do início da apuração do cálculo calculationcode: type: integer format: int64 description: Código do cálculo calculationSituation: type: string allOf: – #/definitions/calculationSituationType description: Situação do cálculo apportionment: description: Cadastro de rateio type: object required: – id – code – name – expenseType properties: id: type: string description: Id do rateio code: type: integer format: int64 description: Código do rateio name: type: string description: Descrição x-i18n: true expenseType: type: string allOf: – #/definitions/expenseType description: Tipo de despesa translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. entry: description: Lançamento da folha de pagamento type: object required: – id – company – entryType – formType – conflictType properties: id: type: string description: Id do lançamento company: type: object allOf: – #/definitions/company description: Empresa entryType: type: string allOf: – #/definitions/entryType description: Tipo do lançamento formType: type: string allOf: – #/definitions/formType description: Forma do lançamento conflictType: type: string allOf: – #/definitions/conflictType description: Tipo de solução para o conflito wageType: type: object allOf: – #/definitions/wagetype description: Evento do lançamento employee: type: object allOf: – #/definitions/employee description: Colaborador do lançamento entryItem: description: Item do lançamento da folha de pagamento type: object required: – id – entry – lotIntegration properties: id: type: string description: Id do item do lançamento entry: type: object allOf: – #/definitions/entry description: Lançamento da folha de pagamento payrollCalculation: type: object allOf: – #/definitions/payrollcalculation description: Cálculo da folha de pagamento wageType: type: object allOf: – #/definitions/wagetype description: Evento do item de lançamento employee: type: object allOf: – #/definitions/employee description: Colaborador do item de lançamento startDate: type: string format: date description: Data de lançamento endDate: type: string format: date description: Data de validate do lançamento reference: type: number format: double description: Referência do lançamento apportionment: type: object allOf: – #/definitions/apportionment description: Rateio do lançamento value: type: number format: double description: Valor do lançamento lotIntegration: type: string description: Id do lote enviado para g5 employeeCalculationBasis: description: Múltiplos vínculos type: object required: – id – employee – competenceDate – individualContributor properties: id: type: string description: Id do item do lançamento employee: type: object allOf: – #/definitions/employee description: Colaborador do item de lançamento competenceDate: type: string format: date description: competência do lançamento sequence: type: integer format: int64 description: sequencia do lançamento minimum: 0 maximum: 99 monthlyInssBasis: type: number format: double description: Base INSS mensal minimum: 0.01 maximum: 999999999.99 monthlyInssValue: type: number format: double description: Valor INSS mensal minimum: 0.01 maximum: 999999999.99 inss13Basis: type: number format: double description: Base INSS 13 salário minimum: 0.01 maximum: 999999999.99 inss13Value: type: number format: double description: Valor INSS 13 salário minimum: 0.01 maximum: 999999999.99 monthlyIncomeTaxBasis: type: number format: double description: Base IR mensal minimum: 0.01 maximum: 999999999.99 monthlyIncomeTaxValue: type: number format: double description: Valor IR mensal minimum: 0.01 maximum: 999999999.99 vacationIncomeTaxBasis: type: number format: double description: Base IR férias minimum: 0.01 maximum: 999999999.99 vacationIncomeTaxValue: type: number format: double description: Valor IR férias minimum: 0.01 maximum: 999999999.99 thirteenthIncomeTaxBasis: type: number format: double description: Base IR 13 salário minimum: 0.01 maximum: 999999999.99 thirteenthIncomeTaxValue: type: number format: double description: Valor IR 13 salário minimum: 0.01 maximum: 999999999.99 profitSharingIncomeTaxBasis: type: number format: double description: Base IR Part. Lucros minimum: 0.01 maximum: 999999999.99 profitSharingIncomeTaxValue: type: number format: double description: Valor IR Part. Lucros minimum: 0.01 maximum: 999999999.99 monthlyIpeBasis: type: number format: double description: Base IPE mensal minimum: 0.01 maximum: 999999999.99 monthlyIpeValue: type: number format: double description: Valor IPE mensal minimum: 0.01 maximum: 999999999.99 vacationIpeBasis: type: number format: double description: Base IPE férias minimum: 0.01 maximum: 999999999.99 vacationIpeValue: type: number format: double description: Valor IPE férias minimum: 0.01 maximum: 999999999.99 thirteenthIpeBasis: type: number format: double description: Base IPE 13 salário minimum: 0.01 maximum: 999999999.99 thirteenthIpeValue: type: number format: double description: Valor IPE 13 salário minimum: 0.01 maximum: 999999999.99 individualContributor: type: boolean description: Contribuinte individual subscriptionType: type: string allOf: – #/definitions/subscriptionCalculationBasisType description: Tipo de inscrição subscriptionNumber: type: number format: double description: Número de inscrição minimum: 0.01 maximum: 9999999999999.99 otherCompanyName: type: string maxLength: 60 description: Nome da outra empresa contributionDiscounted: type: boolean description: Contribuição descontada esocialCategory: type: string allOf: – #/definitions/eSocialCategory description: Categoria eSocial department: description: Local de trabalho type: object required: – id – code – name – position – tablecode – creationdate – expirationdate properties: id: type: string description: Id do local code: type: string description: Código do local name: type: string description: Nome do local x-i18n: true position: type: string description: Posição tablecode: type: integer format: int64 description: Código da tabela creationdate: type: string format: date description: Data de criação expirationdate: type: string format: date description: Data de extinção apportionment: type: object allOf: – #/definitions/apportionment description: Rateio do local translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. jobposition: description: Cargo type: object required: – id – code – name – jobpositionstructure properties: id: type: string description: Id do cargo code: type: string description: Código do cargo name: type: string description: Nome do cargo x-i18n: true cbo: type: string description: CBO do cargo jobpositionstructure: type: string description: Id da estrutura de cargos creationDate: type: string format: date description: Data de criação do cargo expirationDate: type: string format: date description: Data de extinção do cargo translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. apportionmentEntry: description: Lançamento de rateio type: object required: – id – apportionment – startDate – endDate – percentage properties: id: type: string description: Id da entidade employee: type: object allOf: – #/definitions/employee description: Colaborador department: type: object allOf: – #/definitions/department description: Local jobPosition: type: object allOf: – #/definitions/jobposition description: Cargo company: type: object allOf: – #/definitions/company description: Empresa apportionment: type: object allOf: – #/definitions/apportionment description: Rateio startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final percentage: type: number format: double description: Percentual isIntegration: type: boolean description: É integração? (campo calculado) apportionmentEntryException: description: Exceção do lançamento de rateio type: object required: – id – apportionment – wageType – startDate – endDate – percentage properties: id: type: string description: Id da entidade employee: type: object allOf: – #/definitions/employee description: Colaborador department: type: object allOf: – #/definitions/department description: Local jobPosition: type: object allOf: – #/definitions/jobposition description: Cargo company: type: object allOf: – #/definitions/company description: Empresa apportionment: type: object allOf: – #/definitions/apportionment description: Rateio wageType: type: object allOf: – #/definitions/wagetype description: Evento startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final percentage: type: number format: double description: Percentual isIntegration: type: boolean description: É integração? (campo calculado) entry13Salary: description: Lançamentos de 13 salário type: object required: – company – companyBranch – competence – employeeType – employee – value properties: id: type: string maxLength: 32 description: Id da entidade company: type: object allOf: – #/definitions/company description: Empresa companyBranch: type: object allOf: – #/definitions/company description: Filial competence: type: string format: date description: Competência employeeType: type: string allOf: – #/definitions/employeeType description: Tipo do Colaborador employee: type: object allOf: – #/definitions/employee description: Colaborador value: type: string description: Valor companyWageTypeTable: description: Ligação entre a empresa e a tabela de eventos type: object required: – company – wageTypeTable properties: id: type: string maxLength: 32 description: Id da entidade company: type: object allOf: – #/definitions/company description: Empresa wageTypeTable: type: object allOf: – #/definitions/wageTypeTable description: Tabela de eventos entryImportation: description: Importação de lançamentos type: object required: – id – importedFile – username – creationDate properties: id: type: string description: Id da tabela importedFile: type: object allOf: – #/definitions/attachment description: Id da tabela de anexo, do arquivo importado pelo cliente errorFile: type: object allOf: – #/definitions/attachment description: Id do arquivo com os erros de validação no blobservice username: type: string description: Usuário fez a solicitação recordCount: type: integer format: int64 description: Quantidade de registros no arquivo successCount: type: integer format: int64 description: Quantidade de registros processados com sucesso errorCount: type: integer format: int64 description: Quantidade de registros processados com erro creationDate: type: string format: date-time description: Data de criação da importação entryItemLotIntegration: description: Tabela de lotes de integração da tabela de lançamentos type: object required: – integrated – done properties: id: type: string maxLength: 32 description: Id da entidade integrated: type: boolean description: Se já foi enviado para integrar para g5 done: type: boolean description: Se já foi gerado o lote inteiro e está pronto para integrar entryCustomization: description: Tabela de lotes de integração da tabela de lançamentos type: object required: – script properties: id: type: string maxLength: 32 description: Id da entidade script: type: string description: Script para ser executado notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment