transaction_journal_entries

Resource: transaction_journal_entry

This link relationship returns a collection of transaction journal entries. You can paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last.

Required Scopes

Full store_full_access
Read transactions_read
Write transactions_write

Collection Resource

transaction_journal_entry

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

Properties (5)

_embedded Object · Read-only

Contains fx:transaction_journal_entries[] — array of transaction_journal_entry resources

total_items String · Read-only

Total number of resources in this collection.

returned_items Number · Read-only

Number of resources returned in this page.

limit Number · Read-only

Maximum number of resources per page.

offset Number · Read-only

Number of resources skipped.

Link Relations (5)

self This Collection
first First Page of this Collection
prev Previous Page of this Collection
next Next Page of this Collection
last Last Page of this Collection
https://api.foxycart.com/transactions/{transaction_id}/transaction_journal_entries
Available via fx:transaction_journal_entries on store·fx:transaction_journal_entries on transaction

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/transaction_journal_entries",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/transaction_journal_entries?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/transaction_journal_entries?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/transaction_journal_entries?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/transaction_journal_entries?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:transaction_journal_entries": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/transaction_journal_entries/456",
            "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"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}