transaction_journal_entries

Description

This link relationship returns a collection of resources. You can easily paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last. Scroll down to view a representation of a single resource embedded within this collection.

Actions

GET
View a list of transaction_journal_entries
HEAD
Get just the header response
OPTIONS
Get a response explaining which HTTP methods are supported

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "...",
      "title": "This Collection"
    },
    "first": {
      "href": "...?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "...?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "...?offset=0",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "...?offset=0",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:transaction_journal_entries": [...]
  },
  "total_items": "5",
  "returned_items": 5,
  "limit": 20,
  "offset": 0
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="...">
  <link rel="self" href="..." title="This Collection"/>
  <link rel="first" href="...?offset=0" title="First Page of this Collection"/>
  <link rel="prev" href="...?offset=0" title="Previous Page of this Collection"/>
  <link rel="next" href="...?offset=0" title="Next Page of this Collection"/>
  <link rel="last" href="...?offset=0" title="Last Page of this Collection"/>
  <resource href="..." rel="https://api.foxycart.com/rels/transaction_journal_entry">
  ...
  </resource>
  <total_items>5</total_items>
  <returned_items>5</returned_items>
  <limit>20</limit>
  <offset>0</offset>
</resource>

{
    "properties": {
        "total_items": "5",
        "returned_items": 5,
        "limit": 20,
        "offset": 0
    },
    "entities": [...],
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "..."
        },
        {
            "rel": [
                "first"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "prev"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "next"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "last"
            ],
            "href": "...?offset=0"
        }
    ],
    "actions": [
    ]
}

Embedded Resource: transaction_journal_entry

Description

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 on 2022-02-01, 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 from the customer to the merchant, but subsequent capture would. If you subsequently use Foxy to edit the transaction and capture $80 on 2022-03-01, another journal entry will be created with an amount of 80.00. And again, if you issue a partial refund for $40 on 2022-04-01, 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 (such as an initial auth+capture, a delayed capture on an earlier auth or verification, a void or a refund, etc.), but the transaction_log_id can be used to determine that if needed.

Actions

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

Properties

Property Description Type Constraints
amount 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. Decimal Read only
display_id 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). String Read only
date_created The date this resource was created. String Read only

Example Representation

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

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api.foxycart.test/transaction_journal_entries/1" rel="https://api.foxycart.com/rels/transaction_journal_entry">
    <link rel="self" href="https://api.foxycart.test/transaction_journal_entries/1" title="This Transaction Log"/>
    <link rel="https://api.foxycart.com/rels/store" href="https://api.foxycart.test/stores/40075" title="This Store"/>
    <link rel="https://api.foxycart.com/rels/transaction" href="https://api.foxycart.test/transactions/3860058" title="This Transaction"/>
    <link rel="https://api.foxycart.com/rels/transaction_logs" href="https://api.foxycart.test/transaction_logs/4433" title="This Transaction"/>
    <amount>40.3</amount>
    <display_id>18532324-2</display_id>
    <date_created>2022-03-21T07:43:45-0700</date_created>
</resource>

{
    "class": [
        "transaction_journal_entry"
    ],
    "properties": {
        "amount": 40.3,
        "date_created": "2022-03-21T07:43:45-0700"
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api.foxycart.test/transaction_journal_entries/1"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store"
            ],
            "href": "https://api.foxycart.test/stores/40075"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/transaction"
            ],
            "href": "https://api.foxycart.test/transactions/3860058"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/transaction_logs"
            ],
            "href": "https://api.foxycart.test/transaction_logs/4433"
        }
    ],
    "actions": [
        {
            "name": "self",
            "title": "Update Transaction Journal Entry",
            "method": "PATCH",
            "href": "https://api.foxycart.test/transaction_journal_entries/1",
            "type": "application/x-www-form-urlencoded",
            "fields": [
                {
                    "name": "amount",
                    "title": "Amount",
                    "type": "text",
                    "value": 40.3
                },
                {
                    "name": "display_id",
                    "title": "Display Id",
                    "type": "text",
                    "value": "18532324-2"
                }
            ]
        }
    ]
}

Zoomable Resources

The following related resources can be embedded within this resource by including a ?zoom=<child_resource> parameter. You can also filter by child resources by ?child_resource:property=<property_value>

transaction_logs