Skip to main content

Fetch connection summary

GET 

/v1/entities/:entity_id/connections/: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.

    id stringrequired

    Unique identifier for the connection.

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

A dictionary with a data property that contains an array of summaries for the specified connection, 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.

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
  • ]
Loading...