Obtaining data on commission (Invoice showCommission)

Method for obtaining information on the possible amount of commission on the created invoice.

URI

POST /api/invoicer/payments/showCommission

Request:

Key

Description

Type

Mandatory

Example

Key

Description

Type

Mandatory

Example

params

 

 

 

 

sessionId

client session id

string, uuid

yes

"00684a7f-3d5c-43f4-b4d1-ea994226be9c"

invoiceId

invoice id

string, uuid

yes

"6e391161-94ff-41a3-bd22-c6d77509bff6"

data

 

 

 

 

amount

the amount of payment in kopecks

integer

yes

2300

The amount parameter is mandatory, but this field is taken into account in the calculation only for invoices with an open amount. For other invoices, the amount does not depend on the value of this parameter and the commission will be calculated from the amount specified when creating the invoice.

 

1 2 3 4 5 6 7 8 9 { "params": { "sessionId": "00684a7f-3d5c-43f4-b4d1-ea994226be9c", "invoiceId": ""6e391161-94ff-41a3-bd22-c6d77509bff6" }, "data": { "amount": 50000 } }

Reply:

Key

Description

Type

Example

Key

Description

Type

Example

status

Status. 0 - error, 1 - success

integer

1

data

 

 

 

commissionAmount

The amount of commission

integer

102

commission

 

 

 

percents

commission percentage

integer

2

fixed

fixed value of the commission

integer

100

1 2 3 4 5 6 7 8 9 10 { "status": 1, "data": { "commission": { "percents": 2, "fixed": 100 }, "commissionAmount": 1100 } }