v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
ProfitAndLossReport

Retrieves a mapped profit and loss report

Retrieves a mapped profit and loss report

get/profit_and_loss_report

Query parameters

startstring date-time

YYYY-MM-DD

endstring date-time

YYYY-MM-DD

refreshstring

If refresh is set, data will be fetched from the source application even when cached data is available

Response

ProfitAndLossReport resource

timestampstring date-time
profit_lossstring
yoy_sales_growthnumber float nullable
periodsobject[]
startstring date
endstring date
lastReconciledstring date nullable
lastReconciledLabelstring nullable
isReconciledboolean
hasCompleteDataboolean

Example response

{
  "timestamp": "2021-08-25T15:40:22+00:00",
  "profit_loss": "<b>INCOME</b><br>Sales: 148440.00<br><hr><b style=\"color:#00B4FF;\">Total Income: 148440.00</b><hr><br><b>EXPENSES</b><br>Advertising: 500.00<br>Repair and maintenance: 8000.00<br><hr><b style=\"color:#00B4FF;\">Total Expenses: 8500.00</b><hr><br><hr><b style=\"color:#00B4FF;\">PROFIT: 139940.00</b><hr><br>",
  "yoy_sales_growth": 1,
  "periods": [
    {
      "rows": "[{\"type\": \"sectionheader\", \"cells\": [{\"value\": \"INCOME\"}, {\"value\": \"\"}]}, {\"type\": \"row\", \"cells\": [{\"id\": \"9\", \"value\": \"Sales\"}, {\"value\": \"22540.00\"}]}, {\"type\": \"sectionsummary\", \"cells\": [{\"value\": \"Total Income\"}, {\"value\": \"22540.00\"}]}, {\"type\": \"summaryrow\", \"cells\": [{\"value\": \"PROFIT\"}, {\"value\": \"22540.00\"}]}]",
      "start": "2021-01-01",
      "end": "2021-01-31",
      "totals": {
        "income": 22540,
        "expenses": 0,
        "profit": 22540
      },
      "details": [
        {
          "id": "9",
          "name": "Sales",
          "value": 22540,
          "mapping": "Revenue"
        }
      ],
      "opex": 0,
      "ebitda": 22540,
      "adjusted_ebitda": 22540,
      "ebit": 22540,
      "gross_margin": 22540,
      "gross_income": 22540,
      "yoy_sales_growth": null,
      "year_ago_sales": null
    },
    {
      "rows": "[{\"type\": \"sectionheader\", \"cells\": [{\"value\": \"INCOME\"}, {\"value\": \"\"}]}, {\"type\": \"row\", \"cells\": [{\"id\": \"9\", \"value\": \"Sales\"}, {\"value\": \"28000.00\"}]}, {\"type\": \"sectionsummary\", \"cells\": [{\"value\": \"Total Income\"}, {\"value\": \"28000.00\"}]}, {\"type\": \"summaryrow\", \"cells\": [{\"value\": \"PROFIT\"}, {\"value\": \"28000.00\"}]}]",
      "start": "2021-02-01",
      "end": "2021-02-28",
      "totals": {
        "income": 28000,
        "expenses": 0,
        "profit": 28000
      },
      "details": [
        {
          "id": "9",
          "name": "Sales",
          "value": 28000,
          "mapping": "Revenue"
        }
      ],
      "opex": 0,
      "ebitda": 28000,
      "adjusted_ebitda": 28000,
      "ebit": 28000,
      "gross_margin": 28000,
      "gross_income": 28000,
      "yoy_sales_growth": null,
      "year_ago_sales": null
    },
    {
      "rows": "[{\"type\": \"sectionheader\", \"cells\": [{\"value\": \"INCOME\"}, {\"value\": \"\"}]}, {\"type\": \"row\", \"cells\": [{\"id\": \"9\", \"value\": \"Sales\"}, {\"value\": \"24500.00\"}]}, {\"type\": \"sectionsummary\", \"cells\": [{\"value\": \"Total Income\"}, {\"value\": \"24500.00\"}]}, {\"type\": \"sectionheader\", \"cells\": [{\"value\": \"EXPENSES\"}, {\"value\": \"\"}]}, {\"type\": \"row\", \"cells\": [{\"id\": \"17\", \"value\": \"Advertising\"}, {\"value\": \"500.00\"}]}, {\"type\": \"sectionsummary\", \"cells\": [{\"value\": \"Total Expenses\"}, {\"value\": \"500.00\"}]}, {\"type\": \"summaryrow\", \"cells\": [{\"value\": \"PROFIT\"}, {\"value\": \"24000.00\"}]}]",
      "start": "2021-03-01",
      "end": "2021-03-31",
      "totals": {
        "income": 24500,
        "expenses": 500,
        "profit": 24000
      },
      "details": [
        {
          "id": "9",
          "name": "Sales",
          "value": 24500,
          "mapping": "Revenue"
        },
        {
          "id": "17",
          "name": "Advertising",
          "value": 500,
          "mapping": "Expenses"
        }
      ],
      "opex": 500,
      "ebitda": 24000,
      "adjusted_ebitda": 24000,
      "ebit": 24000,
      "gross_margin": 24000,
      "gross_income": 24500,
      "yoy_sales_growth": null,
      "year_ago_sales": null
    },
    {
      "rows": "[{\"type\": \"sectionheader\", \"cells\": [{\"value\": \"INCOME\"}, {\"value\": \"\"}]}, {\"type\": \"row\", \"cells\": [{\"id\": \"9\", \"value\": \"Sales\"}, {\"value\": \"7500.00\"}]}, {\"type\": \"sectionsummary\", \"cells\": [{\"value\": \"Total Income\"}, {\"value\": \"7500.00\"}]}, {\"type\": \"summaryrow\", \"cells\": [{\"value\": \"PROFIT\"}, {\"value\": \"7500.00\"}]}]",
      "start": "2021-04-01",
      "end": "2021-04-30",
      "totals": {
        "income": 7500,
        "expenses": 0,
        "profit": 7500
      },
      "details": [
        {
          "id": "9",
          "name": "Sales",
          "value": 7500,
          "mapping": "Revenue"
        }
      ],
      "opex": 0,
      "ebitda": 7500,
      "adjusted_ebitda": 7500,
      "ebit": 7500,
      "gross_margin": 7500,
      "gross_income": 7500,
      "yoy_sales_growth": null,
      "year_ago_sales": null
    },
    {
      "rows": "[{\"type\": \"sectionheader\", \"cells\": [{\"value\": \"INCOME\"}, {\"value\": \"\"}]}, {\"type\": \"row\", \"cells\": [{\"id\": \"9\", \"value\": \"Sales\"}, {\"value\": \"22600.00\"}]}, {\"type\": \"sectionsummary\", \"cells\": [{\"value\": \"Total Income\"}, {\"value\": \"22600.00\"}]}, {\"type\": \"summaryrow\", \"cells\": [{\"value\": \"PROFIT\"}, {\"value\": \"22600.00\"}]}]",
      "start": "2021-05-01",
      "end": "2021-05-31",
      "totals": {
        "income": 22600,
        "expenses": 0,
        "profit": 22600
      },
      "details": [
        {
          "id": "9",
          "name": "Sales",
          "value": 22600,
          "mapping": "Revenue"
        }
      ],
      "opex": 0,
      "ebitda": 22600,
      "adjusted_ebitda": 22600,
      "ebit": 22600,
      "gross_margin": 22600,
      "gross_income": 22600,
      "yoy_sales_growth": null,
      "year_ago_sales": null
    },
    {
      "rows": "[{\"type\": \"sectionheader\", \"cells\": [{\"value\": \"INCOME\"}, {\"value\": \"\"}]}, {\"type\": \"row\", \"cells\": [{\"id\": \"9\", \"value\": \"Sales\"}, {\"value\": \"43300.00\"}]}, {\"type\": \"sectionsummary\", \"cells\": [{\"value\": \"Total Income\"}, {\"value\": \"43300.00\"}]}, {\"type\": \"sectionheader\", \"cells\": [{\"value\": \"EXPENSES\"}, {\"value\": \"\"}]}, {\"type\": \"row\", \"cells\": [{\"id\": \"35\", \"value\": \"Repair and maintenance\"}, {\"value\": \"8000.00\"}]}, {\"type\": \"sectionsummary\", \"cells\": [{\"value\": \"Total Expenses\"}, {\"value\": \"8000.00\"}]}, {\"type\": \"summaryrow\", \"cells\": [{\"value\": \"PROFIT\"}, {\"value\": \"35300.00\"}]}]",
      "start": "2021-06-01",
      "end": "2021-06-30",
      "totals": {
        "income": 43300,
        "expenses": 8000,
        "profit": 35300
      },
      "details": [
        {
          "id": "9",
          "name": "Sales",
          "value": 43300,
          "mapping": "Revenue"
        },
        {
          "id": "35",
          "name": "Repair and maintenance",
          "value": 8000,
          "mapping": "Expenses"
        }
      ],
      "opex": 8000,
      "ebitda": 35300,
      "adjusted_ebitda": 35300,
      "ebit": 35300,
      "gross_margin": 35300,
      "gross_income": 43300,
      "yoy_sales_growth": null,
      "year_ago_sales": null
    },
    {
      "rows": "[{\"type\": \"row\", \"cells\": [{\"value\": \"PROFIT\"}]}]",
      "start": "2021-07-01",
      "end": "2021-07-31",
      "totals": {
        "income": 0,
        "expenses": 0,
        "profit": 0
      },
      "details": [],
      "opex": 0,
      "ebitda": 0,
      "adjusted_ebitda": 0,
      "ebit": 0,
      "gross_margin": 0,
      "gross_income": 0,
      "yoy_sales_growth": null,
      "year_ago_sales": null
    },
    {
      "rows": "[{\"type\": \"row\", \"cells\": [{\"value\": \"PROFIT\"}]}]",
      "start": "2021-08-01",
      "end": "2021-08-31",
      "totals": {
        "income": 0,
        "expenses": 0,
        "profit": 0
      },
      "details": [],
      "opex": 0,
      "ebitda": 0,
      "adjusted_ebitda": 0,
      "ebit": 0,
      "gross_margin": 0,
      "gross_income": 0,
      "yoy_sales_growth": null,
      "year_ago_sales": null
    }
  ],
  "start": "2021-01-01",
  "end": "2021-08-25",
  "lastReconciled": "1980-01-01",
  "lastReconciledLabel": "Dec 79",
  "hasCompleteData": true
}