API

Есеп деректерінің барлық тұтынушылары үшін бірыңғай API. A3.Finance оны 1С және кез келген басқа сыртқы жүйемен тең дәрежеде пайдаланады.

API жұмысының төрт ережесі

  • Артықшылықты арна жоқ

    Базаға тікелей қолжетімділік және API-ды айналып өтетін ішкі шақырулар жоқ. Өз өнімі сыртқы есеп жүйесі алатын өрістер мен шектеулерді алады.

  • Бағыт біреу

    API есеп фактілерін сыртқа береді және жазуға ештеңе қабылдамайды. Тұтынушы өз проекциясын құрады, ал сандар барлығында бірдей.

  • Жою берілмейді

    Сторно беріледі. Тұтынушы түзетуді тіркелімдегідей көреді: сторнолайтын жазба және жаңа операция.

  • Идентификаторлар тұрақты

    Кезеңді қайта жүктеу проводкалар мен шоттардың сол идентификаторларын береді, сондықтан тұтынушы қайталанатын жазбалар құрмайды.

Сұрау бойынша жүктеу

Барлық әдістер заңды тұлғаны және беттік беруді қабылдайды. Проводкаларды инкременттік түрде алуға болады: тек соңғы синхрондаудан кейін өткізілгендерін.

GETGetChartOfAccounts

Шоттар жоспары: түрі, валютасы, аталық шоты, міндетті аналитикасы, шығу тегі

GETGetEntriesExport

Кезеңдегі немесе көрсетілген сәттен кейін өткізілген проводкалар

GETGetBalancesExport

Кезеңдегі айналым-сальдо ведомосі

GETGetCounterpartiesReference

Заңды тұлғаның контрагенттер анықтамалығы

GETGetPeriodsExport

Мәртебелері мен бақылау сомалары бар кезеңдер

Кезеңнің бақылау сомалары

Тұтынушы алынған проводкаларды қосып, жабылған кезеңнің сомаларымен салыстырады. Алшақтық дөңгелектеу қатесін емес, жоғалған бетті немесе аяқталмаған жүктеуді білдіреді.

GET /api/Contract/GetPeriodsExport?legalEntityId=…
API-KEY: a3c_9f2e…
{
  "year": 2026,
  "month": 1,
  "status": "Closed",
  "controlEntriesCount": 412,
  "controlTotalDebit": 18450320.55,
  "controlTotalCredit": 18450320.55
}

Оқиғаларға жазылым

Оқиғалар тәулігіне бір рет топтамамен емес, операциялар өткізілген сайын жарияланады.

accounting.entry.posted

Операция өткізілді

accounting.entry.reversed

Операция сторноланды

accounting.period.closed

Кезең жабылды, тұтынушы өзінде де сол кезеңді жабады

accounting.period.reopened

Кезең қайта ашылды, оның есептілігі өзгеруі мүмкін

accounting.reference.changed

Анықтамалық немесе шоттар жоспары өзгерді

Қолжетімділік және жеткізу

  • Тұтынушының API кілті тек хеш түрінде сақталады және бір рет көрсетіледі
  • Алты рұқсат: шоттар жоспары, проводкалар, қалдықтар, анықтамалықтар, кезеңдер, оқиғалар
  • Кілтті бір заңды тұлғамен шектеуге болады
  • Оқиға денесіне HMAC-SHA256 арқылы қол қойылады, әр оқиғаның идемпотенттік кілті бар
  • Жеткізілмеген оқиға өсіп отыратын кідіріспен он ретке дейін қайталанады
  • Әр проводка контурмен белгіленген: ресми немесе ішкі

Құжаттама және қосылу

Әдістердің сипаттамасы кодтан жиналады және OpenAPI форматында алты тілде жарияланады. Тұтынушы ұйым баптауларында A3 әзірлеушілерінің қатысуынсыз қосылады.