Get Payment Items

GET

payment-items

Get Payment Items

curl --request GET \
  --url https://api.zeal.com/payment-items \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.zeal.com/payment-items', 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.zeal.com/payment-items",
  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: <api-key>"
  ],
]);

$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.zeal.com/payment-items"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.zeal.com/payment-items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "testMode": false,
  "data": {
    "paymentItemID": "0083fb3bae9d4915adc133c6d6548f89",
    "companyID": "fc235f012bae46aa8a082f357715bcfa",
    "contractorID": "669fe6216d9eff8ca4c9f0de",
    "contractorPaymentID": "68ffb95239326ca8713eadb1",
    "work_info": {
      "work_description": "Construction development work",
      "service_date": "2025-10-15T00:00:00.000Z"
    },
    "earning_type": "hourly",
    "category": "regular",
    "quantity": 25,
    "rate": 100,
    "rate_unit": "hour",
    "bill_rate": 175,
    "metadata": {
      "jobID": "19834673",
      "description": "Piecework pay"
    }
  }
}

This endpoint serves two usages on the same path. Pass paymentItemID to retrieve a single Payment Item. Omit paymentItemID to list payment items; you can optionally pass contractorID, contractorPaymentID, or serviceTypeID to filter that list. When paymentItemID is present, list filters (contractorID, contractorPaymentID, serviceTypeID) and pagination parameters are ignored. Listing responses include meta with next, previous, and totalCount.

Authorizations

Authorization

string

header

required

Query Parameters

paymentItemID

string

ID of the payment item to retrieve. When present, the endpoint returns that single payment item and list filters are ignored.

contractorID

string

When listing payment items (omit paymentItemID), filter to this contractor. Ignored when paymentItemID is present.

contractorPaymentID

string

When listing payment items (omit paymentItemID), filter to this contractor payment. Ignored when paymentItemID is present.

serviceTypeID

string

When listing payment items (omit paymentItemID), filter to items whose work_info.serviceTypeID matches this value. Ignored when paymentItemID is present.

limit

number

Number of payment items returned per page. Minimum 1, maximum 100. Defaults to 25. Ignored when paymentItemID is present.

Required range: 1 <= x <= 100

start_at

string

The pagination cursor to start at. Ignored when paymentItemID is present.

sort_by

string

Field to sort by when listing. Defaults to _id. Ignored when paymentItemID is present.

sort_direction

enum<string>

Sort direction when listing. Defaults to desc. Ignored when paymentItemID is present.

Available options:

asc,

desc

Response

200

success

boolean

testMode

boolean

data

any

A Payment Item object, or an array of Payment Item objects when listing

meta

object

Present when listing (paymentItemID omitted). Contains next, previous, and totalCount.

Get Payment Items

curl --request GET \
  --url https://api.zeal.com/payment-items \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.zeal.com/payment-items', 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.zeal.com/payment-items",
  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: <api-key>"
  ],
]);

$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.zeal.com/payment-items"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.zeal.com/payment-items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "testMode": false,
  "data": {
    "paymentItemID": "0083fb3bae9d4915adc133c6d6548f89",
    "companyID": "fc235f012bae46aa8a082f357715bcfa",
    "contractorID": "669fe6216d9eff8ca4c9f0de",
    "contractorPaymentID": "68ffb95239326ca8713eadb1",
    "work_info": {
      "work_description": "Construction development work",
      "service_date": "2025-10-15T00:00:00.000Z"
    },
    "earning_type": "hourly",
    "category": "regular",
    "quantity": 25,
    "rate": 100,
    "rate_unit": "hour",
    "bill_rate": 175,
    "metadata": {
      "jobID": "19834673",
      "description": "Piecework pay"
    }
  }
}

Introduction

Webhooks

Zeal Components

Companies

Company Onboarding

Reserve Accounts

Customer Accounts (Early Access)

Taxable Locations

Work Locations

Employees

Employee Deduction Templates

Employee Onboarding

Bank Accounts

Custom Attributes

Paperwork API

Employee Checks

Contractors

Contractor Onboarding

Contractor Payment Deductions

Payment Items

Contractor Payments

Paycards

Instant Pay

Employer Checks

Preview

Embedded HR

Reports

Documents

Authorizations

Query Parameters

Response