curl --request GET \
--url https://app.ezzydoc.com/EzzyService.svc/Rest/getFormData \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.ezzydoc.com/EzzyService.svc/Rest/getFormData"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.ezzydoc.com/EzzyService.svc/Rest/getFormData', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.ezzydoc.com/EzzyService.svc/Rest/getFormData",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.ezzydoc.com/EzzyService.svc/Rest/getFormData"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.ezzydoc.com/EzzyService.svc/Rest/getFormData")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.ezzydoc.com/EzzyService.svc/Rest/getFormData")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"bankBranch": "<string>",
"bankAccount": "<string>",
"tag": "<string>",
"service_status": {
"invoice_id": 123,
"message": "<string>",
"status": 0
},
"form_data": {
"purchaseOrder": "<string>",
"invoiceNumber": "<string>",
"invoiceDate": "2023-11-07T05:31:56Z",
"paymentDate": "2023-11-07T05:31:56Z",
"supplier": "<string>",
"supplier_id": "<string>",
"total": 123,
"tax": 123,
"charge": 123,
"discount": 123,
"abn": "<string>",
"description": "<string>",
"from_email": "<string>",
"delivery_to": "<string>",
"invoice_to": "<string>",
"company_invoiced": "<string>",
"delivery_to_address": "<string>",
"invoice_to_address": "<string>",
"supplier_address": "<string>",
"bankBranch": "<string>",
"bankAccount": "<string>",
"bPaycode": "<string>",
"bPayRef": "<string>",
"customField1": "<string>",
"customField2": "<string>",
"customField3": "<string>",
"customField4": "<string>",
"customValues": {
"name": "<string>",
"value": "<string>",
"hint": "<string>"
},
"wfsettings": "<string>",
"location": "<string>",
"tracking": "<string>",
"tracking_option": "<string>",
"glcode_option": "<string>",
"glcode_text": "<string>",
"expense_claim": "<string>",
"email_to": "<string>",
"document_subtype": 123,
"switch_workflow": 123,
"email_subject": "<string>",
"email_conversation_id": "<string>",
"email_message_id": "<string>",
"approver": "<string>",
"approver_email": "<string>",
"additional_request": "<string>",
"require_email": true,
"require_bank_details": true,
"email": "<string>",
"bank_details": "<string>",
"changed": true
},
"blob_url": "<string>",
"pdf_url": "<string>",
"thumb_url": "<string>",
"supplier_name": "<string>",
"invoice_number": "<string>",
"file_name": "<string>",
"original_filename": "<string>",
"document_workflow": 123,
"total": 123,
"gst_total": 123,
"charge": 123,
"discount": 123,
"locale": 0,
"classification": 123
}getFormData
Returns form metadata for a document, including email sender, recipient, subject, and conversation IDs.
curl --request GET \
--url https://app.ezzydoc.com/EzzyService.svc/Rest/getFormData \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.ezzydoc.com/EzzyService.svc/Rest/getFormData"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.ezzydoc.com/EzzyService.svc/Rest/getFormData', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.ezzydoc.com/EzzyService.svc/Rest/getFormData",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.ezzydoc.com/EzzyService.svc/Rest/getFormData"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.ezzydoc.com/EzzyService.svc/Rest/getFormData")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.ezzydoc.com/EzzyService.svc/Rest/getFormData")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"bankBranch": "<string>",
"bankAccount": "<string>",
"tag": "<string>",
"service_status": {
"invoice_id": 123,
"message": "<string>",
"status": 0
},
"form_data": {
"purchaseOrder": "<string>",
"invoiceNumber": "<string>",
"invoiceDate": "2023-11-07T05:31:56Z",
"paymentDate": "2023-11-07T05:31:56Z",
"supplier": "<string>",
"supplier_id": "<string>",
"total": 123,
"tax": 123,
"charge": 123,
"discount": 123,
"abn": "<string>",
"description": "<string>",
"from_email": "<string>",
"delivery_to": "<string>",
"invoice_to": "<string>",
"company_invoiced": "<string>",
"delivery_to_address": "<string>",
"invoice_to_address": "<string>",
"supplier_address": "<string>",
"bankBranch": "<string>",
"bankAccount": "<string>",
"bPaycode": "<string>",
"bPayRef": "<string>",
"customField1": "<string>",
"customField2": "<string>",
"customField3": "<string>",
"customField4": "<string>",
"customValues": {
"name": "<string>",
"value": "<string>",
"hint": "<string>"
},
"wfsettings": "<string>",
"location": "<string>",
"tracking": "<string>",
"tracking_option": "<string>",
"glcode_option": "<string>",
"glcode_text": "<string>",
"expense_claim": "<string>",
"email_to": "<string>",
"document_subtype": 123,
"switch_workflow": 123,
"email_subject": "<string>",
"email_conversation_id": "<string>",
"email_message_id": "<string>",
"approver": "<string>",
"approver_email": "<string>",
"additional_request": "<string>",
"require_email": true,
"require_bank_details": true,
"email": "<string>",
"bank_details": "<string>",
"changed": true
},
"blob_url": "<string>",
"pdf_url": "<string>",
"thumb_url": "<string>",
"supplier_name": "<string>",
"invoice_number": "<string>",
"file_name": "<string>",
"original_filename": "<string>",
"document_workflow": 123,
"total": 123,
"gst_total": 123,
"charge": 123,
"discount": 123,
"locale": 0,
"classification": 123
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Document ID.
Response
Success
Response returned by getFormData. Contains document form metadata, file URLs, invoice values, and service status.
Bank branch or BSB value extracted from the document when available.
Bank account value extracted from the document when available.
Document tag used to identify or classify the document.
Service-level status for the API request.
Show child attributes
Show child attributes
Detailed form metadata for the document, including extracted invoice and email fields.
Show child attributes
Show child attributes
URL for accessing the original document or attachment content.
URL for accessing the PDF representation of the document when available.
URL for accessing a thumbnail preview of the document when available.
Supplier name associated with the document.
Invoice number associated with the document.
Internal file name of the stored document.
Original file name of the uploaded document.
Internal workflow identifier associated with the document.
Total document amount.
Total GST or tax amount.
Additional charge amount applied to the document.
Discount amount applied to the document.
Locale used for interpreting document values and formatting.
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 Internal document classification code.