/income-statements/{id}

GET

/accounting/v1/income-statements/:id

GET

/api/accounting/v1/income-statements/:id

$ curl -G https://api.merge.dev/api/accounting/v1/income-statements/id \
>      -H "X-Account-Token: X-Account-Token" \
>      -H "Authorization: Bearer <token>" \
>      -d expand=company

200Retrieved

1 {
2   "id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
3   "remote_id": "1342348",
4   "created_at": "2021-09-15T00:00:00Z",
5   "modified_at": "2021-10-16T00:00:00Z",
6   "name": "IncomeStatement",
7   "currency": "USD",
8   "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
9   "start_period": "2024-01-15T09:30:00Z",
10   "end_period": "2024-01-15T09:30:00Z",
11   "income": [
12     {
13       "remote_id": "10299",
14       "name": "Total Income",
15       "value": 325,
16       "sub_items": [
17         {
18           "name": "Landscaping Services",
19           "remote_id": "10200",
20           "sub_items": [],
21           "value": 425
22         },
23         {
24           "name": "Pest Control Services",
25           "remote_id": "10201",
26           "sub_items": [],
27           "value": -100
28         }
29       ]
30     }
31   ],
32   "cost_of_sales": [
33     {
34       "remote_id": "10299",
35       "name": "Total COGS",
36       "value": 25,
37       "sub_items": [
38         {
39           "name": "Supplies",
40           "remote_id": "10200",
41           "sub_items": [],
42           "value": 10
43         }
44       ]
45     }
46   ],
47   "gross_profit": 300,
48   "operating_expenses": [
49     {
50       "remote_id": "10299",
51       "name": "Total Operating Expenses",
52       "value": 100,
53       "sub_items": []
54     }
55   ],
56   "net_operating_income": 200,
57   "non_operating_expenses": [
58     {
59       "remote_id": "10299",
60       "name": "Total Non-Operating Expenses",
61       "value": 100,
62       "sub_items": []
63     }
64   ],
65   "net_income": 100,
66   "remote_was_deleted": true,
67   "field_mappings": {
68     "organization_defined_targets": {
69       "custom_key": "custom_value"
70     },
71     "linked_account_defined_targets": {
72       "custom_key": "custom_value"
73     }
74   },
75   "remote_data": [
76     {
77       "path": "/actions",
78       "data": null
79     }
80   ]
81 }

Returns an IncomeStatement object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandlist of enumsOptional

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

idstringOptionalRead-onlyformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only

The datetime that this object was created by Merge.

modified_atdatetimeOptionalRead-only

The datetime that this object was modified by Merge.

namestring or nullOptional

The income statement's name.

currencyenum or nullOptional

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

companystring or nullOptionalformat: "uuid"

The company the income statement belongs to.

start_perioddatetime or nullOptional

The income statement's start period.

end_perioddatetime or nullOptional

The income statement's end period.

incomelist of objectsOptionalRead-only

cost_of_saleslist of objectsOptionalRead-only

gross_profitdouble or nullOptional

The revenue minus the cost of sale.

operating_expenseslist of objectsOptionalRead-only

net_operating_incomedouble or nullOptional

The revenue minus the operating expenses.

non_operating_expenseslist of objectsOptionalRead-only

net_incomedouble or nullOptional

The gross profit minus the total expenses.

remote_was_deletedbooleanOptionalRead-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 nullOptionalRead-only

remote_datalist of objects or nullOptionalRead-only