> ## Documentation Index > Fetch the complete documentation index at: https://docs.bindbee.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get Payroll Codes > Returns a list of Payroll Code objects. ## OpenAPI ````yaml get /api/hris/v1/payroll-codes openapi: 3.1.0 info: title: Bindbee APIs version: 0.1.0 servers: - url: https://api.bindbee.dev - url: https://api-eu.bindbee.dev security: [] paths: /api/hris/v1/payroll-codes: get: tags: - Payroll Codes summary: Get Payroll Codes description: Returns a list of Payroll Code objects. operationId: get_payroll_codes_api_hris_v1_payroll_codes_get parameters: - name: ids in: query required: false schema: anyOf: - type: string - type: 'null' description: The ID of the payroll codes to fetch examples: - >- 01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a title: Ids description: The ID of the payroll codes to fetch - name: type in: query required: false schema: anyOf: - type: string - type: 'null' description: >- The type of payroll code to filter by (e.g., Earning, Deduction, Tax). examples: - EARNING - DEDUCTION - TAX title: Type description: >- The type of payroll code to filter by (e.g., Earning, Deduction, Tax). - name: remote_id in: query required: false schema: anyOf: - type: string - type: 'null' description: The third-party API ID of the matching object. examples: - '3235005483341316245' title: Remote Id description: The third-party API ID of the matching object. - name: include_raw_data in: query required: false schema: type: boolean description: >- Whether to include the original data Bindbee fetched from the third-party to produce these models. examples: - false default: false title: Include Raw Data description: >- Whether to include the original data Bindbee fetched from the third-party to produce these models. - name: include_custom_fields in: query required: false schema: type: boolean description: Whether to include custom fields in the response. examples: - false default: false title: Include Custom Fields description: Whether to include custom fields in the response. - name: modified_after in: query required: false schema: type: string description: >- If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC. examples: - '2024-02-21T21:22:12.993Z' title: Modified After description: >- If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC. - name: page_size in: query required: false schema: type: integer maximum: 200 minimum: 1 description: Number of results to return per page. Maximum size is 200. default: 50 title: Page Size description: Number of results to return per page. Maximum size is 200. - name: cursor in: query required: false schema: type: string description: The pagination cursor value. title: Cursor description: The pagination cursor value. - name: x-connector-token in: header required: true schema: type: string title: X-Connector-Token responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PaginatedResponse_HrisPayrollCode_' '401': description: Missing or invalid bearer authentication credentials. headers: WWW-Authenticate: description: Bearer authentication challenge. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '429': description: Rate limit exceeded. headers: X-RateLimit-Limit: description: Maximum requests allowed in the current window. schema: type: integer X-RateLimit-Remaining: description: Requests remaining in the current window. schema: type: integer X-RateLimit-Reset: description: >- Unix timestamp (seconds since epoch) at which the current rate-limit window resets. schema: type: integer Retry-After: description: Seconds to wait before retrying the request. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - HTTPBearer: [] components: schemas: PaginatedResponse_HrisPayrollCode_: properties: cursor: anyOf: - type: string - type: 'null' title: Cursor description: Cursor value to fetch next set of items examples: - MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1 page_size: type: integer title: Page Size description: Indicates the count of items in the response examples: - 50 items: items: $ref: '#/components/schemas/HrisPayrollCode' type: array title: Items description: List of items in the current response examples: - {} type: object required: - cursor - page_size - items title: PaginatedResponse[HrisPayrollCode] ErrorResponse: type: object required: - detail properties: detail: type: string HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError HrisPayrollCode: properties: id: type: string format: uuid title: Id examples: - 018b18ef-c487-703c-afd9-0ca478ccd9d6 remote_id: anyOf: - type: string - type: 'null' title: Remote Id description: The third-party API ID of the matching object. examples: - '123321' modified_at: type: string format: date-time title: Modified At description: This is the datetime that this object was last updated by Bindbee examples: - '2021-10-16T00:00:00Z' raw_data: anyOf: - additionalProperties: true type: object - type: 'null' title: Raw Data description: This is the Raw data examples: - key_1: Platform dependent data 1 key_2: Platform dependent data 2 custom_fields: anyOf: - additionalProperties: true type: object - type: 'null' title: Custom Fields description: The custom fields related to the model examples: - category_group: REG disability_type: ASBERG hire_date: '1991-03-16T00:00:00' hire_source: REFER nationality: USA original_hire_date: '1991-03-16T00:00:00' name: anyOf: - type: string - type: 'null' title: Name description: Human-readable name of the payroll code. examples: - Regular Earnings code: anyOf: - type: string - type: 'null' title: Code description: Short code identifying the payroll code within the source system. examples: - REG type: anyOf: - $ref: '#/components/schemas/HRISPayrollCodeType' - type: 'null' enum: - EARNING - DEDUCTION - TAX description: Category of the payroll code, such as Earning, Deduction, or Tax. examples: - EARNING sub_type: anyOf: - $ref: '#/components/schemas/HRISPayrollCodeSubType' - type: 'null' enum: - REGULAR - OVERTIME - BONUS - ALLOWANCE - TIME_OFF - SEVERANCE - EQUITY - REIMBURSEMENT - RETRO - HEALTH - DENTAL - VISION - HEALTH_SAVINGS - FLEXIBLE_SPENDING - RETIREMENT - LIFE_INSURANCE - SUPPLEMENTAL_INSURANCE - DISABILITY - GARNISHMENT - FUTA - SUTA - FICA - MEDICARE - FIT - SIT - INCOME_TAX - UNEMPLOYMENT - LEVY - SOCIAL_SECURITY description: >- Optional finer-grained classification of the payroll code, drawn from the set allowed for its type. Null when no unified sub-type applies. examples: - OVERTIME type: object required: - id - remote_id - modified_at - custom_fields - name - code - type - sub_type title: HrisPayrollCode description: >- The Payroll Code object represents a payroll code such as an earning, deduction, or tax used within the payroll system. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError HRISPayrollCodeType: type: string enum: - EARNING - DEDUCTION - TAX title: HRISPayrollCodeType HRISPayrollCodeSubType: anyOf: - $ref: '#/components/schemas/HRISPayrollEarningSubType' - $ref: '#/components/schemas/HRISPayrollDeductionSubType' - $ref: '#/components/schemas/HRISPayrollTaxSubType' HRISPayrollEarningSubType: type: string enum: - REGULAR - OVERTIME - BONUS - ALLOWANCE - TIME_OFF - SEVERANCE - EQUITY - REIMBURSEMENT - RETRO title: HRISPayrollEarningSubType HRISPayrollDeductionSubType: type: string enum: - HEALTH - DENTAL - VISION - HEALTH_SAVINGS - FLEXIBLE_SPENDING - RETIREMENT - LIFE_INSURANCE - SUPPLEMENTAL_INSURANCE - DISABILITY - GARNISHMENT title: HRISPayrollDeductionSubType HRISPayrollTaxSubType: type: string enum: - FUTA - SUTA - FICA - MEDICARE - FIT - SIT - INCOME_TAX - UNEMPLOYMENT - LEVY - SOCIAL_SECURITY title: HRISPayrollTaxSubType securitySchemes: HTTPBearer: type: http scheme: bearer ````