Submits an invoicing request.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
bss:ApplyInvoice |
create |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InvoiceAmount |
integer |
Yes |
The amount of the invoice request, in cents. |
124132 |
| CustomerId |
integer |
Yes |
The ID of the invoicing customer. This ID corresponds to the ID parameter returned by the QueryInvoicingCustomerList operation. |
124132423 |
| AddressId |
integer |
Yes |
The ID of the mailing address. This ID corresponds to the ID parameter returned by the QueryCustomerAddressList operation. |
237958367 |
| InvoicingType |
integer |
No |
The type of the invoice. Valid values:
|
1 |
| ProcessWay |
integer |
No |
The invoicing channel. The value must be 1. Examples:
|
1 |
| ApplyUserNick |
string |
Yes |
The nickname of the applicant. The system does not verify this parameter. |
test |
| InvoiceByAmount |
boolean |
No |
Specifies whether to issue an invoice based on a specified amount. If you set this parameter to true, an invoice is requested for the amount specified by InvoiceAmount. Otherwise, an invoice is requested for the total amount of the selected items. |
true |
| UserRemark |
string |
No |
The user's remarks. |
test |
| SelectedIds |
array |
Yes |
A list of IDs for the items to be invoiced. These IDs correspond to the ID parameter returned by the QueryEvaluateList operation. |
384752367 |
|
integer |
No |
384752367 |
||
| emails |
string |
No |
The email address to which the invoice is sent. The value can be up to 200 characters in length. Separate multiple email addresses with commas (,). |
aaa@aa.com,bbb@bb.com |
Response elements
|
Parameter |
Type |
Description |
Example |
|
object |
|||
| Code |
string |
The status code. |
Success |
| Message |
string |
The error message. |
Successful! |
| RequestId |
string |
The request ID. |
6000EE23-274B-4E07-A697-FF2E999520A4 |
| Success |
boolean |
Indicates whether the request was successful. |
true |
| Data |
object |
The returned data. |
|
| InvoiceApplyId |
integer |
The ID of the invoice request record. |
1323125534 |
Examples
Success response
JSON format
{
"Code": "Success",
"Message": "Successful!",
"RequestId": "6000EE23-274B-4E07-A697-FF2E999520A4",
"Success": true,
"Data": {
"InvoiceApplyId": 1323125534
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.