All Products
Search
Document Center

BSS OpenAPI:ApplyInvoice

Last Updated:Mar 01, 2024

Submits an application for an invoice.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
bss:ApplyInvoiceWRITE
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InvoiceAmountlongYes

The amount of the invoice. Unit: Cent.

124132
CustomerIdlongYes

The ID of the customer. Set the ID to the value of the CustomerId parameter returned by calling the QueryInvoicingCustomerList operation.

124132423
AddressIdlongYes

The ID of the address to which the invoice is delivered. This parameter is required if the invoice is a paper invoice. Set the ID to the value of the AddressId parameter returned by calling the QueryCustomerAddressList operation.

237958367
InvoicingTypeintegerNo

The type of the invoice. Valid values:

  • 0: paper invoice
  • 1: electronic invoice
1
ProcessWayintegerNo

The channel that is used to process the invoice. A value of 0 indicates that the invoice is processed by Alibaba Cloud. A value of 1 indicates that the invoice is processed by the tax platform. Set the value to 1.

1
ApplyUserNickstringYes

The nickname of the applicant. The system does not verify the nickname.

test
InvoiceByAmountbooleanNo

Specifies whether to invoice by amount. A value of true indicates that the user applies for the invoice based on the InvoiceAmount parameter. A value of false indicates that the user applies for the invoice based on the total amount of the invoicing items.

true
UserRemarkstringNo

The remarks made by the user.

test
SelectedIdsarrayYes

The IDs of the selected invoicing items. Set the IDs to the IDs returned by calling the QueryEvaluateList operation.

longYes
384752367

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The status code.

Success
Messagestring

The error message returned.

Successful!
RequestIdstring

The ID of the request.

6000EE23-274B-4E07-A697-FF2E999520A4
Successboolean

Indicates whether the request was successful.

true
Dataobject

The data returned.

InvoiceApplyIdlong

The ID of the application.

1323125534

Examples

Sample success responses

JSONformat

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "6000EE23-274B-4E07-A697-FF2E999520A4",
  "Success": true,
  "Data": {
    "InvoiceApplyId": 1323125534
  }
}

Error codes

For a list of error codes, visit the Service error codes.