Skip to main content
GET
getFormData

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

invoiceid
integer
required

Document ID.

Response

Success

Response returned by getFormData. Contains document form metadata, file URLs, invoice values, and service status.

bankBranch
string

Bank branch or BSB value extracted from the document when available.

bankAccount
string

Bank account value extracted from the document when available.

tag
string

Document tag used to identify or classify the document.

service_status
object

Service-level status for the API request.

form_data
object

Detailed form metadata for the document, including extracted invoice and email fields.

blob_url
string

URL for accessing the original document or attachment content.

pdf_url
string

URL for accessing the PDF representation of the document when available.

thumb_url
string

URL for accessing a thumbnail preview of the document when available.

supplier_name
string

Supplier name associated with the document.

invoice_number
string

Invoice number associated with the document.

file_name
string

Internal file name of the stored document.

original_filename
string

Original file name of the uploaded document.

document_workflow
integer

Internal workflow identifier associated with the document.

total
number

Total document amount.

gst_total
number

Total GST or tax amount.

charge
number

Additional charge amount applied to the document.

discount
number

Discount amount applied to the document.

locale
enum<integer>

Locale used for interpreting document values and formatting.

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
81,
82,
83,
84,
85,
86,
87,
88,
89,
90,
91,
92,
93,
94,
95,
96,
97,
98,
99,
100,
101,
102,
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,
142,
143,
144,
145,
146,
147,
148,
149,
150,
151,
152,
153,
154,
155,
156,
157,
158,
159,
160,
161,
162,
163,
165,
166,
167,
168,
170,
171,
172,
173,
174,
175,
176,
177,
178,
179,
180,
181,
182,
183,
184,
185,
186,
187,
188,
192,
193,
194,
195,
196,
197,
198,
199
classification
integer

Internal document classification code.