Files
@ 3378805b80ee
Branch filter:
Location: NPO-Accounting/experimental-accounting-api/doc/source/restapi.rst
3378805b80ee
4.5 KiB
text/x-rst
[doc] Added REST API, using sphinxcontrib-httpdomain
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 | ==========
REST API
==========
Get transactions
----------------
.. http:get:: /transaction
Get all transactions
**Example request**
.. code-block:: http
GET /transaction HTTP/1.1
Host: accounting.example
Accept: application/json
**Example response**
.. code-block:: http
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
----------------
.. http:post:: /transaction
:jsonparam array transactions: A list of Transaction objects to add.
**Example request**
.. code-block:: http
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**
.. code-block:: http
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "OK",
"transaction_ids": [
"Ids can be anything"
]
}
Delete a transaction
--------------------
.. http:delete:: /transaction/<string:transaction_id>
Delete the transaction with ID :data:`transaction_id`.
**Example request**
.. code-block:: http
DELETE /transaction/123456 HTTP/1.1
Host: accounting.example
Accept: application/json
**Example response**
.. code-block:: http
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "OK"
}
|