Payment Requests
Get a payment request
Working with the API
Workers
- Workers
- Employments
- Compensations
- Classifications
- Locations
- Roles
- Reportings
Payments
- Payments
- Payment Requests
- Charges
- Refunds
- Sources
Payroll
- Payroll
- Payroll Changes
Documents
- Documents
- Contracts
Time Tracking
- Time Entries
Payment Requests
Get a payment request
Retrieve the details of an existing payment request.
GET
/
payment-requests
/
{id}
curl --request GET \
--url https://api.plane.com/v1/payment-requests/{id} \
--header 'Authorization: Bearer <token>'
{
"id": "ptr_ogdEjSnSqNYxtW1sd3pC3hFX",
"worker": "wr_anqRSFcK36ie85",
"amount": "1200.00",
"currency": "EUR",
"status": "pending",
"reference": "EV1S3GDM",
"note": "Payment for July",
"period": {
"starts": "2023-07-01",
"ends": "2023-07-31"
},
"documents": [],
"approvals": [],
"payment": null
}
Parameters
The ID of a payment request object.
Returns
Return the Payment Request object.
{
"id": "ptr_ogdEjSnSqNYxtW1sd3pC3hFX",
"worker": "wr_anqRSFcK36ie85",
"amount": "1200.00",
"currency": "EUR",
"status": "pending",
"reference": "EV1S3GDM",
"note": "Payment for July",
"period": {
"starts": "2023-07-01",
"ends": "2023-07-31"
},
"documents": [],
"approvals": [],
"payment": null
}
Was this page helpful?
curl --request GET \
--url https://api.plane.com/v1/payment-requests/{id} \
--header 'Authorization: Bearer <token>'
{
"id": "ptr_ogdEjSnSqNYxtW1sd3pC3hFX",
"worker": "wr_anqRSFcK36ie85",
"amount": "1200.00",
"currency": "EUR",
"status": "pending",
"reference": "EV1S3GDM",
"note": "Payment for July",
"period": {
"starts": "2023-07-01",
"ends": "2023-07-31"
},
"documents": [],
"approvals": [],
"payment": null
}