Skip to main content
POST
/
vLatest
/
query
/
glasscore
/
payment
Query Payment
curl --request POST \
  --url https://api.glass.fm/vLatest/query/glasscore/payment \
  --header 'Content-Type: application/json' \
  --data '{
  "advancedFilter": {
    "linkOperator": "AND",
    "items": [
      {
        "columnField": "nameFirst",
        "operatorValue": "contains",
        "value": "John"
      }
    ]
  },
  "return": [
    "id",
    "firstName",
    "lastName"
  ],
  "isAdditionalData": false,
  "page": 1,
  "pageSize": 20,
  "sortBy": "createdAt",
  "sortDirection": "desc"
}'
{
  "amountToPay": 123,
  "id": 123,
  "InvoiceId": "<string>",
  "OrgId": 123,
  "PersonId": 123,
  "resptext": "<string>",
  "transaction_id": "<string>"
}

Body

application/json

Multiple query options are supported. You can build a complex query filling out the advancedFilter section. We also support "simple" queries which used by putting the key you want to filter by in the query section along with the value you want it to filter for. E.g., nameFirst=John will return all persons with a first name of John.

​
advancedFilter
object

Complex filter configuration allowing for multiple conditions with AND/OR operators.

​
return
string[]

Array of field names to return in the response.

Example:
["id", "firstName", "lastName"]
​
isAdditionalData
boolean
default:false

Set to true to merge requested fields with default response, or false/omit to return only requested fields plus ID.

​
page
number
default:1

Page number for pagination.

Example:

1

​
pageSize
number
default:500

Number of items per page. Defaults to 500.

Example:

20

​
sortBy
string

Field name to sort by.

Example:

"createdAt"

​
sortDirection
enum<string>
default:desc

Sort direction: ascending (asc) or descending (desc).

Available options:
asc,
desc
Example:

"desc"

​
{key}
string

Additional key-value pairs for simple filtering. Any field from the entity can be used as a filter key. E.g., field=value will return all records where that field matches the specified value.

Example:

"status=active"

Response

200 - application/json

A list of Payments

​
amountToPay
number
required

Represents the total sum of money that is due for a particular payment.

​
id
number
required

Unique identifier.

​
InvoiceId
string
required

Unique identifier for a specific invoice related to a payment.

​
OrgId
number | null
required

Represents the unique identifier for the organization associated with a specific payment.

​
PersonId
number
required

Unique identifier for an individual associated with a specific payment.

​
resptext
string
required

Contains the response message from the payment gateway regarding the transaction status.

​
transaction_id
string
required

Unique identifier for each payment made.