Skip to content
Vespy API

List expense payments

GET
/api/expense-payments
curl --request GET \
  --url 'https://api.getvespy.com/api/expense-payments?status=issued&sortBy=paidAt&sortDirection=asc&page=1&pageSize=20' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
search
string
>= 1 characters <= 100 characters
vendorId
string format: uuid
expenseId
string format: uuid
status
string
Allowed values: issued pending failed voided
paidAfter
string format: date
paidBefore
string format: date
createdAfter
string format: date
createdBefore
string format: date
sortBy
string
Allowed values: paidAt vendorName amountCents paymentMethod status createdAt
sortDirection
string
Allowed values: asc desc
page
integer
default: 1 >= 1
pageSize
integer
default: 20 >= 1 <= 100

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
expensePayments
required
Array<object>
object
allocatedCents
required
integer
allocations
required
Array<object>
object
amountCents
required
integer
>= 1
expense
required
object
amountCents
required
integer
>= 1
category
required
string
Allowed values: maintenance utility tax insurance management other
description
required
string
nullable
id
required
string format: uuid
incurredOn
required
string format: date
name
required
string
nullable <= 160 characters
outstandingCents
required
integer
status
required
string
Allowed values: active voided
vendorName
required
string
nullable
expenseId
required
string format: uuid
expensePaymentId
required
string format: uuid
id
required
string format: uuid
amountCents
required
integer
>= 1
createdAt
required
string format: date-time
currency
required
string
id
required
string format: uuid
memo
required
string
nullable
organizationId
required
string format: uuid
paidAt
required
string format: date-time
paymentMethod
required
string
Allowed values: ach card cash check other
referenceNumber
required
string
nullable
status
required
string
Allowed values: issued pending failed voided
unallocatedCents
required
integer
vendor
required
object
id
required
string format: uuid
name
required
string
>= 1 characters <= 160 characters
vendorId
required
string format: uuid
nullable
page
required
integer
>= 1
pageSize
required
integer
>= 1 <= 100
total
required
integer
totalPages
required
integer
>= 1
Example
{
  "expensePayments": [
    {
      "allocations": [
        {
          "expense": {
            "category": "maintenance",
            "status": "active"
          }
        }
      ],
      "paymentMethod": "ach",
      "status": "issued"
    }
  ]
}

400

Section titled “400”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}