Skip to main content
GET
/
payment-sheet
/
parameter
/
{paymentSheetParameterId}
/
collaborators
Busca colaboradores vinculados a um parâmetro de folha de pagamento
curl --request GET \
  --url https://api.example.com/payment-sheet/parameter/{paymentSheetParameterId}/collaborators
{
  "pagina": 0,
  "total": 5,
  "unidades": [
    {
      "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"
      }
    }
  ],
  "limite": 10
}

Path Parameters

paymentSheetParameterId
string
required

ID do parâmetro de folha de pagamento

Query Parameters

searchText
string

Texto pesquisado para filtrar consulta

pagina
number

Página que deseja retornar os resultados

Example:

0

limite
number

Quantidade de itens que retorna na consulta. Min 1 - Max 100

Example:

100

collaboratorType
enum<string>
default:CLT

Tipo de vínculo do colaborador

Available options:
CLT,
PRESTADOR_SERVICO

Response

Colaboradores vinculados ao parâmetro de folha de pagamento

pagina
number
required

Pagina retornada dos dados

Example:

0

total
number
required

Quantidade total de unidades para consultar

Example:

5

unidades
object[]
required

Resultado da consulta

limite
number

Quantidade de itens retornados na consulta

Example:

10