v1
latestOpenAPI 3.0.02026-07-2482421001.1 KBBook Queries
Book information
Retrieve details of a <glossary:Book>, including uploaded <glossary:Document>s, bank account information, and transaction periods.
get/v1/book/info
Query parameters
book_uuidstring uuid
The unique identifier of the <glossary:Book> whose information you want to retrieve. Mutually exclusive with book_pk.
pkstring
Unique primary key (pk) of the <glossary:Book> whose information you want to retrieve. Mutually exclusive with book_uuid.
Response
Success
Example response
{
"status": 200,
"response": {
"created": "2023-03-03T04:36:31Z",
"created_ts": "2023-03-03T04:36:31Z",
"pk": 133771,
"owner_email": "email@address.com",
"is_public": true,
"book_uuid": "19aab921-25a5-4beb-a59e-ac72320061d6",
"id": 30219565,
"xid": "123ABC",
"book_type": "DEFAULT",
"is_shared_or_public_book": true,
"bank_accounts": [
{
"bank_name": "CHASE",
"activity_info": [
{
"active": [
{
"start": [
{
"year": 2022,
"month": 9,
"day": 10
}
],
"end": [
{
"year": 2020,
"month": 9,
"day": 10
}
]
}
]
}
],
"account_type": "CHECKING",
"account_holder": "JILL SMITH",
"holder_country": "US",
"holder_state": "NY",
"holder_city": "New York",
"holder_address_1": "74 Prospect Park",
"holder_address_2": "West Park Slope",
"account_category": "PERSONAL ACCOUNT",
"periods": [
{
"uuid": "c283613c-d20a-4aac-b8b3-5dfd608ba111",
"bank_account_pk": 12942296,
"begin_date": "09/10/2020",
"end_date": "09/10/2022",
"primary_recon_error_reason": "File Tampering Detected",
"secondary_recon_error_reason": "Tampering on pages 1, 3, 4, and 5"
}
],
"account_holders": "JILL'S COFFEE",
"status_tags": {
"status_tag": {
"pk": 2386480,
"created_ts": "2022-06-28T14:15:18Z",
"tag_name": "rev_exclude",
"color": "navy",
"is_status_tag": true,
"id": 2386480
}
}
}
]
},
"message": "Ok"
}