Turnover & Gross Margin Report

This API provides the Sales Orders based Turn Over achieved and the Gross Margin earned from the Sales Orders fulfilled within the specified date range. This takes into consideration the Item Rates, MRPs and the Cost of Goods while calculating the gross margins.
The data can be accessed at Customer Level as well as on a Consolidated Level.

There are are following two versions of this data set available for access through this API:

Data source should be either INV or ORD ( INV - Sales Invoice, ORD - Sales Order).

This api includes FOC (Free of Cost) order details.

Request

Header Params

Authorization

string

required

Example:

Bearer 3e4b6e748d872a95aa39483ca54b27cb49eb464f

Body Params application/json

type

string

required

Customer wise or Consolidate

tax

integer

required

1 including tax 0 excluding tax

from_date

string

required

From Date IST - 2024-12-01

to_date

string

required

To date IST - 2024-12-31

source

string

required

ORD for order, INV invoice only applicable with version R

Example

{
    "type":"CUSTOMER",
    "tax":"1",
    "from_date":"2024-08-01",
    "to_date":"2025-01-31",
    "source" : "INV"
}

{
    "type":"CUSTOMER",
    "tax":"1",
    "from_date":"2024-08-01",
    "to_date":"2025-01-31",
    "source" : "INV"
}

{
    "type":"CONSOLIDATED",
    "tax":"0",
    "from_date":"2024-08-01",
    "to_date":"2025-01-31",
    "source" : "ORD"
}

{
    "type":"CONSOLIDATED",
    "tax":"0",
    "from_date":"2024-08-01",
    "to_date":"2025-01-31",
    "source" : "ORD"
}

Responses

🟢200Success

application/json

Body

company_name

string

required

product_name

string

required

product_sku

string

required

Prod_type

string

required

MRP

number

required

per_unit_cogs

number

required

Total_sale_qty

number

required

total_sale

number

required

return_qty

number

required

return_amt

number

required

Total_cost_cogs

number

required

profit

number

required

profit_per

number

required

Examples

SuccessExceptionExceptionException

{
    "data": [
        {
            "company_name": "New Cust Add New Vendor",
            "product_name": "Demo One",
            "product_sku": "FEFO00021",
            "Prod_type": "Single",
            "MRP": "39.00",
            "per_unit_cogs": "15.00",
            "Total_sale_qty": "4.00",
            "total_sale": "156.00",
            "return_qty": "0.00",
            "return_amt": "0.00",
            "Total_cost_cogs": "60.00",
            "profit": "96.00",
            "profit_per": "160.00"
        },
        {
            "company_name": "New Cust Add New Vendor",
            "product_name": "INV Finished Goods 1",
            "product_sku": "FGORD000212",
            "Prod_type": "Single",
            "MRP": "52.50",
            "per_unit_cogs": "25.00",
            "Total_sale_qty": "10.00",
            "total_sale": "525.00",
            "return_qty": "2.00",
            "return_amt": "100.00",
            "Total_cost_cogs": "200.00",
            "profit": "225.00",
            "profit_per": "112.50"
        },
        {
            "company_name": "New Cust Add New Vendor",
            "product_name": "New Gropup of Material New Combo FOur",
            "product_sku": "NEWGP02112",
            "Prod_type": "Combo",
            "MRP": "150.00",
            "per_unit_cogs": "50.00",
            "Total_sale_qty": "15.00",
            "total_sale": "2250.02",
            "return_qty": "1.00",
            "return_amt": "127.12",
            "Total_cost_cogs": "700.00",
            "profit": "1422.90",
            "profit_per": "203.27"
        },
        {
            "company_name": "New Cust Add New Vendor",
            "product_name": "Sales Product Two",
            "product_sku": "SOFG0002",
            "Prod_type": "Single",
            "MRP": "0.00",
            "per_unit_cogs": "16.80",
            "Total_sale_qty": "5.00",
            "total_sale": "0.00",
            "return_qty": "3.00",
            "return_amt": "0.00",
            "Total_cost_cogs": "33.60",
            "profit": "-33.60",
            "profit_per": "-100.00"
        },
        {
            "company_name": "New Cust Add New Vendor",
            "product_name": "Sf Pack  Nmae",
            "product_sku": "SF-PACK0258",
            "Prod_type": "Single",
            "MRP": "31.50",
            "per_unit_cogs": "25.00",
            "Total_sale_qty": "5.00",
            "total_sale": "157.50",
            "return_qty": "0.00",
            "return_amt": "0.00",
            "Total_cost_cogs": "125.00",
            "profit": "32.50",
            "profit_per": "26.00"
        },
        {
            "company_name": "Ravi & Company",
            "product_name": "Demo One",
            "product_sku": "FEFO00021",
            "Prod_type": "Single",
            "MRP": "40.00",
            "per_unit_cogs": "15.00",
            "Total_sale_qty": "15.00",
            "total_sale": "600.03",
            "return_qty": "0.00",
            "return_amt": "0.00",
            "Total_cost_cogs": "225.00",
            "profit": "375.03",
            "profit_per": "166.68"
        },
        {
            "company_name": "Ravi & Company",
            "product_name": "Sales Gross Product",
            "product_sku": "SGA00001",
            "Prod_type": "Single",
            "MRP": "42.00",
            "per_unit_cogs": "23.00",
            "Total_sale_qty": "10.00",
            "total_sale": "420.00",
            "return_qty": "0.00",
            "return_amt": "0.00",
            "Total_cost_cogs": "230.00",
            "profit": "190.00",
            "profit_per": "82.61"
        },
        {
            "company_name": "Ravi & Company",
            "product_name": "Sales Product One",
            "product_sku": "SOFG0001",
            "Prod_type": "Single",
            "MRP": "150.00",
            "per_unit_cogs": "10.17",
            "Total_sale_qty": "10.00",
            "total_sale": "1500.02",
            "return_qty": "4.00",
            "return_amt": "535.72",
            "Total_cost_cogs": "61.02",
            "profit": "903.28",
            "profit_per": "1480.30"
        },
        {
            "company_name": "Ravi & Company",
            "product_name": "Sales Product Two",
            "product_sku": "SOFG0002",
            "Prod_type": "Single",
            "MRP": "26.25",
            "per_unit_cogs": "12.08",
            "Total_sale_qty": "34.00",
            "total_sale": "2531.26",
            "return_qty": "3.00",
            "return_amt": "75.00",
            "Total_cost_cogs": "374.48",
            "profit": "2081.78",
            "profit_per": "555.91"
        },
        {
            "company_name": "Sales Order Customer",
            "product_name": "Demo One",
            "product_sku": "FEFO00021",
            "Prod_type": "Single",
            "MRP": "40.00",
            "per_unit_cogs": "15.00",
            "Total_sale_qty": "6.00",
            "total_sale": "240.01",
            "return_qty": "0.00",
            "return_amt": "0.00",
            "Total_cost_cogs": "90.00",
            "profit": "150.01",
            "profit_per": "166.68"
        },
        {
            "company_name": "Sales Order Customer",
            "product_name": "Group 6 Prod New",
            "product_sku": "GRDFG0006",
            "Prod_type": "Combo",
            "MRP": "0.00",
            "per_unit_cogs": "84.00",
            "Total_sale_qty": "4.00",
            "total_sale": "0.00",
            "return_qty": "0.00",
            "return_amt": "0.00",
            "Total_cost_cogs": "336.00",
            "profit": "-336.00",
            "profit_per": "-100.00"
        },
        {
            "company_name": "Test Mehta Private Limited",
            "product_name": "Fifo testing 001",
            "product_sku": "FIFO001",
            "Prod_type": "Single",
            "MRP": "42.00",
            "per_unit_cogs": "31.00",
            "Total_sale_qty": "20.00",
            "total_sale": "840.00",
            "return_qty": "0.00",
            "return_amt": "0.00",
            "Total_cost_cogs": "620.00",
            "profit": "220.00",
            "profit_per": "35.48"
        },
        {
            "company_name": "Test Mehta Private Limited",
            "product_name": "Group 6 Prod New",
            "product_sku": "GRDFG0006",
            "Prod_type": "Combo",
            "MRP": "58.80",
            "per_unit_cogs": "84.00",
            "Total_sale_qty": "5.00",
            "total_sale": "294.00",
            "return_qty": "0.00",
            "return_amt": "0.00",
            "Total_cost_cogs": "420.00",
            "profit": "-126.00",
            "profit_per": "-30.00"
        },
        {
            "company_name": "Test Mehta Private Limited",
            "product_name": "Physical Combo One",
            "product_sku": "PHY-COM-0001",
            "Prod_type": "Single",
            "MRP": "52.50",
            "per_unit_cogs": "11.80",
            "Total_sale_qty": "5.00",
            "total_sale": "262.50",
            "return_qty": "0.00",
            "return_amt": "0.00",
            "Total_cost_cogs": "59.00",
            "profit": "203.50",
            "profit_per": "344.92"
        },
        {
            "company_name": "Test Mehta Private Limited",
            "product_name": "Sales Product One",
            "product_sku": "SOFG0001",
            "Prod_type": "Single",
            "MRP": "33.60",
            "per_unit_cogs": "18.56",
            "Total_sale_qty": "15.00",
            "total_sale": "504.00",
            "return_qty": "0.00",
            "return_amt": "0.00",
            "Total_cost_cogs": "278.40",
            "profit": "225.60",
            "profit_per": "81.03"
        },
        {
            "company_name": "Vendord twog pvt limited",
            "product_name": "Demo One",
            "product_sku": "FEFO00021",
            "Prod_type": "Single",
            "MRP": "40.00",
            "per_unit_cogs": "15.00",
            "Total_sale_qty": "52.00",
            "total_sale": "2212.08",
            "return_qty": "0.00",
            "return_amt": "0.00",
            "Total_cost_cogs": "780.00",
            "profit": "1432.08",
            "profit_per": "183.60"
        },
        {
            "company_name": "Vendord twog pvt limited",
            "product_name": "Fifo testing 001",
            "product_sku": "FIFO001",
            "Prod_type": "Single",
            "MRP": "42.50",
            "per_unit_cogs": "22.00",
            "Total_sale_qty": "15.00",
            "total_sale": "637.56",
            "return_qty": "0.00",
            "return_amt": "0.00",
            "Total_cost_cogs": "330.00",
            "profit": "307.56",
            "profit_per": "93.20"
        },
        {
            "company_name": "Vendord twog pvt limited",
            "product_name": "Fifo testing 002",
            "product_sku": "FIFO002",
            "Prod_type": "Single",
            "MRP": "212.50",
            "per_unit_cogs": "45.00",
            "Total_sale_qty": "10.00",
            "total_sale": "2125.00",
            "return_qty": "0.00",
            "return_amt": "0.00",
            "Total_cost_cogs": "450.00",
            "profit": "1675.00",
            "profit_per": "372.22"
        },
        {
            "company_name": "Vendord twog pvt limited",
            "product_name": "Group 7 Prod New",
            "product_sku": "RTD09890",
            "Prod_type": "Combo",
            "MRP": "120.00",
            "per_unit_cogs": "28.00",
            "Total_sale_qty": "25.00",
            "total_sale": "3099.94",
            "return_qty": "0.00",
            "return_amt": "0.00",
            "Total_cost_cogs": "700.00",
            "profit": "2399.94",
            "profit_per": "342.85"
        },
        {
            "company_name": "Vendord twog pvt limited",
            "product_name": "Sales Product Two",
            "product_sku": "SOFG0002",
            "Prod_type": "Single",
            "MRP": "170.00",
            "per_unit_cogs": "4.90",
            "Total_sale_qty": "25.00",
            "total_sale": "4249.88",
            "return_qty": "0.00",
            "return_amt": "0.00",
            "Total_cost_cogs": "122.50",
            "profit": "4127.38",
            "profit_per": "3369.29"
        }
    ],
    "_links": {
        "self": {
            "href": "http://127.0.0.1/bizeebuy/rest/web/v1/sales/gross-margin?page=1"
        },
        "first": {
            "href": "http://127.0.0.1/bizeebuy/rest/web/v1/sales/gross-margin?page=1"
        },
        "last": {
            "href": "http://127.0.0.1/bizeebuy/rest/web/v1/sales/gross-margin?page=1"
        }
    },
    "_meta": {
        "totalCount": 20,
        "pageCount": 1,
        "currentPage": 1,
        "perPage": 20
    }
}