Skip to content
/
List Payments

List Payments

Request

Security
x-api-key and a-api-key
Query
pageinteger, >= 1
Example:page=1
page_sizeinteger, [ 1 .. 200 ]
Example:page_size=50
sort_byArray of strings

Comma separated search fields. See Sorting

Example:sort_by=["payment_id"]
q[]Array of strings

Filter result by one or more fields.

See Query Filtering

Available filters:

ValueFormat
totaldouble
unallocateddouble
invoice_item_idinteger
createdtimestamp
updatedtimestamp
payment_timetimestamp
curl -i -X GET \
  'https://api.pracsuite.com/v1/payment?page=1&page_size=50&sort_by=%5B%22field_name%22%2C%22field_name%22%5D&q%5B%5D=string' \
  -H 'a-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful

Bodyapplication/json
paymentsArray of objects(Payment)
total_entriesinteger
Response
{
  "payments": [
    { … }
  ],
  "total_entries": 0,
  "links": {
    "self": "https://api.pracsuite.com/v1/payment?page=2",
    "previous": "https://api.pracsuite.com/v1/payment?page=1",
    "next": "https://api.pracsuite.com/v1/payment?page=3"
  }
}