Create expense

post

https://open-api.guesty.com/v1/expenses-api/expenses

Creates a new manual expense.

Validates the expense date against the lock period and rejects creation if the date is locked.

Required fields: name, expenseDate, categoryId, chargeableAmount, currency, paymentShareAmountType, revenueShareAmountType, shares, and shareOption. Either owners or listingIds must be provided (mutually exclusive).

Type (owner_charge or pmc_expense) is optional. If omitted, it is derived from the shares array: PMC_EXPENSE when PMC pays (or both PMC and Owner pay), OWNER_CHARGE when only Owner pays. If provided, it must match the calculated type from shares.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

type

string

enum

Expense type. If not provided, will be automatically calculated from shares array. If provided, must match the calculated type from shares.

Allowed:

name

string

required

length ≤ 255

expenseDate

string

required

Date of the expense in ISO 8601 format (YYYY-MM-DD)

categoryId

string

required

description

string

length ≤ 255

chargeableAmount

number

required

currency

string

required

length ≤ 3

paymentShareAmountType

string

enum

required

Allowed:

revenueShareAmountType

string

enum

required

Allowed:

taxCategoryCode

string

enum

Legacy; prefer taxCategoryId when specifying tax category.

Allowed:

taxCategoryId

string

taxName

string

length ≤ 255

taxDescription

string

length ≤ 255

taxAmountType

string

enum

Allowed:

taxAmount

number

0 to 1

Tax amount as a decimal between 0 and 1 (e.g., 0.2 for 20%)

taxPayeeTypes

array of strings

Business entity types that pay the tax (e.g., ["OWNER"], ["OWNER", "PMC"])

isPmcAsVendor

boolean

vendorId

string

reservationId

string

externalRefId

string

length ≤ 255

A unique identifier that serves as a reference to an external object. This ID can be used to link the current resource to a related entity in another system

owners

array of objects

Required when listingIds property is not in use. Can only be provided when OWNER has a payment share in the shares array.

owners

listingIds

array of strings

Required when owners property is not in use. Each item must be a valid MongoDB ObjectId.

listingIds

array of objects

required

shares*

shareOption

string

enum

required

Allowed:

attachments

array of objects

Array of expense attachments

attachments

Responses

201Created expense(s) wrapped in a data array

400Invalid input data - validation errors in request body

401Authentication required - invalid or missing token

403You do not have sufficient permissions to access this resource

500Unhandled exception. Something went wrong on server