Skip to main content
POST
/
v1
/
bank-statements
/
{bank_statement_id}
Update A Bank Statement
curl --request POST \
  --url http://api.stuut.ai/v1/bank-statements/{bank_statement_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account": "<string>"
}
'
{
  "object": "<string>",
  "id": "<string>",
  "account_id": "<string>",
  "agent_confidence_reason": "<string>",
  "agent_confidence_score": 123,
  "agent_error_code": "<string>",
  "agent_uncertainties": [
    "<string>"
  ],
  "approver_id": "<string>",
  "attachment": {
    "file_type": "audio",
    "mime_type": "<string>",
    "name": "<string>",
    "object": "<string>",
    "organization_id": "<string>",
    "id": "<string>",
    "content_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "disposition": "<string>",
    "is_verified": true,
    "modified_at": "2023-11-07T05:31:56Z",
    "presigned_url": "<string>",
    "presigned_url_expires_at": "2023-11-07T05:31:56Z",
    "purpose": "<string>",
    "remote_id": "<string>",
    "size": 123,
    "src": "<unknown>",
    "user_id": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "parsed_transaction_data": "<unknown>",
  "period_end": "2023-12-25",
  "period_start": "2023-12-25",
  "status": "submitted",
  "transactions": [
    {
      "account_id": "<string>",
      "amount": 123,
      "object": "<string>",
      "posted": true,
      "reference_number": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "type": "deposit",
      "id": "<string>",
      "account_mask": "<unknown>",
      "authorized_at": "2023-11-07T05:31:56Z",
      "check_number": "<string>",
      "counterparty_email": "<string>",
      "counterparty_logo": "<string>",
      "counterparty_name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "ADP",
      "currency_rate": 123,
      "custom_fields": "<unknown>",
      "description": "<string>",
      "description_details": "<unknown>",
      "invoice_numbers": [
        "<string>"
      ],
      "is_draft": true,
      "last_synced_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "partner": {
        "id": "<string>",
        "account_number": "<string>",
        "ap_portals": [
          {
            "object": "<string>",
            "partner_id": "<string>",
            "id": "<string>",
            "account": {
              "object": "<string>",
              "organization_id": "<string>",
              "provider": "coupa",
              "id": "<string>",
              "available_operations": "<unknown>",
              "created_at": "2023-11-07T05:31:56Z",
              "modified_at": "2023-11-07T05:31:56Z"
            },
            "account_id": "<string>",
            "account_key": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "customer_identifier": "<string>",
            "customer_name": "<string>",
            "invoice_submission_guidelines": "<string>",
            "is_enabled": true,
            "is_invoice_submission_enabled": true,
            "is_report_download_enabled": true,
            "modified_at": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "provider": "coupa",
            "report_email": "<string>",
            "report_frequency": "daily"
          }
        ],
        "assignee": {
          "email": "<string>",
          "family_name": "<string>",
          "given_name": "<string>",
          "object": "<string>",
          "organization_id": "<string>",
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "dashboard_settings": {
            "thread_emails_sort_order": "asc"
          },
          "default_email_sender_id": "<string>",
          "invited_by_user_id": "<string>",
          "is_access_approved": true,
          "is_org_admin": true,
          "modified_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "onboarding_required": true,
          "profile_picture": "<string>",
          "selected": true
        },
        "assignee_id": "<string>",
        "billing_address": {
          "object": "<string>",
          "city": "<string>",
          "coordinates": {},
          "country": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "line1": "<string>",
          "line2": "<string>",
          "modified_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "phone": "<string>",
          "postal_code": "<string>",
          "remote_id": "<string>",
          "state": "<string>",
          "type": "<string>"
        },
        "billing_address_id": 123,
        "contacts": [
          {
            "email": "<string>",
            "object": "<string>",
            "partner_id": "<string>",
            "id": "<string>",
            "address": {
              "object": "<string>",
              "city": "<string>",
              "coordinates": {},
              "country": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "line1": "<string>",
              "line2": "<string>",
              "modified_at": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "phone": "<string>",
              "postal_code": "<string>",
              "remote_id": "<string>",
              "state": "<string>",
              "type": "<string>"
            },
            "address_id": 123,
            "addresses": [
              {
                "object": "<string>",
                "id": "<string>",
                "city": "<string>",
                "coordinates": {},
                "country": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "description": "<string>",
                "is_primary": true,
                "line1": "<string>",
                "line2": "<string>",
                "modified_at": "2023-11-07T05:31:56Z",
                "name": "<string>",
                "postal_code": "<string>",
                "state": "<string>",
                "type": "<string>"
              }
            ],
            "created_at": "2023-11-07T05:31:56Z",
            "custom_fields": "<unknown>",
            "external_role": "billing_contact",
            "family_name": "<string>",
            "given_name": "<string>",
            "internal_role": "account_manager",
            "is_email_disabled": true,
            "is_phone_disabled": true,
            "is_primary": true,
            "is_primary_email": true,
            "is_primary_phone": true,
            "job_title": "<string>",
            "modified_at": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "phone": "<string>",
            "remote_created_at": "2023-11-07T05:31:56Z",
            "remote_id": "<string>",
            "remote_metadata": "<unknown>",
            "remote_modified_at": "2023-11-07T05:31:56Z",
            "status_metadata": "<unknown>"
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "currency": "ADP",
        "custom_fields": "<unknown>",
        "description": "<string>",
        "email": "<string>",
        "family_name": "<string>",
        "finix_identity_id": "<string>",
        "given_name": "<string>",
        "invoice_prefix": "<string>",
        "is_active": true,
        "is_company": true,
        "is_email_disabled": true,
        "is_phone_disabled": true,
        "is_primary_email": true,
        "is_primary_phone": true,
        "last_outreach_at": "2023-11-07T05:31:56Z",
        "last_outreach_channel": "email",
        "last_outreach_to": "<string>",
        "last_synced_at": "2023-11-07T05:31:56Z",
        "legal_name": "<string>",
        "linked_integration": {
          "integration_name": "<string>",
          "is_configured": true,
          "object": "<string>",
          "settings": {},
          "id": "<string>",
          "api_subdomain": "<string>",
          "api_url": "<string>",
          "connection_info": "<unknown>",
          "created_at": "2023-11-07T05:31:56Z",
          "credentials_expire_at": "2023-11-07T05:31:56Z",
          "health": {
            "status": "incomplete",
            "details": null,
            "message": null,
            "reason": null
          },
          "identity_info": "<unknown>",
          "integration": {
            "display_name": "<string>",
            "name": "<string>",
            "object": "<string>",
            "api_base_url": "<string>",
            "api_documentation_url": null,
            "api_requires_subdomain": false,
            "auth_type": null,
            "categories": [
              "accounting"
            ],
            "color": null,
            "connection_guide_url": null,
            "connection_instructions": null,
            "connection_steps": [
              {
                "type": "fetch",
                "title": "<string>",
                "description": null,
                "endpoint": null,
                "fields": null,
                "post_auth": false
              }
            ],
            "created_at": "2023-11-07T05:31:56Z",
            "description": null,
            "is_enabled": true,
            "logo": null,
            "logo_square": null,
            "modified_at": "2023-11-07T05:31:56Z",
            "settings": [
              {
                "key": "<string>",
                "type": "any",
                "choices": null,
                "description": null,
                "format": "text",
                "group": null,
                "guide_url": null,
                "is_editable": false,
                "is_required": true,
                "is_select": false,
                "label": null,
                "post_auth": false,
                "requires_load": false
              }
            ],
            "short_description": null
          },
          "is_running_setup": true,
          "is_sync_disabled": true,
          "is_webhooks_enabled": true,
          "models": [
            {
              "integration_schema_id": "<string>",
              "linked_integration_id": "<string>",
              "name": "<string>",
              "object": "<string>",
              "id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "exclude_rule": {},
              "field_mappings": "<unknown>",
              "health": {
                "status": "incomplete",
                "details": null,
                "message": null,
                "reason": null
              },
              "is_read_enabled": true,
              "is_webhooks_setup": true,
              "is_write_enabled": true,
              "last_sync": {
                "linked_model_id": "<string>",
                "object": "<string>",
                "run_id": "<string>",
                "id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "entity_id": "<string>",
                "is_initial_sync": true,
                "is_one_off": true,
                "modified_at": "2023-11-07T05:31:56Z",
                "pagination": "<unknown>",
                "run": {
                  "object": "<string>",
                  "id": "<string>",
                  "completed_at": "2023-11-07T05:31:56Z",
                  "created_at": "2023-11-07T05:31:56Z",
                  "data": "<unknown>",
                  "event_id": "<string>",
                  "modified_at": "2023-11-07T05:31:56Z",
                  "output": "<unknown>",
                  "remote_id": "<string>",
                  "stacktrace": "<string>",
                  "started_at": "2023-11-07T05:31:56Z",
                  "status": "scheduled"
                },
                "timerange_end": "2023-11-07T05:31:56Z",
                "timerange_start": "2023-11-07T05:31:56Z"
              },
              "last_sync_id": "<string>",
              "modified_at": "2023-11-07T05:31:56Z",
              "next_sync_at": "2023-11-07T05:31:56Z",
              "sync_requested": true
            }
          ],
          "modified_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "owner_id": "<string>",
          "requires_setup": true,
          "username": "<string>",
          "webhook_listener_url": "<string>",
          "webhook_setup_error": "<string>"
        },
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "object": "<string>",
        "on_behalf_of": "<string>",
        "on_behalf_of_phone": "<string>",
        "organization_id": "<string>",
        "parent_id": "<string>",
        "phone": "<string>",
        "remote_created_at": "2023-11-07T05:31:56Z",
        "remote_id": "<string>",
        "remote_metadata": "<unknown>",
        "remote_modified_at": "2023-11-07T05:31:56Z",
        "remote_parent_id": "<string>",
        "remote_payment_portal_url": "<string>",
        "shipping_address": {
          "object": "<string>",
          "city": "<string>",
          "coordinates": {},
          "country": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "line1": "<string>",
          "line2": "<string>",
          "modified_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "phone": "<string>",
          "postal_code": "<string>",
          "remote_id": "<string>",
          "state": "<string>",
          "type": "<string>"
        },
        "status_metadata": "<unknown>",
        "sync_status": "partial",
        "tags": [
          {
            "object": "<string>",
            "partner_id": "<string>",
            "tag_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "is_manual": true,
            "modified_at": "2023-11-07T05:31:56Z",
            "tag": {
              "name": "<string>",
              "object": "<string>",
              "id": "<string>",
              "color": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "modified_at": "2023-11-07T05:31:56Z",
              "rule_condition": {}
            }
          }
        ],
        "tax_number": "<string>",
        "timezone": "Africa/Abidjan"
      },
      "partner_id": "<string>",
      "payment_method": "ach",
      "remote_created_at": "2023-11-07T05:31:56Z",
      "remote_id": "<string>",
      "remote_metadata": "<unknown>",
      "remote_modified_at": "2023-11-07T05:31:56Z",
      "statement_id": "<string>",
      "sync_status": "partial",
      "transaction_code": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
bank_statement_id
string
required

Body

application/json
​
account
string

The BankAccount identifier, (e.g. bnka_abc123).

Response

Successful response

​
object
string
required
​
id
string
Maximum string length: 32
​
account_id
string | null
Maximum string length: 32
​
agent_confidence_reason
string | null

The justification for the agent's confidence score.

​
agent_confidence_score
integer | null

The confidence score of the result on a scale of 0-100, where 0 indicates no confidence in the accuracy of the result and 100 indicates full confidence in the accuracy of the result.

​
agent_error_code
string | null

The code for why an error occurred when processing the statement.

​
agent_uncertainties
string[]

A list of uncertainties we have regarding the result.

​
approver_id
string | null
Maximum string length: 32
​
attachment
object
​
created_at
string<date-time>
​
modified_at
string<date-time> | null
​
parsed_transaction_data
unknown
​
period_end
string<date> | null

The statement period's end date.

​
period_start
string<date> | null

The statement period's start date.

​
status
enum<string>

The status of this upload.

Available options:
submitted,
processing,
invalid,
pending_approval,
approved
Maximum string length: 16
​
transactions
object[]