Fee management
Was this helpful?
Was this helpful?
Retrieving a fee by given id.
The unique identifier of the requested fee.
the tenant to work on.
testtenantBoolean parameter that enables the retrieval of item YRNs the fee is assigned to. By default, this value is false.
falseThe value of the locale identifier of the language in which the attribute should be returned. Provide several values separated by comma, in order to specify fallback languages.
*GET /fee/{tenant}/fees/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"fee": {
"id": "5d9459d453b0c703bb846e44",
"active": true,
"code": "apple_picking_fee",
"feeAbsolute": {
"amount": 3.5,
"currency": "EUR"
},
"feeType": "ABSOLUTE",
"name": {
"en": "Sixpack PET",
"de": "Sixpack PET"
},
"description": "Apple Picking Fee",
"siteCode": "main",
"taxable": false,
"yrn": "urn:yaas:saasag:fee:id:tenantName;5d9459d453b0c703bb846e44"
},
"itemYRNs": {
"siteCode": "main",
"itemYrns": [
"urn:yaas:saasag:caasproduct:product:oddity;5f734137b2a4130018db2766",
"urn:yaas:saasag:caasproduct:product:oddity;5f73413db2a4130018db2767"
]
}
}The unique identifier of the requested fee.
the tenant to work on.
testtenantDELETE /fee/{tenant}/fees/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Retrieves all fees for tenant.
the tenant to work on.
testtenantA list of site codes.
mainA list of fee codes.
A list of feeIds.
The page number to be retrieved where the size of the pages must be specified by the pageSize parameter. The number of the first page is 1.
1The number of documents being retrieved on one page.
16The value of the locale identifier of the language in which the attribute should be returned. Provide several values separated by comma, in order to specify fallback languages.
*GET /fee/{tenant}/fees HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "5a030b5da1aff5000e31d43e",
"name": {
"de": "Sixpack PET",
"en": "Sixpack PET"
},
"code": "apple_picking_fee",
"feeType": "ABSOLUTE",
"siteCode": "main",
"feeAbsolute": {
"amount": 3.5,
"currency": "EUR"
},
"active": true,
"taxable": false
},
{
"id": "5a030b5da1aff5000e31d43e",
"name": {
"de": "ZACKE Bier",
"en": "ZACKE Beer"
},
"code": "apple_mackintosh_fee",
"feeType": "ABSOLUTE",
"siteCode": "main",
"feeAbsolute": {
"amount": 4.5,
"currency": "EUR"
},
"active": true,
"taxable": false
}
]the tenant to work on.
testtenantThe locale identifier of the language of the updated attribute.
Unique identifier of the fee.
The localized fee name.
The localized value in the form of map (language, value) or string.
string in the specified language.
Longneck bottleThe localized fee description.
The localized value in the form of map (language, value) or string.
string in the specified language.
Longneck bottleThe code-name, unique for the tenant.
'PERCENT' for relative values, 'ABSOLUTE' for float values or 'ABSOLUTE_MULTIPLY_ITEMQUANTITY' for float values to be multiplied by the quantity of the item.
The fee rate in percentage. Required if feeType is 'PERCENT'.
The fee as an absolute amount. Required if type is 'ABSOLUTE'.
The itemtype the fee can belong to. It could be a product or paymenttype.
The SiteCode the fee belongs to.
Flag indicating whether the fee is currently active or not.
Flag indicating whether the fee is taxable or not.
The tax code. When 'taxable' is set to true, the taxCode is mandatory
A unique identifier of a global resource, which stores information about the resource, such as its type, ID or name of the tenant.
POST /fee/{tenant}/fees HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 190
{
"name": {
"de": "Sixpack PET",
"en": "Sixpack PET"
},
"code": "apple_picking_fee",
"feeType": "ABSOLUTE",
"siteCode": "main",
"feeAbsolute": {
"amount": 3.5,
"currency": "EUR"
},
"active": true,
"taxable": false
}{
"id": "5d80a39ceec29e04726e921f",
"yrn": "urn:yaas:saasag:fee:id:tenantName;5d80a39ceec29e04726e921f"
}The unique identifier of the requested fee.
the tenant to work on.
testtenantBoolean parameter that defines the update type. By default, its value is false. For partial updates, the value is true.
falseThe locale identifier of the language of the updated attribute.
Unique identifier of the fee.
The localized fee name.
The localized value in the form of map (language, value) or string.
string in the specified language.
Longneck bottleThe localized fee description.
The localized value in the form of map (language, value) or string.
string in the specified language.
Longneck bottleThe code-name, unique for the tenant.
'PERCENT' for relative values, 'ABSOLUTE' for float values or 'ABSOLUTE_MULTIPLY_ITEMQUANTITY' for float values to be multiplied by the quantity of the item.
The fee rate in percentage. Required if feeType is 'PERCENT'.
The fee as an absolute amount. Required if type is 'ABSOLUTE'.
The itemtype the fee can belong to. It could be a product or paymenttype.
The SiteCode the fee belongs to.
Flag indicating whether the fee is currently active or not.
Flag indicating whether the fee is taxable or not.
The tax code. When 'taxable' is set to true, the taxCode is mandatory
A unique identifier of a global resource, which stores information about the resource, such as its type, ID or name of the tenant.
PUT /fee/{tenant}/fees/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 190
{
"name": {
"de": "Sixpack PET",
"en": "Sixpack PET"
},
"code": "apple_picking_fee",
"feeType": "ABSOLUTE",
"siteCode": "main",
"feeAbsolute": {
"amount": 3.5,
"currency": "EUR"
},
"active": true,
"taxable": false
}No content