SHshinkansen
Entries

List of entries

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.

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

Response

List of entries

Example response

{
  "entries": [
    {
      "entry_id": "4BF30A06-1E82-432E-851E-C278D4DAB5B0",
      "direction": "credit",
      "amount": 123.5,
      "description": "Transfer received from John Doe",
      "booking_date": "2023-06-05",
      "source_id": "D5CC7E2C-71D2-48F7-935E-9DEFCA1F4CA0",
      "source_type": "account_statement",
      "account_number": "CL9312345678901234567890",
      "references": [
        {
          "reference_id": "02D3F902-4B25-4B74-9B97-5A5B5C4E787A",
          "reference_type": "base_entry"
        }
      ],
      "entry_details": {
        "debtor_account": "4322110",
        "debtor_fin_id": "BANCO_DE_CHILE_CL",
        "debtor_id": "12345678-9"
      },
      "operational_payments": [
        "8FD48186-8214-4062-8532-589930DDA37B"
      ],
      "reconciliation_status": "reconciled",
      "reconciliation_method": "automatic"
    },
    {
      "entry_id": "58183FE9-78DE-4E02-971D-E4CD9EB3EF98",
      "direction": "debit",
      "amount": 999999,
      "description": "PNOL 99999",
      "booking_date": "2023-06-05",
      "source_id": "D5CC7E2C-71D2-48F7-935E-9DEFCA1F4CA0",
      "source_type": "account_statement",
      "account_number": "CL9312345678901234567890",
      "references": [
        {
          "reference_id": "4155DE70-7327-49F7-9C05-14C69B3F984E",
          "reference_type": "charge"
        }
      ],
      "entry_details": {
        "creditor_account": "9432958",
        "creditor_fin_id": "BCI_CL",
        "creditor_id": "19154443-9"
      },
      "reconciliation_status": "externally_reconciled",
      "reconciliation_method": "manual"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.