> ## Documentation Index > Fetch the complete documentation index at: https://developers.pontua.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Busca exportações de folha de pagamento ## OpenAPI ````yaml https://api.pre.pontua.tech/api/public/doc-json get /payment-sheet/export openapi: 3.0.0 info: title: Pontua Public API description: >- API oficial da Pontua para integrações de clientes externos. Autentique com o token gerado no dashboard em **Configurações → API**. Envie o token no header `Authorization: Bearer `. version: '1.0' contact: {} servers: [] security: [] tags: [] paths: /payment-sheet/export: get: tags: - Payment Sheet summary: Busca exportações de folha de pagamento operationId: PaymentSheetExportController_getAll parameters: - name: searchText description: Texto pesquisado para filtrar consulta required: false in: query schema: type: string - name: pagina description: Página que deseja retornar os resultados required: false in: query schema: example: 0 type: number - name: limite description: Quantidade de itens que retorna na consulta. Min 1 - Max 100 required: false in: query schema: example: 100 type: number - description: Competência da exportação de folha de pagamento required: false name: competence in: query schema: example: 07/2024 type: string - description: Status da exportação required: false name: status in: query schema: default: PENDING enum: - PENDING - PROCESSED - PROCESSING type: string - description: Nome da fonte do parâmetro de folha de pagamento (busca exata) required: false name: source in: query schema: example: Keevo type: string responses: '200': description: Exportações de folha de pagamento content: application/json: schema: $ref: '#/components/schemas/PaymentSheetExportsDto' default: description: "\n\t\t\t400 - Bad Request: A solicitação não está no formato correto.\n\t\t\t401 - Unauthorized: A solicitação não foi autorizada. Verifique se o token de acesso é válido.\n\t\t\t403 - Forbidden: Acesso proibido! Requer um nível de permissão mais elevado.\n\t\t\t404 - Not Found: O recurso solicitado não foi encontrado.\n\t\t\t500 - Internal Server Error: Erro de execução no servidor!\n\t\t\t" content: application/json: schema: $ref: '#/components/schemas/ErrorDto' deprecated: false security: - bearer: [] - cookie: [] components: schemas: PaymentSheetExportsDto: type: object properties: pagina: type: number description: Pagina retornada dos dados example: 0 limite: type: number description: Quantidade de itens retornados na consulta example: 10 total: type: number description: Quantidade total de unidades para consultar example: 5 unidades: description: Resultado da consulta type: array items: $ref: '#/components/schemas/PaymentSheetExportDto' required: - pagina - total - unidades ErrorDto: type: object properties: service: type: string description: Rota solicitada method: type: string description: Método http message: description: Mensagem do erro oneOf: - type: string example: message erro - type: array items: type: string example: - erro 1 - erro 2 required: - service - method - message PaymentSheetExportDto: type: object properties: id: type: string description: Id da exportação de folha de pagamento example: 123-abc competence: type: string description: Competência da exportação de folha de pagamento example: 07/2024 startDate: type: string description: Data inicial da exportação de folha de pagamento example: 01/07/2024 endDate: type: string description: Data final da exportação de folha de pagamento example: 31/07/2024 source: type: string description: Fonte do parâmetro de folha de pagamento example: KEEVO NG FOLHA status: type: string description: Status da exportação de folha de pagamento enum: - PENDING - PROCESSED - PROCESSING default: PENDING layoutId: type: string description: >- ID do layout de exportação em .txt, para o caso de uma fonte desconhecida (Outro) example: 123-456abc collaborators: type: number description: Número de colaboradores da exportação de folha de pagamento example: 10 paymentSheets: description: Folhas de pagamento type: array items: $ref: '#/components/schemas/PaymentSheetDto' base64: type: string description: Base64 dos eventos em formato .txt example: dGVzdA== required: - id - competence - startDate - endDate - source - status PaymentSheetDto: type: object properties: collaborator: description: Dados do colaborador allOf: - $ref: '#/components/schemas/PaymentSheetCollaboratorDto' status: type: string description: Status da integração da folha de pagamento enum: - PENDING - PROCESSED - PROCESSING default: PENDING events: description: Dados dos eventos type: array items: $ref: '#/components/schemas/PaymentSheetExportEventDto' required: - collaborator - status - events PaymentSheetCollaboratorDto: type: object properties: id: type: string description: ID do colaborador example: 123-456abc code: type: number description: Código numérico do colaborador example: 7 name: type: string description: Nome do colaborador example: Fulano de Tal documentNumber: type: string description: CPF ou CNPJ do colaborador example: '15621118054' internalRegistration: type: string description: Matrícula interna do colaborador example: '49172594718' photo: type: string description: Url para download da foto example: https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg businessUnit: description: Unidade de negócio do colaborador allOf: - $ref: '#/components/schemas/PaymentSheetExportBusinessUnitDto' required: - id - code - name - documentNumber PaymentSheetExportEventDto: type: object properties: id: type: string description: Id do evento de folha de pagamento example: 123-abc code: type: string description: Código do evento de folha de pagamento example: '250087' description: type: string description: Descrição do evento de folha de pagamento example: Keevo NG Folha measurementUnit: type: string description: Unidade de medida da exibição do valor enum: - Horas - Dias - Datas default: Horas numericValue: type: number description: >- Valor numérico do evento de folha de pagamento (em caso de unidade de medida em horas, este virá em minutos, útil para cálculos) example: 480 stringValue: type: string description: Valor por extenso do evento de folha de pagamento example: '8:00' dates: description: >- Lista de valores para um evento de folha de pagamento que é medido em datas example: - '2024-07-22T00:00:00.000Z' - '2024-07-23T00:00:00.000Z' type: array items: format: date-time type: string tron: type: object description: >- Valores exclusivos para integração com o sistema TRON. Contém valor generico a pedido do cliente. Obs: Para o campo de faltas, ele retorna um objeto de { date: ABSENCE | HALF_ABSENCE } advancedPercentage: type: string description: >- Percentual de acréscimo, caso seja um evento de regra avançada ([OT_ADVANCED]) example: 50% required: - id - code - description - measurementUnit PaymentSheetExportBusinessUnitDto: type: object properties: id: type: string description: ID da unidade de negócio example: 123-456abc name: type: string description: Nome da unidade de negócio example: Fulano de Tal documentNumber: type: string description: CPF ou CNPJ da unidade de negócio example: '15621118054' documentNumberType: type: string description: Tipo do número de documento da unidade de negócio enum: - CNPJ - CPF default: CNPJ complementaryRegistration: type: string description: Cadastro complementar da unidade de negócio example: '15621118054' complementaryRegistrationType: type: string description: Tipo de cadastro complementar da unidade de negócio enum: - CNPJ - CPF default: CNPJ photo: type: string description: Url para download da foto example: https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg required: - id - name - documentNumber - documentNumberType ````