View on GitHub

runmyaccounts-rest-api

RESTful API Documentation

Vendor entity

Element Description Default Type Mandatory
vendornumber Primary key of the vendor entity is the vendor number   TEXT(32) Yes
name Name of the vendor. The name of the business or full name of a person   TEXT(64) Yes
created Date of the creation   DATETIME  
ended Closing date of this vendor   DATETIME  
salutation Use this field for salutation information such as Dear Sir or Madam or Sir/Madam   TEXYT(32)  
firstname Contact’s first name   TEXYT(32)  
lastname Contact’s first name   TEXT(32)  
address1 First address line   TEXT(32)  
address2 Second address line   TEXT(32)  
zipcode Zip code with free ten character format   TEXT(10)  
city     TEXT(32)  
state     TEXT(32)  
country Free format   TEXT(32)  
terms Default payment terms in days   INTEGER  
phone     TEXT(20)  
fax     TEXT(20)  
mobile     TEXT(20)  
email     TEXT  
cc     TEXT  
bcc     TEXT  
notes Internal notes   TEXT  
taxnumber     TEXT(32)  
arap_accno Default accounts payable account number 2000 TEXT(32)  
payment_accno Default payment account number 1020 TEXT(32)  
bank_name Data identifying the vendor’s bank connection. Name of the bank.   TEXT(64)  
bank_address1 First address line of vendor’s bank connection   TEXT(32)  
bank_address2 Second address line   TEXT(32)  
bank_zipcode     TEXT(10)  
bank_city     TEXT(32)  
bank_state     TEXT(32)  
bank_country     TEXT(32)  
bank_iban     TEXT(34)  
bank_bic     TEXT(11)  

Example:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<vendor>
	<id>10880</id>
    <vendornumber>L-66</vendornumber>
    <name>ABC Lieferant</name>
    <created>2013-01-01T00:00:00+01:00</created>
    <salutation>Herr</salutation>
    <firstname>Hans</firstname>
    <lastname>Muster</lastname>
    <terms>14</terms>
    <address1>Seestrasse 63</address1>
    <address2></address2>
    <zipcode>8000</zipcode>
    <city>Zürich</city>
    <state>Zürich</state>
    <country>Schweiz</country>
    <phone>044 000 00 01</phone>
    <fax></fax>
    <mobile></mobile>
    <email>hans.muster@abc.ch</email>
    <taxnumber></taxnumber>
    <arap_accno>2000</arap_accno>
    <payment_accno>1020</payment_accno>
    <bank_name>CREDIT SUISSE</bank_name>
    <bank_address1>PARADEPLATZ</bank_address1>
    <bank_address2></bank_address2>
    <bank_zipcode>8000</bank_zipcode>
    <bank_city>ZüRICH</bank_city>
    <bank_country></bank_country>
    <bank_iban>CH57 0483 5053 9150 6000 1</bank_iban>
    <bank_bic>CRESCHZZ81Z</bank_bic>
</vendor>
{
  "id": "10880",
  "vendornumber": "L-66",
  "name": "ABC Lieferant",
  "created": "2013-01-01T00:00:00+01:00",
  "salutation": "Herr",
  "firstname": "Hans",
  "lastname": "Muster",
  "terms": "14",
  "address1": "Seestrasse 63",
  "address2": "",
  "zipcode": "8000",
  "city": "Zürich",
  "state": "Zürich",
  "country": "Schweiz",
  "phone": "044 000 00 01",
  "fax": "",
  "mobile": "",
  "email": "hans.muster@abc.ch",
  "taxnumber": "",
  "arap_accno": "2000",
  "payment_accno": "1020",
  "bank_name": "CREDIT SUISSE",
  "bank_address1": "PARADEPLATZ",
  "bank_address2": "",
  "bank_zipcode": "8000",
  "bank_city": "ZüRICH",
  "bank_country": "",
  "bank_iban": "CH57 0483 5053 9150 6000 1",
  "bank_bic": "CRESCHZZ81Z"
}