diff --git a/doc/build/html/restapi.html b/doc/build/html/restapi.html new file mode 100644 index 0000000000000000000000000000000000000000..7c7f50db7ca1a00d87662802c65e30e7d1dc1e8a --- /dev/null +++ b/doc/build/html/restapi.html @@ -0,0 +1,318 @@ + + + + + + + + REST API — Accounting API 0.1-beta documentation + + + + + + + + + + + + + +
+

Navigation

+ +
+ +
+
+
+
+ +
+

REST API

+
+

Get transactions

+
+
+GET /transaction
+

Get all transactions

+

Example request

+
GET /transaction HTTP/1.1
+Host: accounting.example
+Accept: application/json
+
+
+

Example response

+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "transactions": [
+    {
+      "__type__": "Transaction",
+      "date": "2010-01-01",
+      "id": "Ids can be anything",
+      "metadata": {},
+      "payee": "Kindly T. Donor",
+      "postings": [
+        {
+          "__type__": "Posting",
+          "account": "Income:Foo:Donation",
+          "amount": {
+            "__type__": "Amount",
+            "amount": "-100",
+            "symbol": "$"
+          },
+          "metadata": {
+            "Invoice": "Projects/Foo/Invoices/Invoice20100101.pdf"
+          }
+        },
+        {
+          "__type__": "Posting",
+          "account": "Assets:Checking",
+          "amount": {
+            "__type__": "Amount",
+            "amount": "100",
+            "symbol": "$"
+          },
+          "metadata": {}
+        }
+      ]
+    },
+    {
+      "__type__": "Transaction",
+      "date": "2011-03-15",
+      "id": "but mind you if they collide.",
+      "metadata": {},
+      "payee": "Another J. Donor",
+      "postings": [
+        {
+          "__type__": "Posting",
+          "account": "Income:Foo:Donation",
+          "amount": {
+            "__type__": "Amount",
+            "amount": "-400",
+            "symbol": "$"
+          },
+          "metadata": {
+            "Approval": "Projects/Foo/earmark-record.txt"
+          }
+        },
+        {
+          "__type__": "Posting",
+          "account": "Assets:Checking",
+          "amount": {
+            "__type__": "Amount",
+            "amount": "400",
+            "symbol": "$"
+          },
+          "metadata": {}
+        }
+      ]
+    },
+  ]
+}
+
+
+
+ +
+
+

Add transactions

+
+
+POST /transaction
+
+++ + + + + +
Json Parameters:
 
    +
  • transactions (array) – A list of Transaction objects to add.
    • +
+
+

Example request

+
POST /transaction HTTP/1.1
+Host: accounting.example
+Content-Type: application/json
+Accept: application/json
+
+{
+  "transactions": [
+    {
+      "__type__": "Transaction",
+      "date": "2010-01-01",
+      "id": "Ids can be anything",
+      "metadata": {},
+      "payee": "Kindly T. Donor",
+      "postings": [
+        {
+          "__type__": "Posting",
+          "account": "Income:Foo:Donation",
+          "amount": {
+            "__type__": "Amount",
+            "amount": "-100",
+            "symbol": "$"
+          },
+          "metadata": {
+            "Invoice": "Projects/Foo/Invoices/Invoice20100101.pdf"
+          }
+        },
+        {
+          "__type__": "Posting",
+          "account": "Assets:Checking",
+          "amount": {
+            "__type__": "Amount",
+            "amount": "100",
+            "symbol": "$"
+          },
+          "metadata": {}
+        }
+      ]
+    },
+  ]
+}
+
+
+

Example response

+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status": "OK",
+  "transaction_ids": [
+    "Ids can be anything"
+  ]
+}
+
+
+
+ +
+
+

Delete a transaction

+
+
+DELETE /transaction/<string:transaction_id>
+

Delete the transaction with ID transaction_id.

+

Example request

+
DELETE /transaction/123456 HTTP/1.1
+Host: accounting.example
+Accept: application/json
+
+
+

Example response

+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status": "OK"
+}
+
+
+
+ +
+
+ + +
+
+
+
+
+

Table Of Contents

+ + +

Previous topic

+

The Accounting API

+

Next topic

+

accounting package

+

This Page

+ + + +
+
+
+
+
+

Navigation

+ +
+
+ © Copyright 2013, Joar Wandborg. + Created using Sphinx 1.2. +
+ + \ No newline at end of file