> For the complete documentation index, see [llms.txt](https://devdocs.brightpay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://devdocs.brightpay.com/available-apis/payroll-api-v1.0-methods.md).

# Payroll API V1.0 Methods

Below is a list of the currently supported API methods within the Payroll API. The Payroll API will integrate with the BrightPay Cloud application.

Note there is also a swagger interface available that supports testing of Authentication and Integration: <https://external.brightpay.com/index.html>

### Get Current User Summary

{% openapi src="/files/k9AS91OXSvcxiAsRDLHZ" path="/api/v1/Payroll/GetCurrentUserSummary" method="get" %}
[swaggerProd.json](https://3990740512-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLeO4xCDW3mr7w7oBBrqw%2Fuploads%2Ffi2QkuzFxDR9jyhaKHtX%2FswaggerProd.json?alt=media\&token=e7cafb7d-fc1e-4a4f-a8ab-d62318a733d1)
{% endopenapi %}

### Get Organisations\Employers

{% openapi src="/files/k9AS91OXSvcxiAsRDLHZ" path="/api/v1/Payroll/GetEmployers" method="get" %}
[swaggerProd.json](https://3990740512-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLeO4xCDW3mr7w7oBBrqw%2Fuploads%2Ffi2QkuzFxDR9jyhaKHtX%2FswaggerProd.json?alt=media\&token=e7cafb7d-fc1e-4a4f-a8ab-d62318a733d1)
{% endopenapi %}

### Get Hourly Rates

{% openapi src="/files/k9AS91OXSvcxiAsRDLHZ" path="/api/v1/Payroll/GetEmployerHourlyRates" method="get" %}
[swaggerProd.json](https://3990740512-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLeO4xCDW3mr7w7oBBrqw%2Fuploads%2Ffi2QkuzFxDR9jyhaKHtX%2FswaggerProd.json?alt=media\&token=e7cafb7d-fc1e-4a4f-a8ab-d62318a733d1)
{% endopenapi %}

### Get Employees

{% openapi src="/files/k9AS91OXSvcxiAsRDLHZ" path="/api/v1/Payroll/GetEmployees" method="get" %}
[swaggerProd.json](https://3990740512-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLeO4xCDW3mr7w7oBBrqw%2Fuploads%2Ffi2QkuzFxDR9jyhaKHtX%2FswaggerProd.json?alt=media\&token=e7cafb7d-fc1e-4a4f-a8ab-d62318a733d1)
{% endopenapi %}

### Create Employee Hourly Payments

{% openapi src="/files/k9AS91OXSvcxiAsRDLHZ" path="/api/v1/Payroll/CreateEmployeeHourlyPayments" method="post" %}
[swaggerProd.json](https://3990740512-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLeO4xCDW3mr7w7oBBrqw%2Fuploads%2Ffi2QkuzFxDR9jyhaKHtX%2FswaggerProd.json?alt=media\&token=e7cafb7d-fc1e-4a4f-a8ab-d62318a733d1)
{% endopenapi %}