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

Create owner charges by listing

Changed on

Create an owner charge for the provided listing. This will apply to all owners unless you include a given ownerId.

post/business-models-api/transactions/owner-charges-by-listing

Request

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

Request body

namestring required

Charge name. Max length is 255 characters

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

Charge description. Max length is 255 characters

amountnumber required

Charge amount, account currency will be used

recognitionDatestring required

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

ownerIdstring required

You can get your owner ID here

listingIdstring

You can get your listing 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": "Furniture repairment",
  "categoryId": "123e4567-e89b-12d3-a456-426614174000",
  "description": "Furniture repair",
  "amount": 100,
  "recognitionDate": "2023-10-27",
  "ownerId": "67166b458d730bb789c969e1",
  "listingId": "67166b51607b95e9450d9c30",
  "revenueShare": {
    "shareSplit": 0.5,
    "vendorId": "67166b458d730bb789c969e1"
  },
  "vatOCConfig": {
    "name": "VAT",
    "description": "VAT",
    "percent": 0.01,
    "categoryCode": "vat",
    "categoryId": "789e3210-1234-5678-90ab-cdef12345678",
    "categoryName": "VAT"
  },
  "referenceId": "REF-12345",
  "attachments": [
    {
      "url": "https://cdn.filepicker.io/api/file/bBnKEk8TlmJAUHcLApRx",
      "urlThumbnail": "https://cdn.filepicker.io/api/file/bBnKEk8TlmJAUHcLApRx",
      "extension": "png",
      "fileName": "Invoice copy"
    }
  ]
}

Response

Owner charges by listing created

Changes

  • 3122b8618183Revision changes
    • info

      added the new optional request property //

    • info

      added the non-success response with the status