Journal Entries

Get JournalEntry record

Retrieve a specific JournalEntry record by its record number with all related data.

get/public/v2/journal-entries/{record_number}/

Path parameters

record_numberinteger required

The number attribute of the record.

The number attribute of the record.

Query parameters

integration_sourcesIntegrationSourceSlug[] nullable
searchstring nullable
company_idinteger[] nullable
account_idinteger[] nullable
customer_idinteger[] nullable
vendor_idinteger[] nullable
numberinteger[] nullable
codestring[] nullable
start_datestring date nullable
end_datestring date nullable
record_statusRecordStatus[] nullable
approval_statusstring[] nullable
approval_status_scopeRecordStatus[] nullable
number
OR
string
number
OR
string
updated_afterstring date-time nullable
updated_beforestring date-time nullable

Response

OK

bank_match_statusstring nullable
reconciliation_statusstring nullable
approval_statusstring nullable
internal_idinteger required
numberinteger required
codestring nullable
transaction_idinteger required
company_idinteger required
company_namestring required
company_currencystring required
memostring required
datestring date required

Posting date (GL date) - the date when the transaction is recorded in the general ledger

transaction_datestring date required

Transaction date (inception date) - the date when the transaction actually occurred

currency_iso_4217_code'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' required
amountstring required
exchange_ratestring required
record_status'draft' | 'posted' | 'archived' required
created_atstring date-time required

Date and time the record was created

updated_atstring date-time required

Date and time the record was last updated

Changes

Changed in 6 of the 14 revisions of this API.81343

  • 48edcb3acb743518See the full diff
    • the response property reversal_items/items/account_number became optional for the status 200

      response-property-became-optional

    • the response property reversal_items/items/memo became optional for the status 200

      response-property-became-optional

    • removed the required property reversal_items/items/entry_id from the response with the 200 status

      response-required-property-removed

    • removed the optional property has_more_lines from the response with the 200 status

      response-optional-property-removed

    • removed the optional property items/items/reversal_entry_id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property items/items/reversal_line_id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property lines_count from the response with the 200 status

      response-optional-property-removed

    • removed the optional property reversal_date from the response with the 200 status

      response-optional-property-removed

    • api operation id get_JournalEntryV2_record removed and replaced with get_JournalEntry_record

      api-operation-id-removed

    • added the optional property reversal_items/items/billable_customer_id to the response with the 200 status

      response-optional-property-added

    • added the optional property reversal_items/items/billable_customer_name to the response with the 200 status

      response-optional-property-added

    • added the optional property reversal_items/items/billable_markup_pct to the response with the 200 status

      response-optional-property-added

    • added the optional property reversal_items/items/billable_project_id to the response with the 200 status

      response-optional-property-added

    • added the optional property reversal_items/items/billable_project_name to the response with the 200 status

      response-optional-property-added

    • added the optional property reversal_items/items/is_billable to the response with the 200 status

      response-optional-property-added

    • added the optional property reversal_items/items/not_aging_eligible_reason to the response with the 200 status

      response-optional-property-added

    • added the optional property reversal_items/items/original_line_id to the response with the 200 status

      response-optional-property-added

    • the response property items became required for the status 200

      response-property-became-required

    • the response property reversal_items became required for the status 200

      response-property-became-required

    • the memo response's property default value was added for the status 200

      response-property-default-value-added

    • the items response's property default value was removed for the status 200

      response-property-default-value-removed

    • the reversal_items response's property default value was removed for the status 200

      response-property-default-value-removed

    • response property reversal_items reactivated

      response-property-reactivated

    • added the required property reversal_items/items/account_id to the response with the 200 status

      response-required-property-added

    • added the required property reversal_items/items/currency to the response with the 200 status

      response-required-property-added

    • added the required property reversal_items/items/line_type to the response with the 200 status

      response-required-property-added

    This revision also has 93 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional query request parameter code

      new-optional-request-parameter

    • added the enum value monday to the property items/ of the query request parameter integration_sources

      request-parameter-property-enum-value-added

    • added the enum value netsuite_rutter to the property items/ of the query request parameter integration_sources

      request-parameter-property-enum-value-added

    • added the optional property code to the response with the 200 status

      response-optional-property-added

    • added the new optional query request parameter approval_status_scope

      new-optional-request-parameter

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 844da04100e3489See the full diff
    • the response property reversal_items became optional for the status 200

      response-property-became-optional

    • removed the required property reversal_items/items/account_id from the response with the 200 status

      response-required-property-removed

    • removed the required property reversal_items/items/currency from the response with the 200 status

      response-required-property-removed

    • removed the required property reversal_items/items/line_type from the response with the 200 status

      response-required-property-removed

    • removed the optional property reversal_items/items/billable_customer_id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property reversal_items/items/billable_customer_name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property reversal_items/items/billable_markup_pct from the response with the 200 status

      response-optional-property-removed

    • removed the optional property reversal_items/items/billable_project_id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property reversal_items/items/billable_project_name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property reversal_items/items/is_billable from the response with the 200 status

      response-optional-property-removed

    • removed the optional property reversal_items/items/not_aging_eligible_reason from the response with the 200 status

      response-optional-property-removed

    • removed the optional property reversal_items/items/original_line_id from the response with the 200 status

      response-optional-property-removed

    • added the optional property items/items/reversal_entry_id to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/reversal_line_id to the response with the 200 status

      response-optional-property-added

    • added the optional property reversal_date to the response with the 200 status

      response-optional-property-added

    • the response property reversal_items/items/account_number became required for the status 200

      response-property-became-required

    • the response property reversal_items/items/memo became required for the status 200

      response-property-became-required

    • the reversal_items response's property default value was added for the status 200

      response-property-default-value-added

    • the memo response's property default value was removed for the status 200

      response-property-default-value-removed

    • response property reversal_items deprecated

      response-property-deprecated

    • added the required property reversal_items/items/entry_id to the response with the 200 status

      response-required-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property reversal_items/items/billable_customer_id to the response with the 200 status

      response-optional-property-added

    • added the optional property reversal_items/items/billable_customer_name to the response with the 200 status

      response-optional-property-added

    • added the optional property reversal_items/items/billable_markup_pct to the response with the 200 status

      response-optional-property-added

    • added the optional property reversal_items/items/billable_project_id to the response with the 200 status

      response-optional-property-added

    • added the optional property reversal_items/items/billable_project_name to the response with the 200 status

      response-optional-property-added

    • added the optional property reversal_items/items/is_billable to the response with the 200 status

      response-optional-property-added

    This revision also has 21 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 64136e8e19bb15See the full diff
    • the response property items became optional for the status 200

      response-property-became-optional

    • api operation id get_JournalEntry_record removed and replaced with get_JournalEntryV2_record

      api-operation-id-removed

    • added the enum value rippling to the property items/ of the query request parameter integration_sources

      request-parameter-property-enum-value-added

    • added the optional property has_more_lines to the response with the 200 status

      response-optional-property-added

    • added the optional property lines_count to the response with the 200 status

      response-optional-property-added

    • the items response's property default value was added for the status 200

      response-property-default-value-added

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog