Skip to content

Get journal entry
Alpha

Request

Get a single journal entry by its ID. Returns the postings, references, and supporting documents required to sync the entry to an external accounting integration.

Security
OAuth2(Required scopes: accounting.read)
Path
journalEntryIdstringrequired

The unique identifier of the journal entry.

GET
/v1/accounting-journal-entries/{journalEntryId}
curl -i -X GET \
  'https://api.understory.io/v1/accounting-journal-entries/{journalEntryId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
documentsArray of objects(Document)required

Supporting documents (e.g. customer receipts) referenced by URL.

idstringrequired

The unique identifier of the journal entry.

kindstringrequired

The kind of journal entry. Drives the bookkeeping treatment in the external accounting system, and discriminates the variant.

The kind also decides whether the entry's posting amounts include VAT — see amount on a posting.

Value:"SALE"
Discriminator
occurred_atstring, (date-time)required

Timestamp of when the underlying business event occurred. Drives which accounting period this entry is booked into.

order_idsArray of stringsrequired

The orders this journal entry derives from. A single order for most kinds; several for REVENUE_RECOGNITION entries that aggregate an event's bookings into one entry.

postingsArray of any(Posting)required

The postings that make up the entry. Sum of debits equals sum of credits.

transaction_idstringrequired

The payment transaction that produced this sale.

originstring

The system that processed the transaction that produced this journal entry

  • UNDERSTORY_PAY - Understory's own payment offering.
  • STRIPE - Stripe.
  • PAYPAL - PayPal.
  • QUICKPAY - QuickPay.
  • GIFTCARD - payment redeemed against a gift card balance.
  • PUNCHCARD - payment redeemed against a punch card balance.
  • EXTERNAL - payment was received in another system and marked as paid within Understory.
Enum:"UNDERSTORY_PAY""STRIPE""PAYPAL""QUICKPAY""GIFTCARD""PUNCHCARD""EXTERNAL"
Response
{
  "id": "string",
  "kind": "SALE",
  "order_ids": [
    "string"
  ],
  "origin": "UNDERSTORY_PAY",
  "occurred_at": "2019-08-24T14:15:22Z",
  "postings": [
    { … }
  ],
  "documents": [
    { … }
  ],
  "transaction_id": "string"
}