Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
Capture

Book form data

Retrieve data for all forms uploaded to a <glossary:Book>.

A detailed description of the response can be found on the form data data type definition.

get/v1/book/forms

Query parameters

book_uuidstring

The unique identifier of the <glossary:Book> that contains the form data. Mutually exclusive with pk.

pkstring

The <glossary:PK> of the <glossary:Book> that contains the form data. Mutually exclusive with book_uuid.

Response

Success

statusinteger

A numerical code that indicates the status of the request.

messagestring

A textual description that indicates details about this response's status.

Example response

{
  "status": 200,
  "response": {
    "pk": 133771,
    "uuid": "988a30fe-d25e-40b4-9724-f4c06bacbab5",
    "name": "Example Book",
    "created": "2023-03-29T18:45:04Z",
    "created_ts": "2023-03-29T18:45:04Z",
    "verified_pages_count": 6,
    "book_status": "ACTIVE",
    "id": 133771,
    "forms": [
      {
        "pk": 12304,
        "uuid": "e6d7d3c7-444c-4cf3-99c7-65bdabb309f9",
        "uploaded_doc_pk": 1555125,
        "form_type": "ACCOUNT_SUMMARY",
        "raw_fields": {
          "examplefield:field_name": {
            "value": "1379.82",
            "source_filename": "simple_bank_statement.pdf",
            "subfields": {
              "value": "1379.82",
              "source_filename": "simple_bank_statement.pdf"
            }
          }
        },
        "form_config_pk": 1013,
        "tables": [],
        "attribute_data": {
          "period_pk": 101948
        }
      }
    ],
    "book_is_complete": true
  },
  "message": "OK"
}