Overview

Classer - API Documentation

INTRODUCTION

Welcome to the Classer API documentation. This guide explains how Classer connects with external systems so organizations can manage invoices, receipts, outcomes, and customer records in one consistent workflow.

It is intended for businesses, implementation teams, and service providers who need to connect their platforms with Classer for daily financial and CRM operations.

To use this API successfully, begin by reviewing the process flow in this documentation, follow the recommended order of actions, and ensure your team works with the correct environment details shown on this page.

We continuously improve this platform, so parts of the integration journey may evolve over time. We recommend checking this guide regularly to stay aligned with the latest updates.

Should you have any inquiries or require assistance, please do not hesitate to contact our technical support team at support@Classer.co.il. To expedite the resolution of your queries, kindly provide a detailed description of your issue. We will promptly identify the problem and provide you with the necessary support.

Thank you for choosing Classer. We are committed to delivering a seamless and reliable API experience for your invoices and CRM processing needs.

Classer REST API URL's

Classer provides dedicated environments for real operations.

Use the correct environment for your activity and make sure the access details you use match that environment.

Following the guidance in each section will help you maintain a smooth and reliable integration experience with Classer.

REST API URLs

Postman testing collection

Download the ready-to-use Postman collection and environment template to validate your integration quickly in a shared testing flow.

Download collectionDownload environment

Environment variables included: baseUrl, apiKey, pageSize, pageNumber, search and document/report placeholders. Update values with your account data before running requests.

Pricing note: use request field vatType with values 1 (BeforeVat) or 2 (IncludeVat). ovrlPrice is optional for incomes/receipts/bundle and computed server-side.

NameURLPurpose
Base URLhttps://api.gorder.co.il/api/externalAll external routes in this controller use this prefix.
Panel loginhttps://panel.classer.co.il/loginReturned by GET /api/external/account/login-url.

Last REST API updates

Switch versions from the left to compare past stable and new preview changes.

DateVersionStatusSummary
2026-04-19v1.0.3stableDocument types GET, list pagination, internalNotes on documents, and expanded API reference.
2026-04-15v1.0.2deprecatedAdded generic create/get documents endpoints and cancellation support.
2026-03-22v1.0.1deprecatedAdded tax connect/verify and account details endpoints.
2025-10-10v1.0.0deprecatedLegacy endpoint set retained for backward compatibility.

Prerequisite endpoint requests

Send X-API-Key on every request. For outcomes, resolve categoryId via lookups before Add Outcome. Then follow the ordered steps below.

Snippet

Terminal (curl) — send the key in a header, not in the JSON body:

curl -X POST "https://api.gorder.co.il/api/external/account/details" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_EXTERNAL_API_KEY" \
  -d "{}"

Same header for every POST/GET under /api/external/.

  1. 1. Send X-API-Key on every request

    The server resolves the customer from the X-API-Key header. JSON bodies must not include apiKey.

  2. 2. Resolve categories for expenses

    Use an category id from this list as categoryId on Add Outcome.

    Jump to endpoint

  3. 3. Resolve document type for expenses

    Optional: pick expense/income/receipt DocumentType when integrating generic create or external tooling.

    Jump to endpoint

  4. 4. Confirm account details

    Check active, verified, and tax connection before write operations.

    Jump to endpoint

Contacts of Clients and Suppliers

Clients, suppliers, account details, and login URL.

Endpoints

Documents

Income, outcome, receipt flows, cancel, and generic create/list.

Endpoints

Generic Documents

Generic create/list.

Endpoints

Expenses

Expense create and view.

Endpoints

Reports

Period and accounting reports.

Endpoints

Tax Connectivity

Connect and verify tax authority linkage.

Endpoints

Account

Account details, and login URL.

Endpoints

Lookups

Account indexes, expense types, and journal entry document type selection.

Endpoints

Enums and utilities

Document Type

Used by account-indexes/get body and document-types/get optional category filter.

NameValueDescription
INCOME0Income-side accounts/types.
OUTCOME1Outcome/expense accounts/types.
RECEIPT2Receipt-side types.

Type (documents/create)

Type selector for generic document creation.

NameValueDescription
Invoice1Income invoice flow.
Outcome2Outcome/expense flow.
Receipt3Receipt flow.
TaxInvoiceReceipt4Bundle invoice+receipt flow.

VatType

Controls how item prices are interpreted when creating income/bundle documents.

NameValueDescription
BeforeVat1Items are sent excluding VAT (net prices).
IncludeVat2Items are sent including VAT (gross prices); backend normalizes item unit/line values to VAT-excluded.

Document type code mapping

Mapping used by ExternalController.MapExternalDocumentTypeCode for external type to internal document code resolution.

NameValueDescription
חשבונית/חשבונית עסקה300חשבונית/חשבונית עסקה
חשבונית מס305חשבונית מס
חשבונית מס/קבלה320חשבונית מס/קבלה
חשבונית זיכוי330חשבונית זיכוי
קבלה400קבלה
יציאה מקופה410יציאה מקופה

Payment Methods

Payment type values used in receipt payment lines for v2 endpoints.

NameValueDescription
CASH0Cash payment.
CREDIT1Credit card payment.
TRANSACTION2Bank transfer payment.
CHEQUE3Cheque payment.
HOLD_TAX4Withholding tax payment.
BIT5BIT payment method.
APPLE_PAY6Apple Pay.
GOOGLE_PAY7Google Pay.

Utilities

Shared helpers and integration notes used across endpoints.

UtilityDescriptionValue
AuthenticationSend API key in request header, not body.X-API-Key: <customer_external_api_key>
PaginationOptional pageSize/pageNumber/search on list endpoints; both size and number null or -1 returns all rows.Example: { "pageSize": 20, "pageNumber": 1, "search": "INV" }
Verification behaviorSome write endpoints require verified customer status.Unverified requests may return 400