Incoming Fees
REST Sandbox URL: https://sandbox.4levers.com/NewReportsApi/api/Reports/incoming-fees
REST Production URL: https://reports-api.4levers.com/api/Reports/incoming-fees
Incoming Fees report provides a complete overview of all the incoming and outgoing fees that your Sub-Account has received within a specific time range.
Request Example (REST Production URL)
GET: https://reports-api.4levers.com/api/Reports/incoming-fees?DateFrom=2019-07-23&DateTo=2019-07-24
Request Parameters
| Name | Type | Required | Description | |
| datefrom | datetime | ✓ | determines the selection starting/ending time range | |
| dateto | datetime | ✓ | ||
| feeid | integer/array | optional | enter your fee id(s) | |
| feegroupid | integer/array | optional | enter your fee group id(s) | |
| feetype | enum | optional | select fee type to output in the report Available Values:
| |
| feecategory | enum | optional | nullable fee categories Available Values:
| |
| feesources | enum | optional | specify the fee source Available Values:
| |
| processors | string/array | required | clearing acquirer name(s) | |
| serviceproviders | integer/array | optional | enter your service provider id(s) | |
| operators | integer/array | optional | enter your operator id(s) | |
| accounts | integer/array | optional | enter your platform account id(s) | |
| subaccounts | string/array | optional | enter your sub-account id(s) | |
| skip | integer | optional | these parameters determine which records will be displayed in the report based on specified index number.to get from fifth to twentieth record specify skip = 4 and take = 16 | |
| take | integer | optional | ||
| currencies | string/array | optional | enter currency type ids to filter sub-accounts by Available Values:
|
Response Parameters
| Name | Description | |
| feeDate | system fee processing date and time | |
| feename | name of the fee | |
| feegroupname | name of the fee group a fee belongs too | |
| feetype | fee type | |
| feecategory | fee categories | |
| transactionid | transaction identifier | |
| transactiontype | type of transaction a fee has been calculated for | |
| transactionamount | relevant transaction amount | |
| pertrxamount | fee per transaction amount value | |
| pertrxpercentage | fee percentage value per transaction | |
| feeamount | fee fixed amount | |
| currency | fee currency | |
| feesource | source of the fee. | |
| subaccount | sub-account identifier | |
| platformaccount | platform account name | |
| billingamount | billing amount. used to calculate transaction commissions and fees. |
[
{
"feeDate": "2022-03-04T17:59:59",
"feeName": "test_fee",
"feeGroupName": "test_fee",
"feeType": "Per Transaction Fee",
"feeCategory": "Tax",
"transactionId": "1588001137083647671",
"merchantTransactionId": "69",
"processorTransactionId": "90ed214e-8558-4e49-987e-2a56c4e7bbae",
"transactionSystemDate": "0001-01-01T00:00:00",
"transactionMerchantDate": "2022-03-01T00:00:00",
"transactionOrigin": "test_sub_account",
"transactionType": "Charge",
"transactionDescription": "test",
"merchantFreeText": "here can be any Merchant Free Text",
"paymentMethod": "Visa",
"entryMode": "0-Unknown",
"transactionAmount": "15.00",
"transactionStatus": "Processed",
"processor": "Emulator",
"terminalId": "t--0123345345345345",
"billingAmount": "15.000000",
"perTrxAmount": "0.000000",
"perTrxPercentage": "10.000000",
"feeAmount": "1.500000",
"feeSource": "source_account",
"currency": "USD",
"subAccount": "test_sub_account",
"platformAccount": "test_account"
}
]