Expected Future Revenue

REST Sandbox URL: https://sandbox.4levers.com/NewReportsApi/api/Reports/expected-future-revenue

REST Production URL: https://reports-api.4levers.com/api/Reports/expected-future-revenue

Expected Future Revenue report provides overview of all due fees, fees with billing delay and fees before the Cut-off.

Request Example (REST Production URL)

GET: https://reports-api.4levers.com/api/Reports/expected-future-revenue?DateFrom=2020-06-01&DateTo=2020-07-17

Request Parameters

Name	Type	Required	Description
datefrom	datetime	✓	determines the selection starting/ending time range
dateto	datetime	✓	determines the selection starting/ending time range
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: pertransaction calculated per transaction scalerange calculated per transaction count scheduled calculated on a scheduled basis interchangefee interchange fees feeonfee fees for other fees
feecategory	enum	optional	nullable fee categories Available Values: fee tax
feesources	enum	optional	specify the fee source Available Values: disabled for platform user. available for full view only. platform platform account is a fee recipient serviceprovider service provider is a fee recipient operator operator is a fee recipient reservebalance fees for reserve balance subaccount sub-account is a fee recipient outgoing outgoing fees agents fees for agent entities
processors	string/array	required	processor 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: CAD USD EUR GBP AUD SGD JPY NZD

Response Parameters

	Name	Description
	feeDueDate	due 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.

				
					[
  {
        "feeDueDate": "2022-03-04T14:59:59",       
        "feeName": "test",     
        "feeGroupName": "pertrx mark",        
        "feeType": "Per Transaction Fee",        
        "feeCategory": "Tax",      
        "transactionId": "1588001137083647673",        
        "merchantTransactionId": "71",     
        "processorTransactionId": "pr123",     
        "transactionSystemDate": "0001-01-01T00:00:00",        
        "transactionMerchantDate": "2022-03-01T00:00:00",      
        "transactionOrigin": "1588.3 - ti4_sub3",        
        "transactionType": "Charge",       
        "transactionDescription": "test",      
        "merchantFreeText": "here can be any Merchant Free Text",        
        "paymentMethod": "Visa",       
        "entryMode": "0-Unknown",      
        "transactionAmount": "15.00",      
        "transactionStatus": "Processed",      
        "processor": "ProPay",     
        "terminalId": "t--0123345345345345",       
        "billingAmount": "0.134814",       
        "perTrxAmount": "0.000000",        
        "perTrxPercentage": "100.000000",      
        "feeAmount": "-0.134814",      
        "currency": "USD",     
        "feeSource": "T_ilim4",        
        "subAccount": "testAccount",       
        "platformAccount": "testAccount"       
    },
    {
        "feeDueDate": "2022-03-04T14:59:59",       
        "feeName": "test",     
        "feeGroupName": "pertrx mark",        
        "feeType": "Per Transaction Fee",        
        "feeCategory": "Tax",      
        "transactionId": "1588001137083647673",        
        "merchantTransactionId": "71",     
        "processorTransactionId": "pr123",     
        "transactionSystemDate": "0001-01-01T00:00:00",        
        "transactionMerchantDate": "2022-03-01T00:00:00",      
        "transactionOrigin": "1588.3 - ti4_sub3",        
        "transactionType": "Charge",       
        "transactionDescription": "test",      
        "merchantFreeText": "here can be any Merchant Free Text",        
        "paymentMethod": "Visa",       
        "entryMode": "0-Unknown",      
        "transactionAmount": "15.00",      
        "transactionStatus": "Processed",      
        "processor": "ProPay",     
        "terminalId": "t--0123345345345345",       
        "billingAmount": "0.134814",       
        "perTrxAmount": "0.000000",        
        "perTrxPercentage": "100.000000",      
        "feeAmount": "-0.134814",      
        "currency": "USD",     
        "feeSource": "T_ilim4",        
        "subAccount": "testAccount",       
        "platformAccount": "testAccount"
    }
]

Still stuck? How can we help?

Was this page helpful? Yes No