Friskvårdsintegration - Teknisk Dokumentation(Benify/Wellnet/S&P ...)
Integration
BasURL är exempelvis
https://api.brpsystems.se/brpgog/
Anrop
Anropet sker med en http POST innehållande Xml.
Skicka alltid med headern:
Content-Type: application/xml; charset=utf-8
Xml:en valideras mot den xsd som ligger på:
{BasURL}/xsd/webservice/createpartnerorder.xsd
Friskvårdsportal | Anrop | Kommentar |
---|---|---|
Benify | POST {BasURL}/webservice/partnerorders/createbenifyorder?apikey={apiKey} | |
Wellnet | POST {BasURL}/webservice/partnerorders/createwellnetorder?apikey={apiKey} | |
S&P | POST {BasURL}/webservice/partnerorders/createsoporder?apikey={apiKey} | |
Actiway | POST {BasURL}/webservice/partnerorders/createactiwayorder?apikey={apiKey} | |
Epassi | POST {BasURL}/webservice/partnerorders/createepassiorder?apikey={apiKey} | Tillgänglig från version 2021.50nnnn |
Apinyckel
Api-nyckel av typen 'partner' krävs för alla anrop. Denna nyckel tillåter endast anrop från i förväg bestämda IP:n och läggs in manuellt av BRP:s support.
Exempel:
Exempel
Observera:
priceincvat är priset i öre inklusive moms.
ordernr är beställningsnummer hos benify|wellnet|sop|actiway och hamnar som märkning på fakturan i BRP. "Avser beställning 1234567 hos Benify"
Man ha en eller flera orderItems
Anrop
Svar
Vid fel:
Tag | Format | Förklaring |
---|---|---|
message | Sträng | Läsbart meddelande |
code | Nummer | |
debuginfo | Sträng | Mer utförlig information om felet |
Engelska används som språk för eventuella felmeddelanden.
När det går som det ska:
Tag | Format | Förklaring |
---|---|---|
order | Den skapade ordern | |
number | Nummer | Ordernummer |
created | Tidpunkt | När ordern skapades |
orderedby | Beställaren, obs behöver inte helt överensstämma med det som angavs i anropet men den ordern faktiskt skapades på | |
personnumber | Personnummer | Beställarens personnummer |
number | Sträng | Beställarens kundnummer i BRP |
firstname | Sträng | Beställarens förnamn |
lastname | Sträng | Beställarens efternamn |
street | Sträng | Beställarens adress gata |
postal | Sträng | Beställarens adress postnummer |
city | Sträng | Beställarens adress stad |
country | Sträng | Beställarens adress 2-bokstavslandskod enligt ISO 3166 |
businessunit | Den anläggning som order är gjord på | |
name | Sträng | Anläggningens namn |
organization | Organisationen som order hör till | |
number | Sträng | Organisationsnummer |
name | Sträng | Organisationens namn |
product | Produkt som ingår i beställningen | |
number | Sträng | Produktnummer i BRP |
type | Sträng | Produkttyp |
name | Sträng | Produktnamn |
sumexvat | Number | Orders totalpris exklusive moms i ören |
vatsum | Moms | |
rate | Number | Momssatsen i procent |
amount | Number | Momsdelen i ören |
sum | Number | Totalpriset på ordern inklusive moms i ören |
lefttopay | Number | Hur mycket det är kvar att betala på ordern, ska alltid vara 0 ty ordern betalas av fakturan |
mark | Sträng | Order markering |
invoice | Faktura | |
number | Nummer | Fakturans nummer i BRP |
ocrnumber | Nummer | Fakturans OCR-nummer |
totalamount | Nummer | Faktura värde i ören |
rest | Nummer | Kvar att betala på fakturan i ören |
invoicedate | Datum | Faktura datum |
duedate | Datum | Fakturans förfallodatum |
mark | Sträng | Faktura markering. Sätts till "Avser beställning 1234 hos Benify|Wellnet|Sop|Activway" om ordernr anges vid anrop. |
Inställningar
Inställningen "Använd förnya i partnerorder". Om satt tillåts att renew sätts på abonnemang.
usePartnerOrderInvoiceReferenceAsPayer
(TP55978)
If setting usePartnerOrderInvoiceReferenceAsPayer is FALSE
If organization (that is sent in API call from integrator) has invoice reference - the invoice will be on the Reference Person.
If organization (that is sent in API call from integrator) has no invoice reference - the invoice will be on the created Person.
If setting usePartnerOrderInvoiceReferenceAsPayer isTRUE
If integrator organization (setting) has an invoice reference - the invoice will be on the integrator organization reference person.
If integrator organization (setting) has no invoice reference - the invoice will be on the organization that is sent in API call from integrator. And if that also doesn't have a reference Person, then invoice will be on the created Person.
So the feature will work with the combination of New Setting + Invoice Reference set on Epassi Partner organization.