pixiReport_GrossProfit

API call exposes report "Gross Profit"

Since pixi version: 19.04 (9.0.2.38390) Additional notes: This report/API calculates the gross profit per item in a defined time frame. Applicable for Sales and Returns (Avg.): The selling price is an average of all selling prices during this time frame - same with supplier prices and VAT.

    Calculation:
    Single Gross Profit = Selling Price (Sales) - VAT (Sales) - Supp. Price (Sales)
    Total Gross Profit = Single Gross Profit * Sales - ( Selling Price (Returns) - VAT (Returns) - Supp. Price (Returns) ) * Returns
    
    Values:
    Selling prices include VAT, supplier prices do not include VAT.
    The sums for columns Selling Price, VAT and Supplier Price below Sales & Returns (Avg.) are already multiplied with item quantities for Sales or Returns.

Request

POST https://apigateway.descartes.com/tms/pixi/pixiReport_GrossProfit

Request body

Name Type Required Description
ShopID string false

Filter: Shop Id

Type: varchar(3)

Default value: NULL

Example: MAD

Available from: 19.04 (9.0.2.38390)

ToDate string true

Range: End of date range (End of day time is added)

Type: datetime

Default value:

Example: YYYY-MM-DD

Available from: 19.04 (9.0.2.38390)

SupplNr string false

Filter: Supplier code

Type: varchar(10)

Default value: NULL

Example: MGS

Available from: 19.04 (9.0.2.38390)

TagKey1 integer false

Filter: Item tag Id (1)

Type: int

Default value: NULL

Example: 111

Available from: 19.04 (9.0.2.38390)

TagKey2 integer false

Filter: Item tag Id (2)

Type: int

Default value: NULL

Example: 222

Available from: 19.04 (9.0.2.38390)

TagKey3 integer false

Filter: Item tag Id (3)

Type: int

Default value: NULL

Example: 333

Available from: 19.04 (9.0.2.38390)

Category string false

Filter: Category code

Type: varchar(10)

Default value: NULL

Example: Clothes

Available from: 19.04 (9.0.2.38390)

FromDate string true

Range: Start of date range (Start of day time is added)

Type: datetime

Default value:

Example: YYYY-MM-DD

Available from: 19.04 (9.0.2.38390)

PaymentType string false

Filter: Payment code

Type: char

Default value: NULL

Example: Single character : "C"

Available from: 19.04 (9.0.2.38390)

ExcludePaymentType string false

Filter: Payment code to exclude

Type: char

Default value: NULL

Example: Single character : "C"

Available from: 19.04 (9.0.2.38390)


Response

1. Report "Gross Profit" output columns

Name Type Description
Barcode string

Item barcode

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

Currency string

Currency

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)

ItemName string

Item name

Type: varchar (120)

Available from: 25.06 (25.6.0.58802)

Supplier string

Supplier name

Type: varchar (60)

Available from: 25.06 (25.6.0.58802)

Sales_VAT number

Average item (sales) VAT

Type: money

Available from: 25.06 (25.6.0.58802)

Returns_VAT number

Average item (returns) VAT

Type: money

Available from: 25.06 (25.6.0.58802)

ItemNrSupplier string

Item number supplier

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

Sales_Quantity integer

Item quantity sold

Type: int

Available from: 25.06 (25.6.0.58802)

Returns_Quantity integer

Average item (returns) selling price

Type: int

Available from: 25.06 (25.6.0.58802)

TotalGrossProfit number

Total Gross Profit = Single Gross Profit * Sales - ( Selling Price (Returns) - VAT (Returns) - Supp. Price (Returns) ) * Returns

Type: money

Available from: 25.06 (25.6.0.58802)

SingleGrossProfit number

Single Gross Profit = Selling Price (Sales) - VAT (Sales) - Supp. Price (Sales)

Type: money

Available from: 25.06 (25.6.0.58802)

Sales_SellingPrice number

Average item (sales) selling price

Type: money

Available from: 25.06 (25.6.0.58802)

Sales_SupplierPrice number

Average item (sales) supplier price

Type: money

Available from: 25.06 (25.6.0.58802)

Returns_SellingPrice number

Item quantity returned

Type: money

Available from: 25.06 (25.6.0.58802)

Returns_SupplierPrice number

Average item (returns) supplier price

Type: money

Available from: 25.06 (25.6.0.58802)

2. Error

Name Type Description
Status string

Status

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

Message string

Status message details

Type: varchar (MAX)

Available from: 25.06 (25.6.0.58802)