Child pages
  • Benify/Wellnet/S&P teknisk dokumentation
Skip to end of metadata
Go to start of metadata

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

 

Anropen för Benify sker mot:

POST {BasURL}/webservice/partnerorders/createbenifyorder?apikey={apiKey}

 

Anropen för Wellnet sker mot:

POST {BasURL}/webservice/partnerorders/createwellnetorder?apikey={apiKey}

 

Anropen för S&P sker mot:

POST {BasURL}/webservice/partnerorders/createsoporder?apikey={apiKey}

 

Anropen för Actiway sker mot:

POST {BasURL}/webservice/partnerorders/createactiwayorder?apikey={apiKey}

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:

 

POST {BasURL}/webservice/partnerorders/create{partner}order?apikey=338936767883

 

Exempel

Observera:

  1. priceincvat är priset i öre inklusive moms. 
  2. ordernr är beställningsnummer hos benify|wellnet|sop|actiway och hamnar som märkning på fakturan i BRP. "Avser beställning 1234567 hos Benify"
  3. Man ha en eller flera orderItems
Anrop
<?xml version="1.0" encoding="UTF-8"?>
<order>
  <origin>benify|wellnet|sop</origin>
  <version>1</version>
  <ordernr>1234567</ordernr>
  <businessunit>
    <id>1</id>
  </businessunit>
  <organization>
    <number>123425-2334</number>
    <name>Test Org.</name>
  </organization>

  <person>
    <firstname>Tessan</firstname>
    <lastname>Testsson</lastname>
    <personnumber>111111-1116</personnumber>
    <shippingstreet>Testgatan 4</shippingstreet>
    <shippingpostal>12345</shippingpostal>
    <shippingcity>Teststad</shippingcity>
    <shippingcountry>SE</shippingcountry>
    <email>tessan@test.com</email>
    <homephone>123 45</homephone>
    <workphone>07984245</workphone>
	<note>An optional message here.</note>
  </person>
 
  <orderitem>
    <productnumber>2</productnumber>
    <startday>2013-12-24</startday>
    <priceincvat>250000</priceincvat>
  </orderitem>
  <orderitem>
    <productnumber>4</productnumber>
    <startday>2013-12-24</startday>
    <priceincvat>1000</priceincvat>
  </orderitem>
</order>
Svar

Vid fel:

TagFormatFörklaring
messageSträngLäsbart meddelande
codeNummerFelkoder
debuginfoSträngMer utförlig information om felet
<errors>
  <error>
    <message>Invalid settings configuration</message>
    <code>1111</code>
    <debuginfo>Invalid value for setting 'organizationidflexpay', no organization found with id: null</debuginfo>
  </error>
</errors>

Engelska används som språk för eventuella felmeddelanden.

 

När det går som det ska:

TagFormatFörklaring
order Den skapade ordern
numberNummerOrdernummer
createdTidpunktNä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å
personnumberPersonnummerBeställarens personnummer
numberNummerBeställarens kundnummer i BRP
firstnameSträngBeställarens förnamn
lastnameSträngBeställarens efternamn
streetSträngBeställarens adress gata
postalSträngBeställarens adress postnummer
citySträngBeställarens adress stad
countrySträngBeställarens adress 2-bokstavslandskod enligt ISO 3166
businessunit Den anläggning som order är gjord på
nameSträngAnläggningens namn
organization Organisationen som order hör till
numberSträngOrganisationsnummer
nameSträngOrganisationens namn
product Produkt som ingår i beställningen
numberSträngProduktnummer i BRP
typeSträngProdukttyp
nameSträngProduktnamn
sumexvatNumberOrders totalpris exklusive moms i ören
vatsum Moms
rateNumberMomssatsen i procent
amountNumberMomsdelen i ören
sumNumberTotalpriset på ordern inklusive moms i ören
lefttopayNumberHur mycket det är kvar att betala på ordern, ska alltid vara 0 ty ordern betalas av fakturan
markSträngOrder markering
invoice Faktura
numberNummerFakturans nummer i BRP
ocrnumberNummerFakturans OCR-nummer
totalamountNummerFaktura värde i ören
restNummerKvar att betala på fakturan i ören
invoicedateDatumFaktura datum
duedateDatumFakturans förfallodatum
markSträngFaktura markering. Sätts till "Avser beställning 1234 hos Benify|Wellnet|Sop|Activway" om ordernr anges vid anrop.
<confirmation>
  <order>
    <number>137</number>
    <created>2013-11-20 10:31</created>
    <orderedby>
      <personnumber>111111-1116<personnumber>
      <number>10004</number>
      <firstname>Tessan</firstname>
      <lastname>Testsson</lastname>
      <street>Testgagan 4</streetaddress>
      <postal>12345</postaladdress>
      <city>Teststa</city>
      <country>SE</country>
    </orderedby>
    <businessunit>
      <name>Anläggning 2</name>
    </businessunit>
    <organization>
      <number>123425-2334</number>
      <name>Test Org.</name>
    </organization>
    <products>
      <product>
        <number>64575F</number>
        <type>Klippkort</type>
        <name>100 Entre klipp</name>
      </product>
	  <product>
        <number>10544C</number>
        <type>article</type>
        <name>Banana</name>
      </product>
    </products>
    <sumexvat>19660</sumexvat>
    <vatsums>
      <vatsum>
        <rate>25</rate>
        <amount>4680</amount>
      </vatsum>
	  <vatsum>
        <rate>6</rate>
        <amount>60</amount>
      </vatsum>
    </vatsums>
    <sum>24400</sum>
    <lefttopay>0</lefttopay>
    <mark>benify</mark>
  </order>
  <invoice>
    <number>14</number>
    <ocrnumber>1446</ocrnumber>
    <totalamount>24400</totalamount>
    <rest>24400</rest>
    <invoicedate>2013-11-20</invoicedate>
    <duedate>2013-11-30</duedate>
    <mark>Avser beställning 1234 hos Benify</mark>
  </invoice>
</confirmation>

Inställningar

Inställningen "Använd förnya i partnerorder". Om satt tillåts att renew sätts på abonnemang. 

  • No labels