Sākumlapa/Api

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

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"
  }
}

Stock

Nodokļi un Likmes

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

Document

Dokumenta izveide (Document Store v2)

Izveido jaunu dokumentu (piemēram, pavadzīmi) ar grāmatojumiem.

Curl: 

curl -X 'POST' \
  'http://localhost:8080/ramusAccountant/service/api/v2/document/store' \
  -H 'accept: application/json' \
  -H 'documents: {
    "sessionId": "B521BFE77F1827EACE330AF1F1E26E36",
    "documents": [
      {
        "from": { "registrationNr": "99999999999" },
        "to": { "registrationNr": "40002315621" },
        "bookings": [
          {
            "bookingType": "STANDARD",
            "amount": 100,
            "note": "KOMENTARS tests",
            "startDate": "01-05-2024",
            "endDate": "30-05-2024",
            "valueAddedTax": { "percent": 21, "code": "42" },
            "debitAccountNr": "2310",
            "creditAccountNr": "6110"
          },
          {
            "bookingType": "TAX",
            "amount": 21,
            "tax": { "percent": 21, "code": "42" },
            "automatic": false,
            "debitAccountNr": "2310",
            "creditAccountNr": "57211"
          }
        ],
        "nr": "234BBBG",
        "date": "01-05-2024",
        "documentType": "OUTGOING_DELIVERY_NOTE",
        "refresh": false,
        "external": false,
        "confirm": false
      }
    ]
  }' \
  -H 'Authorization: Ramus 8e2fe39d-f2f7-497c-a7b8-1acf6a451e40' \
  -d ''

Response body: 

{
  "docs": [
    {
      "docNr": "234BBBG",
      "docId": 716645665283,
      "success": true
    }
  ],
  "success": true
}

Dokumentu tipi

Šis pieprasījums atgriež informāciju par dokumentu veidiem (piemēram, rēķiniem vai pavadzīmēm) un tiem piesaistītajām atskaišu formām.

Curl: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/document/type' \
  -H 'accept: application/json' \
  -H 'query: {
      "sessionId": "D821FE10B0C80B72D8A471E6C19BD18B",
      "query": {
        "documentTypes": ["OUTGOING_INVOICE", "OUTGOING_DELIVERY_NOTE"]
      },
      "start": 0,
      "length": 20
    }' \
  -H 'Authorization: Ramus eyJhbGciOiJIUzM4NCJ9...'

Response body (saīsināts): 

{
  "total": 2,
  "rows": [
    {
      "code": "OUTGOING_INVOICE",
      "shortCode": "REK/IZE",
      "name": "Izrakstītais rēķins",
      "report": [
        {
          "reportViewId": 178367942516,
          "label": "01.Rekins (LAT) (PARAUGS)",
          "language": "lv"
        }
      ]
    }
  ]
}

---

Dokumentu meklēšana

Pieprasījums, lai atrastu konkrētus dokumentus (piemēram, pēc numura) un iegūtu detalizētu informāciju par grāmatojumiem un saistītajiem maksājumiem.

Curl: 

curl -X 'GET' \
  'https://demo.ramusnet.eu/ramusAccountant/service/api/document/find' \
  -H 'accept: application/json' \
  -H 'query: {
      "sessionId": "D821FE10B0C80B72D8A471E6C19BD18B",
      "query": {
        "nrs": "1",
        "documentTypes": ["OUTGOING_INVOICE", "OUTGOING_DELIVERY_NOTE"]
      },
      "start": 0,
      "length": 20
    }' \
  -H 'Authorization: Ramus eyJhbGciOiJIUzM4NCJ9...'

Response body (detalizēts): 

{
  "hasDocuments": true,
  "total": 1,
  "rows": [
    {
      "id": 641738183089,
      "date": "03.05.2022",
      "nr": " 1",
      "documentType": "OUTGOING_INVOICE",
      "partner": "Apgāds Zvaigzne ABC SIA",
      "amount": "24.20",
      "currencyCode": "EUR",
      "bookings": [
        {
          "id": 641738183145,
          "bookingType": "STANDARD",
          "note": "Test",
          "amountAndTax": "24.20"
        },
        {
          "id": 641738183193,
          "bookingType": "TAX",
          "label": "Pievienotās vērtības nodoklis [LV] (21.00%)"
        }
      ],
      "links": [
        {
          "label": "Apmaksas dokumenti",
          "link": [
            {
              "documentType": "MAK/IEN",
              "amount": "24.20",
              "date": "03.05.2022"
            }
          ]
        }
      ]
    }
  ]
}

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.

1. 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": "..." }
  ]
}

---

2. 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
  }'

---

3. 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"
  }'

Iespējamie CommentType veidi:

  • COMMENT – parasts teksts.
  • INFO – informatīvs paziņojums.
  • ERROR – kļūdas paziņojums.
  • ATTACHMENT – saite uz pielikumu (failu).

Imports

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.

1. 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
      }
    }
  ]
}'

Iespējamie LinkType veidi:

  • PAYMENT – Apmaksas dokuments.
  • INVOICE_DELIVERY_NOTE – Rēķins piesaistīts pavadzīmei.
  • CANCELLATION – Atcelšanas dokuments.
  • ADVANCE_INVOICE_DELIVERY_NOTE – Avansa rēķins piesaistīts pavadzīmei.

---

2. 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.

---

3. 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"
  }'

Iespējamie DocumentType kodi:

  • INCOMING_INVOICE – Saņemtais rēķins.
  • OUTGOING_INVOICE – Izrakstītais rēķins.
  • OUTGOING_DELIVERY_NOTE – Izsniegtā pavadzīme.
  • INCOMING_PAYMENT – Ienākošais maksājums.

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

Custom

Standard

Saturs iegūts no "https://wiki.ramusnet.eu/index.php?title=Sākumlapa/Api&oldid=262"