> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/settlement-bo-api/sales-commission-lookup-by-vendor.md).

# Sales Commission Lookup By Vendor

## Retrieve Sales Fee List by Vendor

> \## Function Description\
> \* Retrieves the sales fee list by vendor according to the sales fee summary item by vendor selected on the screen.\
> \---\
> \## Detailed Description\
> \* Retrieves the sales fee list by vendor according to the sales fee summary item by vendor selected on the screen.\
> \---\
> \## Revision History\
> \* Release v1.03\_231106: Initial development of sales fee by vendor\
> \* Release v1.04\_231120: Added search conditions (order number, product number), added search for all vendors within the period (grid footer click)<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"EntrCommissionRequest":{"type":"object","description":"Retrieve Sales Fee by Vendor Request","properties":{"salesStrDt":{"type":"string","description":"Sales Start Date"},"salesEndDt":{"type":"string","description":"Sales End Date"},"entrNo":{"type":"string","description":"Vendor No. for Summary Inquiry"},"searchEntrNo":{"type":"string","description":"Vendor No. for Detail Inquiry"},"ordNo":{"type":"string","description":"Order No."},"goodsNo":{"type":"string","description":"Product No."}}},"RealGridListResponseEntrCommissionDetailResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/EntrCommissionDetailResponse"}}}},"EntrCommissionDetailResponse":{"type":"object","description":"Retrieve Sales Fee by Vendor Response","properties":{"ordNo":{"type":"string","description":"Order No."},"salesGb":{"type":"string","description":"Sales Type"},"adjStdDt":{"type":"string","description":"Sales Date"},"entrNo":{"type":"string","description":"Vendor No."},"entrNm":{"type":"string","description":"Vendor Name"},"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"itmNo":{"type":"string","description":"Item No."},"itmNm":{"type":"string","description":"Item Name"},"supPcost":{"type":"number","description":"Supply Cost"},"salePrc":{"type":"number","description":"Selling Price"},"salesQty":{"type":"integer","format":"int64","description":"Sale Quantity"},"totSaleAmt":{"type":"number","description":"Total Sales Amount"},"dcAmt":{"type":"number","description":"Discount Amount"},"entrDcAmt":{"type":"number","description":"Vendor Discount Amount"},"ourDcAmt":{"type":"number","description":"Company Discount Amount"},"salesAmt":{"type":"number","description":"Net Sales Amount"},"salesCmsn":{"type":"number","description":"Sales Fee"},"siteNo":{"type":"string","description":"Site No."},"siteNm":{"type":"string","description":"Site Name"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/adjust/entrCommission/getEntrCommissionDetailList":{"get":{"tags":["Sales Commission Lookup by Vendor"],"summary":"Retrieve Sales Fee List by Vendor","description":"## Function Description\n* Retrieves the sales fee list by vendor according to the sales fee summary item by vendor selected on the screen.\n---\n## Detailed Description\n* Retrieves the sales fee list by vendor according to the sales fee summary item by vendor selected on the screen.\n---\n## Revision History\n* Release v1.03_231106: Initial development of sales fee by vendor\n* Release v1.04_231120: Added search conditions (order number, product number), added search for all vendors within the period (grid footer click)\n","operationId":"getEntrCommissionDetailList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/EntrCommissionRequest"}},{"name":"salesStrDt","in":"query","description":"Sales Start Date","schema":{"type":"string"}},{"name":"salesEndDt","in":"query","description":"Sales End Date","schema":{"type":"string"}},{"name":"searchEntrNo","in":"query","description":"Vendor No.","schema":{"type":"string"}},{"name":"ordNo","in":"query","description":"Order No.","schema":{"type":"string"}},{"name":"goodsNo","in":"query","description":"Product No.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseEntrCommissionDetailResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Sales Fee Summary by Vendor

> \## Function Description\
> \* Retrieves the sales fee summary list by vendor according to the conditions selected on the screen.\
> \---\
> \## Detailed Description\
> \* Retrieves the sales fee summary list by vendor according to the conditions selected on the screen.\
> \* When entering via PO, the vendor number in the request information must match the vendor information in the user information.\
> \---\
> \## Revision History\
> \* Release v1.03\_231106: Initial development of sales fee by vendor\
> \* Release v1.04\_231120: Added search conditions (order number, product number)<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"EntrCommissionSummaryRequest":{"type":"object","properties":{"salesStrDt":{"type":"string","description":"Sales Start Date"},"salesEndDt":{"type":"string","description":"Sales End Date"},"entrNo":{"type":"string","description":"Vendor No. for Summary Inquiry"},"searchEntrNo":{"type":"string","description":"Vendor No. for Detail Inquiry"},"ordNo":{"type":"string","description":"Order No."},"goodsNo":{"type":"string","description":"Product No."},"userGbCd":{"type":"string","description":"User Type Code (UR001)"},"userEntrNo":{"type":"string","description":"User's Vendor No."}}},"EntrCommissionSummaryResponse":{"type":"object","description":"Sales Fee Summary by Vendor Response","properties":{"adjStdDt":{"type":"string","description":"Sales Date"},"entrNo":{"type":"string","description":"Vendor No."},"entrNm":{"type":"string","description":"Vendor Name"},"totSaleAmt":{"type":"integer","format":"int64","description":"Total Sales Amount"},"dcAmt":{"type":"number","description":"Discount Amount"},"entrDcAmt":{"type":"integer","format":"int64","description":"Vendor Discount Amount"},"ourDcAmt":{"type":"integer","format":"int64","description":"Company Discount Amount"},"salesAmt":{"type":"number","description":"Net Sales Amount"},"salesCmsn":{"type":"integer","format":"int64","description":"Sales Fee"},"siteNm":{"type":"string","description":"Site Name"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/adjust/entrCommission/getEntrCommissionSummaryList":{"get":{"tags":["Sales Commission Lookup by Vendor"],"summary":"Retrieve Sales Fee Summary by Vendor","description":"## Function Description\n* Retrieves the sales fee summary list by vendor according to the conditions selected on the screen.\n---\n## Detailed Description\n* Retrieves the sales fee summary list by vendor according to the conditions selected on the screen.\n* When entering via PO, the vendor number in the request information must match the vendor information in the user information.\n---\n## Revision History\n* Release v1.03_231106: Initial development of sales fee by vendor\n* Release v1.04_231120: Added search conditions (order number, product number)\n","operationId":"getEntrCommisionSummaryList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/EntrCommissionSummaryRequest"}},{"name":"salesStrDt","in":"query","description":"Sales Start Date","schema":{"type":"string"}},{"name":"salesEndDt","in":"query","description":"Sales End Date","schema":{"type":"string"}},{"name":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"string"}},{"name":"ordNo","in":"query","description":"Order No.","schema":{"type":"string"}},{"name":"goodsNo","in":"query","description":"Product No.","schema":{"type":"string"}},{"name":"userGbCd","in":"query","description":"User Type Code","schema":{"type":"string"}},{"name":"userEntrNo","in":"query","description":"User's Vendor No.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntrCommissionSummaryResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Download Sales Fee List by Vendor as Excel

> \## Function Description\
> \* Downloads the sales fee list for the vendor selected on the screen as an Excel file.\
> \---\
> \## Detailed Description\
> \* Downloads the sales fee list for the vendor selected on the screen as an Excel file with unpaged data.\
> \---\
> \## Revision History\
> \* Release v1.03\_231106: Initial development of sales fee by vendor<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"EntrCommissionRequest":{"type":"object","description":"Retrieve Sales Fee by Vendor Request","properties":{"salesStrDt":{"type":"string","description":"Sales Start Date"},"salesEndDt":{"type":"string","description":"Sales End Date"},"entrNo":{"type":"string","description":"Vendor No. for Summary Inquiry"},"searchEntrNo":{"type":"string","description":"Vendor No. for Detail Inquiry"},"ordNo":{"type":"string","description":"Order No."},"goodsNo":{"type":"string","description":"Product No."}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/adjust/entrCommission/entrCommissionDetailExcelDownload":{"get":{"tags":["Sales Commission Lookup by Vendor"],"summary":"Download Sales Fee List by Vendor as Excel","description":"## Function Description\n* Downloads the sales fee list for the vendor selected on the screen as an Excel file.\n---\n## Detailed Description\n* Downloads the sales fee list for the vendor selected on the screen as an Excel file with unpaged data.\n---\n## Revision History\n* Release v1.03_231106: Initial development of sales fee by vendor\n","operationId":"entrCommissionDetailExcelDownload","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/EntrCommissionRequest"}},{"name":"salesStrDt","in":"query","description":"Sales Start Date","schema":{"type":"string"}},{"name":"salesEndDt","in":"query","description":"Sales End Date","schema":{"type":"string"}},{"name":"searchEntrNo","in":"query","description":"Vendor No.","schema":{"type":"string"}},{"name":"ordNo","in":"query","description":"Order No.","schema":{"type":"string"}},{"name":"goodsNo","in":"query","description":"Product No.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```