# Payout

## The `Payouts` object

{% tabs %}
{% tab title="Attributes" %}

| Attributes           | Type     | Description                                                                                                                                                  |
| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ledgerGroupId`      | `string` | Unique id which identifies portal for which payout report can be generated :[Refer](/eshopbox-developers/payment/payouts.md#ledger-portal-mapping)           |
| `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` | <p>File loading status</p><p>Refer<a href="/pages/-M0wJ9vXDMrwz03zVieq#enum-requeststatus"> <code>Enum : processiong, fail, uploaded, partial</code></a></p> |
| `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                                                                                                                         |

{% endtab %}

{% tab title="Sample Object" %}

```
 {
   "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"
  }
```

{% endtab %}
{% endtabs %}

### 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             |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://eshop.gitbook.io/eshopbox-developers/payment/payouts.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.