Get Statement Details

Retrieve Statement Details based on the given program GUID and optional date range.

Request

Security:

Bearer

path Parameters

version

required

string

Request Body schema: application/json

Request body containing program GUID and optional date range

program_guid required	string <uuid> Program unique identifier.
statement_cycle_start_date	string or null <date-time> Statement cycle start date. If not passed, it will be defaulted to program recent statement cycle start date.
statement_cycle_end_date	string or null <date-time> Statement cycle end date. If not passed, it will be defaulted to program recent statement cycle end date.
show_txns	boolean or null Show Transaction details.
show_subprograms	boolean or null Show SubProgram details.
format	string (StatementFormat) Enum: "JSON" "PDF"

Responses

200

Returns the Statement Details

400

Bad request

401

Unauthorized

500

Server Error

post/api/{version}/statements/getstatement

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
"statement_cycle_start_date": "2019-08-24T14:15:22Z",
"statement_cycle_end_date": "2019-08-24T14:15:22Z",
"show_txns": true,
"show_subprograms": true,
"format": "JSON"
}

Response samples

application/json

{"consolidated_statement_summary": {"program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
"amount_due": 0,
"credit_limit": 0,
"available_credit": 0,
"opening_balance": 0,
"purchases": 0,
"other_credits": 0,
"payments": 0,
"current_cycle_payments": 0,
"closing_balance": 0,
"outstanding_statement_amount": 0,
"other_debits": 0,
"cash_withdrawal": 0,
"fees": 0,
"payments_pending_settlement": 0
},
"statement_details": [{"program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
"parent_program_guid": "4c73d8e3-85f7-42e5-9a39-2376fdcc4881",
"program_short_name": "string",
"program_name": "string",
"company_dba_name": "string",
"company_short_name": "string",
"billing_date": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"amount_due": 0,
"credit_limit": 0,
"available_credit": 0,
"number_of_billing_cycle_days": 0,
"opening_balance": 0,
"purchases": 0,
"other_credits": 0,
"payments": 0,
"current_cycle_payments": 0,
"closing_balance": 0,
"outstanding_statement_amount": 0,
"other_debits": 0,
"cash_withdrawal": 0,
"fees": 0,
"current_payment_due": 0,
"past_due_amount": 0,
"txn_date": "2019-08-24T14:15:22Z",
"amount": 0,
"schedule_status": "string",
"instrument_number_mask": "string",
"frequency": "string",
"next_auto_payment_date": "2019-08-24T14:15:22Z",
"payments_pending_settlement": 0,
"program_txns": [{"txn_type": "string",
"account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
"post_date": "2019-08-24T14:15:22Z",
"txn_date": "2019-08-24T14:15:22Z",
"reference_number": "string",
"txn_description": "string",
"txn_amount": 0
}
]
}
]
}