Sākumlapa/Api

No ''Ramus Wiki''
Pāriet uz navigāciju Pāriet uz meklēšanu

Ramus Accountant API dokumentācija

Laipni lūdzam Ramus Accountant API tehniskajā rokasgrāmatā. Šī lapa kalpo kā vienots resurss izstrādātājiem, nodrošinot pilnu pārskatu par pieejamajiem servisiem, datu struktūrām un integrācijas soļiem.

Ramus Accountant API ir izstrādāts, lai nodrošinātu automatizētu datu apmaiņu starp ārējām sistēmām un grāmatvedības platformu, aptverot plašu funkcionalitāti no dokumentu vadības līdz sarežģītiem finanšu pārskatiem.

Arhitektūras pamatprincipi

  • RESTful standarts: API izmanto standarta HTTP metodes (GET, POST, PUT, DELETE) un nodrošina paredzamu resursu struktūru.
  • JSON formāts: Visi pieprasījumi un atbildes tiek apstrādātas JSON formātā, nodrošinot vieglu integrāciju ar modernām programmēšanas valodām.
  • Drošība: Datu integritāte un drošība tiek garantēta, izmantojot obligātu HTTPS šifrēšanu un sesiju bāzētu autorizāciju.

Dokumentācijas struktūra

Šī rokasgrāmata ir sadalīta vairākos loģiskos blokos atbilstoši sistēmas moduļiem:

  1. Sesijas un Autorizācija: API piekļuves uzsākšana un drošības parametri.
  2. Dokumentu vadība: Rēķinu, aktu un citu dokumentu imports, apstrāde un statusu kontrole.
  3. Personas un Partneri: Klientu un piegādātāju datu bāzes sinhronizācija.
  4. Produkti un Pakalpojumi: Nomenklatūras vadība.
  5. Atskaites: Finanšu datu eksports un analītika.

Darba uzsākšana

Pirms jebkura pieprasījuma veikšanas, lūdzu, pārliecinieties, ka esat iepazinušies ar Sesijas uzsākšanas sadaļu, jo katram tālākam izsaukumam ir nepieciešama derīga autorizācijas atslēga.

Session

Šajā sadaļā ir aprakstīti soļi sesijas uzsākšanai un konfigurēšanai Ramus Accountant API.

1. Lietotāja autorizācija (Login)

Pieprasījums, lai iegūtu sesijas ID un API atslēgu.

Curl: 

curl -X 'POST' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/session/login/user' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -d '{ "usernameOrEmail": "vards.uzvards@pasts.lv", "password": "?????????" }'

Request URL: https://demo.ramusnet.eu/ramusAccountant/service/api/session/login/user

Response body: 

{
  "error": false,
  "message": "Logged In",
  "sessionId": "D821FE10B0C80B72D8A471E6C19BD18B",
  "apiKey": "Ramus eyJhbGciOiJIUzM4NCJ9..."
}

---

2. Darba vides (Workspace) atrašana

Curl: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/session/find' \
  -H 'accept: application/json' \
  -H 'query: { "sessionId": "D821FE10B0C80B72D8A471E6C19BD18B", "workspaceName": "PARAUGS" }' \
  -H 'Authorization: Ramus eyJhbGciOiJIUzM4NCJ9...'

Response body: 

{
  "workspaces": [
    {
      "serverDataSourceId": 1001,
      "name": "demo.ramusnet.lv",
      "data": {
        "total": 1,
        "rows": [
          {
            "userId": 144332002024,
            "workspace": "PARAUGS",
            "workspaceId": 150734769495
          }
        ]
      }
    }
  ]
}

---

3. Finanšu periodu atrašana

Curl: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/session/find/periods' \
  -H 'accept: application/json' \
  -H 'query: { "sessionId": "D821FE10B0C80B72D8A471E6C19BD18B", "serverDataSourceId": "1001" }'

---

4. Sesijas saglabāšana (Store)

Curl: 

curl -X 'POST' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/session/store' \
  -H 'accept: application/json' \
  -H 'query: { 
      "sessionId": "D821FE10B0C80B72D8A471E6C19BD18B", 
      "serverDataSourceId": "1001", 
      "workspaceId": "150734769495", 
      "financialPeriodId": "641738108062" 
    }' \
  -d ''

Response body: 

{
  "success": true,
  "subject": {
    "userId": "144332002024",
    "workspaceId": "150734769495",
    "financialPeriodId": "641738108062",
    "sesionId": "D821FE10B0C80B72D8A471E6C19BD18B"
  }
}

Noliktava (Stock Controller)

Šī sadaļa nodrošina noliktavas atlikumu datu eksportēšanu un pārskatīšanu.

1. Noliktavas atlikumu eksports (XLS)

Ģenerē noliktavas atlikumu pārskatu Excel (XLS) formātā, balstoties uz norādītajiem filtriem.

Curl: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/stock/xls' \
  -H 'accept: application/json' \
  -H 'query: {
    "sessionId": "YOUR_SESSION_ID",
    "query": {
      "productPattern": "",
      "showQuantity": "TRUE",
      "stocksIds": ["1", "2"],
      "productGroupIds": ["163424699459"]
    },
    "exportFormat": "STOCKLIST_XLS"
  }'

Parametru skaidrojums:

  • productPattern – filtrs pēc produkta nosaukuma vai koda (var izmantot tukšu, lai atlasītu visus).
  • showQuantity – norāda, vai atskaitē iekļaut daudzumu.
  • stocksIds – noliktavu identifikatoru masīvs. Ja tukšs, tiek ņemtas visas pieejamās noliktavas.
  • productGroupIds – produktu grupu filtri (iegūstami no Product Controller).
  • exportFormat – pašlaik atbalstītais formāts ir STOCKLIST_XLS.

Atbilde: API atgriež bināro datu plūsmu vai saiti uz ģenerēto failu (atkarībā no klienta konfigurācijas), kas tiek saglabāts kā Excel dokuments.

Nodokļi (Tax Controller)

Šī sadaļa ļauj iegūt informāciju par sistēmā konfigurētajiem nodokļu veidiem un to klasifikāciju.

1. Nodokļu veidu iegūšana (Type)

Atgriež sarakstu ar pieejamajiem nodokļu tipiem, to grupām un iestatījumu kodiem. Šos kodus izmanto dokumentu grāmatojumos (bookings), lai precizētu nodokļa dabu.

Curl: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/tax/type' \
  -H 'accept: application/json' \
  -H 'query: { "sessionId": "YOUR_SESSION_ID" }'

Svarīgākie nodokļu veidi (piemēri):

Kods (code) Nosaukums Grupa Pielietojums
VALUE_ADDED_TAX Value added tax VALUE_ADDED_TAX Standarta PVN aprēķinam.
REVERSE_VALUE_ADDED_TAX Reverse value added tax VALUE_ADDED_TAX Reversā PVN darījumiem.
NON_DEDUCTIBLE_VALUE_ADDED_TAX Non-deductible VAT NON_DEDUCTIBLE PVN daļa, kas nav atskaitāma kā priekšnodoklis.
NOT_TAX_BOOK_INCOME_TAX Not tax book income tax SALARY_NOT_TAX Ar algām saistīti nodokļu veidi.

Lauku skaidrojums:

  • code – unikāls nodokļa veida identifikators.
  • group – nodokļu grupēšana (piemēram, visi PVN veidi ietilpst vienā grupā).
  • setting – sistēmas iestatījuma kods, kas nosaka nodokļa uzvedību grāmatvedības loģikā.

Authenticate

Pieteikšanās sesijas izveide (Login)

Izmanto, lai izveidotu autentifikācijas saiti, kas ļauj lietotājam autorizēties sistēmas saskarnē vai pabeigt pieslēgšanās procesu konkrētai darba videi un periodam.

Curl: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/authenticate/login' \
  -H 'accept: application/json' \
  -H 'query: {
    "serverDataSourceId": "12345",
    "workspaceId": "67890",
    "financialPeriodId": "2024"
  }'

Parametru skaidrojums:

  • serverDataSourceId – Datu avota identifikators.
  • workspaceId – Darba vides (uzņēmuma) ID.
  • financialPeriodId – Finanšu perioda ID (iegūstams no Financial Period Controller).

Atbilde: Atgriež success: true un unikālu url, ko var izmantot lietotāja novirzīšanai uz sistēmu. 

{
  "success": true,
  "url": "https://demo.ramusnet.eu/ramusnet/enterAuthenticate.jsp?authenticateId=..."
}

Dokumentu pārvaldība (Document Controller)

Šis kontrolieris nodrošina dokumentu (rēķinu, pavadzīmju, maksājumu) izveidi, labošanu, meklēšanu un dažāda formāta eksportu.

1. Dokumenta izveide vai atjaunošana (Store v2)

Izmanto jaunu dokumentu iesniegšanai vai esošu dokumentu datu labošanai (ar `PUT`).

Curl (POST): 

curl -X 'POST' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/v2/document/store' \
  -H 'Content-Type: application/json' \
  -d '{
  "sessionId": "YOUR_SESSION_ID",
  "documents": [
    {
      "documentType": "OUTGOING_INVOICE",
      "nr": "234",
      "serialNr": "AG",
      "date": "01-05-2024",
      "from": { "registrationNr": "99999999999" },
      "to": { "registrationNr": "40003154167" },
      "bookings": [
        {
          "bookingType": "PRODUCT",
          "product": { "code": "301" },
          "price": 20,
          "quantity": 5,
          "amount": 100,
          "valueAddedTax": { "percent": 21, "code": "42" },
          "debit": { "debitAccountNr": "2310" },
          "credit": { "creditAccountNr": "6110" }
        }
      ]
    }
  ]
}'

---

2. Dokumentu meklēšana (Find v2)

Ļauj detalizēti atlasīt dokumentus pēc datumiem, numuriem, partneriem vai statusiem.

Curl: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/v2/document/find' \
  -H 'accept: application/json' \
  -H 'query: {
    "sessionId": "YOUR_SESSION_ID",
    "query": {
      "fromDate": "01.01.2026",
      "tillDate": "31.12.2026",
      "documentTypes": ["OUTGOING_INVOICE", "OUTGOING_DELIVERY_NOTE"],
      "financialPeriod": true
    },
    "start": 0,
    "length": 20
  }'

---

3. Dokumentu eksports (PDF, XML, XLS, Maksājumi)

Sistēma atbalsta dažādus eksporta formātus atkarībā no vajadzības.

PDF ģenerēšana

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/document/pdf' \
  -H 'query: {
    "sessionId": "YOUR_SESSION_ID",
    "query": {
      "documentId": "730139934146",
      "reportViewId": "178367942516",
      "language": "lv",
      "reportOutputType": "inline"
    }
  }'

E-rēķini (XML)

Atbalsta PEPPOL BIS Billing 3.0 un citus formātus.

  • PEPPOL_BIS_BILLING_INVOICE_XML
  • E_INVOICE_XML

Bankas maksājumu eksports (ISO20022 / FIDAVISTA)

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/document/payments' \
  -H 'query: {
    "sessionId": "YOUR_SESSION_ID",
    "exportFormat": "ISO20022_LOCAL",
    "paymentAccountNr": "LV63HABA...",
    "query": { "documentTypes": ["OUTGOING_PAYMENT"] }
  }'

---

Klasifikatori dokumentiem

Šie kodi un struktūras ir jāizmanto, veidojot vai meklējot dokumentus caur API.

1. Dokumentu veidi (DocumentType)

Kods Apraksts
INCOMING_ADVANCE_INVOICE Ienākošais avansa rēķins
INCOMING_INVOICE Ienākošais rēķins
INCOMING_CREDIT_INVOICE Ienākošais kredītrēķins
OUTGOING_ADVANCE_INVOICE Izejošais avansa rēķins
OUTGOING_INVOICE Izejošais rēķins
OUTGOING_CREDIT_INVOICE Izejošais kredītrēķins
INCOMING_PAYMENT Ienākošais maksājumu uzdevums
OUTGOING_PAYMENT Izejošais maksājumu uzdevums
INCOMING_DELIVERY_NOTE Ienākošā pavadzīme
OUTGOING_DELIVERY_NOTE Izejošā pavadzīme
MATERIAL_ACCEPTANCE_STATEMENT Materiālu pieņemšanas akts
REPORT_ON_WRITE_OFF_OF_MATERIALS Materiālu norakstīšanas akts
REPORT_OF_GOODS_WRITTEN_OFF_THE_WAREHAUSE No noliktavas norakstīto preču atskaite
RECEIPT_CASH_ORDER Ieņēmumu kases orderis
EXPENSE_CASH_ORDER Izdevumu kases orderis
BOOKKEEPING_ORDER Grāmatvedības orderis
INCOMING_BOOKKEEPING_ORDER Ienākošais grāmatvedības orderis
OUTGOING_BOOKKEEPING_ORDER Izejošais grāmatvedības orderis

2. Specifiskie sasaistes lauki (Context Fields)

Atkarībā no dokumenta veida, JSON struktūrā jāizmanto šādi lauki:

  • Kase (RECEIPT_CASH_ORDER, EXPENSE_CASH_ORDER):
    • fromPayOffice vai toPayOffice:
"fromPayOffice": { "payOfficeId": "519135641035" }
  • Pakalpojumu sniegšanas vietas (INVOICE):
    • serviceFrom vai serviceTo:
"serviceFrom": { "registrationNr": "41203063885" }
  • Noliktavas kustība (DELIVERY_NOTE):
    • stockFrom vai stockTo:
"stockFrom": { "registrationNr": "41203063885" }
    • transporter: Pārvadātāja reģistrācijas numurs.

3. Grāmatojumu veidi (BookingType)

Kods Apraksts
STANDARD Dokumenta finanšu ieraksts (parasts grāmatojums)
PRODUCT Produkta vai pakalpojuma ieraksta rinda
PRODUCT_STOCK Noliktavas produkta ieraksts (ietekmē atlikumus)
TAX Nodokļa (PVN) ieraksts

Svarīgas piezīmes izstrādātājiem

  • Datu sasaiste: Veidojot dokumentu ar POST, blokos from un to pietiek norādīt tikai registrationNr. Ja partneris ar šādu numuru jau eksistē sistēmā, Ramus to atpazīs un piesaistīs automātiski.
  • Lauku hierarhija (Bookings): Masīvā bookings konti (debets/kredīts) un PVN kodi ir jāsūta kā objekti, nevis kā vienkārši teksta lauki.
    • Pareizi: "debit": { "debitAccountNr": "2310" }
    • Nepareizi: "debitAccountNr": "2310"
  • PDF atskaites: Lai veiksmīgi izsauktu GET /pdf, vispirms ieteicams izmantot GET /service/api/document/type. Tas ļauj noskaidrot konkrētajam dokumenta veidam pieejamos reportViewId un reportViewNr, kas mainās atkarībā no uzņēmuma konfigurācijas (piemēram, dažādi rēķinu dizaini).

Dokumentu komentāri (Document Comment Controller)

Šī sadaļa ļauj pievienot, meklēt un dzēst dokumentu komentārus, informāciju, kļūdas vai failu pielikumus.

Komentāru vai pielikumu pievienošana (Store)

Izmanto, lai dokumentam piesaistītu teksta komentāru vai saiti uz pielikumu (piemēram, rēķina PDF).

Curl: 

curl -X 'POST' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/document/comment/store' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "sessionId": "4D6F56BF698098F4611C8030310F3FD0",
  "documentComments": [
    {
      "documentId": "41203063885",
      "commentType": "ATTACHMENT",
      "referenceFileUrl": "https://demo.files.hubvivente.com/...",
      "referenceFileId": "63885085",
      "description": "REK/IZE AG 234 01.05.2025 121"
    },
    {
      "documentId": "41203063885",
      "commentType": "COMMENT",
      "description": "REK/IZE AG ????"
    }
  ]
}'

Response body: 

{
  "success": true,
  "docs": [
    { "success": true, "documentId": "41203063885", "commentId": "..." }
  ]
}

---

Komentāru meklēšana (Find)

Atrod visus komentārus vai pielikumus, kas piesaistīti konkrētam dokumentam.

Curl: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/document/comment/find' \
  -H 'accept: application/json' \
  -H 'query: {
    "sessionId": "YOUR_SESSION_ID",
    "query": {
      "documentId": 730139934146,
      "commentType": "ATTACHMENT"
    },
    "start": 0,
    "length": 20
  }'

---

Komentāra dzēšana (Remove)

Dzēš dokumenta komentāru vai pielikuma saiti pēc tās ID.

Curl: 

curl -X 'DELETE' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/document/comment/remove' \
  -H 'accept: application/json' \
  -H 'query: {
    "sessionId": "YOUR_SESSION_ID",
    "commentId": "730139934146"
  }'


Komentāru veidi (CommentType)

Kods Apraksts
COMMENT Brīva teksta komentārs
INFO Informatīvs paziņojums
ERROR Sistēmas vai lietotāja kļūdas ziņojums
ATTACHMENT Saite uz pielikumu (failu)

Dokumentu imports (Document Imports Controller)

Šis kontrolieris nodrošina dokumentu importēšanu sistēmā no dažādiem ārējiem formātiem un servisiem (piemēram, Peppol vai CostPocket).

1. Ramus JSON imports

Izmanto dokumentu importēšanai standarta Ramus JSON formātā.

Curl: 

curl -X 'POST' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/document/imports/ramus' \
  -H 'Content-Type: application/json' \
  -d '{
  "sessionId": "YOUR_SESSION_ID",
  "importFormat": "RAMUS_INVOICE_JSON",
  "documents": [
    {
      "documentType": "OUTGOING_INVOICE",
      "nr": "234",
      "date": "01-05-2024",
      "from": { "registrationNr": "41203063885" },
      "to": { "registrationNr": "40203263996" },
      "bookings": [
        {
          "bookingType": "STANDARD",
          "amount": 100,
          "valueAddedTax": { "percent": 21, "code": "42" }
        }
      ]
    }
  ]
}'

---

2. E-rēķinu imports (XML)

Ļauj augšupielādēt un importēt XML rēķinus (piemēram, PEPPOL BIS Billing 3.0 formātā).

Curl: 

curl -X 'POST' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/document/imports/invoice' \
  -F 'file=@rekins.xml' \
  -F 'documentsQuery={
    "sessionId": "YOUR_SESSION_ID",
    "importFormat": "PEPPOL_BIS_BILLING_INVOICE_XML"
  }'

Piezīme: Papildus var norādīt fileId vai fileUrl, ja rēķinam ir pievienots oriģinālais attēls/pielikums.

---

3. Čeku imports (CSV / CostPocket)

Paredzēts izdevumu čeku importam, piemēram, no CostPocket servisa.

Curl: 

curl -X 'POST' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/document/imports/cheque' \
  -F 'file=@ceki.csv' \
  -F 'documentsQuery={
    "sessionId": "YOUR_SESSION_ID",
    "importFormat": "COSTPOCKET_CHEQUE_CSV"
  }'

---

Importa formātu saraksts

Kods Apraksts
RAMUS_INVOICE_JSON Standarta Ramus JSON struktūra
PEPPOL_BIS_BILLING_INVOICE_XML Eiropas standarta e-rēķins
COSTPOCKET_CHEQUE_CSV CostPocket sistēmas eksporta fails

Atbildes struktūra

Sekmīga importa gadījumā sistēma atgriež importResourceId, kas kalpo kā atsauce uz veikto operāciju. 

{
  "success": true,
  "serverDataSourceId": 1001,
  "workspaceId": 150734769495,
  "financialPeriodId": 731247751131,
  "imports": [ { "importResourceId": 731545159090 } ]
}

Dokumentu saites (Document Link Controller)

Šī sadaļa ļauj veidot, skatīt un dzēst saites starp dažādiem dokumentu veidiem, piemēram, sasaistīt rēķinu ar tā apmaksu.

Dokumentu sasaistīšana (Store)

Izmanto, lai izveidotu saiti starp galveno dokumentu (parent) un pakārtoto dokumentu (child).

Curl: 

curl -X 'POST' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/document/link/store' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "sessionId": "4D6F56BF698098F4611C8030310F3FD0",
  "documentLinks": [
    {
      "documentId": "41203063885",
      "linkType": "PAYMENT",
      "child": {
        "documentId": "40203263996",
        "amount": 10.7
      }
    }
  ]
}'

---

Pieejamo saišu tipu iegūšana (Type)

Palīgfunkcija, lai noskaidrotu, kādus dokumentu veidus drīkst savstarpēji sasaistīt.

Curl: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/document/link/type' \
  -H 'accept: application/json' \
  -H 'query: {
    "sessionId": "YOUR_SESSION_ID",
    "query": {
      "documentTypes": [
        "OUTGOING_INVOICE",
        "OUTGOING_DELIVERY_NOTE"
      ]
    }
  }'

Response body piemērs: Atbildē redzams, ka, piemēram, OUTGOING_INVOICE kā apmaksas dokumentu (PAYMENT) var sasaistīt ar INCOMING_PAYMENT vai RECEIPT_CHEQUE.

---

Saites dzēšana (Remove)

Pārtrauc saiti starp diviem dokumentiem.

Curl: 

curl -X 'DELETE' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/document/link/remove' \
  -H 'accept: application/json' \
  -H 'query: {
    "sessionId": "YOUR_SESSION_ID",
    "documentLinkId": "730139934146"
  }'

Dokumentu saišu veidi (LinkType)

Lieto, veidojot saites starp dokumentiem (Document Link Controller), lai definētu sasaistes loģiku.

Kods Apraksts
PAYMENT Maksājuma dokuments (rēķina apmaksa)
PAYMENT_ADVANCE Avansa maksājuma dokuments
RECEIPT Ieņēmumu dokuments
EXPENSE Izdevumu dokuments
CANCELLATION Atcelšanas dokuments
ADVANCE_INVOICE_DELIVERY_NOTE Avansa rēķins piesaistīts pavadzīmei/rēķinam
INVOICE_DELIVERY_NOTE Rēķins piesaistīts pavadzīmei
CANCELLED_DOCUMENT Anulēts dokuments
REBOOKED_DOCUMENT Pārgrāmatots dokuments
DELIVERY_NOTE_DELIVERY_NOTE Pavadzīme piesaistīta pavadzīmei
INVOICE_INVOICE Rēķins piesaistīts rēķinam
MOVING_OF_MATERIALS Materiālu kustība (pārvietošana)
REVERT_OF_MATERIALS Materiālu atgriešana
DELIVERY_NOTE_REVERT Pavadzīmes atgriešana (storno)

Personas un Partneri (Person Controller)

Šī sadaļa ļauj pārvaldīt juridiskas un fiziskas personas, darbiniekus, kā arī pārbaudīt PVN maksātāju statusu.

1. Personas izveide vai atjaunošana (Store v2)

Pievieno jaunu partneri vai atjauno esošā datus. Šī versija atbalsta detalizētu bankas datu un maksājumu termiņu norādīšanu.

Curl: 

curl -X 'POST' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/v2/person/store' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "sessionId": "YOUR_SESSION_ID",
  "persons": [
    {
      "personType": "JURIDICAL",
      "name": "Albions2",
      "abbreviation": "SIA",
      "registrationNr": "40003154167",
      "country": "LV",
      "taxPayerNr": "LV40003154167",
      "address": "Juridiskā adrese",
      "payTerm": "10",
      "banks": [
        {
          "accountNr": "LV63HABA055101561XXXX",
          "swift": "HABALV22",
          "defaultBank": true
        }
      ]
    }
  ]
}'

---

2. Personu meklēšana (Find v2)

Meklē partnerus pēc nosaukuma, reģistrācijas numura vai bankas konta.

Curl: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/v2/person/find' \
  -H 'accept: application/json' \
  -H 'query: {
    "sessionId": "YOUR_SESSION_ID",
    "query": {
      "personType": "JURIDICAL",
      "name": "Zvaigzne",
      "registrationNr": "",
      "accountNr": ""
    },
    "start": 0,
    "length": 20
  }'

---

3. Uzņēmuma struktūras iegūšana (Enterprise)

Atgriež informāciju par paša uzņēmuma struktūrvienībām (DEPARTMENT) un darbiniekiem (EMPLOYEE).

Curl: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/person/find/enterprise' \
  -H 'accept: application/json' \
  -H 'query: { "sessionId": "YOUR_SESSION_ID", "tree": false }'

Atbildes lauki:

  • path – parāda struktūrvienības hierarhiju (piemēram, "PARAUGS/Birojs/Administrācija").
  • personType – JURIDICAL (galvenais), DEPARTMENT (nodaļa), EMPLOYEE (darbinieks).

---

4. PVN maksātāja statusa pārbaude (Check VAT)

Pārbauda reģistrācijas numuru PVN reģistros.

Curl: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/person/check/vat?countryCode=LV&registrationNr=40003154167&taxPayerNr=LV40003154167' \
  -H 'accept: application/json'

---

Personu tipi (PersonType):

  • JURIDICAL – Juridiska persona (uzņēmums).
  • PHYSICAL – Fiziska persona.
  • DEPARTMENT – Struktūrvienība (nodaļa, veikals, filiāle).
  • EMPLOYEE – Darbinieks.

Produkti un Pakalpojumi (Product Controller)

Šī sadaļa ļauj pārvaldīt preču un pakalpojumu katalogu, iegūt informāciju par produktu grupām un cenām.

1. Produktu grupu iegūšana (Groups)

Atgriež visu sistēmā reģistrēto produktu grupu sarakstu.

Curl: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/product/groups' \
  -H 'accept: application/json' \
  -H 'query: { "sessionId": "YOUR_SESSION_ID" }'

Atbildes piemērs: 

{
  "total": 1,
  "rows": [
    {
      "code": "AP/BALTA",
      "name": "Apdrosinasana [AP]/Baltas polises [BALTA]",
      "id": "168779874110"
    }
  ]
}

---

2. Produktu meklēšana (Find)

Meklē produktus pēc koda, nosaukuma, grupas vai unikālā ceļa (Path). Šis pieprasījums atgriež arī informāciju par cenām (mazumtirdzniecības, vairumtirdzniecības u.c.).

Curl: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/product/find' \
  -H 'accept: application/json' \
  -H 'query: {
    "sessionId": "YOUR_SESSION_ID",
    "query": {
      "queryPath": "AP/BALTA/OCTA",
      "queryName": "OCTA",
      "productIds": ["163424720289"],
      "productGroupIds": []
    },
    "start": 0,
    "length": 20
  }'

Svarīgākie atbildes lauki:

  • pathAsCodes – produkta hierarhijas ceļš (noder precīzai meklēšanai).
  • prices – objekts, kas satur dažādus cenu veidus (PRICE_ACTUAL, PRICE_RETAIL u.c.).
  • service – norāda, vai ieraksts ir pakalpojums (true) vai prece (false).
  • barCode – produkta svītrkods.

---

Praktiski padomi

  • **Meklēšana pēc grupas**: Ja vēlaties atlasīt visas preces konkrētā grupā, izmantojiet productGroupIds filtru.
  • **Cenu noteikšana**: Veidojot dokumentus (piemēram, rēķinus), no šīs sadaļas var iegūt noklusēto cenu, izmantojot lauku PRICE_ACTUAL.

Report

Lietotāja definētās atskaites (Custom Report Controller)

Šī sadaļa ļauj piekļūt specifiskām, konkrētam uzņēmumam izstrādātām vai pielāgotām atskaitēm. Procesa loģika ir asinhrona (Start -> Status/Dati -> Remove).

Atskaites palaišana (Start)

Inicializē pielāgotās atskaites sagatavošanu. Atšķirībā no standarta atskaitēm, šeit obligāti jāizmanto specifisks reportTypeId.

Curl: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/report/custom/start' \
  -H 'accept: application/json' \
  -H 'query: {
    "sessionId": "YOUR_SESSION_ID",
    "reportTypeId": "150734769495",
    "query": {
      "fromDate": "01.01.2026",
      "tillDate": "31.03.2026",
      "reportInFinancialPeriod": true
    }
  }'

Atbildē saņemtais teksts ir reportExecutorCode.

---

Atskaites datu eksports

Kad ir saņemts izpildes kods (executor code), datus var izgūt nepieciešamajā formātā.

JSON dati

Izmanto, lai integrētu atskaites datus citās sistēmās. 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/report/custom/json' \
  -H 'query: { "sessionId": "...", "reportExecutorCode": "..." }'
Excel (XLS) eksports
curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/report/custom/xls' \
  -H 'query: {
    "sessionId": "...",
    "reportExecutorCode": "...",
    "exportFormatCode": "SMART_XLS"
  }'

---

Lietotāja definēto atskaišu vārdnīca (Custom Report Types) ===

Atgriež sarakstu ar visām "Custom" atskaitēm, kas ir pieejamas lietotājam. 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/report/custom/type' \
  -H 'query: { "sessionId": "YOUR_SESSION_ID" }'

---

Šajā tabulā apkopoti populārākie pielāgoto atskaišu identifikatori. Atšķirībā no standarta atskaitēm, šeit obligāti jāizmanto reportTypeId.

reportTypeId Atskaites nosaukums XLS formāti (exportFormatCode / FileId)
168769541626 03. Bilance CUSTOM_REPORT_XLS (FileId: 168769588791)
168769524493 02. P/Z aprēķins CUSTOM_REPORT_XLS (FileId: 168769569425)
191176613076 06. Debitori CUSTOM_REPORT_180809_XLS
150840650023 04. Realizācijas pārskats CUSTOM_REPORT_180809_XLS (FileId: 254849825322)
224593394061 01. PVN deklarācija 2009 CUSTOM_REPORT_XLS (FileId: 224593410318)

Svarīgi par XLS eksportu (Custom)

Lietotāja definētajām atskaitēm XLS eksportā bieži vien ir specifiski failu šabloni. Veicot GET /xls pieprasījumu, query objektā ir jāiekļauj abi parametri:

  • exportFormatCode: parasti CUSTOM_REPORT_XLS vai CUSTOM_REPORT_180809_XLS.
  • exportFormatFileId: unikālais faila identifikators (redzams tabulā augstāk), ja tāds ir norādīts sistēmā.

PDF skati (Custom)

Lielākā daļa pielāgoto atskaišu izmanto standarta dizainus:

  • 560355625026 — 01. Lietotāja definēta atskaite
  • 560355625038 — 02. Lietotāja definēta atskaite (detalizēts)

Statusa pārbaude un dzēšana

  • Status: Pārbauda atskaites ģenerēšanas progresu.
  • Remove: Obligāti izsaukt pēc datu saņemšanas, lai atbrīvotu servera atmiņu.
curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/report/custom/remove' \
  -H 'query: { "sessionId": "...", "reportExecutorCode": "..." }'

---

Atšķirības no Standard Report:

  • Tiek izmantots parametrs reportTypeId (ciparu ID), nevis koda nosaukums.
  • XLS eksportā ir iespējams papildus norādīt exportFormatFileId, ja atskaitei ir vairākas sagataves.

Standarta atskaites (Standard Report Controller)

Šis kontrolieris nodrošina piekļuvi sistēmas standarta grāmatvedības atskaitēm (piemēram, Virsgrāmata, Debitoru saraksts u.c.).

Atskaišu ģenerēšanas cikls

Atskaišu iegūšana notiek vairākos posmos:

  1. Start: Tiek inicializēta atskaites sagatavošana, saņemot reportExecutorCode.
  2. Status: (Pēc izvēles) Pārbauda, vai atskaite ir gatava.
  3. Eksports: Datu lejuplāde JSON, XLS, PDF vai XML formātā.
  4. Remove: Atskaites koda dzēšana no sistēmas atmiņas pēc lietošanas.

---

Atskaites palaišana (Start)

Šī metode sāk atskaites datu apkopošanu.

Curl: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/report/standard/start' \
  -H 'accept: application/json' \
  -H 'query: {
    "sessionId": "YOUR_SESSION_ID",
    "reportTypeCode": "ACCOUNT_TURNOVER",
    "query": {
      "fromDate": "01.01.2026",
      "tillDate": "31.12.2026",
      "account_nr": "2310",
      "reportRowIdElements": ["ACCOUNT", "PERSON"]
    }
  }'

Piezīme: Atbildē saņemtais teksts ir reportExecutorCode, kas jāizmanto tālākajos soļos.

---

Atskaites datu saņemšana (JSON / XLS / PDF)

Kad atskaite ir palaista, datus var iegūt izvēlētajā formātā.

Datu iegūšana JSON formātā
curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/report/standard/json' \
  -H 'query: {
    "sessionId": "YOUR_SESSION_ID",
    "reportExecutorCode": "KODS_NO_START_METODES"
  }'
Eksports uz PDF
curl -X 'GET' \
  'https://demo.ramusnet.eu/report/standard/pdf' \
  -H 'query: {
    "sessionId": "YOUR_SESSION_ID",
    "reportExecutorCode": "...",
    "query": { "reportViewId": "", "reportOutputType": "inline" }
  }'

---

Standarta atskaišu vārdnīca (Report Types)

Ļauj noskaidrot visus pieejamos atskaišu kodus (reportTypeCode), ko lietotājs drīkst palaist. 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/report/standard/type' \
  -H 'query: { "sessionId": "YOUR_SESSION_ID" }'

---

Šajā tabulā apkopoti biežāk lietotie atskaišu kodi un to iespējas (XLS/PDF), ko atgriež /service/api/report/standard/type.

reportTypeCode Nosaukums XLS pieejamība PDF piemēri (reportViewId)
ACCOUNT_PLAN_TURNOVER Virsgrāmatas apgrozījums Jā 560354707473 (Landscape), 560354707547 (Atlikumi)
ACCOUNT_TURNOVER Konta žurnāls Jā 560354694670 (Konta žurnāls)
VAT_LV_2014 PVN deklarācija (LV) Jā 560355289194 (PVN pielikums)
PAYROLL Algu saraksti Jā (vairāki) 560355240797 (Banka), 560355240891 (Algas lapiņas)
FIXED_ASSETS Pamatlīdzekļi Jā 560355317368 (Saraksts), 560355317405 (Kartīte)
PRODUCT_STOCK_TURNOVER Noliktavas apgrozījums (FIFO) Jā 560355524864 (Inventarizācijas akts)
DOCUMENT Dokumentu reģistrs Jā 560355429966 (Izrakstīto rēķinu reģistrs)
PAYOFFICE_TURNOVER Kases apgrozījums Nē 560354731599 (Kases pārskats)

Detalizēts piemērs: Algu atskaite (PAYROLL)

Algu atskaite piedāvā vairākus specifiskus eksporta formātus (exportFormatCode), ko norāda XLS pieprasījumā:

  • PAYROLL_XLS – Standarta algu saraksts.
  • PAYROLL_TAX_XLS – Nodokļu kopsavilkums.
  • PAYROLL_EMPLOYEE_WORK_CALENDAR_XLS – Darba laika kalendārs.

Atskaites statusa pārbaude un dzēšana

  • Status: Pārbauda, vai atskaites ģenerēšana vēl procesā vai pabeigta.
  • Remove: Atbrīvo sistēmas resursus, izdzēšot pabeigto atskaiti.

Remove piemērs: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/report/standard/remove' \
  -H 'query: { "sessionId": "...", "reportExecutorCode": "..." }'

---

Svarīgi parametri atskaišu query blokā:

  • reportRowIdElements – definē atskaites detalizāciju (piemēram, grupēt pēc konta vai partnera).
  • reportInFinancialPeriod – ja true, iekļauj tikai konkrētā finanšu perioda datus.
  • exportFormatCode – nosaka XLS eksporta specifiku (piemēram, Smart XLS).
Saturs iegūts no "https://file.ramusnet.eu/index.php?title=Sākumlapa/Api&oldid=374"