> ## Documentation Index > Fetch the complete documentation index at: https://docs.pland.app/llms.txt > Use this file to discover all available pages before exploring further. # List Salaries > List salary records with optional filtering, pagination, and sorting. Supports various filters for advanced querying of salary data. ## OpenAPI ````yaml GET /salaries/ openapi: 3.0.0 info: title: PlanD API description: PlanD Public API version: '2' servers: - url: http:localhost:3000/v2 description: Local Server - url: https://beta-api.pland.app/v2 description: Sandbox Server - url: https://cloud-api.pland.app/v2 description: Production Server security: [] tags: - name: Absences description: >- Absence management endpoints for creating, updating, and managing user absences - name: Activity Types description: Activity type management operations - name: API Keys description: API key management operations for programmatic access to the API - name: Assignments description: Assignment management operations - name: Chat (Legacy) description: >- Legacy chat operations using Stream Chat service (deprecated - use Entity Chat v2 instead) - name: Client description: Unauthenticated client-facing operations - name: Company description: Company information and settings management operations - name: Complaints description: Customer complaint and ticket management operations - name: Contacts description: Contact person management operations - name: Customers description: Customer management operations - name: Customer Objects description: >- Customer object management operations - locations and buildings where services are performed - name: Documents description: >- Document management operations for uploading, retrieving, and managing files - name: Logbuch description: >- Operations for sending, retrieving, updating, and deleting Logbuch in entity chats. - name: Push Notifications description: Operations for listing, reading, and deleting user notifications. - name: Equipment description: Equipment management operations - name: Equipment Types description: Equipment type management operations - name: Assignment Confirmations description: Assignment confirmation management operations - name: Credit description: >- Credit note management operations for creating and handling credit documents - name: Invoice description: >- Invoice management operations for creating, managing, and processing customer invoices - name: Invoice Reminders description: >- Invoice reminder management operations for creating and handling payment reminder documents - name: Invoice Reminder Templates description: >- Invoice reminder template management operations for creating and handling reminder document templates - name: Invoice Storno description: Invoice storno (cancellation) document management operations - name: Invoice Templates description: >- Invoice template management operations for creating and handling invoice document templates - name: Offers description: Offer management operations - name: ServiceReport description: >- Service report management operations for creating and handling service documentation - name: Holiday description: Holidays management - name: Implementation description: User implementation progress tracking and onboarding management - name: Jobs description: >- Endpoints for managing jobs, including creation, listing, updating, and job-specific actions. - name: Material Orders description: Operations for listing, viewing, updating, and managing material orders. - name: Notifications description: User notification management operations - name: Payment Methods description: >- Payment method management operations for configuring available payment options - name: Payment Terms description: Operations for managing payment terms - name: Payments description: Payment management operations - name: Articles description: >- Operations for creating, listing, viewing, updating, and deleting articles. - name: Suppliers description: Supplier management operations - name: Service Products description: >- Operations for creating, listing, viewing, updating, and deleting service products. - name: Quality Control description: Quality control and assessment management operations - name: Pay Types description: Pay type management operations for salary and absence types - name: Salary description: >- Salary management operations for tracking and managing employee compensation - name: Surcharges description: Surcharge management operations for pay types and salary calculations - name: Search description: Search for entities in PlanD - name: Signing description: Endpoints for creating and listing signings (digital signatures). - name: Tasks description: Task management operations - name: Task Types description: Task type management operations - name: Tax Rates description: >- Tax rate management operations for handling VAT, zero rates, exemptions, and reverse charge scenarios - name: Time Tracking description: >- Time tracking management endpoints for recording, monitoring, and managing work time entries - name: Assets description: Asset URL management operations for secure access to uploaded files - name: Upload description: >- CSV and file uploads for various entities (articles, material, users, customers, objects, contacts, equipment, images) - name: Users description: >- User management endpoints for creating, updating, and managing system users - name: Authentication description: User authentication and password management operations - name: Banking Transactions description: Banking transaction management operations - name: Webhooks - name: SMS description: Endpoints for SMS status updates and link tracking. paths: /salaries/: get: tags: - Salary summary: List salaries description: >- List salary records with optional filtering, pagination, and sorting. Supports various filters for advanced querying of salary data. operationId: listSalaries parameters: - name: limit in: query description: Maximum number of items to return required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - name: offset in: query description: Number of items to skip for pagination required: false schema: type: integer default: 0 minimum: 0 - name: sort in: query description: Sort field and direction (e.g. from:1, createdAt:-1) required: false schema: type: string - name: status in: query required: false schema: $ref: '#/components/schemas/FilterStatus' - name: ids in: query required: false schema: $ref: '#/components/schemas/FilterIds' - name: user in: query required: false schema: $ref: '#/components/schemas/FilterUser' - name: from in: query required: false schema: $ref: '#/components/schemas/FilterFrom' - name: to in: query required: false schema: $ref: '#/components/schemas/FilterTo' - name: object in: query required: false schema: $ref: '#/components/schemas/FilterObject' - name: objectIds in: query required: false schema: $ref: '#/components/schemas/FilterObjectIds' - name: objectsByName in: query required: false schema: $ref: '#/components/schemas/FilterObjectsByName' - name: fromWithIncludedTrackingDate in: query required: false schema: $ref: '#/components/schemas/FilterFromWithIncludedTrackingDate' - name: activityTypeId in: query required: false schema: $ref: '#/components/schemas/FilterActivityTypeId' - name: jobIds in: query required: false schema: $ref: '#/components/schemas/FilterJobIds' - name: trackingJobDate in: query required: false schema: $ref: '#/components/schemas/FilterTrackingJobDate' - name: generalField in: query required: false schema: $ref: '#/components/schemas/GeneralFieldFilter' responses: '200': description: List of salary records content: application/json: schema: type: array items: $ref: '#/components/schemas/Salary' '401': description: Unauthorized '403': description: Forbidden security: - API-Key: [] - Bearer-Auth: [] components: schemas: FilterStatus: description: Filter by status (single value or comma-separated list) type: string x-internal: true FilterIds: description: Filter by IDs (array of objectIds) type: array items: type: string format: objectid x-internal: true FilterUser: description: Filter by user ID type: string format: objectid x-internal: true FilterFrom: description: Filter by creation date from (timestamp) type: integer format: int64 x-internal: true FilterTo: description: Filter by creation date to (timestamp) type: integer format: int64 x-internal: true FilterObject: description: Filter by object ID type: string format: objectid x-internal: true FilterObjectIds: description: Filter by object IDs type: array items: type: string format: objectid x-internal: true FilterObjectsByName: description: Filter something (e.g. complaints) by the objects name or number properties: value: description: The name or number of the object to filter by type: string type: object FilterFromWithIncludedTrackingDate: description: >- Filter by date range including tracking date - searches across from, timeStart, and trackingJobDate fields type: array items: type: integer maxItems: 2 minItems: 2 x-internal: true FilterActivityTypeId: title: Filter for Activity Type ID description: >- Filter to search jobs by activity type IDs. It can handle multiple activity type IDs and also includes checks for assignments, jobs, and salaries. type: array items: description: Activity Type ID to filter by type: string format: objectId x-internal: true FilterJobIds: description: Filter by job IDs type: array items: type: string format: objectid x-internal: true FilterTrackingJobDate: description: >- Filter by tracking job date range - accepts TimeFrame JSON object with from/to timestamps type: string x-internal: true GeneralFieldFilter: description: >- A dynamic filter that allows filtering on any field with various operators. Supports string, number, boolean, date, and objectid field types. required: - key - value - operator - fieldType properties: key: description: >- The field path to filter on (supports dot notation for nested fields) type: string example: customer.name value: description: The value to filter by example: Example Company oneOf: - type: string - type: number - type: boolean - type: array items: type: string operator: description: The comparison operator to use type: string enum: - contains - equals - not_equals - greater_than - less_than - greater_equal - less_equal - in - not_in - exists - not_exists - regex example: contains fieldType: description: The data type of the field being filtered type: string enum: - string - number - boolean - date - objectid example: string type: object x-internal: true Salary: title: Salary description: >- A salary record representing payment information for work performed by a user. Inherits common fields from ChatableEntityModel. type: object allOf: - $ref: '#/components/schemas/ChatableEntityModel' - properties: userId: description: User ID who earned this salary type: string format: objectid timeTrackingId: description: Time tracking entry ID this salary is based on type: string format: objectid billed: description: Whether this salary has been billed type: boolean type: description: Type of salary (regular, overtime, etc.) type: string objectId: description: Object ID where the work was performed type: string format: objectid workingTime: description: Actual working time in seconds type: integer targetTime: description: Target working time in seconds type: integer salaryPerHour: description: Hourly salary rate type: number format: float salary: description: Total salary amount type: number format: float reason: description: Reason or description for this salary entry type: string approvedByUserId: description: User ID who approved this salary type: string format: objectid updatedByUserId: description: User ID who last updated this salary type: string format: objectid from: description: Start date/time for this salary period type: string format: date-time to: description: End date/time for this salary period type: string format: date-time addedTime: description: Additional time added by object manager in seconds type: integer break: description: Break time in seconds type: integer minBreakTime: description: Minimum break time required in seconds type: integer absenceId: description: Only set when type = Salary Absence type: string format: objectid jobId: description: Job ID this salary is associated with type: string format: objectid trackingJobDate: description: Date/time when job tracking was started type: string format: date-time ignoreDoubleSalaries: description: Whether to ignore double salary checks type: boolean roundedUp: description: Whether working time was rounded up type: boolean roundUpSeconds: description: Seconds that were rounded up type: integer payType: description: Pay type classification type: string nightWorkingTime: description: >- Total working time during night hours in seconds (deprecated - use surcharges) type: integer deprecated: true sundayWorkingTime: description: >- Total working time on Sunday in seconds (deprecated - use surcharges) type: integer deprecated: true publicHolidayWorkingTime: description: >- Total working time on public holidays in seconds (deprecated - use surcharges) type: integer deprecated: true surcharges: description: >- Array of salary surcharges for special work conditions (night, weekend, holiday, etc.) type: array items: $ref: '#/components/schemas/SurchargeOnSalary' drivingTime: description: Total driving time in seconds type: integer assignmentId: description: Assignment ID this salary belongs to type: string format: objectid activityTypeId: description: Activity type ID for categorizing work type: string format: objectid releasedBySystem: description: Indicates if this salary was released by the system type: boolean nullable: true type: object ChatableEntityModel: title: Chatable Entity Model description: Base class for all entities that can have a chat associated with them. type: object allOf: - $ref: '#/components/schemas/Entity' - properties: chatId: description: ID of the chat associated with this entity type: string format: objectid nullable: true type: object SurchargeOnSalary: title: Surcharge on Salary description: >- Represents a surcharge applied to a salary for special work conditions like night hours, weekends, holidays, or driving time. required: - seconds type: object allOf: - $ref: '#/components/schemas/Entity' - properties: surchargeId: description: Surcharge ID reference type: string format: objectid name: description: >- Name of the surcharge (e.g., "Night Shift", "Weekend", "Holiday") type: string number: description: Surcharge number for ordering/display purposes type: integer surcharge: description: Surcharge percentage (e.g., 25 for 25% surcharge) type: number format: float activeOn: description: Configuration defining when this surcharge is active type: object userId: description: User ID (used in salary export rows) type: string format: objectid date: description: Date (used in salary export rows) type: string format: date seconds: description: Duration of the surcharge application in seconds type: integer minimum: 0 activeTimeFrames: description: >- Time frames when this surcharge was active during the salary period type: array items: properties: from: description: Start time of the surcharge period type: string format: date-time to: description: End time of the surcharge period type: string format: date-time type: object _cash: description: >- Calculated cash amount for this surcharge (available in combined calculations) type: number format: float default: 0 type: object Entity: title: Entity description: >- Base class for all entities in the system, providing common properties and methods. properties: _id: description: Unique identifier of the entity type: string format: objectid number: description: Unique number of the entity, used for identification type: integer companyId: description: The ID of the company this entity belongs to type: string format: objectid x-internal: true status: $ref: '#/components/schemas/StatusStruct' type: object StatusStruct: description: Entity Status information properties: status: description: Current status type: integer createdAt: description: Creation timestamp type: string format: date-time createdBy: description: User who created this supplier type: string format: objectid lastModifiedAt: description: Last modification timestamp type: string format: date-time lastModifiedBy: description: User who last modified this supplier type: string format: objectid type: object securitySchemes: API-Key: type: apiKey name: x-API-Key in: header Bearer-Auth: type: http bearerFormat: JWT scheme: bearer ````