Allocate expense payment to expenses

POST

/api/expense-payments/{id}/allocate

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

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

allocations

required

Array<object>

>= 1 items

object

amountCents

required

integer

>= 1

expenseId

required

string format: uuid

Example^generated

{
  "allocations": [
    {
      "amountCents": 1,
      "expenseId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ]
}

Responses

200

Default Response

Media typeapplication/json

object

expensePayment

required

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

Example

{
  "expensePayment": {
    "allocations": [
      {
        "expense": {
          "category": "maintenance",
          "status": "active"
        }
      }
    ],
    "paymentMethod": "ach",
    "status": "issued"
  }
}

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