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)

Path parameters

• id integer Required

  id

Responses

• 200 */*

  OK

  Hide response attributes Show response attributes object

  • 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
    • id integer
    • net string
    • officeId integer
    • 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 object

        • de string
        • en string
        • fr string
        • it string
      • attributionId integer
      • currencyCode string
      • generatedStockMovementId integer
      • id integer
      • quantity string
      • shipmentDate string
      • totalCost number
  • comment string
  • currencyId integer
  • date string
  • description string
  • document object
    Hide document attributes Show document attributes object

    • comments string
    • contact object
      Hide contact attributes Show contact attributes object

      • 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, CONTACT_BALANCE_REPORT, ORGANIZATION_CURRENCIES, ORGANIZATION_CURRENCIES_DETAILS, or FINANCIAL_STATEMENTS.

    • 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
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error