Record security deposit disposition

POST

/api/trust/deposits/{id}/dispositions

curl --request POST \
  --url https://api.getvespy.com/api/trust/deposits/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/dispositions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "amountCents": 1, "documentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "lineItems": [ { "amountCents": 1, "description": "example" } ], "reason": "example", "type": "deduction" }'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

amountCents

required

integer

>= 1

documentId

string format: uuid

lineItems

Array<object>

object

amountCents

required

integer

>= 1

description

required

string

>= 1 characters <= 500 characters

reason

required

string

>= 1 characters <= 2000 characters

type

required

string

Allowed values: deduction refund

Responses

201

Default Response

Media typeapplication/json

object

disposition

required

object

amountCents

required

integer

>= 1

createdAt

required

string format: date-time

createdByUserId

required

string format: uuid

nullable

documentId

required

string format: uuid

nullable

id

required

string format: uuid

reason

required

string

>= 1 characters <= 2000 characters

securityDepositId

required

string format: uuid

type

required

string

Allowed values: deduction refund

securityDeposit

required

object

amountCents

required

integer

>= 1

bankAccountId

required

string format: uuid

nullable

createdAt

required

string format: date-time

id

required

string format: uuid

isOverdue

required

boolean

leaseId

required

string format: uuid

nullable

organizationId

required

string format: uuid

propertyState

required

string

nullable

receivedAt

required

string format: date-time

returnDeadline

required

string format: date-time

nullable

returnDeadlineDays

required

integer

nullable

returnedAt

required

string format: date-time

nullable

status

required

string

Allowed values: held partially_returned returned forfeited

tenantId

required

string format: uuid

nullable

updatedAt

required

string format: date-time

Example

{
  "disposition": {
    "type": "deduction"
  },
  "securityDeposit": {
    "status": "held"
  }
}

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"
}

409

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"
}