All Products
Search
Document Center

BSS OpenAPI:QueryInvoicingCustomerList

Last Updated:Mar 01, 2024

Queries the information about invoice titles.

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:QueryCustomerInvoiceInfoREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The status code.

Success
Messagestring

The error message returned.

Successful!
RequestIdstring

The ID of the request.

BBEF51A3-E933-4F40-A534-C673CBDB9C80
Successboolean

Indicates whether the request was successful.

true
Dataobject

The data returned.

CustomerInvoiceListobject []

The information about the invoice.

Typelong

The type of the invoice. Valid values:

  • 0: plain value-added tax (VAT) invoice
  • 1: special VAT invoice
1
Statuslong

The status of the invoice title.

2
AdjustTypelong

The type of invoice that was changed to.

1
Bankstring

The bank that issues the invoice.

Test Bank
StartCyclelong

The time when the payment started.

202002
TitleChangeInstructionsstring

The instruction document of the invoice title change.

instruction.doc
UserIdlong

The ID of the user.

34565465675
OperatingLicenseAddressstring

The address of the business license.

XXX, XXX district, XXX city, XXX province
InvoiceTitlestring

The company name in the invoice title.

Test Company
UserNickstring

The nickname of the user.

testNick
OperatingLicensePhonestring

The phone number of the business license.

138xxxxxxxx
EndCyclelong

The time when the payment ended.

202003
DefaultRemarkstring

The default note that is attached when the title is specified.

PO Code: 12984554
TaxationLicensestring

The path and file name of the scanned copy of the tax registration certificate.

taxationLicense.jpg
RegisterNostring

The tax registration number.

21343245342534
GmtCreatestring

The time when the invoice was created. The time was in the yyyy-mm-dd hh:mm:ss format.

2018-09-07 15:26:20
TaxpayerTypelong

The type of the taxpayer. Valid values:

  • 1: general taxpayer
  • 2: special taxpayer
1
CustomerTypelong

The authentication type of Alipay. Valid values:

  • 1: individual
  • 2: company
1
IssueTypelong

The type of issue.

1
Idlong

The ID of the invoice.

239875502738
BankNostring

The bank account number.

389576348573296349853476

Examples

Sample success responses

JSONformat

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "BBEF51A3-E933-4F40-A534-C673CBDB9C80",
  "Success": true,
  "Data": {
    "CustomerInvoiceList": {
      "CustomerInvoice": [
        {
          "Type": 1,
          "Status": 2,
          "AdjustType": 1,
          "Bank": "Test Bank\n",
          "StartCycle": 202002,
          "TitleChangeInstructions": "instruction.doc",
          "UserId": 34565465675,
          "OperatingLicenseAddress": "XXX, XXX district, XXX city, XXX province\n",
          "InvoiceTitle": "Test Company\n",
          "UserNick": "testNick",
          "OperatingLicensePhone": "138xxxxxxxx",
          "EndCycle": 202003,
          "DefaultRemark": "PO Code: 12984554\n",
          "TaxationLicense": "taxationLicense.jpg",
          "RegisterNo": "21343245342534",
          "GmtCreate": "2018-09-07 15:26:20",
          "TaxpayerType": 1,
          "CustomerType": 1,
          "IssueType": 1,
          "Id": 239875502738,
          "BankNo": "389576348573296349853476"
        }
      ]
    }
  }
}

Error codes

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