transaction_journal_entry

Collection: transaction_journal_entries

A journal entry records the movement of money related to transactions in Foxy, primarily for use in reconciling Foxy with external accounting systems. Though similar to the total_order value on a transaction, a journal entry provides a more accurate record of the movement of funds, particularly as it relates to authorizations, verifications, voids, captures, and refunds on a transaction (all of which happen after the transaction's transaction_date). In most cases, the amount value of a journal entry will match the total_order, but this is not always the case.

For instance, if your store's payment gateway is set to authorize-only or verify-only-and-always, and a customer makes a $100 purchase, a journal entry will be made with an amount of 0, though the transaction's total_order will be $100. This is because an authorization or verification doesn't actually result in funds being transferred. If you subsequently capture $80, another journal entry will be created with an amount of 80.00. And if you issue a partial refund for $40, yet another journal entry will be created with an amount of -40.00.

Note that journal entries only contain an amount, and not the corresponding currency, so if you use multiple currencies you'll want to zoom on the transaction as well. Similarly, journal entries do not contain the action that caused them, but the transaction_log_id can be used to determine that if needed.

Required Scopes

Full store_full_access
Read transactions_read
Write transactions_write

Actions

GET View a transaction journal entry
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (3)

amount Number · Read-only

The value of money that should be transferred to or from the merchant's bank account (or comparable). Note that voids or refunds will result in a negative number.

display_id String or Number · Read-only

If custom transaction IDs, prefixes, or suffixes have been configured, this value will contain the custom ID (which may be a string). Otherwise it will be identical to the id value (an integer).

date_created String (nullable) · Read-only

The date this resource was created.

Link Relations (4)

self This Transaction Journal Entry
fx:store GET PATCH PUT DELETE This Store
fx:transaction GET PATCH PUT POST This Transaction
fx:transaction_log GET Transaction Log

Zoomable Resources

Embed related resources using ?zoom=<resource>. Filter with ?resource:property=value.

transaction_logs
https://api.foxycart.com/transaction_journal_entries/{id}

Example Representation

Zoom
{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/transaction_journal_entries/123",
      "title": "This Transaction Journal Entry"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:transaction": {
      "href": "https://api.foxycart.com/transactions/999",
      "title": "This Transaction"
    },
    "fx:transaction_log": {
      "href": "https://api.foxycart.com/transaction_logs/456",
      "title": "Transaction Log"
    }
  },
  "amount": 40.3,
  "display_id": "18532324-2",
  "date_created": "2022-03-21T07:43:45-0700"
}