Get Bank Statement sets

GET 
/api/v8/partner/bank-statements-set

Get Bank Statement sets

Request

Responses

200

A list of previously processed Bank Statement sets.

application/json

Schema

Schema

count integerrequired

The total number of results retrieved across all pages.

next string

The URL to the next page of results.

previous string

The URL to the previous page of results.

results object[]required
The collection of Document identifiers processed by the PDF Splitter.
Array [
id integerrequired
The unique identifier of the collections of processed documents.
document_ids integer[]
The unique identifiers of the documents created from processed PDF Splitter.
status stringrequired
Possible values: [processed, in_progress, deleted, failed]
page_breaks object[]
A list of page breaks to split a document. Each object defines what pages to use to create a new document.
Array [
page_start integerrequired
Possible values: > 0
Page start
page_end integerrequired
Possible values: > 0
]
]

Example (from schema)

{
  "count": 0,
  "next": "string",
  "previous": "string",
  "results": [
    {
      "id": 0,
      "document_ids": [
        0
      ],
      "status": "processed",
      "page_breaks": [
        {
          "page_start": 0,
          "page_end": 0
        }
      ]
    }
  ]
}

Loading...