Page Comparison

...

Code Block
https://api.brpsystems.se/brpgog/

Anrop

Anropet sker med en http POST innehållande Xml.
Skicka alltid med headern:

Code Block
Content-Type: application/xml; charset=utf-8

Xml Xml:en valideras mot den xsd som ligger på:

Code Block
{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 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:

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

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

Code Block

<?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>
    <mobilephone>0731234567</mobilephone>
	<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:

Tag	Format	Förklaring
message	Sträng	Läsbart meddelande
code	Nummer	Felkoder
debuginfo	Sträng	Mer utförlig information om felet

Code Block

<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:

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.

Code Block

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

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.

Versions Compared

Old Version 35

New Version 36

Key

Anrop

Exempel

Anrop

Svar

Inställningar

usePartnerOrderInvoiceReferenceAsPayer

If setting usePartnerOrderInvoiceReferenceAsPayer is FALSE

If setting usePartnerOrderInvoiceReferenceAsPayer isTRUE