Payroll/HR

Get Tax Codes

Summary Description

The GET Tax Codes by list by Company ID endpoint allows users to retrieve a comprehensive list of Tax Codes details from a client's Paylocity instance. To use this endpoint, the Paylocity “taxes” parameter must be specified. Tax codes serve as a means for tax authorities and organizations to categorize various forms of taxes and tax-related data. These codes facilitate precise computation, reporting, and adherence to diverse tax responsibilities. Tax codes are jurisdiction-specific and can vary substantially between different locations.

Pagination can be achieved by using the "taxes" parameter and specifying the values of "limit" and "offset" to decide the quantity of records to be retrieved. The utilization of the "limit" option permits the user to restrict the quantity of rows that are retrieved from a query, whereas the "offset" option enables the omission of a designated number of rows preceding the commencement of the result set. The utilization of both the limit and offset parameters in a query allows for the skipping of rows as well as the restriction of the number of rows returned. “includeTotalCount” parameter can also be used to return the total number of resources available (even though only a subset may be returned).

Use Cases

  • The process of calculating income tax involves the utilization of tax codes, which serve to calculate the appropriate income tax rates and brackets for both people and businesses. Distinct tax codes may be applicable to different income thresholds, filing statuses, and categories of income (such as capital gains and dividends).
  • Payroll Deductions: Employers utilize tax codes to accurately compute and retain the appropriate amount of income tax, Social Security tax, and Medicare tax from employees' wages. These codes serve to guarantee that employees have the accurate amount of tax deducted throughout the year.
get/apiHub/payroll/v1/companies/{companyId}/taxes

Request

  • Base URL
    dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
  • URL
    dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/{companyId}/taxes
  • Auth
    none declared

Path parameters

companyIdstring required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. Allowable Values: 9 char max

Query parameters

includeTotalCountboolean

A boolean value representing whether the API should return the total number of resources available (even though only a subset may be returned). When includeTotalCount=true, then the X-Pcty-Total-Count response header should be added to the response and will specify the total number of records available. APIs that support X-Pcty-Total-Count should include this parameter in their specification.

offsetinteger

Pagination offset.

limitinteger

Number of tax codes per page. Default Value: 20 Maximum Value: 100

Headers

Authorizationstring

Authorization token. Ex. Bearer ...

testModeboolean

If true all responses are mocked and generated randomly.

Response

OK

companyIdstring nullable

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.

codestring nullable

A distinct code representing a specific entity or item, providing a concise reference for accurate identification and categorization.

descriptionstring nullable

A detailed textual explanation or label that offers additional context and meaning to the associated code or entity.

einstring nullable

The Employee Identification Number (EIN) is a unique identifier assigned to businesses and organizations for tax-related purposes.

startDatestring date-time nullable

The date on which a specific process, program, or activity begins, serving as a reference point for timeline-related data.

endDatestring date-time nullable

End date of the tax code.

depositFrequencystring nullable

A descriptor specifying the frequency at which deposits or transactions are made, aiding in financial planning and management.

depositMethodstring nullable

A method or approach used for making deposits or financial transactions, offering flexibility and customization options.

typestring nullable

A categorical label defining the type or category to which an entity or item belongs, enhancing organizational classification.

depositWithstring nullable

A descriptor indicating the entity or account with which deposits or financial transactions are associated, providing clarity on financial relationships.

isEmployeeTaxboolean nullable

An indicator specifying whether a particular element or entity is related to employee taxation, aiding in tax-related management and reporting.

isExemptboolean nullable

Indicates if the tax code is exempt.

isSuiReimbursableboolean nullable

An indicator indicating whether an item or entity is eligible for State Unemployment Insurance (SUI) reimbursement, providing clarity on financial considerations.

isActiveboolean nullable

An indicator denoting the current status or active state of an entity or item, facilitating management and decision-making processes.

isFiledWithAgencyboolean nullable

An indicator specifying whether an entity or item is filed with a regulatory agency, ensuring compliance and reporting transparency.

workPsdCodestring nullable

Work PSD (Payment Service Delivery) code for the tax code.

Changes

No recorded changes to this operation across all 1 revision of this API.