Help Center> Optical Character Recognition> API Reference> APIs> Motor Vehicle Sales Invoice OCR

Motor Vehicle Sales Invoice OCR

Function

Motor Vehicle Sales Invoice OCR recognizes the text in a vehicle sales invoice image and returns the recognition result in JSON format. For details about the constraints on using this API, see Constraints. For details about how to use this API, see Introduction to OCR.

If the image contains multiple cards and tickets, call Auto Classification OCR.

Prerequisites

Before using Motor Vehicle Sales Invoice OCR, you need to apply for the service and complete authentication. For details, see Subscribing to OCR and Authentication.

URI

POST https://{endpoint}/v2/{project_id}/ocr/mvs-invoice

Table 1 Path parameters

Parameter

Mandatory

Description

endpoint

Yes

Domain name or IP address of the server bearing the REST service endpoint. The endpoint varies depending on services in different regions. For more details, see Endpoints.

For example, the endpoint of OCR in the CN North-Beijing4 region is ocr.cn-north-4.myhuaweicloud.com.

project_id

Yes

Project ID, which can be obtained from Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

During API authentication using a token, the token is added to requests to obtain permissions for calling the API. The value of X-Subject-Token in the response header is the obtained token.

Content-Type

Yes

String

MIME type of the request body. The value is application/json.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

image

No. Set either this parameter or url.

String

Base64 character string converted from the image. The size cannot exceed 10 MB. The narrow edge contains at least 100 pixels and the wide edge contains at most 8,000 pixels. Images only in JPEG, JPG, PNG, BMP, or TIFF format can be recognized.

url

No. Set either this parameter or image.

String

Image URL. Currently, the following URLs are supported:

  • Public network: HTTP/HTTPS URL
  • URL provided by OBS. You need to be authorized to use OBS data, including service authorization, temporary authorization, and anonymous public authorization. For details, see Configuring Access Permissions of OBS.
NOTE:
  • The API response time depends on the image download time. If the image download takes a long time, the API call will fail.
  • Ensure that the storage service where the images to be detected reside is stable and reliable. OBS is recommended for storing image data.

Response Parameters

Response parameters and status codes vary in different recognition results. They are described as below.

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

result

MvsInvoiceResult object

Calling result of a successful API call

This parameter is not included when the API fails to be called.
Table 5 MvsInvoiceResult

Parameter

Type

Description

code

String

Invoice code

number

String

Invoice number

machine_printed_code

String

Machine-printed code

machine_printed_number

String

Machine-printed number

issue_date

String

Date of issue

machine_number

String

Machine number

buyer_name

String

Buyer's name

buyer_organization_number

String

ID card number or organization code of the buyer

buyer_id

String

Buyer's taxpayer identifier

seller_name

String

Seller's name

seller_phone

String

Seller's phone number

seller_id

String

Seller's taxpayer identifier

seller_account

String

Seller's bank account

seller_address

String

Seller's address

seller_bank

String

Seller's deposit bank

vehicle_type

String

Vehicle type

brand_model

String

Manufacturer and vehicle model

manufacturing_location

String

Place of production

quality_certificate

String

Certification number

import_certificate

String

Import certificate number

inspection_number

String

Commercial inspection number

engine_number

String

Engine number

vehicle_identification_number

String

VIN

tonnage

String

Tonnage

seating_capacity

String

Maximum number of passengers

tax_authority

String

Local tax authority

tax_authority_code

String

Code of the local tax authority

tax_payment_receipt

String

Tax payment voucher number

tax_rate

String

VAT rate

tax

String

VAT amount

tax_exclusive_price

String

Pretax price

total

String

Total price including tax

total_chinese

String

Total amount in words

fiscal_code

String

Tax code

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code of a failed API call. For details, see Error Codes.

If error code ModelArts.4204 is displayed, refer to Why Is a Message Stating "ModelArts.4204" Displayed When the OCR API Is Called?

This parameter is not included when the API is successfully called.

error_msg

String

Error message returned when the API fails to be called

This parameter is not included when the API is successfully called.

Request Example

  • The endpoint is the request URL for calling an API. Endpoints vary depending on services and regions. For details, see Endpoints.

    For example, Motor Vehicle Sales Invoice OCR is deployed in the CN North-Beijing4 region. The endpoint is ocr.cn-north-4.myhuaweicloud.com. The request URL is https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/mvs-invoice. project_id is the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

  • For details about how to obtain a token, see Making an API Request.
  • Request example (Method 1: Use the image Base64 string.) 
    POST https://{endpoint}/v2/{project_id}/ocr/mvs-invoice 
    
 Request Header:   
 Content-Type: application/json   
 X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...      
 Request Body:
 { 
    "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
  }
  • Request example (Method 2: Use the image URL.) 
    POST https://{endpoint}/v2/{project_id}/ocr/mvs-invoice
    
 Request Header:   
 Content-Type: application/json   
 X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...      
 Request Body:
 {
     "url":"https://BucketName.obs.xxxx.com/ObjectName"
  }
  • Sample code for a Python 3 request (For codes in other languages, refer to the following sample or use OCR SDK.) 
    # encoding:utf-8

import requests
import base64

url = "https://{endpoint}/v2/{project_id}/ocr/mvs-invoice"
token = "Actual token value obtained by the user"
headers = {'Content-Type': 'application/json', 'X-Auth-Token': token}

imagepath = r'./data/mvs-invoice-demo.png'
with open(imagepath, "rb") as bin_data:
    image_data = bin_data.read()
image_base64 = base64.b64encode(image_data).decode("utf-8")  # Base64 encoding of images.
payload = {"image": image_base64}  # url or image.
response = requests.post(url, headers=headers, json=payload)
print(response.text)

Example Response

Status code: 200

Successful response example

{
  "result":{
      "code":"11XXXXXXXX88",
      "number":"00XXXX08",
      "machine_printed_code":"11XXXXXXXX88",
      "machine_printed_number":"00XXXX08",
      "issue_date":"2017-07-19",
      "machine_number":"49991450XXXX",
      "buyer_name":"Buyer name recognized from the image",
      "buyer_organization_number":"XXX",
      "buyer_id":"XXX",
      "seller_name":"Seller name recognized from the image",
      "seller_phone":"0755-XXX",
      "seller_id":"XXX",
      "seller_account":"XXX",
       "seller_address":"Seller address recognized from the image",
      "seller_bank":"Seller bank recognized from the image",
      "vehicle_type":"Vehicle type recognized from the image",
      "brand_model": "XXX",
      "manufacturing_location":"Manufacturing location recognized from the image",
      "quality_certificate":"XXX",
      "import_certificate":"",
      "inspection_number":"", 
      "engine_number":"XXX",
      "vehicle_identification_number":"XXX",
      "tonnage": "",
      "seating_capacity":"5",
      "tax_authority":"XXXX",
      "tax_authority_code":"122XXXX08",
      "tax_payment_receipt":"",
      "tax_rate": "17%",
      "tax": "Tax recognized from the image",
      "tax_exclusive_price": "Tax exclusive price recognized from the image",
      "total": "Total recognized from the image",
      "total_chinese": "Total Chinese recognized from the image",
      "fiscal_code":""
  }
}

Status code: 400

Failure response example

{
    "error_code": "AIS.0103",
    "error_msg": "The image size does not meet the requirements."
}

Status Codes

Status Code

Description

200

Success response

400

Failure response

For details about status codes, see Status Codes.

Error Codes

For details about error codes, see Error Codes.

Parent topic: APIs