Search Document Model Fields

POST

https://api.staple.io/v2/search/documents/model/fields

POST

/v2/search/documents/model/fields

$ curl -X POST https://api.staple.io/v2/search/documents/model/fields \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json"

200Search Document Model Fields

1 {
2   "getFieldsByModelId": [
3     {
4       "code": "InvoiceNumber",
5       "name": "InvoiceNumber"
6     },
7     {
8       "code": "DeliveryOrderNumber",
9       "name": "DeliveryOrderNumber"
10     },
11     {
12       "code": "SalesOrderNumber",
13       "name": "SalesOrderNumber"
14     },
15     {
16       "code": "VendorGSTNumber",
17       "name": "VendorGSTNumber"
18     },
19     {
20       "code": "CustomerGSTNumber",
21       "name": "CustomerGSTNumber"
22     },
23     {
24       "code": "PONumber",
25       "name": "PONumber"
26     },
27     {
28       "code": "AccountNumber",
29       "name": "AccountNumber"
30     },
31     {
32       "code": "PaymentTerm",
33       "name": "PaymentTerm"
34     },
35     {
36       "code": "SwiftCode",
37       "name": "SwiftCode"
38     },
39     {
40       "code": "IBAN",
41       "name": "IBAN"
42     },
43     {
44       "code": "InvoiceDate",
45       "name": "InvoiceDate"
46     },
47     {
48       "code": "PaymentDate",
49       "name": "PaymentDate"
50     },
51     {
52       "code": "OtherDate",
53       "name": "OtherDate"
54     },
55     {
56       "code": "ProjectName",
57       "name": "ProjectName"
58     },
59     {
60       "code": "TaxPercent",
61       "name": "TaxPercent"
62     },
63     {
64       "code": "FXRate",
65       "name": "FXRate"
66     },
67     {
68       "code": "AccountName",
69       "name": "AccountName"
70     },
71     {
72       "code": "Total",
73       "name": "Total"
74     },
75     {
76       "code": "Subtotal",
77       "name": "Subtotal"
78     },
79     {
80       "code": "Freight",
81       "name": "Freight"
82     },
83     {
84       "code": "TaxTotal",
85       "name": "TaxTotal"
86     },
87     {
88       "code": "Discount",
89       "name": "Discount"
90     },
91     {
92       "code": "DiscountPercent",
93       "name": "DiscountPercent"
94     },
95     {
96       "code": "Email",
97       "name": "Email"
98     },
99     {
100       "code": "URL",
101       "name": "URL"
102     },
103     {
104       "code": "Currency",
105       "name": "Currency"
106     },
107     {
108       "code": "CustomerName",
109       "name": "CustomerName"
110     },
111     {
112       "code": "BillingAddress",
113       "name": "BillingAddress"
114     },
115     {
116       "code": "ShippingAddress",
117       "name": "ShippingAddress"
118     },
119     {
120       "code": "CompanyName",
121       "name": "CompanyName"
122     },
123     {
124       "code": "SenderAddress",
125       "name": "SenderAddress"
126     },
127     {
128       "code": "SupplierNote",
129       "name": "SupplierNote"
130     },
131     {
132       "code": "DocumentType",
133       "name": "DocumentType"
134     },
135     {
136       "code": "TotalRounding",
137       "name": "TotalRounding"
138     },
139     {
140       "code": "LessAmountPaid",
141       "name": "LessAmountPaid"
142     },
143     {
144       "code": "InvoiceBankName",
145       "name": "InvoiceBankName"
146     },
147     {
148       "code": "UniqueStamp",
149       "name": "UniqueStamp"
150     },
151     {
152       "code": "Signature",
153       "name": "Signature"
154     },
155     {
156       "code": "RubberStamp",
157       "name": "RubberStamp"
158     },
159     {
160       "code": "ExchangeCurrencyTo",
161       "name": "ExchangeCurrencyTo"
162     },
163     {
164       "code": "ExchangeCurrencyFrom",
165       "name": "ExchangeCurrencyFrom"
166     },
167     {
168       "code": "SerialNumber",
169       "name": "SerialNumber"
170     },
171     {
172       "code": "FormNumber",
173       "name": "FormNumber"
174     },
175     {
176       "code": "DescriptionText",
177       "name": "DescriptionText"
178     },
179     {
180       "code": "ISOCountryCode",
181       "name": "ISOCountryCode"
182     },
183     {
184       "code": "E-Verification",
185       "name": "E-Verification"
186     },
187     {
188       "code": "VendorPhone",
189       "name": "VendorPhone"
190     },
191     {
192       "code": "VendorFax",
193       "name": "VendorFax"
194     },
195     {
196       "code": "LineRowsCheck",
197       "name": "LineRowsCheck"
198     },
199     {
200       "code": "SubtotalCheck",
201       "name": "SubtotalCheck"
202     },
203     {
204       "code": "Totalcheck",
205       "name": "Totalcheck"
206     },
207     {
208       "code": "VendorAddressCheck",
209       "name": "VendorAddressCheck"
210     },
211     {
212       "code": "VendorNameCheck",
213       "name": "VendorNameCheck"
214     },
215     {
216       "code": "RegisteredVendorStatus",
217       "name": "RegisteredVendorStatus"
218     },
219     {
220       "code": "RegisteredVendorName",
221       "name": "RegisteredVendorName"
222     },
223     {
224       "code": "RegisteredVendorAddress",
225       "name": "RegisteredVendorAddress"
226     },
227     {
228       "code": "NationalTaxNumber",
229       "name": "NationalTaxNumber"
230     },
231     {
232       "code": "HSNOrSACCode",
233       "name": "HSNOrSACCode"
234     },
235     {
236       "code": "WithholdingTaxTotal",
237       "name": "WithholdingTaxTotal"
238     },
239     {
240       "code": "AdvanceTax",
241       "name": "AdvanceTax"
242     },
243     {
244       "code": "SpecificTax",
245       "name": "SpecificTax"
246     },
247     {
248       "code": "SpecificTaxPercent",
249       "name": "SpecificTaxPercent"
250     },
251     {
252       "code": "PublicLightingTax",
253       "name": "PublicLightingTax"
254     },
255     {
256       "code": "PublicLightingTaxPercent",
257       "name": "PublicLightingTaxPercent"
258     },
259     {
260       "code": "SalesTax",
261       "name": "SalesTax"
262     },
263     {
264       "code": "AdditionalTax",
265       "name": "AdditionalTax"
266     },
267     {
268       "code": "SalesTaxPercent",
269       "name": "SalesTaxPercent"
270     },
271     {
272       "code": "BIRNumber",
273       "name": "BIRNumber"
274     },
275     {
276       "code": "AdditionalPONumbers",
277       "name": "AdditionalPONumbers"
278     },
279     {
280       "code": "POTotal",
281       "name": "POTotal"
282     },
283     {
284       "code": "DOTotal",
285       "name": "DOTotal"
286     },
287     {
288       "code": "CustomerEntityName",
289       "name": "CustomerEntityName"
290     },
291     {
292       "code": "Region",
293       "name": "Region"
294     },
295     {
296       "code": "Strikethrough",
297       "name": "Strikethrough"
298     },
299     {
300       "code": "Handwritten",
301       "name": "Handwritten"
302     },
303     {
304       "code": "VendorCode",
305       "name": "VendorCode"
306     }
307   ]
308 }

Get the pre-configured format of a specific model.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Request

This endpoint expects an object.

modelstringOptional

Authentication

Request

Response