--- title: "Get Profit and Loss" method: GET path: "/accounting/profit-and-loss" tags: ["Profit and Loss"] --- # Get Profit and Loss `GET /accounting/profit-and-loss` Get Profit and Loss ## Query parameters - `raw` boolean - `filter` ProfitAndLossFilter - `customer_id` string — Filter by customer id - `start_date` string — Filter by start date. If start date is given, end date is required. - `end_date` string — Filter by end date. If end date is given, start date is required. - `location_id` string — Filter by location id - `accounting_method` 'cash' | 'accrual' — The accounting method used for the report: cash or accrual. - `pass_through` PassThroughQuery - `example_downstream_property` string — All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads) - `fields` string, nullable ## Headers - `x-apideck-consumer-id` string, required - `x-apideck-app-id` string, required - `x-apideck-service-id` string - `x-apideck-company-id` string ## Response `200` Profit & Loss Report - GetProfitAndLossResponse - `status_code` integer, required — HTTP Response Status Code - `status` string, required — HTTP Response Status - `service` string, required — Apideck ID of service provider - `resource` string, required — Unified API resource name - `operation` string, required — Operation performed - `data` ProfitAndLoss, required - `id` string — A unique identifier for an object. - `report_name` string, required — The name of the report - `start_date` string — The start date of the report - `end_date` string — The end date of the report - `currency` 'UNKNOWN_CURRENCY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRC' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' | 'ETH', nullable — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - `income` object, required — The operating income accounts - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `total` number, nullable, required — The aggregated total of all accounts within this category. - `records` union[], nullable, required - union - ProfitAndLossSection - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `total` number, nullable, required — The aggregated total of all accounts within this category. - `records` ProfitAndLossRecords — recursive - ProfitAndLossRecord - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `value` number - `total` number, nullable, required — The total amount of the transaction or record - `cost_of_goods_sold` object — The cost of goods sold accounts - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `total` number, nullable — The aggregated total of all accounts within this category. - `records` union[], nullable, required - union - ProfitAndLossSection - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `total` number, nullable, required — The aggregated total of all accounts within this category. - `records` ProfitAndLossRecords — recursive - ProfitAndLossRecord - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `value` number - `total` number, nullable, required — The total amount of the transaction or record - `expenses` object, required — The operating expenses accounts - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `total` number, nullable, required — The aggregated total of all accounts within this category. - `records` union[], nullable, required - union - ProfitAndLossSection - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `total` number, nullable, required — The aggregated total of all accounts within this category. - `records` ProfitAndLossRecords — recursive - ProfitAndLossRecord - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `value` number - `total` number, nullable, required — The total amount of the transaction or record - `other_income` object — The other income accounts - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `total` number, nullable — The aggregated total of all accounts within this category. - `records` union[], nullable, required - union - ProfitAndLossSection - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `total` number, nullable, required — The aggregated total of all accounts within this category. - `records` ProfitAndLossRecords — recursive - ProfitAndLossRecord - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `value` number - `total` number, nullable, required — The total amount of the transaction or record - `other_expenses` object — The other expenses accounts - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `total` number, nullable — The aggregated total of all accounts within this category. - `records` union[], nullable, required - union - ProfitAndLossSection - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `total` number, nullable, required — The aggregated total of all accounts within this category. - `records` ProfitAndLossRecords — recursive - ProfitAndLossRecord - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `value` number - `total` number, nullable, required — The total amount of the transaction or record - `uncategorized_accounts` object — The accounts not categorized in the other sections - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `total` number, nullable, required — The aggregated total of all accounts within this category. - `records` union[], nullable, required - union - ProfitAndLossSection - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `total` number, nullable, required — The aggregated total of all accounts within this category. - `records` ProfitAndLossRecords — recursive - ProfitAndLossRecord - `id` string — A unique identifier for an object. - `code` string — The account code of the account - `title` string — The name of the account. - `type` 'Section' | 'Record', nullable — The type of profit and loss - `value` number - `total` number, nullable, required — The total amount of the transaction or record - `gross_profit` ProfitAndLossIndicator - `total` number, nullable — The total amount of the transaction or record - `net_operating_income` ProfitAndLossIndicator - `total` number, nullable — The total amount of the transaction or record - `net_income` ProfitAndLossIndicator - `total` number, nullable — The total amount of the transaction or record - `custom_mappings` CustomMappings, nullable — When custom mappings are configured on the resource, the result is included here. - `customer` string — The customer id - `meta` Meta — Response metadata - `items_on_page` integer — Number of items returned in the data property of the response - `cursors` object — Cursors to navigate to previous or next pages through the API - `previous` string, nullable — Cursor to navigate to the previous page of results through the API - `current` string, nullable — Cursor to navigate to the current page of results through the API - `next` string, nullable — Cursor to navigate to the next page of results through the API - `total_count` integer — Number of records available in total for this resource - `warnings` object[], nullable — Non-fatal warnings emitted when optional workflow steps failed. Present only when at least one step degraded; the response status remains 200. - `type` string — Discriminator for the warning kind. - `status_code` integer, nullable — HTTP status code returned by the failed downstream request, when available. - `error` string, nullable — Short error description from the downstream provider, when available. - `operation` string, nullable — Identifier of the workflow step that failed. - `message` string, nullable — Detailed message from the downstream provider, when available. - `_raw` Raw, nullable — Raw response from the integration when raw=true query param is provided ## Other responses - `400` — Bad Request - `401` — Unauthorized - `402` — Payment Required - `404` — The specified resource was not found - `422` — Unprocessable - `default` — Unexpected error --- [API](https://skmtc.net/apideck-libraries/apis/accounting-api.md) · [All operations](https://skmtc.net/apideck-libraries/apis/accounting-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/apideck-libraries/accounting-api/revisions/4047ae2da55f/schema)