How Staple’s APIs may be used to automate specific tasks?
In this section, we describe the API process for sending a document to Staple, and immediately receiving Staple’s predicted data for the document without any human intervention. Scanning a document is a primary function of Staple. Here is an example of a flow where a user scans an invoice document using the API calls.
To register an account via the API, navigate to the endpoint that belongs to the Registration of the user (Staple API documentation > Users > Registration). Hover over to the request section and go to the “Body” tab. This tab consists of a request sent to the server. Fill out the information in all required fields. The optional fields can be blank, but we recommend filling in all user details. An example of the Registration is shown below.
After editing the code, send the request by clicking on the “Send” button. It sends the request to the server and accepts a response with the requested data. A response with two fields, an access token (accessToken) and a refresh token (refreshToken), is generated.
The access token is used for the authentication of the user. Once a user is registered and logged in, the access token is used in identifying the user. Any request sent by this user has the access token in its header. This helps the server to identify which user is making the request.
The access token is short-lived. It can be used only for some time after which the user will have to re-authenticate themselves and generate a new access token. This can be skipped using the refresh token. It requests the API to get a new access token that allows the user to continue accessing the application resources.
Once a user is registered, they can log in to the server using the credentials used in the registration. Navigate to the endpoint that belongs to logging in the user. In the request section, open the tab containing the body of the request and enter the credentials.
This creates a response and gives tokens to the user. Here, an additional token (apiKey) is generated. The api key is used for uniquely identifying the user and authenticating its requests and access to resources.
To upload a document to a user’s account, a group must be present. A group contains a queue which holds similar types of documents. If a group is not present, the user has to create a group. An endpoint is curated for the same.
In the endpoint, the user needs to fill out the required fields in the headers section. The headers are an important part of the API request and response as they contain meta-data associated with the request and response. For the user to have access to the resources to be accessed by the request, some fields of the headers should be updated.
The mandatory fields are “Authorization” and “x-api-key”.
In the “Authorization” of the Headers section, replace the token variable with the value of the access token generated after logging in and keep the word “Bearer” undisturbed. Next, edit the value column for the key named “x-api-key” to the value of generated apiKey. Each step after this will need the x-api-key and Authorization values to be altered. It ensures that the current user has access to the operations being performed via the request. In the Body section, fill in the required fields.
This generates a response with details of the created group. The “id” field holds the unique id for the generated group.
To create a queue, follow the same steps as above in the code for creating a group. Set the qid field to the id of the desired group in integer format. Then, fill out the fields in the body section. Users can set the optional fields to null or leave them untouched.
This generates the response with details of the queue created.
There are various ways to upload a document. Users can upload multiple documents or upload each document by the document type. Navigate to the code section corresponding to uploading documents. Here, fill out the required headers. There are two fields to be filled up in the body section. The “qid” is the id of the queue where the documents have to be uploaded while the “files” rows take a file as its input. To do so, we need to change the data type of “files” to Files. Click on the empty space beside “files” in the same cell. A dropdown showing data types will be displayed. Select Files from the same. Then, choose the file from the device.
The generated response will be
Another method to upload documents is by scanning the document according to its document type.
This returns a response as
1 { 2 "scanDocuments": { 3 "data": { 4 "num_pages": 1, 5 "Type": "invoice_pdf", 6 "DocSize": [ 7 [ 8 2000, 9 1546 10 ] 11 ], 12 "Customer": null, 13 "Supplier": null, 14 "TableDetected": true, 15 "DetectedText": "Invoice Date 13 Nov 2018 Invoice Number INV-4412 Sleek Tech Pte Ltd. 28C Stanley Street 068737 SINGAPORE EA 1758937 NOTARUM PTE LTD 32 Carpenter street ] # 03-01 SINGAPORE 059911 SINGAPORE Description Quantity Unit Price Amount SGD Corporate Secretary 1.00 800.00 800.00 Incorporation Discount 1.00 ( 500.00 ) ( 500.00 ) Subtotal 300.00 TOTAL TAX 0.00 TOTAL SGD 300.00 Less Amount Paid 300.00 AMOUNT DUE SGD 0.00 Due Date: 13 Nov 2018 Customer Invoice Number NOTARUM PTE LTD INV-4412 Amount Due Due Date 0.00 13 Nov 2018 To Sleek Tech Pte.Ltd. 28C Stanley Street 068737 SINGAPORE EA 1758937 Amount Enclosed Enter the amount you are paying above Company Registration No 201708433H.Registered Office: 28C Stanley Street ,068737 Singapore. ", 16 "InvoiceNumber": { 17 "matches": [ 18 { 19 "match": "INV-4412", 20 "matchmulti": null, 21 "value": [ 22 1078, 23 1557, 24 1170, 25 1576, 26 1124, 27 1566.5, 28 "INV-4412", 29 "INV-4412" 30 ], 31 "keyword": [ 32 863, 33 1553, 34 1020, 35 1577, 36 941.5, 37 1565, 38 "Invoice Number", 39 "Invoice Number" 40 ], 41 "page": 0 42 } 43 ], 44 "UICategory": "Basic Information", 45 "UIName": "Invoice Number", 46 "UIType": "Text" 47 }, 48 "PONumber": { 49 "matches": [ 50 { 51 "match": null, 52 "value": null, 53 "keyword": null, 54 "page": null 55 } 56 ], 57 "UICategory": "Vendor & Customer", 58 "UIName": "PO Number", 59 "UIType": "Text" 60 }, 61 "AccountNumber": { 62 "matches": [ 63 { 64 "match": null, 65 "value": null, 66 "keyword": null, 67 "page": null 68 } 69 ], 70 "UICategory": "Payment Instructions", 71 "UIName": "Account Number", 72 "UIType": "Text" 73 }, 74 "AccountName": { 75 "matches": [ 76 { 77 "match": null, 78 "value": null, 79 "keyword": null, 80 "page": null 81 } 82 ], 83 "UICategory": "Payment Instructions", 84 "UIName": "Account Name", 85 "UIType": "Text" 86 }, 87 "SwiftCode": { 88 "matches": [ 89 { 90 "match": null, 91 "value": null, 92 "keyword": null, 93 "page": null 94 } 95 ], 96 "UICategory": "Payment Instructions", 97 "UIName": "Swift Code", 98 "UIType": "Text" 99 }, 100 "IBAN": { 101 "matches": [ 102 { 103 "match": null, 104 "value": null, 105 "keyword": null, 106 "page": null 107 } 108 ], 109 "UICategory": "Payment Instructions", 110 "UIName": "IBAN", 111 "UIType": "Text" 112 }, 113 "Email": { 114 "matches": [ 115 { 116 "match": null, 117 "value": null, 118 "keyword": null, 119 "page": null 120 } 121 ], 122 "UICategory": "Vendor & Customer", 123 "UIName": "Email", 124 "UIType": "Text" 125 }, 126 "URL": { 127 "matches": [ 128 { 129 "match": null, 130 "value": null, 131 "keyword": null, 132 "page": null 133 } 134 ], 135 "UICategory": "Vendor & Customer", 136 "UIName": "URL", 137 "UIType": "Text" 138 }, 139 "Total": { 140 "matches": [ 141 { 142 "match": 300, 143 "matchmulti": null, 144 "value": [ 145 1355, 146 1028, 147 1422, 148 1051, 149 1388.5, 150 1039.5, 151 "300.00", 152 "300.00" 153 ], 154 "keyword": [ 155 1092, 156 914, 157 1218, 158 935, 159 1155, 160 1037.5, 161 "TOTAL SGD", 162 "TOTAL SGD" 163 ], 164 "page": 0 165 } 166 ], 167 "UICategory": "VAT & Amounts", 168 "UIName": "Total", 169 "UIType": "Amount" 170 }, 171 "Subtotal": { 172 "matches": [ 173 { 174 "match": 300, 175 "matchmulti": null, 176 "value": [ 177 1356, 178 916, 179 1423, 180 936, 181 1389.5, 182 926, 183 "300.00", 184 "300.00" 185 ], 186 "keyword": [ 187 1139, 188 800, 189 1219, 190 821, 191 1179, 192 923.5, 193 "Subtotal", 194 "Subtotal" 195 ], 196 "page": 0 197 } 198 ], 199 "UICategory": "VAT & Amounts", 200 "UIName": "Subtotal", 201 "UIType": "Amount" 202 }, 203 "TaxTotal": { 204 "matches": [ 205 { 206 "match": 0, 207 "matchmulti": null, 208 "value": [ 209 1380, 210 971, 211 1421, 212 989, 213 1400.5, 214 980, 215 "0.00", 216 "0.00" 217 ], 218 "keyword": [ 219 1091, 220 970, 221 1219, 222 989, 223 1155, 224 979.5, 225 "TOTAL TAX", 226 "TOTAL TAX" 227 ], 228 "page": 0 229 } 230 ], 231 "UICategory": "VAT & Amounts", 232 "UIName": "Tax Total", 233 "UIType": "Amount" 234 }, 235 "Currency": { 236 "matches": [ 237 { 238 "match": "SGD", 239 "matchmulti": null, 240 "value": [ 241 1092, 242 1027, 243 1218, 244 1048, 245 1155, 246 1037.5, 247 "TOTAL SGD", 248 "TOTAL SGD" 249 ], 250 "keyword": [ 251 1092, 252 1027, 253 1218, 254 1048, 255 1155, 256 1037.5, 257 "TOTAL SGD", 258 "TOTAL SGD" 259 ], 260 "page": 0 261 }, 262 { 263 "match": "SGD", 264 "matchmulti": null, 265 "value": [ 266 1011, 267 1125, 268 1217, 269 1147, 270 1114, 271 1136, 272 "AMOUNT DUE SGD", 273 "AMOUNT DUE SGD" 274 ], 275 "keyword": [ 276 1011, 277 1125, 278 1217, 279 1147, 280 1114, 281 1136, 282 "AMOUNT DUE SGD", 283 "AMOUNT DUE SGD" 284 ], 285 "page": 0 286 } 287 ], 288 "UICategory": "VAT & Amounts", 289 "UIName": "Currency", 290 "UIType": "Text" 291 }, 292 "Tables": [ 293 { 294 "header": [ 295 77, 296 727, 297 1430, 298 768 299 ], 300 "GridX": [ 301 82, 302 564, 303 1071, 304 1256.5, 305 1525 306 ], 307 "GridY": [ 308 800, 309 856, 310 897 311 ], 312 "headernum": 4, 313 "HeaderPage": 0, 314 "GridYPages": [ 315 0, 316 0, 317 0 318 ] 319 } 320 ], 321 "LineItems": [ 322 [ 323 { 324 "Description ": [ 325 "Corporate Secretary" 326 ], 327 "Quantity ": [ 328 "1.00" 329 ], 330 "Unit Price ": [ 331 "800.00" 332 ], 333 "Amount SGD ": [ 334 "800.00" 335 ] 336 }, 337 { 338 "Description ": [ 339 "Incorporation Discount" 340 ], 341 "Quantity ": [ 342 "1.00" 343 ], 344 "Unit Price ": [ 345 "( 500.00 )" 346 ], 347 "Amount SGD ": [ 348 "( 500.00 )" 349 ] 350 } 351 ] 352 ], 353 "LineItems_standardHeader": [ 354 [ 355 { 356 "Description": "Corporate Secretary", 357 "Quantity": 1, 358 "UnitAmount": 800, 359 "LineAmount": 800 360 }, 361 { 362 "Description": "Incorporation Discount", 363 "Quantity": 1, 364 "UnitAmount": 500, 365 "LineAmount": 500 366 } 367 ] 368 ], 369 "Freight": { 370 "matches": [ 371 { 372 "match": null, 373 "value": null, 374 "keyword": null, 375 "page": null 376 } 377 ], 378 "UICategory": "VAT & Amounts", 379 "UIName": "Freight", 380 "UIType": "Amount" 381 }, 382 "BillingAddress": { 383 "matches": [ 384 { 385 "match": null, 386 "value": null, 387 "keyword": null, 388 "page": null 389 } 390 ], 391 "UICategory": "Vendor & Customer", 392 "UIName": "Billing Address", 393 "UIType": "Text" 394 }, 395 "ShippingAddress": { 396 "matches": [ 397 { 398 "match": null, 399 "value": null, 400 "keyword": null, 401 "page": null 402 } 403 ], 404 "UICategory": "Vendor & Customer", 405 "UIName": "Shipping Address", 406 "UIType": "Text" 407 }, 408 "CompanyName": { 409 "matches": [ 410 { 411 "match": "Sleek Tech Pte Ltd.", 412 "matchmulti": null, 413 "value": [ 414 1199, 415 300, 416 1402, 417 451, 418 1300.5, 419 375.5, 420 "Sleek Tech Pte Ltd.\n28C Stanley Street\n068737\nSINGAPORE\nEA 1758937", 421 "Sleek Tech Pte Ltd.\n28C Stanley Street\n068737\nSINGAPORE\nEA 1758937" 422 ], 423 "keyword": [ 424 1199, 425 300, 426 1402, 427 451, 428 1300.5, 429 375.5, 430 "Sleek Tech Pte Ltd.\n28C Stanley Street\n068737\nSINGAPORE\nEA 1758937", 431 "Sleek Tech Pte Ltd.\n28C Stanley Street\n068737\nSINGAPORE\nEA 1758937" 432 ], 433 "page": 0 434 } 435 ], 436 "UICategory": "Vendor & Customer", 437 "UIName": "Vendor Name", 438 "UIType": "Text" 439 }, 440 "SenderAddress": { 441 "matches": [ 442 { 443 "match": "Sleek Tech Pte Ltd.\n28C Stanley Street\n068737\nSINGAPORE\nEA 1758937", 444 "matchmulti": null, 445 "value": [ 446 1199, 447 300, 448 1402, 449 451, 450 1300.5, 451 375.5, 452 "Sleek Tech Pte Ltd.\n28C Stanley Street\n068737\nSINGAPORE\nEA 1758937", 453 "Sleek Tech Pte Ltd.\n28C Stanley Street\n068737\nSINGAPORE\nEA 1758937" 454 ], 455 "keyword": [ 456 1199, 457 300, 458 1402, 459 451, 460 1300.5, 461 375.5, 462 "Sleek Tech Pte Ltd.\n28C Stanley Street\n068737\nSINGAPORE\nEA 1758937", 463 "Sleek Tech Pte Ltd.\n28C Stanley Street\n068737\nSINGAPORE\nEA 1758937" 464 ], 465 "page": 0 466 } 467 ], 468 "UICategory": "Vendor & Customer", 469 "UIName": "Vendor Address", 470 "UIType": "Text" 471 }, 472 "OtherAddress": { 473 "matches": [ 474 { 475 "match": "NOTARUM PTE LTD\n32 Carpenter street ]\n# 03-01\nSINGAPORE 059911\nSINGAPORE", 476 "matchmulti": null, 477 "value": [ 478 148, 479 380, 480 367, 481 534, 482 257.5, 483 457, 484 "NOTARUM PTE LTD\n32 Carpenter street ]\n# 03-01\nSINGAPORE 059911\nSINGAPORE", 485 "NOTARUM PTE LTD\n32 Carpenter street ]\n# 03-01\nSINGAPORE 059911\nSINGAPORE" 486 ], 487 "keyword": [ 488 148, 489 380, 490 367, 491 534, 492 257.5, 493 457, 494 "NOTARUM PTE LTD\n32 Carpenter street ]\n# 03-01\nSINGAPORE 059911\nSINGAPORE", 495 "NOTARUM PTE LTD\n32 Carpenter street ]\n# 03-01\nSINGAPORE 059911\nSINGAPORE" 496 ], 497 "page": 0 498 } 499 ], 500 "UICategory": "Vendor & Customer", 501 "UIName": "Other Address", 502 "UIType": "Text" 503 }, 504 "InvoiceDate": { 505 "matches": [ 506 { 507 "match": "2018-11-13", 508 "matchmulti": null, 509 "value": [ 510 921, 511 322, 512 1046, 513 343, 514 983.5, 515 332.5, 516 "13 Nov 2018", 517 "13 Nov 2018" 518 ], 519 "keyword": [ 520 921, 521 295, 522 1044, 523 316, 524 982.5, 525 305.5, 526 "Invoice Date", 527 "Invoice Date" 528 ], 529 "page": 0 530 } 531 ], 532 "UICategory": "Basic Information", 533 "UIName": "Invoice Date", 534 "UIType": "Date" 535 }, 536 "PaymentDate": { 537 "matches": [ 538 { 539 "match": "2018-11-13", 540 "matchmulti": null, 541 "value": [ 542 71, 543 1233, 544 353, 545 1258, 546 212, 547 1245.5, 548 "Due Date: 13 Nov 2018", 549 "Due Date: 13 Nov 2018" 550 ], 551 "keyword": [ 552 71, 553 1233, 554 353, 555 1258, 556 212, 557 1245.5, 558 "Due Date: 13 Nov 2018", 559 "Due Date: 13 Nov 2018" 560 ], 561 "page": 0 562 } 563 ], 564 "UICategory": "Basic Information", 565 "UIName": "Payment Date", 566 "UIType": "Date" 567 }, 568 "OtherDate": { 569 "matches": [ 570 { 571 "match": null, 572 "value": null, 573 "keyword": null, 574 "page": null 575 } 576 ], 577 "UICategory": "Basic Information", 578 "UIName": "Other Date", 579 "UIType": "Date" 580 }, 581 "SmallBoxes": [ 582 { 583 "box": [ 584 921, 585 295, 586 1044, 587 316, 588 982.5, 589 305.5, 590 "Invoice Date", 591 "Invoice Date" 592 ], 593 "page": 0 594 }, 595 { 596 "box": [ 597 921, 598 322, 599 1046, 600 343, 601 983.5, 602 332.5, 603 "13 Nov 2018", 604 "13 Nov 2018" 605 ], 606 "page": 0 607 }, 608 { 609 "box": [ 610 920, 611 367, 612 1077, 613 389, 614 998.5, 615 378, 616 "Invoice Number", 617 "Invoice Number" 618 ], 619 "page": 0 620 }, 621 { 622 "box": [ 623 920, 624 394, 625 1012, 626 415, 627 966, 628 404.5, 629 "INV-4412", 630 "INV-4412" 631 ], 632 "page": 0 633 }, 634 { 635 "box": [ 636 1200, 637 300, 638 1402, 639 321, 640 1301, 641 310.5, 642 "Sleek Tech Pte Ltd.", 643 "Sleek Tech Pte Ltd." 644 ], 645 "page": 0 646 }, 647 { 648 "box": [ 649 1200, 650 333, 651 1388, 652 360, 653 1294, 654 346.5, 655 "28C Stanley Street", 656 "28C Stanley Street" 657 ], 658 "page": 0 659 }, 660 { 661 "box": [ 662 1199, 663 365, 664 1273, 665 387, 666 1236, 667 376, 668 "068737", 669 "068737" 670 ], 671 "page": 0 672 }, 673 { 674 "box": [ 675 1199, 676 396, 677 1332, 678 420, 679 1265.5, 680 408, 681 "SINGAPORE", 682 "SINGAPORE" 683 ], 684 "page": 0 685 }, 686 { 687 "box": [ 688 1200, 689 431, 690 1323, 691 451, 692 1261.5, 693 441, 694 "EA 1758937", 695 "EA 1758937" 696 ], 697 "page": 0 698 }, 699 { 700 "box": [ 701 150, 702 380, 703 367, 704 403, 705 258.5, 706 391.5, 707 "NOTARUM PTE LTD", 708 "NOTARUM PTE LTD" 709 ], 710 "page": 0 711 }, 712 { 713 "box": [ 714 149, 715 413, 716 348, 717 441, 718 248.5, 719 427, 720 "32 Carpenter street ]", 721 "32 Carpenter street ]" 722 ], 723 "page": 0 724 }, 725 { 726 "box": [ 727 148, 728 445, 729 214, 730 467, 731 181, 732 456, 733 "# 03-01", 734 "# 03-01" 735 ], 736 "page": 0 737 }, 738 { 739 "box": [ 740 148, 741 478, 742 360, 743 501, 744 254, 745 489.5, 746 "SINGAPORE 059911", 747 "SINGAPORE 059911" 748 ], 749 "page": 0 750 }, 751 { 752 "box": [ 753 148, 754 511, 755 280, 756 534, 757 214, 758 522.5, 759 "SINGAPORE", 760 "SINGAPORE" 761 ], 762 "page": 0 763 }, 764 { 765 "box": [ 766 82, 767 729, 768 193, 769 757, 770 137.5, 771 743, 772 "Description", 773 "Description" 774 ], 775 "page": 0 776 }, 777 { 778 "box": [ 779 935, 780 737, 781 1017, 782 766, 783 976, 784 751.5, 785 "Quantity", 786 "Quantity" 787 ], 788 "page": 0 789 }, 790 { 791 "box": [ 792 1125, 793 741, 794 1221, 795 762, 796 1173, 797 751.5, 798 "Unit Price", 799 "Unit Price" 800 ], 801 "page": 0 802 }, 803 { 804 "box": [ 805 1292, 806 742, 807 1425, 808 764, 809 1358.5, 810 753, 811 "Amount SGD", 812 "Amount SGD" 813 ], 814 "page": 0 815 }, 816 { 817 "box": [ 818 81, 819 788, 820 284, 821 816, 822 182.5, 823 802, 824 "Corporate Secretary", 825 "Corporate Secretary" 826 ], 827 "page": 0 828 }, 829 { 830 "box": [ 831 976, 832 798, 833 1016, 834 817, 835 996, 836 807.5, 837 "1.00", 838 "1.00" 839 ], 840 "page": 0 841 }, 842 { 843 "box": [ 844 1153, 845 798, 846 1220, 847 820, 848 1186.5, 849 809, 850 "800.00", 851 "800.00" 852 ], 853 "page": 0 854 }, 855 { 856 "box": [ 857 1357, 858 800, 859 1424, 860 821, 861 1390.5, 862 810.5, 863 "800.00", 864 "800.00" 865 ], 866 "page": 0 867 }, 868 { 869 "box": [ 870 80, 871 845, 872 305, 873 870, 874 192.5, 875 857.5, 876 "Incorporation Discount", 877 "Incorporation Discount" 878 ], 879 "page": 0 880 }, 881 { 882 "box": [ 883 976, 884 855, 885 1015, 886 873, 887 995.5, 888 864, 889 "1.00", 890 "1.00" 891 ], 892 "page": 0 893 }, 894 { 895 "box": [ 896 1138, 897 854, 898 1219, 899 882, 900 1178.5, 901 868, 902 "( 500.00 )", 903 "( 500.00 )" 904 ], 905 "page": 0 906 }, 907 { 908 "box": [ 909 1342, 910 856, 911 1423, 912 884, 913 1382.5, 914 870, 915 "( 500.00 )", 916 "( 500.00 )" 917 ], 918 "page": 0 919 }, 920 { 921 "box": [ 922 1139, 923 913, 924 1219, 925 934, 926 1179, 927 923.5, 928 "Subtotal", 929 "Subtotal" 930 ], 931 "page": 0 932 }, 933 { 934 "box": [ 935 1356, 936 916, 937 1423, 938 936, 939 1389.5, 940 926, 941 "300.00", 942 "300.00" 943 ], 944 "page": 0 945 }, 946 { 947 "box": [ 948 1091, 949 970, 950 1219, 951 989, 952 1155, 953 979.5, 954 "TOTAL TAX", 955 "TOTAL TAX" 956 ], 957 "page": 0 958 }, 959 { 960 "box": [ 961 1380, 962 971, 963 1421, 964 989, 965 1400.5, 966 980, 967 "0.00", 968 "0.00" 969 ], 970 "page": 0 971 }, 972 { 973 "box": [ 974 1092, 975 1027, 976 1218, 977 1048, 978 1155, 979 1037.5, 980 "TOTAL SGD", 981 "TOTAL SGD" 982 ], 983 "page": 0 984 }, 985 { 986 "box": [ 987 1355, 988 1028, 989 1422, 990 1051, 991 1388.5, 992 1039.5, 993 "300.00", 994 "300.00" 995 ], 996 "page": 0 997 }, 998 { 999 "box": [ 1000 1037, 1001 1067, 1002 1217, 1003 1091, 1004 1127, 1005 1079, 1006 "Less Amount Paid", 1007 "Less Amount Paid" 1008 ], 1009 "page": 0 1010 }, 1011 { 1012 "box": [ 1013 1355, 1014 1070, 1015 1422, 1016 1091, 1017 1388.5, 1018 1080.5, 1019 "300.00", 1020 "300.00" 1021 ], 1022 "page": 0 1023 }, 1024 { 1025 "box": [ 1026 1011, 1027 1125, 1028 1217, 1029 1147, 1030 1114, 1031 1136, 1032 "AMOUNT DUE SGD", 1033 "AMOUNT DUE SGD" 1034 ], 1035 "page": 0 1036 }, 1037 { 1038 "box": [ 1039 1378, 1040 1130, 1041 1421, 1042 1149, 1043 1399.5, 1044 1139.5, 1045 "0.00", 1046 "0.00" 1047 ], 1048 "page": 0 1049 }, 1050 { 1051 "box": [ 1052 71, 1053 1233, 1054 353, 1055 1258, 1056 212, 1057 1245.5, 1058 "Due Date: 13 Nov 2018", 1059 "Due Date: 13 Nov 2018" 1060 ], 1061 "page": 0 1062 }, 1063 { 1064 "box": [ 1065 862, 1066 1521, 1067 960, 1068 1541, 1069 911, 1070 1531, 1071 "Customer", 1072 "Customer" 1073 ], 1074 "page": 0 1075 }, 1076 { 1077 "box": [ 1078 863, 1079 1553, 1080 1020, 1081 1577, 1082 941.5, 1083 1565, 1084 "Invoice Number", 1085 "Invoice Number" 1086 ], 1087 "page": 0 1088 }, 1089 { 1090 "box": [ 1091 1078, 1092 1520, 1093 1295, 1094 1544, 1095 1186.5, 1096 1532, 1097 "NOTARUM PTE LTD", 1098 "NOTARUM PTE LTD" 1099 ], 1100 "page": 0 1101 }, 1102 { 1103 "box": [ 1104 1078, 1105 1557, 1106 1170, 1107 1576, 1108 1124, 1109 1566.5, 1110 "INV-4412", 1111 "INV-4412" 1112 ], 1113 "page": 0 1114 }, 1115 { 1116 "box": [ 1117 861, 1118 1599, 1119 986, 1120 1619, 1121 923.5, 1122 1609, 1123 "Amount Due", 1124 "Amount Due" 1125 ], 1126 "page": 0 1127 }, 1128 { 1129 "box": [ 1130 862, 1131 1633, 1132 955, 1133 1654, 1134 908.5, 1135 1643.5, 1136 "Due Date", 1137 "Due Date" 1138 ], 1139 "page": 0 1140 }, 1141 { 1142 "box": [ 1143 1075, 1144 1599, 1145 1117, 1146 1618, 1147 1096, 1148 1608.5, 1149 "0.00", 1150 "0.00" 1151 ], 1152 "page": 0 1153 }, 1154 { 1155 "box": [ 1156 1077, 1157 1634, 1158 1201, 1159 1655, 1160 1139, 1161 1644.5, 1162 "13 Nov 2018", 1163 "13 Nov 2018" 1164 ], 1165 "page": 0 1166 }, 1167 { 1168 "box": [ 1169 145, 1170 1589, 1171 170, 1172 1608, 1173 157.5, 1174 1598.5, 1175 "To", 1176 "To" 1177 ], 1178 "page": 0 1179 }, 1180 { 1181 "box": [ 1182 189, 1183 1589, 1184 390, 1185 1610, 1186 289.5, 1187 1599.5, 1188 "Sleek Tech Pte.Ltd.", 1189 "Sleek Tech Pte.Ltd." 1190 ], 1191 "page": 0 1192 }, 1193 { 1194 "box": [ 1195 188, 1196 1622, 1197 377, 1198 1647, 1199 282.5, 1200 1634.5, 1201 "28C Stanley Street", 1202 "28C Stanley Street" 1203 ], 1204 "page": 0 1205 }, 1206 { 1207 "box": [ 1208 188, 1209 1656, 1210 261, 1211 1676, 1212 224.5, 1213 1666, 1214 "068737", 1215 "068737" 1216 ], 1217 "page": 0 1218 }, 1219 { 1220 "box": [ 1221 188, 1222 1687, 1223 320, 1224 1710, 1225 254, 1226 1698.5, 1227 "SINGAPORE", 1228 "SINGAPORE" 1229 ], 1230 "page": 0 1231 }, 1232 { 1233 "box": [ 1234 188, 1235 1722, 1236 313, 1237 1741, 1238 250.5, 1239 1731.5, 1240 "EA 1758937", 1241 "EA 1758937" 1242 ], 1243 "page": 0 1244 }, 1245 { 1246 "box": [ 1247 860, 1248 1677, 1249 1036, 1250 1698, 1251 948, 1252 1687.5, 1253 "Amount Enclosed", 1254 "Amount Enclosed" 1255 ], 1256 "page": 0 1257 }, 1258 { 1259 "box": [ 1260 1073, 1261 1718, 1262 1423, 1263 1744, 1264 1248, 1265 1731, 1266 "Enter the amount you are paying above", 1267 "Enter the amount you are paying above" 1268 ], 1269 "page": 0 1270 }, 1271 { 1272 "box": [ 1273 64, 1274 1887, 1275 871, 1276 1917, 1277 467.5, 1278 1902, 1279 "Company Registration No 201708433H.Registered Office: 28C Stanley Street ,068737 Singapore.", 1280 "Company Registration No 201708433H.Registered Office: 28C Stanley Street ,068737 Singapore." 1281 ], 1282 "page": 0 1283 } 1284 ], 1285 "BigBoxes": [ 1286 { 1287 "box": [ 1288 921, 1289 295, 1290 1046, 1291 343, 1292 983.5, 1293 319, 1294 "Invoice Date\n13 Nov 2018", 1295 "Invoice Date\n13 Nov 2018" 1296 ], 1297 "page": 0 1298 }, 1299 { 1300 "box": [ 1301 920, 1302 367, 1303 1077, 1304 415, 1305 998.5, 1306 391, 1307 "Invoice Number\nINV-4412", 1308 "Invoice Number\nINV-4412" 1309 ], 1310 "page": 0 1311 }, 1312 { 1313 "box": [ 1314 1199, 1315 300, 1316 1402, 1317 451, 1318 1300.5, 1319 375.5, 1320 "Sleek Tech Pte Ltd.\n28C Stanley Street\n068737\nSINGAPORE\nEA 1758937", 1321 "Sleek Tech Pte Ltd.\n28C Stanley Street\n068737\nSINGAPORE\nEA 1758937" 1322 ], 1323 "page": 0 1324 }, 1325 { 1326 "box": [ 1327 148, 1328 380, 1329 367, 1330 534, 1331 257.5, 1332 457, 1333 "NOTARUM PTE LTD\n32 Carpenter street ]\n# 03-01\nSINGAPORE 059911\nSINGAPORE", 1334 "NOTARUM PTE LTD\n32 Carpenter street ]\n# 03-01\nSINGAPORE 059911\nSINGAPORE" 1335 ], 1336 "page": 0 1337 }, 1338 { 1339 "box": [ 1340 82, 1341 729, 1342 193, 1343 757, 1344 137.5, 1345 743, 1346 "Description", 1347 "Description" 1348 ], 1349 "page": 0 1350 }, 1351 { 1352 "box": [ 1353 935, 1354 737, 1355 1017, 1356 766, 1357 976, 1358 751.5, 1359 "Quantity", 1360 "Quantity" 1361 ], 1362 "page": 0 1363 }, 1364 { 1365 "box": [ 1366 1125, 1367 741, 1368 1221, 1369 762, 1370 1173, 1371 751.5, 1372 "Unit Price", 1373 "Unit Price" 1374 ], 1375 "page": 0 1376 }, 1377 { 1378 "box": [ 1379 1292, 1380 742, 1381 1425, 1382 764, 1383 1358.5, 1384 753, 1385 "Amount SGD", 1386 "Amount SGD" 1387 ], 1388 "page": 0 1389 }, 1390 { 1391 "box": [ 1392 81, 1393 788, 1394 284, 1395 816, 1396 182.5, 1397 802, 1398 "Corporate Secretary", 1399 "Corporate Secretary" 1400 ], 1401 "page": 0 1402 }, 1403 { 1404 "box": [ 1405 976, 1406 798, 1407 1016, 1408 817, 1409 996, 1410 807.5, 1411 "1.00", 1412 "1.00" 1413 ], 1414 "page": 0 1415 }, 1416 { 1417 "box": [ 1418 1153, 1419 798, 1420 1220, 1421 820, 1422 1186.5, 1423 809, 1424 "800.00", 1425 "800.00" 1426 ], 1427 "page": 0 1428 }, 1429 { 1430 "box": [ 1431 1357, 1432 800, 1433 1424, 1434 821, 1435 1390.5, 1436 810.5, 1437 "800.00", 1438 "800.00" 1439 ], 1440 "page": 0 1441 }, 1442 { 1443 "box": [ 1444 80, 1445 845, 1446 305, 1447 870, 1448 192.5, 1449 857.5, 1450 "Incorporation Discount", 1451 "Incorporation Discount" 1452 ], 1453 "page": 0 1454 }, 1455 { 1456 "box": [ 1457 976, 1458 855, 1459 1015, 1460 873, 1461 995.5, 1462 864, 1463 "1.00", 1464 "1.00" 1465 ], 1466 "page": 0 1467 }, 1468 { 1469 "box": [ 1470 1138, 1471 854, 1472 1219, 1473 882, 1474 1178.5, 1475 868, 1476 "( 500.00 )", 1477 "( 500.00 )" 1478 ], 1479 "page": 0 1480 }, 1481 { 1482 "box": [ 1483 1342, 1484 856, 1485 1423, 1486 884, 1487 1382.5, 1488 870, 1489 "( 500.00 )", 1490 "( 500.00 )" 1491 ], 1492 "page": 0 1493 }, 1494 { 1495 "box": [ 1496 1139, 1497 913, 1498 1219, 1499 934, 1500 1179, 1501 923.5, 1502 "Subtotal", 1503 "Subtotal" 1504 ], 1505 "page": 0 1506 }, 1507 { 1508 "box": [ 1509 1356, 1510 916, 1511 1423, 1512 936, 1513 1389.5, 1514 926, 1515 "300.00", 1516 "300.00" 1517 ], 1518 "page": 0 1519 }, 1520 { 1521 "box": [ 1522 1091, 1523 970, 1524 1219, 1525 989, 1526 1155, 1527 979.5, 1528 "TOTAL TAX", 1529 "TOTAL TAX" 1530 ], 1531 "page": 0 1532 }, 1533 { 1534 "box": [ 1535 1380, 1536 971, 1537 1421, 1538 989, 1539 1400.5, 1540 980, 1541 "0.00", 1542 "0.00" 1543 ], 1544 "page": 0 1545 }, 1546 { 1547 "box": [ 1548 1092, 1549 1027, 1550 1218, 1551 1048, 1552 1155, 1553 1037.5, 1554 "TOTAL SGD", 1555 "TOTAL SGD" 1556 ], 1557 "page": 0 1558 }, 1559 { 1560 "box": [ 1561 1355, 1562 1028, 1563 1422, 1564 1051, 1565 1388.5, 1566 1039.5, 1567 "300.00", 1568 "300.00" 1569 ], 1570 "page": 0 1571 }, 1572 { 1573 "box": [ 1574 1037, 1575 1067, 1576 1217, 1577 1091, 1578 1127, 1579 1079, 1580 "Less Amount Paid", 1581 "Less Amount Paid" 1582 ], 1583 "page": 0 1584 }, 1585 { 1586 "box": [ 1587 1355, 1588 1070, 1589 1422, 1590 1091, 1591 1388.5, 1592 1080.5, 1593 "300.00", 1594 "300.00" 1595 ], 1596 "page": 0 1597 }, 1598 { 1599 "box": [ 1600 1011, 1601 1125, 1602 1217, 1603 1147, 1604 1114, 1605 1136, 1606 "AMOUNT DUE SGD", 1607 "AMOUNT DUE SGD" 1608 ], 1609 "page": 0 1610 }, 1611 { 1612 "box": [ 1613 1378, 1614 1130, 1615 1421, 1616 1149, 1617 1399.5, 1618 1139.5, 1619 "0.00", 1620 "0.00" 1621 ], 1622 "page": 0 1623 }, 1624 { 1625 "box": [ 1626 71, 1627 1233, 1628 353, 1629 1258, 1630 212, 1631 1245.5, 1632 "Due Date: 13 Nov 2018", 1633 "Due Date: 13 Nov 2018" 1634 ], 1635 "page": 0 1636 }, 1637 { 1638 "box": [ 1639 862, 1640 1521, 1641 1020, 1642 1577, 1643 941, 1644 1549, 1645 "Customer\nInvoice Number", 1646 "Customer\nInvoice Number" 1647 ], 1648 "page": 0 1649 }, 1650 { 1651 "box": [ 1652 1078, 1653 1520, 1654 1295, 1655 1576, 1656 1186.5, 1657 1548, 1658 "NOTARUM PTE LTD\nINV-4412", 1659 "NOTARUM PTE LTD\nINV-4412" 1660 ], 1661 "page": 0 1662 }, 1663 { 1664 "box": [ 1665 861, 1666 1599, 1667 986, 1668 1654, 1669 923.5, 1670 1626.5, 1671 "Amount Due\nDue Date", 1672 "Amount Due\nDue Date" 1673 ], 1674 "page": 0 1675 }, 1676 { 1677 "box": [ 1678 1075, 1679 1599, 1680 1201, 1681 1655, 1682 1138, 1683 1627, 1684 "0.00\n13 Nov 2018", 1685 "0.00\n13 Nov 2018" 1686 ], 1687 "page": 0 1688 }, 1689 { 1690 "box": [ 1691 145, 1692 1589, 1693 390, 1694 1741, 1695 267.5, 1696 1665, 1697 "To Sleek Tech Pte.Ltd.\n28C Stanley Street\n068737\nSINGAPORE\nEA 1758937", 1698 "To Sleek Tech Pte.Ltd.\n28C Stanley Street\n068737\nSINGAPORE\nEA 1758937" 1699 ], 1700 "page": 0 1701 }, 1702 { 1703 "box": [ 1704 860, 1705 1677, 1706 1036, 1707 1698, 1708 948, 1709 1687.5, 1710 "Amount Enclosed", 1711 "Amount Enclosed" 1712 ], 1713 "page": 0 1714 }, 1715 { 1716 "box": [ 1717 1073, 1718 1718, 1719 1423, 1720 1744, 1721 1248, 1722 1731, 1723 "Enter the amount you are paying above", 1724 "Enter the amount you are paying above" 1725 ], 1726 "page": 0 1727 }, 1728 { 1729 "box": [ 1730 64, 1731 1887, 1732 871, 1733 1917, 1734 467.5, 1735 1902, 1736 "Company Registration No 201708433H.Registered Office: 28C Stanley Street ,068737 Singapore.", 1737 "Company Registration No 201708433H.Registered Office: 28C Stanley Street ,068737 Singapore." 1738 ], 1739 "page": 0 1740 } 1741 ] 1742 }, 1743 "docId": 8721, 1744 "status": "COMPLETED" 1745 } 1746 }
To get a document in JSON format, go to the endpoint named “Get document”. This is a Get request fetching information from the server. In this case, it returns the scanned document. Users can also export the document. The difference between the two is that the get request returns the document in a rich format while export is mostly used for automation solutions. Fill up the “x-api-key” and “accessKey” in the headers. In the request URL, replace the docID variable with the id of the document to be accessed. Send the request and the response containing all the information is received.
The changes will be reflected in the account.
Users can export the document once it is completed. The endpoint “Export Document by ID” facilitates this. To complete the request, users have to add the two headers of “API key” and “Authorization”. Following this, the user has to enter their document ID in the URL.
To move document/s to the completed tab, users can resort to the “Change multiple Documents to complete” endpoint. The headers required to complete this request are the “API key” and the “Authorization token”. The document/s to be moved are specified in the request payload. Here, users can mention an array of all the documents to be moved.
Request
Response
