Wyzio API documentation

Save recognized document

PUT /api-v1/invoice-scan-recognizer/batch

Headers

TARGET-ORGANIZATION-ID integer(int32)

ID of organization, for which the operation must be performed
WEAL-TOKEN string Required

API token (can be retrieved from account settings)

Body Required

body

documentFileId string
documentWidth integer(int32)
isNotPurchaseInvoice boolean
result object
Hide result attributes Show result attributes
- message string
- taskType string
  
  Value is RECOGNIZE.
status string

Values are PENDING, IN_PROGRESS, FAIL, or SUCCESS.

Responses

• 200

OK
Hide response attributes Show response attributes object
- documentFileId integer
- documentWidth integer
- fields array[object]
  
  Hide fields attributes Show fields attributes object
  
  anchor boolean
  
  fieldId string
  
  id integer
  
  recognizedDocumentId integer
  
  value string
- id integer
- notPurchaseInvoice boolean
- status string
  
  Values are PENDING, IN_PROGRESS, FAIL, or SUCCESS.
- templateId integer
• 400

400 Bad Request
• 401

401 Unauthorized
• 403

403 Access Denied
• 404

404 Not Found
• 500

500 Internal Server Error

PUT /api-v1/invoice-scan-recognizer/batch

curl \
 -X PUT http://wyzio.app/api-v1/invoice-scan-recognizer/batch \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string" \
 -d '{"documentFileId":"string","documentWidth":42,"isNotPurchaseInvoice":true,"result":{"message":"string","taskType":"RECOGNIZE"},"status":"PENDING"}'

Request example

# Headers
TARGET-ORGANIZATION-ID: 42
WEAL-TOKEN: string

# Payload
{
  "documentFileId": "string",
  "documentWidth": 42,
  "isNotPurchaseInvoice": true,
  "result": {
    "message": "string",
    "taskType": "RECOGNIZE"
  },
  "status": "PENDING"
}

Response examples (200)

{
  "documentFileId": 42,
  "documentWidth": 42,
  "fields": [
    {
      "anchor": true,
      "fieldId": "string",
      "id": 42,
      "recognizedDocumentId": 42,
      "value": "string"
    }
  ],
  "id": 42,
  "notPurchaseInvoice": true,
  "status": "PENDING",
  "templateId": 42
}