v2.payment.generate_income_statement
GET /api/v2/payment/generate_income_statement
Trigger income statement generation.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/payment/generate_income_statement
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| release_time_from | int64 | True | 1751302800 | The release_time_from must be - Monday (local time) for a weekly report - The 1st day (local time) of a Month for a monthly report |
| release_time_to | int64 | True | 1753981199 | The release_time_to must be - Sunday (local time) for a weekly report - The last day (local time) of a Month for a monthly report |
| statement_type | int32 | True | 1 | STATEMENT_TYPE_WEEKLY = 1; STATEMENT_TYPE_MONTHLY = 2; Local seller Income statement requires this value to be set. CB seller income statement does not require this. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| response | object | ||
| id | int64 | 123456789 | Identifier of income statement file. |
| error | string | error code | |
| message | string | error message |