Skip to main content
GET
/
statements
/
{statement_id}
Get a statement
curl --request GET \
  --url https://api.synctera.com/v2/statements/{statement_id} \
  --header 'Authorization: Bearer <token>'
{
  "exclude_jit_transactions": false,
  "include_child_transactions": false,
  "statement_type": "DEPOSIT",
  "saving_summary": {
    "accrual_days": 123,
    "apy": 550,
    "interest_earned": 150,
    "interest_earned_previous_month": 150,
    "interest_earned_previous_year": 10000,
    "interest_earned_ytd": 10000
  },
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billing_period_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "end_date": "2023-12-25",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "issue_date": "2023-12-25",
  "start_date": "2023-12-25",
  "account_summary": {
    "account_number": "<string>",
    "account_status": "<string>",
    "account_type": "<string>",
    "balance_ceiling": {
      "balance": 123
    },
    "balance_floor": {
      "balance": 123
    },
    "creation_time": "2023-11-07T05:31:56Z",
    "currency": "USD",
    "customer_type": "<string>",
    "financial_institution": {
      "address": {
        "address_line_1": "321 Main St",
        "address_line_2": "Apt 34",
        "city": "Chicago",
        "country_code": "US",
        "postal_code": "60622",
        "state": "IL"
      },
      "id_code": "SWIFT_BIC",
      "identifier": "<string>",
      "name": "<string>"
    },
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_updated_time": "2023-11-07T05:31:56Z",
    "nickname": "<string>"
  },
  "authorized_signers": [
    {
      "creation_time": "2023-11-07T05:31:56Z",
      "first_name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_name": "<string>",
      "last_updated_time": "2023-11-07T05:31:56Z",
      "middle_name": "<string>",
      "relationship_type": "<string>"
    }
  ],
  "closing_balance": 123,
  "customer_service_details": {
    "address": {
      "address_line_1": "321 Main St",
      "address_line_2": "Apt 34",
      "city": "Chicago",
      "country_code": "US",
      "postal_code": "60622",
      "state": "IL"
    },
    "email": "<string>",
    "phone_number": "<string>"
  },
  "disclosure": "<string>",
  "joint_account_holders": [
    {
      "creation_time": "2023-11-07T05:31:56Z",
      "first_name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_name": "<string>",
      "last_updated_time": "2023-11-07T05:31:56Z",
      "middle_name": "<string>",
      "relationship_type": "<string>"
    }
  ],
  "opening_balance": 123,
  "primary_account_holder_business": {
    "is_customer": true,
    "status": "PROSPECT",
    "addresses": [
      {
        "address_line_1": "321 Main St",
        "address_line_2": "Apt 34",
        "city": "Chicago",
        "country_code": "US",
        "postal_code": "60622",
        "state": "IL"
      }
    ],
    "classifications": [
      "BANK_CUSTOMER"
    ],
    "compliance_restrictions": [
      "LICENSED_CANNABIS"
    ],
    "creation_time": "2010-05-06T12:23:34.321Z",
    "customer_active": "2010-05-06T12:23:34.321Z",
    "ein": "12-3456789",
    "email": "alice@example.com",
    "entity_name": "Apex Corporation",
    "formation_date": "2000-01-01",
    "formation_state": "NY",
    "has_accounts": true,
    "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "last_updated_time": "2010-05-06T12:23:34.321Z",
    "legal_address": {
      "address_line_1": "321 Main St",
      "address_line_2": "Apt 34",
      "city": "Chicago",
      "country_code": "US",
      "postal_code": "60622",
      "state": "IL"
    },
    "metadata": {},
    "phone_number": "+14374570680",
    "spend_control_ids": [
      "7d943c51-e4ff-4e57-9558-08cab6b963c7"
    ],
    "structure": "CORPORATION",
    "tenant": "abcdef_ghijkl",
    "trade_names": [
      "Apex",
      "Apex LLC",
      "CorporationID#77231"
    ],
    "verification_last_run": "2010-05-06T12:23:34.321Z",
    "verification_status": "ACCEPTED",
    "website": "https://example.com"
  },
  "primary_account_holder_personal": {
    "creation_time": "2023-11-07T05:31:56Z",
    "first_name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_name": "<string>",
    "last_updated_time": "2023-11-07T05:31:56Z",
    "middle_name": "<string>",
    "relationship_type": "<string>"
  },
  "total_transactions": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
statement_id
string<uuid>
required

The unique identifier of a statement

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Response

statement

A statement for a depository account

​
exclude_jit_transactions
boolean
default:false
required

Ignore "JIT funding" transactions when generating a statement

Example:

false

​
include_child_transactions
boolean
default:false
required

Include transactions from sub-accounts when generating a statement

Example:

false

​
statement_type
enum<string>
required

The type of statement

Available options:
DEPOSIT,
LINE_OF_CREDIT,
CHARGE_SECURED,
CHARGE_UNSECURED,
CREDIT_CARD
​
saving_summary
Saving Summary · object
required

A summary of the accrued interest for the saving account in the current period

​
account_id
string<uuid>

The unique identifier of the account the statement belongs to

​
billing_period_id
string<uuid>

The billing period this statement corresponds to

​
end_date
string<date>

The date indicating the ending of the time interval covered by the statement

​
id
string<uuid>

statement ID

​
issue_date
string<date>

The date when the statement has been issued

​
start_date
string<date>

The date indicating the beginning of the time interval covered by the statement

​
account_summary
Account Summary · object
​
authorized_signers
Person · object[]
​
closing_balance
integer<int64>

The account balance at the end of the statement period, in ISO 4217 minor currency units.

​
customer_service_details
Customer Service Details · object

The customer service details of the fintech partner, e.g. phone number, email address, etc.

​
disclosure
string
​
joint_account_holders
Person · object[]
​
opening_balance
integer<int64>

The account balance at the start of the statement period, in ISO 4217 minor currency units.

​
primary_account_holder_business
object

Represents a business customer.

​
primary_account_holder_personal
Person · object
​
total_transactions
integer<int64>

The total number of transactions for this statement period.