Fee management
Retrieves all fees for tenant.
the tenant to work on.
testtenant
A list of site codes.
main
A 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.
1
The number of documents being retrieved on one page.
16
The 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.
*
Request was successful.
Request was syntactically incorrect. Any details will be provided within the response payload.
Given request is unauthorized - the authorization token is invalid or has expired.
Details will be provided in the response payload.
Access token does not contain necessary scopes or tenant in path does not match tenant from token.
Some server-side error occurred. Details will be provided in the response payload.
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.
testtenant
The 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 bottle
The localized fee description.
The localized value in the form of map (language, value) or string.
string in the specified language.
Longneck bottle
The 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.
The resource has been successfully created.
Request was syntactically incorrect. Any details will be provided within the response payload.
Given request is unauthorized - the authorization token is invalid or has expired.
Details will be provided in the response payload.
Access token does not contain necessary scopes or tenant in path does not match tenant from token.
Creation failed because there was a conflict with another resource. Any details will be provided within the response payload.
Some server-side error occurred. Details will be provided in the response payload.
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"
}
Retrieving a fee by given id.
The unique identifier of the requested fee.
the tenant to work on.
testtenant
Boolean parameter that enables the retrieval of item YRNs the fee is assigned to. By default, this value is false.
false
The 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.
*
Fee successfully retrieved.
Request was syntactically incorrect. Any details will be provided within the response payload.
Given request is unauthorized - the authorization token is invalid or has expired.
Details will be provided in the response payload.
Access token does not contain necessary scopes or tenant in path does not match tenant from token.
The requested resource does not exist.
Some server-side error occurred. Details will be provided in the response payload.
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.
testtenant
Boolean parameter that defines the update type. By default, its value is false. For partial updates, the value is true.
false
The 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 bottle
The localized fee description.
The localized value in the form of map (language, value) or string.
string in the specified language.
Longneck bottle
The 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.
Fee successfully updated.
Request was syntactically incorrect. Any details will be provided within the response payload.
Given request is unauthorized - the authorization token is invalid or has expired.
Details will be provided in the response payload.
Access token does not contain necessary scopes or tenant in path does not match tenant from token.
The requested resource does not exist.
Creation failed because there was a conflict with another resource. Any details will be provided within the response payload.
Some server-side error occurred. Details will be provided in the response payload.
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
The unique identifier of the requested fee.
the tenant to work on.
testtenant
The resource has been successfully deleted.
Given request is unauthorized - the authorization token is invalid or has expired.
Details will be provided in the response payload.
Access token does not contain necessary scopes or tenant in path does not match tenant from token.
The requested resource does not exist.
Some server-side error occurred. Details will be provided in the response payload.
DELETE /fee/{tenant}/fees/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Was this helpful?