Get a payroll
curl --request GET \
--url https://api.plane.com/v1/payrolls/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.plane.com/v1/payrolls/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.plane.com/v1/payrolls/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.plane.com/v1/payrolls/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.plane.com/v1/payrolls/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.plane.com/v1/payrolls/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.com/v1/payrolls/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "pr_244UfG",
"entity": "ent_2gHL1F",
"type": "regular",
"status": "paid",
"note": null,
"period": {
"starts": "2026-08-01",
"ends": "2026-08-31"
},
"totals": {
"earnings": {
"name": null,
"source_amount": "6730.77",
"source_currency": "USD",
"destination_amount": "6730.77",
"destination_currency": "USD",
"hours": "86.67",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"taxes": {
"company": {
"name": null,
"source_amount": "417.31",
"source_currency": "USD",
"destination_amount": "417.31",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"worker": {
"name": null,
"source_amount": "1009.62",
"source_currency": "USD",
"destination_amount": "1009.62",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"benefits": {
"name": null,
"source_amount": "250.0",
"source_currency": "USD",
"destination_amount": "250.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"reimbursements": {
"name": null,
"source_amount": "80.0",
"source_currency": "USD",
"destination_amount": "80.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"deductions": {
"name": null,
"source_amount": "336.54",
"source_currency": "USD",
"destination_amount": "336.54",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"net": {
"name": null,
"source_amount": "5464.61",
"source_currency": "USD",
"destination_amount": "5464.61",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"items": [
{
"id": "pri_YogJe",
"status": "paid",
"country": "US",
"currency": "USD",
"payday": "2026-08-31",
"type": "regular",
"payroll_id": "pr_244UfG",
"entity": "ent_2gHL1F",
"worker": {
"id": "wr_2Bj6xY",
"name": "Aaron Patel",
"type": "employee"
},
"cutoff": "2026-08-28T16:00:00-07:00",
"period": {
"starts": "2026-08-01",
"ends": "2026-08-31",
"frequency": "biweekly"
},
"totals": {
"earnings": {
"name": null,
"source_amount": "6730.77",
"source_currency": "USD",
"destination_amount": "6730.77",
"destination_currency": "USD",
"hours": "86.67",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"taxes": {
"company": {
"name": null,
"source_amount": "417.31",
"source_currency": "USD",
"destination_amount": "417.31",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"worker": {
"name": null,
"source_amount": "1009.62",
"source_currency": "USD",
"destination_amount": "1009.62",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"benefits": {
"name": null,
"source_amount": "250.0",
"source_currency": "USD",
"destination_amount": "250.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"reimbursements": {
"name": null,
"source_amount": "80.0",
"source_currency": "USD",
"destination_amount": "80.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"deductions": {
"name": null,
"source_amount": "336.54",
"source_currency": "USD",
"destination_amount": "336.54",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"net": {
"name": null,
"source_amount": "5464.61",
"source_currency": "USD",
"destination_amount": "5464.61",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"earnings": [
{
"name": "Regular",
"source_amount": "6730.77",
"source_currency": "USD",
"destination_amount": "6730.77",
"destination_currency": "USD",
"hours": "86.67",
"type": "regular",
"provider_id": null,
"payer": null,
"tax": null
}
],
"taxes": [
{
"name": "Federal Income Tax",
"source_amount": "1009.62",
"source_currency": "USD",
"destination_amount": "1009.62",
"destination_currency": "USD",
"hours": null,
"type": "federal_income_tax",
"provider_id": null,
"payer": "worker",
"tax": null
},
{
"name": "Employer Social Security Tax",
"source_amount": "417.31",
"source_currency": "USD",
"destination_amount": "417.31",
"destination_currency": "USD",
"hours": null,
"type": "employer_social_security",
"provider_id": null,
"payer": "company",
"tax": null
}
],
"benefits": [
{
"name": "Health insurance",
"source_amount": "250.0",
"source_currency": "USD",
"destination_amount": "250.0",
"destination_currency": "USD",
"hours": null,
"type": "section_125_medical",
"provider_id": null,
"payer": null,
"tax": "pre_tax"
}
],
"reimbursements": [
{
"name": "Internet",
"source_amount": "80.0",
"source_currency": "USD",
"destination_amount": "80.0",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
],
"deductions": [
{
"name": "401(k) Contribution",
"source_amount": "336.54",
"source_currency": "USD",
"destination_amount": "336.54",
"destination_currency": "USD",
"hours": null,
"type": "retirement",
"provider_id": null,
"payer": null,
"tax": "pre_tax"
}
]
}
]
}
Payroll
Get a payroll
Retrieve the details of an existing payroll, including every payroll item and its line-by-line breakdown.
GET
/
v1
/
payrolls
/
{id}
Get a payroll
curl --request GET \
--url https://api.plane.com/v1/payrolls/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.plane.com/v1/payrolls/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.plane.com/v1/payrolls/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.plane.com/v1/payrolls/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.plane.com/v1/payrolls/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.plane.com/v1/payrolls/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.com/v1/payrolls/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "pr_244UfG",
"entity": "ent_2gHL1F",
"type": "regular",
"status": "paid",
"note": null,
"period": {
"starts": "2026-08-01",
"ends": "2026-08-31"
},
"totals": {
"earnings": {
"name": null,
"source_amount": "6730.77",
"source_currency": "USD",
"destination_amount": "6730.77",
"destination_currency": "USD",
"hours": "86.67",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"taxes": {
"company": {
"name": null,
"source_amount": "417.31",
"source_currency": "USD",
"destination_amount": "417.31",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"worker": {
"name": null,
"source_amount": "1009.62",
"source_currency": "USD",
"destination_amount": "1009.62",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"benefits": {
"name": null,
"source_amount": "250.0",
"source_currency": "USD",
"destination_amount": "250.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"reimbursements": {
"name": null,
"source_amount": "80.0",
"source_currency": "USD",
"destination_amount": "80.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"deductions": {
"name": null,
"source_amount": "336.54",
"source_currency": "USD",
"destination_amount": "336.54",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"net": {
"name": null,
"source_amount": "5464.61",
"source_currency": "USD",
"destination_amount": "5464.61",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"items": [
{
"id": "pri_YogJe",
"status": "paid",
"country": "US",
"currency": "USD",
"payday": "2026-08-31",
"type": "regular",
"payroll_id": "pr_244UfG",
"entity": "ent_2gHL1F",
"worker": {
"id": "wr_2Bj6xY",
"name": "Aaron Patel",
"type": "employee"
},
"cutoff": "2026-08-28T16:00:00-07:00",
"period": {
"starts": "2026-08-01",
"ends": "2026-08-31",
"frequency": "biweekly"
},
"totals": {
"earnings": {
"name": null,
"source_amount": "6730.77",
"source_currency": "USD",
"destination_amount": "6730.77",
"destination_currency": "USD",
"hours": "86.67",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"taxes": {
"company": {
"name": null,
"source_amount": "417.31",
"source_currency": "USD",
"destination_amount": "417.31",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"worker": {
"name": null,
"source_amount": "1009.62",
"source_currency": "USD",
"destination_amount": "1009.62",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"benefits": {
"name": null,
"source_amount": "250.0",
"source_currency": "USD",
"destination_amount": "250.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"reimbursements": {
"name": null,
"source_amount": "80.0",
"source_currency": "USD",
"destination_amount": "80.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"deductions": {
"name": null,
"source_amount": "336.54",
"source_currency": "USD",
"destination_amount": "336.54",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"net": {
"name": null,
"source_amount": "5464.61",
"source_currency": "USD",
"destination_amount": "5464.61",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"earnings": [
{
"name": "Regular",
"source_amount": "6730.77",
"source_currency": "USD",
"destination_amount": "6730.77",
"destination_currency": "USD",
"hours": "86.67",
"type": "regular",
"provider_id": null,
"payer": null,
"tax": null
}
],
"taxes": [
{
"name": "Federal Income Tax",
"source_amount": "1009.62",
"source_currency": "USD",
"destination_amount": "1009.62",
"destination_currency": "USD",
"hours": null,
"type": "federal_income_tax",
"provider_id": null,
"payer": "worker",
"tax": null
},
{
"name": "Employer Social Security Tax",
"source_amount": "417.31",
"source_currency": "USD",
"destination_amount": "417.31",
"destination_currency": "USD",
"hours": null,
"type": "employer_social_security",
"provider_id": null,
"payer": "company",
"tax": null
}
],
"benefits": [
{
"name": "Health insurance",
"source_amount": "250.0",
"source_currency": "USD",
"destination_amount": "250.0",
"destination_currency": "USD",
"hours": null,
"type": "section_125_medical",
"provider_id": null,
"payer": null,
"tax": "pre_tax"
}
],
"reimbursements": [
{
"name": "Internet",
"source_amount": "80.0",
"source_currency": "USD",
"destination_amount": "80.0",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
],
"deductions": [
{
"name": "401(k) Contribution",
"source_amount": "336.54",
"source_currency": "USD",
"destination_amount": "336.54",
"destination_currency": "USD",
"hours": null,
"type": "retirement",
"provider_id": null,
"payer": null,
"tax": "pre_tax"
}
]
}
]
}
Parameters
string
required
The ID of a payroll object.
string[]
By default each item’s
worker is the worker’s ID. Pass expand[]=worker to receive an object
with the worker’s id, name and type instead.Returns
Returns a payroll if a valid identifier was provided, and returns an error otherwise. The response always includesitems, one for each worker’s slice of the payroll. Each item carries its own
totals and the individual earnings, taxes, benefits, reimbursements and deductions
lines behind them. See the Payroll object for what each field means.
The example below was requested with expand[]=worker. Without it, each item’s worker is the
worker’s ID.
{
"id": "pr_244UfG",
"entity": "ent_2gHL1F",
"type": "regular",
"status": "paid",
"note": null,
"period": {
"starts": "2026-08-01",
"ends": "2026-08-31"
},
"totals": {
"earnings": {
"name": null,
"source_amount": "6730.77",
"source_currency": "USD",
"destination_amount": "6730.77",
"destination_currency": "USD",
"hours": "86.67",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"taxes": {
"company": {
"name": null,
"source_amount": "417.31",
"source_currency": "USD",
"destination_amount": "417.31",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"worker": {
"name": null,
"source_amount": "1009.62",
"source_currency": "USD",
"destination_amount": "1009.62",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"benefits": {
"name": null,
"source_amount": "250.0",
"source_currency": "USD",
"destination_amount": "250.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"reimbursements": {
"name": null,
"source_amount": "80.0",
"source_currency": "USD",
"destination_amount": "80.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"deductions": {
"name": null,
"source_amount": "336.54",
"source_currency": "USD",
"destination_amount": "336.54",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"net": {
"name": null,
"source_amount": "5464.61",
"source_currency": "USD",
"destination_amount": "5464.61",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"items": [
{
"id": "pri_YogJe",
"status": "paid",
"country": "US",
"currency": "USD",
"payday": "2026-08-31",
"type": "regular",
"payroll_id": "pr_244UfG",
"entity": "ent_2gHL1F",
"worker": {
"id": "wr_2Bj6xY",
"name": "Aaron Patel",
"type": "employee"
},
"cutoff": "2026-08-28T16:00:00-07:00",
"period": {
"starts": "2026-08-01",
"ends": "2026-08-31",
"frequency": "biweekly"
},
"totals": {
"earnings": {
"name": null,
"source_amount": "6730.77",
"source_currency": "USD",
"destination_amount": "6730.77",
"destination_currency": "USD",
"hours": "86.67",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"taxes": {
"company": {
"name": null,
"source_amount": "417.31",
"source_currency": "USD",
"destination_amount": "417.31",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"worker": {
"name": null,
"source_amount": "1009.62",
"source_currency": "USD",
"destination_amount": "1009.62",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"benefits": {
"name": null,
"source_amount": "250.0",
"source_currency": "USD",
"destination_amount": "250.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"reimbursements": {
"name": null,
"source_amount": "80.0",
"source_currency": "USD",
"destination_amount": "80.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"deductions": {
"name": null,
"source_amount": "336.54",
"source_currency": "USD",
"destination_amount": "336.54",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"net": {
"name": null,
"source_amount": "5464.61",
"source_currency": "USD",
"destination_amount": "5464.61",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"earnings": [
{
"name": "Regular",
"source_amount": "6730.77",
"source_currency": "USD",
"destination_amount": "6730.77",
"destination_currency": "USD",
"hours": "86.67",
"type": "regular",
"provider_id": null,
"payer": null,
"tax": null
}
],
"taxes": [
{
"name": "Federal Income Tax",
"source_amount": "1009.62",
"source_currency": "USD",
"destination_amount": "1009.62",
"destination_currency": "USD",
"hours": null,
"type": "federal_income_tax",
"provider_id": null,
"payer": "worker",
"tax": null
},
{
"name": "Employer Social Security Tax",
"source_amount": "417.31",
"source_currency": "USD",
"destination_amount": "417.31",
"destination_currency": "USD",
"hours": null,
"type": "employer_social_security",
"provider_id": null,
"payer": "company",
"tax": null
}
],
"benefits": [
{
"name": "Health insurance",
"source_amount": "250.0",
"source_currency": "USD",
"destination_amount": "250.0",
"destination_currency": "USD",
"hours": null,
"type": "section_125_medical",
"provider_id": null,
"payer": null,
"tax": "pre_tax"
}
],
"reimbursements": [
{
"name": "Internet",
"source_amount": "80.0",
"source_currency": "USD",
"destination_amount": "80.0",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
],
"deductions": [
{
"name": "401(k) Contribution",
"source_amount": "336.54",
"source_currency": "USD",
"destination_amount": "336.54",
"destination_currency": "USD",
"hours": null,
"type": "retirement",
"provider_id": null,
"payer": null,
"tax": "pre_tax"
}
]
}
]
}
Was this page helpful?
⌘I