Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Organizations

...

name

example

Typ

orgnumber

orgnumber=556016-0680

String

customernumbercustomernumber=14String

Request

HTTP GET /organization

Example:

Code Block
APIURL/organizations.xml?apikey=338934897438

...

Tag

Format

Example

Description

organizations

 

<organizations>

organizations-tag encloses organizations

organization

 

<organization>

Represents a organization

id

ID

<id>12</id>

Unique ID

businessunitidID<businessunitid>34</businessunitid>The business unit/facility the organization is connected to

name

String

<name>Organization</name>

Name of the organization

orgnumberString<orgnumber>5566778998</orgnumber>The organizationnumber of the organization
customernumberString<customernumber>14</customernumber>The customernumber of the organization
emailString<email>aaa.bbb@org.nu</email>Email
invoiceemailString<invoiceemail>a.b@org.nu</invoiceemail>Invoice email
phoneString<phone>013-223344</phone>Phonenumber
pricelist <pricelist><id>545</id><name>Pricelistname</name></pricelist>Price list used for the organization. These are listed by an ID in the BRP klient under Products - Settings - Price lists
discountNumber<discount>1250</discount>An across the board rebate for the organization. A rebate of 12,5% is entered as 1250. Please note that other prices may be used due to other combinations of price lists and rebates set on for example an organization. If price lists are used the final price will be a rebated price list price.
creditlimitNumber<creditlimit>100000</creditlimit>Credit limit in cents/ören. 60000 = 600,00 SEK
customerresponsible <customerresponsible><id>33</id><firstname>John</firstname> <lastname>Doe</lastname></customerresponsible>Customerresponsible
mailaddress <mailaddress><street>Storgatan 1</street><postalcode>12345</postalcode><city>Farsta</city><country>SE</country></mailaddress>The mailaddress of the organization.
invoiceaddress <invoiceaddress><street>Storgatan 2</street><postalcode>12345</postalcode><city>Farsta</city><country>SE</country></invoiceaddress>The invoiceaddress of the organization.
invoicereference <invoicereference><id>33</id><firstname>John</firstname> <lastname>Doe</lastname></invoicereference>The invoice reference for the organization.
organizationgroups <organizationgroups><organizationgroup><id>1</id><name>Groupname1</name></organizationgroup></<organizationgroups>Groups that the organization belongs to.
invoicedistributionmethodString<invoicedistributionmethod>email</invoicedistributionmethod>Invoice distribution method. Valid values are "email" and "centralprint21gramscentralPrint21Grams"
Code Block
<organizations>
  <organization>
    <id>12</id> 
    <name>Main Street Gym</name>
    <businessunitid>666</businessunitid>
	<orgnumber>12345567889</orgnumber>
	<customernumber>14</customernumber>
    <email>a.b@c.se</email> 
	<invoiceemail>d.e@f.se</invoiceemail>
    <phone>013-212233</phone>
	<pricelist>
		<id>545</id>
		<name>Pricelistname</name>
	</pricelist>
	<discount>2000</discount> 
	<creditlimit>100000</creditlimit> 
    <mailaddress>
		<street>Storgatan 1</street>
		<postalcode>12345</postalcode>
		<city>Farsta</city>
		<country>SE</country>
	</mailaddress>
	<invoiceaddress>
		<street>Storgatan 2</street>
		<postalcode>12345</postalcode>
		<city>Farsta</city>
		<country>SE</country>
	</invoiceaddress>
	<invoicereference>
		<id>33</id>
		<firstname>John</firstname>
		<lastname>Doe</lastname>
	</invoicereference>
    <invoicedistributionmethod>email</invoicedistributionmethod>
	<organizationgroups>
    	<organizationgroup>
      		<id>1</id>
      		<name>Groupname1</name>
    	</organizationgroup>
    	<organizationgroup>
      		<id>6</id>
      		<name>Groupname2</name>
    	</organizationgroup>
  	</organizationgroups>
  </businessunit>
</businessunits>

...