Wyzio API documentation

Modify batch of purchase invoice scans

PUT /api-v1/purchase-invoice-scan/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)

Query parameters

suppressDuplicateWarning boolean

suppressDuplicateWarning

Body Required

scans

amounts array[object]
Hide amounts attributes Show amounts attributes object
- amountType string
  
  Values are NO_VAT, VAT_RATE, or MANUAL.
- id integer
- net string
- vat string
- vatRateId integer
- vatType string
  
  Values are NO_VAT, NATIVE, or IMPORT_OF_SERVICE.
- vatTypeCodeId integer
attributions array[object]
Hide attributions attributes Show attributions attributes object
- appliedAllocationRules array[string]
- articleId integer
- chartOfAccountsId integer
- dateFrom string
- dateTo string
- departmentId integer
- endDate string
- id integer
- net string
- orderId integer
- orderIdToDisplay string
- percent string
- quantity string
- reBill boolean
- reBillDate string(date-time)
- readOnly boolean
- shipments array[object]
  Hide shipments attributes Show shipments attributes object
  
  articleId integer
  
  articleIdSku string
  
  articleName object
  
  Hide articleName attributes Show articleName attributes
  
  de string
  
  en string
  
  fr string
  
  it string
  
  attributionId integer
  
  currencyCode string
  
  generatedStockMovementId integer
  
  id integer
  
  quantity string
  
  shipmentDate string
  
  totalCost number
- startDate string
comment string
currencyId integer
date string
description string
document object
Hide document attributes Show document attributes
- comments string
- contact object
  Hide contact attributes Show contact attributes
  
  email string
  
  id integer
  
  name string
- createdBy string
- createdOn string
- date string
- entityId integer
- fileExtension string
- fileId integer
- id integer
- isSystem boolean
- module string
  
  Values are ALL, NONE, CONTACTS, CONTACTS_DETAILS, CONTACTS_SUPPLIER, CONTACTS_CLIENT, CONTACTS_STAFF, CONTACTS_STAFF_DOCUMENTS, CONTACTS_USER, CONTACTS_MAIN_USER, CONTACTS_USER_SECURITY, CONTACTS_USER_PERMISSIONS, CONTACTS_SYSTEM, CONTACTS_DOCUMENTS, CONTACTS_ROLES, CONTACTS_ROLES_SUPPLIER, CONTACTS_ROLES_CLIENT, CONTACTS_ROLES_STAFF, CONTACTS_ROLES_USER, CONTACTS_COMMUNICATIONS, ORGANIZATIONS_USERS_MANAGER, ORGANIZATIONS, ORGANIZATIONS_DETAILS, ORGANIZATIONS_TEMPLATES, ORGANIZATIONS_ACCOUNTING, ORGANIZATIONS_INVOICES, ORGANIZATIONS_SYSTEM, ORGANIZATIONS_SYSTEM_CODES, ORGANIZATIONS_SYSTEM_INVENTORY, ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS, ORGANIZATIONS_SYSTEM_EBICS, ORGANIZATIONS_DOCUMENTS, ORGANIZATIONS_DETAILS_INVOICING, PERMISSION_ROLES, PERMISSION_ROLES_DETAILS, BUSINESS_UNITS, ARTICLE_CATEGORIES, CHART_OF_ACCOUNTS, CHART_OF_ACCOUNTS_DETAILS, ACTIVITY_LOG, CURRENCIES, CURRENCIES_DETAILS, JOURNAL, JOURNAL_DETAILS, JOURNAL_DOCUMENTS, DOCUMENTS, DOCUMENTS_DETAILS, RECONCILIATION, PURCHASE_INVOICES, PURCHASE_INVOICES_DETAILS, PURCHASE_INVOICES_VALIDATION, PURCHASE_INVOICES_ACCOUNTING, PURCHASE_INVOICES_SHIPMENTS, PURCHASE_INVOICES_DOCUMENTS, PURCHASE_INVOICES_ALLOCATION_RULES, PURCHASE_INVOICES_WORKFLOW, SALES_INVOICES, SALES_INVOICES_DETAILS, SALES_INVOICES_VALIDATION, SALES_INVOICES_ACCOUNTING, SALES_INVOICES_DOCUMENTS, SALES_INVOICES_SHIPMENTS, SALES_INVOICES_REPORT, SALES_INVOICES_ALLOCATION_RULES, SALES_INVOICES_WORKFLOW, SALARIES, STOCK_REPORT, STOCK_MOVEMENTS, STOCK_MOVEMENTS_DETAILS, ORDERS, ORDERS_DETAILS, ORDERS_VALIDATION, ORDERS_SHIPMENT, ORDERS_INVOICES, ORDERS_EXPENSES, ORDERS_DOCUMENTS, ORDERS_WORKFLOW, ADVANCED_INVOICING, ADVANCED_INVOICING_GENERATE, ACCOUNTING_PERIODS, ACCOUNTING_PERIODS_DETAILS, ACCOUNTING_PERIODS_LOCK, ACCOUNTING_PERIODS_OPEN_CLOSE, GENERAL_LEDGER, GENERAL_LEDGER_STAFF, REPORT_TEMPLATE, ARTICLES, ARTICLES_DETAILS, PURCHASE_INVOICES_SCAN, PURCHASE_INVOICES_SCAN_DETAILS, RECOGNIZER, BALANCE, BALANCE_SHEET, BALANCE_SHEET_STAFF, PL_REPORT, PL_REPORT_STAFF, CASH_FLOW_REPORT, MY_TIMESHEETS, MY_ACCOUNT, TIME_DETAILS, TIME_DETAILS_DETAILS, TIME_DETAILS_WORKFLOW, TEAM_REVIEW, BUDGETING, BUDGETING_DETAILS, SALARY_CONFIG, SALARY_CONFIG_DETAILS, RECEIVABLES, PAYABLES, PAYABLES_PAYMENT_FILE, PDF_TEMPLATES, PDF_TEMPLATES_DETAILS, DASHBOARD, LATE_NOTICES, MY_PAYROLL, PAYROLL, PAYROLL_DETAILS, PAYROLL_ACCOUNTING, VAT_REPORT, ORDER_REPORTS, ORDER_REPORTS_DETAILS, RATIOS_REPORT, VACATIONS, TRASH_CAN, USER_GROUPS, USER_GROUPS_DETAILS, WORKFLOW, WORKFLOW_DETAILS, MY_WORKFLOW_NOTIFICATIONS, FIXED_ASSETS, UNASSIGNED, EXPENSES, EXPENSES_DETAILS, EXPENSES_DRAFT, EXPENSES_DRAFT_DETAILS, or CONTACT_BALANCE_REPORT.
- name string
- self boolean
- size integer
- tags array[object]
  Hide tags attributes Show tags attributes object
  
  id integer
  
  name string
id integer
isFromLockedAccountingPeriod boolean
isOrganizationNameIncluded boolean
isTreatedByManagingOrganization boolean
organizationId integer
paymentChartId integer
payments array[object]
Hide payments attributes Show payments attributes object
- accountNumber string
- bankCharges string
- id integer
- isFromLockedAccountingPeriod boolean
- lineCode string
- paidAmount string
- payableByAccountId integer
- payableToBankId integer
- paymentType string
  
  Values are BANK_TRANSFER, BVR, or QR_BILL.
- plannedDate string
- qrBillData string
- referenceNumber string
- requestedAmount string
- requestedDate string
- sentDate string
- valueDate string
reference string
status string

Values are NEW, PROCESS, CONVERT, or RECOGNIZING.
supplierId integer
validated boolean
vatType string

Values are NO_VAT, NATIVE, or IMPORT_OF_SERVICE.
vatTypeCodeId integer
warnings string

Responses

• 200

OK
Hide response attribute Show response attribute object
- items array[object]
  
  Hide items attributes Show items attributes object
  
  error boolean
  
  errorCode object
  
  Hide errorCode attributes Show errorCode attributes
  
  errorCode string
  
  Values are NO_ERROR, NOT_IMPLEMENTED_YET, CONTACT_NOT_FOUND, FIELD_REQUIRED, VALIDATION_ERROR, DUPLICATION_ERROR, UNIQUE_CONSTRAINT_VIOLATION, WRONG_PASSWORD_FORMAT, WRONG_PASSWORD, ACTION_DENIED, NOT_FOUND, EXPECTED_ONE_FILE, UNIQUE_VIOLATION, CONTENT_EMPTY, INVALID_TYPE, CONVERSION_ERROR, FILE_PARSE_EXCEPTION, or IN_USE.
  
  errorDetailValues array[object]
  
  Hide errorDetailValues attributes Show errorDetailValues attributes object
  
  data string
  
  errorCode string
  
  fieldName string
  
  isSevere boolean
  
  freshData object
  
  freshRow object
  
  possibleWorkflows array[object]
  
  Hide possibleWorkflows attributes Show possibleWorkflows attributes object
  
  id integer
  
  name string
  
  severeError boolean
• 400

400 Bad Request
• 401

401 Unauthorized
• 403

403 Access Denied
• 404

404 Not Found
• 500

500 Internal Server Error

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

curl \
 -X PUT http://wyzio.app/api-v1/purchase-invoice-scan/batch \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string" \
 -d '[{"amounts":[{"amountType":"NO_VAT","id":42,"net":"string","vat":"string","vatRateId":42,"vatType":"NO_VAT","vatTypeCodeId":42}],"attributions":[{"appliedAllocationRules":["string"],"articleId":42,"chartOfAccountsId":42,"dateFrom":"string","dateTo":"string","departmentId":42,"endDate":"string","id":42,"net":"string","orderId":42,"orderIdToDisplay":"string","percent":"string","quantity":"string","reBill":true,"reBillDate":"2024-05-04T09:42:00+00:00","readOnly":true,"shipments":[{"articleId":42,"articleIdSku":"string","articleName":{"de":"string","en":"string","fr":"string","it":"string"},"attributionId":42,"currencyCode":"string","generatedStockMovementId":42,"id":42,"quantity":"string","shipmentDate":"string","totalCost":42.0}],"startDate":"string"}],"comment":"string","currencyId":42,"date":"string","description":"string","document":{"comments":"string","contact":{"email":"string","id":42,"name":"string"},"createdBy":"string","createdOn":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","date":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","entityId":42,"fileExtension":"string","fileId":42,"id":42,"isSystem":true,"module":"ALL","name":"string","self":true,"size":42,"tags":[{"id":42,"name":"string"}]},"id":42,"isFromLockedAccountingPeriod":true,"isOrganizationNameIncluded":true,"isTreatedByManagingOrganization":true,"organizationId":42,"paymentChartId":42,"payments":[{"accountNumber":"string","bankCharges":"string","id":42,"isFromLockedAccountingPeriod":true,"lineCode":"string","paidAmount":"string","payableByAccountId":42,"payableToBankId":42,"paymentType":"BANK_TRANSFER","plannedDate":"string","qrBillData":"string","referenceNumber":"string","requestedAmount":"string","requestedDate":"string","sentDate":"string","valueDate":"string"}],"reference":"string","status":"NEW","supplierId":42,"validated":true,"vatType":"NO_VAT","vatTypeCodeId":42,"warnings":"string"}]'

Request example

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

# Payload
[
  {
    "amounts": [
      {
        "amountType": "NO_VAT",
        "id": 42,
        "net": "string",
        "vat": "string",
        "vatRateId": 42,
        "vatType": "NO_VAT",
        "vatTypeCodeId": 42
      }
    ],
    "attributions": [
      {
        "appliedAllocationRules": [
          "string"
        ],
        "articleId": 42,
        "chartOfAccountsId": 42,
        "dateFrom": "string",
        "dateTo": "string",
        "departmentId": 42,
        "endDate": "string",
        "id": 42,
        "net": "string",
        "orderId": 42,
        "orderIdToDisplay": "string",
        "percent": "string",
        "quantity": "string",
        "reBill": true,
        "reBillDate": "2024-05-04T09:42:00+00:00",
        "readOnly": true,
        "shipments": [
          {
            "articleId": 42,
            "articleIdSku": "string",
            "articleName": {
              "de": "string",
              "en": "string",
              "fr": "string",
              "it": "string"
            },
            "attributionId": 42,
            "currencyCode": "string",
            "generatedStockMovementId": 42,
            "id": 42,
            "quantity": "string",
            "shipmentDate": "string",
            "totalCost": 42.0
          }
        ],
        "startDate": "string"
      }
    ],
    "comment": "string",
    "currencyId": 42,
    "date": "string",
    "description": "string",
    "document": {
      "comments": "string",
      "contact": {
        "email": "string",
        "id": 42,
        "name": "string"
      },
      "createdBy": "string",
      "createdOn": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
      "date": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
      "entityId": 42,
      "fileExtension": "string",
      "fileId": 42,
      "id": 42,
      "isSystem": true,
      "module": "ALL",
      "name": "string",
      "self": true,
      "size": 42,
      "tags": [
        {
          "id": 42,
          "name": "string"
        }
      ]
    },
    "id": 42,
    "isFromLockedAccountingPeriod": true,
    "isOrganizationNameIncluded": true,
    "isTreatedByManagingOrganization": true,
    "organizationId": 42,
    "paymentChartId": 42,
    "payments": [
      {
        "accountNumber": "string",
        "bankCharges": "string",
        "id": 42,
        "isFromLockedAccountingPeriod": true,
        "lineCode": "string",
        "paidAmount": "string",
        "payableByAccountId": 42,
        "payableToBankId": 42,
        "paymentType": "BANK_TRANSFER",
        "plannedDate": "string",
        "qrBillData": "string",
        "referenceNumber": "string",
        "requestedAmount": "string",
        "requestedDate": "string",
        "sentDate": "string",
        "valueDate": "string"
      }
    ],
    "reference": "string",
    "status": "NEW",
    "supplierId": 42,
    "validated": true,
    "vatType": "NO_VAT",
    "vatTypeCodeId": 42,
    "warnings": "string"
  }
]

Response examples (200)

{
  "items": [
    {
      "error": true,
      "errorCode": {
        "errorCode": "NO_ERROR",
        "errorDetailValues": [
          {
            "data": "string",
            "errorCode": "string",
            "fieldName": "string",
            "isSevere": true
          }
        ]
      },
      "freshData": {},
      "freshRow": {},
      "possibleWorkflows": [
        {
          "id": 42,
          "name": "string"
        }
      ],
      "severeError": true
    }
  ]
}