Get Model Fields

GET

https://api.staple.io/v2/supernova/models/:modelName

GET

/v2/supernova/models/:modelName

$ curl https://api.staple.io/v2/supernova/models/modelName \
>      -H "x-api-key: <apiKey>"

200Get Model Fields

1 {
2   "documentModelFields": {
3     "model_fields": [
4       {
5         "UICategory": "Basic Information",
6         "code": "InvoiceNumber",
7         "description": null,
8         "extraction_method": null,
9         "name": "Invoice Number",
10         "recurring": null,
11         "required": null,
12         "type": "Text"
13       },
14       {
15         "UICategory": "Basic Information",
16         "code": "DeliveryOrderNumber",
17         "description": null,
18         "extraction_method": null,
19         "name": "Delivery Order Number",
20         "recurring": null,
21         "required": null,
22         "type": "Text"
23       },
24       {
25         "UICategory": "Basic Information",
26         "code": "SalesOrderNumber",
27         "description": null,
28         "extraction_method": null,
29         "name": "Sales Order Number",
30         "recurring": null,
31         "required": null,
32         "type": "Text"
33       },
34       {
35         "UICategory": "Vendor & Customer",
36         "code": "VendorGSTNumber",
37         "description": null,
38         "extraction_method": null,
39         "name": "Vendor GST Number",
40         "recurring": null,
41         "required": null,
42         "type": "Text"
43       },
44       {
45         "UICategory": "Vendor & Customer",
46         "code": "CustomerGSTNumber",
47         "description": null,
48         "extraction_method": null,
49         "name": "Customer GST Number",
50         "recurring": null,
51         "required": null,
52         "type": "Text"
53       },
54       {
55         "UICategory": "Basic Information",
56         "code": "PONumber",
57         "description": null,
58         "extraction_method": null,
59         "name": "PO Number",
60         "recurring": null,
61         "required": null,
62         "type": "Text"
63       },
64       {
65         "UICategory": "Basic Information",
66         "code": "OutletCode",
67         "description": null,
68         "extraction_method": null,
69         "name": "Outlet Code",
70         "recurring": null,
71         "required": null,
72         "type": "Text"
73       },
74       {
75         "UICategory": "Payment Instructions",
76         "code": "AccountNumber",
77         "description": null,
78         "extraction_method": null,
79         "name": "Account Number",
80         "recurring": null,
81         "required": null,
82         "type": "Text"
83       },
84       {
85         "UICategory": "Payment Instructions",
86         "code": "PaymentTerm",
87         "description": null,
88         "extraction_method": null,
89         "name": "Payment Term",
90         "recurring": null,
91         "required": null,
92         "type": "Text"
93       },
94       {
95         "UICategory": "Payment Instructions",
96         "code": "SwiftCode",
97         "description": null,
98         "extraction_method": null,
99         "name": "Swift Code",
100         "recurring": null,
101         "required": null,
102         "type": "Text"
103       },
104       {
105         "UICategory": "Payment Instructions",
106         "code": "IBAN",
107         "description": null,
108         "extraction_method": null,
109         "name": "IBAN",
110         "recurring": null,
111         "required": null,
112         "type": "Text"
113       },
114       {
115         "UICategory": "Basic Information",
116         "code": "InvoiceDate",
117         "description": null,
118         "extraction_method": null,
119         "name": "Invoice Date",
120         "recurring": null,
121         "required": null,
122         "type": "Date"
123       },
124       {
125         "UICategory": "Basic Information",
126         "code": "PaymentDate",
127         "description": null,
128         "extraction_method": null,
129         "name": "Payment Date",
130         "recurring": null,
131         "required": null,
132         "type": "Date"
133       },
134       {
135         "UICategory": "Basic Information",
136         "code": "DeliveryDate",
137         "description": null,
138         "extraction_method": null,
139         "name": "Delivery Date",
140         "recurring": null,
141         "required": null,
142         "type": "Date"
143       },
144       {
145         "UICategory": "Basic Information",
146         "code": "OtherDate",
147         "description": null,
148         "extraction_method": null,
149         "name": "Other Date",
150         "recurring": null,
151         "required": null,
152         "type": "Date"
153       },
154       {
155         "UICategory": "Basic Information",
156         "code": "ProjectName",
157         "description": null,
158         "extraction_method": null,
159         "name": " Project Name",
160         "recurring": null,
161         "required": null,
162         "type": "Text"
163       },
164       {
165         "UICategory": "VAT & Amounts",
166         "code": "TaxPercent",
167         "description": null,
168         "extraction_method": null,
169         "name": "Tax Percent",
170         "recurring": null,
171         "required": null,
172         "type": "Amount"
173       },
174       {
175         "UICategory": "VAT & Amounts",
176         "code": "FXRate",
177         "description": null,
178         "extraction_method": null,
179         "name": "FX Rate",
180         "recurring": null,
181         "required": null,
182         "type": "Amount"
183       },
184       {
185         "UICategory": "Payment Instructions",
186         "code": "AccountName",
187         "description": null,
188         "extraction_method": null,
189         "name": "Account Name",
190         "recurring": null,
191         "required": null,
192         "type": "Text"
193       },
194       {
195         "UICategory": "VAT & Amounts",
196         "code": "Total",
197         "description": null,
198         "extraction_method": null,
199         "name": "Total",
200         "recurring": null,
201         "required": null,
202         "type": "Amount"
203       },
204       {
205         "UICategory": "VAT & Amounts",
206         "code": "Subtotal",
207         "description": null,
208         "extraction_method": null,
209         "name": "Subtotal",
210         "recurring": null,
211         "required": null,
212         "type": "Amount"
213       },
214       {
215         "UICategory": "VAT & Amounts",
216         "code": "Freight",
217         "description": null,
218         "extraction_method": null,
219         "name": "Freight",
220         "recurring": null,
221         "required": null,
222         "type": "Amount"
223       },
224       {
225         "UICategory": "VAT & Amounts",
226         "code": "TaxTotal",
227         "description": null,
228         "extraction_method": null,
229         "name": "Tax Total",
230         "recurring": null,
231         "required": null,
232         "type": "Amount"
233       },
234       {
235         "UICategory": "VAT & Amounts",
236         "code": "Discount",
237         "description": null,
238         "extraction_method": null,
239         "name": "Discount",
240         "recurring": null,
241         "required": null,
242         "type": "Amount"
243       },
244       {
245         "UICategory": "VAT & Amounts",
246         "code": "DiscountPercent",
247         "description": null,
248         "extraction_method": null,
249         "name": "Discount Percent",
250         "recurring": null,
251         "required": null,
252         "type": "Amount"
253       },
254       {
255         "UICategory": "Vendor & Customer",
256         "code": "Email",
257         "description": null,
258         "extraction_method": null,
259         "name": "Email",
260         "recurring": null,
261         "required": null,
262         "type": "Text"
263       },
264       {
265         "UICategory": "Vendor & Customer",
266         "code": "URL",
267         "description": null,
268         "extraction_method": null,
269         "name": "URL",
270         "recurring": null,
271         "required": null,
272         "type": "Text"
273       },
274       {
275         "UICategory": "VAT & Amounts",
276         "code": "Currency",
277         "description": null,
278         "extraction_method": null,
279         "name": "Currency",
280         "recurring": null,
281         "required": null,
282         "type": "Currency"
283       },
284       {
285         "UICategory": "Vendor & Customer",
286         "code": "CustomerName",
287         "description": null,
288         "extraction_method": null,
289         "name": "Customer Name",
290         "recurring": null,
291         "required": null,
292         "type": "Text"
293       },
294       {
295         "UICategory": "Vendor & Customer",
296         "code": "BillingAddress",
297         "description": null,
298         "extraction_method": null,
299         "name": "Billing Address",
300         "recurring": null,
301         "required": null,
302         "type": "Text"
303       },
304       {
305         "UICategory": "Vendor & Customer",
306         "code": "ShippingAddress",
307         "description": null,
308         "extraction_method": null,
309         "name": "Shipping Address",
310         "recurring": null,
311         "required": null,
312         "type": "Text"
313       },
314       {
315         "UICategory": "Vendor & Customer",
316         "code": "CompanyName",
317         "description": null,
318         "extraction_method": null,
319         "name": "Vendor Name",
320         "recurring": null,
321         "required": null,
322         "type": "Text"
323       },
324       {
325         "UICategory": "Vendor & Customer",
326         "code": "SenderAddress",
327         "description": null,
328         "extraction_method": null,
329         "name": "Vendor Address",
330         "recurring": null,
331         "required": null,
332         "type": "Text"
333       },
334       {
335         "UICategory": "Vendor & Customer",
336         "code": "SupplierNote",
337         "description": null,
338         "extraction_method": null,
339         "name": "Supplier Note",
340         "recurring": null,
341         "required": null,
342         "type": "Text"
343       },
344       {
345         "UICategory": "Vendor & Customer",
346         "code": "SpecialNotice",
347         "description": null,
348         "extraction_method": null,
349         "name": "Special Notice",
350         "recurring": null,
351         "required": null,
352         "type": "Text"
353       },
354       {
355         "UICategory": "Vendor & Customer",
356         "code": "ReceivedAddress",
357         "description": null,
358         "extraction_method": null,
359         "name": "Received Address",
360         "recurring": null,
361         "required": null,
362         "type": "Text"
363       },
364       {
365         "UICategory": "Basic Information",
366         "code": "DocumentType",
367         "description": null,
368         "extraction_method": null,
369         "name": "Invoice Type",
370         "recurring": null,
371         "required": null,
372         "type": "Text"
373       },
374       {
375         "UICategory": "VAT & Amounts",
376         "code": "TotalRounding",
377         "description": null,
378         "extraction_method": null,
379         "name": "Total Rounding",
380         "recurring": null,
381         "required": null,
382         "type": "Amount"
383       },
384       {
385         "UICategory": "VAT & Amounts",
386         "code": "LessAmountPaid",
387         "description": null,
388         "extraction_method": null,
389         "name": "Advance Payment",
390         "recurring": null,
391         "required": null,
392         "type": "Amount"
393       },
394       {
395         "UICategory": "Basic Information",
396         "code": "InvoiceBankName",
397         "description": null,
398         "extraction_method": null,
399         "name": "Bank Name",
400         "recurring": null,
401         "required": null,
402         "type": "Text"
403       },
404       {
405         "UICategory": "Basic Information",
406         "code": "UniqueStamp",
407         "description": null,
408         "extraction_method": null,
409         "name": "Unique Stamp",
410         "recurring": null,
411         "required": null,
412         "type": "Boolean"
413       },
414       {
415         "UICategory": "Basic Information",
416         "code": "Signature",
417         "description": null,
418         "extraction_method": null,
419         "name": "Signature",
420         "recurring": null,
421         "required": null,
422         "type": "Boolean"
423       },
424       {
425         "UICategory": "Basic Information",
426         "code": "RubberStamp",
427         "description": null,
428         "extraction_method": null,
429         "name": "RubberStamp",
430         "recurring": null,
431         "required": null,
432         "type": "Boolean"
433       },
434       {
435         "UICategory": "VAT & Amounts",
436         "code": "ExchangeCurrencyTo",
437         "description": null,
438         "extraction_method": null,
439         "name": "Exchange Currency To",
440         "recurring": null,
441         "required": null,
442         "type": "Amount"
443       },
444       {
445         "UICategory": "VAT & Amounts",
446         "code": "ExchangeCurrencyFrom",
447         "description": null,
448         "extraction_method": null,
449         "name": "Exchange Currency From",
450         "recurring": null,
451         "required": null,
452         "type": "Amount"
453       },
454       {
455         "UICategory": "Basic Information",
456         "code": "SerialNumber",
457         "description": null,
458         "extraction_method": null,
459         "name": "Serial Number",
460         "recurring": null,
461         "required": null,
462         "type": "Text"
463       },
464       {
465         "UICategory": "Basic Information",
466         "code": "FormNumber",
467         "description": null,
468         "extraction_method": null,
469         "name": "Form Number",
470         "recurring": null,
471         "required": null,
472         "type": "Text"
473       },
474       {
475         "UICategory": "Basic Information",
476         "code": "DescriptionText",
477         "description": null,
478         "extraction_method": null,
479         "name": "Description Text",
480         "recurring": null,
481         "required": null,
482         "type": "Text"
483       },
484       {
485         "UICategory": "Basic Information",
486         "code": "ISOCountryCode",
487         "description": null,
488         "extraction_method": null,
489         "name": "ISOCountryCode",
490         "recurring": null,
491         "required": null,
492         "type": "CountryCode"
493       },
494       {
495         "UICategory": "Verification",
496         "code": "E-Verification",
497         "description": null,
498         "extraction_method": null,
499         "name": "Govt. Verification",
500         "recurring": null,
501         "required": null,
502         "type": "Text"
503       },
504       {
505         "UICategory": "Vendor & Customer",
506         "code": "VendorPhone",
507         "description": null,
508         "extraction_method": null,
509         "name": "Vendor Phone Number",
510         "recurring": null,
511         "required": null,
512         "type": "Digits"
513       },
514       {
515         "UICategory": "Vendor & Customer",
516         "code": "VendorFax",
517         "description": null,
518         "extraction_method": null,
519         "name": "Vendor Fax Number",
520         "recurring": null,
521         "required": null,
522         "type": "Digits"
523       },
524       {
525         "UICategory": "Verification",
526         "code": "LineRowsCheck",
527         "description": null,
528         "extraction_method": null,
529         "name": "Line Rows Check",
530         "recurring": null,
531         "required": null,
532         "type": "Text"
533       },
534       {
535         "UICategory": "Verification",
536         "code": "SubtotalCheck",
537         "description": null,
538         "extraction_method": null,
539         "name": "Subtotal Check",
540         "recurring": null,
541         "required": null,
542         "type": "Text"
543       },
544       {
545         "UICategory": "Verification",
546         "code": "Totalcheck",
547         "description": null,
548         "extraction_method": null,
549         "name": "Total Check",
550         "recurring": null,
551         "required": null,
552         "type": "Text"
553       },
554       {
555         "UICategory": "Verification",
556         "code": "VendorAddressCheck",
557         "description": null,
558         "extraction_method": null,
559         "name": "Vendor Address Check",
560         "recurring": null,
561         "required": null,
562         "type": "Text"
563       },
564       {
565         "UICategory": "Verification",
566         "code": "VendorNameCheck",
567         "description": null,
568         "extraction_method": null,
569         "name": "Vendor Name Check",
570         "recurring": null,
571         "required": null,
572         "type": "Text"
573       },
574       {
575         "UICategory": "Verification",
576         "code": "RegisteredVendorStatus",
577         "description": null,
578         "extraction_method": null,
579         "name": "Registered Vendor Status",
580         "recurring": null,
581         "required": null,
582         "type": "Text"
583       },
584       {
585         "UICategory": "Verification",
586         "code": "RegisteredVendorName",
587         "description": null,
588         "extraction_method": null,
589         "name": "Registered Vendor Name",
590         "recurring": null,
591         "required": null,
592         "type": "Text"
593       },
594       {
595         "UICategory": "Verification",
596         "code": "RegisteredVendorAddress",
597         "description": null,
598         "extraction_method": null,
599         "name": "Registered Vendor Address",
600         "recurring": null,
601         "required": null,
602         "type": "Text"
603       },
604       {
605         "UICategory": "Basic Information",
606         "code": "NationalTaxNumber",
607         "description": null,
608         "extraction_method": null,
609         "name": "NTN",
610         "recurring": null,
611         "required": null,
612         "type": "Text"
613       },
614       {
615         "UICategory": "Vendor & Customer",
616         "code": "HSNOrSACCode",
617         "description": null,
618         "extraction_method": null,
619         "name": "HSN SAC",
620         "recurring": null,
621         "required": null,
622         "type": "Text"
623       },
624       {
625         "UICategory": "VAT & Amounts",
626         "code": "WithholdingTaxTotal",
627         "description": null,
628         "extraction_method": null,
629         "name": "Withholding Tax Total",
630         "recurring": null,
631         "required": null,
632         "type": "Amount"
633       },
634       {
635         "UICategory": "VAT & Amounts",
636         "code": "AdvanceTax",
637         "description": null,
638         "extraction_method": null,
639         "name": "Advance Tax",
640         "recurring": null,
641         "required": null,
642         "type": "Amount"
643       },
644       {
645         "UICategory": "VAT & Amounts",
646         "code": "SpecificTax",
647         "description": null,
648         "extraction_method": null,
649         "name": "Specific Tax",
650         "recurring": null,
651         "required": null,
652         "type": "Amount"
653       },
654       {
655         "UICategory": "VAT & Amounts",
656         "code": "SpecificTaxPercent",
657         "description": null,
658         "extraction_method": null,
659         "name": "Specific Tax Percent",
660         "recurring": null,
661         "required": null,
662         "type": "Text"
663       },
664       {
665         "UICategory": "VAT & Amounts",
666         "code": "PublicLightingTax",
667         "description": null,
668         "extraction_method": null,
669         "name": "Public Lighting Tax",
670         "recurring": null,
671         "required": null,
672         "type": "Amount"
673       },
674       {
675         "UICategory": "VAT & Amounts",
676         "code": "PublicLightingTaxPercent",
677         "description": null,
678         "extraction_method": null,
679         "name": "Public Lighting Tax Percent",
680         "recurring": null,
681         "required": null,
682         "type": "Text"
683       },
684       {
685         "UICategory": "VAT & Amounts",
686         "code": "SalesTax",
687         "description": null,
688         "extraction_method": null,
689         "name": "Sales Tax",
690         "recurring": null,
691         "required": null,
692         "type": "Amount"
693       },
694       {
695         "UICategory": "VAT & Amounts",
696         "code": "AdditionalTax",
697         "description": null,
698         "extraction_method": null,
699         "name": "Additional Tax",
700         "recurring": null,
701         "required": null,
702         "type": "Amount"
703       },
704       {
705         "UICategory": "VAT & Amounts",
706         "code": "SalesTaxPercent",
707         "description": null,
708         "extraction_method": null,
709         "name": "Sales Tax Percent",
710         "recurring": null,
711         "required": null,
712         "type": "Text"
713       },
714       {
715         "UICategory": "Vendor & Customer",
716         "code": "BIRNumber",
717         "description": null,
718         "extraction_method": null,
719         "name": "BIR Number",
720         "recurring": null,
721         "required": null,
722         "type": "Text"
723       },
724       {
725         "UICategory": "Basic Information",
726         "code": "AdditionalPONumbers",
727         "description": null,
728         "extraction_method": null,
729         "name": "Additional PO Numbers",
730         "recurring": null,
731         "required": null,
732         "type": "Text"
733       },
734       {
735         "UICategory": "VAT & Amounts",
736         "code": "POTotal",
737         "description": null,
738         "extraction_method": null,
739         "name": "PO Total",
740         "recurring": null,
741         "required": null,
742         "type": "Amount"
743       },
744       {
745         "UICategory": "VAT & Amounts",
746         "code": "DOTotal",
747         "description": null,
748         "extraction_method": null,
749         "name": "DO Total",
750         "recurring": null,
751         "required": null,
752         "type": "Amount"
753       },
754       {
755         "UICategory": "Vendor & Customer",
756         "code": "CustomerEntityName",
757         "description": null,
758         "extraction_method": null,
759         "name": "Customer Entity Name",
760         "recurring": null,
761         "required": null,
762         "type": "Text"
763       },
764       {
765         "UICategory": "Basic Information",
766         "code": "Region",
767         "description": null,
768         "extraction_method": null,
769         "name": "Region",
770         "recurring": null,
771         "required": null,
772         "type": "Text"
773       },
774       {
775         "UICategory": "Basic Information",
776         "code": "Strikethrough",
777         "description": null,
778         "extraction_method": null,
779         "name": "Strikethrough",
780         "recurring": null,
781         "required": null,
782         "type": "Boolean"
783       },
784       {
785         "UICategory": "Basic Information",
786         "code": "Handwritten",
787         "description": null,
788         "extraction_method": null,
789         "name": "Handwritten",
790         "recurring": null,
791         "required": null,
792         "type": "Boolean"
793       },
794       {
795         "UICategory": "Basic Information",
796         "code": "VendorCode",
797         "description": null,
798         "extraction_method": null,
799         "name": "VendorCode",
800         "recurring": null,
801         "required": null,
802         "type": "Text"
803       },
804       {
805         "UICategory": "Vendor & Customer",
806         "code": "ABN",
807         "description": null,
808         "extraction_method": null,
809         "name": "ABN",
810         "recurring": null,
811         "required": null,
812         "type": "Text"
813       },
814       {
815         "UICategory": "Verification",
816         "code": "ABNVerification",
817         "description": null,
818         "extraction_method": null,
819         "name": "ABN Verification",
820         "recurring": null,
821         "required": null,
822         "type": "Text"
823       },
824       {
825         "UICategory": "Verification",
826         "code": "EntityStatus",
827         "description": null,
828         "extraction_method": null,
829         "name": "Entity Status",
830         "recurring": null,
831         "required": null,
832         "type": "Text"
833       },
834       {
835         "UICategory": "Verification",
836         "code": "ASICNumber",
837         "description": null,
838         "extraction_method": null,
839         "name": "ASIC Number",
840         "recurring": null,
841         "required": null,
842         "type": "Text"
843       },
844       {
845         "UICategory": "Metadata",
846         "code": "Producer",
847         "description": null,
848         "extraction_method": null,
849         "name": "Producer",
850         "recurring": null,
851         "required": null,
852         "type": "Text"
853       },
854       {
855         "UICategory": "Metadata",
856         "code": "CreatedAt",
857         "description": null,
858         "extraction_method": null,
859         "name": "Created At",
860         "recurring": null,
861         "required": null,
862         "type": "Text"
863       },
864       {
865         "UICategory": "Metadata",
866         "code": "ModifiedAt",
867         "description": null,
868         "extraction_method": null,
869         "name": "Modified At",
870         "recurring": null,
871         "required": null,
872         "type": "Text"
873       },
874       {
875         "UICategory": "Metadata",
876         "code": "GPSCoordinates",
877         "description": null,
878         "extraction_method": null,
879         "name": "GPS Coordinates",
880         "recurring": null,
881         "required": null,
882         "type": "Text"
883       },
884       {
885         "UICategory": "Verification",
886         "code": "DigitalSignature",
887         "description": null,
888         "extraction_method": null,
889         "name": "Digital Signature",
890         "recurring": null,
891         "required": null,
892         "type": "Text"
893       },
894       {
895         "UICategory": "Vendor & Customer",
896         "code": "ABA",
897         "description": null,
898         "extraction_method": null,
899         "name": "ABA",
900         "recurring": null,
901         "required": null,
902         "type": "Text"
903       }
904     ],
905     "table_headers": [
906       "Description",
907       "Quantity",
908       "LineAmount",
909       "UnitAmount",
910       "Tax",
911       "TaxRate",
912       "DiscountRate",
913       "DiscountAmount",
914       "UnitOfMeasurement",
915       "ItemCode",
916       "ItemNumber",
917       "ItemizedHSNOrSACCode",
918       "WithholdingTax",
919       "Other",
920       "SKUCode"
921     ]
922   }
923 }

Get pre-configured model fields.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Path parameters

modelNamestringRequired

Authentication

Path parameters

Response