View on GitHub

runmyaccounts-rest-api

RESTful API Documentation

Vendor invoice entity

Element Description Default Type Mandatory
invnumber Unique key identifying the invoice   TEXT Yes
ordnumber Order number   TEXT  
status OPEN, PAID, OVERDUE OPEN    
currency Three character currency code CHF TEXT(3)  
ap_accno Accounts receivable account number 2000 TEXT  
transdate Invoice date   DATE Yes
duedate     DATE  
description Invoice title   TEXT  
notes     TEXT  
intnotes Internal notes usually not printed on the invoice   TEXT  
taxincluded Prices included taxes or not   BOOLEAN  
department Name of the department   Text  
vendor     vendor entity Yes
parts List of part elements describing the invoice positions   part Yes

Examples:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payable>
  <invnumber>K-001</invnumber>
  <ordnumber></ordnumber>
  <status>OPEN</status>
  <currency>CHF</currency>
  <ap_accno>2000</ap_accno>
  <transdate>2013-07-30T00:00:00+02:00</transdate>
  <duedate>2013-08-13T00:00:00+02:00</duedate>
  <description></description>
  <notes></notes>
  <intnotes></intnotes>
  <taxincluded>true</taxincluded>
  <dcn></dcn>
  <amount>100.0</amount>
  <netamount>100.0</netamount>
  <paid>50.0</paid>
  <paymentAccno>1020</paymentAccno>
  <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>
  <parts>
    <part>
      <income_accno>3400</income_accno>
      <expense_accno>4999</expense_accno>
      <partnumber>ART-1</partnumber>
      <description>ART-1</description>
      <unit></unit>
      <quantity>1.0</quantity>
      <sellprice>200.0</sellprice>
      <discount>0.0</discount>
      <itemnote></itemnote>
      <tax_accnos>2201,2206</tax_accnos>
      <price_update>2012-01-01T00:00:00+01:00</price_update>
    </part>
  </parts>
</payable>
{
   "invnumber": "K-001",
   "ordnumber": "",
   "status": "OPEN",
   "currency": "CHF",
   "ap_accno": "2000",
   "transdate": "2013-07-30T00:00:00+02:00",
   "duedate": "2013-08-13T00:00:00+02:00",
   "description": "",
   "notes": "",
   "intnotes": "",
   "taxincluded": "true",
   "dcn": "",
   "amount": "100.0",
   "netamount": "100.0",
   "paid": "50.0",
   "paymentAccno": "1020",
   "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"
   },
   "parts":
   {
       "part":
       {
           "income_accno": "3400",
           "expense_accno": "4999",
           "partnumber": "ART-1",
           "description": "ART-1",
           "unit": "",
           "quantity": "1.0",
           "sellprice": "200.0",
           "discount": "0.0",
           "itemnote": "",
           "tax_accnos": "2201,2206",
           "price_update": "2012-01-01T00:00:00+01:00"
       }
   }
}