Skip to main content
POST
Cria uma exportação de folhas de pagamento

Body

application/json

Dados da exportação

startDate
string
required

Data inicial (dd/MM/yyyy) para a busca

Example:

"01/05/2024"

endDate
string
required

Data final (dd/MM/yyyy) para a busca

Example:

"31/05/2024"

source
enum<string>
default:Keevo
required

Fonte de parâmetro de folha de pagamento

Available options:
Keevo,
OneFlow,
Sankhya,
Tron,
Outro
sourceName
string

Nome da fonte do parâmetro de folha de pagamento, para o caso de uma fonte desconhecida (Outro)

Example:

"Folha TMNT Dev Team"

paymentSheetParameterId
string

ID do parâmetro de folha de pagamento

Example:

"123-456abc"

businessUnitId
string

ID da unidade de negócio

Example:

"123-456abc"

punchRuleId
string

ID da regra de ponto

Example:

"123-456abc"

shutdownId
string

ID do fechamento

Example:

"123-456abc"

collaboratorIds
string[]

IDs de colaboradores específicos

Example:

Response

Exportação criada

id
string
required

Id da exportação de folha de pagamento

Example:

"123-abc"

competence
string
required

Competência da exportação de folha de pagamento

Example:

"07/2024"

startDate
string
required

Data inicial da exportação de folha de pagamento

Example:

"01/07/2024"

endDate
string
required

Data final da exportação de folha de pagamento

Example:

"31/07/2024"

source
string
required

Fonte do parâmetro de folha de pagamento

Example:

"KEEVO NG FOLHA"

status
enum<string>
default:PENDING
required

Status da exportação de folha de pagamento

Available options:
PENDING,
PROCESSED,
PROCESSING
layoutId
string

ID do layout de exportação em .txt, para o caso de uma fonte desconhecida (Outro)

Example:

"123-456abc"

collaborators
number

Número de colaboradores da exportação de folha de pagamento

Example:

10

paymentSheets
object[]

Folhas de pagamento

base64
string

Base64 dos eventos em formato .txt

Example:

"dGVzdA=="