Profitability Analysis

REST Sandbox URL: https://sandbox.4levers.com/NewReportsApi/api/Reports/profitability-analysis

REST Production URL: https://reports-api.4levers.com/api/Reports/profitability-analysis

Profitability Analysis report displays information about Outgoing Fees and Incoming Fees including mark as External Cost Fees.

Fees with Fee Target = Reserve Balance are ignored in this report.

Request Example (REST Production URL)

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

Request Parameters

Name	Type	Required	Description
datefrom	datetime	✓	determines the selection starting/ending time range date in future (fees due date)
dateto	datetime	✓
clearingacquirercompanies	string array	optional	specify one or more acquiring companies
reportperiodtyp	enum	optional	select the output period for the report Available Values: daily monthly
paymentmethods	enum	optional	specify the payment method required in case credit card is populated. Available Values: creditcard ach giftcard
creditcards	enum	optional	specify a credit card type Available Values: visa mastercard diners isracard americanexpress discover jcb visadebit mastercarddebit delta electron maestro solo interac
transactiontype	enum	optional	specify a transaction type Available Values: authorization void partialvoid capture partialcapture charge refund partialrefund credit chargeback payout payoutrejectedbyprocessor payoutdeclinedbyuser payoutauthorization retrieval representment arbitration reversal cancel adjustment fee
status	enum	optional	transaction processing status Available Values: processed declined
TransactionOrigin	string array	optional	specify one or more processing sub-account id(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

Response Parameters

	Name	Description
	feeDate	system date and time
	transactionid	transaction identifier
	transactiontype	type of the transaction
	paymentmethod	payment method: ach, credit card or gift card type.
	transactionstatus	transaction status
	transactionamount	relevant transaction amount
	incomingfeesamount	amount of all incoming fees collected for the sub-account
	outgoingfeesamount	amount of fees paid from the sub-account
	externalcostamount	amount of incoming fees that were marked as cost
	profitamount	incoming fees amount less external cost amount and outgoing fees amount
	subaccount	sub-account identifier
	platformaccount	platform account name

				
					[
  {
        "feeDate": "2021-03-22T23:59:59",              
        "transactionId": "1150000277091582668",                
        "merchantTransactionId": "BOSL-213-023528",                
        "processorTransactionId": "1637084094",                
        "transactionSystemDate": "2021-03-22T22:31:51",                
        "transactionMerchantDate": "2021-03-22T22:06:52",              
        "transactionOrigin": "test_account",               
        "transactionType": "Charge",               
        "transactionDescription": "",              
        "merchantFreeText": "",                
        "paymentMethod": "Master Card",               
        "entryMode": "0-Unknown",              
        "transactionAmount": "25.97",              
        "transactionStatus": "Processed",              
        "processor": "None",               
        "terminalId": "",              
        "incomingFeesAmount": "0.000000",              
        "outgoingFeesAmount": "0.519400",              
        "externalCostAmount": "0.000000",              
        "profitAmount": "-0.519400",               
        "currency": "USD",             
        "subAccount": "test_account",              
        "platformAccount": "test_account"              
    },
    {
        "feeDate": "2021-03-22T23:59:59",              
        "transactionId": "1150000277091582668",                
        "merchantTransactionId": "BOSL-213-023528",                
        "processorTransactionId": "1637084094",                
        "transactionSystemDate": "2021-03-22T22:31:51",                
        "transactionMerchantDate": "2021-03-22T22:06:52",              
        "transactionOrigin": "test_account",               
        "transactionType": "Charge",               
        "transactionDescription": "",              
        "merchantFreeText": "",                
        "paymentMethod": "Master Card",               
        "entryMode": "0-Unknown",              
        "transactionAmount": "25.97",              
        "transactionStatus": "Processed",              
        "processor": "None",               
        "terminalId": "",              
        "incomingFeesAmount": "0.000000",              
        "outgoingFeesAmount": "0.519400",              
        "externalCostAmount": "0.000000",              
        "profitAmount": "-0.519400",               
        "currency": "USD",             
        "subAccount": "test_account",              
        "platformAccount": "test_account"
    }
]

Still stuck? How can we help?

Was this page helpful? Yes No