amatino-http-docs/transaction_versions.json at master · amatino-code/amatino-http-docs · GitHub

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
{
    "title": "Transaction Version List",
    "category": "ancillary",
    "sidenav_override": "Tx Version List",
    "docpath": "transactions/version_list",
    "introduction": [
        "Amatino retains a version history of every <a href=\"/documentation/transactions\" class=\"link\">Transaction</a>. That history allows you to step backwards and forwards through changes to the accounting information describing an Entity. To view the history of a Transaction, you can retrieve a Transaction Version List."
        ],
    "object": {
        "name": "Transaction Version List",
        "exposition": "The Amatino API returns Transaction Version Lists with the following structure",
        "form": {
            "root": "list",
            "components": [
                {
                    "key": {
                        "value": "\"transaction_id\"",
                        "mono": true
                    },
                    "type": {
                        "value": "JSON Number",
                        "mono": false
                    },
                    "description": {
                        "value": "An integer identifier of the <a class=\"link\" href=\"/documentation/transactions\"Transaction</a> whose versions are contained herein",
                        "mono": false
                    },
                    "example": {
                        "value": 420123,
                        "mono": true
                    }
                },
                {
                    "key": {
                        "value": "\"versions\"",
                        "mono": true
                    },
                    "type": {
                        "value": "JSON Array",
                        "mono": false
                    },
                    "description": {
                        "value": "A list of all available versions of this Transaction",
                        "mono": false
                    },
                    "list objects": {
                        "value": "Transaction",
                        "mono": false,
                        "link": "/documentation/transactions"
                    },
                    "example": {
                        "value": "See <a href=\"/documentation/transactions\" class=\"link\">Transactions</a>",
                        "mono": false
                    }
                }
            ]
        }
    },
    "actions": [
        {
            "name": "Retrieve",
            "method": "GET",
            "path": "/transactions/versions/list",
            "description": "Retrieve a Transaction Versions List for a Transaction or Transactions",
            "return_root_type": "JSON Array",
            "required_json_data": null,
            "required_headers": [
                {
                    "key": "X-Signature",
                    "content": "Your <a class=\"link\" href=\"/documentation/sessions\">Session</a> signature",
                    "example": "\"yxATCPRKAAXHNiPctNQPHEGGVJF\"..."
                },
                {
                    "key": "X-Session-ID",
                    "content": "An an integer <a class=\"link\" href=\"/documentation/sessions\">Session</a> ID",
                    "example": 7449059267091272858
                }
            ],
            "required_url_parameters": [
                {
                    "key": "entity_id",
                    "type": "string",
                    "description": "The entity id of the entity from which you wish to retrieve a Recursive Balance",
                    "example": "oB3cjSNKXklkJ4Tb",
                    "repeatable": false
                },
                {
                    "key": "transaction_id",
                    "type": "string",
                    "description": "The unique integer id of a transaction for which you would like to retrieve a list of versions",
                    "example": 420123,
                    "repeatable": true
                }
            ],
            "returns": {
                "root": "list",
                "components": {
                    "object": "transaction_versions_list"
                }
            }
        }
    ]
}