List payrolls

List payrolls

curl --request GET \
  --url https://api.plane.com/v1/payrolls \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.plane.com/v1/payrolls"

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', 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",
  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"

	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")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.plane.com/v1/payrolls")

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

{
  "payrolls": [
    {
      "id": "pr_abc123def456",
      "type": "contractor",
      "status": "processed",
      "note": null,
      "period": {
        "starts": "2024-01-01",
        "ends": "2024-01-15"
      },
      "totals": {
        "amount": "25000.00",
        "currency": "USD"
      },
      "items": [
        {
          "worker": "wr_xyz789",
          "amount": "5000.00",
          "currency": "USD"
        }
      ]
    },
    {...},
    {...}
  ]
}

GET

payrolls

List payrolls

curl --request GET \
  --url https://api.plane.com/v1/payrolls \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.plane.com/v1/payrolls"

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', 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",
  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"

	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")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.plane.com/v1/payrolls")

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

{
  "payrolls": [
    {
      "id": "pr_abc123def456",
      "type": "contractor",
      "status": "processed",
      "note": null,
      "period": {
        "starts": "2024-01-01",
        "ends": "2024-01-15"
      },
      "totals": {
        "amount": "25000.00",
        "currency": "USD"
      },
      "items": [
        {
          "worker": "wr_xyz789",
          "amount": "5000.00",
          "currency": "USD"
        }
      ]
    },
    {...},
    {...}
  ]
}

Parameters

number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

string

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with pr_foo, your subsequent call can include starting_after=pr_foo in order to fetch the next page of the list.

string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with pr_bar, your subsequent call can include ending_before=pr_bar in order to fetch the previous page of the list.

Returns

A dictionary with a payrolls property that contains an array of up to limit payrolls, starting after payroll starting_after. Each entry in the array is a separate payroll object. If no more payrolls are available, the resulting array will be empty.

{
  "payrolls": [
    {
      "id": "pr_abc123def456",
      "type": "contractor",
      "status": "processed",
      "note": null,
      "period": {
        "starts": "2024-01-01",
        "ends": "2024-01-15"
      },
      "totals": {
        "amount": "25000.00",
        "currency": "USD"
      },
      "items": [
        {
          "worker": "wr_xyz789",
          "amount": "5000.00",
          "currency": "USD"
        }
      ]
    },
    {...},
    {...}
  ]
}

Payroll

Get a payroll

⌘I

Working with the API

Core Resources

HR

Workforce

Benefits

Payments

Payroll

Documents

Time

Labor

Legal

Parameters

Returns

​Parameters

​Returns

Parameters

Returns