Sign in

v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB
Core Accounting

Retrieve Journal Entry

    Retrieve a specific journal entry by ID with all transaction details.

    **Response includes:**
    - Complete journal entry with all transactions
    - Account names, numbers, and types
    - Vendor and department information
    - Tag associations with groups
    - Exchange rate data for multi-currency entries
    - Attachment information
    - Reversal information if applicable
get/coa/api/journal_entry/{id}

Path parameters

idinteger required

Response

idinteger required
is_deletedboolean required
deleted_atstring date-time nullable required
invoiceinteger nullable required
reversal_of_orderstring required
reversalsobject[] required
reversal_datestring date nullable
entity_namestring required
entity_currencystring required
created_byinteger nullable required

Derived user ID of the journal entry creator. Check created_by_source before explaining provenance.

created_by_namestring nullable required

Derived name of the journal entry creator. Check created_by_source before explaining provenance.

created_by_sourcestring nullable required

Provenance for created_by and created_by_name: 'draft_queue_created_by', 'chart_transaction_last_modified_by_fallback', or null.

orderstring
revenue_transactionsinteger[]
bulk_uploadboolean
chat_uuidstring uuid nullable
close_task_idstring
update_reversalboolean
credit_memosobject[] required
debit_memosobject[] required
journals_to_deleteinteger[]
ramp_use_sandboxstring required
navan_regionstring nullable required

Navan data region (US/EU) for a Navan-sourced journal entry, else None.

Mirrors ramp_use_sandbox: the frontend builds the "Open in Navan" deep link from source_id and uses this to pick the web-app host (US -> app.navan.com, EU -> app-fra.navan.com). Navan records carry no FK to their connection, so the region is resolved per customer and memoized to avoid an N+1 lookup across a transaction list.

float_bill_idstring nullable required

Float id of the bill paid by a Float bill-payment journal entry, else None.

Payment journal entries store the Float payment id as source_id, which has no page of its own in Float's web app — the frontend deep-links "View on Float" to the paid bill instead.

search_vectorstring nullable required
search_textstring nullable required
type'bill' | 'bill_payment' | 'bill_prepayment' | 'check' | 'credit_card' | 'credit_memo' | 'credit_memo_payment' | 'debit_memo' | 'debit_memo_payment' | 'deposit' | 'expense' | 'invoice' | 'intercompany_journal' | 'invoice_payment' | 'journal_entry' | 'lease' | 'payment' | 'receive_payment' | 'refund' | 'revenue_recognition' | 'sales_receipt' | 'transfer' | 'vendor_credit' | 'void_bill' | 'void_bill_payment' | 'void_invoice_payment' | 'void_credit_memo' | 'void_credit_memo_payment' | 'void_debit_memo_payment' | 'void_invoice' | 'elimination' | 'revaluation' | 'asset_reclassification'
  • bill - Bill
  • bill_payment - Bill Payment
  • bill_prepayment - Bill Prepayment
  • check - Check
  • credit_card - Credit Card
  • credit_memo - Credit Memo
  • credit_memo_payment - Credit Memo Payment
  • debit_memo - Debit Memo
  • debit_memo_payment - Debit Memo Payment
  • deposit - Deposit
  • expense - Expense
  • invoice - Invoice
  • intercompany_journal - Intercompany Journal
  • invoice_payment - Invoice Payment
  • journal_entry - Journal Entry
  • lease - Lease
  • payment - Payment
  • receive_payment - Receive Payment
  • refund - Refund
  • revenue_recognition - Revenue Recognition
  • sales_receipt - Sales Receipt
  • transfer - Transfer
  • vendor_credit - Vendor Credit
  • void_bill - Void Bill
  • void_bill_payment - Void Bill Payment
  • void_invoice_payment - Void Invoice Payment
  • void_credit_memo - Void Credit Memo
  • void_credit_memo_payment - Void Credit Memo Payment
  • void_debit_memo_payment - Void Debit Memo Payment
  • void_invoice - Void Invoice
  • elimination - Elimination
  • revaluation - Revaluation
  • asset_reclassification - Asset Reclassification
journal_idstring uuid
memostring nullable
currencystring
exchange_ratenumber double nullable
exchange_rate_booknumber double nullable
use_average_rateboolean nullable
created_automaticallyboolean
datestring date
ref_numberstring nullable
created_atstring date-time required
sourcestring nullable
source_idstring nullable
last_modified_atstring date-time required
customerinteger required
recurrent_journal_entryinteger nullable
entityinteger nullable
reversal_ofinteger nullable
intercompany_journalinteger nullable
source_fileinteger nullable
chatinteger nullable
last_draftinteger nullable required