--- updatedAt: 2026-06-29T09:41:37.000Z agentTools: projectIndex: https://developers.payfit.io/llms.txt --- # List all Collaborators Meal Vouchers 🇫🇷 Returns all Collaborators Meal Vouchers for a given month. Only available for french companies. \ **Required scopes**: *collaborators:meal-vouchers:read* # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Partner API", "description": "An API to let third parties communicate with PayFit", "version": "1.0" }, "servers": [ { "url": "https://partner-api.payfit.com", "description": "The PayFit API production server" } ], "paths": { "/companies/{companyId}/collaborators/meal-vouchers": { "get": { "operationId": "GET_collaborators_meal_vouchers", "summary": "List all Collaborators Meal Vouchers 🇫🇷", "description": "Returns all Collaborators Meal Vouchers for a given month. Only available for french companies.\n\\\n**Required scopes**: *collaborators:meal-vouchers:read*", "tags": [ "Collaborator" ], "parameters": [ { "in": "path", "name": "companyId", "schema": { "type": "string" }, "required": true, "description": "The id of the company" }, { "in": "query", "name": "date", "schema": { "type": "string", "pattern": "^2\\d{3}(0[1-9]|1[0-2])$" }, "required": true, "description": "The month to fetch the data for. This must be in the format YYYYMM, January being the month \"01\".", "example": 202212 }, { "in": "query", "name": "nextPageToken", "required": false, "schema": { "title": "nextPageToken", "type": "string", "additionalProperties": false }, "description": "The encoded pagination token" }, { "in": "query", "name": "maxResults", "required": false, "schema": { "title": "maxResults", "type": "string", "additionalProperties": false, "default": "10" }, "description": "Allows to define the maximum number of items to fetch at once. (Max: 50, Default: 10)" } ], "responses": { "200": { "description": "All collaborators meal vouchers of the company.", "content": { "application/json": { "schema": { "title": "mealVouchers", "type": "object", "additionalProperties": false, "properties": { "mealVouchers": { "type": "array", "items": { "title": "meal-voucher", "type": "object", "properties": { "collaboratorId": { "type": "string", "description": "Id of the collaborator." }, "vouchersCount": { "type": "number", "description": "Represents the number of days a collaborator worked during the month and for which he/she should receive meal vouchers." }, "voucherAmount": { "type": "number", "description": "Represents the amount of a single meal voucher." }, "dayOffEligibility": { "type": "boolean", "description": "Defines if the voucher can be used to pay a meal on a sunday and on a bank holiday or not." }, "voucherCompanyPartAmount": { "type": "number", "description": "Represents the company part amount of a single meal voucher." }, "voucherEmployeePartAmount": { "type": "number", "description": "Represents the employee part amount of a single meal voucher." } }, "required": [ "collaboratorId", "vouchersCount", "voucherAmount", "dayOffEligibility", "voucherCompanyPartAmount", "voucherEmployeePartAmount" ] } }, "meta": { "title": "meta", "type": "object", "additionalProperties": false, "properties": { "nextPageToken": { "type": "string", "nullable": true }, "count": { "type": "integer", "nullable": true } } } }, "required": [ "mealVouchers", "meta" ] }, "examples": { "mealVouchers": { "summary": "An example of mealVouches", "value": { "meta": { "nextPageToken": "eyJsaW1pdCI6NTAsIm9mZnNldCI6NTB9", "count": 2 }, "mealVouchers": [ { "collaboratorId": "6fe3a703-89f5-414d-8190-88f0d80435a3", "vouchersCount": 10, "voucherAmount": 8.5, "dayOffEligibility": false, "voucherCompanyPartAmount": 4.5, "voucherEmployeePartAmount": 4 }, { "collaboratorId": "6fe3a703-89f5-414d-8190-88f0d80435a4", "vouchersCount": 15, "voucherAmount": 9, "dayOffEligibility": true, "voucherCompanyPartAmount": 3, "voucherEmployeePartAmount": 6 } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "error", "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "A human readable error" }, "details": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string", "additionalProperties": true } ] }, "errors": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": [ "error" ] }, "examples": { "error": { "summary": "An example of an error message", "value": { "code": 400, "error": "Bad request", "details": "Field \"id\" is required." } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "title": "error", "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "A human readable error" }, "details": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string", "additionalProperties": true } ] }, "errors": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": [ "error" ] }, "examples": { "error": { "summary": "An example of an error message", "value": { "code": 401, "error": "Unauthorized" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "error", "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "A human readable error" }, "details": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string", "additionalProperties": true } ] }, "errors": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": [ "error" ] }, "examples": { "error": { "summary": "An example of an error message", "value": { "code": 403, "error": "Forbidden action", "details": "Missing scope \"contracts:read\"." } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "title": "error", "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "A human readable error" }, "details": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string", "additionalProperties": true } ] }, "errors": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": [ "error" ] }, "examples": { "error": { "summary": "An example of an error message", "value": { "code": 404, "error": "Ressource not found", "details": "The provided id is wrong" } } } } } } }, "security": [ { "partner-api-oauth": [ "collaborators:meal-vouchers:read" ] } ] } } }, "components": { "securitySchemes": { "partner-api-oauth": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://oauth.payfit.com/authorize", "tokenUrl": "https://oauth.payfit.com/token", "scopes": { "contracts:read": "Allow to read contracts information", "collaborators:contracts:write": "Allow to create contracts on a collaborator", "contracts:payslips:read": "Allow to read payslips", "contracts:time-information:read": "Allow to read time related information of contracts", "pension:read": "Allow to read pension documents", "collaborators:read": "Read general information of collaborators.", "collaborators:write": "Allow to create collaborators.", "collaborators:contracts:read": "Read contract information of collaborators.", "collaborators:management:read": "Read information about organisation and management.", "collaborators:meal-vouchers:read": "Read meal vouchers information of collaborators.", "collaborators:personal:read": "Read personal data of collaborators.", "collaborators:social-security:read": "Read the social security identifiers of collaborators.", "collaborators:legal-identity:read": "Read the legal identity information of collaborators.", "collaborators:bank-info:read": "Allow to read the bank info of collaborators.", "accounting:read": "Allow to read company accounting information", "payment-files:read": "Allow to read company payment file information", "time:read": "Allow to read time data", "time:write": "Allow to write time data", "health-insurance:read": "Allow to read health insurance contracts", "health-insurance:write": "Allow to write health insurance contracts" } } } } } }, "tags": [ { "name": "Collaborator" } ] } ```