Income Statements

The IncomeStatement object is used to represent a company's income statements.

The IncomeStatement object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

nameString
Optional
The income statement's name.

start_periodString
Optional
The income statement's start period.

end_periodString
Optional
The income statement's end period.

incomeReportItem[]
Required

The ReportItem object

The ReportItem object is used to represent a report item for a Balance Sheet, Cash Flow Statement or Profit and Loss Report.
{
"remote_id": "10299",
"name": "Revenue",
"value": 1000,
"sub_items": [
{
"remote_id": "10300",
"name": "Revenue - San Francisco",
"value": 500,
"sub_items": []
},
{
"remote_id": "10301",
"name": "Revenue - New York",
"value": 500,
"sub_items": []
}
]
}

Properties


remote_idString
Optional
The third-party API ID of the matching object.

nameString
Optional
The report item's name.

valueNumber
Optional
The report item's value.

sub_itemsObject
Required

cost_of_salesReportItem[]
Required

The ReportItem object

The ReportItem object is used to represent a report item for a Balance Sheet, Cash Flow Statement or Profit and Loss Report.
{
"remote_id": "10299",
"name": "Revenue",
"value": 1000,
"sub_items": [
{
"remote_id": "10300",
"name": "Revenue - San Francisco",
"value": 500,
"sub_items": []
},
{
"remote_id": "10301",
"name": "Revenue - New York",
"value": 500,
"sub_items": []
}
]
}

Properties


remote_idString
Optional
The third-party API ID of the matching object.

nameString
Optional
The report item's name.

valueNumber
Optional
The report item's value.

sub_itemsObject
Required

gross_profitNumber
Optional
The income statement's gross profit.

operating_expensesReportItem[]
Required

The ReportItem object

The ReportItem object is used to represent a report item for a Balance Sheet, Cash Flow Statement or Profit and Loss Report.
{
"remote_id": "10299",
"name": "Revenue",
"value": 1000,
"sub_items": [
{
"remote_id": "10300",
"name": "Revenue - San Francisco",
"value": 500,
"sub_items": []
},
{
"remote_id": "10301",
"name": "Revenue - New York",
"value": 500,
"sub_items": []
}
]
}

Properties


remote_idString
Optional
The third-party API ID of the matching object.

nameString
Optional
The report item's name.

valueNumber
Optional
The report item's value.

sub_itemsObject
Required

net_operating_incomeNumber
Optional
The income statement's net operating profit.

non_operating_expensesReportItem[]
Required

The ReportItem object

The ReportItem object is used to represent a report item for a Balance Sheet, Cash Flow Statement or Profit and Loss Report.
{
"remote_id": "10299",
"name": "Revenue",
"value": 1000,
"sub_items": [
{
"remote_id": "10300",
"name": "Revenue - San Francisco",
"value": 500,
"sub_items": []
},
{
"remote_id": "10301",
"name": "Revenue - New York",
"value": 500,
"sub_items": []
}
]
}

Properties


remote_idString
Optional
The third-party API ID of the matching object.

nameString
Optional
The report item's name.

valueNumber
Optional
The report item's value.

sub_itemsObject
Required

net_incomeNumber
Optional
The income statement's net income.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted on the third-party.

The IncomeStatement object
JSON
{
"id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"remote_id": "1342348",
"name": "IncomeStatement",
"start_period": "2022-05-19T19:23:43.762Z",
"end_period": "2022-05-19T19:23:43.763Z",
"income": [
{
"remote_id": "10299",
"name": "Total Income",
"value": 325,
"sub_items": [
{
"remote_id": "10200",
"name": "Landscaping Services",
"value": 425,
"sub_items": null
},
{
"remote_id": "10201",
"name": "Pest Control Services",
"value": -100,
"sub_items": null
}
]
}
],
"cost_of_sales": [
{
"remote_id": "10299",
"name": "Total COGS",
"value": 25,
"sub_items": [
{
"remote_id": "10200",
"name": "Supplies",
"value": 10,
"sub_items": null
}
]
}
],
"gross_profit": 300,
"operating_expenses": [
{
"remote_id": "10299",
"name": "Total Operating Expenses",
"value": 100,
"sub_items": null
}
],
"net_operating_income": 200,
"non_operating_expenses": [
{
"remote_id": "10299",
"name": "Total Non-Operating Expenses",
"value": 100,
"sub_items": null
}
],
"net_income": 100,
"remote_was_deleted": true
}

GET

/income-statements

Returns a list of IncomeStatement objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
Whether to include data that was deleted in the third-party service.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"remote_id": "1342348",
"name": "IncomeStatement",
"start_period": "2022-05-19T19:23:43.769Z",
"end_period": "2022-05-19T19:23:43.769Z",
"income": [
{
"remote_id": "10299",
"name": "Total Income",
"value": 325,
"sub_items": [
{
"remote_id": "10200",
"name": "Landscaping Services",
"value": 425,
"sub_items": null
},
{
"remote_id": "10201",
"name": "Pest Control Services",
"value": -100,
"sub_items": null
}
]
}
],
"cost_of_sales": [
{
"remote_id": "10299",
"name": "Total COGS",
"value": 25,
"sub_items": [
{
"remote_id": "10200",
"name": "Supplies",
"value": 10,
"sub_items": null
}
]
}
],
"gross_profit": 300,
"operating_expenses": [
{
"remote_id": "10299",
"name": "Total Operating Expenses",
"value": 100,
"sub_items": null
}
],
"net_operating_income": 200,
"non_operating_expenses": [
{
"remote_id": "10299",
"name": "Total Non-Operating Expenses",
"value": 100,
"sub_items": null
}
],
"net_income": 100,
"remote_was_deleted": true
}
]
}
GET

/income-statements/{id}

Returns an IncomeStatement object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
"id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"remote_id": "1342348",
"name": "IncomeStatement",
"start_period": "2022-05-19T19:23:43.774Z",
"end_period": "2022-05-19T19:23:43.774Z",
"income": [
{
"remote_id": "10299",
"name": "Total Income",
"value": 325,
"sub_items": [
{
"remote_id": "10200",
"name": "Landscaping Services",
"value": 425,
"sub_items": null
},
{
"remote_id": "10201",
"name": "Pest Control Services",
"value": -100,
"sub_items": null
}
]
}
],
"cost_of_sales": [
{
"remote_id": "10299",
"name": "Total COGS",
"value": 25,
"sub_items": [
{
"remote_id": "10200",
"name": "Supplies",
"value": 10,
"sub_items": null
}
]
}
],
"gross_profit": 300,
"operating_expenses": [
{
"remote_id": "10299",
"name": "Total Operating Expenses",
"value": 100,
"sub_items": null
}
],
"net_operating_income": 200,
"non_operating_expenses": [
{
"remote_id": "10299",
"name": "Total Non-Operating Expenses",
"value": 100,
"sub_items": null
}
],
"net_income": 100,
"remote_was_deleted": true
}