Abacus Web API

A REST service for transferring purchase/sales invoices, collection and payment vouchers from your agency and operator applications into Abacus, and for querying and reversing what you transferred.

Overview

How does it work?

The Abacus Web API lets agency and operator software read accounting definitions, transfer purchase/sales invoices and collection/payment vouchers into Abacus, query the transferred records and reverse them when needed. Every request is authorized with a Bearer token.

Base address{{baseUrl}} — specific to your installation, provided by the Abacus team
AuthenticationOAuth 2.0 password flow, Authorization: Bearer <token>
HTTP methodsOnly GET and POST. PUT and DELETE are not used.
Endpoint format{{baseUrl}}/api/{controller}/{action} — e.g. /api/values/updateintegration. Action names are case-insensitive.
Body formatJSON (recommended). updateintegration also accepts XML.
Character setUTF-8
Datesyyyy-MM-dd or yyyy-MM-ddTHH:mm:ss (e.g. 2026-08-05)
DecimalsDot in JSON: 36.5544. Do not use thousands separators.

Integration steps

  1. Get a token

    Get an access token with POST /token and use it on every request for 2 days.

  2. Read the definitions

    Read account codes, users, currencies, branches and cost centers, and map them to your own system.

  3. Send the document

    Send the invoice or voucher with POST /api/values/updateintegration. Store the id (voucher number) and GuidId from the response.

  4. Check

    Query the transferred records with GetSlipListX and GetInvoiceReportX.

  5. Correct if needed

    There is no update: reverse the wrong record with integrationreturn, fix it and send it again.

i

Before you start, get these from the Abacus team: the base address, username and password, the connection name and the integration user code that will appear on your records (KayitEdenString, e.g. CONNECT). See the FAQ.

Update

Changes since the previous document

This document was rebuilt from the current Abacus Web API code. Check your existing integration against the points below.

TopicCurrent behaviour
PUTNo endpoint uses PUT. GetSlipListX is now POST. A PUT call returns 405 Method Not Allowed.
Token lifetime2 days (expires_in ≈ 172799 seconds).
InsertCardAll of code1…code5 must be present in the URL (they may be empty). Optional EAIdNo, EACustName, EATaxOffice, EAAddress, EAEmail were added for e-document details.
New definition endpointsgetintbranches (branches) and getintwhcodes (withholding codes).
getintaccountsThe response also returns the account's currency (CurrCode) and VAT rate (VatRatio).
integrationreturnBesides the voucher number, reversal by booking number (Voucher), ResInfo and linked voucher (SourceSlipNo); UserCode records who reversed it.
Response formatObjects carry a "$id" field; fields whose value is null are left out. See Responses & Errors.
ClassesEvery request and response class (Icmal, Detay, InvoiceReport, KonaklamaVergisi, Slip…) is documented field by field. See Classes.
Authentication

Getting a token

Send a POST to /token with an application/x-www-form-urlencoded body. Use the returned access_token in the Authorization header of every subsequent request.

Form fieldRequiredDescription
grant_typeYesAlways password.
usernameYesAPI username provided by the Abacus team.
passwordYesAPI password.
connectionYesName of the company database to connect to (provided by the Abacus team). If a branch is assigned to the connection, records are written to that branch.
# Request
POST {{baseUrl}}/token
Content-Type: application/x-www-form-urlencoded

grant_type=password&username=APIUSER&password=APIPASSWORD&connection=CONNECTIONNAME
// Response — HTTP 200
{
  "access_token": "4ZVKa96Egt0Ep1MkQUXVKb9NrDsvMfAtS245AN4dL1hi...",
  "token_type": "bearer",
  "expires_in": 172799
}
// Failed sign-in — HTTP 400
{
  "error": "invalid_grant",
  "error_description": "Seçilen bağlantı tanımlı değil."
}

On subsequent requests:

GET {{baseUrl}}/api/values/getintaccounts
Authorization: Bearer ACCESS_TOKEN
!

The token is valid for 2 days. Do not request a new token for every call; store and reuse it. A request with an expired or invalid token returns 401 Unauthorized; in that case get a new token from /token and retry the request.

Rules

Response and error format

All responses are JSON. The rules below apply to every endpoint.

  • ✓ Business errors return HTTP 200. For transfer and reversal, judge success by the error field, not the HTTP code: empty ("") or missing means success, filled means it is the error message.
  • ✓ The "$id" field: every object in a response carries a field such as "$id": "1". It is the serializer's reference number; ignore it. If the same object repeats, "$ref" may appear.
  • ✓ Null fields are omitted: fields whose value is null are not in the response at all. Treat a missing field as null. Non-nullable numeric fields come back as 0.
  • ✓ Dates are returned as 2026-08-05T00:00:00.
  • ✓ Message texts can differ by installation language and version. Do not branch on message text in your code; show the message to the user or write it to your log.
HTTPWhen?Body
200The request was processed (it may still be a business error).The endpoint's response class; error filled on error.
400/token: wrong username, password or connection.{"error":"invalid_grant","error_description":"..."}
401No token, invalid or expired token.{"Message":"Authorization has been denied for this request."}
404Wrong endpoint name, or a required URL parameter is missing.{"Message":"No HTTP resource was found..."}
405Wrong method (e.g. PUT, or GET to a POST endpoint).{"Message":"The requested resource does not support http method 'PUT'."}
500Unexpected server error.{"Message":"An error has occurred."} — send the request and the time to Abacus support.
Reference Data

Accounting definitions

Before sending documents, read these lists and map them to your own codes. In documents you send the codes (Code); Abacus resolves the ids itself. Every list endpoint returns an array of IntegrationDefault.

MethodEndpointReturnsUsed in
GET/api/values/getintaccountsSub-ledger account codes: Id, Code, Name, CurrCode, VatRatioIcmal.CariKod, Detay.HesapKod
GET/api/values/geinttusersAbacus users: Id, Code, NameIcmal.KayitEdenString (= Code)
GET/api/values/getintcurrenciesCurrencies: Id, Code (TRY, USD, EUR…), NameDovizCinsiString
GET/api/values/getintbranchesBranches: Id, Code (branch name), Name (title)Icmal.IsyeriId (= Id)
GET/api/values/getcostaccountsCost centers: Id, Code, NameDetay.MasrafMerkezi (= Code)
GET/api/values/getintwhcodesWithholding (tevkifat) codes: Id, Code (601, 602…), NameIcmal.TevkifatKodu (= Code)
GET/api/values/InsertCardOpens a new account card, returns CardObjectNew customer / account
// GET /api/values/getintaccounts — sample response
[
  { "$id": "1", "Id": 338, "Code": "120.08.235", "Name": "YAZ TUR", "CurrCode": "EUR", "VatRatio": 0.0 },
  { "$id": "2", "Id": 689, "Code": "600.01.002", "Name": "YURT DIŞI SATIŞLAR", "CurrCode": "", "VatRatio": 10.0 }
]
!

If the server fails while reading a list, the array comes back with a single element whose Id is 0 (its Name holds the technical error). Never use an element with Id = 0 as a valid definition.

InsertCard — opening a new account card

Opens a new sub-ledger account under the given parent code with the next free number. For example, if the last code under 120.01 is 120.01.024, the new card is 120.01.025; if there is no code under it yet, 120.01.001 is opened. If the calculated code already exists, no card is opened and the existing card is returned.

ParameterRequiredDescription
code1…code5Yes*Levels of the parent code (120, 01…). All five must be present in the URL; leave the unused ones empty (code4=&code5=). A missing parameter returns 404.
accountnameYesAccount name (title).
EAIdNoNoTax number / national id. If filled, e-document details are also written to the card.
EACustName, EATaxOffice, EAAddress, EAEmailNoE-document title, tax office, address and email.
GET {{baseUrl}}/api/values/InsertCard?code1=120&code2=01&code3=&code4=&code5=&accountname=YAZ%20TUR&EAIdNo=9300199600
Authorization: Bearer ACCESS_TOKEN

// Response — CardObject
{ "$id": "1", "Id": 1204, "Code": "120.01.025", "Name": "YAZ TUR" }
i

Alternative: instead of opening the card first, send the document with OpenCards: true; CariKod and HesapKod cards missing in Abacus are then opened during the transfer. The /api/values/UpdateAccCard endpoint uses the Abacus desktop application's internal card model; in integrations use InsertCard or OpenCards.

Core Integration

Invoice / voucher transfer

All purchase/sales invoices and collection/payment vouchers go to a single endpoint. The body is an Icmal object (document header + Detay lines). The response is an errorhandler object.

MethodEndpointBodyResponse
POST/api/values/updateintegrationIcmal (JSON or XML)errorhandler

Fields required on every document

FieldRule
TarihDocument date. The exchange rate is looked up for this date.
DocType, IsSlipDocument type. See Document Types.
CariKodCustomer/supplier account code defined in Abacus (or OpenCards: true).
KayitEdenStringAbacus user code. The user must exist and be authorized in the branch. If empty or unknown, the document is rejected.
DovizCinsiString, KurDocument currency and exchange rate. For TL documents "TRY" and 1. See Currency, Rate & VAT.
KaynakName of the sending system (e.g. "Sejour", "MyApp"). A record sent with an empty Kaynak cannot be reversed with integrationreturn.
DetayAt least one line. Each line needs HesapKod, DovizCinsiString, DovizTutar (VAT included), Kdv, Kur. The sum of the lines' DovizTutar cannot be 0.

Example 1 — Foreign currency (USD) sales invoice, JSON

POST {{baseUrl}}/api/values/updateintegration
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

{
  "Tarih": "2026-08-05",
  "DocType": 1,
  "IsSlip": 0,
  "CariKod": "120.01.024",
  "KayitEdenString": "CONNECT",
  "DovizCinsiString": "USD",
  "Kur": 32.4567,
  "EvrakSeri": "ABC",
  "EvrakNo": "ABC2026000000123",
  "Aciklama": "August accommodation invoice",
  "Kaynak": "MyApp",
  "EACustName": "Sample Travel Ltd.",
  "EAIdNo": "9300199600",
  "EATaxOffice": "Muratpaşa",
  "EAEmail": "accounting@sampletravel.com",
  "EAAddress": "Lara Cad. No:1 Antalya",
  "Detay": [
    {
      "HesapKod": "600.01.002",
      "DovizCinsiString": "USD",
      "DovizTutar": 1100.00,
      "Kdv": 10,
      "Kur": 32.4567,
      "Aciklama1": "Accommodation 2 nights",
      "ResNo": "PX061022",
      "ResServiceType": "Kon",
      "ResServiceName": "ADORA GOLF HOTEL",
      "ResGuestName": "ALİ VELİ",
      "ResCountry": "TR",
      "GirisTarihi": "2026-08-10",
      "CikisTarihi": "2026-08-12",
      "indirimler": []
    }
  ]
}

Example 2 — TL purchase invoice (with withholding), JSON

{
  "Tarih": "2026-08-05",
  "DocType": 3,
  "IsSlip": 0,
  "CariKod": "320.01.010",
  "KayitEdenString": "CONNECT",
  "DovizCinsiString": "TRY",
  "Kur": 1,
  "EvrakSeri": "TRF",
  "EvrakNo": "TRF2026000000045",
  "Kaynak": "MyApp",
  "TevkifatKodu": "624",
  "Detay": [
    { "HesapKod": "740.01.001", "DovizCinsiString": "TRY", "DovizTutar": 12000.00, "Kdv": 20, "Kur": 1,
      "Aciklama1": "Transfer service", "MasrafMerkezi": "OPR", "indirimler": [] }
  ]
}

Example 3 — Collection voucher, JSON

{
  "Tarih": "2026-08-06",
  "DocType": 3,
  "IsSlip": 1,
  "CariKod": "120.01.024",
  "KayitEdenString": "CONNECT",
  "DovizCinsiString": "TRY",
  "Kur": 1,
  "EvrakNo": "COL-2026-0098",
  "Aciklama": "Bank transfer",
  "Kaynak": "MyApp",
  "Detay": [
    { "HesapKod": "102.01.001", "DovizCinsiString": "TRY", "DovizTutar": 25000.00, "Kdv": 0, "Kur": 1, "indirimler": [] }
  ]
}

Example 4 — Sales invoice, XML

<?xml version="1.0" encoding="UTF-8"?>
<Icmal>
  <Tarih>2026-08-05</Tarih>
  <DocType>1</DocType>
  <IsSlip>0</IsSlip>
  <CariKod>120.01.024</CariKod>
  <KayitEdenString>CONNECT</KayitEdenString>
  <DovizCinsiString>USD</DovizCinsiString>
  <Kur>32.4567</Kur>
  <EvrakNo>ABC2026000000123</EvrakNo>
  <Kaynak>MyApp</Kaynak>
  <Detay>
    <HesapKod>600.01.002</HesapKod>
    <DovizCinsiString>USD</DovizCinsiString>
    <DovizTutar>1100.00</DovizTutar>
    <Kdv>10</Kdv>
    <Kur>32.4567</Kur>
  </Detay>
  <Detay>
    ...second line...
  </Detay>
</Icmal>
i

XML notes: the root element is Icmal and each line is a separate Detay element. Decimals accept a dot or a comma (32.4567 / 32,4567); do not use thousands separators. In XML the EBOran field is named EBOrani; the BiletNo element is written to both TicketNo and EvrakNo; MusAdi can be used instead of EACustName. IsyeriId, IsEInv, KurAlis, MasrafMerkeziId and UntaxType are not read from XML. For new integrations use JSON.

Response

// Success — HTTP 200
{
  "$id": "1",
  "id": 2500,
  "id2": 0,
  "error": "",
  "Token": "",
  "Token1": "120.01.024",
  "GuidId": "05b34756-cbf2-472f-b223-a379c56f5059"
}

// Business error — HTTP 200, error filled
{
  "$id": "1",
  "id": 0,
  "id2": 0,
  "error": "Abacus Error : User Not Found KayitEdenString-CONNECTX",
  "Token": ""
}

Messages come from the Abacus language table; depending on your installation they can be English or Turkish (e.g. User Not Found / Kullanıcı bulunamadı).

FieldMeaning
errorEmpty means the transfer succeeded. If filled, the document was not saved; show the message, fix it and send it again.
idAbacus voucher number (SlipNo). Store it for reversal and queries.
id2Number of the linked EB/advance or transfer voucher, if any; otherwise 0.
GuidIdUnique id of the record. Use it with the GuidId query filter; store it.
Token1The customer/supplier account code used.
errdatainfoOnly on error: technical diagnostic data. Do not show it to end users; attach it to support requests.

Reasons a document is rejected

  • ✓ The body is empty, the JSON/XML cannot be read, or Detay is empty / contains a null line.
  • ✓ The sum of the Detay lines' DovizTutar is 0.
  • ✓ CariKod, HesapKod, MasrafMerkezi or a currency code is not defined in Abacus (for customer and account codes you can send OpenCards: true).
  • ✓ KayitEdenString is empty, unknown, or the user is not authorized in the branch.
  • ✓ Kur was sent as 0 and Abacus has no exchange rate for that date.
  • ✓ On a purchase invoice (DocType 3) the same EvrakSeri + EvrakNo was already transferred for the same account. Depending on branch settings, duplicate document numbers can be checked for other document types too.
Document Types

DocType & IsSlip

These two fields determine the type of document you send. For vouchers (IsSlip = 1) DocType sets the debit/credit direction.

TransactionDocTypeIsSlipCustomer/supplier accountLine accounts
Sales invoice10DebitCredit (revenue + VAT)
Sales return invoice20CreditDebit
Purchase invoice30CreditDebit (expense + VAT)
Purchase return invoice40DebitCredit
Collection voucher (money in from a customer)31CreditDebit (cash/bank)
Payment voucher (money out to a supplier)11DebitCredit (cash/bank)
i

The IsCollect field ("1" / "2") is only for collection/payment breakdown scenarios set up separately with Abacus. In a standard integration do not send it or leave it empty.

Amount Rules

Currency, exchange rate and VAT

TL documents: Kur = 1

For a TL document send DovizCinsiString: "TRY" and write 1 in Kur both in the header and on every line. Do not write 0: 0 means "let Abacus find the rate"; Abacus then looks for a TRY rate for that date, and if there is none the document is rejected with an "exchange rate not found" error (Exchange rate can not found).

Foreign currency documents

What you sendWhat Abacus does
Kur > 0The rate you send is used. TL amount = DovizTutar × Kur.
Kur = 0The buying rate for the Tarih day is taken from the Abacus rate table. If there is no rate for that day, the document is rejected.
Line TLTutar > 0 and DovizTutar > 0TLTutar is used as the TL amount and the line rate is calculated as TLTutar / DovizTutar (no rounding differences).
Line currency differs from the document currencyThe line's DovizCinsiString and Kur are used; if the line rate is 0, that currency's daily rate is used.
i

If branch-specific integration settings are enabled, Abacus can ignore the rate you send and recalculate it from its own table. Ask the Abacus team which setting your installation uses.

VAT: DovizTutar includes VAT

DovizTutar (and TLTutar, if sent) is the line total including VAT. Abacus extracts the VAT from this amount: Net = DovizTutar / (1 + Kdv/100), VAT = DovizTutar − Net. The customer/supplier account receives the VAT-inclusive total of the lines.

// DovizTutar: 1100.00, Kdv: 10  →  Net 1000.00 + VAT 100.00, account 1100.00
  • ✓ Kdv is an integer percentage: 0, 1, 8, 10, 18, 20.
  • ✓ For VAT-exempt lines send Kdv: 0 and, if needed, UntaxType (exemption type code).
  • ✓ For accommodation tax send AccomodationRate (rate, e.g. 2) and ResServiceType: "Kon" on the line. If AccomodationRate > 0 and ResServiceType is empty, Abacus assumes "Kon"; AccomodationRate: 0 means no accommodation tax is calculated.
  • ✓ For a line discount add { "Aciklama": "...", "DovizTutar": 50.00 } to the indirimler list; the amount is deducted from the line's currency amount. If there is no discount send an empty list ([]), not null.
  • ✓ Send amounts with 2 decimals and rates with at most 6 decimals.
Correction

Reversal (integrationreturn)

There is no endpoint that updates a transferred record. Corrections are always made as reverse → fix → send again. The resent document gets a new voucher number.

MethodEndpointResponse
GET/api/values/integrationreturn?SlipNo=2500&UserCode=CONNECTerrorhandler
ParameterTypeDescription
SlipNointThe id from the transfer response. Linked transfer vouchers are deleted with it.
VoucherstringAlternative: reverses the record whose lines match this ResNo.
ResInfostringAlternative: reverses the record whose lines match this ResInfo.
SourceSlipNointReverses only the linked voucher (EB/advance/transfer): the value is the main voucher number.
UserCodestringAbacus user code performing the reversal (e.g. CONNECT). The action is logged under this user.
// Success
{ "$id": "1", "id": 0, "id2": 0, "error": "", "Token": "" }

// Not found
{ "$id": "1", "id": 2500, "id2": 0, "error": "Slip Not Found-in Db:ABACUS_COMPANY", "Token": "" }
  • ✓ Send at least one filter (SlipNo, Voucher or ResInfo).
  • ✓ Only records transferred through the API (Kaynak filled) can be reversed; records entered manually in Abacus cannot be deleted with this endpoint.
  • ✓ An e-invoice already sent to GİB cannot be reversed.
  • ✓ If the filter matches more than one document, nothing is done and an error is returned; reverse by SlipNo in that case.
Queries

Queries & preview

MethodEndpointBody / parameterResponse
POST/api/values/GetInvoiceReportXSlipFiterInvoiceReportResponse
POST/api/values/GetSlipListXVoucherFilterSlipRequestMessage
GET/api/default/GetInvoiceHtml?eguideid=E-invoice ETTN (UUID)HTML text (JSON string)
GET/api/default/GetInvoiceByte?eguideid=E-invoice ETTN (UUID)PDF, Base64 (JSON string)

GetInvoiceReportX — invoice report

Returns invoices (only DocType 1–4; vouchers are not in this report) at document-header level and optionally line level. The response also contains VAT lines (KdvRows) and accommodation tax lines (KonnaklamaVergisi).

// Request — date range + voucher number range
POST {{baseUrl}}/api/values/GetInvoiceReportX
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

{
  "DateBegin": "2026-08-01",
  "DateEnd": "2026-08-31",
  "VoucherNoBegin": 2400,
  "VoucherNoEnd": 2600,
  "DocType": 1,
  "Details": false
}

// Request — a single document
{ "GuidId": "05b34756-cbf2-472f-b223-a379c56f5059", "Details": true }
// Response — for the invoice in Example 1 (shortened)
{
  "$id": "1",
  "Handler": { "$id": "2", "id": 0, "id2": 0, "error": "", "Token": "" },
  "InvoiceReport": [
    {
      "$id": "3",
      "Id": 81231, "GuidId": "05b34756-cbf2-472f-b223-a379c56f5059", "SlipNo": 2500,
      "DocType": 1, "RowType": 0, "Dates": "2026-08-05T00:00:00",
      "DocNo": "ABC2026000000123", "InvSerie": "ABC",
      "Code": "120.01.024", "Name": "SAMPLE TRAVEL LTD.",
      "Currency": "USD", "Total": 35702.37, "TotalCurr": 1100.00, "ExcRate": 32.4567,
      "ResNo": "PX061022", "ResGuestName": "ALİ VELİ",
      "EAIdNo": "9300199600", "EACustName": "Sample Travel Ltd.",
      "RecDate": "2026-08-05T14:22:10", "RecUser": 12,
      "Amount0": 0.0, "VatTotal": 0.0, "RowVatAmount": 0.0, "...": "..."
    }
  ],
  "KonnaklamaVergisi": [],
  "KdvRows": [
    { "$id": "4", "Id": 81232, "GuidId": "05b34756-cbf2-472f-b223-a379c56f5059",
      "Credit": 32456.70, "CreditCurr": 1000.00, "VatAmount": 3245.67, "VatAmountCurr": 100.00,
      "VatRatio": 10.0, "AccCardId": 689, "VatCardId": 412, "AccomodationVatRate": 0.0 }
  ]
}

// A KonnaklamaVergisi element on an invoice with accommodation tax (sample values)
{ "$id": "5", "Id": 90412, "GuidId": "7d1c...", "Credit": 640.00, "CreditCurr": 19.72,
  "AccCardId": 0, "AccomodationCalc": true, "AccomodationVatRate": 2.0 }
!

Important: the list in the response is named KonnaklamaVergisi (double n); its elements are of class KonaklamaVergisi. KdvRows and KonnaklamaVergisi are filled by voucher number range; link their lines to invoices by GuidId. If Handler.error is filled, the report failed.

GetSlipListX — voucher list

Lists invoices and vouchers at document (voucher) level, one record per document. Use it to check whether your transferred records are in Abacus and to see lock/approval/e-ledger states.

// Request — records the CONNECT user transferred via the API in August
POST {{baseUrl}}/api/values/GetSlipListX
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

{
  "BeginDate": "2026-08-01",
  "EndDate": "2026-08-31",
  "Source": [1],
  "RecUser": 12
}

// Response (shortened)
{
  "$id": "1",
  "errhandler": { "$id": "2", "id": 0, "id2": 0, "error": "", "Token": "" },
  "SlipList": [
    { "$id": "3", "GuidId": "05b34756-cbf2-472f-b223-a379c56f5059", "SlipNo": 2500,
      "DocType": 1, "DocNo": "ABC2026000000123", "Dates": "2026-08-05T00:00:00", "BranchId": 1,
      "Total": 35702.37, "TotalCurr": 1100.00, "CurrId": 2, "IntSource": "MyApp",
      "Lock": false, "Confirm": false, "EledgerSent": false, "EarchiveCancel": false, "IntState": 0,
      "RecDate": "2026-08-05T14:22:10", "RecUser": 12, "CategoryId": 0 }
  ]
}

GetInvoiceHtml / GetInvoiceByte — e-invoice preview

The eguideid parameter is the e-invoice's ETTN (UUID). It works once the invoice has been approved on the Abacus E-Invoice screen and its e-invoice XML exists.

  • ✓ GetInvoiceHtml: returns the invoice's HTML view as a JSON string. If the invoice is not found it returns the text "<h5>E-Fatura Bulunamadı...</h5>".
  • ✓ GetInvoiceByte: returns the invoice PDF as a Base64-encoded JSON string; decode the Base64 and save it as .pdf. If the invoice is not found it returns null.
Data Models

Classes (models)

All classes used in requests and responses. JSON field names are exactly as in the tables (including case). A ? in a type means the field can be empty (null).

Icmal document header — updateintegration body

FieldTypeRequiredDescription
TarihDateTimeYesDocument date; the exchange rate is looked up for this date.
DocTypebyteYes1 Sales, 2 Sales return, 3 Purchase, 4 Purchase return. Sets the direction for vouchers (table).
IsSlipbyteYes0 Invoice, 1 Voucher (collection/payment).
CariKodstringYesCustomer/supplier account code (getintaccounts → Code). If not defined, it is opened with OpenCards: true.
KayitEdenStringstringYesAbacus user code recording the document (geinttusers → Code). The user must be authorized in the branch. A dedicated integration user is recommended (FAQ).
DovizCinsiStringstringYesDocument currency: TRY, USD, EUR… (getintcurrencies → Code).
KurdecimalYesDocument exchange rate. 1 for TL documents. For foreign currency, the rate or 0 (Abacus finds the daily rate). See Rate.
KaynakstringYesName of the sending system. Stored as the integration source on the records; if empty the record cannot be reversed through the API.
DetayList<Detay>YesDocument lines; at least one line.
EvrakNostringRecommendedDocument (invoice) number. On purchase invoices the same account + series + number is not accepted twice.
EvrakSeristringNoDocument series, at most 3 characters (longer values are cut).
AciklamastringNoDocument description (max 250 characters). If empty, the first line's Aciklama1 is used.
IsyeriIdintNoBranch id (getintbranches → Id). If a branch is assigned to the token's connection, that branch applies; with a single branch it is selected automatically.
OpenCardsbool?Notrue: open CariKod, HesapKod, EBHesapKodu, AvansHesapKodu cards that do not exist in Abacus.
EACustNamestringNoE-document recipient title / name. If empty, taken from the account card.
EAIdNostringNoRecipient tax number (10 digits) / national id (11 digits). If empty, taken from the account card.
EATaxOfficestringNoRecipient tax office.
EAAddressstringNoRecipient address.
EAEmailstringNoRecipient email address (e-archive delivery).
IsEInvbool?NoIs it an e-invoice? For invoices Abacus re-determines it from the e-invoice registration on the account card.
TevkifatKodustringNoWithholding code (getintwhcodes → Code, e.g. 624). On purchase invoices the withholding rate and account are applied; an unknown code produces no withholding.
TicketNostringNoTicket number (ticket integrations).
AttachmentsstringNoAttachment file name / path; written to the created lines.
KurAlisdecimal?NoPurchase (cost) rate. If empty/0 it is completed from the rate.
SatTarihi, TurTarihiDateTime?NoSale and tour date. If the branch's tour/ticket transfer setting is on, they can be used as the document or rate date.
EBHesapKodustringNoAccount code of the EB (early booking) transfer.
EBOranstringNoEB rate as text (e.g. "10"). Empty or "0": no EB entry. XML name EBOrani.
DovizEBTutardecimal?NoEB amount (in document currency). TL equivalent DovizEBTutar × Kur.
AvansHesapKodustringNoAccount code of the advance transfer.
AvansOranistringNoAdvance percentage as text. Empty or "0": no advance entry. EB and advance fields are ignored on purchase returns (DocType 4). The linked voucher's number is returned as id2.
VirmanList<Detay>NoTransfer lines linked to the main document. Each line creates two opposing accounting lines; accounts must already exist. If the transfer cannot be saved, the main document is reversed too.
IsCollectstringNoOnly for special scenarios set up with Abacus ("1" collection, "2" payment breakdown). Do not send it in a standard integration.
CariId, KayitEden, DovizCinsiintDo not sendAbacus fills these from the CariKod, KayitEdenString, DovizCinsiString codes.

Detay document line — Icmal.Detay and Icmal.Virman

FieldTypeRequiredDescription
HesapKodstringYesRevenue / expense / service account (on vouchers, the cash/bank account). getintaccounts → Code.
DovizCinsiStringstringYesLine currency; usually the same as the document currency.
DovizTutardecimalYesLine total including VAT (in line currency, 2 decimals). The sum of all lines cannot be 0.
KdvintYesVAT percentage: 0, 1, 8, 10, 18, 20.
KurdecimalYesLine rate. 1 for TL lines. If 0, the document rate or daily rate is used.
TLTutardecimal?NoLine TL amount including VAT. If > 0 it is used directly as the TL amount and the rate is calculated as TLTutar / DovizTutar.
Aciklama1, Aciklama2stringNoAccounting line descriptions (max 250 characters).
ResNostringNoBooking / voucher number. Used for reversal with integrationreturn?Voucher=.
ResInfostringNoAdditional booking information (pax, operation note).
ResServiceTypestringNoService type: Kon accommodation, Trf transfer; other values are free text.
ResServiceNamestringNoService name (e.g. hotel name).
ResGuestNamestringNoGuest / customer name.
ResCountrystringNoGuest country.
GirisTarihi, CikisTarihiDateTime?NoBooking check-in / check-out date.
AccomodationRateint?NoAccommodation tax rate (%). If > 0 accommodation tax is extracted; if 0 it is not calculated; if left empty while ResServiceType: "Kon", 1 is assumed.
UntaxTypeshort?NoVAT exemption / exception type code.
MasrafMerkezistringNoCost center code (getcostaccounts → Code). If sent, it must exist.
MasrafMerkeziIdint?NoCost center id instead of the code.
indirimlerList<indirim>RecommendedLine discounts; amounts are deducted from the line's currency amount. Send [] if there is no discount.
IndirimSatiribool?Notrue: the line is a discount line that is not added to the document total.
F1…F6stringNoFree fields (150 characters). E.g. F1 customer name, F2 voucher/invoice no, F3 room type. F6 must be numeric.
DovizTutarAlisdecimal?NoLine purchase (cost) amount, currency.
TLTutarAlisdecimal?NoLine purchase (cost) amount, TL.
DovizCinsiStringAlisstringNoCurrency code of the purchase amount.
KurAlisdecimal?NoPurchase rate.
HesapIdintNoAccount id instead of HesapKod. Sending the code is recommended.
DovizCinsi, DovizTutarOrg, TLTutarOrg, price, pricecurr, AccomodationAmount, AccomodationAmountNotRounding, AccomodationAmountTry, AccomodationAmountTryNotRounding—Do not sendInternal fields filled by Abacus during calculation.

indirim element of Detay.indirimler

FieldTypeDescription
AciklamastringDiscount description.
DovizTutardecimalDiscount amount (in line currency); deducted from the line's DovizTutar.

errorhandler operation result — updateintegration, integrationreturn; Handler / errhandler in reports

FieldTypeDescription
errorstringEmpty ("") means success; filled means the error message. Abacus service errors come with the "Abacus Error : " prefix.
idintVoucher number created by the transfer (SlipNo).
id2intLinked EB/advance/transfer voucher number; otherwise 0.
GuidIdstringUnique id of the created record.
Token1stringCustomer/supplier account code used by the transfer.
Token, Token2, Token3stringTechnical fields; do not use them in integrations.
errdatainfostringTechnical diagnostic data on error (for support).
SqlQuerystringTechnical field; do not use.

IntegrationDefault definition list element — getint* endpoints

FieldTypeDescription
IdintAbacus id of the record. 0 means the list returned an error.
CodestringCode to send in documents (account code, user code, currency code, cost center code, withholding code). Branch name in getintbranches.
NamestringName / description. Branch title in getintbranches.
CurrCodestringgetintaccounts only: currency code of the account (empty = no currency / TL).
VatRatiodecimal?getintaccounts only: VAT rate defined on the account card.

CardObject InsertCard response

FieldTypeDescription
IdintAccount card id.
CodestringOpened (or already existing) account code; use it as CariKod / HesapKod in documents.
NamestringAccount name.

SlipFiter GetInvoiceReportX body

The class has many fields used by other reports as well; the ones below are the fields this endpoint uses. Do not send the others. If no filter is sent, every invoice you are authorized for is returned; always give a date or number range.

FieldTypeDescription
DateBegin, DateEndDateTimeDocument date range (inclusive).
VoucherNoBegin, VoucherNoEndintVoucher number (SlipNo) range.
GuidIdstringA single document. If sent, the other filters are ignored.
GuidIdListList<string>A list of documents.
DocTypebyte?A single document type (1–4).
InvTypeList<int>Several document types, e.g. [1,2].
InvNostringDocument number (EvrakNo), exact match.
seriestringDocument series (EvrakSeri).
AccCodeBegin, AccCodeEndstringAccount code range.
GroupCodestringAccount card group code.
CurrIdintCurrency id (getintcurrencies → Id).
BranchIdList<int>Branch id list.
DueDateBegin, DueDateEndDateTimeDue date range.
CategoriyId, SlipTypes, PayTypes, VouchertypesList<int>Category, voucher type, payment type, document type id lists (Abacus definitions).
F1…F5stringFilter by the account card's F1–F5 custom fields.
Detailsboolfalse (default): document header lines only (RowType 0). true: service lines too (RowType 1).
ColumnsList<string>InvoiceReport fields to leave out of the response (to make it smaller), e.g. ["Address1","Address2","BankIban"]. Leave empty to get all fields.

InvoiceReportResponse GetInvoiceReportX response

FieldTypeDescription
HandlererrorhandlerIf Handler.error is filled, the report failed.
InvoiceReportList<InvoiceReport>Invoice header lines (and service lines with Details: true).
KonnaklamaVergisiList<KonaklamaVergisi>Accommodation tax lines. Spelled with a double n.
KdvRowsList<KonaklamaVergisi>Service lines carrying VAT (net amount, VAT, withholding).

InvoiceReport element of InvoiceReportResponse.InvoiceReport — one accounting line

Each element is one accounting line. RowType 0 is the document's customer/supplier (header) line and carries the invoice total; RowType 1 is a service (revenue/expense) line. The lines of an invoice share the same GuidId.

FieldTypeDescription
Document and line
IdintAccounting line id.
GuidIdstringDocument id (the GuidId from the transfer response).
SlipNointVoucher number (the id from the transfer response).
DocTypebyte1 Sales, 2 Sales return, 3 Purchase, 4 Purchase return.
RowTypebyte?0 customer/supplier (header) line, 1 service line.
GeneralTypebyte?Abacus internal line class; informational.
DatesDateTimeDocument (accounting) date.
DocDateDateTime?Paper document date.
DocNostringDocument number (EvrakNo).
InvSeriestringDocument series (EvrakSeri).
DueDateDateTime?Due date.
OrderNoint?Order / sequence number.
CategorystringCategory name.
RowRemark, RowRemark2stringLine descriptions (Aciklama1, Aciklama2).
UnitRemark, Quantitystring / decimal?Unit and quantity.
CostCenterIdint?Cost center id.
VatRatiodecimal?VAT rate of the line.
WhtTax, WhRateshort? / stringWithholding code and rate.
UnTaxTypeshort?VAT exemption type.
AttachmentsstringAttachment information.
Account and amount
Code, Name, Name2stringAccount code and names of the line (the customer/supplier account on RowType 0).
CurrencystringLine currency code.
Totaldecimal?Line amount in TL (debit + credit). On RowType 0, the invoice's VAT-inclusive TL total.
TotalCurrdecimal?Line amount in currency.
ExcRatedecimal?Exchange rate.
Booking
ResNo, ResInfo, ResServiceType, ResServiceName, ResGuestName, ResCountrystringThe booking fields of the transferred Detay.
CiDate, CoDateDateTime?Check-in / check-out date (GirisTarihi, CikisTarihi).
E-document recipient (sent with the document)
EAIdNo, EACustName, EATaxOffice, EAAddress, EAEmailstringThe e-document fields of the transferred Icmal.
Account card details (from the card in Abacus)
IdNo, TaxOffice, isEInv, EWorkTypestring / bool? / byte?Tax number / national id, tax office, e-invoice registered or not, working type.
Address1, Address2, Street, BuildingNumber, CitySubdivisionName, City, Country, PostCodestringAddress details.
Tel, Tel2, Fax, Fax2, Email, Web, AuthorPerson, AuthorPerson2stringContact details and contact persons.
ExpiryDay, PayDayint?Payment term in days (both carry the same value).
BankName, BankBranch, BankAccount, BankIbanstringBank details.
Custom fields and record details
F1…F5stringText custom fields of the line.
F6…F10decimal?Numeric custom fields of the line.
RecDateDateTime?Record time.
RecUserint?Id of the user who recorded it (geinttusers → Id). Use it to separate your integration user's records.
Fields not filled by this endpoint
Fields that exist in the class but are not filled by GetInvoiceReportX: Amount0, Amount1, Amount8, Amount10, Amount18, Amount20, VatAmount1…VatAmount20, VatCardId1…VatCardId20, RowVatAmount, RowVatAmountCurr, VatTotal, VatTotalCurr, AccomodationLocal, AccomodationCurrency, AccomodationVatRate, WhAmount, WhMatrahTotal, TutarYazi, TutarYaziEng, TutarYaziCurrTr, TutarYaziCurrEng, CostCode, CostName, Tevkifat, CrossAccountCode, CrossAccountName, RecUserName. Numeric ones come back as 0, the others are not in the response. Use the KdvRows and KonnaklamaVergisi lists for VAT and accommodation tax amounts.

KonaklamaVergisi element of the KonnaklamaVergisi and KdvRows lists

The same class is used in two lists; different fields are filled in each. Amounts: Debit/Credit in TL, DebitCurr/CreditCurr in currency; the line amount is debit + credit (one of them is filled: credit on sales, debit on purchases).

FieldTypeKonnaklamaVergisiKdvRowsDescription
Idint✓✓Accounting line id.
GuidIdstring✓✓Document id; match it with InvoiceReport.GuidId.
Debit, Creditdecimal?✓✓TL debit / credit. In KonnaklamaVergisi the accommodation tax amount; in KdvRows the line amount excluding VAT (net).
DebitCurr, CreditCurrdecimal?✓✓The same amounts in currency.
AccomodationCalcbool?✓—Whether accommodation tax was calculated.
AccomodationVatRatedecimal?✓✓Accommodation tax rate (%); 0 if none.
VatRatiodecimal?—✓VAT rate (%).
VatAmount, VatAmountCurrdecimal?—✓VAT amount, TL and currency.
WhAmount, WhAmountCurrdecimal?—✓Withholding amount, TL and currency.
NotApplyWhbool?—✓true: no withholding is applied to this line.
AccCardIdint— (0)✓Account card id of the line (getintaccounts → Id).
VatCardIdint?—✓Card id of the VAT account.

VoucherFilter GetSlipListX body

The fields below are the ones this endpoint uses. If no end date is given, all records up to today are searched.

FieldTypeDescription
BeginDate, EndDateDateTimeDocument date range.
RecBeginDate, RecEndDateDateTimeRecord (transfer) time range.
GuidIdstringA single document.
GuidIdsList<string>A list of documents.
BeginVouhcer, EndVouhcerintVoucher number range. Send the field name with this spelling (Vouhcer).
BeginVouhcerTarget, EndVouhcerTargetintMain voucher number (SourceSlipNo) range, for linked vouchers.
DocNo, SerialstringDocument number and series.
DocTypesList<int>Document types (0 voucher, 1–4 invoice).
SlipTypesList<int>Voucher types (2 collection, 3 payment…).
SourceList<int>[1] only records transferred via the API, [2] only records entered in Abacus, empty = all.
ResNostringBooking number.
RecUserint?Id of the recording user (geinttusers → Id), e.g. the id of the CONNECT user.
BranchId, CategoryIdes, VoucherTypesList<int>Branch, category, document type id lists.
ColumnsList<string>Slip fields to leave out of the response, e.g. ["OwnerRemark","VoucherRemark"].

SlipRequestMessage GetSlipListX response

FieldTypeDescription
errhandlererrorhandlerIf errhandler.error is filled, the list failed.
SlipListList<Slip>The vouchers found.

Slip element of SlipRequestMessage.SlipList — one voucher/document

FieldTypeDescription
GuidIdstringDocument id.
SlipNoint?Voucher number.
SourceSlipNoint?For a linked voucher, the main voucher's number.
SlipTypebyte?Voucher type (2 collection, 3 payment; others are accounting voucher types).
DocTypebyte?0 voucher, 1–4 invoice types.
DocNostringDocument number.
Dates, DocDateDateTime?Document date, paper document date.
BranchIdint?Branch id.
Total, TotalCurrdecimal?Debit total, TL and currency.
CurrIdint?Currency id.
IntSourcestringIntegration source (the Kaynak of the transfer); empty for records entered in Abacus.
IntStateshort?Integration state code.
RecDate, RecUserDateTime? / int?Record time and recording user id.
ChgDate, ChgUserDateTime? / int?Last change time and user.
Lock, LockUser, LockDatebool? / int? / DateTime?Lock state.
Confirm, ConfirmUser, ConfirmDatebool? / int? / DateTime?Approval state.
EledgerSentbool?Sent to the e-ledger or not.
EarchiveCancelbool?E-archive cancelled or not.
Attachmentbool?Has an attachment or not.
Proformabool?Pro forma or not.
OwnerRemark, VoucherType, VoucherRemark, PayTypeId, OrderNo, CategoryId, SecurityId, CrossAccount—Description, document type, payment type, sequence number, category, security group and counter-account details.
UAEreporting_status, UAEexchange_status, UAEstatus_messagestringFilled only on UAE e-invoice installations; empty in Türkiye.
FAQ

Frequently asked questions

Is PUT used? How do I update a record?

No. Every endpoint is GET or POST; queries, including GetSlipListX, use POST. There is no endpoint that updates a transferred record: reverse it with integrationreturn, fix it and send it again with updateintegration. The new record gets a new voucher number.

Can a dedicated Abacus user (e.g. "CONNECT") be opened for KayitEdenString?

Yes, this is the recommended approach. Ask Abacus support or your Abacus administrator to open a dedicated integration user (e.g. CONNECT) and authorize it in the branch the records will be written to; then send "KayitEdenString": "CONNECT" on every document. If the user does not exist or is not authorized in the branch, the document is rejected.

To tell your records apart: find the Id of the CONNECT user with geinttusers. In GetSlipListX, use the "RecUser": Id and "Source": [1] filters to list only the records you transferred; in the GetInvoiceReportX response every line's RecUser field carries this id. To correct a record, reverse it with integrationreturn?SlipNo=...&UserCode=CONNECT and send it again; the reversal is also recorded under CONNECT.

What are the fields of the InvoiceReport and KonaklamaVergisi classes in the GetInvoiceReportX response?

The response is an InvoiceReportResponse object: Handler, InvoiceReport, KonnaklamaVergisi (double n) and KdvRows. All fields with descriptions are in the InvoiceReport and KonaklamaVergisi tables, together with the list of fields that are not filled. Take VAT and accommodation tax amounts from the KdvRows and KonnaklamaVergisi lists, matching them by GuidId.

For TL documents, should the Kur field be 0 or 1?

Write 1, both for Icmal.Kur and for every Detay.Kur. 0 means Abacus should find the rate in that date's rate table; if there is no TRY rate record, the document is rejected with an "exchange rate not found" error. For foreign currency documents send your own rate, or send 0 to use the Abacus daily rate.

Does DovizTutar include or exclude VAT?

It includes VAT. Abacus extracts VAT from the line amount (Net = DovizTutar / (1 + Kdv/100)). Example: DovizTutar 1100, Kdv 10 → net 1000, VAT 100.

What happens if I send the same invoice twice by mistake?

On purchase invoices the same series + number for the same account is not accepted a second time and an error is returned. For other document types the check depends on branch settings. Before resending, check with the DocNo filter of GetSlipListX whether the document is already in Abacus; reverse a duplicate with integrationreturn.

Why is there a "$id" field in the response, and why are some fields missing?

"$id" is the serializer's reference number; ignore it. Fields whose value is null are left out of the response; treat a missing field as null. Details: Responses & Errors.

How do I know whether there was an error?

Even when the HTTP code is 200, check the error field in the response: empty means success, filled means the document was not saved. Message text can differ by language and version, so do not branch on the text in your code.

Which branch are records written to?

If a branch is assigned to the connection you used to get the token, records are written to that branch and IsyeriId is ignored. Otherwise IsyeriId (getintbranches → Id) is used; with a single branch it is selected automatically. The KayitEdenString user must be authorized in that branch.

Is the Postman collection up to date?

The collection contains ready-made request examples. If you see a difference between the collection and this document (e.g. an old request using PUT), follow this document.

Let's start integrating

Get your username, password, connection name and integration user code, then try the endpoints right away with the ready-made requests in the collection.