---
title: "List of entries"
method: GET
path: "/entries"
tags: ["Entries"]
---

# List of entries

`GET /entries`

## Request

- Base URL: `https://api.treasury.shinkansen.finance/v1`
- URL: `https://api.treasury.shinkansen.finance/v1/entries`
- Auth: API key in header `Shinkansen-Treasury-Api-Key`

Returns a paginated list of entries. Entries are the movements that occurred in your bank, commonly seen in your bank statement. This endpoint fetches the entries from all bank accounts enrolled in Shinkansen Treasury and can be identified by the `account_number` field. List can be filtered by date range, bank account id, entry direction, and source type (account statement or account report). Getting historical information is usually not feasible unless you were connected to the banks through Shinkansen during the period in question.

**Pagination:** Results are returned in pages of up to `page_size` entries (default 25, max 100), ordered by `booking_date` descending and then by internal id ascending, so the pages of a walk do not overlap. The response includes a `Link` HTTP header (RFC 5988) with navigation URLs:
- `rel="next"` - URL for the next page (absent on the last page)
- `rel="prev"` - URL for the previous page (absent on the first page)
- `rel="first"` - URL for the first page
- `rel="last"` - URL for the last page

Each link is an absolute URL built from the host this service is configured with, and carries the `page` of the target page plus the filters you sent, so following a link walks the same filtered result set. To retrieve all entries, follow the `rel="next"` link until it is no longer present in the response.

## Response `200`

List of entries

- Entries: List of entries
  - `entries` Entry[], required: A list of entries
    - `entry_id` string, required: UUID Unique identifier for the entry.
    - `direction` 'credit' | 'debit', required: The direction of the entry. Can be one of: - `credit`: The entry is a credit to the account. The account balance increases. - `debit`: The entry is a debit to the account. The account balance decreases.
    - `amount` string, required: Amount, ISO20022-compatible: Up to 18 integer digits, optional decimal separator ".", up to 5 fraction digits (also optional). By using a string we avoid issues with floating-point arithmetic as well as integer type limits on some JSON implementations.
    - `description` string, required: Description of the entry. It can be a free text or a specific code depending of the bank.
    - `booking_date` string, date, required: Date of bank booking for this specific entry. Can be different from the operation date.
    - `operation_date` string, date-time: Date and time when the operation was actually performed. Not all financial institutions provide this information. When only the date is available but not the time, the timestamp will be midnight of that day in the bank operating time zone (which might be UTC or local/regional time).
    - `source_id` string, required: UUID Unique identifier for the source of this entry (statement or report). The combination of source_id and source_type is unique.
    - `source_type` 'account_statement' | 'account_report', required: The type of the source statement of this entry. The combination of source_id and source_type is unique. Can be `account_report` (a sort of interim entry) or `account_statement` (which usually means the entry is permanent and confirmed).
    - `account_number` string, required: Bank account number (IBAN format) where the entry was booked.
    - `bank_operation_id` string, required: Unique identifier from the bank related to this operation. Some finantial institutions do not provide this information, in this case it will be an empty string.
    - `references` object[], required: List of references for the entry. References could be the statement from the bank or substatements computed from Shinkansen Network. It will always contain at least one reference.
      - `reference_id` string: UUID Unique identifier for the reference.
      - `reference_type` 'charge_entry' | 'reversal_entry' | 'base_entry': The type of reference. Can be one of: - `charge_entry`: The reference is another entry in the statement that relates to this entry as charge from the bank. - `reversal_entry`: The reference is another entry in the statement that relates to this entry as reversal from the bank. - `base_entry`: The reference is a another entry in the statement that relates to this entry. Usually when the entry is a reversal or a charge the reference is the entry that was generated by the user Ex. the payout.
    - `entry_details` object, required: Additional information for the entry in a key-value format. Depends of the finantial institution and the entry type. Ex. BCI bank has source_account, source_bank, source_dni.
    - `operational_payments` string[], required: List of operational payments ids for all operations related to this entry. Can be empty or not present if no operations were matched.
    - `reconciliation_status` 'unreconciled' | 'reconciled' | 'externally_reconciled' | 'ignored': The status of the reconciliation of this entry. Can be one of: - `unreconciled`: We don't have information to match this entry. For now we only match operational payments. - `reconciled`: This entry is associated with one or more operational payments Shinkansen Network or changed manually. - `externally_reconciled`: This entry was manually reconciled by the user through the UI from an external source. - `ignored`: This entry was ignored by the user and is not associated with any operational payment.
    - `reconciliation_method` 'manual' | 'automatic' | 'none', required: The reconciliation method used for this entry. Can be one of: - `manual`: This entry was reconciled or ignored manually by the user through the UI. - `automatic`: This entry was reconciled automatically by Shinkansen Treasury Bot. - `none`: This entry has not been reconciled.
    - `is_via_shinkansen` boolean: Indicates whether this entry was processed via Shinkansen network. True if there are linked payouts from Shinkansen transactions.
    - `linked_payouts` object[]: List of Shinkansen payouts linked to this entry. Empty array if the entry is not associated with any Shinkansen transaction.
      - `shinkansen_transaction_id` string: Shinkansen transaction identifier
      - `transaction_id` string: Internal transaction UUID
      - `state` 'created' | 'pending' | 'ok' | 'error' | 'invalid': Current state of the payout
      - `payout_order_id` integer: Internal payout order ID
      - `shinkansen_payout_order_id` string: Shinkansen payout order identifier
      - `description` string: Description of the payout order

## Other responses

- `403`: Forbidden (e.g: wrong API Key)
- `422`: One or more query parameters could not be validated. The body names the reason: `Invalid query parameters` when a filter value has the wrong type or shape, and `account_number must be a single value` when `account_number` arrives repeated or nested.

---

[API](https://skmtc.dev/shinkansen/apis/treasury-shinkansen-endpoints.md) - [All operations](https://skmtc.dev/shinkansen/apis/treasury-shinkansen-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/shinkansen/apis/treasury-shinkansen-endpoints/revisions/2d3ec7684af3?raw)