Comment on page

Payout

The payout represents the funds a portal receives from their contact.

The Payouts object
Attributes
Sample Object
Attributes
Type
Description
ledgerGroupId
string
Unique id which identifies portal for which payout report can be generated :Refer​
ledgerName
string
Ledger Name for which payout is generated
portalId
string
Unique Id for a portal (Ex. Amazon, Flipkart) for which payout is generated
portalName
string
Name of portal (Ex. Amazon, Flipkart) in payout report
transactionId
string
Transaction Id for payment in report
portalAccountId
string
Unique key for an account  with which products are sold on portal.
fundTransferAmount
number
Total amount received from portal
reportUrl
string
URL of the file loaded
comments
string
Comments
requestId
string
Unique Id for Request
requestStatus
string
File loading status
Refer Enum : processiong, fail, uploaded, partial​
requestMsg
string
Message for file loading status
active
string
Active payouts are used for reconciliation or not. ENUM: 0,1
fundTransferDate
string
Datetime on which payment is received from portal
createdAt
string
Datetime, at which payout is created
updatedAt
string
Datetime, at which payout is updated
​
 {
   "ledgerGroupId": "3",
   "fundTransferDate": "2019-04-02 00:04:00.0",
   "portalName": "Snapdeal",
   "ledgerName": "Snapdeal Raymond",
   "fundTransferAmount": 5475.58,
   "transactionId": "904022991616",
   "reportUrl": "https://cdn.filestackcontent.com/gaD35vYZTzWjU4iJNeBO",
   "comments": "",
   "requestId": "1576929129640",
   "requestStatus": "success",
   "requestMsg": "Successfully file uploaded",
   "createdAt": "2019-12-21T11:52:09.000Z",
   "updatedAt": "2020-03-09T15:57:17.000Z",
   "portalAccountId": "23",
   "accountId": null,
   "portalId": "4",
   "active": "1"
  }
​
Enum: requestStatus
Attributes
Description
processing
File loading in process
fail
File loading Failed
uploaded
File successfully uploaded
partial
File uploaded partially
ledger Portal Mapping
portalName
ledgerGroupId
amazon
1
flipkart
2
snapdeal
3
limeroad
4
paytm
5
tatacliq
6
myntra
8

Update Status

Get all Payouts

Last modified 3yr ago

Attributes	Type	Description
`ledgerGroupId`	`string`	Unique id which identifies portal for which payout report can be generated :Refer
`ledgerName`	`string`	Ledger Name for which payout is generated
`portalId`	`string`	Unique Id for a portal (Ex. Amazon, Flipkart) for which payout is generated
`portalName`	`string`	Name of portal (Ex. Amazon, Flipkart) in payout report
`transactionId`	`string`	Transaction Id for payment in report
`portalAccountId`	`string`	Unique key for an account with which products are sold on portal.
`fundTransferAmount`	`number`	Total amount received from portal
`reportUrl`	`string`	URL of the file loaded
`comments`	`string`	Comments
`requestId`	`string`	Unique Id for Request
`requestStatus`	`string`	File loading status Refer `Enum : processiong, fail, uploaded, partial`
`requestMsg`	`string`	Message for file loading status
`active`	`string`	`Active` payouts are used for reconciliation or not. `ENUM: 0,1`
`fundTransferDate`	`string`	Datetime on which payment is received from portal
`createdAt`	`string`	Datetime, at which payout is created
`updatedAt`	`string`	Datetime, at which payout is updated

Attributes	Description
`processing`	File loading in process
`fail`	File loading Failed
`uploaded`	File successfully uploaded
`partial`	File uploaded partially

portalName	ledgerGroupId
amazon	1
flipkart	2
snapdeal	3
limeroad	4
paytm	5
tatacliq	6
myntra	8