Skip to Content
BusinessChecksReports

Retrieve the Undeposited Checks Report

GET
/v0/business/{business_id}/reports/undeposited-checks

Checks received on or before the as-of date that were not deposited, voided or returned by the end of that day. A check counts as deposited on the date of the bank Transaction matched to it. Their total ties to the Undeposited Funds balance at the end of the day.

Scopes: report:read

Authorization

OAuth2ClientCredentialsBearer report:read
headerAuthorizationBearer <token>

Scope: report:read

Path Parameters

business_id*Business Id

The id of the business

Formatbiz_string

Query Parameters

as_of?|

The date the report is as of, inclusive. Defaults to today.

Response Body

Successful Response

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.sandbox.getasset.com/v0/business/biz_GA6EG2qFxA97NZHtxeLPUy/reports/undeposited-checks'
Example Response
{  "data": {    "as_of": "2019-08-24",    "currency": "USD",    "checks": [      {        "received_check_id": "rck_WQMDNUHpBThYSNh4AprDBo",        "check_number": "2207",        "received_at": "2019-08-24T14:15:22Z",        "payer": "Acme Corp",        "customer_id": "cus_WQMDNUHpBThYSNh4AprDBo",        "amount": 400,        "invoice_ids": [          "inv_Lq5AyApd4pdL1VvakpY5aJ"        ],        "days_held": 2      }    ],    "total": 650,    "undeposited_funds_balance": 650,    "difference": 0  }}