API Reference

Get all journal entries

get
https://open-api.guesty.com/v1/accounting-api/journal-entries/all

Retrieves all journal entries matching the specified parameters

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
transactionDate
object
required

DO NOT use the format provided in the coding playground output. Fields in this query param must be transformed according to the rules explained below. For example, in order to fetch the information for past 7 days:

  1. Form your object first
{
  "operator": "@in_past_days",
  "value": 7
}
  1. Then encode it to sanitized URL (see the code example written in JS below)
encodeURIComponent(JSON.stringify({"operator": "@in_past_days", "value": 7}))
  1. The final query param structure should be looked like
transactionDate=%7B%22operator%22%3A%22%40in_past_days%22%2C%22value%22%3A7%7D
string

Filter list by journal entries name, it will search by matching strings from filter input

string

Filter list by journal entries description, it will search by matching strings from filter input

reservationConfirmationCodes
array of strings

Filter by reservation confirmation codes

reservationConfirmationCodes
ledger
array of strings

Filter by ledger type. Available ledgers:

  • AD (Advanced deposit)
  • AP (Accounts payable)
  • C (Cash)
  • O (Owners)
  • WC (Working capital)
ledger
guests
array of strings

Show journal entries for selected guests ID

guests
vendors
array of strings

Show journal entries for selected vendors ID

vendors
owners
array of strings

Show journal entries for selected owners ID

owners
listings
array of strings

Show journal entries for selected listings ID

listings
chargeCode
array of strings

Show journal entries for selected transaction codes

chargeCode
triggers
array of strings

Show journal entries for selected triggers. Available triggers:

  • PAYMENT
  • MANUAL
  • PERIODIC
  • RESERVATION_CANCELLED
  • RESERVATION_CREATED
  • RESERVATION_UPDATED
  • DISBURSEMENT
  • RECONCILIATION_CASH_ADJUSTMENT
triggers
number
≥ 0

Pagination skip value

number
0 to 100

Pagination limit value

string
enum

Sort by date. For ascending order use 'ASC' value, for descending - 'DESC'

Allowed:
string

Filter by recognition status of the transaction

Responses

Updated 3 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago