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 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798
use crate::types_prelude::*;
/// Creates a new cash account within a portfolio.
pub struct CashAccountCreate;
impl<'a> ApiEndpoint<'a> for CashAccountCreate {
const URL_PATH: &'static str = "/portfolios/:portfolio_id/cash_accounts.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Post;
type UrlDisplay = CashAccountCreateUrlDisplay<'a>;
type Parameters = CashAccountCreateParameters;
type Success = CashAccountCreateSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
CashAccountCreateUrlDisplay(parameters)
}
}
pub struct CashAccountCreateUrlDisplay<'a>(&'a CashAccountCreateParameters);
impl<'a> fmt::Display for CashAccountCreateUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(
f,
"/portfolios/{}/cash_accounts.json",
parameters.portfolio_id
)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct CashAccountCreateParameters {
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
pub cash_account: CashAccountCreateCashAccountParameters,
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct CashAccountCreateCashAccountParameters {
/// The new cash account's name.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The new cash account's currency.
pub currency: Currency,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountCreateSuccess {
pub cash_account: CashAccountCreateCashAccountSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountCreateCashAccountSuccess {
/// The cash account ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The cash account name.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The cash account currency code.
pub currency: Currency,
/// The cash accounts portfolio currency code.
pub portfolio_currency: Currency,
/// The portfolio ID
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// The cash accounts balance on date (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub date: NaiveDate,
/// The cash account balance on a given date (rounded to 2 decimal places).
pub balance: Float,
/// The cash account balance converted into the portfolios currency (rounded to 2 decimal places).
pub balance_in_portfolio_currency: Float,
/// List of links for this cash account
pub links: CashAccountCreateCashAccountLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountCreateCashAccountLinksSuccess {
/// Url of the portfolio of this cash account
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
}
/// Deletes an existing cash account.
pub struct CashAccountDelete;
impl<'a> ApiEndpoint<'a> for CashAccountDelete {
const URL_PATH: &'static str = "/cash_accounts/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Delete;
type UrlDisplay = CashAccountDeleteUrlDisplay<'a>;
type Parameters = CashAccountDeleteParameters;
type Success = ();
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
CashAccountDeleteUrlDisplay(parameters)
}
}
pub struct CashAccountDeleteUrlDisplay<'a>(&'a CashAccountDeleteParameters);
impl<'a> fmt::Display for CashAccountDeleteUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/cash_accounts/{}.json", parameters.id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct CashAccountDeleteParameters {
/// ID of the cash account to delete.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
}
/// Returns details about a cash account including its balance on a specified date.
pub struct CashAccountShow;
impl<'a> ApiEndpoint<'a> for CashAccountShow {
const URL_PATH: &'static str = "/cash_accounts/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = CashAccountShowUrlDisplay<'a>;
type Parameters = CashAccountShowParameters;
type Success = CashAccountShowSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
CashAccountShowUrlDisplay(parameters)
}
}
pub struct CashAccountShowUrlDisplay<'a>(&'a CashAccountShowParameters);
impl<'a> fmt::Display for CashAccountShowUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/cash_accounts/{}.json", parameters.id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct CashAccountShowParameters {
/// ID of the cash account to show.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// Cash Account balance on date (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub date: Option<NaiveDate>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountShowSuccess {
/// The cash account ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The cash account name.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The cash account currency code.
pub currency: Currency,
/// The cash accounts portfolio currency code.
pub portfolio_currency: Currency,
/// The portfolio ID
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// The cash accounts balance on date (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub date: NaiveDate,
/// The cash account balance on a given date (rounded to 2 decimal places).
pub balance: Float,
/// The cash account balance converted into the portfolios currency (rounded to 2 decimal places).
pub balance_in_portfolio_currency: Float,
/// List of links for this cash account
pub links: CashAccountShowLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountShowLinksSuccess {
/// Url of the portfolio of this cash account
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
/// Url to the current cash account
#[serde(rename = "self")]
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub itself: String,
}
/// Creates a new cash transaction within a cash account.
pub struct CashAccountTransactionCreate;
impl<'a> ApiEndpoint<'a> for CashAccountTransactionCreate {
const URL_PATH: &'static str = "/cash_accounts/:cash_account_id/cash_account_transactions.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Post;
type UrlDisplay = CashAccountTransactionCreateUrlDisplay<'a>;
type Parameters = CashAccountTransactionCreateParameters;
type Success = CashAccountTransactionCreateSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
CashAccountTransactionCreateUrlDisplay(parameters)
}
}
pub struct CashAccountTransactionCreateUrlDisplay<'a>(&'a CashAccountTransactionCreateParameters);
impl<'a> fmt::Display for CashAccountTransactionCreateUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(
f,
"/cash_accounts/{}/cash_account_transactions.json",
parameters.cash_account_id
)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct CashAccountTransactionCreateParameters {
/// ID of the cash account to list transactions for.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub cash_account_id: i64,
/// The new transaction description.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub description: String,
/// The new transaction amount.
pub amount: Float,
/// Transaction types may be any string. For example: `"OPENING BALANCE"`, `"DEPOSIT"`, `"WITHDRAWAL"`, `"INTEREST_PAYMENT"`, `"FEE"`, `"FEE_REIMBURSEMENT"`. The transaction type `"OPENING BALANCE"` has a rule to create an opening balance transaction, the others are all treated the same.
pub type_name: CashAccountTransactionTypeName,
/// The new transaction date and time (format `YYYY-MM-DDThh:mm:ss`, see <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>).
pub date_time: DateTime<FixedOffset>,
/// The new transaction foreign-identifier.
#[serde(default)]
pub foreign_identifier: Option<String>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountTransactionCreateSuccess {
pub cash_account_transaction: CashAccountTransactionCreateCashAccountTransactionSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountTransactionCreateCashAccountTransactionSuccess {
/// The transaction ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The transaction description.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub description: String,
/// The transaction date time (format `YYYY-MM-DDThh:mm:ss`, see <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>).
pub date_time: DateTime<FixedOffset>,
/// The transaction amount (rounded to 2 decimal places).
pub amount: Float,
/// The transaction balance (rounded to 2 decimal places).
pub balance: Float,
/// ID of the cash account to list transactions for.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub cash_account_id: i64,
/// The transaction foreign_identifier.
#[serde(default)]
pub foreign_identifier: Option<String>,
/// Whenever the transaction was generated through a trade sync, this is the ID for the holding it belongs to.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub holding_id: Option<i64>,
/// Whenever the transaction was generated through a trade sync, this is the ID for the trade it belongs to.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub trade_id: Option<i64>,
/// The transaction type.
pub cash_account_transaction_type: CashAccountTransactionType,
/// List of links for this cash account transaction
pub links: CashAccountTransactionCreateCashAccountTransactionLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountTransactionCreateCashAccountTransactionLinksSuccess {
/// Url of the portfolio of this cash account transaction
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
}
/// Deletes an existing cash account transaction.
pub struct CashAccountTransactionDelete;
impl<'a> ApiEndpoint<'a> for CashAccountTransactionDelete {
const URL_PATH: &'static str = "/cash_account_transactions/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Delete;
type UrlDisplay = CashAccountTransactionDeleteUrlDisplay<'a>;
type Parameters = CashAccountTransactionDeleteParameters;
type Success = ();
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
CashAccountTransactionDeleteUrlDisplay(parameters)
}
}
pub struct CashAccountTransactionDeleteUrlDisplay<'a>(&'a CashAccountTransactionDeleteParameters);
impl<'a> fmt::Display for CashAccountTransactionDeleteUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/cash_account_transactions/{}.json", parameters.id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct CashAccountTransactionDeleteParameters {
/// ID of the cash account transaction to delete.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
}
/// Update an existing cash account transaction.
pub struct CashAccountTransactionUpdate;
impl<'a> ApiEndpoint<'a> for CashAccountTransactionUpdate {
const URL_PATH: &'static str = "/cash_account_transactions/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Put;
type UrlDisplay = CashAccountTransactionUpdateUrlDisplay<'a>;
type Parameters = CashAccountTransactionUpdateParameters;
type Success = CashAccountTransactionUpdateSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
CashAccountTransactionUpdateUrlDisplay(parameters)
}
}
pub struct CashAccountTransactionUpdateUrlDisplay<'a>(&'a CashAccountTransactionUpdateParameters);
impl<'a> fmt::Display for CashAccountTransactionUpdateUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/cash_account_transactions/{}.json", parameters.id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct CashAccountTransactionUpdateParameters {
/// The transaction ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The transaction description.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub description: String,
/// The transaction amount.
pub amount: Float,
/// Transaction types may be any string. For example: `"OPENING BALANCE"`, `"DEPOSIT"`, `"WITHDRAWAL"`, `"INTEREST_PAYMENT"`, `"FEE"`, `"FEE_REIMBURSEMENT"`. The transaction type `"OPENING BALANCE"` has a rule to create an opening balance transaction, the others are all treated the same.
pub type_name: CashAccountTransactionTypeName,
/// The transaction date and time (format `YYYY-MM-DDThh:mm:ss`, see <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>).
pub date_time: DateTime<FixedOffset>,
/// The transaction foreign-identifier.
#[serde(default)]
pub foreign_identifier: Option<String>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountTransactionUpdateSuccess {
pub cash_account_transaction: CashAccountTransactionUpdateCashAccountTransactionSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountTransactionUpdateCashAccountTransactionSuccess {
/// The transaction ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The transaction description.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub description: String,
/// The transaction date time (format `YYYY-MM-DDThh:mm:ss`, see <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>).
pub date_time: DateTime<FixedOffset>,
/// The transaction amount (rounded to 2 decimal places).
pub amount: Float,
/// The transaction balance (rounded to 2 decimal places).
pub balance: Float,
/// ID of the cash account to list transactions for.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub cash_account_id: i64,
/// The transaction foreign_identifier.
#[serde(default)]
pub foreign_identifier: Option<String>,
/// Whenever the transaction was generated through a trade sync, this is the ID for the holding it belongs to.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub holding_id: Option<i64>,
/// Whenever the transaction was generated through a trade sync, this is the ID for the trade it belongs to.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub trade_id: Option<i64>,
/// The transaction type.
pub cash_account_transaction_type: CashAccountTransactionType,
/// List of links for this cash account transaction
pub links: CashAccountTransactionUpdateCashAccountTransactionLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountTransactionUpdateCashAccountTransactionLinksSuccess {
/// Url of the portfolio of this cash account transaction
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
}
/// Returns list of transactions for a cash account.
pub struct CashAccountTransactionsList;
impl<'a> ApiEndpoint<'a> for CashAccountTransactionsList {
const URL_PATH: &'static str = "/cash_accounts/:cash_account_id/cash_account_transactions.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = CashAccountTransactionsListUrlDisplay<'a>;
type Parameters = CashAccountTransactionsListParameters;
type Success = CashAccountTransactionsListSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
CashAccountTransactionsListUrlDisplay(parameters)
}
}
pub struct CashAccountTransactionsListUrlDisplay<'a>(&'a CashAccountTransactionsListParameters);
impl<'a> fmt::Display for CashAccountTransactionsListUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(
f,
"/cash_accounts/{}/cash_account_transactions.json",
parameters.cash_account_id
)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct CashAccountTransactionsListParameters {
/// ID of the cash account to list transactions for.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub cash_account_id: i64,
/// The transaction from date (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub from: Option<NaiveDate>,
/// The transaction to date (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub to: Option<NaiveDate>,
/// The transaction description
#[serde(default)]
pub description: Option<String>,
/// The transaction identifier
#[serde(default)]
pub foreign_identifier: Option<String>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountTransactionsListSuccess {
/// List of cash accounts.
pub cash_account_transactions: Vec<CashAccountTransactionsListCashAccountTransactionsSuccess>,
/// List of links for this resource
pub links: CashAccountTransactionsListLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountTransactionsListCashAccountTransactionsSuccess {
/// The transaction ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The transaction date and time.
pub date_time: DateTime<FixedOffset>,
/// The transaction amount (rounded to 2 decimal places).
pub amount: Float,
/// The transaction balance (rounded to 2 decimal places).
pub balance: Float,
/// ID of the cash account to list transactions for.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub cash_account_id: i64,
/// The transaction foreign_identifier.
#[serde(default)]
pub foreign_identifier: Option<String>,
/// Whenever the transaction was generated through a trade or payout sync, this is the ID for the holding it belongs to.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub holding_id: Option<i64>,
/// Whenever the transaction was generated through a trade sync, this is the ID for the trade it belongs to.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub trade_id: Option<i64>,
/// Whenever the transaction was generated through a payout sync, this is the ID for the payout it belongs to.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub payout_id: Option<i64>,
/// The transaction type.
pub cash_account_transaction_type: CashAccountTransactionType,
/// List of links for this cash account transaction
pub links: CashAccountTransactionsListCashAccountTransactionsLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountTransactionsListCashAccountTransactionsLinksSuccess {
/// Url of the portfolio of this cash account transaction
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountTransactionsListLinksSuccess {
/// Url to list of cash account transactions
#[serde(rename = "self")]
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub itself: String,
}
/// Updates attributes on an existing cash account.
pub struct CashAccountUpdate;
impl<'a> ApiEndpoint<'a> for CashAccountUpdate {
const URL_PATH: &'static str = "/cash_accounts/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Put;
type UrlDisplay = CashAccountUpdateUrlDisplay<'a>;
type Parameters = CashAccountUpdateParameters;
type Success = CashAccountUpdateSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
CashAccountUpdateUrlDisplay(parameters)
}
}
pub struct CashAccountUpdateUrlDisplay<'a>(&'a CashAccountUpdateParameters);
impl<'a> fmt::Display for CashAccountUpdateUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/cash_accounts/{}.json", parameters.id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct CashAccountUpdateParameters {
/// ID of the cash account to update.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The cash account's name.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The cash account's currency.
pub currency: Currency,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountUpdateSuccess {
/// The cash account ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The cash account name.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The cash account currency code.
pub currency: Currency,
/// The cash accounts portfolio currency code.
pub portfolio_currency: Currency,
/// The portfolio ID
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// The cash accounts balance on date (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub date: NaiveDate,
/// The cash account balance on a given date (rounded to 2 decimal places).
pub balance: Float,
/// The cash account balance converted into the portfolios currency (rounded to 2 decimal places).
pub balance_in_portfolio_currency: Float,
/// List of links for this cash account
pub links: CashAccountUpdateLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountUpdateLinksSuccess {
/// Url of the portfolio of this cash account
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
}
/// Returns list of cash accounts for a portfolio. If you want to only access the cash account of one particular portfolios, use https://api.sharesight.com/api/v2/portfolios/:id/cash_accounts.json. The response will be the same.
pub struct CashAccountsList;
impl<'a> ApiEndpoint<'a> for CashAccountsList {
const URL_PATH: &'static str = "/cash_accounts.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = &'static str;
type Parameters = CashAccountsListParameters;
type Success = CashAccountsListSuccess;
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/cash_accounts.json"
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct CashAccountsListParameters {
/// Cash Account balance on date (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub date: Option<NaiveDate>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountsListSuccess {
/// List of cash accounts.
pub cash_accounts: Vec<CashAccountsListCashAccountsSuccess>,
/// List of links for this resource
pub links: CashAccountsListLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountsListCashAccountsSuccess {
/// The cash account ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The cash account name.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The cash account currency code.
pub currency: Currency,
/// The portfolio ID
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// The portfolio currency
pub portfolio_currency: Currency,
/// The cash accounts balance on date (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub date: NaiveDate,
/// The cash account balance on a given date (rounded to 2 decimal places).
pub balance: Float,
/// The cash account balance converted into the portfolios currency (rounded to 2 decimal places).
pub balance_in_portfolio_currency: Float,
/// List of links for this cash account
pub links: CashAccountsListCashAccountsLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountsListCashAccountsLinksSuccess {
/// Url of the portfolio of this cash account
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CashAccountsListLinksSuccess {
/// Url to list of cash accounts
#[serde(rename = "self")]
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub itself: String,
}
/// Returns a specific document.
pub struct DocumentShow;
impl<'a> ApiEndpoint<'a> for DocumentShow {
const URL_PATH: &'static str = "/documents/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = DocumentShowUrlDisplay<'a>;
type Parameters = DocumentShowParameters;
type Success = DocumentShowSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
DocumentShowUrlDisplay(parameters)
}
}
pub struct DocumentShowUrlDisplay<'a>(&'a DocumentShowParameters);
impl<'a> fmt::Display for DocumentShowUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/documents/{}.json", parameters.id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct DocumentShowParameters {
/// The document ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct DocumentShowSuccess {
/// The file itself
pub file: (),
}
/// List all custom (and regular) groups which a user has defined
pub struct GroupsList;
impl<'a> ApiEndpoint<'a> for GroupsList {
const URL_PATH: &'static str = "/groups.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = &'static str;
type Parameters = ();
type Success = GroupsListSuccess;
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/groups.json"
}
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct GroupsListSuccess {
/// List of custom groups.
pub groups: Vec<GroupsListGroupsSuccess>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct GroupsListGroupsSuccess {
/// A unique id identifying the custom or regular group.
pub id: IdOrName,
/// The name of the group (not reliably unique).
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// True if this is a custom group.
pub custom: bool,
/// A list of portfolio ids a custom group can be used with (Custom groups can only be used on their creators portfolios)
#[serde(default)]
pub portfolio_ids: Option<Vec<i64>>,
}
/// The Create a holding merge endpoint is designed to record a company merger in the situation where you hold shares in a listed company that is wholly acquired by another listed company.
///
/// It creates a merge (cancel-trade) transaction against the cancelled holding. This transaction is similar to a sell trade. <br> It also creates a merge (buy-trade) transaction within the new holding and contains both the cost base and market value from the cancelled holding.
pub struct HoldingMergesCreate;
impl<'a> ApiEndpoint<'a> for HoldingMergesCreate {
const URL_PATH: &'static str = "/portfolios/:portfolio_id/holding_merges.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Post;
type UrlDisplay = HoldingMergesCreateUrlDisplay<'a>;
type Parameters = HoldingMergesCreateParameters;
type Success = HoldingMergesCreateSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
HoldingMergesCreateUrlDisplay(parameters)
}
}
pub struct HoldingMergesCreateUrlDisplay<'a>(&'a HoldingMergesCreateParameters);
impl<'a> fmt::Display for HoldingMergesCreateUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(
f,
"/portfolios/{}/holding_merges.json",
parameters.portfolio_id
)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct HoldingMergesCreateParameters {
/// The portfolio ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// Tho holding ID that is to cancel (sell)
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// The holding-merge date
#[serde_as(as = "DeserializeDate")]
pub merge_date: NaiveDate,
/// The quantity
pub quantity: Float,
/// The instrument symbol for the new holding (buy)
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// The market code for the new holding
pub market: Market,
/// The cancelled price
#[serde(default)]
pub cancelled_price: Option<Float>,
/// Your comments against the trade
#[serde(default)]
pub comments: Option<String>,
/// This is a string of up to 255 characters used to identify duplicate trades. Generate an identifier for each trade and Sharesight will check on upload that this trade has not already been loaded.
#[serde(default)]
pub unique_identifier: Option<String>,
/// Base64 encoded file to be attached to both trades (cancel- and buy-trade)
#[serde(default)]
pub attachment: Option<String>,
/// File name for the attachment. This parameter is required if attachment is set.
#[serde(default)]
pub attachment_filename: Option<String>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct HoldingMergesCreateSuccess {
pub holding_merge: HoldingMergesCreateHoldingMergeSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct HoldingMergesCreateHoldingMergeSuccess {
/// The ID. Equal to the cancel-trade ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// List of both trades created, cancel- and buy-trade
pub trades: Vec<HoldingMergesCreateHoldingMergeTradesSuccess>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct HoldingMergesCreateHoldingMergeTradesSuccess {
/// The trade ID. Maybe nil if the trade is based on an adjustment and has not yet been confirmed by the user.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The trade type (BUY, SELL, SPLIT, etc).
pub transaction_type: TradeDescription,
/// The trade date.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub transaction_date: String,
/// The market (ASX, NZX, etc).
pub market: Market,
/// The instrument code/symbol.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// Number of shares sold/bought.
pub quantity: Float,
/// Price paid/received.
pub price: Float,
/// The transfer's exchange rate.
pub exchange_rate: Float,
/// The transfer's brokerage.
pub brokerage: Float,
/// The brokerage currency.
pub brokerage_currency_code: Currency,
/// The value for the trade as displayed in the 'value' column of the UI. For a merge buy this is the cost of the transaction. The value displayed in the UI for the merge buy is the market value of the cancelled holding at the time of the merge event.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub value: String,
/// The company event linked to the transaction.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub company_event_id: Option<i64>,
/// Your unique identifier for this trade, if given
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub unique_identifier: String,
/// Any comments for that trade.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub comments: String,
/// Portfolio ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// Holding ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// Instrument ID of the related Holding.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub instrument_id: i64,
/// The state of the trade, can be any of "confirmed", "unconfirmed" or "rejected".
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
/// Filename of attachmented file, if present.
#[serde(default)]
pub attachment_filename: Option<String>,
/// Id of the attachment, if present. Use the documents endpoint to get a copy of the file.
#[serde(default)]
pub attachment_id: Option<String>,
}
/// Update a holding merge.
pub struct HoldingMergesUpdate;
impl<'a> ApiEndpoint<'a> for HoldingMergesUpdate {
const URL_PATH: &'static str = "/portfolios/:portfolio_id/holding_merges/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Put;
type UrlDisplay = HoldingMergesUpdateUrlDisplay<'a>;
type Parameters = HoldingMergesUpdateParameters;
type Success = HoldingMergesUpdateSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
HoldingMergesUpdateUrlDisplay(parameters)
}
}
pub struct HoldingMergesUpdateUrlDisplay<'a>(&'a HoldingMergesUpdateParameters);
impl<'a> fmt::Display for HoldingMergesUpdateUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(
f,
"/portfolios/{}/holding_merges/{}.json",
parameters.portfolio_id, parameters.id
)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct HoldingMergesUpdateParameters {
/// The portfolio ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// The ID of the cancel-trade
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The holding-merge date
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub merge_date: Option<NaiveDate>,
/// The quantity
#[serde(default)]
pub quantity: Option<Float>,
/// The instrument symbol for the new holding (buy)
#[serde(default)]
pub symbol: Option<String>,
/// The market code for the new holding
#[serde(default)]
pub market: Option<Market>,
/// The cancelled price
#[serde(default)]
pub cancelled_price: Option<Float>,
/// Your comments against the trade
#[serde(default)]
pub comments: Option<String>,
/// This is a string of up to 255 characters used to identify duplicate trades. Generate an identifier for each trade and Sharesight will check on upload that this trade has not already been loaded.
#[serde(default)]
pub unique_identifier: Option<String>,
/// Base64 encoded file to be attached to both trades (cancel- and buy-trade)
#[serde(default)]
pub attachment: Option<String>,
/// File name for the attachment. This parameter is required if attachment is set.
#[serde(default)]
pub attachment_filename: Option<String>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct HoldingMergesUpdateSuccess {
pub holding_merge: HoldingMergesUpdateHoldingMergeSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct HoldingMergesUpdateHoldingMergeSuccess {
/// The ID. Equal to the cancel-trade ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// List of both trades created, cancel- and buy-trade
pub trades: Vec<HoldingMergesUpdateHoldingMergeTradesSuccess>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct HoldingMergesUpdateHoldingMergeTradesSuccess {
/// The trade ID. Maybe nil if the trade is based on an adjustment and has not yet been confirmed by the user.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The trade type (BUY, SELL, SPLIT, etc).
pub transaction_type: TradeDescription,
/// The trade date.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub transaction_date: String,
/// The market (ASX, NZX, etc).
pub market: Market,
/// The instrument code/symbol.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// Number of shares sold/bought.
pub quantity: Float,
/// Price paid/received.
pub price: Float,
/// The transfer's exchange rate.
pub exchange_rate: Float,
/// The transfer's brokerage.
pub brokerage: Float,
/// The brokerage currency.
pub brokerage_currency_code: Currency,
/// The value for the trade as displayed in the 'value' column of the UI. For a merge buy this is the cost of the transaction. The value displayed in the UI for the merge buy is the market value of the cancelled holding at the time of the merge event.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub value: String,
/// The company event linked to the transaction.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub company_event_id: Option<i64>,
/// Your unique identifier for this trade, if given
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub unique_identifier: String,
/// Any comments for that trade.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub comments: String,
/// Portfolio ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// Holding ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// Instrument ID of the related Holding.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub instrument_id: i64,
/// The state of the trade, can be any of "confirmed", "unconfirmed" or "rejected".
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
/// Filename of attachmented file, if present.
#[serde(default)]
pub attachment_filename: Option<String>,
/// Id of the attachment, if present. Use the documents endpoint to get a copy of the file.
#[serde(default)]
pub attachment_id: Option<String>,
}
/// Returns trade transactions for a holding.
pub struct HoldingTrades;
impl<'a> ApiEndpoint<'a> for HoldingTrades {
const URL_PATH: &'static str = "/holdings/:holding_id/trades.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = HoldingTradesUrlDisplay<'a>;
type Parameters = HoldingTradesParameters;
type Success = HoldingTradesSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
HoldingTradesUrlDisplay(parameters)
}
}
pub struct HoldingTradesUrlDisplay<'a>(&'a HoldingTradesParameters);
impl<'a> fmt::Display for HoldingTradesUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/holdings/{}/trades.json", parameters.holding_id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct HoldingTradesParameters {
/// The holding id(to show trades for).
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub holding_id: String,
/// Search for trade with the given unique identifier.
#[serde(default)]
pub unique_identifier: Option<String>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct HoldingTradesSuccess {
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub trades: Vec<String>,
/// The current API Transaction.
pub api_transaction: HoldingTradesApiTransactionSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct HoldingTradesTradesSuccess {
/// The trade ID. Maybe nil if the trade is based on an adjustment and has not yet been confirmed by the user.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub id: String,
/// A unique identifier associated with this trade
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub unique_identifier: String,
/// The trade date (format YYYY-MM-DD).
#[serde_as(as = "DeserializeDate")]
pub transaction_date: NaiveDate,
/// Number of shares sold/bought.
pub quantity: Float,
/// Price paid/received.
pub price: Float,
/// For an opening balance, the cost base of the trade. Always returned in the portfolio currency
pub cost_base: Float,
/// The trade's exchange rate as portfolio currency / instrument currency.
pub exchange_rate: Float,
/// The trade's brokerage.
pub brokerage: Float,
/// The ISO code of the brokerage currency, must be either Portfolio or Instrument currency. If the instrument is a cryptocurrency, any valid brokerage currency is supported.
pub brokerage_currency_code: Currency,
/// The value for the trade as displayed in the 'value' column of the UI. For a return of capital, this will be the (signed) capital return value. For a capital call, this will be the (positive) capital return value. For a cost base adjustment, this will be the value of the adjustment. For an opening balance, this will be the market value: the market price x quantity at the opening balance date In each case this is in portfolio currency (rounded to 2 decimal places).
pub value: Float,
/// For a CAPITAL_RETURN or other trade with a linked payout, this is the paid on date
#[serde_as(as = "DeserializeDate")]
pub paid_on: NaiveDate,
/// The company event linked to the transaction.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub company_event_id: Option<i64>,
/// Any comments for that trade.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub comments: String,
/// Portfolio ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// Holding ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// The state of the trade, can be any of "confirmed", "unconfirmed" or "rejected".
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
/// The trade type ('BUY','SELL','SPLIT','BONUS','CONSOLD','CANCEL','CAPITAL_RETURN','OPENING_BALANCE','ADJUST_COST_BASE','CAPITAL_CALL').
pub transaction_type: TradeDescription,
/// Instrument ID of the related Holding.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub instrument_id: i64,
/// The instrument code/symbol
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// The market code (eg. `ASX`, `NZX`, etc).
pub market: Market,
/// The filename of any attachment
#[serde(default)]
pub attachment_filename: Option<String>,
/// The document id of any attachment, for use with the Show Document API (v2)
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub attachment_id: Option<i64>,
/// Returns 'true' if trade is confirmed. DEPRECATED: Use the state field to determine 'confirmed' vs. 'rejected' vs. 'unconfirmed' instead.
pub confirmed: bool,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct HoldingTradesApiTransactionSuccess {
/// The unique API Transaction id.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The API version you called.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub version: i64,
/// The path executed.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub action: String,
/// When the transaction was executed.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub timestamp: String,
}
/// Returns reject trade transactions for the holding.
pub struct HoldingTradesRejected;
impl<'a> ApiEndpoint<'a> for HoldingTradesRejected {
const URL_PATH: &'static str = "/holdings/:holding_id/rejected_trades.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = HoldingTradesRejectedUrlDisplay<'a>;
type Parameters = HoldingTradesRejectedParameters;
type Success = HoldingTradesRejectedSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
HoldingTradesRejectedUrlDisplay(parameters)
}
}
pub struct HoldingTradesRejectedUrlDisplay<'a>(&'a HoldingTradesRejectedParameters);
impl<'a> fmt::Display for HoldingTradesRejectedUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(
f,
"/holdings/{}/rejected_trades.json",
parameters.holding_id
)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct HoldingTradesRejectedParameters {
/// The holding id(to show trades for).
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub holding_id: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct HoldingTradesRejectedSuccess {
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub trades: Vec<String>,
/// The current API Transaction.
pub api_transaction: HoldingTradesRejectedApiTransactionSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct HoldingTradesRejectedTradesSuccess {
/// The trade ID. Maybe nil if the trade is based on an adjustment and has not yet been confirmed by the user.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub id: String,
/// A unique identifier associated with this trade
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub unique_identifier: String,
/// The trade date (format YYYY-MM-DD).
#[serde_as(as = "DeserializeDate")]
pub transaction_date: NaiveDate,
/// Number of shares sold/bought.
pub quantity: Float,
/// Price paid/received.
pub price: Float,
/// For an opening balance, the cost base of the trade. Always returned in the portfolio currency
pub cost_base: Float,
/// The trade's exchange rate as portfolio currency / instrument currency.
pub exchange_rate: Float,
/// The trade's brokerage.
pub brokerage: Float,
/// The ISO code of the brokerage currency, must be either Portfolio or Instrument currency. If the instrument is a cryptocurrency, any valid brokerage currency is supported.
pub brokerage_currency_code: Currency,
/// The value for the trade as displayed in the 'value' column of the UI. For a return of capital, this will be the (signed) capital return value. For a capital call, this will be the (positive) capital return value. For a cost base adjustment, this will be the value of the adjustment. For an opening balance, this will be the market value: the market price x quantity at the opening balance date In each case this is in portfolio currency (rounded to 2 decimal places).
pub value: Float,
/// For a CAPITAL_RETURN or other trade with a linked payout, this is the paid on date
#[serde_as(as = "DeserializeDate")]
pub paid_on: NaiveDate,
/// The company event linked to the transaction.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub company_event_id: Option<i64>,
/// Any comments for that trade.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub comments: String,
/// Portfolio ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// Holding ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// The state of the trade, can be any of "confirmed", "unconfirmed" or "rejected".
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
/// The trade type ('BUY','SELL','SPLIT','BONUS','CONSOLD','CANCEL','CAPITAL_RETURN','OPENING_BALANCE','ADJUST_COST_BASE','CAPITAL_CALL').
pub transaction_type: TradeDescription,
/// Instrument ID of the related Holding.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub instrument_id: i64,
/// The instrument code/symbol
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// The market code (eg. `ASX`, `NZX`, etc).
pub market: Market,
/// The filename of any attachment
#[serde(default)]
pub attachment_filename: Option<String>,
/// The document id of any attachment, for use with the Show Document API (v2)
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub attachment_id: Option<i64>,
/// Returns 'true' if trade is confirmed. DEPRECATED: Use the state field to determine 'confirmed' vs. 'rejected' vs. 'unconfirmed' instead.
pub confirmed: bool,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct HoldingTradesRejectedApiTransactionSuccess {
/// The unique API Transaction id.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The API version you called.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub version: i64,
/// The path executed.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub action: String,
/// When the transaction was executed.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub timestamp: String,
}
/// This takes a Google id token, from an approved mobile app. The token will be validated. If the email matches one registered with Sharesight (as the primary or Google ID email) then an access_token will be returned. Otherwise, a 404 error will be generated.
pub struct IdentityByToken;
impl<'a> ApiEndpoint<'a> for IdentityByToken {
const URL_PATH: &'static str = ".1-mobile/identity/by_token.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = &'static str;
type Parameters = IdentityByTokenParameters;
type Success = IdentityByTokenSuccess;
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/.1-mobile/identity/by_token.json"
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct IdentityByTokenParameters {
/// The ID token as sent by Google
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub id_token: String,
/// The client id assigned to your application
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub client_id: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct IdentityByTokenSuccess {
/// An access_token to access Sharesight
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub access_token: String,
/// An OAuth 2.0 refresh token
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub refresh_token: String,
/// The number of seconds the token will be valid
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub expires_in: i64,
/// The token type
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub token_type: String,
}
/// This takes a Google id token, from an approved mobile app. The token will be validated. A new Sharesight account (with no holdings) will be created. If the email matches one registered with Sharesight (as the primary or Google ID email) then an error will be returned. The access and refresh tokens will be returned. (Note that the user must create a holding before the account becomes useful).
pub struct IdentitySignupByToken;
impl<'a> ApiEndpoint<'a> for IdentitySignupByToken {
const URL_PATH: &'static str = ".1-mobile/identity/signup_by_token.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = &'static str;
type Parameters = IdentitySignupByTokenParameters;
type Success = IdentitySignupByTokenSuccess;
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/.1-mobile/identity/signup_by_token.json"
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct IdentitySignupByTokenParameters {
/// The ID token as sent by Google
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub id_token: String,
/// The client id assigned to your application
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub client_id: String,
/// The country code for the users first portfolio tax residence
pub country_code: Country,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct IdentitySignupByTokenSuccess {
/// An access_token to access Sharesight
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub access_token: String,
/// An OAuth 2.0 refresh token
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub refresh_token: String,
/// The number of seconds the token will be valid
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub expires_in: i64,
/// The token type
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub token_type: String,
}
/// Returns a list of instruments in the current user's portfolios.
pub struct ListUserInstruments;
impl<'a> ApiEndpoint<'a> for ListUserInstruments {
const URL_PATH: &'static str = "/user_instruments.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = &'static str;
type Parameters = ();
type Success = ListUserInstrumentsSuccess;
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/user_instruments.json"
}
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct ListUserInstrumentsSuccess {
/// List of instruments.
pub instruments: Vec<ListUserInstrumentsInstrumentsSuccess>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct ListUserInstrumentsInstrumentsSuccess {
/// Identifier for this instrument.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The instrument's code (on the associated market).
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub code: String,
/// The market this instrument is listed on.
pub market_code: Market,
/// The instrument name.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The currency this instrument is listed in, or default market currency if nothing specified for the instrument.
pub currency_code: Currency,
/// The price-earnings ratio for this instrument.
#[serde(default)]
pub pe_ratio: Option<Float>,
/// The net tangible assets for this instrument displayed on it's currency.
#[serde(default)]
pub nta: Option<Float>,
/// The earnings per share for this instrument displayed on it's currency.
#[serde(default)]
pub eps: Option<Float>,
/// The current price for this instrument displayed on it's currency.
#[serde(default)]
pub current_price: Option<Float>,
/// The date and time the current price was loaded (format YYYY-MM-DDThh:mm:ss, see <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>).
#[serde(default)]
pub current_price_updated_at: Option<DateTime<FixedOffset>>,
/// The instrument sector.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub sector_classification_name: String,
/// The instrument industry.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub industry_classification_name: String,
/// The instrument security type. [DEPRECATED, use friendly_instrument_description]
#[serde(default)]
pub security_type: Option<String>,
/// A normalised description of the instrument.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub friendly_instrument_description: String,
/// The instrument registry.
#[serde(default)]
pub registry_name: Option<String>,
}
/// Create a new membership for a user's portfolio, using an existing user id or by creating a new user (providing email, etc.).
///
/// You may only use this endpoint if the user is on the required plan (not free, etc.).
pub struct MembershipCreate;
impl<'a> ApiEndpoint<'a> for MembershipCreate {
const URL_PATH: &'static str = "/memberships.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Post;
type UrlDisplay = &'static str;
type Parameters = MembershipCreateParameters;
type Success = MembershipCreateSuccess;
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/memberships.json"
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct MembershipCreateParameters {
pub membership: MembershipCreateMembershipParameters,
/// Details about the new user to create. You have to provide the user_id or a user hash.
#[serde(default)]
pub user: Option<MembershipCreateUserParameters>,
/// Details about the invitation created together with the membership
pub invitation: MembershipCreateInvitationParameters,
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct MembershipCreateMembershipParameters {
/// Portfolio ID to create the membership for.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// Access level (one of NONE, READ, EDIT, ADMIN, OWNER)
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub access_code: String,
/// User ID to use for the new membership. You have to provide the user_id or a user hash.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub user_id: Option<i64>,
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct MembershipCreateUserParameters {
/// The email address of the new user.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub email: String,
/// The first name of the new user.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub first_name: String,
/// The last name of the new user.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub last_name: String,
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct MembershipCreateInvitationParameters {
/// Invitation text sent to the new member. No HTML tags are allowed here but line-breaks are converted into paragraphs and HTML line breaks (e.g. "\n" into `\>br /\<` and "\n\n" into wrapping `\>p\<...\>/p\<` elements).
#[serde(default)]
pub text: Option<String>,
/// Set to true if you don't want an invitation email being sent to the new member.
#[serde(default)]
pub no_email: Option<bool>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct MembershipCreateSuccess {
/// The membership ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// Access level (one of NONE, READ, EDIT, ADMIN, OWNER)
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub access_code: String,
/// The portfolio ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// If present, organisation name associated with this membership.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub organisation_name: String,
/// If true, this membership is for a Sharesight Pro organisation and the portfolio has been shared to the whole organisation. The user details returned will be those of the organisation's main account, so may differ from the invited email address.
pub shared_with_organisation: bool,
pub user: MembershipCreateUserSuccess,
/// True if the user enabled portfolio alerts.
pub alerts_enabled: bool,
/// True if the user enabled company event alerts.
pub company_event_alerts_enabled: bool,
/// True if the user enabled price alerts.
pub price_alerts_enabled: bool,
pub invitation: MembershipCreateInvitationSuccess,
/// List of links for this membership
pub links: MembershipCreateLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct MembershipCreateUserSuccess {
/// The user ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The user's first name.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub first_name: i64,
/// The user's last name'.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub last_name: i64,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct MembershipCreateInvitationSuccess {
/// The invitation ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The invitation text.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub text: String,
/// 'accepted' or 'pending'
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub status: String,
/// URL used for the invitation. Note that you can append a "redirect_to" parameter to the invitation URL in case you want the user to be redirected to the specified path after the invitation is accepted; ex. https://portfolio.sharesight.com/invitations?code=code&redirect_to=/portfolios/1
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub url: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct MembershipCreateLinksSuccess {
/// Url of the portfolio of this membership
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
}
/// Delete an existing user membership.
///
/// You may only use this endpoint if the user is on the required plan (not free, etc.).
pub struct MembershipDelete;
impl<'a> ApiEndpoint<'a> for MembershipDelete {
const URL_PATH: &'static str = "/memberships/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Delete;
type UrlDisplay = MembershipDeleteUrlDisplay<'a>;
type Parameters = MembershipDeleteParameters;
type Success = ();
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
MembershipDeleteUrlDisplay(parameters)
}
}
pub struct MembershipDeleteUrlDisplay<'a>(&'a MembershipDeleteParameters);
impl<'a> fmt::Display for MembershipDeleteUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/memberships/{}.json", parameters.id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct MembershipDeleteParameters {
/// ID of the membership to delete.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
}
/// Lists memberships for the current user's portfolios.
///
/// If you want to only access the memberships of one particular portfolio, use `https://api.sharesight.com/api/v2/portfolios/:id/memberships.json`. The response will be the same.
///
/// You may only use this endpoint if the user is on the required plan (not free, etc.).
///
/// To access the memberships of all the user's portfolios, use this common endpoint:
pub struct MembershipList;
impl<'a> ApiEndpoint<'a> for MembershipList {
const URL_PATH: &'static str = "/memberships.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = &'static str;
type Parameters = ();
type Success = MembershipListSuccess;
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/memberships.json"
}
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct MembershipListSuccess {
/// List of memberships.
pub memberships: Vec<MembershipListMembershipsSuccess>,
/// If present, organisation name associated with this membership.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub organisation_name: String,
/// If true, this membership is for a Sharesight Pro organisation and the portfolio has been shared to the whole organisation.
pub shared_with_organisation: bool,
/// List of links for this resource
pub links: MembershipListLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct MembershipListMembershipsSuccess {
/// The membership ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// Access level (one of NONE, READ, EDIT, ADMIN, OWNER)
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub access_code: String,
/// The portfolio ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// The user details.
pub user: MembershipListMembershipsUserSuccess,
/// True if the user enabled portfolio alerts.
pub alerts_enabled: bool,
/// True if the user enabled company event alerts.
pub company_event_alerts_enabled: bool,
/// True if the user enabled price alerts.
pub price_alerts_enabled: bool,
pub invitation: MembershipListMembershipsInvitationSuccess,
/// List of links for this membership
pub links: MembershipListMembershipsLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct MembershipListMembershipsUserSuccess {
/// The user id.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The user first name.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub first_name: String,
/// The user last name.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub last_name: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct MembershipListPortfoliosSuccess {
/// Alerts sent on: one of 0 (no emails), 1 (all emails), 2 (email errors only).
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub api_email_notification: i64,
/// Notifications for Trade Confirmation Emails. One of: 0 (no emails), 1 (all emails), 2 (email errors only).
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub contract_note_email_notification: i64,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct MembershipListMembershipsInvitationSuccess {
/// The invitation ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The invitation text.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub text: String,
/// URL used for the invitation.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub url: String,
/// 'accepted' or 'pending'
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub status: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct MembershipListMembershipsLinksSuccess {
/// Url of the portfolio of this membership
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct MembershipListLinksSuccess {
/// Url to list of memberships
#[serde(rename = "self")]
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub itself: String,
}
/// Update an existing user membership.
///
/// You may only use this endpoint if the user is on the required plan (not free, etc.).
pub struct MembershipUpdate;
impl<'a> ApiEndpoint<'a> for MembershipUpdate {
const URL_PATH: &'static str = "/memberships/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Put;
type UrlDisplay = MembershipUpdateUrlDisplay<'a>;
type Parameters = MembershipUpdateParameters;
type Success = MembershipUpdateSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
MembershipUpdateUrlDisplay(parameters)
}
}
pub struct MembershipUpdateUrlDisplay<'a>(&'a MembershipUpdateParameters);
impl<'a> fmt::Display for MembershipUpdateUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/memberships/{}.json", parameters.id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct MembershipUpdateParameters {
/// ID of the membership to update.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// Access level (one of NONE, READ, EDIT, ADMIN, OWNER)
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub access_code: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct MembershipUpdateSuccess {
/// The membership ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// Access level (one of NONE, READ, EDIT, ADMIN, OWNER)
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub access_code: String,
/// The portfolio ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// The user details.
pub user: MembershipUpdateUserSuccess,
/// True if the user enabled portfolio alerts.
pub alerts_enabled: bool,
/// True if the user enabled company event alerts.
pub company_event_alerts_enabled: bool,
/// True if the user enabled price alerts.
pub price_alerts_enabled: bool,
pub invitation: MembershipUpdateInvitationSuccess,
/// List of links for this membership
pub links: MembershipUpdateLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct MembershipUpdateUserSuccess {
/// The user id.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The user first name.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub first_name: String,
/// The user last name.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub last_name: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct MembershipUpdateInvitationSuccess {
/// The invitation ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The invitation text.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub text: String,
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub url: String,
/// 'accepted' or 'pending'
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub status: String,
/// URL used for the invitation.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub invitation_path: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct MembershipUpdateLinksSuccess {
/// Url of the portfolio of this membership
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
}
/// Access currency definitions
pub struct Currencies;
impl<'a> ApiEndpoint<'a> for Currencies {
const URL_PATH: &'static str = "/currencies.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = &'static str;
type Parameters = ();
type Success = CurrenciesSuccess;
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/currencies.json"
}
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CurrenciesSuccess {
/// List of currency definitions
pub currencies: Vec<CurrenciesCurrenciesSuccess>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CurrenciesCurrenciesSuccess {
/// The ISO currency code
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub code: String,
/// An integer currency id
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub id: String,
/// The currency description
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub description: String,
/// The date the currency came into use
#[serde_as(as = "DeserializeDate")]
pub in_use_from: NaiveDate,
/// The date the currency came into use
#[serde_as(as = "DeserializeDate")]
pub in_use_until: NaiveDate,
/// The source data feeds with symbol when not ISO and date ranges if applicable
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub source_feeds: String,
}
/// Returns payouts for the user’s holding between the two supplied dates.
pub struct ListHoldingPayouts;
impl<'a> ApiEndpoint<'a> for ListHoldingPayouts {
const URL_PATH: &'static str = "/holdings/:holding_id/payouts.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = ListHoldingPayoutsUrlDisplay<'a>;
type Parameters = ListHoldingPayoutsParameters;
type Success = ListHoldingPayoutsSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
ListHoldingPayoutsUrlDisplay(parameters)
}
}
pub struct ListHoldingPayoutsUrlDisplay<'a>(&'a ListHoldingPayoutsParameters);
impl<'a> fmt::Display for ListHoldingPayoutsUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/holdings/{}/payouts.json", parameters.holding_id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct ListHoldingPayoutsParameters {
/// The holding ID (to show payouts for).
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// Show trades from this date on (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub start_date: Option<NaiveDate>,
/// Show trades until this date (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub end_date: Option<NaiveDate>,
/// Which payout date to use when filtering. Allowed values: `"paid_on"`, `"ex_date"`.
#[serde(default)]
pub use_date: Option<String>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct ListHoldingPayoutsSuccess {
/// List of payouts.
pub payouts: Vec<ListHoldingPayoutsPayoutsSuccess>,
/// List of links for this resource
pub links: ListHoldingPayoutsLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct ListHoldingPayoutsPayoutsSuccess {
/// The payout ID.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub id: Option<i64>,
/// Payout company/instrument symbol on the market.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// Market code.
pub market: Market,
/// The payout date (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub paid_on: NaiveDate,
/// The payout ex date (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub ex_date: Option<NaiveDate>,
/// The payout amount.
pub amount: Float,
/// The calculated gross amount
pub gross_amount: Float,
/// The payout type: DIV (Dividend), REP (Capital replayment), INT (Interest), or DIS (Distribution)
pub transaction_description: PayoutDescription,
/// The payout resident withholding tax amount. Always returned in the portfolio currency.
#[serde(default)]
pub resident_withholding_tax: Option<Float>,
/// The payout non-resident withholding tax amount.
#[serde(default)]
pub non_resident_withholding_tax: Option<Float>,
/// The payout tax credit amount. Always returned in the portfolio currency.
#[serde(default)]
pub tax_credit: Option<Float>,
/// Currency code of the payout, using 3-letter ISO 4217 code.
pub currency: Currency,
/// The payout's exchange rate.
pub exchange_rate: Float,
/// If `true`, payout is non taxable.
pub non_taxable: bool,
/// Any comments for that payout.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub comments: String,
/// Other net foreign source income.
#[serde(default)]
pub other_net_fsi: Option<Float>,
/// The amount of an LIC dividend that is attributable to an LIC capital gain.
pub lic_capital_gain: Float,
/// ID of the company event the given payout is based on (nil if not based on any).
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub company_event_id: Option<i64>,
/// The state of the payout, can be any of `"confirmed"`, `"unconfirmed"` or `"rejected"`.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
/// Parameters when the payout is reinvested.
#[serde(default)]
pub drp_trade_attributes: Option<ListHoldingPayoutsPayoutsDrpTradeAttributesSuccess>,
/// Franked amount in the payout. (Australia only)
#[serde(default)]
pub franked_amount: Option<Float>,
/// Unfranked amount in the payout (Australia only)
#[serde(default)]
pub unfranked_amount: Option<Float>,
/// `true` if this payout is for a trust. (Australia only)
#[serde(default)]
pub trust: Option<bool>,
/// Extra interest amount in this payout. (Australia only)
#[serde(default)]
pub extra_interest_payment_amount: Option<Float>,
/// Capital gain amount in this payout. (Australia only)
#[serde(default)]
pub capital_gains: Option<Float>,
/// Discounted capital gain amount in this payout. (Australia only)
#[serde(default)]
pub discounted_capital_gains: Option<Float>,
/// Interest payment amount in this payout. (Australia only)
#[serde(default)]
pub interest_payment: Option<Float>,
/// Amount of foreign income in this payout. (Australia only)
#[serde(default)]
pub foreign_source_income: Option<Float>,
/// Value of deferred income in this payout. (Australia only)
#[serde(default)]
pub deferred_income: Option<Float>,
/// `true` if this payout is not assessed for tax. (Australia only)
#[serde(default)]
pub non_assessable: Option<bool>,
/// Value of CGT concession in this payout. (Australia only)
#[serde(default)]
pub cgt_concession_amount: Option<Float>,
/// Relevant for attribution managed investment trusts (AMIT) when the taxable income attributed to you is less than the cash distribution you received. This amount is non-assessable and is used to decrease your cost base for cgt purposes (Australia only)
#[serde(default)]
pub amit_decrease_amount: Option<Float>,
/// Relevant for attribution managed investment trusts (AMIT) when the taxable income attributed to you is more than the cash distribution you received. This amount is non-assessable and is used to increase your cost base for cgt purposes (Australia only)
#[serde(default)]
pub amit_increase_amount: Option<Float>,
/// List of links for this payout
pub links: ListHoldingPayoutsPayoutsLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct ListHoldingPayoutsPayoutsDrpTradeAttributesSuccess {
/// `true` for a reinvested payout.
pub dividend_reinvested: bool,
/// How many units are reinvested.
pub quantity: Float,
/// Price per reinvested unit.
pub price: Float,
/// ID of any source adjustment for the reinvested amount.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub source_adjustment_id: Option<i64>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct ListHoldingPayoutsPayoutsLinksSuccess {
/// Url of the portfolio of this payout
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct ListHoldingPayoutsLinksSuccess {
/// Url to list of payouts
#[serde(rename = "self")]
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub itself: String,
}
/// Returns payouts for the user’s portfolio between the two supplied dates.
pub struct ListPortfolioPayouts;
impl<'a> ApiEndpoint<'a> for ListPortfolioPayouts {
const URL_PATH: &'static str = "/portfolios/:portfolio_id/payouts.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = ListPortfolioPayoutsUrlDisplay<'a>;
type Parameters = ListPortfolioPayoutsParameters;
type Success = ListPortfolioPayoutsSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
ListPortfolioPayoutsUrlDisplay(parameters)
}
}
pub struct ListPortfolioPayoutsUrlDisplay<'a>(&'a ListPortfolioPayoutsParameters);
impl<'a> fmt::Display for ListPortfolioPayoutsUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/portfolios/{}/payouts.json", parameters.portfolio_id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct ListPortfolioPayoutsParameters {
/// The portfolio ID (to show payouts for).
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// Show payouts from this date on (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub start_date: Option<NaiveDate>,
/// Show payouts until this date (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub end_date: Option<NaiveDate>,
/// Which payout date to use when filtering. Allowed values: `"paid_on"`, `"ex_date"`.
#[serde(default)]
pub use_date: Option<String>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct ListPortfolioPayoutsSuccess {
/// List of payouts.
pub payouts: Vec<ListPortfolioPayoutsPayoutsSuccess>,
/// List of links for this resource
pub links: ListPortfolioPayoutsLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct ListPortfolioPayoutsPayoutsSuccess {
/// The payout ID.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub id: Option<i64>,
/// The portfolio ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// The holding ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// The instrument ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub instrument_id: i64,
/// Payout company/instrument symbol on the market.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// Market code.
pub market: Market,
/// The payout date (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub paid_on: NaiveDate,
/// The payout ex date (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub ex_date: Option<NaiveDate>,
/// The payout amount.
pub amount: Float,
/// The calculated gross amount
pub gross_amount: Float,
/// The payout resident withholding tax amount. Always returned in the portfolio currency.
#[serde(default)]
pub resident_withholding_tax: Option<Float>,
/// The payout non-resident withholding tax amount.
#[serde(default)]
pub non_resident_withholding_tax: Option<Float>,
/// The payout tax credit amount. Always returned in the portfolio currency.
#[serde(default)]
pub tax_credit: Option<Float>,
/// Currency code of the payout, using 3-letter ISO 4217 code.
pub currency: Currency,
/// The payout's exchange rate.
pub exchange_rate: Float,
/// If true, payout is non taxable.
pub non_taxable: bool,
/// Any comments for that payout.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub comments: String,
/// Other net foreign source income.
#[serde(default)]
pub other_net_fsi: Option<Float>,
/// ID of the company event the given payout is based on (nil if not based on any).
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub company_event_id: Option<i64>,
/// The state of the payout, can be any of `"confirmed"`, `"unconfirmed"` or `"rejected"`.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
/// Parameters when the payout is reinvested.
#[serde(default)]
pub drp_trade_attributes: Option<ListPortfolioPayoutsPayoutsDrpTradeAttributesSuccess>,
/// Franked amount in the payout. (Australia only)
#[serde(default)]
pub franked_amount: Option<Float>,
/// Unfranked amount in the payout (Australia only)
#[serde(default)]
pub unfranked_amount: Option<Float>,
/// `true` if this payout is for a trust. (Australia only)
#[serde(default)]
pub trust: Option<bool>,
/// Extra interest amount in this payout. (Australia only)
#[serde(default)]
pub extra_interest_payment_amount: Option<Float>,
/// Capital gain amount in this payout. (Australia only)
#[serde(default)]
pub capital_gains: Option<Float>,
/// Discounted capital gain amount in this payout. (Australia only)
#[serde(default)]
pub discounted_capital_gains: Option<Float>,
/// Interest payment amount in this payout. (Australia only)
#[serde(default)]
pub interest_payment: Option<Float>,
/// Amount of foreign income in this payout. (Australia only)
#[serde(default)]
pub foreign_source_income: Option<Float>,
/// Value of deferred income in this payout. (Australia only)
#[serde(default)]
pub deferred_income: Option<Float>,
/// True if this payout is not assessed for tax. (Australia only)
#[serde(default)]
pub non_assessable: Option<bool>,
/// Relevant for attribution managed investment trusts (AMIT) when the taxable income attributed to you is less than the cash distribution you received. This amount is non-assessable and is used to decrease your cost base for cgt purposes (Australia only)
#[serde(default)]
pub amit_decrease_amount: Option<Float>,
/// Relevant for attribution managed investment trusts (AMIT) when the taxable income attributed to you is more than the cash distribution you received. This amount is non-assessable and is used to increase your cost base for cgt purposes (Australia only)
#[serde(default)]
pub amit_increase_amount: Option<Float>,
/// List of links for this payout
pub links: ListPortfolioPayoutsPayoutsLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct ListPortfolioPayoutsPayoutsDrpTradeAttributesSuccess {
/// True for a reinvested payout.
pub dividend_reinvested: bool,
/// How many units are reinvested.
pub quantity: Float,
/// Price per reinvested unit.
pub price: Float,
/// ID of any source adjustment for the reinvested amount.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub source_adjustment_id: Option<i64>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct ListPortfolioPayoutsPayoutsLinksSuccess {
/// Url of the portfolio of this payout
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct ListPortfolioPayoutsLinksSuccess {
/// Url to list of payouts
#[serde(rename = "self")]
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub itself: String,
}
/// Confirm a payout. Tnis can be either a payout based on a company event or a payout based on the payment date of an interest payment.
pub struct PayoutConfirm;
impl<'a> ApiEndpoint<'a> for PayoutConfirm {
const URL_PATH: &'static str = "/payouts.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Post;
type UrlDisplay = &'static str;
type Parameters = PayoutConfirmParameters;
type Success = PayoutConfirmSuccess;
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/payouts.json"
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct PayoutConfirmPayoutParameters {
/// The ID of the holding.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// ID used to identify the company event the unconfirmed payout is based on.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub company_event_id: i64,
/// Date used to identify the payout based on a payment date of an interest payment (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub paid_on: NaiveDate,
/// The new state of the payout: `"confirmed"`.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
/// Parameters when the payout is reinvested.
#[serde(default)]
pub drp_trade_attributes: Option<PayoutConfirmPayoutDrpTradeAttributesParameters>,
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct PayoutConfirmPayoutDrpTradeAttributesParameters {
/// `true` for a reinvested payout.
#[serde(default)]
pub dividend_reinvested: Option<bool>,
/// How many units are reinvested.
#[serde(default)]
pub quantity: Option<Float>,
/// Price per reinvested unit.
#[serde(default)]
pub price: Option<Float>,
/// ID of any source adjustment for the reinvested amount (same as `company_event_id`).
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub source_adjustment_id: Option<i64>,
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct PayoutConfirmParameters {
pub payout: PayoutConfirmPayoutParameters,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PayoutConfirmSuccess {
/// The confirmed payout.
pub payout: PayoutConfirmPayoutSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PayoutConfirmPayoutSuccess {
/// The payout ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The portfolio ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// The holding ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// The instrument ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub instrument_id: i64,
/// Payout company/instrument symbol on the market.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// Market code.
pub market: Market,
/// The payout date (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub paid_on: NaiveDate,
/// The payout ex date (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub ex_date: Option<NaiveDate>,
/// The payout amount.
pub amount: Float,
/// The calculated gross amount
pub gross_amount: Float,
/// The payout resident withholding tax amount. Always returned in the portfolio currency.
#[serde(default)]
pub resident_withholding_tax: Option<Float>,
/// The payout non-resident withholding tax amount.
#[serde(default)]
pub non_resident_withholding_tax: Option<Float>,
/// The payout tax credit amount. Always returned in the portfolio currency.
#[serde(default)]
pub tax_credit: Option<Float>,
/// Payout currency code, using 3-letter ISO 4217 code.
pub currency: Currency,
/// The payout's exchange rate.
pub exchange_rate: Float,
/// If `true`, payout is non taxable.
pub non_taxable: bool,
/// Any comments for that payout.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub comments: String,
/// ID of the company event the given payout is based on (nil if not based on any).
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub company_event_id: Option<i64>,
/// The state of the payout, can be any of `"confirmed"`, `"unconfirmed"` or `"rejected"`.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
}
/// Creates a new payout for this portfolio.
pub struct PayoutCreate;
impl<'a> ApiEndpoint<'a> for PayoutCreate {
const URL_PATH: &'static str = "/payouts";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Post;
type UrlDisplay = &'static str;
type Parameters = PayoutCreateParameters;
type Success = PayoutCreateSuccess;
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/payouts"
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct PayoutCreateParameters {
pub payout: PayoutCreatePayoutParameters,
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct PayoutCreatePayoutParameters {
/// Portfolio ID to create the payout for. This needs to be specified together with market and symbol, unless you specify a holding_id (for an existing Holding).
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub portfolio_id: Option<i64>,
/// Holding ID to create the trade for. If you include this, you do not need to specify portfolio_id, market and symbol parameters.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub holding_id: Option<i64>,
/// Payout company/instrument symbol on the market. This is not mandatory if holding_id for an existing Holding is specified.
#[serde(default)]
pub symbol: Option<String>,
/// Market code (like `"NZX"` or `"ASX"`). This is not mandatory if holding_id for an existing Holding is specified.
#[serde(default)]
pub market: Option<Market>,
/// The date of the payout (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub paid_on: NaiveDate,
/// Payout amount.
pub amount: Float,
/// Code for the payout currency_code, using 3-letter ISO 4217 code.
pub currency_code: Currency,
/// The ex date for the payout (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub goes_ex_on: Option<NaiveDate>,
/// Resident withholding tax for the payout.
#[serde(default)]
pub resident_withholding_tax: Option<Float>,
/// Non-resident withholding tax for the payout
#[serde(default)]
pub non_resident_withholding_tax: Option<Float>,
/// Tax credit for the payout.
#[serde(default)]
pub tax_credit: Option<Float>,
/// Exchange rate for other currency payout.
#[serde(default)]
pub exchange_rate: Option<Float>,
/// The ID of any adjustment.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub adjustment_id: Option<i64>,
/// Any comments to be saved on the payout.
#[serde(default)]
pub comments: Option<String>,
/// `true` if this payout is non-taxable.
#[serde(default)]
pub non_taxable: Option<bool>,
/// Date of the source payment
#[serde(default)]
pub source_payment_date: Option<String>,
/// If `true`, sync this payout to xero
#[serde(default)]
pub send_to_xero: Option<bool>,
/// Banked amount for this payout.
#[serde(default)]
pub banked_amount: Option<Float>,
/// Parameters when the payout is reinvested.
#[serde(default)]
pub drp_trade_attributes: Option<PayoutCreatePayoutDrpTradeAttributesParameters>,
/// Franked amount in the payout. (Australia only)
#[serde(default)]
pub franked_amount: Option<Float>,
/// Unfranked amount in the payout (Australia only)
#[serde(default)]
pub unfranked_amount: Option<Float>,
/// `true` if this payout is for a trust. (Australia only)
#[serde(default)]
pub trust: Option<bool>,
/// Extra interest amount in this payout. (Australia only)
#[serde(default)]
pub extra_interest_payment_amount: Option<Float>,
/// Capital gain amount in this payout. (Australia only)
#[serde(default)]
pub capital_gains: Option<Float>,
/// Discounted capital gain amount in this payout. (Australia only)
#[serde(default)]
pub discounted_capital_gains: Option<Float>,
/// Amount of foreign income in this payout. (Australia only)
#[serde(default)]
pub foreign_source_income: Option<Float>,
/// The amount of an LIC dividend that is attributable to an LIC capital gain. (Australia only)
#[serde(default)]
pub lic_capital_gain: Option<Float>,
/// `true` if this payout is not assessed for tax. (Australia only)
#[serde(default)]
pub non_assessable: Option<bool>,
/// Value of deferred income in this payout. (Australia only)
#[serde(default)]
pub deferred_income: Option<Float>,
/// Value of CGT concession in this payout. (Australia only)
#[serde(default)]
pub cgt_concession_amount: Option<Float>,
/// Relevant for attribution managed investment trusts (AMIT) when the taxable income attributed to you is less than the cash distribution you received. This amount is non-assessable and is used to decrease your cost base for cgt purposes (Australia only)
#[serde(default)]
pub amit_decrease_amount: Option<Float>,
/// Relevant for attribution managed investment trusts (AMIT) when the taxable income attributed to you is more than the cash distribution you received. This amount is non-assessable and is used to increase your cost base for cgt purposes (Australia only)
#[serde(default)]
pub amit_increase_amount: Option<Float>,
/// File name for the attachment. This parameter is required if attachment is set.
#[serde(default)]
pub file_name: Option<String>,
/// Base64 encoded attachment file to save against the payout.
#[serde(default)]
pub file_attachment: Option<String>,
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct PayoutCreatePayoutDrpTradeAttributesParameters {
/// `true` for a reinvested payout.
#[serde(default)]
pub dividend_reinvested: Option<bool>,
/// How many units are reinvested.
#[serde(default)]
pub quantity: Option<Float>,
/// Price per reinvested unit.
#[serde(default)]
pub price: Option<Float>,
/// ID of any source adjustment for the reinvested amount.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub source_adjustment_id: Option<i64>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PayoutCreateSuccess {
/// The new payout
pub payout: PayoutCreatePayoutSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PayoutCreatePayoutSuccess {
/// The payout ID.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub id: Option<i64>,
/// The portfolio ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// The holding ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// The instrument ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub instrument_id: i64,
/// Payout company/instrument symbol on the market.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// Market code.
pub market: Market,
/// The payout date (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub paid_on: NaiveDate,
/// The payout ex date (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub ex_date: Option<NaiveDate>,
/// The payout amount.
pub amount: Float,
/// The calculated gross amount
pub gross_amount: Float,
/// The payout resident withholding tax amount. Always returned in the portfolio currency.
#[serde(default)]
pub resident_withholding_tax: Option<Float>,
/// The payout non-resident withholding tax amount.
#[serde(default)]
pub non_resident_withholding_tax: Option<Float>,
/// The payout tax credit amount. Always returned in the portfolio currency.
#[serde(default)]
pub tax_credit: Option<Float>,
/// Currency code of the payout, using 3-letter ISO 4217 code.
pub currency: Currency,
/// The payout's exchange rate.
pub exchange_rate: Float,
/// If true, payout is non taxable.
pub non_taxable: bool,
/// Any comments for that payout.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub comments: String,
/// Other net foreign source income.
#[serde(default)]
pub other_net_fsi: Option<Float>,
/// ID of the company event the given payout is based on (nil if not based on any).
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub company_event_id: Option<i64>,
/// The state of the payout, can be any of `"confirmed"`, `"unconfirmed"` or `"rejected"`.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
/// Parameters when the payout is reinvested.
#[serde(default)]
pub drp_trade_attributes: Option<PayoutCreatePayoutDrpTradeAttributesSuccess>,
/// Franked amount in the payout. (Australia only)
#[serde(default)]
pub franked_amount: Option<Float>,
/// Unfranked amount in the payout (Australia only)
#[serde(default)]
pub unfranked_amount: Option<Float>,
/// `true` if this payout is for a trust. (Australia only)
#[serde(default)]
pub trust: Option<bool>,
/// Extra interest amount in this payout. (Australia only)
#[serde(default)]
pub extra_interest_payment_amount: Option<Float>,
/// Capital gain amount in this payout. (Australia only)
#[serde(default)]
pub capital_gains: Option<Float>,
/// Discounted capital gain amount in this payout. (Australia only)
#[serde(default)]
pub discounted_capital_gains: Option<Float>,
/// Interest payment amount in this payout. (Australia only)
#[serde(default)]
pub interest_payment: Option<Float>,
/// Amount of foreign income in this payout. (Australia only)
#[serde(default)]
pub foreign_source_income: Option<Float>,
/// Value of deferred income in this payout. (Australia only)
#[serde(default)]
pub deferred_income: Option<Float>,
/// True if this payout is not assessed for tax. (Australia only)
#[serde(default)]
pub non_assessable: Option<bool>,
/// Relevant for attribution managed investment trusts (AMIT) when the taxable income attributed to you is less than the cash distribution you received. This amount is non-assessable and is used to decrease your cost base for cgt purposes (Australia only)
#[serde(default)]
pub amit_decrease_amount: Option<Float>,
/// Relevant for attribution managed investment trusts (AMIT) when the taxable income attributed to you is more than the cash distribution you received. This amount is non-assessable and is used to increase your cost base for cgt purposes (Australia only)
#[serde(default)]
pub amit_increase_amount: Option<Float>,
/// Filename of payout attachment, if present.
#[serde(default)]
pub attachment_filename: Option<String>,
/// Id of payout attachment, if present. Use the attachments endpoint to get a copy of the file.
#[serde(default)]
pub attachment_id: Option<String>,
/// List of links for this payout
pub links: PayoutCreatePayoutLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PayoutCreatePayoutDrpTradeAttributesSuccess {
/// True for a reinvested payout.
pub dividend_reinvested: bool,
/// How many units are reinvested.
pub quantity: Float,
/// Price per reinvested unit.
pub price: Float,
/// ID of any source adjustment for the reinvested amount.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub source_adjustment_id: Option<i64>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PayoutCreatePayoutLinksSuccess {
/// Url of the portfolio of this payout
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
}
/// Deletes a confirmed payout, leaving an unconfirmed payout derived from the linked corporate action. (This is similar to the 'Reset this payout') button in the UI). See Reject Payout in order to hide the corporate action altogether.
pub struct PayoutDelete;
impl<'a> ApiEndpoint<'a> for PayoutDelete {
const URL_PATH: &'static str = "/payouts/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Delete;
type UrlDisplay = PayoutDeleteUrlDisplay<'a>;
type Parameters = PayoutDeleteParameters;
type Success = PayoutDeleteSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
PayoutDeleteUrlDisplay(parameters)
}
}
pub struct PayoutDeleteUrlDisplay<'a>(&'a PayoutDeleteParameters);
impl<'a> fmt::Display for PayoutDeleteUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/payouts/{}.json", parameters.id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct PayoutDeleteParameters {
/// The ID of the payout to be deleted.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PayoutDeleteSuccess {
/// The payout has been deleted.
pub deleted: bool,
}
/// Rejects an unconfirmed payout (based on a corporate action event). A payout derived from the linked corporate action will no longer appear in the users portfolio. (This is similar to the 'Reject this Payout' button in the UI). See Delete Payout in order to delete a confirmed payout.
pub struct PayoutReject;
impl<'a> ApiEndpoint<'a> for PayoutReject {
const URL_PATH: &'static str = "/payouts.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Post;
type UrlDisplay = &'static str;
type Parameters = PayoutRejectParameters;
type Success = PayoutRejectSuccess;
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/payouts.json"
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct PayoutRejectParameters {
/// The ID of the holding.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// ID used to identify the company event the unconfirmed payout is based on.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub company_event_id: i64,
/// The new state of the payout: `"rejected"`.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PayoutRejectSuccess {
/// The rejected payout.
pub payout: PayoutRejectPayoutSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PayoutRejectPayoutSuccess {
/// The payout ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The portfolio ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// The holding ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// The instrument ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub instrument_id: i64,
/// Payout company/instrument symbol on the market.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// Market code.
pub market: Market,
/// The payout date (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub paid_on: NaiveDate,
/// The payout ex date (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub ex_date: Option<NaiveDate>,
/// The payout amount.
pub amount: Float,
/// The calculated gross amount
pub gross_amount: Float,
/// The payout resident withholding tax amount. Always returned in the portfolio currency.
#[serde(default)]
pub resident_withholding_tax: Option<Float>,
/// The payout non-resident withholding tax amount.
#[serde(default)]
pub non_resident_withholding_tax: Option<Float>,
/// The payout tax credit amount. Always returned in the portfolio currency.
#[serde(default)]
pub tax_credit: Option<Float>,
/// Payout currency code, using 3-letter ISO 4217 code.
pub currency: Currency,
/// The payout's exchange rate.
pub exchange_rate: Float,
/// If `true`, payout is non taxable.
pub non_taxable: bool,
/// Any comments for that payout.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub comments: String,
/// ID of the company event the given payout is based on (nil if not based on any).
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub company_event_id: Option<i64>,
/// The state of the payout, can be any of "confirmed", "unconfirmed" or "rejected".
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
}
/// Returns a specific payout.
pub struct PayoutShow;
impl<'a> ApiEndpoint<'a> for PayoutShow {
const URL_PATH: &'static str = "/payouts/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = PayoutShowUrlDisplay<'a>;
type Parameters = PayoutShowParameters;
type Success = PayoutShowSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
PayoutShowUrlDisplay(parameters)
}
}
pub struct PayoutShowUrlDisplay<'a>(&'a PayoutShowParameters);
impl<'a> fmt::Display for PayoutShowUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/payouts/{}.json", parameters.id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct PayoutShowParameters {
/// The payout ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PayoutShowSuccess {
/// The payout ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The portfolio ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// The holding ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// The instrument ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub instrument_id: i64,
/// Payout company/instrument symbol on the market.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// Market code.
pub market: Market,
/// The payout date (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub paid_on: NaiveDate,
/// The payout ex date (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub ex_date: Option<NaiveDate>,
/// The payout amount.
pub amount: Float,
/// The calculated gross amount
pub gross_amount: Float,
/// The payout resident withholding tax amount. Always returned in the portfolio currency.
#[serde(default)]
pub resident_withholding_tax: Option<Float>,
/// The payout non-resident withholding tax amount.
#[serde(default)]
pub non_resident_withholding_tax: Option<Float>,
/// The payout tax credit amount. Always returned in the portfolio currency.
#[serde(default)]
pub tax_credit: Option<Float>,
/// Payout currency code, using 3-letter ISO 4217 code.
pub currency: Currency,
/// The payout's exchange rate.
pub exchange_rate: Float,
/// If `true`, payout is non taxable.
pub non_taxable: bool,
/// Any comments for that payout.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub comments: String,
/// Other net foreign source income.
#[serde(default)]
pub other_net_fsi: Option<Float>,
/// The amount of an LIC dividend that is attributable to an LIC capital gain.
pub lic_capital_gain: Float,
/// ID of the company event the given payout is based on (nil if not based on any).
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub company_event_id: Option<i64>,
/// The state of the payout, can be any of "confirmed", "unconfirmed" or "rejected".
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
/// Parameters when the payout is reinvested.
#[serde(default)]
pub drp_trade_attributes: Option<PayoutShowDrpTradeAttributesSuccess>,
/// Franked amount in the payout. (Australia only)
#[serde(default)]
pub franked_amount: Option<Float>,
/// Unfranked amount in the payout (Australia only)
#[serde(default)]
pub unfranked_amount: Option<Float>,
/// `true` if this payout is for a trust. (Australia only)
#[serde(default)]
pub trust: Option<bool>,
/// Extra interest amount in this payout. (Australia only)
#[serde(default)]
pub extra_interest_payment_amount: Option<Float>,
/// Capital gain amount in this payout. (Australia only)
#[serde(default)]
pub capital_gains: Option<Float>,
/// Discounted capital gain amount in this payout. (Australia only)
#[serde(default)]
pub discounted_capital_gains: Option<Float>,
/// Amount of foreign income in this payout. (Australia only)
#[serde(default)]
pub foreign_source_income: Option<Float>,
/// `true` if this payout is not assessed for tax. (Australia only)
#[serde(default)]
pub non_assessable: Option<bool>,
/// Value of deferred income in this payout. (Australia only)
#[serde(default)]
pub deferred_income: Option<Float>,
/// Value of CGT concession in this payout. (Australia only)
#[serde(default)]
pub cgt_concession_amount: Option<Float>,
/// Relevant for attribution managed investment trusts (AMIT) when the taxable income attributed to you is less than the cash distribution you received. This amount is non-assessable and is used to decrease your cost base for cgt purposes (Australia only)
#[serde(default)]
pub amit_decrease_amount: Option<Float>,
/// Relevant for attribution managed investment trusts (AMIT) when the taxable income attributed to you is more than the cash distribution you received. This amount is non-assessable and is used to increase your cost base for cgt purposes (Australia only)
#[serde(default)]
pub amit_increase_amount: Option<Float>,
/// Filename of payout attachment, if present.
#[serde(default)]
pub attachment_filename: Option<String>,
/// Id of payout attachment, if present. Use the attachments endpoint to get a copy of the file.
#[serde(default)]
pub attachment_id: Option<String>,
/// List of links for this payout
pub links: PayoutShowLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PayoutShowDrpTradeAttributesSuccess {
/// `true` for a reinvested payout.
pub dividend_reinvested: bool,
/// How many units are reinvested.
pub quantity: Float,
/// Price per reinvested unit.
pub price: Float,
/// ID of any source adjustment for the reinvested amount.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub source_adjustment_id: Option<i64>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PayoutShowLinksSuccess {
/// Url of this payout
#[serde(rename = "self")]
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub itself: String,
/// Url of the portfolio of this payout
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
}
/// Updates a payout with the provided parameters
pub struct PayoutUpdate;
impl<'a> ApiEndpoint<'a> for PayoutUpdate {
const URL_PATH: &'static str = "/payouts/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Put;
type UrlDisplay = PayoutUpdateUrlDisplay<'a>;
type Parameters = PayoutUpdateParameters;
type Success = PayoutUpdateSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
PayoutUpdateUrlDisplay(parameters)
}
}
pub struct PayoutUpdateUrlDisplay<'a>(&'a PayoutUpdateParameters);
impl<'a> fmt::Display for PayoutUpdateUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/payouts/{}.json", parameters.id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct PayoutUpdateParameters {
/// The ID of the payout to be updated.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The payout
pub payout: PayoutUpdatePayoutParameters,
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct PayoutUpdatePayoutParameters {
/// The date of the payout (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub paid_on: NaiveDate,
/// The ex date for the payout (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub goes_ex_on: Option<NaiveDate>,
/// Resident withholding tax for the payout.
#[serde(default)]
pub resident_withholding_tax: Option<Float>,
/// Non-resident withholding tax for the payout
#[serde(default)]
pub non_resident_withholding_tax: Option<Float>,
/// Tax credit for the payout.
#[serde(default)]
pub tax_credit: Option<Float>,
/// Exchange rate for other currency payout.
#[serde(default)]
pub exchange_rate: Option<Float>,
/// Payout amount. (All except Australia)
#[serde(default)]
pub amount: Option<Float>,
/// The ID of any adjustment.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub adjustment_id: Option<i64>,
/// Any comments to be saved on the payout.
#[serde(default)]
pub comments: Option<String>,
/// `true` if this payout is non-taxable.
#[serde(default)]
pub non_taxable: Option<bool>,
/// Code for the payout currency, using 3-letter ISO 4217 code.
#[serde(default)]
pub currency_code: Option<Currency>,
/// Date of the source payment (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub source_payment_date: Option<NaiveDate>,
/// If `true`, sync this payout to xero
#[serde(default)]
pub send_to_xero: Option<bool>,
/// Banked amount for this payout.
#[serde(default)]
pub banked_amount: Option<Float>,
/// ID of any source adjustment.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub source_adjustment_id: Option<i64>,
/// Parameters when the payout is reinvested.
#[serde(default)]
pub drp_trade_attributes: Option<PayoutUpdatePayoutDrpTradeAttributesParameters>,
/// [Franked amount in the payout] (Australia only)
#[serde(default)]
pub franked_amount: Option<Float>,
/// Unfranked amount in the payout (Australia only)
#[serde(default)]
pub unfranked_amount: Option<Float>,
/// `true` if this payout is for a trust. (Australia only)
#[serde(default)]
pub trust: Option<bool>,
/// Extra interest amount in this payout. (Australia only)
#[serde(default)]
pub extra_interest_payment_amount: Option<Float>,
/// Capital gain amount in this payout. (Australia only)
#[serde(default)]
pub capital_gains: Option<Float>,
/// Discounted capital gain amount in this payout. (Australia only)
#[serde(default)]
pub discounted_capital_gains: Option<Float>,
/// Amount of foreign income in this payout. (Australia only)
#[serde(default)]
pub foreign_source_income: Option<Float>,
/// The amount of an LIC dividend that is attributable to an LIC capital gain. (Australia only)
#[serde(default)]
pub lic_capital_gain: Option<Float>,
/// `true` if this payout is not assessed for tax. (Australia only)
#[serde(default)]
pub non_assessable: Option<bool>,
/// Value of deferred income in this payout. (Australia only)
#[serde(default)]
pub deferred_income: Option<Float>,
/// Value of CGT concession in this payout. (Australia only)
#[serde(default)]
pub cgt_concession_amount: Option<Float>,
/// Relevant for attribution managed investment trusts (AMIT) when the taxable income attributed to you is less than the cash distribution you received. This amount is non-assessable and is used to decrease your cost base for cgt purposes (Australia only)
#[serde(default)]
pub amit_decrease_amount: Option<Float>,
/// Relevant for attribution managed investment trusts (AMIT) when the taxable income attributed to you is more than the cash distribution you received. This amount is non-assessable and is used to increase your cost base for cgt purposes (Australia only)
#[serde(default)]
pub amit_increase_amount: Option<Float>,
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct PayoutUpdatePayoutDrpTradeAttributesParameters {
/// True for a reinvested payout.
#[serde(default)]
pub dividend_reinvested: Option<bool>,
/// How many units are reinvested.
#[serde(default)]
pub quantity: Option<Float>,
/// Price per reinvested unit.
#[serde(default)]
pub price: Option<Float>,
/// ID of any source adjustment for the reinvested amount.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub source_adjustment_id: Option<i64>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PayoutUpdateSuccess {
/// The payout ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// Payout company/instrument symbol on the market.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// Market code.
pub market: Market,
/// The payout date (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub paid_on: NaiveDate,
/// The payout ex date (format `YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub ex_date: Option<NaiveDate>,
/// The payout amount.
pub amount: Float,
/// The calculated gross amount
pub gross_amount: Float,
/// The payout resident withholding tax amount. Always returned in the portfolio currency.
#[serde(default)]
pub resident_withholding_tax: Option<Float>,
/// The payout non-resident withholding tax amount.
#[serde(default)]
pub non_resident_withholding_tax: Option<Float>,
/// The payout tax credit amount. Always returned in the portfolio currency.
#[serde(default)]
pub tax_credit: Option<Float>,
/// Payout currency code, using 3-letter ISO 4217 code.
pub currency: Currency,
/// The payout's exchange rate.
pub exchange_rate: Float,
/// If true, payout is non taxable.
pub non_taxable: bool,
/// Any comments for that payout.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub comments: String,
/// ID of the company event the given payout is based on (nil if not based on any).
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub company_event_id: Option<i64>,
/// The state of the payout, can be any of `"confirmed"`, `"unconfirmed"` or `"rejected"`.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
/// Parameters when the payout is reinvested.
#[serde(default)]
pub drp_trade_attributes: Option<PayoutUpdateDrpTradeAttributesSuccess>,
/// Franked amount in the payout. (Australia only)
#[serde(default)]
pub franked_amount: Option<Float>,
/// Unfranked amount in the payout (Australia only)
#[serde(default)]
pub unfranked_amount: Option<Float>,
/// `true` if this payout is for a trust. (Australia only)
#[serde(default)]
pub trust: Option<bool>,
/// Extra interest amount in this payout. (Australia only)
#[serde(default)]
pub extra_interest_payment_amount: Option<Float>,
/// Capital gain amount in this payout. (Australia only)
#[serde(default)]
pub capital_gains: Option<Float>,
/// Discounted capital gain amount in this payout. (Australia only)
#[serde(default)]
pub discounted_capital_gains: Option<Float>,
/// Amount of foreign income in this payout. (Australia only)
#[serde(default)]
pub foreign_source_income: Option<Float>,
/// `true` if this payout is not assessed for tax. (Australia only)
#[serde(default)]
pub non_assessable: Option<bool>,
/// Value of deferred income in this payout. (Australia only)
#[serde(default)]
pub deferred_income: Option<Float>,
/// Value of CGT concession in this payout. (Australia only)
#[serde(default)]
pub cgt_concession_amount: Option<Float>,
/// Relevant for attribution managed investment trusts (AMIT) when the taxable income attributed to you is less than the cash distribution you received. This amount is non-assessable and is used to decrease your cost base for cgt purposes (Australia only)
#[serde(default)]
pub amit_decrease_amount: Option<Float>,
/// Relevant for attribution managed investment trusts (AMIT) when the taxable income attributed to you is more than the cash distribution you received. This amount is non-assessable and is used to increase your cost base for cgt purposes (Australia only)
#[serde(default)]
pub amit_increase_amount: Option<Float>,
/// Filename of payout attachment, if present.
#[serde(default)]
pub attachment_filename: Option<String>,
/// Id of payout attachment, if present. Use the attachments endpoint to get a copy of the file.
#[serde(default)]
pub attachment_id: Option<String>,
/// List of links for this payout
pub links: PayoutUpdateLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PayoutUpdateDrpTradeAttributesSuccess {
/// `true` for a reinvested payout.
pub dividend_reinvested: bool,
/// How many units are reinvested.
pub quantity: Float,
/// Price per reinvested unit.
pub price: Float,
/// ID of any source adjustment for the reinvested amount.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub source_adjustment_id: Option<i64>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PayoutUpdateLinksSuccess {
/// Url of the portfolio of this payout
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
}
/// Create a new portfolio for the current user.
pub struct PortfolioCreate;
impl<'a> ApiEndpoint<'a> for PortfolioCreate {
const URL_PATH: &'static str = "/portfolios.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Post;
type UrlDisplay = &'static str;
type Parameters = PortfolioCreateParameters;
type Success = ();
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/portfolios.json"
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct PortfolioCreateParameters {
/// The new portfolio's name.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// `true` to enable broker import via Trade Confirmation Emails.
pub broker_email_api_enabled: bool,
/// (deprecated) Financial year end month (`1` for January, ..., `12` for December).
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub financial_year_end_month_id: i64,
/// Financial year end MM-DD.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub financial_year_end: String,
/// Default sale allocation method. See <a href="/api/2/codes#sale_allocation_method">valid methods by country</a>.
pub default_sale_allocation_method: SaleAllocationMethod,
/// Interest method calculation: `"simple"` or `"compound"`.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub interest_method: String,
/// Tax Status (`true`: Trader, `false`: Investor)
pub trader: bool,
/// For Canadian portfolios, the type of tax processing (`"non_registered"`, `"rrsp"` or `"rrif"`)
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub tax_entity_type: String,
/// Disable Automatic Transactions for this portfolio (`true`: disable, `false`: enable)
#[serde(default)]
pub disable_automatic_transactions: Option<bool>,
/// `0`: trust, `1`: smsf, `2`: company
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub cg_discount_id: i64,
/// New Zealand Resident Withholding Tax Rate. As a percentage to 1 decimal place (for example, 33.1% comes as `33.1`).
pub rwtr_rate: Float,
/// ISO code of the portfolio country (see <a href="https://en.wikipedia.org/wiki/ISO_3166-1">ISO 3166-1</a>). Defaults to the portfolio owner's default country.
#[serde(default)]
pub country_code: Option<Country>,
/// `true` in order to calculate accrual adjustments against any portfolio cash accounts to allow for unsettled trades and unpaid dividends
#[serde(default)]
pub apply_cash_account_adjustments: Option<bool>,
/// Specifies the number of working days between the buy trade date and settlement in the cash account
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub buy_trade_settlement_delay: Option<i64>,
/// Specifies the number of working days between the sell trade date and settlement in the cash account
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub sell_trade_settlement_delay: Option<i64>,
/// `true` in order to account for the fact that bank statement data is delayed by a day due to overnight processing
#[serde(default)]
pub account_for_delayed_cash_transactions: Option<bool>,
}
/// Delete an existing user portfolio.
pub struct PortfolioDelete;
impl<'a> ApiEndpoint<'a> for PortfolioDelete {
const URL_PATH: &'static str = "/portfolios/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Delete;
type UrlDisplay = PortfolioDeleteUrlDisplay<'a>;
type Parameters = PortfolioDeleteParameters;
type Success = PortfolioDeleteSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
PortfolioDeleteUrlDisplay(parameters)
}
}
pub struct PortfolioDeleteUrlDisplay<'a>(&'a PortfolioDeleteParameters);
impl<'a> fmt::Display for PortfolioDeleteUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/portfolios/{}.json", parameters.id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct PortfolioDeleteParameters {
/// ID of the portfolio to delete.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PortfolioDeleteSuccess {
/// The portfolio was successfully deleted.
pub status: (),
}
/// Returns list of portfolios for the user.
///
/// If the user owns the portfolio, all the info related to it will be displayed. Otherwise only basic info is returned.
pub struct PortfolioList;
impl<'a> ApiEndpoint<'a> for PortfolioList {
const URL_PATH: &'static str = "/portfolios.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = &'static str;
type Parameters = ();
type Success = PortfolioListSuccess;
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/portfolios.json"
}
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PortfolioListSuccess {
/// List of portfolios.
pub portfolios: Vec<PortfolioListPortfoliosSuccess>,
/// All buys and sells will generate a corresponding deposit/withdrawal in the selected 'trading' account.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub trade_sync_cash_account_id: Option<i64>,
/// List of links for this resource
pub links: PortfolioListLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PortfolioListPortfoliosSuccess {
/// The portfolio ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The portfolio name.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The default sale allocation method for tax reporting.
pub default_sale_allocation_method: SaleAllocationMethod,
/// Discount for Capital Gains Tax.
#[serde(default)]
pub cg_discount: Option<String>,
/// New Zealand Resident Withholding Tax Rate. As a percentage to 1 decimal place (for example, 33.1% comes as `33.1`).
pub rwtr_rate: Float,
/// Tax Status (`true`: Trade, `false`: Investor).
#[serde(default)]
pub trader: Option<bool>,
/// Automatic Transactions are disabled (`true`) or enabled (`false`).
pub disable_automatic_transactions: bool,
/// `true` if the broker import email is enabled.
pub broker_email_api_enabled: bool,
/// Email prefix of the broker import email address.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub broker_email_key: String,
/// (deprecated) Financial Year end month (`1`: Jan, `2`: Feb, etc.).
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub financial_year_end_month_id: i64,
/// Financial Year end date MM-DD.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub financial_year_end: String,
/// Performance Calculation Method
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub interest_method: String,
/// ISO code of the portfolio country (see <a href="https://en.wikipedia.org/wiki/ISO_3166-1">ISO 3166-1</a>)
pub country_code: Country,
/// ISO code of the portfolio currency (see <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO 4217</a>)
pub currency_code: Currency,
/// Portfolio's inception date (first trade record)
#[serde_as(as = "DeserializeDate")]
pub inception_date: NaiveDate,
/// Time zone name
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub tz_name: String,
/// Calculates accrual adjustments against any portfolio cash accounts to allow for unsettled trades and unpaid dividends
pub apply_cash_account_adjustments: bool,
/// Specifies the number of working days between the buy trade date and settlement in the cash account
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub buy_trade_settlement_delay: Option<i64>,
/// Specifies the number of working days between the sell trade date and settlement in the cash account
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub sell_trade_settlement_delay: Option<i64>,
/// Accounts for the fact that bank statement data is delayed by a day due to overnight processing
pub account_for_delayed_cash_transactions: bool,
/// List of links for this portfolio
pub links: PortfolioListPortfoliosLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PortfolioListPortfoliosLinksSuccess {
/// Url of this portfolio
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PortfolioListLinksSuccess {
/// Url to list of portfolios
#[serde(rename = "self")]
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub itself: String,
}
/// Returns a single portfolio with settings for the user.
pub struct PortfolioShow;
impl<'a> ApiEndpoint<'a> for PortfolioShow {
const URL_PATH: &'static str = "/portfolios/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = PortfolioShowUrlDisplay<'a>;
type Parameters = PortfolioShowParameters;
type Success = PortfolioShowSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
PortfolioShowUrlDisplay(parameters)
}
}
pub struct PortfolioShowUrlDisplay<'a>(&'a PortfolioShowParameters);
impl<'a> fmt::Display for PortfolioShowUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/portfolios/{}.json", parameters.id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct PortfolioShowParameters {
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PortfolioShowSuccess {
/// The portfolio ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The portfolio name.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The default sale allocation method for tax reporting.
pub default_sale_allocation_method: SaleAllocationMethod,
/// Discount for Capital Gains Tax.
#[serde(default)]
pub cg_discount: Option<String>,
/// New Zealand Resident Withholding Tax Rate. As a percentage to 1 decimal place (for example, 33.1% comes as `33.1`).
pub rwtr_rate: Float,
/// Tax Status (`true`: Trade, `false`: Investor).
pub trader: bool,
/// Automatic Transactions are disabled (`true`) or enabled (`false`).
pub disable_automatic_transactions: bool,
/// For Canadian portfolios, the type of tax processing (`"non_registered"`, `"rrsp"` or `"rrif"`)
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub tax_entity_type: String,
/// `true` if the broker import email is enabled.
pub broker_email_api_enabled: bool,
/// Email prefix of the broker import email address.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub broker_email_key: String,
/// (deprecated) Financial Year end month (`1`: Jan, `2`: Feb, etc.).
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub financial_year_end_month_id: i64,
/// Financial Year end date MM-DD.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub financial_year_end: String,
/// Performance Calculation Method
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub interest_method: String,
/// ISO code of the portfolio country (see <a href="https://en.wikipedia.org/wiki/ISO_3166-1">ISO 3166-1</a>)
pub country_code: Country,
/// ISO code of the portfolio currency (see <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO 4217</a>)
pub currency_code: Currency,
/// The portfolio's inception date (first trade record)
#[serde_as(as = "DeserializeDate")]
pub inception_date: NaiveDate,
/// Time zone name
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub tz_name: String,
/// Calculates accrual adjustments against any portfolio cash accounts to allow for unsettled trades and unpaid dividends
pub apply_cash_account_adjustments: bool,
/// Specifies the number of working days between the buy trade date and settlement in the cash account
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub buy_trade_settlement_delay: i64,
/// Specifies the number of working days between the sell trade date and settlement in the cash account
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub sell_trade_settlement_delay: i64,
/// Accounts for the fact that bank statement data is delayed by a day due to overnight processing
pub account_for_delayed_cash_transactions: bool,
/// All buys and sells will generate a corresponding deposit/withdrawal in the selected 'trading' account.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub trade_sync_cash_account_id: i64,
/// List of links for this resource
pub links: PortfolioShowLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PortfolioShowLinksSuccess {
/// Url of this portfolio
#[serde(rename = "self")]
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub itself: String,
/// Url of this portfolio (same as self)
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
}
/// Update an existing portfolio for the user.
pub struct PortfolioUpdate;
impl<'a> ApiEndpoint<'a> for PortfolioUpdate {
const URL_PATH: &'static str = "/portfolios/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Put;
type UrlDisplay = PortfolioUpdateUrlDisplay<'a>;
type Parameters = PortfolioUpdateParameters;
type Success = PortfolioUpdateSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
PortfolioUpdateUrlDisplay(parameters)
}
}
pub struct PortfolioUpdateUrlDisplay<'a>(&'a PortfolioUpdateParameters);
impl<'a> fmt::Display for PortfolioUpdateUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/portfolios/{}.json", parameters.id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct PortfolioUpdateParameters {
/// The portfolio ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The portfolio's name.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// `true`to enable broker import via Trade Confirmation Emails.
pub broker_email_api_enabled: bool,
/// (deprecated) Financial year end month (`1` for January, ..., `12` for December).
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub financial_year_end_month_id: i64,
/// Financial year end MM-DD.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub financial_year_end: String,
/// Default sale allocation method. See <a href="/api/2/codes#sale_allocation_method">valid methods by country</a>.
pub default_sale_allocation_method: SaleAllocationMethod,
/// Interest method calculation: `"simple"` or `"compound"`.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub interest_method: String,
/// `true` if trader.
pub trader: bool,
/// For Canadian portfolios, the type of tax processing (`"non_registered"`, `"rrsp"` or `"rrif"`)
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub tax_entity_type: String,
/// `0`: trust, `1`: smsf, `2`: company
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub cg_discount_id: i64,
/// New Zealand Resident Withholding Tax Rate. As a percentage to 1 decimal place (for example, 33.1% comes as `33.1`).
pub rwtr_rate: Float,
/// `true` in order to calculate accrual adjustments against any portfolio cash accounts to allow for unsettled trades and unpaid dividends
#[serde(default)]
pub apply_cash_account_adjustments: Option<bool>,
/// Specifies the number of working days between the buy trade date and settlement in the cash account
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub buy_trade_settlement_delay: Option<i64>,
/// Specifies the number of working days between the sell trade date and settlement in the cash account
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub sell_trade_settlement_delay: Option<i64>,
/// `true` in order to account for the fact that bank statement data is delayed by a day due to overnight processing
#[serde(default)]
pub account_for_delayed_cash_transactions: Option<bool>,
/// All buys and sells will generate a corresponding deposit/withdrawal in the selected 'trading' account. You can only select a trading cash account if it has the same currency as the portfolio currency
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub trade_sync_cash_account_id: i64,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PortfolioUpdateSuccess {
/// The portfolio ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The portfolio name.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The default sale allocation method for tax reporting.
pub default_sale_allocation_method: SaleAllocationMethod,
/// Discount for Capital Gains Tax.
#[serde(default)]
pub cg_discount: Option<String>,
/// New Zealand Resident Withholding Tax Rate. As a percentage to 1 decimal place (for example, 33.1% comes as `33.1`).
pub rwtr_rate: Float,
/// Tax Status (`true`: Trader, `false`: Investor).
pub trader: bool,
/// For Canadian portfolios, the type of tax processing (`"non_registered"`, `"rrsp"` or `"rrif"`)
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub tax_entity_type: String,
/// `true` if the broker import email is enabled.
pub broker_email_api_enabled: bool,
/// Email prefix of the broker import email address.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub broker_email_key: String,
/// (deprecated) Financial Year end month (`1`: Jan, `2`: Feb, etc.).
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub financial_year_end_month_id: i64,
/// Financial Year end date MM-DD.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub financial_year_end: String,
/// Performance Calculation Method
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub interest_method: String,
/// ISO code of the portfolio country (see <a href="https://en.wikipedia.org/wiki/ISO_3166-1">ISO 3166-1</a>)
pub country_code: Country,
/// ISO code of the portfolio currency (see <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO 4217</a>)
pub currency_code: Currency,
/// Calculates accrual adjustments against any portfolio cash accounts to allow for unsettled trades and unpaid dividends
pub apply_cash_account_adjustments: bool,
/// Specifies the number of working days between the buy trade date and settlement in the cash account
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub buy_trade_settlement_delay: i64,
/// Specifies the number of working days between the sell trade date and settlement in the cash account
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub sell_trade_settlement_delay: i64,
/// Accounts for the fact that bank statement data is delayed by a day due to overnight processing
pub account_for_delayed_cash_transactions: bool,
/// All buys and sells will generate a corresponding deposit/withdrawal in the selected 'trading' account.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub trade_sync_cash_account_id: i64,
/// List of links for this resource
pub links: PortfolioUpdateLinksSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PortfolioUpdateLinksSuccess {
/// Url of this portfolio
#[serde(rename = "self")]
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub itself: String,
/// Url of this portfolio (same as self)
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio: String,
}
/// Return a report on capital gains tax (for Australian portfolios only)
pub struct CapitalGains;
impl<'a> ApiEndpoint<'a> for CapitalGains {
const URL_PATH: &'static str = "/portfolios/:portfolio_id/capital_gains.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = CapitalGainsUrlDisplay<'a>;
type Parameters = CapitalGainsParameters;
type Success = CapitalGainsSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
CapitalGainsUrlDisplay(parameters)
}
}
pub struct CapitalGainsUrlDisplay<'a>(&'a CapitalGainsParameters);
impl<'a> fmt::Display for CapitalGainsUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(
f,
"/portfolios/{}/capital_gains.json",
parameters.portfolio_id
)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct CapitalGainsParameters {
/// The id of the (Australian) portfolio to report on
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// inception date] Show report from this date on (`YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub start_date: Option<NaiveDate>,
/// Show report until this date (`YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub end_date: Option<NaiveDate>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CapitalGainsSuccess {
/// The total of short term gains (less than one year, rounded to 2 decimal places).
pub short_term_gains: Float,
/// The total of long term gains (over one year, rounded to 2 decimal places).
pub long_term_gains: Float,
/// The total of losses (rounded to 2 decimal places).
pub losses: Float,
/// The total of short term capital losses available to be offset (rounded to 2 decimal places).
pub short_term_losses: Float,
/// The total of capital losses available to be offset after deducting short term losses (rounded to 2 decimal places).
pub long_term_losses: Float,
/// The total of discounted capital gain distributions (grossed up, rounded to 2 decimal places).
pub total_discounted_capital_gain_distributions: Float,
/// The total of non discounted capital gain distributions (rounded to 2 decimal places).
pub total_non_discounted_capital_gain_distributions: Float,
/// The rate of CGT concession on long term gains applied (rounded to 2 decimal places).
pub cgt_concession_rate: Float,
/// The amount of the CGT concession applied (rounded to 2 decimal places).
pub cgt_concession_amount: Float,
/// The market value of the portfolio (rounded to 2 decimal places).
pub market_value: Float,
/// The gain (or loss, if negative, rounded to 2 decimal places).
pub tax_gain_loss: Float,
/// Discounted capital gain distributions
pub discounted_capital_gain_distributions:
Vec<CapitalGainsDiscountedCapitalGainDistributionsSuccess>,
/// Non-discounted capital gain distributions
pub non_discounted_capital_gain_distributions:
Vec<CapitalGainsNonDiscountedCapitalGainDistributionsSuccess>,
/// Stock parcels (separated by date) held for less than one year and subject to tax without concession
pub short_term_parcels: Vec<CapitalGainsShortTermParcelsSuccess>,
/// Stock parcels (separated by date) held for over a year and eligible for tax concession
pub long_term_parcels: Vec<CapitalGainsLongTermParcelsSuccess>,
/// Holdings showing a loss (which will be expressed as a negative value)
pub loss_parcels: Vec<CapitalGainsLossParcelsSuccess>,
/// The start date gains are calculated from (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub start_date: NaiveDate,
/// The end date gains are calculated to (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub end_date: NaiveDate,
/// The portfolio id, as requested
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CapitalGainsDiscountedCapitalGainDistributionsSuccess {
/// The market symbol
pub market: Market,
/// The instrument symbol
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// The name of the instrument
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The capital gain (negative for losses, rounded to 2 decimal places).
pub gain: Float,
/// The date the gain is calculated for (format `YYYY-MM-DD`)
#[serde_as(as = "DeserializeDate")]
pub gain_date: NaiveDate,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CapitalGainsNonDiscountedCapitalGainDistributionsSuccess {
/// The market symbol
pub market: Market,
/// The instrument symbol
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// The name of the instrument
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The capital gain (negative for losses, rounded to 2 decimal places).
pub gain: Float,
/// The date the gain is calculated for (format `YYYY-MM-DD`)
#[serde_as(as = "DeserializeDate")]
pub gain_date: NaiveDate,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CapitalGainsShortTermParcelsSuccess {
/// The market symbol
pub market: Market,
/// The instrument symbol
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// The name of the instrument
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The allocation method used: see <a href="/api/2/codes#sale_allocation_method">valid methods by country</a>
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub allocation_method: String,
/// The purchase date for this parcel (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub purchase_date: NaiveDate,
/// The quantity of stock held
pub quantity: Float,
/// The adjusted total cost of the parcel (rounded to 2 decimal places).
pub cost_base: Float,
/// The market value of the parcel at the balance date (rounded to 2 decimal places).
pub market_value: Float,
/// The capital gain (negative for losses, rounded to 2 decimal places).
pub gain: Float,
/// The date the gain is calculated for (format `YYYY-MM-DD`)
#[serde_as(as = "DeserializeDate")]
pub gain_date: NaiveDate,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CapitalGainsLongTermParcelsSuccess {
/// The market symbol
pub market: Market,
/// The instrument symbol
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// The name of the instrument
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The allocation method used: see <a href="/api/2/codes#sale_allocation_method">valid methods by country</a>
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub allocation_method: String,
/// The purchase date for this parcel (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub purchase_date: NaiveDate,
/// The quantity of stock held
pub quantity: Float,
/// The adjusted total cost of the parcel (rounded to 2 decimal places).
pub cost_base: Float,
/// The market value of the parcel at the balance date (rounded to 2 decimal places).
pub market_value: Float,
/// The capital gain (negative for losses, rounded to 2 decimal places).
pub gain: Float,
/// The date the gain is calculated for (format `YYYY-MM-DD`)
#[serde_as(as = "DeserializeDate")]
pub gain_date: NaiveDate,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct CapitalGainsLossParcelsSuccess {
/// The market symbol
pub market: Market,
/// The instrument symbol
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// The name of the instrument
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The allocation method used: see <a href="/api/2/codes#sale_allocation_method">valid methods by country</a>
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub allocation_method: String,
/// The purchase date for this parcel (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub purchase_date: NaiveDate,
/// The quantity of stock held
pub quantity: Float,
/// The adjusted total cost of the parcel (rounded to 2 decimal places).
pub cost_base: Float,
/// The market value of the parcel at the balance date (rounded to 2 decimal places).
pub market_value: Float,
/// The capital gain (negative for losses, rounded to 2 decimal places).
pub gain: Float,
/// The date the gain is calculated for (format `YYYY-MM-DD`)
#[serde_as(as = "DeserializeDate")]
pub gain_date: NaiveDate,
}
/// Retrieves the Diversity Report for the underlying portfolio
pub struct Diversity;
impl<'a> ApiEndpoint<'a> for Diversity {
const URL_PATH: &'static str = "/portfolios/:portfolio_id/diversity.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = DiversityUrlDisplay<'a>;
type Parameters = DiversityParameters;
type Success = DiversitySuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
DiversityUrlDisplay(parameters)
}
}
pub struct DiversityUrlDisplay<'a>(&'a DiversityParameters);
impl<'a> fmt::Display for DiversityUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/portfolios/{}/diversity.json", parameters.portfolio_id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct DiversityParameters {
/// The portfolio ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// true if a consolidated view is requested.
#[serde(default)]
pub consolidated: Option<bool>,
/// Show report from this date on (`YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub date: Option<NaiveDate>,
/// One of: market(s), industry_classification(s), sector_classification(s), investment_type(s), countries/country, portfolio, ungrouped or custom_group.
#[serde(default)]
pub grouping: Option<String>,
/// If present, the custom group id to group by, as an integer id returned from the CustomGroupsList endpoint. When this is used, the 'grouping' parameter must be set to 'custom_group'.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub custom_group_id: Option<i64>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct DiversitySuccess {
/// Each group in the report, keyed by the group name
pub groups: Vec<DiversityGroupsSuccess>,
/// The total percentage across the portfolio (always 100%)
pub percentage: Float,
/// The total value of the portfolio (rounded to 2 decimal places).
pub value: Float,
/// The date this report was generated for (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub date: NaiveDate,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct DiversityGroupsSuccess {
/// The group's contents
pub group: DiversityGroupsGroupSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct DiversityGroupsGroupSuccess {
/// A holding or cash account
pub elements: Vec<DiversityGroupsGroupElementsSuccess>,
/// The percentage of the portfolio in this group (rounded to 2 decimal places). For example, 33% comes as `33.0`.
pub percentage: Float,
/// The value of the portfolio components in this group (rounded to 2 decimal places).
pub value: Float,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct DiversityGroupsGroupElementsSuccess {
/// The name of this element
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// If a holding, the instrument symbol of this element
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub code: String,
/// If a holding, the market code of this element
pub market: Market,
/// The percentage of the portfolio this element represents (rounded to 2 decimal places). For example, 33% comes as `33.0`.
pub percentage: Float,
/// The value of the holding or cash account (rounded to 2 decimal places).
pub value: Float,
}
/// Retrieves the Performance Report for the underlying portfolio.
///
/// ## Holding Limit
///
/// Depending on user's plan the number of holdings shown in the report is limited. In that case the following response headers will be set: <ul> <li>`X-HoldingLimit-Limit`: The plan's holding limit.</li> <li>`X-HoldingLimit-Total`: The number of holding in the requested portfolio.</li> <li>`X-HoldingLimit-Reason`: A human-readable string describing why the number of holdings is limited.</li> </ul>
///
/// ## Remarks
///
/// <sup>1</sup> Infinity is represented by string values "Infinity" or "-Infinity"
pub struct Performance;
impl<'a> ApiEndpoint<'a> for Performance {
const URL_PATH: &'static str = "/portfolios/:portfolio_id/performance.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = PerformanceUrlDisplay<'a>;
type Parameters = PerformanceParameters;
type Success = PerformanceSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
PerformanceUrlDisplay(parameters)
}
}
pub struct PerformanceUrlDisplay<'a>(&'a PerformanceParameters);
impl<'a> fmt::Display for PerformanceUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(
f,
"/portfolios/{}/performance.json",
parameters.portfolio_id
)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct PerformanceParameters {
/// inception date] Show report from this date on (YYYY-MM-DD).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub start_date: Option<NaiveDate>,
/// Show report until this date (YYYY-MM-DD).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub end_date: Option<NaiveDate>,
/// The Portfolio id
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// true if a consolidated view is requested.
#[serde(default)]
pub consolidated: Option<bool>,
/// true: include sales, false: do not include sales.
#[serde(default)]
pub include_sales: Option<bool>,
/// One of: market(s), industry_classification(s), sector_classification(s), investment_type(s), countries/country, portfolio, ungrouped, or custom_group.
#[serde(default)]
pub grouping: Option<String>,
/// If present, the custom group id to group by, as an integer id returned from the CustomGroupsList endpoint. When this is used, the 'grouping' parameter must be set to 'custom_group'.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub custom_group_id: Option<i64>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PerformanceSuccess {
/// A unique id identifying this report instance
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub id: String,
/// The portfolio id
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio_id: String,
/// Grouping id or name
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub grouping: String,
/// The id of the custom group, if any, otherwise nil if a built-in group was selected
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub custom_group_id: String,
/// The total value of the portfolio
pub value: Float,
/// Capital Gain<sup>1</sup> (rounded to 2 decimal places).
pub capital_gain: Float,
/// Capital Gain (percentage, rounded to 2 decimal places, 33% as `33.0`)<sup>1</sup>
pub capital_gain_percent: Float,
/// Payout Gain<sup>1</sup> (rounded to 2 decimal places).
pub payout_gain: Float,
/// Payout Gain (percentage, rounded to 2 decimal places, 33% as `33.0`)<sup>1</sup>
pub payout_gain_percent: Float,
/// Currency Gain<sup>1</sup> (rounded to 2 decimal places).
pub currency_gain: Float,
/// Currency Gain (percentage, rounded to 2 decimal places, 33% as `33.0`)<sup>1</sup>
pub currency_gain_percent: Float,
/// Total Gain<sup>1</sup> (rounded to 2 decimal places).
pub total_gain: Float,
/// Total Gain (percentage, rounded to 2 decimal places, 33% as ``33.0``)<sup>1</sup>
pub total_gain_percent: Float,
/// Start date (format `YYYY-MM-DD`)
#[serde_as(as = "DeserializeDate")]
pub start_date: NaiveDate,
/// End date (format `YYYY-MM-DD`)
#[serde_as(as = "DeserializeDate")]
pub end_date: NaiveDate,
/// Include sales (format `YYYY-MM-DD`)
#[serde_as(as = "DeserializeDate")]
pub include_sales: NaiveDate,
/// List of holdings.
pub holdings: Vec<PerformanceHoldingsSuccess>,
/// List of cash accounts. This includes Unsettled Trades and Unpaid Payout Adjustments.
pub cash_accounts: Vec<PerformanceCashAccountsSuccess>,
/// List of sub-totals for each group.
pub sub_totals: Vec<PerformanceSubTotalsSuccess>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PerformanceHoldingsSuccess {
/// The id of this holding
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub id: String,
/// The Sharesight symbol for the held instrument
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// A unique id identifying the instrument
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub instrument_id: String,
/// The code for the market the held instrument is listed on
pub market: Market,
/// The group value this instrument has been placed in - note that the field name will be the group type
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub _group_type_: String,
/// The name of the selected grouping for the report
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub grouping: String,
/// The name of the instrument
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The current value of the holding.
pub value: Float,
/// The quantity of shares or other instruments in the holding
pub quantity: Float,
/// Capital Gain<sup>1</sup> on the holding (rounded to 2 decimal places).
pub capital_gain: Float,
/// Capital Gain (percentage, rounded to 2 decimal places, 33% as `33.0`)<sup>1</sup> on the holding
pub capital_gain_percent: Float,
/// Payout Gain<sup>1</sup> on the holding (rounded to 2 decimal places).
pub payout_gain: Float,
/// Payout Gain (percentage, rounded to 2 decimal places, 33% as `33.0`)<sup>1</sup> on the holding
pub payout_gain_percent: Float,
/// Currency Gain<sup>1</sup> on the holding (rounded to 2 decimal places).
pub currency_gain: Float,
/// Currency Gain (percentage, rounded to 2 decimal places, 33% as `33.0`)<sup>1</sup> on the holding
pub currency_gain_percent: Float,
/// Total Gain<sup>1</sup> on the holding (rounded to 2 decimal places).
pub total_gain: Float,
/// Total Gain (percentage, rounded to 2 decimal places, 33% as `33.0`)<sup>1</sup> on the holding
pub total_gain_percent: Float,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PerformanceCashAccountsSuccess {
/// A unique key for each cash account
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub id: String,
/// The id of the cash account, null for adjustments
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub cash_account_id: String,
/// The name of the cash account
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The value of the cash account
pub value: Float,
/// The currency symbol (e.g. AU$) of the cash account
pub currency: Currency,
/// The ISO currency code (e.g. AUD) of the portfolio
pub currency_code: Currency,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct PerformanceSubTotalsSuccess {
/// The group value - note that the field name will be the group type
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub _group_type_: String,
/// The total value of the holdings in this group
pub value: Float,
/// Capital Gain<sup>1</sup> on the holdings in this group (rounded to 2 decimal places).
pub capital_gain: Float,
/// Capital Gain (percentage, rounded to 2 decimal places, 33% as `33.0`)<sup>1</sup>
pub capital_gain_percent: Float,
/// Payout Gain<sup>1</sup> on the holdings in this group (rounded to 2 decimal places).
pub payout_gain: Float,
/// Payout Gain (percentage, rounded to 2 decimal places, 33% as `33.0`)<sup>1</sup> on the holdings in this group
pub payout_gain_percent: Float,
/// Currency Gain<sup>1</sup> on the holdings in this group (rounded to 2 decimal places).
pub currency_gain: Float,
/// Currency Gain (percentage, rounded to 2 decimal places, 33% as `33.0`)<sup>1</sup> on the holdings in this group
pub currency_gain_percent: Float,
/// Total Gain<sup>1</sup> on the holdings in this group (rounded to 2 decimal places).
pub total_gain: Float,
/// Total Gain (percentage, rounded to 2 decimal places, 33% as `33.0`)<sup>1</sup> on the holdings in this group
pub total_gain_percent: Float,
}
/// Return a report on unrealised capital gains tax (for Australian portfolios only)
pub struct UnrealisedCgt;
impl<'a> ApiEndpoint<'a> for UnrealisedCgt {
const URL_PATH: &'static str = "/portfolios/:portfolio_id/unrealised_cgt.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = UnrealisedCgtUrlDisplay<'a>;
type Parameters = UnrealisedCgtParameters;
type Success = UnrealisedCgtSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
UnrealisedCgtUrlDisplay(parameters)
}
}
pub struct UnrealisedCgtUrlDisplay<'a>(&'a UnrealisedCgtParameters);
impl<'a> fmt::Display for UnrealisedCgtUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(
f,
"/portfolios/{}/unrealised_cgt.json",
parameters.portfolio_id
)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct UnrealisedCgtParameters {
/// The id of the (Australian) portfolio to report on
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// The reference date to price the holdings on (format `YYYY-MM-DD`)
#[serde_as(as = "DeserializeDate")]
pub balance_date: NaiveDate,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct UnrealisedCgtSuccess {
/// The total of unrealized short term gains (less than one year, rounded to 2 decimal places).
pub unrealised_short_term_gains: Float,
/// The total of unrealized long term gains (over one year, rounded to 2 decimal places).
pub unrealised_long_term_gains: Float,
/// The total of unrealised lossses (rounded to 2 decimal places).
pub unrealised_losses: Float,
/// The rate of CGT concession on long term gains applied (rounded to 2 decimal places).
pub cgt_concession_rate: Float,
/// The amount of the CGT concession applied (rounded to 2 decimal places).
pub unrealised_cgt_concession_amount: Float,
/// The market value of the portfolio (rounded to 2 decimal places).
pub market_value: Float,
/// The unrealised gain (or loss, if negative, rounded to 2 decimal places).
pub unrealised_tax_gain_loss: Float,
/// Stock parcels (separated by date) held for less than one year and subject to tax without concession
pub short_term_parcels: Vec<UnrealisedCgtShortTermParcelsSuccess>,
/// Stock parcels (separated by date) held for over a year and eligible for tax concession
pub long_term_parcels: Vec<UnrealisedCgtLongTermParcelsSuccess>,
/// Holdings showing a loss (which will be expressed as a negative value)
pub losses: Vec<UnrealisedCgtLossesSuccess>,
/// The balance date capital gains are calculated for, as requested (format `YYYY-MM-DD`)
#[serde_as(as = "DeserializeDate")]
pub balance_date: NaiveDate,
/// The portfolio id, as requested
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct UnrealisedCgtShortTermParcelsSuccess {
/// The market symbol
pub market: Market,
/// The instrument symbol
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// The name of the instrument
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The allocation method used: see <a href="/api/2/codes#sale_allocation_method">valid methods by country</a>
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub allocation_method: String,
/// The purchase date for this parcel (format `YYYY-MM-DD`)
#[serde_as(as = "DeserializeDate")]
pub purchase_date: NaiveDate,
/// The quantity of stock held
pub quantity: Float,
/// The adjusted total cost of the parcel (rounded to 2 decimal places).
pub cost_base: Float,
/// The market value of the parcel at the balance date (rounded to 2 decimal places).
pub market_value: Float,
/// The unrealised capital gain (negative for losses, rounded to 2 decimal places).
pub unrealised_gain: Float,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct UnrealisedCgtLongTermParcelsSuccess {
/// The market symbol
pub market: Market,
/// The instrument symbol
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// The name of the instrument
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The allocation method used: see <a href="/api/2/codes#sale_allocation_method">valid methods by country</a>
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub allocation_method: String,
/// The purchase date for this parcel (format `YYYY-MM-DD`)
#[serde_as(as = "DeserializeDate")]
pub purchase_date: NaiveDate,
/// The quantity of stock held
pub quantity: Float,
/// The adjusted total cost of the parcel (rounded to 2 decimal places).
pub cost_base: Float,
/// The market value of the parcel at the balance date (rounded to 2 decimal places).
pub market_value: Float,
/// The unrealised capital gain (negative for losses, rounded to 2 decimal places).
pub unrealised_gain: Float,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct UnrealisedCgtLossesSuccess {
/// The market symbol
pub market: Market,
/// The instrument symbol
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// The name of the instrument
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The allocation method used: see <a href="/api/2/codes#sale_allocation_method">valid methods by country</a>
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub allocation_method: String,
/// The purchase date for this parcel (format `YYYY-MM-DD`)
#[serde_as(as = "DeserializeDate")]
pub purchase_date: NaiveDate,
/// The quantity of stock held
pub quantity: Float,
/// The adjusted total cost of the parcel (rounded to 2 decimal places).
pub cost_base: Float,
/// The market value of the parcel at the balance date (rounded to 2 decimal places).
pub market_value: Float,
/// The unrealised capital gain (negative for losses, rounded to 2 decimal places).
pub unrealised_gain: Float,
}
/// Retrieves the Valuation Report for the underlying portfolio.
pub struct Valuation;
impl<'a> ApiEndpoint<'a> for Valuation {
const URL_PATH: &'static str = "/portfolios/:portfolio_id/valuation.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = ValuationUrlDisplay<'a>;
type Parameters = ValuationParameters;
type Success = ValuationSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
ValuationUrlDisplay(parameters)
}
}
pub struct ValuationUrlDisplay<'a>(&'a ValuationParameters);
impl<'a> fmt::Display for ValuationUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/portfolios/{}/valuation.json", parameters.portfolio_id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct ValuationParameters {
/// Show report as of this date (`YYYY-MM-DD`).
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub balance_date: Option<NaiveDate>,
/// The Portfolio id
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// true if a consolidated view is requested.
#[serde(default)]
pub consolidated: Option<bool>,
/// true: include sales, false: do not include sales.
#[serde(default)]
pub include_sales: Option<bool>,
/// One of: market(s), industry_classification(s), sector_classification(s), investment_type(s), countries/country, portfolio, ungrouped, or custom_group.
#[serde(default)]
pub grouping: Option<String>,
/// If present, the custom group id to group by, as an integer id returned from the CustomGroupsList endpoint. When this is used, the 'grouping' parameter must be set to 'custom_group'.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub custom_group_id: Option<i64>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct ValuationSuccess {
/// A unique id identifying this report instance
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub id: String,
/// Report is as of this date.
#[serde_as(as = "DeserializeDate")]
pub balance_date: NaiveDate,
/// The portfolio id
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio_id: String,
/// Grouping id or name
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub grouping: String,
/// The id of the custom group, if any, otherwise nil if a built-in group was selected
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub custom_group_id: String,
/// The total value of the portfolio
pub value: Float,
/// List of holdings.
pub holdings: Vec<ValuationHoldingsSuccess>,
/// List of cash accounts. This includes Unsettled Trades and Unpaid Payout Adjustments.
pub cash_accounts: Vec<ValuationCashAccountsSuccess>,
/// List of sub-totals for each group.
pub sub_totals: Vec<ValuationSubTotalsSuccess>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct ValuationHoldingsSuccess {
/// The id of this holding
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub id: String,
/// The Sharesight symbol for the held instrument
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// A unique id identifying the instrument
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub instrument_id: String,
/// The code for the market the held instrument is listed on
pub market: Market,
/// The group value this instrument has been placed in - note that the field name will be the group type
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub _group_type_: String,
/// The name of the selected grouping for the report
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub grouping: String,
/// The name of the instrument
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The current value of the holding.
pub value: Float,
/// The quantity of shares or other instruments in the holding
pub quantity: Float,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct ValuationCashAccountsSuccess {
/// A unique key for each cash account
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub id: String,
/// The id of the cash account, null for adjustments
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub cash_account_id: String,
/// The name of the cash account
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The value of the cash account
pub value: Float,
/// The currency symbol (e.g. AU$) of the cash account
pub currency: Currency,
/// The ISO currency code (e.g. AUD) of the portfolio
pub currency_code: Currency,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct ValuationSubTotalsSuccess {
/// The group value - note that the field name will be the group type
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub _group_type_: String,
/// The total value of the holdings in this group
pub value: Float,
}
/// Single sign on authorisation. The single sign-on operation returns a URL that will allow the user to login to their Sharesight account without the need to enter their email address and password. The URL is valid for one minute. A single sign-on link or button in your application should be implemented so that the user click initiates this API call and then the URL returned is launched in the user’s browser. A "redirect_to" parameter can be appended to the login url. After successfully been logged in, the user will be then redirected to the specified redirect_to path; example: https://api.sharesight.com/users/sign_in?signon-token=token&redirect_to=/portfolios/1
pub struct RequestSingleSignOn;
impl<'a> ApiEndpoint<'a> for RequestSingleSignOn {
const URL_PATH: &'static str = "/single_sign_on.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = &'static str;
type Parameters = ();
type Success = RequestSingleSignOnSuccess;
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/single_sign_on.json"
}
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct RequestSingleSignOnSuccess {
/// Single-sign-on link
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub login_url: String,
}
/// Confirm a trade. This can be either a trade based on a company event or a sell trade based on the maturity date of an interest instrument.
pub struct TradeConfirm;
impl<'a> ApiEndpoint<'a> for TradeConfirm {
const URL_PATH: &'static str = "/trades.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Post;
type UrlDisplay = &'static str;
type Parameters = TradeConfirmParameters;
type Success = TradeConfirmSuccess;
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/trades.json"
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct TradeConfirmParameters {
/// The ID of the holding.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// ID used to identify the company event the unconfirmed trade is based on.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub company_event_id: i64,
/// Date used to identify the sell trade based on a maturity date of an interest instrument (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub transaction_date: NaiveDate,
/// The new state of the trade: `"confirmed"`.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct TradeConfirmSuccess {
/// The confirmed trade.
pub trade: TradeConfirmTradeSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct TradeConfirmTradeSuccess {
/// The confirmed trade's ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The trade type (`"BUY"`, `"SELL"`, `"SPLIT"`, etc).
pub transaction_type: TradeDescription,
/// The trade date (matches the maturity date for interest instruments, format `YYYY-MM-DD`).
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub transaction_date: String,
/// The market code (`"ASX"`, `"NZX"`, etc).
pub market: Market,
/// The instrument code/symbol.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// Number of shares sold/bought.
pub quantity: Float,
/// Price paid/received.
pub price: Float,
/// The transfer's exchange rate.
pub exchange_rate: Float,
/// The transfer's brokerage.
pub brokerage: Float,
/// The brokerage currency.
pub brokerage_currency_code: Currency,
/// The value for the trade as displayed in the 'value' column of the UI. For a return of capital, this will be the (signed) capital return value. For a cost base adjustment, this will be the value of the adjustment. For an opening balance, this will be the market value. In each case this is in portfolio currency (rounded to 2 decimal places).
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub value: String,
/// Any comments for that trade.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub comments: String,
/// Portfolio ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// Holding ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// Instrument ID of the related Holding.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub instrument_id: i64,
/// ID of the company event the given trade is based on (nil if not based on any).
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub company_event_id: Option<i64>,
/// The state of the trade, can be any of `"confirmed"`, `"unconfirmed"` or `"rejected"`.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
}
/// Reject a trade. This can be either a trade based on a company event or a sell trade based on the maturity date of an interest instrument.
pub struct TradeReject;
impl<'a> ApiEndpoint<'a> for TradeReject {
const URL_PATH: &'static str = "/trades.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Post;
type UrlDisplay = &'static str;
type Parameters = TradeRejectParameters;
type Success = TradeRejectSuccess;
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/trades.json"
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct TradeRejectParameters {
/// The ID of the holding.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// ID used to identify the company event the unconfirmed trade is based on.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub company_event_id: i64,
/// Date used to identify the sell trade based on a maturity date of an interest instrument (format `YYYY-MM-DD`).
#[serde_as(as = "DeserializeDate")]
pub transaction_date: NaiveDate,
/// The new state of the trade: `"rejected"`.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct TradeRejectSuccess {
/// The rejected trade.
pub trade: TradeRejectTradeSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct TradeRejectTradeSuccess {
/// The rejected trade's ID.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The trade type (`"BUY"`, `"SELL"`, `"SPLIT"`, etc).
pub transaction_type: TradeDescription,
/// The trade date (matches the maturity date for interest instruments, format `YYYY-MM-DD`).
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub transaction_date: String,
/// The market code (`"ASX"`, `"NZX"`, etc).
pub market: Market,
/// The instrument code/symbol.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// Number of shares sold/bought.
pub quantity: Float,
/// Price paid/received.
pub price: Float,
/// The transfer's exchange rate.
pub exchange_rate: Float,
/// The transfer's brokerage.
pub brokerage: Float,
/// The brokerage currency.
pub brokerage_currency_code: Currency,
/// The value for the trade as displayed in the 'value' column of the UI. For a return of capital, this will be the (signed) capital return value. For a cost base adjustment, this will be the value of the adjustment. For an opening balance, this will be the market value. In each case this is in portfolio currency (rounded to 2 decimal places).
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub value: String,
/// Any comments for that trade.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub comments: String,
/// Portfolio ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// Holding ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// Instrument ID of the related Holding.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub instrument_id: i64,
/// ID of the company event the given trade is based on (nil if not based on any).
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub company_event_id: Option<i64>,
/// The state of the trade, can be any of `"confirmed"`, `"unconfirmed"` or `"rejected"`.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
}
/// Returns trade transactions for the user’s portfolio between the two supplied dates. If you want to only access the trades of a particular holding, use `https://api.sharesight.com/api/v2/holdings/:holding_id/trades.json`. The response will be the same.
pub struct Trades;
impl<'a> ApiEndpoint<'a> for Trades {
const URL_PATH: &'static str = "/portfolios/:portfolio_id/trades.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = TradesUrlDisplay<'a>;
type Parameters = TradesParameters;
type Success = TradesSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
TradesUrlDisplay(parameters)
}
}
pub struct TradesUrlDisplay<'a>(&'a TradesParameters);
impl<'a> fmt::Display for TradesUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/portfolios/{}/trades.json", parameters.portfolio_id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct TradesParameters {
/// The portfolio ID (to show trades for).
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub portfolio_id: String,
/// Show trades from this date on. Defaults to portfolio inception date. Default value: inception_date
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub start_date: Option<NaiveDate>,
/// Show trades until this date (format `YYYY-MM-DD`). Default value: `Today`
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub end_date: Option<NaiveDate>,
/// Search for trade with the given unique identifier.
#[serde(default)]
pub unique_identifier: Option<String>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct TradesSuccess {
pub trades: Vec<TradesTradesSuccess>,
/// The current API Transaction.
pub api_transaction: TradesApiTransactionSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct TradesTradesSuccess {
/// The trade ID. Maybe nil if the trade is based on an adjustment and has not yet been confirmed by the user.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub id: Option<i64>,
/// A unique identifier associated with this trade
#[serde(default)]
pub unique_identifier: Option<String>,
/// The trade date (format YYYY-MM-DD).
#[serde_as(as = "DeserializeDate")]
pub transaction_date: NaiveDate,
/// Number of shares sold/bought.
pub quantity: Float,
/// Price paid/received.
pub price: Float,
/// For an opening balance, the cost base of the trade. Always returned in the portfolio currency
#[serde(default)]
pub cost_base: Option<Float>,
/// The trade's exchange rate as portfolio currency / instrument currency.
pub exchange_rate: Float,
/// The trade's brokerage.
pub brokerage: Float,
/// The ISO code of the brokerage currency, must be either Portfolio or Instrument currency. If the instrument is a cryptocurrency, any valid brokerage currency is supported.
#[serde(default)]
pub brokerage_currency_code: Option<Currency>,
/// The value for the trade as displayed in the 'value' column of the UI. For a return of capital, this will be the (signed) capital return value. For a capital call, this will be the (positive) capital return value. For a cost base adjustment, this will be the value of the adjustment. For an opening balance, this will be the market value: the market price x quantity at the opening balance date In each case this is in portfolio currency (rounded to 2 decimal places).
pub value: Float,
/// For a CAPITAL_RETURN or other trade with a linked payout, this is the paid on date
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub paid_on: Option<NaiveDate>,
/// The company event linked to the transaction.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub company_event_id: Option<i64>,
/// Any comments for that trade.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub comments: String,
/// Portfolio ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// Holding ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// The state of the trade, can be any of "confirmed", "unconfirmed" or "rejected".
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
/// The trade type ('BUY','SELL','SPLIT','BONUS','CONSOLD','CANCEL','CAPITAL_RETURN','OPENING_BALANCE','ADJUST_COST_BASE','CAPITAL_CALL').
pub transaction_type: TradeDescription,
/// Instrument ID of the related Holding.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub instrument_id: i64,
/// The instrument code/symbol
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// The market code (eg. `ASX`, `NZX`, etc).
pub market: Market,
/// The filename of any attachment
#[serde(default)]
pub attachment_filename: Option<String>,
/// The document id of any attachment, for use with the Show Document API (v2)
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub attachment_id: Option<i64>,
/// Returns 'true' if trade is confirmed. DEPRECATED: Use the state field to determine 'confirmed' vs. 'rejected' vs. 'unconfirmed' instead.
pub confirmed: bool,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct TradesApiTransactionSuccess {
/// The unique API Transaction id.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The API version you called.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub version: i64,
/// The path executed.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub action: String,
/// When the transaction was executed.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub timestamp: String,
}
/// Create a trade against a Portfolio or an existing Holding.
pub struct TradesCreate;
impl<'a> ApiEndpoint<'a> for TradesCreate {
const URL_PATH: &'static str = "/trades.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Post;
type UrlDisplay = &'static str;
type Parameters = TradesCreateParameters;
type Success = TradesCreateSuccess;
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/trades.json"
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct TradesCreateParameters {
pub trade: TradesCreateTradeParameters,
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct TradesCreateTradeParameters {
/// Portfolio ID to create the trade against. Alternatively, you can pass a 'holding_id' and also avoid sending instrument lookup parameters.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub portfolio_id: Option<i64>,
/// Holding ID to create the trade for. If you specify this, you can avoid specifying 'portfolio_id' and instrument lookup parameters.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub holding_id: Option<i64>,
/// This is a string of up to 255 characters used to identify duplicate trades. Generate an identifier for each trade and Sharesight will check on upload that this trade has not already been loaded.
#[serde(default)]
pub unique_identifier: Option<String>,
/// For an confirm trade, ID used to identify the company event the unconfirmed trade is based on.
#[serde(default)]
pub company_event_id: Option<String>,
/// For an confirm trade, the new state of the trade.
#[serde(default)]
pub state: Option<String>,
/// The transaction or trade date (format YYYY-MM-DD).
#[serde(default)]
pub transaction_date: Option<String>,
/// Number of units in the transaction. Must be a whole number unless the market allows fractional quantities to be traded.
#[serde(default)]
pub quantity: Option<Float>,
/// Currency value per unit.
#[serde(default)]
pub price: Option<Float>,
/// For an opening balance, the cost base of the trade.
#[serde(default)]
pub cost_base: Option<Float>,
/// The exchange rate used for the transaction as portfolio currency / instrument currency.
#[serde(default)]
pub exchange_rate: Option<Float>,
/// The brokerage fee (currency value).
#[serde(default)]
pub brokerage: Option<Float>,
/// The ISO code of the brokerage currency, must be either Portfolio or Instrument currency. If the instrument is a cryptocurrency, any valid brokerage currency is supported.
#[serde(default)]
pub brokerage_currency_code: Option<Currency>,
/// When transaction_type "ADJUST_COST_BASE" was chosen, this is the required value
#[serde(default)]
pub adjust_cost_base_value: Option<Float>,
/// When transaction_type "CAPITAL_RETURN" or "CAPITAL_CALL" is chosen, this is the required value
#[serde(default)]
pub capital_return_value: Option<Float>,
/// When transaction_type "CAPITAL_RETURN" or "CAPITAL_CALL" is chosen, this is the paid on date
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub paid_on: Option<NaiveDate>,
/// Comments against the trade.
#[serde(default)]
pub comments: Option<String>,
/// An `instrument_id` to look up the Instrument. Required unless you specify a `holding_id` or search by `instrument_code` and `instrument_market_code`.
#[serde(default)]
pub instrument_id: Option<String>,
/// Code to look up the Instrument; must be accompanied by `market`. Required unless you specify a `holding_id`.
#[serde(default)]
pub symbol: Option<String>,
/// Market Code to look up the Instrument; must be accompanied by `symbol`. Required unless you specify a `holding_id`.
#[serde(default)]
pub market: Option<Market>,
/// Market Country Code to look up the Instrument; must be accompanied by `symbol`. Required unless you specify a `symbol` with `market`, or a `holding_id`.
#[serde(default)]
pub market_country_code: Option<String>,
/// Supported transaction types: 'BUY','SELL','SPLIT','BONUS','CONSOLD','CANCEL','CAPITAL_RETURN','OPENING_BALANCE','ADJUST_COST_BASE','CAPITAL_CALL'.
#[serde(default)]
pub transaction_type: Option<TradeDescription>,
/// Base64 encoded file to be attached to the trade.
#[serde(default)]
pub attachment: Option<String>,
/// File name for the attachment. This parameter is required if attachment is set.
#[serde(default)]
pub attachment_filename: Option<String>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct TradesCreateSuccess {
pub trade: TradesCreateTradeSuccess,
/// The current API Transaction.
pub api_transaction: TradesCreateApiTransactionSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct TradesCreateTradeSuccess {
/// The trade ID. Maybe nil if the trade is based on an adjustment and has not yet been confirmed by the user.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub id: String,
/// A unique identifier associated with this trade
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub unique_identifier: String,
/// The trade date (format YYYY-MM-DD).
#[serde_as(as = "DeserializeDate")]
pub transaction_date: NaiveDate,
/// Number of shares sold/bought.
pub quantity: Float,
/// Price paid/received.
pub price: Float,
/// For an opening balance, the cost base of the trade. Always returned in the portfolio currency
pub cost_base: Float,
/// The trade's exchange rate as portfolio currency / instrument currency.
pub exchange_rate: Float,
/// The trade's brokerage.
pub brokerage: Float,
/// The ISO code of the brokerage currency, must be either Portfolio or Instrument currency. If the instrument is a cryptocurrency, any valid brokerage currency is supported.
pub brokerage_currency_code: Currency,
/// The value for the trade as displayed in the 'value' column of the UI. For a return of capital, this will be the (signed) capital return value. For a capital call, this will be the (positive) capital return value. For a cost base adjustment, this will be the value of the adjustment. For an opening balance, this will be the market value: the market price x quantity at the opening balance date In each case this is in portfolio currency (rounded to 2 decimal places).
pub value: Float,
/// For a CAPITAL_RETURN or other trade with a linked payout, this is the paid on date
#[serde_as(as = "DeserializeDate")]
pub paid_on: NaiveDate,
/// The company event linked to the transaction.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub company_event_id: Option<i64>,
/// Any comments for that trade.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub comments: String,
/// Portfolio ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// Holding ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// The state of the trade, can be any of "confirmed", "unconfirmed" or "rejected".
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
/// The trade type ('BUY','SELL','SPLIT','BONUS','CONSOLD','CANCEL','CAPITAL_RETURN','OPENING_BALANCE','ADJUST_COST_BASE','CAPITAL_CALL').
pub transaction_type: TradeDescription,
/// Instrument ID of the related Holding.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub instrument_id: i64,
/// The instrument code/symbol
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// The market code (eg. `ASX`, `NZX`, etc).
pub market: Market,
/// The filename of any attachment
#[serde(default)]
pub attachment_filename: Option<String>,
/// The document id of any attachment, for use with the Show Document API (v2)
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub attachment_id: Option<i64>,
/// Returns 'true' if trade is confirmed. DEPRECATED: Use the state field to determine 'confirmed' vs. 'rejected' vs. 'unconfirmed' instead.
pub confirmed: bool,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct TradesCreateApiTransactionSuccess {
/// The unique API Transaction id.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The API version you called.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub version: i64,
/// The path executed.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub action: String,
/// When the transaction was executed.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub timestamp: String,
}
/// Deletes a trade
pub struct TradesDestroy;
impl<'a> ApiEndpoint<'a> for TradesDestroy {
const URL_PATH: &'static str = "/trades/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Delete;
type UrlDisplay = TradesDestroyUrlDisplay<'a>;
type Parameters = TradesDestroyParameters;
type Success = TradesDestroySuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
TradesDestroyUrlDisplay(parameters)
}
}
pub struct TradesDestroyUrlDisplay<'a>(&'a TradesDestroyParameters);
impl<'a> fmt::Display for TradesDestroyUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/trades/{}.json", parameters.id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct TradesDestroyParameters {
/// id of the trade to delete
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct TradesDestroySuccess {
/// true if the record was deleted
pub deleted: bool,
/// The current API Transaction.
pub api_transaction: TradesDestroyApiTransactionSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct TradesDestroyApiTransactionSuccess {
/// The unique API Transaction id.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The API version you called.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub version: i64,
/// The path executed.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub action: String,
/// When the transaction was executed.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub timestamp: String,
}
/// Returns a trade transaction.
pub struct TradesShow;
impl<'a> ApiEndpoint<'a> for TradesShow {
const URL_PATH: &'static str = "/trades/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = TradesShowUrlDisplay<'a>;
type Parameters = TradesShowParameters;
type Success = TradesShowSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
TradesShowUrlDisplay(parameters)
}
}
pub struct TradesShowUrlDisplay<'a>(&'a TradesShowParameters);
impl<'a> fmt::Display for TradesShowUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/trades/{}.json", parameters.id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct TradesShowParameters {
/// The trade ID (to show trades for).
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub id: String,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct TradesShowSuccess {
/// The trade ID. Maybe nil if the trade is based on an adjustment and has not yet been confirmed by the user.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub id: String,
/// A unique identifier associated with this trade
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub unique_identifier: String,
/// The trade date (format YYYY-MM-DD).
#[serde_as(as = "DeserializeDate")]
pub transaction_date: NaiveDate,
/// Number of shares sold/bought.
pub quantity: Float,
/// Price paid/received.
pub price: Float,
/// For an opening balance, the cost base of the trade. Always returned in the portfolio currency
pub cost_base: Float,
/// The trade's exchange rate as portfolio currency / instrument currency.
pub exchange_rate: Float,
/// The trade's brokerage.
pub brokerage: Float,
/// The ISO code of the brokerage currency, must be either Portfolio or Instrument currency. If the instrument is a cryptocurrency, any valid brokerage currency is supported.
pub brokerage_currency_code: Currency,
/// The value for the trade as displayed in the 'value' column of the UI. For a return of capital, this will be the (signed) capital return value. For a capital call, this will be the (positive) capital return value. For a cost base adjustment, this will be the value of the adjustment. For an opening balance, this will be the market value: the market price x quantity at the opening balance date In each case this is in portfolio currency (rounded to 2 decimal places).
pub value: Float,
/// For a CAPITAL_RETURN or other trade with a linked payout, this is the paid on date
#[serde_as(as = "DeserializeDate")]
pub paid_on: NaiveDate,
/// The company event linked to the transaction.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub company_event_id: Option<i64>,
/// Any comments for that trade.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub comments: String,
/// Portfolio ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// Holding ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// The state of the trade, can be any of "confirmed", "unconfirmed" or "rejected".
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
/// The trade type ('BUY','SELL','SPLIT','BONUS','CONSOLD','CANCEL','CAPITAL_RETURN','OPENING_BALANCE','ADJUST_COST_BASE','CAPITAL_CALL').
pub transaction_type: TradeDescription,
/// Instrument ID of the related Holding.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub instrument_id: i64,
/// The instrument code/symbol
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// The market code (eg. `ASX`, `NZX`, etc).
pub market: Market,
/// The filename of any attachment
#[serde(default)]
pub attachment_filename: Option<String>,
/// The document id of any attachment, for use with the Show Document API (v2)
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub attachment_id: Option<i64>,
/// Returns 'true' if trade is confirmed. DEPRECATED: Use the state field to determine 'confirmed' vs. 'rejected' vs. 'unconfirmed' instead.
pub confirmed: bool,
/// The current API Transaction.
pub api_transaction: TradesShowApiTransactionSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct TradesShowApiTransactionSuccess {
/// The unique API Transaction id.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The API version you called.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub version: i64,
/// The path executed.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub action: String,
/// When the transaction was executed.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub timestamp: String,
}
/// Update an existing trade for the user. The trade is identified by the 'id'. Any parameter supplied will replace that field on the trade. Other fields will remain unchanged.
pub struct TradesUpdate;
impl<'a> ApiEndpoint<'a> for TradesUpdate {
const URL_PATH: &'static str = "/trades/:id.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Put;
type UrlDisplay = TradesUpdateUrlDisplay<'a>;
type Parameters = TradesUpdateParameters;
type Success = TradesUpdateSuccess;
fn url_path(parameters: &'a Self::Parameters) -> Self::UrlDisplay {
TradesUpdateUrlDisplay(parameters)
}
}
pub struct TradesUpdateUrlDisplay<'a>(&'a TradesUpdateParameters);
impl<'a> fmt::Display for TradesUpdateUrlDisplay<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let parameters = self.0;
write!(f, "/trades/{}.json", parameters.id)
}
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct TradesUpdateParameters {
/// id of the trade to update.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
pub trade: TradesUpdateTradeParameters,
}
#[serde_as]
#[derive(Debug, Clone, Serialize)]
pub struct TradesUpdateTradeParameters {
/// The transaction or trade date (format YYYY-MM-DD).
#[serde(default)]
pub transaction_date: Option<String>,
/// Number of units in the transaction. Must be a whole number unless the market allows fractional quantities to be traded.
#[serde(default)]
pub quantity: Option<Float>,
/// Currency value per unit.
#[serde(default)]
pub price: Option<Float>,
/// For an opening balance, the cost base of the trade.
#[serde(default)]
pub cost_base: Option<Float>,
/// The exchange rate used for the transaction as portfolio currency / instrument currency.
#[serde(default)]
pub exchange_rate: Option<Float>,
/// The brokerage fee (currency value).
#[serde(default)]
pub brokerage: Option<Float>,
/// The ISO code of the brokerage currency, must be either Portfolio or Instrument currency. If the instrument is a cryptocurrency, any valid brokerage currency is supported.
#[serde(default)]
pub brokerage_currency_code: Option<Currency>,
/// When transaction_type "ADJUST_COST_BASE" was chosen, this is the required value
#[serde(default)]
pub adjust_cost_base_value: Option<Float>,
/// When transaction_type "CAPITAL_RETURN" or "CAPITAL_CALL" is chosen, this is the required value
#[serde(default)]
pub capital_return_value: Option<Float>,
/// When transaction_type "CAPITAL_RETURN" or "CAPITAL_CALL" is chosen, this is the paid on date
#[serde_as(as = "Option<DeserializeDate>")]
#[serde(default)]
pub paid_on: Option<NaiveDate>,
/// Comments against the trade.
#[serde(default)]
pub comments: Option<String>,
/// An `instrument_id` to look up the Instrument. Required unless you specify a `holding_id` or search by `instrument_code` and `instrument_market_code`.
#[serde(default)]
pub instrument_id: Option<String>,
/// Code to look up the Instrument; must be accompanied by `market`. Required unless you specify a `holding_id`.
#[serde(default)]
pub symbol: Option<String>,
/// Market Code to look up the Instrument; must be accompanied by `symbol`. Required unless you specify a `holding_id`.
#[serde(default)]
pub market: Option<Market>,
/// Market Country Code to look up the Instrument; must be accompanied by `symbol`. Required unless you specify a `symbol` with `market`, or a `holding_id`.
#[serde(default)]
pub market_country_code: Option<String>,
/// Supported transaction types: 'BUY','SELL','SPLIT','BONUS','CONSOLD','CANCEL','CAPITAL_RETURN','OPENING_BALANCE','ADJUST_COST_BASE','CAPITAL_CALL'.
#[serde(default)]
pub transaction_type: Option<TradeDescription>,
/// Base64 encoded file to be attached to the trade.
#[serde(default)]
pub attachment: Option<String>,
/// File name for the attachment. This parameter is required if attachment is set.
#[serde(default)]
pub attachment_filename: Option<String>,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct TradesUpdateSuccess {
pub trade: TradesUpdateTradeSuccess,
/// The current API Transaction.
pub api_transaction: TradesUpdateApiTransactionSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct TradesUpdateTradeSuccess {
/// The trade ID. Maybe nil if the trade is based on an adjustment and has not yet been confirmed by the user.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub id: String,
/// A unique identifier associated with this trade
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub unique_identifier: String,
/// The trade date (format YYYY-MM-DD).
#[serde_as(as = "DeserializeDate")]
pub transaction_date: NaiveDate,
/// Number of shares sold/bought.
pub quantity: Float,
/// Price paid/received.
pub price: Float,
/// For an opening balance, the cost base of the trade. Always returned in the portfolio currency
pub cost_base: Float,
/// The trade's exchange rate as portfolio currency / instrument currency.
pub exchange_rate: Float,
/// The trade's brokerage.
pub brokerage: Float,
/// The ISO code of the brokerage currency, must be either Portfolio or Instrument currency. If the instrument is a cryptocurrency, any valid brokerage currency is supported.
pub brokerage_currency_code: Currency,
/// The value for the trade as displayed in the 'value' column of the UI. For a return of capital, this will be the (signed) capital return value. For a capital call, this will be the (positive) capital return value. For a cost base adjustment, this will be the value of the adjustment. For an opening balance, this will be the market value: the market price x quantity at the opening balance date In each case this is in portfolio currency (rounded to 2 decimal places).
pub value: Float,
/// For a CAPITAL_RETURN or other trade with a linked payout, this is the paid on date
#[serde_as(as = "DeserializeDate")]
pub paid_on: NaiveDate,
/// The company event linked to the transaction.
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub company_event_id: Option<i64>,
/// Any comments for that trade.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub comments: String,
/// Portfolio ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub portfolio_id: i64,
/// Holding ID of the trade.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub holding_id: i64,
/// The state of the trade, can be any of "confirmed", "unconfirmed" or "rejected".
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub state: String,
/// The trade type ('BUY','SELL','SPLIT','BONUS','CONSOLD','CANCEL','CAPITAL_RETURN','OPENING_BALANCE','ADJUST_COST_BASE','CAPITAL_CALL').
pub transaction_type: TradeDescription,
/// Instrument ID of the related Holding.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub instrument_id: i64,
/// The instrument code/symbol
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub symbol: String,
/// The market code (eg. `ASX`, `NZX`, etc).
pub market: Market,
/// The filename of any attachment
#[serde(default)]
pub attachment_filename: Option<String>,
/// The document id of any attachment, for use with the Show Document API (v2)
#[serde_as(as = "Option<PickFirst<(_, DisplayFromStr)>>")]
#[serde(default)]
pub attachment_id: Option<i64>,
/// Returns 'true' if trade is confirmed. DEPRECATED: Use the state field to determine 'confirmed' vs. 'rejected' vs. 'unconfirmed' instead.
pub confirmed: bool,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct TradesUpdateApiTransactionSuccess {
/// The unique API Transaction id.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The API version you called.
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub version: i64,
/// The path executed.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub action: String,
/// When the transaction was executed.
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub timestamp: String,
}
/// Access information on the current user
pub struct MyUser;
impl<'a> ApiEndpoint<'a> for MyUser {
const URL_PATH: &'static str = "/my_user.json";
const HTTP_METHOD: ApiHttpMethod = ApiHttpMethod::Get;
type UrlDisplay = &'static str;
type Parameters = ();
type Success = MyUserSuccess;
fn url_path(_parameters: &'a Self::Parameters) -> Self::UrlDisplay {
"/my_user.json"
}
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct MyUserSuccess {
/// Information on the current user
pub user: MyUserUserSuccess,
}
#[serde_as]
#[derive(Debug, Clone, Deserialize)]
pub struct MyUserUserSuccess {
/// The user id
#[serde_as(as = "PickFirst<(_, DisplayFromStr)>")]
pub id: i64,
/// The full name of the user
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub name: String,
/// The first name of the user
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub first_name: String,
/// The last name of the user
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub last_name: String,
/// The email address of the user
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub email: String,
/// The Sharesight plan code of the user
#[serde(default)]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub plan_code: String,
/// Is the user activated (by confirming email address)
pub is_activated: bool,
/// Is the user on a free plan
pub is_free: bool,
/// Is the user a beta tester
pub is_beta: bool,
/// Is the user a guest
pub is_guest: bool,
/// Is the user a staff member
pub is_staff: bool,
/// Is the user on a professional plan
pub is_professional: bool,
/// Has the user cancelled
pub is_cancelled: bool,
/// Has the user account expired
pub is_expired: bool,
}