Create owner payable

POST

/api/trust/owner-payables

curl --request POST \
  --url https://api.getvespy.com/api/trust/owner-payables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "amountCents": 1, "description": "example", "ownerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "propertyId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

• Production
• Development
• Local

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

amountCents

required

integer

>= 1

description

string

<= 500 characters

ownerId

required

string format: uuid

propertyId

string format: uuid

Example^generated

{
  "amountCents": 1,
  "description": "example",
  "ownerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "propertyId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

201

Default Response

Media typeapplication/json

object

ownerPayable

required

object

amountCents

required

integer

>= 1

createdAt

required

string format: date-time

description

required

string

nullable

id

required

string format: uuid

organizationId

required

string format: uuid

ownerId

required

string format: uuid

paidAt

required

string format: date-time

nullable

propertyId

required

string format: uuid

nullable

status

required

string

Allowed values: pending paid voided

updatedAt

required

string format: date-time

Example

{
  "ownerPayable": {
    "status": "pending"
  }
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

404

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}