Connector API
Search…
Outlet bills

Add outlet bills

Adds new outlet bills with their items.

Request

[PlatformAddress]/api/connector/v1/outletBills/add
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"Bills": [
6
{
7
"OutletId": "7700469f-7667-4ebd-a1c0-10380afc9bd0",
8
"Number": "1257",
9
"ClosedUtc": "2017-01-01T00:00:00Z",
10
"Items": [
11
{
12
"Type": "Payment",
13
"Name": "Cash payment",
14
"UnitCount": 1,
15
"UnitAmount": {
16
"Currency": "GBP",
17
"GrossValue": -25,
18
"TaxCodes": [
19
"UK-S"
20
]
21
},
22
"ConsumedUtc": "2017-01-01T00:00:00Z"
23
},
24
{
25
"Type": "Revenue",
26
"Name": "Beer",
27
"UnitCount": 10,
28
"UnitAmount": {
29
"Currency": "GBP",
30
"GrossValue": 2.50,
31
"TaxCodes": [
32
"UK-S"
33
]
34
},
35
"ConsumedUtc": "2017-01-01T00:00:00Z",
36
"AccountingCategoryId": null
37
}
38
]
39
}
40
]
41
}
Copied!
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
Bills
required
The new outlet bills.

Outlet bill parameters

Property
Type
Contract
Description
OutletId
string
required
Unique identifier of the Outlet where the bill was issued.
Number
string
required
Number of the bill.
Notes
string
optional
Additional notes on the bill.
ClosedUtc
string
required
Date and time of the bill closure in UTC timezone in ISO 8601 format.
Items
required
The items on the bill.

Outlet item parameters

Property
Type
Contract
Description
Type
optional
Type of the item.
Name
string
required
Name of the item.
UnitCount
number
required
Unit count of the item.
UnitAmount
required
Unit amount of the item.
ConsumedUtc
string
required
Date and time of the item consumption in UTC timezone in ISO 8601 format.
Notes
string
optional
Additional notes of the item.
AccountingCategoryId
string
optional
Unique identifier of an Accounting category to be assigned to the item.

Response

1
{
2
"OutletBillIds": [
3
"f2ee1bd2-dd55-4cd3-bab1-ab6800bf0301"
4
]
5
}
Copied!
Property
Type
Contract
Description
OutletBillIds
array of string
required
Array of unique identifiers of the added Outlet bills.
Last modified 3mo ago