Fetch entity summary

GET 
/v1/entities/:entity_id/summary

A dictionary with a data property that contains an array of summaries broken down by report and currency. Each entry in the array is a separate report-summary object. If no reports are available, the resulting array will be empty.

Date range behavior

• If from_date and to_date are missing, the default is to return the previous 30 days.
• If from_date is present but to_date is not, to_date is set to from_date+30.days.
• If to_date is present but from_date is not, from_date is set to to_date-30.days. Authentication

Request

Path Parameters

entity_id stringrequired

Unique identifier for the entity.

Query Parameters

from_date string

Beginning of date range in format YYYY-MM-DD.

to_date string

End of date range in format YYYY-MM-DD.

currency string

Three-letter ISO currency code. ex: USD.

report string

Report name. ex: shopify_summary.

state string

Filter by state. ex: posted, unposted.

Responses

200

A dictionary with a data property that contains an array of summaries broken down by report and currency. Each entry in the array is a separate report-summary object. If no reports are available, the resulting array will be empty.

application/json

Schema

Schema

object stringrequired

Default value: list

data object[]
Array [
report stringrequired
connection_ids string[]required
Array of Unique identifier for each connected app.
lines object[]
Array [
description stringrequired
account_type stringrequired
posting_type stringrequired
total doublerequired
subcategories object
property name* doublerequired
currency stringrequired
]
metadata object
from_date daterequired
to_date daterequired
day_count integerrequired
record_count integerrequired
posted integerrequired
unposted integerrequired
failed integerrequired
missing object
count integerrequired
dates date[]required
]

Example (from schema)

{
  "object": "list",
  "data": [
    {
      "report": "shopify_ecommerce",
      "connection_ids": [
        "d58AGp7e1jVK"
      ],
      "lines": [
        {
          "description": "Square Sales",
          "account_type": "Income",
          "posting_type": "Credit",
          "total": 50424.75,
          "subcategories": {
            "Cash": 2513.7,
            "Credit Card": 47911.05,
            "JT-Red Wine": 1024.7,
            "JT-Spirits": 487.78
          },
          "currency": "USD"
        }
      ],
      "metadata": {
        "from_date": "2024-05-17",
        "to_date": "2024-06-16",
        "day_count": 31,
        "record_count": 30,
        "posted": 30,
        "unposted": 0,
        "failed": 0,
        "missing": {
          "count": 6,
          "dates": [
            "2024-05-22",
            "2024-05-23",
            "2024-05-24",
            "2024-05-25",
            "2024-06-11",
            "2024-06-12"
          ]
        }
      }
    }
  ]
}

401

HTTP Basic: Access denied.

404

Returns an error if a invalid entity was provided.

application/json

Schema

Schema

error object
message stringrequired
type stringrequired

Example (from schema)

{
  "error": {
    "message": "Unrecognized request URL",
    "type": "invalid_request_error"
  }
}

Loading...