/income-statements/{id}

from merge import Merge
client = Merge(
    account_token="YOUR_ACCOUNT_TOKEN",
    api_key="YOUR_API_KEY",
)
client.accounting.income_statements.retrieve(
    id="id",
)

{
  "id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
  "remote_id": "1342348",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
  "name": "IncomeStatement",
  "currency": "USD",
  "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
  "start_period": "2024-01-15T09:30:00Z",
  "end_period": "2024-01-15T09:30:00Z",
  "income": [
    {
      "remote_id": "10299",
      "name": "Total Income",
      "value": 325,
      "sub_items": [
        {
          "remote_id": "10200",
          "name": "Landscaping Services",
          "value": 425,
          "sub_items": []
        },
        {
          "remote_id": "10201",
          "name": "Pest Control Services",
          "value": -100,
          "sub_items": []
        }
      ]
    }
  ],
  "cost_of_sales": [
    {
      "remote_id": "10299",
      "name": "Total COGS",
      "value": 25,
      "sub_items": [
        {
          "remote_id": "10200",
          "name": "Supplies",
          "value": 10,
          "sub_items": []
        }
      ]
    }
  ],
  "gross_profit": 300,
  "operating_expenses": [
    {
      "remote_id": "10299",
      "name": "Total Operating Expenses",
      "value": 100,
      "sub_items": []
    }
  ],
  "net_operating_income": 200,
  "non_operating_expenses": [
    {
      "remote_id": "10299",
      "name": "Total Non-Operating Expenses",
      "value": 100,
      "sub_items": []
    }
  ],
  "net_income": 100,
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  },
  "remote_data": [
    {
      "path": "/actions"
    }
  ]
}

Returns an IncomeStatement object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandenumOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

Allowed values:

include_remote_databooleanOptional

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

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

idstringRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only

The datetime that this object was created by Merge.

modified_atdatetimeRead-only

The datetime that this object was modified by Merge.

namestring or null

The income statement's name.

currencyenum or null

The income statement's currency. The currency code in ISO 4217 format.

companystring or nullformat: "uuid"

The company the income statement belongs to.

start_perioddatetime or null

The income statement's start period.

end_perioddatetime or null

The income statement's end period.

incomelist of objectsRead-only

cost_of_saleslist of objectsRead-only

gross_profitdouble or null

The revenue minus the cost of sale.

operating_expenseslist of objectsRead-only

net_operating_incomedouble or null

The revenue minus the operating expenses.

non_operating_expenseslist of objectsRead-only

net_incomedouble or null

The gross profit minus the total expenses.

remote_was_deletedbooleanRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullRead-only

remote_datalist of objects or nullRead-only

Authentication

Path parameters

Headers

Query parameters

Response