GUguesty
Accounting (only available for accounting add-on users)

Create expense by listing

Changed on

Create a PMC expense for the provided listing (PMC pays the vendor). By default, 100% of the expense is applied to the PMC. If you provide expenseShare, the expense is split between PMC and Owner: when ownerId is provided, the owner share is charged to that specific owner; when ownerId is omitted, the owner share is distributed across all owners of the listing.

post/business-models-api/transactions/expenses-by-listing

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/business-models-api/transactions/expenses-by-listing
  • Auth
    API key in header authorization

Request body

namestring required

Expense name

category'advertising' | 'cleaning' | 'damage_waiver' | 'electricity' | 'furniture_appliances' | 'gas' | 'internet' | 'lock_automation' | 'management' | 'mortgage' | 'pest_control' | 'pool_cleaning' | 'property_taxes' | 'repairs_maintenance' | 'supplies_purchases' | 'other_misc' | 'taxes_paid' | 'telephone' | 'television' | 'trash' | 'water_septic' | 'guest_cleaning' | 'owner_cleaning' | 'channel_commission' | 'payment_charge' | 'pet_fee' | 'startup_fee' | 'fotoshoot' | 'vat' | 'gst' | 'insurance' | 'monitoring_surveillance' | 'garden_maintenance' | 'jacuzzi_maintenance' | 'sauna_maintenance' | 'photoshoot' | 'bank_fees' | 'sta_licensing' | 'security' | 'laundry' | 'listing_fee' | 'gardening' | 'guest_compensation' | 'home_improvement' | 'other_expenses' | 'other_income' | 'other_services_ops_assistants' | 'painting' | 'plumbing' | 'refund' | 'refund_security_deposit' | 'rubbish_removal_service' | 'set_up_fee' | 'strata_rates' | 'security_deposit'

Charge category

categoryIdstring

You can get your Category ID here

descriptionstring required

Expense description. Max length is 255 characters

amountnumber required

Expense amount, account currency will be used

recognitionDatestring required

Expense recognition date in the account timezone. ISO 8601 Date format (year-month-day)

vendorIdstring required

You can get your vendor ID here

referenceIdstring

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

Example request

{
  "name": "Maintenance expense",
  "categoryId": "123e4567-e89b-12d3-a456-426614174000",
  "description": "Bulb replacement",
  "amount": 5,
  "recognitionDate": "2023-10-27",
  "vendorId": "5f4f6e1c1c6e4e001f7e8b4e",
  "referenceId": "REF-12345",
  "expenseShare": {
    "shareSplit": 0.5,
    "ownerId": "67166b173907ef3b9bf25fb3",
    "listingId": "507f191e810c19729de860ea"
  },
  "attachments": [
    {
      "url": "https://cdn.filepicker.io/api/file/bBnKEk8TlmJAUHcLApRx",
      "urlThumbnail": "https://cdn.filepicker.io/api/file/bBnKEk8TlmJAUHcLApRx",
      "extension": "png",
      "fileName": "Invoice copy"
    }
  ]
}

Response

Expense created

Changes