Skip to main content
POST
/
payment-sheet
/
export
Cria uma exportação de folhas de pagamento
curl --request POST \
  --url https://api.example.com/payment-sheet/export \
  --header 'Content-Type: application/json' \
  --data '
{
  "startDate": "01/05/2024",
  "endDate": "31/05/2024",
  "source": "Keevo"
}
'
{
  "id": "123-abc",
  "competence": "07/2024",
  "startDate": "01/07/2024",
  "endDate": "31/07/2024",
  "source": "KEEVO NG FOLHA",
  "status": "PENDING",
  "layoutId": "123-456abc",
  "collaborators": 10,
  "paymentSheets": [
    {
      "collaborator": {
        "id": "123-456abc",
        "code": 7,
        "name": "Fulano de Tal",
        "documentNumber": "15621118054",
        "internalRegistration": "49172594718",
        "photo": "https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg",
        "businessUnit": {
          "id": "123-456abc",
          "name": "Fulano de Tal",
          "documentNumber": "15621118054",
          "documentNumberType": "CNPJ",
          "complementaryRegistration": "15621118054",
          "complementaryRegistrationType": "CNPJ",
          "photo": "https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg"
        }
      },
      "status": "PENDING",
      "events": [
        {
          "id": "123-abc",
          "code": "250087",
          "description": "Keevo NG Folha",
          "measurementUnit": "Horas",
          "numericValue": 480,
          "stringValue": "8:00",
          "dates": [
            "2024-07-22T00:00:00.000Z",
            "2024-07-23T00:00:00.000Z"
          ],
          "tron": {},
          "advancedPercentage": "50%"
        }
      ]
    }
  ],
  "base64": "dGVzdA=="
}

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,
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:
["123-456abc,987-654321"]

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=="