View on GitHub

runmyaccounts-rest-api

RESTful API Documentation

General ledger entity

Element Description Default Type Mandatory
batch_number Booking reference number   TEXT Yes
transdate Transaction date   DATE Yes
description     TEXT  
currency Three char currency code CHF TEXT(3)  
exchangerate   1 DOUBLE  
notes Internal notes   TEXT  
gl_transactions List of general ledger transactions   General ledger transaction entities  

Entity gl_transaction

Element Description Default Type Mandatory
accno Account number   TEXT Yes
debit_amount     DOUBLE Yes or credit amount
credit_amount     DOUBLE Yes or debit amount
memo Additional note per transaction entry   TEXT  
source Additional text field per transaction entry   TEXT  

Examples:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<gl_batch>
  <batch_number>GL-001</batch_number>
  <currency>CHF</currency>
  <transdate>2013-07-30T00:00:00+02:00</transdate>
  <description>Bankübertrag</description>
  <notes></notes>
  <intnotes></intnotes>
  <exchangerate>1.0</exchangerate>
  <gl_transactions>
    <gl_transaction>
      <accno>1020</accno>
      <memo></memo>
      <source></source>
      <debit_amount>100</debit_amount>
      <credit_amount>0</credit_amount>
    </gl_transaction>  
    <gl_transaction>
      <accno>1021</accno>
      <memo></memo>
      <source></source>
      <accno></accno>
      <debit_amount>0</debit_amount>
      <credit_amount>100</credit_amount>
    </gl_transaction>
  </gl_transactions>
</gl_batch>
{  
   "batch_number":"GL-001",
   "transdate":"2016-04-06T11:48:05.555+02:00",
   "description":"Bankuebertrag",
   "currency":"CHF",
   "exchangerate":1.0,
   "gl_transactions":{  
      "gl_transaction":[  
         {  
            "debit_amount":100.0,
            "accno":"1020"
         },
         {  
            "credit_amount":100.0,
            "accno":"1021"
         }
      ]
   }
}