Payment Items
Create Payment Item
Add a payment item line to a pending contractor payment.
POST
/
payment-items
Create Payment Item
curl --request POST \
--url https://api.zeal.com/payment-items \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "<string>",
"contractorID": "<string>",
"contractorPaymentID": "<string>",
"work_info": {
"work_description": "<string>",
"service_date": "<string>"
},
"quantity": 123,
"rate": 123,
"bill_rate": 123,
"gross_amount": 123,
"bill_amount": 123
}
'import requests
url = "https://api.zeal.com/payment-items"
payload = {
"companyID": "<string>",
"contractorID": "<string>",
"contractorPaymentID": "<string>",
"work_info": {
"work_description": "<string>",
"service_date": "<string>"
},
"quantity": 123,
"rate": 123,
"bill_rate": 123,
"gross_amount": 123,
"bill_amount": 123
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyID: '<string>',
contractorID: '<string>',
contractorPaymentID: '<string>',
work_info: {work_description: '<string>', service_date: '<string>'},
quantity: 123,
rate: 123,
bill_rate: 123,
gross_amount: 123,
bill_amount: 123
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companyID' => '<string>',
'contractorID' => '<string>',
'contractorPaymentID' => '<string>',
'work_info' => [
'work_description' => '<string>',
'service_date' => '<string>'
],
'quantity' => 123,
'rate' => 123,
'bill_rate' => 123,
'gross_amount' => 123,
'bill_amount' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/payment-items"
payload := strings.NewReader("{\n \"companyID\": \"<string>\",\n \"contractorID\": \"<string>\",\n \"contractorPaymentID\": \"<string>\",\n \"work_info\": {\n \"work_description\": \"<string>\",\n \"service_date\": \"<string>\"\n },\n \"quantity\": 123,\n \"rate\": 123,\n \"bill_rate\": 123,\n \"gross_amount\": 123,\n \"bill_amount\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zeal.com/payment-items")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"<string>\",\n \"contractorID\": \"<string>\",\n \"contractorPaymentID\": \"<string>\",\n \"work_info\": {\n \"work_description\": \"<string>\",\n \"service_date\": \"<string>\"\n },\n \"quantity\": 123,\n \"rate\": 123,\n \"bill_rate\": 123,\n \"gross_amount\": 123,\n \"bill_amount\": 123\n}")
.asString();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::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyID\": \"<string>\",\n \"contractorID\": \"<string>\",\n \"contractorPaymentID\": \"<string>\",\n \"work_info\": {\n \"work_description\": \"<string>\",\n \"service_date\": \"<string>\"\n },\n \"quantity\": 123,\n \"rate\": 123,\n \"bill_rate\": 123,\n \"gross_amount\": 123,\n \"bill_amount\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"paymentItemID": "0083fb3bae9d4915adc133c6d6548f89",
"companyID": "fc235f012bae46aa8a082f357715bcfa",
"contractorID": "669fe6216d9eff8ca4c9f0de",
"contractorPaymentID": "68ffb95239326ca8713eadb1",
"work_info": {
"work_description": "Construction development work",
"service_date": "2025-10-15T00:00:00.000Z"
},
"payment_type": "hourly",
"quantity": 25,
"rate": 100,
"bill_rate": 175
},
"testMode": false
}Creates a new Payment Item and adds it to a contractor payment. Payment items can only be added to a contractor payment with the status pending.
Authorizations
Body
application/json
ID of company
ID of contractor
ID of contractor payment that this payment item will be added to
Show child attributes
Show child attributes
Available options:
hourly, per_unit, flat_fee, expense_reimbursement, bonus Only required if earning_type is hourly or per_unit
Only applicable if earning_type is hourly or per_unit
Only applicable if earning_type is hourly or per_unit
Only applicable if earning_type is flat_fee, expense_reimbursement, or bonus
Only applicable if earning_type is flat_fee, expense_reimbursement, or bonus
⌘I
Create Payment Item
curl --request POST \
--url https://api.zeal.com/payment-items \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "<string>",
"contractorID": "<string>",
"contractorPaymentID": "<string>",
"work_info": {
"work_description": "<string>",
"service_date": "<string>"
},
"quantity": 123,
"rate": 123,
"bill_rate": 123,
"gross_amount": 123,
"bill_amount": 123
}
'import requests
url = "https://api.zeal.com/payment-items"
payload = {
"companyID": "<string>",
"contractorID": "<string>",
"contractorPaymentID": "<string>",
"work_info": {
"work_description": "<string>",
"service_date": "<string>"
},
"quantity": 123,
"rate": 123,
"bill_rate": 123,
"gross_amount": 123,
"bill_amount": 123
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyID: '<string>',
contractorID: '<string>',
contractorPaymentID: '<string>',
work_info: {work_description: '<string>', service_date: '<string>'},
quantity: 123,
rate: 123,
bill_rate: 123,
gross_amount: 123,
bill_amount: 123
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companyID' => '<string>',
'contractorID' => '<string>',
'contractorPaymentID' => '<string>',
'work_info' => [
'work_description' => '<string>',
'service_date' => '<string>'
],
'quantity' => 123,
'rate' => 123,
'bill_rate' => 123,
'gross_amount' => 123,
'bill_amount' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/payment-items"
payload := strings.NewReader("{\n \"companyID\": \"<string>\",\n \"contractorID\": \"<string>\",\n \"contractorPaymentID\": \"<string>\",\n \"work_info\": {\n \"work_description\": \"<string>\",\n \"service_date\": \"<string>\"\n },\n \"quantity\": 123,\n \"rate\": 123,\n \"bill_rate\": 123,\n \"gross_amount\": 123,\n \"bill_amount\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zeal.com/payment-items")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"<string>\",\n \"contractorID\": \"<string>\",\n \"contractorPaymentID\": \"<string>\",\n \"work_info\": {\n \"work_description\": \"<string>\",\n \"service_date\": \"<string>\"\n },\n \"quantity\": 123,\n \"rate\": 123,\n \"bill_rate\": 123,\n \"gross_amount\": 123,\n \"bill_amount\": 123\n}")
.asString();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::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyID\": \"<string>\",\n \"contractorID\": \"<string>\",\n \"contractorPaymentID\": \"<string>\",\n \"work_info\": {\n \"work_description\": \"<string>\",\n \"service_date\": \"<string>\"\n },\n \"quantity\": 123,\n \"rate\": 123,\n \"bill_rate\": 123,\n \"gross_amount\": 123,\n \"bill_amount\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"paymentItemID": "0083fb3bae9d4915adc133c6d6548f89",
"companyID": "fc235f012bae46aa8a082f357715bcfa",
"contractorID": "669fe6216d9eff8ca4c9f0de",
"contractorPaymentID": "68ffb95239326ca8713eadb1",
"work_info": {
"work_description": "Construction development work",
"service_date": "2025-10-15T00:00:00.000Z"
},
"payment_type": "hourly",
"quantity": 25,
"rate": 100,
"bill_rate": 175
},
"testMode": false
}