POS - Point Of Sale

With this API you can integrate third party POS solutions with Profit365

Content:

Resource information

Url https://api.profit365.eu/1.6/apps/POS
Authentication required
Access level company
Response JSON / XML
Class

Get product items

Url https://api.profit365.eu/1.6/apps/POS/items?lastSync={lastSync}&tag={tag}
Method GET
Params
{lastSync} optional Query only items that has been added or updated since this date (and time also)
{tag} optional Query only items that has been tagged with this tag(s)
Example

Get all items since last sync on June 1st 2017, 8:00 AM with Tag 'shop-A1'

https://api.profit365.eu/1.6/apps/POS/items?lastSync=2017-06-01T08-00&tag=shop-A1

Create new sale

Url https://api.profit365.eu/1.6/apps/POS/sales
Method POST
Content A new sale transaction
Example POST https://api.profit365.eu/1.6/apps/POS/sales

Authorization: Basic *** hidden credentials ***
CompanyID: CCA2...
Content-Type: application/json

{ "id" : "d8eed2f1-1049-4d2c-98f7-6a12e4cf0d39",
"cashierId": "8a4e435c-15e2-4469-b236-621a95dc5f4b",
"printedAt": "2015-06-20T14:00:00",

"items": [{ "itemId": "9551d4ba-45e1-4ff3-8dbd-7a4b485520bb",
"unitId": "65a61b04-4f27-41e6-9e29-c9b13846db4f",
"warehouseId": "84a9d122-ad67-4975-b18d-1d9ae61a592a",

"code": "ENER91008",
"name": "Tyčinka POWER SPORT čokoláda 2x30g",

"qty": 10,
"pricePerUnitBrutto": 15,
"priceBrutto": 150,
"discount": 5,
"priceTotalBrutto" : 145,
"vatRate" : 20 },{ "itemId": "a62c718d-0f17-4113-86fc-3cfb328919a8",
"unitId": "9985e8a0-3d96-4ccb-bd1b-552bb1b1e809",
"warehouseId": "2f898a38-a48a-46f4-9c20-9422d467851b",

"code": "ENER91007",
"name": "Tyčinka POWER SPORT kokos 2x30g",

"qty": 5,
"pricePerUnitBrutto": 15,
"priceBrutto": 75,
"discount": 0,
"priceTotalBrutto" : 75,
"vatRate" : 20 },{ "itemId": "cb5070c9-eb23-403e-958f-bd7dd12566aa",
"unitId": "8d0d227e-5e5a-439c-b753-ad433350a095",
"warehouseId": "28522186-909a-4664-9770-61ab80d7764a",

"code": "KNI00055V00166",
"name": "Kniha VELO",

"qty": 1,
"pricePerUnitBrutto": 12.51,
"priceBrutto": 12.51,
"discount": 0,
"priceTotalBrutto" : 12.51,
"vatRate" : 10 }],

"payments": [{ "type": "cash",
"amount": 232.51 }]
}

Sale transaction

id

required

The unique ID of the transaction. ID must be generated by POS application, from which has been the sale transaction send. ID is used to identify transaction in Profit365 to avoid duplicates. ID may be generated randomly, but should be stored in POS internaly alongside the sale.

Type: GUID

 request, response

cashierId

required

A Code of a cashier from which was the sale made.

Type: string

 request, response

printedAt

required

Date when sale reciept was originaly printed at (business date not system date)

Type: DateTime

 request

receiptNumber

required

Number of the physical printed receipt which is also stored in fiscal memory of printer.

Type: GUID

 request, response

items

required

Array of sold items. See Sale transaction item description

Type: Array of objects

 request

payments

required

Array of payments. See Sale transaction payment description

Type: Array of objects

 request

Sale transaction item

itemId

required

An ID of sold item.

Type: string

 request, response

unitId

required

An unit ID of sold item.

Type: GUID

 request, response

warehouseId

optional

If supplied, issue card from this warehouse will be generated on the background.

Type: GUID

 request, response

code

optional

A code of sold item

Type: string

 request, response

name

required

A name of sold item

Type: string

 request, response

vatRate

optional

a VAT rate of sold item. If not VAT payer, ignore this field. Sample: 20%, 10%, 0% or NULL

Type: Decimal

 request, response

quantity

required

Quantity of sold item.

Type: Decimal

 request, response

pricePerUnit

conditional required

Price per unit of sold item. Either pricePerUnit or pricePerUnitBrutto must be supplied.

Type: Decimal

 request, response

pricePerUnitBrutto

conditional required

Brutto price (incl. VAT and all taxes) of sold item. Either pricePerUnit or pricePerUnitBrutto must be supplied.

Type: Decimal

 request, response

discountPerUnit

optional

Discount on pricePerUnit, optional, default = 0.

Type: Decimal

 request, response

price

conditional required

Should be calculated as (Price per unit - Discount per unit) * Quantity. Either price or priceBrutto must be supplied.

Type: Decimal

 request, response

priceBrutto

conditional required

Should be calculated as (Brutto price per unit - Discount per unit) * Quantity.

Type: Decimal

 request, response

discount

optional

Discount, optional, default = 0.

Type: Decimal

 request, response

priceTotal

conditional required

Price - Discount. Either priceTotal or priceTotalBrutto must be supplied.

Type: Decimal

 request, response

priceTotalBrutto

conditional required

PriceBrutto - Discount. Either priceTotal or priceTotalBrutto must be supplied.

Type: Decimal

 request, response

Sale transaction payment

type

required

Enum. Options: Cash, Card, MealVoucher

Type: Enum

 request

amount

required

Paid amount

Type: Decimal

 request, response
  • Pubished at 4/27/2016 12:08:41 PM
  • Last edited 10/19/2018 11:37:34 AM

Back to top ↑