Update payment allocation

PUT

/api/payments/{id}/allocations/{allocationId}

curl --request PUT \
  --url https://api.getvespy.com/api/payments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/allocations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "amountCents": 1 }'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

allocationId

required

string format: uuid

Request Body^required

Media typeapplication/json

object

amountCents

required

integer

>= 1

Example^generated

{
  "amountCents": 1
}

Responses

200

Default Response

Media typeapplication/json

object

payment

required

object

allocations

required

Array<object>

object

amountCents

required

integer

>= 1

charge

required

object

amountCents

required

integer

>= 1

balanceCents

required

integer

chargeType

required

string

Allowed values: rent fee deposit adjustment other

dueDate

required

string format: date

id

required

string format: uuid

name

required

string

nullable <= 160 characters

status

required

string

Allowed values: pending posted paid void

chargeId

required

string format: uuid

id

required

string format: uuid

paymentId

required

string format: uuid

paymentReceivedAt

required

string format: date-time

amountCents

required

integer

>= 1

checkNumber

required

string

nullable >= 1 characters <= 64 characters

createdAt

required

string format: date-time

id

required

string format: uuid

idempotencyKey

required

string

nullable

lease

required

object

endDate

required

string format: date

nullable

id

required

string format: uuid

startDate

required

string format: date

status

required

string

Allowed values: draft active ended terminated

leaseId

required

string format: uuid

nullable

organizationId

required

string format: uuid

paymentMethod

required

string

Allowed values: ach card cash check other

property

required

object

city

required

string

>= 1 characters <= 120 characters

id

required

string format: uuid

name

required

string

>= 1 characters <= 160 characters

state

required

string

>= 2 characters <= 2 characters

receivedAt

required

string format: date-time

status

required

string

Allowed values: received pending failed reversed

tenant

required

object

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

tenantId

required

string format: uuid

nullable

unallocatedCents

required

integer

unit

required

object

id

required

string format: uuid

unitNumber

required

string

nullable >= 1 characters <= 32 characters

Example

{
  "payment": {
    "allocations": [
      {
        "charge": {
          "chargeType": "rent",
          "status": "pending"
        }
      }
    ],
    "lease": {
      "status": "draft"
    },
    "paymentMethod": "ach",
    "status": "received"
  }
}

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