> ## Documentation Index
> Fetch the complete documentation index at: https://docs.synctera.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List statements

> Gets a list of statement summaries for an account.




## OpenAPI

````yaml openapi-v1.json get /statements
openapi: 3.0.3
info:
  description: >-
    This is the official reference documentation for Synctera APIs. If you need
    something specific or have a question, <a class='text-blue-600'
    href='https://synctera.com/contact-us' target='_blank'
    rel='noreferrer'>contact us</a>.</p>
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: Synctera API
  version: 1.181.0
servers:
  - description: Production
    url: https://api.synctera.com/v1
  - description: Sandbox (no real world financial impact)
    url: https://api-sandbox.synctera.com/v1
security:
  - bearerAuth: []
tags:
  - description: |
      Requests to create and manage Rewards
    name: Rewards (beta)
  - description: Requests to generate simulated webhooks
    name: Card Webhook Simulations
  - description: >-
      Testing endpoints to simulate in-store cash deposits. Available in sandbox
      environments only.
    name: In-Store Cash Deposit Simulations
  - description: Create and manage spending controls
    name: Spend Controls (beta)
  - description: Rates
    name: Rates
  - description: Requests to create and manage webhooks
    name: Webhooks
  - description: Tenant Config
    name: Tenant Config
  - description: FDX authentication and data transfer using Plaid Core Exchange
    name: Plaid Core Exchange (beta)
  - description: Create and manage disputes
    name: Disputes
  - description: Requests to simulate card payments
    name: Card Simulations
  - description: |
      Manage fee products and fee configs for automated fee collection
    name: Fee Products
  - description: Apple Pay APIs
    name: Apple Pay
  - description: Lending Config
    name: Lending Config
  - description: Payments related to lending accounts
    name: Payments
  - description: Manage negative balance processes
    name: Negative Balance
  - description: Configuration for mapping LoanPro events to Payola transaction parameters
    name: LoanPro Transaction Event Config
  - description: Requests to generate simulated transactions
    name: Cash Transaction Simulations (alpha)
  - description: Create and manage transactions
    name: Transactions (beta)
  - description: Autopay payment records for billing periods
    name: Autopays
  - description: Create and manage accounts
    name: Accounts
  - description: |
      Requests to create and manage batch payments
    name: Batch Payments (alpha)
  - description: Billing rates
    name: Billing Rates
  - description: Bank Delinquency Configuration
    name: Bank Delinquency Configuration
  - description: >-
      Rules that map a posted payment transaction (bank/partner + transaction
      attributes) to a regulatory payment code. NULL match columns act as
      wildcards.
    name: Payment Code Configuration
  - description: Create and manage Synctera Pay templates
    name: SyncteraPay
  - description: |
      Manage reward products and reward configs for automated cashback rewards
    name: Reward Products
  - description: Requests to create and manage card disputes
    name: Card Disputes
  - description: >-
      Per bank/partner account-type mapping to FFIEC collateral codes used for
      regulatory call report furnishment.
    name: Collateral Code Configuration
  - description: Bulk card issuance
    name: Bulk Issuance
  - description: Autopay configuration management for lending accounts
    name: Autopay Configs
  - description: Request to create and manage exclusions
    name: Statements
  - description: Create and manage barcodes for in-store cash deposits
    name: In-Store Cash Deposits
  - description: Customer Service Details for disputes and billing inquiries
    name: Customer Service Details
  - description: Create a credit application.
    name: Applications (beta)
  - description: Requests to generate simulated transactions
    name: Card Transaction Simulations
  - description: Billing period summaries
    name: Billing Period Summaries
  - description: Requests to issue and manage cards
    name: Cards
  - description: Push and pull from cards
    name: External Cards
  - description: |
      Requests to create and manage fees
    name: Fees (beta)
paths:
  /statements:
    summary: Statements
    get:
      tags:
        - Statements
      summary: List statements
      description: |
        Gets a list of statement summaries for an account.
      operationId: listStatements
      parameters:
        - $ref: '#/components/parameters/billing_period_id'
        - $ref: '#/components/parameters/account_id1'
        - $ref: '#/components/parameters/page_token'
        - $ref: '#/components/parameters/limit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/statement_list'
          description: List of statements for a given account
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '500':
          $ref: '#/components/responses/internal_server_error'
components:
  parameters:
    billing_period_id:
      description: Filter statements by billing period
      in: query
      name: billing_period_id
      schema:
        example: 7d943c51-e4ff-4e57-9558-08cab6b963c7
        format: uuid
        type: string
    account_id1:
      description: The account's unique identifier provided by Synctera
      in: query
      name: account_id
      required: true
      schema:
        example: 7d943c51-e4ff-4e57-9558-08cab6b963c7
        format: uuid
        type: string
    page_token:
      in: query
      name: page_token
      schema:
        description: >-
          Optional pagination token to be provided to retrieve subsequent pages,
          returned from previous get
        example: a8937a0d
        type: string
    limit:
      in: query
      name: limit
      schema:
        default: 100
        description: >
          Maximum number of objects to return per page. If the limit is greater
          than 100, then it will be set to 100.
        example: 100
        minimum: 1
        type: integer
  schemas:
    statement_list:
      allOf:
        - properties:
            statements:
              description: Array of statements
              items:
                $ref: '#/components/schemas/statement_summary'
              type: array
          required:
            - statements
          type: object
        - $ref: '#/components/schemas/paginated_response'
      title: Statement List
    statement_summary:
      properties:
        account_id:
          description: The unique identifier of the account the statement belongs to
          format: uuid
          readOnly: true
          type: string
        billing_period_id:
          description: The billing period this statement corresponds to
          format: uuid
          readOnly: true
          type: string
        credit_summary:
          $ref: '#/components/schemas/credit_summary'
        end_date:
          description: >-
            The date indicating the ending of the time interval covered by the
            statement
          format: date
          readOnly: true
          type: string
        id:
          description: statement ID
          format: uuid
          readOnly: true
          type: string
        issue_date:
          description: The date when the statement has been issued
          format: date
          readOnly: true
          type: string
        saving_summary:
          $ref: '#/components/schemas/saving_summary'
        security_account_summary:
          $ref: '#/components/schemas/security_account_summary'
        start_date:
          description: >-
            The date indicating the beginning of the time interval covered by
            the statement
          format: date
          readOnly: true
          type: string
        statement_type:
          $ref: '#/components/schemas/statement_type'
      title: Statement
      type: object
    paginated_response:
      properties:
        next_page_token:
          description: >-
            If returned, use the next_page_token to query for the next page of
            results. Not returned if there are no more rows.
          example: a8937a0d
          type: string
      title: Paginated List response
      type: object
    error:
      description: Synctera error responses in API v1 implement a custom error schema.
      properties:
        code:
          description: >
            A machine-readable string that identifies the error for programmatic
            use.
          example: BAD_REQUEST_BODY
          type: string
        detail:
          description: |
            A human-readable string explaining this particular error.
          example: 'Missing required fields: first_name, dob'
          type: string
        status:
          description: HTTP status code for this response
          example: 400
          type: integer
      title: Synctera error response
      type: object
    credit_summary:
      description: >-
        A summary of the accrued interest for the credit account in the current
        period.
      properties:
        amount_over_limit:
          description: >-
            The portion of the posted account balance that exceeds the account's
            credit limit, in ISO 4217 minor currency units.
          example: 100000
          format: int64
          type: integer
        amount_past_due:
          description: >
            Any outstanding balance from a previous statement for this account
            in ISO 4217 minor currency units.
          example: 100000
          format: int64
          type: integer
        apr:
          description: The annual percentage rate of the credit account, in basis points.
          format: int64
          type: integer
        balance_for_interest:
          description: >-
            Balance on which interest is computed during the time interval
            covered by the statement.
          format: int64
          type: integer
        credit_limit:
          description: >-
            The credit limit of the credit account, in ISO 4217 minor currency
            units. Not applicable for charge secured accounts.
          format: int64
          type: integer
        disclosure:
          description: A suggested regulatory disclosure to display on the statement.
          example: >-
            We have told the credit bureau(s) about a late payment, missed
            payment or other default on your account. This information may be
            reflected in your credit report.
          type: string
        disputed_balance:
          description: >-
            The disputed balance on the credit account in ISO 4217 minor
            currency units.
          format: int64
          type: integer
        fees:
          description: >-
            The total fees charged on the credit account in ISO 4217 minor
            currency units during the time interval covered by the statement.
          format: int64
          type: integer
        fees_ytd:
          description: >-
            The total fees charged on the credit account in ISO 4217 minor
            currency units for the year to date.
          format: int64
          type: integer
        interest:
          description: >-
            The total interest charged on the credit account in ISO 4217 minor
            currency units during the time interval covered by the statement.
          format: int64
          type: integer
        interest_ytd:
          description: >-
            The total interest charged on the credit account in ISO 4217 minor
            currency units for the year to date.
          format: int64
          type: integer
        is_past_due:
          description: Whether or not the credit account is past due on payment.
          type: boolean
        last_payment_date:
          description: The date of the last payment received.
          format: date
          type: string
        minimum_payment_due:
          description: >-
            The minimum payment amount due by the payment due date in ISO 4217
            minor currency units.
          format: int64
          type: integer
        payment_due:
          description: >-
            The total amount due by the payment due date in ISO 4217 minor
            currency units.
          format: int64
          type: integer
        payment_due_date:
          description: The date the next payment is due.
          format: date
          type: string
        payments_received:
          description: The sum of all payments received in ISO 4217 minor currency units.
          format: int64
          type: integer
      title: Credit Summary
      type: object
    saving_summary:
      description: >-
        A summary of the accrued interest for the saving account in the current
        period
      properties:
        accrual_days:
          description: >
            The number of days for which interest was accrued. In most cases
            this will match the number of days in the billing period, but may be
            less if an account was closed part way through the period.
          format: int32
          type: integer
        apy:
          description: >
            The annual percentage yield (APY) for this statement period, in
            basis points. For example, an APY of 5.5% will display as 550.
          example: 550
          type: integer
        interest_earned:
          description: >
            The total interest earned by the depository account for this
            statement period in ISO 4217 minor currency units. For example,
            $1.50 USD of interest will be displayed as 150.
          example: 150
          format: int64
          type: integer
        interest_earned_previous_month:
          description: >
            The total interest earned by the depository account in the previous
            statement period in ISO 4217 minor currency units. For example,
            $1.50 USD of interest will be displayed as 150.
          example: 150
          format: int64
          type: integer
        interest_earned_previous_year:
          description: >
            The total interest earned by the depository account in the previous
            year in ISO 4217 minor currency units. For example, $100 USD of
            interest will be displayed as 10000.
          example: 10000
          format: int64
          type: integer
        interest_earned_ytd:
          description: >
            The total interest earned by the depository account for this year to
            date in ISO 4217 minor currency units. For example, $100 USD of
            interest will be displayed as 10000.
          example: 10000
          format: int64
          type: integer
      title: Saving Summary
      type: object
    security_account_summary:
      description: A summary for the security account backing the credit account.
      properties:
        account_id:
          description: The unique identifier of the backing account.
          format: uuid
          type: string
        account_number:
          description: Account number of the backing account.
          type: string
        account_type:
          description: |
            The type of the account. It refers to the backing account.
          type: string
        apy:
          description: >
            The annual percentage yield (APY) for the security account for this
            statement period, in basis points. For example, an APY of 5.5% will
            display as 550.
          example: 550
          format: int64
          type: integer
        closing_balance:
          description: >-
            The security account balance at the end of the statement period, in
            ISO 4217 minor currency units. For example, $1,000 USD will be
            displayed as 100000.
          example: 100000
          format: int64
          type: integer
        disclosure:
          type: string
        interest:
          description: >
            The total interest earned by the security account for this statement
            period in ISO 4217 minor currency units. For example, $1.50 USD of
            interest will be displayed as 150.
          example: 150
          format: int64
          type: integer
        interest_previous_month:
          description: >
            The total interest earned by the security account in the previous
            statement period in ISO 4217 minor currency units. For example,
            $1.50 USD of interest will be displayed as 150.
          example: 150
          format: int64
          type: integer
        interest_previous_year:
          description: >
            The total interest earned by the security account in the previous
            year in ISO 4217 minor currency units. For example, $100 USD of
            interest will be displayed as 10000.
          example: 10000
          format: int64
          type: integer
        interest_ytd:
          description: >
            The total interest earned by the security account for this year to
            date in ISO 4217 minor currency units. For example, $100 USD of
            interest will be displayed as 10000.
          example: 10000
          format: int64
          type: integer
        opening_balance:
          description: >-
            The security account balance at the start of the statement period,
            in ISO 4217 minor currency units. For example, $1,000 USD will be
            displayed as 100000.
          example: 100000
          format: int64
          type: integer
      title: Security Account Summary
      type: object
    statement_type:
      description: The type of statement
      enum:
        - CHARGE_SECURED
        - CHARGE_UNSECURED
        - CREDIT_CARD
        - DEPOSIT
        - LINE_OF_CREDIT
      title: Statement Type
      type: string
      x-enumDescriptions:
        CHARGE_SECURED: Secured charge card account statement (e.g. for Smart Charge Cards)
        CHARGE_UNSECURED: Unsecured charge card account statement (e.g. for Smart Charge Cards)
        CREDIT_CARD: Credit card account statement
        DEPOSIT: Deposit account statement (e.g. for CHECKING or SAVING accounts)
        LINE_OF_CREDIT: Line of Credit account statement
  responses:
    unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
      description: Unauthorized
    forbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
      description: Forbidden
    internal_server_error:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
      description: Internal server error
  securitySchemes:
    bearerAuth:
      bearerFormat: api_key
      scheme: bearer
      type: http

````