Vouchers

Vouchers represent financial documents in the system that can be linked to various entities such as documents, journal entries, and collections. They form a crucial part of the financial document management system.

Status Values

Voucher Status

| Value | Description | |——-|————-| | PENDING | Initial state, voucher awaiting processing | | DRAFT | Voucher is being worked on, can be modified | | ARCHIVED | Voucher has been archived and is no longer active | | BOOKED | Voucher has been posted to the accounting system | | DELETED | Voucher has been marked as deleted |

Document Types

Accounts Receivable Documents

| Value | Description | |——-|————-| | ARINV | AR Invoice - Customer invoice | | ARCRN | AR Credit Note - Customer credit note | | ARCIN | AR Cash Invoice - Customer cash invoice | | ARPIN | AR Proforma Invoice - Customer proforma invoice | | ARDEB | AR Debt Collection - Customer debt collection document |

Accounts Payable Documents

| Value | Description | |——-|————-| | APINV | AP Invoice - Supplier invoice | | APCRN | AP Credit Note - Supplier credit note | | RECPT | AP Receipt - Supplier receipt | | APCIN | AP Cash Invoice - Supplier cash invoice | | APPIN | AP Proforma Invoice - Supplier proforma invoice | | APDEB | AP Debt Collection - Supplier debt collection document |

Settlement Documents

| Value | Description | |——-|————-| | PAYSR | Payment Settlement Report | | SALSM | Sales Summary | | VATST | VAT Settlement - For payment of VAT | | VATRP | VAT Report - For reporting VAT |

Payroll Documents

| Value | Description | |——-|————-| | PRRUN | Payroll Run | | PRPAY | Payroll Payment List | | PRTAX | Payroll Tax Settlement |

Workflow Status

| Value | Description | |——-|————-| | IMAGE_PROCESSING | Document image is being processed and text extracted | | STARTING_WORKFLOW | Initial workflow setup is in progress | | CLASSIFICATION | Document type is being determined | | DATA_EXTRACTION | Relevant data is being extracted from the document | | WAITING_FOR_ANSWER | Workflow is paused waiting for user input | | DUPLICATE_CHECK | Checking for duplicate documents | | BOOKING | Document is being posted to the accounting system | | RECONCILING | The document’s reconciliation lines are being reconciled with the books | | CANCELLED | Workflow has been cancelled | | FAILED | Workflow failed and requires manual intervention | | COMPLETED | Workflow has completed successfully |

List Vouchers

GET /api/v2/vouchers

Retrieves a paginated list of vouchers based on specified filters.

Query Parameters

Dot-notation aliases

The parameters that filter on the voucher’s document or on its journal entry lines also accept a prefixed form. When both are sent, the prefixed one wins.

Document payment filters

These filter on the voucher’s document and are only available in the prefixed form. See Documents for what each flag means.

Response Fields

A voucher is an uploaded file, so every response also includes the base uploaded-file fields in addition to the voucher-specific ones below.

Related Objects

The following related objects can be included using the with parameter:

• attachments: Associated file attachments
• documents: Linked commercial documents
• document: Primary document
• journal_entries: Associated journal entries
• journal_entry: Primary journal entry
• statements: Associated statements
• statement: Primary statement
• tasks: Related worker tasks
• questions: Associated accounting questions
• collection: Associated voucher collection
• project: Associated project

Example Request

GET /api/v2/vouchers?status=PENDING&document_date_from=2024-01-01&with=documents,journal_entries

Array-valued parameters (status, document_type, with, etc.) take a single query value with items separated by comma, semicolon, or space — not repeated key[]= params.

Example Response

{
  "data": [
    {
      "id": 1234,
      "created_at": "2024-01-15T10:30:00Z",
      "client_account_id": 7,
      "type": "APINV",
      "file_name": "invoice.pdf",
      "content_type": "application/pdf",
      "channel": "email",
      "size": 84213,
      "is_active": true,
      "thumbnail_url": "https://...",
      "preview_url": "https://...",
      "download_url": "https://...",
      "original_url": "https://...",
      "page_images": [],
      "document_date": "2024-01-15",
      "status": "PENDING",
      "collection_id": 567,
      "project_id": 890,
      "workflow_status": "DATA_EXTRACTION",
      "documents": [
        {
          "id": 456,
          "type": "APINV",
          "status": "PENDING"
        }
      ],
      "journal_entries": [
        {
          "id": 789,
          "posting_date": "2024-01-15",
          "status": "DRAFT"
        }
      ]
    }
  ],
  "meta": {
    "records": 45,
    "per_page": 100,
    "page": 1,
    "pages": 1
  }
}

Error Responses

Get Single Voucher

GET /api/v2/vouchers/{id}

Retrieves a specific voucher by ID.

Path Parameters

Example Request

GET /api/v2/vouchers/1234?with[]=documents&with[]=journal_entries

Example Response

{
  "id": 1234,
  "created_at": "2024-01-15T10:30:00Z",
  "client_account_id": 7,
  "type": "APINV",
  "file_name": "invoice.pdf",
  "content_type": "application/pdf",
  "channel": "email",
  "size": 84213,
  "is_active": true,
  "thumbnail_url": "https://...",
  "preview_url": "https://...",
  "download_url": "https://...",
  "original_url": "https://...",
  "page_images": [],
  "document_date": "2024-01-15",
  "status": "PENDING",
  "collection_id": 567,
  "project_id": 890,
  "workflow_status": "DATA_EXTRACTION",
  "documents": [
    {
      "id": 456,
      "type": "APINV",
      "status": "PENDING"
    }
  ],
  "journal_entries": [
    {
      "id": 789,
      "posting_date": "2024-01-15",
      "status": "DRAFT"
    }
  ]
}

Error Responses

Delete Voucher

DELETE /api/v2/vouchers/{id}

Permanently deletes a voucher along with its draft journal entries and draft documents. Returns 204 No Content on success.

Deletion is rejected when the voucher still has accounting relations that must be preserved:

• It has posted (non-cancelled) journal entries.
• Its documents have reconciliation lines referenced by a live (non-archived) external reconciliation record.
• It has posted (non-cancelled) documents.
• It has accounts-receivable documents created in-app (sendable documents).

In these cases the request fails with 400 Bad Request and the standard v2 error envelope ({"error": {"code", "message", "request_id"}}), with message describing the relation that blocked the deletion.

Path Parameters

Error Responses

Endpoints

Merge Vouchers

POST /api/v2/vouchers/merge

Merges multiple vouchers into a single PDF voucher. PDFs and images from the source vouchers are combined into one document. Non-PDF files (Word, Excel, etc.) are transferred as attachments on the merged voucher. The page order in the merged PDF follows the order of the voucher_ids array.

Request Body

Source Action Values

Example Request

{
  "voucher_ids": [101, 102, 103],
  "source_action": "ARCHIVE"
}

Example Response (201 Created)

Returns the merged voucher with the same shape as Get Single Voucher (abbreviated here):

{
  "id": 200,
  "created_at": "2026-04-10T08:30:00Z",
  "type": "APINV",
  "document_date": "2026-04-10",
  "status": "PENDING",
  "collection_id": null,
  "project_id": null,
  "workflow_status": null
}

Error Responses

Split Voucher

POST /api/v2/vouchers/split

Splits a multi-page PDF voucher into multiple vouchers by page ranges. Each page range produces a new voucher. Pages are 1-indexed and ranges are inclusive. If the source voucher has a statement, it is copied to all new vouchers.

Request Body

The source_action values are the same as for Merge Vouchers.

Example Request

{
  "voucher_id": 456,
  "page_ranges": [[1, 2], [3, 5], [6, 6]],
  "source_action": "DELETE"
}

Example Response (201 Created)

Returns an array of newly created vouchers (same shape as Get Single Voucher, abbreviated here), one per page range:

[
  {
    "id": 457,
    "created_at": "2026-04-10T09:00:00Z",
    "document_date": "2026-04-10",
    "status": "PENDING",
    "collection_id": null,
    "project_id": null,
    "workflow_status": null
  },
  {
    "id": 458,
    "created_at": "2026-04-10T09:00:00Z",
    "document_date": "2026-04-10",
    "status": "PENDING",
    "collection_id": null,
    "project_id": null,
    "workflow_status": null
  },
  {
    "id": 459,
    "created_at": "2026-04-10T09:00:00Z",
    "document_date": "2026-04-10",
    "status": "PENDING",
    "collection_id": null,
    "project_id": null,
    "workflow_status": null
  }
]

Error Responses

Voucher Statements

Voucher statements capture user-provided metadata about a voucher, such as the expense purpose, item categories, payment method, and payor. They are used during the document processing workflow to enrich vouchers with accounting-relevant information. Creating or updating a statement can trigger automatic updates to the linked journal entry (e.g. setting the project dimension) and influence the document posting workflow.

List Voucher Statements

GET /api/v2/vouchers/{id}/statements

Returns a paginated list of statements for a specific voucher, ordered by creation date (newest first).

Path Parameters

Query Parameters

Response

{
  "data": [
    {
      "id": 10,
      "created_by_id": 7,
      "created_at": "2026-04-10T09:15:00Z",
      "client_account_id": 7,
      "voucher_id": 1234,
      "voucher_category_id": 2,
      "item_categories": "ELECTRONICS,SOFTWARE_CLOUD_SERVICES",
      "purpose": "WORKPLACE_EQUIPMENT",
      "participant_information": null,
      "additional_information": "New laptop for development team",
      "payment_method": "BUSINESS_CARD",
      "payor_id": null,
      "project_id": 5,
      "collection_id": null
    }
  ],
  "meta": {
    "page": 1,
    "pages": 1,
    "per_page": 100,
    "records": 1
  }
}

Error Responses

Create Voucher Statement

POST /api/v2/vouchers/{id}/statements

Creates a new statement for a voucher. When a statement is created, the system may automatically update the linked journal entry’s project dimension and manage document posting workflow tasks.

Path Parameters

Request Body

Example Request

{
  "item_categories": "ELECTRONICS",
  "purpose": "WORKPLACE_EQUIPMENT",
  "payment_method": "BUSINESS_CARD",
  "project_id": 5,
  "additional_information": "New laptop for development team",
  "tags": [{"id": 1}]
}

Response (201 Created)

Returns the created statement object (same shape as list response items).

Error Responses

Statement Attributes

Relationships

Payment Methods

Purpose Values

Item Categories

The item_categories field accepts one or more of the following enum values, separated by commas. Any other value is rejected with 400 Invalid item category. See Voucher Statements for the full reference.

ELECTRONICS, FOOD, HOUSEHOLD_ITEMS, OFFICE_OR_WAREHOUSE_SPACE, FUEL, VEHICLES, HIRED_LABOR_CONSULTANCY, BROADBAND_TELEPHONY, ELECTRICITY, BUILDING_MATERIALS, SOFTWARE_CLOUD_SERVICES, CLOTHING, TRANSPORT_TRAVEL, TOOLS, FURNITURE_INTERIOR, CLEANING_EQUIPMENT, WELLNESS_ITEMS, ADVERTISING, SHIPPING_POSTAGE_CUSTOMS, INSURANCE, PAYMENT_SERVICES_FEES, MEDICAL_SUPPLIES, BOOKS_MAGAZINES, EDUCATION_TRAINING, ENTERTAINMENT, GIFTS_NOVELTIES, HARDWARE, LEGAL_SERVICES, OUTDOOR_GARDEN, PET_SUPPLIES, SPORTS_FITNESS, TOYS_GAMES, TRAVEL_ACCOMMODATION

Related Resources

• Documents
• Journal Entries
• Projects
• Business Partners
• Voucher Collections