Partner API

 

Partner API on professionaalne API funktsionaalsus, mis võimaldab ERPLY Books’iga integreerida. Booksi API-t kasutatakse nii, et saad oma ID väärtused salvestada ERPLY Books’is. Sa ei pea salvestama Booksi ID väärtuseid, vaid saad lasta ERPLY Books’il uuendada väärtused, kui saadad omaenda ID.

 

ID väärtused

Vaatame näidet, kus Sul on arve ID-ga 82738732. Sa saadad selle ERPLY Books’i, kus partnerDocumentID on 82738732. Sel juhul peate ainult lugema infot, kas Books annab arve saatmisel veateate või mitte. Kui ei anna veateadet, siis luuakse Books’is vastava infoga arve. Kui Sa saadad näiteks selle arve uuesti homme, öeldes, et partnerDocumentID on 82738732, siis Partner API’t kasutades teab ERPLY Books, et see arve juba eksisteerib juba. Sel juhul ei looda uut arvet, vaid uuendatakse olemasolevat.

 

Partner API’l on jägmised ID valikud:

  • PartnerCustomerId (Partnerkliendi ID)
  • PartnerSupplierId (Partnerhankija ID)
  • PartnerDocumentId (Partnerdokumendi ID)
  • PartnerArticleId (Partnerartikli ID)
  • PartnerAccountId (Partnerkonto ID)
  • PartnerTaxRateId (Partner maksumäära ID)

 

Kui Sa saadad informatsiooni Partner API kaudu, siis on käsitletakse Sind partner tüübina PARTNER_API. Kui ka keegi teine hakkab infot saatma API kaudu, siis peab ta kasutama Sinuga samasid ID väärtuseid. Kui ühel saatjal on nõuete kontoks X ja teine saatja soovib kasutada nõuete jaoks kontot Y, siis ei leita erinevate kontode puhul unikaalset võtit, kuna mõlemad olete käsitletud kui PARNTER_API. Lühidalt öeldes, kui Sul on rohkem kui üks koht, kust arveid saadetakse, siis pead olema kindlad, et kõik kohad kasutavad sama partner ID-d.

 

Reeglid

  • GLOBAL_API_USE_PARTNER_API
    • Peate aktiveerima selle, et partner API tunnuseid kasutada.
  • GLOBAL_API_AGGREGATE_DOCUMENTS
    • Kui see on aktiveeritud, siis ERPLY Books liidab kokku dokumendi read, grupeerides artiklid ja projektid.
  • GLOBAL_API_UPDATE_SUPPLIERS
    • Kui saadad kliendi andmed koos arvega, siis see uuendab automaatselt kliendi informatsiooni (kohandub samuti maksjale, kui maksja on kättesaadav).
  • GLOBAL_API_UPDATE_CUSTOMERS
    • Kui saadad kliendi andmed koos arvega, siis see uuendab automaatselt kliendi informatsiooni (kohandub samuti maksjale, kui maksja on kättesaadav).
  • GLOBAL_API_DO_NOT_UPDATE_SUPPLIERS
  • GLOBAL_API_DO_NOT_UPDATE_CUSTOMERS
  • GLOBAL_API_DO_NOT_UPDATE_PAYMENTS
  • GLOBAL_API_ROUND_INVOICE_TOTALS
    • Sellega saad saata samuti arve kokku summad (sumWithVat, SumNoVat) ja ERPLY Books arvutab, kas esineb erinevus arve ridade summa ja tegeliku arve kokku summa vahel. Erinevuse puhul lisatakse ümardus automaatselt arvele.

 

Atribuudid

API dokumentatsioon Partner API jaoks on sama nagu tavaliste arvete puhul. Ainus erinevus on see, et url on “invoices/partner”, mitte “invoices”. Lisaks on oluline meeles pidada, et lisaksid partnerDocumentID elemendi. Partner API puhul on järgmised atribuudid:

  • Invoice.partnerDocumentId (String)
  • Invoice.projectNames (String array) – see üritab leida sama nimega projekte olemasolevate seast. Kui ei leia, siis lisab uue projekti automaatselt.
      • [“Project1”, “Project2”]
      • Projects – kui see eksisteerib, siis rohkem projekti välja pole kasutusel [23982, 439832]
  • Invoice.connectedDocuments –  saad ühendada erinevad dokumendid üksteisega. Näiteks saab ühendada tellimused müügiarvega. Väli: 
      • id (Long) – jäta tühjaks
      • parentDocumentId (Long) – jäta tühjaks
      • baseDocumentId (Long) – jäta tühjaks
      • partnerParentDocumentId (String) – lisa oma ID
      • partnerBaseDocumentId (String) – lisa oma ID
  • Invoice.rows.partnerTaxRateId (String)
  • Invoice.rows.partnerTaxRateName (String)
  • Invoice.rows.partnerArticleId (String)
  • Invoice.payer (CustomerInfo) – sellega saab lisada maksja. Klientide puhul kehtib sama andmete struktuur.

 

Kuidas tagada, et süsteem töötaks tõrgeteta?

API tunnuse uuendamine

Vaikimisi API tunnuse kehtivusaeg on 1 aasta.

API tunnus peab olema kinnitatud ERPLY Booksi supporti poolt. Saada päring support@erplybooks.com

POST/settings/update_token – see annab uue tunnuse.

 

API turvamine Teie IP aadressiga

API seadete all saab määrata IP aadressid API päringute jaoks.

 

Veateadete saatmine API-ga

Kirjuta pealehe otsingukasti “Globaalsed atribuudid” ja lisa järgmise atribuudiga rida:

Global name = GLOBAL_API_SEND_ERROR_MESSAGE

Value = emaili pealkiri

altValue = kes saab veateate