PDF4me AI (Preview)
Enhance your workflows with the powerful capabilities of the PDF4me AI Connector. Seamlessly integrate advanced artificial intelligence features, including language processing, image recognition, document parsing, generative AI and more to drive better efficiency and intelligence across your processes.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | PDF4me Support |
| URL | https://dev.pdf4me.com/help/ |
| support@pdf4me.com |
| Connector Metadata | |
|---|---|
| Publisher | Ynoox GmbH |
| Website | https://dev.pdf4me.com/ |
| Privacy policy | https://dev.pdf4me.com/privacy-policy/ |
| Categories | AI;Website |
Title: PDF4me AI
Description: Enhance your workflows with the powerful capabilities of the PDF4me AI Connector. Seamlessly integrate advanced artificial intelligence features, including language processing, image recognition, document parsing, generative AI and more to drive better efficiency and intelligence across your processes.
Publisher: PDF4me Ynoox GmbH
Prerequisites : You need a trial or an active/valid subscription in order to try our AI features.
Supported Operations
Operation 1 : AI - Invoice Parser","This action collects and returns detailed information about the provided invoice file.,
Operation 2 : AI - Healthcard Parser","This action collects and returns detailed information about the provided Health card file.,
Operation 3 : AI - Contract Parser","This action collects and returns detailed information about the provided Contract file,
Obtaining Credentials : To use this integration, you need to have an account on the PDF4me Developer Portal. Follow steps below to get your Subscription Key.
How to get PDF4me Subscription Key
- Register in PDF4me Developer Portal and start a Free Trial
- Go to Api Keys tab in the Developer Portal.
- Select an application or Create a new application.
- You will find a Primary Key and Secondary Key listed under the application. Click on Copy Key button beside the Primary Key for Power Automate text and paste it to Power Automate PDF4me connection
Getting Started : You can integrate PDF4me connector with Flow in easy steps. To know about the integration & more, visit our documentation page: PDF4me : Getting Started
Known Issues and Limitations : None
Deployment Instructions : It is very simple to deploy as any other costom connector.
You're now ready to start using this AI integration.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| api_key | securestring | The api_key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| AI - Bank Cheque Parser |
This action collects and returns detailed information about the provided Bank Cheque file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-bank-cheque-parser |
| AI - Bank Statement Parser |
This action collects and returns detailed information about the provided Bank Statement file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-bank-statement-parser |
| AI - Contract Parser |
This action collects and returns detailed information about the provided Contract file.Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-contract-parser |
| AI - Credit Card Parser |
This action collects and returns detailed information about the provided Credit Card file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-credit-card-parser |
| AI - Healthcard Parser |
This action collects and returns detailed information about the provided Healthcard file.Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-health-card-parser |
| AI - Invoice Parser |
This action collects and returns detailed information about the provided invoice file.Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-invoice-parser |
| AI - Marriage Certificate Parser |
This action collects and returns detailed information about the provided Marriage Certificate file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-marriage-certificate-parser |
| AI - Mortgage Document Parser |
This action collects and returns detailed information about the provided Mortgage Document file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-mortgage-document-parser |
| AI - Order Parser |
This action collects and returns detailed information about the provided Order file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-order-parser |
| AI - Pay Stub,Payslip Parser |
This action collects and returns detailed information about the provided Pay Stub/Payslip file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-paystub-payslip-parser |
| AI - Receipt Parser |
This action collects and returns detailed information about the provided Receipt file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-receipt-parser |
| AI - Shipping Label Parser |
This action collects and returns detailed information about the provided Shipping Label file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-shipping-label-parser |
| AI - Tax Document Parser |
This action collects and returns detailed information about the provided Tax Document file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-tax-document-parser |
| AI - Universal Document Parser |
This action processes any document type and extracts structured information based on user-specified fields. Supports invoices, contracts, legal documents, orders, certificates, receipts, shipping labels, and more. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-universal-document-parser |
AI - Bank Cheque Parser
This action collects and returns detailed information about the provided Bank Cheque file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-bank-cheque-parser
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | byte |
The content of the bank cheque file. |
|
|
File Name
|
Name | string |
The name of the file. |
|
|
customFieldKeys
|
customFieldKeys | array of string |
Optional list of custom field keys to extract. |
Returns
- Body
- BankChequeResponse
AI - Bank Statement Parser
This action collects and returns detailed information about the provided Bank Statement file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-bank-statement-parser
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | byte |
The content of the bank statement file. |
|
|
File Name
|
Name | string |
The name of the file. |
|
|
bankName
|
bankName | string |
Optional bank name for improved parsing accuracy. |
|
|
analyzePatterns
|
analyzePatterns | boolean |
Whether to analyze transaction patterns. |
|
|
customFieldKeys
|
customFieldKeys | array of string |
Optional list of custom field keys to extract. |
Returns
AI - Contract Parser
This action collects and returns detailed information about the provided Contract file.Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-contract-parser
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | byte |
The content of the contract file. |
|
|
File Name
|
Name | string |
The name of the file. |
|
|
customFieldKeys
|
customFieldKeys | array of string |
Optional list of custom field keys to extract. |
Returns
- Body
- ContractResponse
AI - Credit Card Parser
This action collects and returns detailed information about the provided Credit Card file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-credit-card-parser
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | byte |
The content of the credit card file. |
|
|
File Name
|
Name | string |
The name of the file. |
|
|
customFieldKeys
|
customFieldKeys | array of string |
Optional list of custom field keys to extract. |
Returns
- Body
- CreditCardResponse
AI - Healthcard Parser
This action collects and returns detailed information about the provided Healthcard file.Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-health-card-parser
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | byte |
The content of the health card file. |
|
|
File Name
|
Name | string |
The name of the file. |
|
|
customFieldKeys
|
customFieldKeys | array of string |
Optional list of custom field keys to extract. |
Returns
- Body
- HealthCardResponse
AI - Invoice Parser
This action collects and returns detailed information about the provided invoice file.Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-invoice-parser
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | byte |
The content of the invoice file. |
|
|
File Name
|
Name | string |
The name of the file. |
|
|
customFieldKeys
|
customFieldKeys | array of string |
Optional list of custom field keys to extract. |
Returns
- Body
- InvoiceResponse
AI - Marriage Certificate Parser
This action collects and returns detailed information about the provided Marriage Certificate file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-marriage-certificate-parser
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | byte |
The content of the marriage certificate file. |
|
|
File Name
|
Name | string |
The name of the file. |
|
|
verifyAuthenticity
|
verifyAuthenticity | boolean |
Whether to verify the authenticity of the certificate. |
|
|
customFieldKeys
|
customFieldKeys | array of string |
Optional list of custom field keys to extract. |
Returns
AI - Mortgage Document Parser
This action collects and returns detailed information about the provided Mortgage Document file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-mortgage-document-parser
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | byte |
The content of the mortgage document file. |
|
|
File Name
|
Name | string |
The name of the file. |
|
|
documentType
|
documentType | string |
Optional document type for improved parsing accuracy. |
|
|
customFieldKeys
|
customFieldKeys | array of string |
Optional list of custom field keys to extract. |
Returns
AI - Order Parser
This action collects and returns detailed information about the provided Order file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-order-parser
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | byte |
The content of the order file. |
|
|
File Name
|
Name | string |
The name of the file. |
Returns
- Body
- OrderResponse
AI - Pay Stub,Payslip Parser
This action collects and returns detailed information about the provided Pay Stub/Payslip file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-paystub-payslip-parser
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | byte |
The content of the pay stub/payslip file. |
|
|
File Name
|
Name | string |
The name of the file. |
|
|
customFieldKeys
|
customFieldKeys | array of string |
Optional list of custom field keys to extract. |
Returns
- Body
- PayStubResponse
AI - Receipt Parser
This action collects and returns detailed information about the provided Receipt file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-receipt-parser
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | byte |
The content of the receipt file. |
|
|
File Name
|
Name | string |
The name of the file. |
|
|
ReceiptType
|
ReceiptType | string |
Optional receipt type for improved parsing accuracy supportedTypes - meal - supplies - hotel - "fuel and energy" - transportation - communication - subscriptions - entertainment - training - healthcare - generic |
|
|
analyzeItems
|
analyzeItems | boolean |
Whether to analyze individual items on the receipt. |
|
|
extractMerchantInfo
|
extractMerchantInfo | boolean |
Whether to extract merchant information. |
|
|
calculateTotals
|
calculateTotals | boolean |
Whether to calculate totals and subtotals. |
|
|
customFieldKeys
|
customFieldKeys | array of string |
Optional list of custom field keys to extract. |
Returns
- Body
- ReceiptResponse
AI - Shipping Label Parser
This action collects and returns detailed information about the provided Shipping Label file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-shipping-label-parser
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | byte |
The content of the shipping label file. |
|
|
File Name
|
Name | string |
The name of the file. |
Returns
AI - Tax Document Parser
This action collects and returns detailed information about the provided Tax Document file. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-tax-document-parser
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | byte |
The content of the tax document file. |
|
|
File Name
|
Name | string |
The name of the file. |
|
|
TaxModel
|
TaxModel | string |
Optional tax model for improved parsing accuracy. supportedTypes - W2 - "1099" - "1099-SSA" - "1040" - "1040-SR" - "1040-NR" - "1098" - "1098-E" - "1098-T" - "1095A" - "1095C" - "W-4" - UnifiedTaxUS |
|
|
customFieldKeys
|
customFieldKeys | array of string |
Optional list of custom field keys to extract. |
Returns
- Body
- TaxDocumentResponse
AI - Universal Document Parser
This action processes any document type and extracts structured information based on user-specified fields. Supports invoices, contracts, legal documents, orders, certificates, receipts, shipping labels, and more. Documentation: https://docs.pdf4me.com/power-automate/pdf4me-ai/ai-universal-document-parser
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte | |
|
File Name
|
Name | string |
The name of the file. |
|
|
Fields to Extract
|
fields | True | array of string | |
|
Extraction Mode
|
mode | integer |
Returns
Definitions
CustomFieldsData
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string | |
|
value
|
value | string |
InvoiceResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Invoice Number
|
processInvoiceModel.invoiceNumber | string | |
|
Invoice Date
|
processInvoiceModel.invoiceDate | date-time | |
|
Order ID
|
processInvoiceModel.orderId | string | |
|
Vendor Name
|
processInvoiceModel.vendorName | string | |
|
Vendor Address
|
processInvoiceModel.vendorAddress | string | |
|
Vendor Phone
|
processInvoiceModel.vendorPhone | string | |
|
Vendor E-mail
|
processInvoiceModel.vendorEmail | string | |
|
Vendor GSTN Number
|
processInvoiceModel.vendorGSTIN | string | |
|
Vendor PAN Number
|
processInvoiceModel.vendorPAN | string | |
|
Vendor CIN Number
|
processInvoiceModel.vendorCIN | string | |
|
Bill To
|
processInvoiceModel.billTo | string | |
|
Bill To Address
|
processInvoiceModel.billToAddress | string | |
|
Bill To Phone
|
processInvoiceModel.billToPhone | string | |
|
Bill To E-mail
|
processInvoiceModel.billToEmail | string | |
|
Bill To State
|
processInvoiceModel.billToState | string | |
|
Bill To Pincode
|
processInvoiceModel.billToPincode | string | |
|
lineItems
|
processInvoiceModel.lineItems | array of InvoiceLineItem | |
|
Sub Total
|
processInvoiceModel.subTotal | decimal | |
|
CGST Amount
|
processInvoiceModel.cgst | decimal | |
|
SGST Amount
|
processInvoiceModel.sgst | decimal | |
|
CGST Rate
|
processInvoiceModel.cgstRate | decimal | |
|
SGST Rate
|
processInvoiceModel.sgstRate | decimal | |
|
Total Amount
|
processInvoiceModel.total | decimal | |
|
Store Number
|
processInvoiceModel.storeNumber | string | |
|
Delivery Date
|
processInvoiceModel.deliveryDate | string | |
|
Financial Charges
|
processInvoiceModel.financialCharges | decimal | |
|
Line Total
|
processInvoiceModel.lineTotal | decimal | |
|
Purchase Order Ref No
|
processInvoiceModel.purchaseOrderRef | string | |
|
Customer Reference No
|
processInvoiceModel.customerReference | string | |
|
Department Code
|
processInvoiceModel.departmentCode | string | |
|
CustomFieldsData
|
processInvoiceModel.CustomFieldsData | array of CustomFieldsData |
InvoiceLineItem
| Name | Path | Type | Description |
|---|---|---|---|
|
HSN Code
|
hsnCode | string |
HSN (Harmonized System of Nomenclature) code |
|
Description
|
description | string |
Item description |
|
Unit Price
|
unitPrice | decimal |
Unit price of the item |
|
Discount
|
discount | decimal |
Discount amount |
|
Quantity
|
quantity | decimal |
Quantity of items |
|
Taxable Value
|
taxableValue | decimal |
Taxable value of the line item |
|
CGST Amount
|
cgstAmount | decimal |
CGST amount for this line item |
|
SGST Amount
|
sgstAmount | decimal |
SGST amount for this line item |
|
Total
|
total | decimal |
Total amount for this line item |
ContractResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Title
|
contractData.title | string | |
|
Contract ID
|
contractData.contractId | string | |
|
Industry
|
contractData.industry | string | |
|
Decision Maker
|
contractData.decisionMaker | string | |
|
Application Reference
|
contractData.applicationReference | string | |
|
Print Reference
|
contractData.printReference | string | |
|
parties
|
contractData.parties | array of Party | |
|
Execution Date
|
contractData.executionDateStr | string |
Execution date as string. |
|
Effective Date
|
contractData.effectiveDateStr | string |
Effective date as string. |
|
Expiration Date
|
contractData.expirationDateStr | string |
Expiration date as string. |
|
Contract Duration
|
contractData.contractDuration | string | |
|
Jurisdictions
|
contractData.jurisdiction | Jurisdiction | |
|
Custom Fields
|
contractData.customFieldsData | array of CustomFieldsData |
Party
| Name | Path | Type | Description |
|---|---|---|---|
|
Legal Party Type
|
legalParty | string | |
|
Party Name
|
name | string | |
|
Address
|
address | string | |
|
Reference Name
|
referenceName | string | |
|
Full Description
|
fullDescription | string |
Jurisdiction
| Name | Path | Type | Description |
|---|---|---|---|
|
Jurisdictions
|
jurisdictions | array of string | |
|
Court Location
|
courtLocation | string | |
|
Full Description
|
fullDescription | string | |
|
Region
|
region | string |
HealthCardResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Member ID No
|
healthData.memberId | string | |
|
Group Number
|
healthData.groupNumber | string | |
|
Plan Type
|
healthData.planType | string | |
|
Insurance Provider Name
|
healthData.insuranceProvider | string | |
|
Member Name
|
healthData.memberName | string | |
|
Date Of Birth
|
healthData.dateOfBirth | string |
Date of birth as string |
|
Effective Date
|
healthData.effectiveDate | string |
Effective date as string |
|
RxBin
|
healthData.rxBin | string | |
|
RxPcn
|
healthData.rxPcn | string | |
|
RxGroup
|
healthData.rxGroup | string | |
|
Copay Info
|
healthData.copayInfo | array of string | |
|
CustomFieldsData
|
healthData.CustomFieldsData | array of CustomFieldsData |
BankChequeResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Account Holder Name
|
bankChequeData.accountHolder | string | |
|
Account holder Address
|
bankChequeData.address | string | |
|
Cheque Number
|
bankChequeData.checkNumber | string | |
|
Date on the cheque
|
bankChequeData.ChequeDate | string |
Date on the cheque |
|
Payee
|
bankChequeData.payee | string | |
|
Amount Number
|
bankChequeData.amountNumber | decimal | |
|
Amount in Words
|
bankChequeData.amountWords | string | |
|
Memo
|
bankChequeData.memo | string | |
|
Signature on the Cheque
|
bankChequeData.signature | string | |
|
Routing Number
|
bankChequeData.routingNumber | string | |
|
Bank Account Number
|
bankChequeData.accountNumber | string | |
|
Bank Name
|
bankChequeData.bankName | string | |
|
CustomFieldsData
|
bankChequeData.CustomFieldsData | array of CustomFieldsData |
BankStatementResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Bank Name
|
bankStatementData.bankName | string | |
|
Account Holder Name
|
bankStatementData.accountHolderName | string | |
|
Account Number
|
bankStatementData.accountNumber | string | |
|
Account Type
|
bankStatementData.accountType | string | |
|
Branch Name
|
bankStatementData.branch | string | |
|
Statement Number
|
bankStatementData.statementNumber | string | |
|
Statement Period
|
bankStatementData.statementPeriod | StatementPeriod | |
|
Balances Details
|
bankStatementData.Balances | Balances | |
|
Currency Name
|
bankStatementData.currency | string | |
|
Bank Fees
|
bankStatementData.fees | decimal | |
|
Interest
|
bankStatementData.interest | decimal | |
|
Transactions
|
bankStatementData.transactions | array of BankTransaction | |
|
checksPaid
|
bankStatementData.checksPaid | array of CheckPaid | |
|
Pattern
|
bankStatementData.patterns | Patterns | |
|
Summary
|
bankStatementData.summary | Summary | |
|
CustomFieldsData
|
bankStatementData.CustomFieldsData | array of CustomFieldsData |
StatementPeriod
| Name | Path | Type | Description |
|---|---|---|---|
|
Start Date
|
startDate | string |
Start date of the statement period |
|
End Date
|
endDate | string |
End date of the statement period |
Balances
| Name | Path | Type | Description |
|---|---|---|---|
|
Opening Balance
|
openingBalance | decimal | |
|
Closing Balance
|
closingBalance | decimal | |
|
Total Deposits
|
totalDeposits | decimal | |
|
Total Withdrawals
|
totalWithdrawals | decimal |
BankTransaction
| Name | Path | Type | Description |
|---|---|---|---|
|
Transaction Date
|
TransactionDate | string |
Transaction date as string |
|
Description
|
Description | string | |
|
Amount
|
amount | decimal | |
|
Type
|
type | string |
Transaction type (debit/credit) |
|
Balance
|
balance | decimal | |
|
Category
|
category | string | |
|
Merchant
|
merchant | string | |
|
Reference Number
|
referenceNumber | string |
CheckPaid
| Name | Path | Type | Description |
|---|---|---|---|
|
Check Number
|
checkNumber | string | |
|
Paid Date
|
paidDate | string | |
|
Amount
|
amount | decimal | |
|
Amount
|
payee | string | |
|
Description
|
description | string |
Patterns
| Name | Path | Type | Description |
|---|---|---|---|
|
Recurring Payments
|
recurringPayments | array of RecurringPayment | |
|
Unusual Transactions
|
unusualTransactions | array of UnusualTransaction |
RecurringPayment
| Name | Path | Type | Description |
|---|---|---|---|
|
Merchant
|
merchant | string | |
|
Amount
|
amount | decimal | |
|
Frequency
|
frequency | string | |
|
Recurring Dates
|
recurringDates | array of string |
UnusualTransaction
| Name | Path | Type | Description |
|---|---|---|---|
|
Unusual Date
|
unusualDate | string | |
|
Description
|
description | string | |
|
Amount
|
amount | decimal | |
|
Reason
|
reason | string |
Summary
| Name | Path | Type | Description |
|---|---|---|---|
|
Total Transactions
|
totalTransactions | integer | |
|
Category Summary
|
categorySummary | object | |
|
Average Daily Balance
|
averageDailyBalance | decimal | |
|
Largest Transaction Data
|
largestCredit | LargestTransaction | |
|
Largest Transaction Data
|
largestDebit | LargestTransaction |
LargestTransaction
| Name | Path | Type | Description |
|---|---|---|---|
|
Largest Transaction Date
|
largestTransactionDate | string | |
|
Amount
|
amount | decimal | |
|
Description
|
description | string |
CreditCardResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Bank Name
|
creditCardData.bankName | string |
Name of the bank |
|
Card Number
|
creditCardData.cardNumber | string |
Credit card number |
|
Expiry Date
|
creditCardData.expiryDate | string |
Card expiry date |
|
Cardholder Name
|
creditCardData.cardholderName | string |
Name of the cardholder |
|
CVV
|
creditCardData.cvv | string |
Card verification value (CVV) |
|
Card Type
|
creditCardData.cardType | string |
Type of credit card (Debit/Credit) |
|
Issuing Bank
|
creditCardData.issuingBank | string |
Bank that issued the card |
|
Card Brand
|
creditCardData.cardBrand | string |
Card brand (Visa, Mastercard, etc.) |
|
Account Number
|
creditCardData.accountNumber | string |
Associated account number |
|
Valid From
|
creditCardData.validFrom | string |
Card valid from date |
|
Valid Thru
|
creditCardData.validThru | string |
Card valid through date |
|
CustomFieldsData
|
creditCardData.CustomFieldsData | array of CustomFieldsData |
PayStubResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Gross Pay
|
payStubData.grossPay | decimal | |
|
Net Pay
|
payStubData.netPay | decimal | |
|
Pay Period
|
payStubData.payPeriod | string | |
|
Pay Date
|
payStubData.payDateStr | string |
Pay date as string |
|
Federal Income Tax
|
payStubData.federalIncomeTax | decimal | |
|
State Income Tax
|
payStubData.stateIncomeTax | decimal | |
|
Social Security Tax
|
payStubData.socialSecurityTax | decimal | |
|
Medicare Tax
|
payStubData.medicareTax | decimal | |
|
Local City Tax
|
payStubData.localCityTax | decimal | |
|
Employee Name
|
payStubData.employeeName | string | |
|
Employee Id Ssn
|
payStubData.employeeIdSsn | string | |
|
Employee Address
|
payStubData.employeeAddress | string | |
|
Job Title
|
payStubData.jobTitle | string | |
|
Company Name
|
payStubData.companyName | string | |
|
Employer Address
|
payStubData.employerAddress | string | |
|
Employer Ein
|
payStubData.employerEin | string | |
|
Regular Hours
|
payStubData.regularHours | decimal | |
|
Overtime Hours
|
payStubData.overtimeHours | decimal | |
|
Regular Rate
|
payStubData.regularRate | decimal | |
|
Overtime Rate
|
payStubData.overtimeRate | decimal | |
|
Total Hours
|
payStubData.totalHours | decimal | |
|
Health Insurance
|
payStubData.healthInsurance | decimal | |
|
Retirement 401k
|
payStubData.retirement401k | decimal | |
|
Other Benefits
|
payStubData.otherBenefits | decimal | |
|
Garnishments
|
payStubData.garnishments | decimal | |
|
Ytd Gross Pay
|
payStubData.ytdGrossPay | decimal | |
|
Ytd Net Pay
|
payStubData.ytdNetPay | decimal | |
|
Ytd Federal Tax
|
payStubData.ytdFederalTax | decimal | |
|
Ytd State Tax
|
payStubData.ytdStateTax | decimal | |
|
Check Number
|
payStubData.checkNumber | string | |
|
Direct Deposit Info
|
payStubData.directDepositInfo | string | |
|
Vacation Sick Time
|
payStubData.vacationSickTime | string | |
|
Commission Bonus
|
payStubData.commissionBonus | decimal | |
|
Pay Date
|
payStubData.payDate | string |
Pay date as string |
|
Raw OCR Text
|
payStubData.rawOcrText | string |
Raw OCR text extracted from document |
|
CustomFieldsData
|
payStubData.CustomFieldsData | array of CustomFieldsData |
TaxDocumentResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Tax Form Type
|
taxDocumentData.formType | string |
Type of tax form (W2, 1099, 1040, etc.) |
|
Tax Year
|
taxDocumentData.taxYear | string |
Tax year of the document |
|
Employer Name
|
taxDocumentData.employerName | string |
Employer name from W2 |
|
Employer EIN
|
taxDocumentData.employerEin | string |
Employer Identification Number |
|
Employer Address
|
taxDocumentData.employerAddress | string |
Employer address |
|
Employee Name
|
taxDocumentData.employeeName | string |
Employee name |
|
Employee SSN
|
taxDocumentData.employeeSsn | string |
Employee Social Security Number |
|
Employee Address
|
taxDocumentData.employeeAddress | string |
Employee address |
|
Wages & Tips
|
taxDocumentData.wagesTips | string |
Wages, tips, and other compensation |
|
Social Security Wages
|
taxDocumentData.socialSecurityWages | string |
Social Security wages |
|
SS Tax Withheld
|
taxDocumentData.socialSecurityTaxWithheld | string |
Social Security tax withheld |
|
Medicare Wages
|
taxDocumentData.medicareWages | string |
Medicare wages and tips |
|
Medicare Tax Withheld
|
taxDocumentData.medicareTaxWithheld | string |
Medicare tax withheld |
|
State
|
taxDocumentData.state | string |
State |
|
State Wages
|
taxDocumentData.stateWages | string |
State wages, tips, etc. |
|
State Income Tax
|
taxDocumentData.stateIncomeTax | string |
State income tax withheld |
|
Local Income Tax
|
taxDocumentData.localIncomeTax | string |
Local income tax withheld |
|
Box 12 Codes
|
taxDocumentData.box12Codes | string |
Box 12 codes and amounts |
|
Payer Name
|
taxDocumentData.payerName | string |
Payer name |
|
Payer TIN
|
taxDocumentData.payerTin | string |
Payer TIN |
|
Payer Address
|
taxDocumentData.payerAddress | string |
Payer address |
|
Recipient Name
|
taxDocumentData.recipientName | string |
Recipient name |
|
Recipient TIN
|
taxDocumentData.recipientTin | string |
Recipient TIN |
|
Recipient Address
|
taxDocumentData.recipientAddress | string |
Recipient address |
|
Recipient SSN
|
taxDocumentData.recipientSsn | string |
Recipient SSN |
|
Nonemployee Compensation
|
taxDocumentData.nonemployeeCompensation | string |
Nonemployee compensation amount |
|
Other Income
|
taxDocumentData.otherIncome | string |
Other income |
|
Account Number
|
taxDocumentData.accountNumber | string |
Account number |
|
State Tax Withheld
|
taxDocumentData.stateTaxWithheld | string |
State tax withheld |
|
Benefits Paid
|
taxDocumentData.benefitsPaid | string |
Social Security benefits paid |
|
Tax Withheld
|
taxDocumentData.taxWithheld | string |
Federal tax withheld |
|
Box 7 Voluntary Tax Withheld
|
taxDocumentData.box7VoluntaryFederalIncomeTaxWithheld | string |
Box 7 - Voluntary federal income tax withheld |
|
Box 8 State Tax Withheld
|
taxDocumentData.box8StateTaxWithheld | string |
Box 8 - State tax withheld |
|
Filing Status
|
taxDocumentData.filingStatus | string |
Filing status |
|
Taxpayer Name
|
taxDocumentData.taxpayerName | string |
Taxpayer name |
|
Taxpayer SSN
|
taxDocumentData.taxpayerSsn | string |
Taxpayer SSN |
|
Spouse Name
|
taxDocumentData.spouseName | string |
Spouse name |
|
Spouse SSN
|
taxDocumentData.spouseSsn | string |
Spouse SSN |
|
Address
|
taxDocumentData.address | string |
Address |
|
Wages
|
taxDocumentData.wages | string |
Total wages |
|
Taxable Interest
|
taxDocumentData.taxableInterest | string |
Taxable interest |
|
Tax Exempt Interest
|
taxDocumentData.taxExemptInterest | string |
Tax-exempt interest |
|
Dividends
|
taxDocumentData.dividends | string |
Ordinary dividends |
|
IRA Distributions
|
taxDocumentData.iraDistributions | string |
IRA distributions |
|
Social Security Benefits
|
taxDocumentData.socialSecurityBenefits | string |
Social Security benefits |
|
Total Income
|
taxDocumentData.totalIncome | string |
Total income |
|
Adjusted Gross Income
|
taxDocumentData.adjustedGrossIncome | string |
Adjusted gross income |
|
Standard Deduction
|
taxDocumentData.standardDeduction | string |
Standard deduction |
|
Taxable Income
|
taxDocumentData.taxableIncome | string |
Taxable income |
|
Total Tax
|
taxDocumentData.totalTax | string |
Total tax |
|
Federal Income Tax Withheld
|
taxDocumentData.federalIncomeTaxWithheld | string |
Federal income tax withheld |
|
Refund Amount
|
taxDocumentData.refundAmount | string |
Refund amount |
|
Amount Owed
|
taxDocumentData.amountOwed | string |
Amount owed |
|
Dependents
|
taxDocumentData.dependents | string |
Dependents information (JSON string) |
|
Virtual Currency
|
taxDocumentData.virtualCurrency | string |
Virtual currency transactions |
|
Additional Income
|
taxDocumentData.additionalIncome | string |
Additional income |
|
Adjustments To Income
|
taxDocumentData.adjustmentsToIncome | string |
Adjustments to income |
|
Lender Name
|
taxDocumentData.lenderName | string |
Lender name |
|
Lender TIN
|
taxDocumentData.lenderTin | string |
Lender TIN |
|
Mortgage Interest
|
taxDocumentData.mortgageInterest | string |
Mortgage interest received |
|
Points Paid
|
taxDocumentData.pointsPaid | string |
Points paid on purchase |
|
Refund Overpaid Interest
|
taxDocumentData.refundOverpaidInterest | string |
Refund of overpaid interest |
|
Mortgage Insurance Premiums
|
taxDocumentData.mortgageInsurancePremiums | string |
Mortgage insurance premiums |
|
Property Address
|
taxDocumentData.propertyAddress | string |
Property address |
|
Mortgage Acquisition Date
|
taxDocumentData.mortgageAcquisitionDate | string |
Mortgage acquisition date |
|
Outstanding Mortgage Principal
|
taxDocumentData.outstandingMortgagePrincipal | string |
Outstanding mortgage principal |
|
Borrower Name
|
taxDocumentData.borrowerName | string |
Borrower name |
|
Borrower TIN
|
taxDocumentData.borrowerTin | string |
Borrower TIN |
|
Student Loan Interest Received
|
taxDocumentData.studentLoanInterestReceived | string |
Student loan interest received |
|
Student Name
|
taxDocumentData.studentName | string |
Student name |
|
Student TIN
|
taxDocumentData.studentTin | string |
Student TIN |
|
School Name
|
taxDocumentData.schoolName | string |
School/institution name |
|
School TIN
|
taxDocumentData.schoolTin | string |
School TIN |
|
Qualified Tuition Expenses
|
taxDocumentData.qualifiedTuitionAndRelatedExpenses | string |
Qualified tuition and related expenses |
|
Scholarships Or Grants
|
taxDocumentData.scholarshipsOrGrants | string |
Scholarships or grants |
|
Service Provider TIN
|
taxDocumentData.serviceProviderTin | string |
Service provider TIN |
|
Refunds
|
taxDocumentData.refunds | string |
Refunds or adjustments |
|
Policy Number
|
taxDocumentData.policyNumber | string |
Policy number |
|
Start Date
|
taxDocumentData.startDate | string |
Coverage start date |
|
End Date
|
taxDocumentData.endDate | string |
Coverage end date |
|
Monthly Premium
|
taxDocumentData.monthlyPremium | string |
Monthly premium amount |
|
Advance Payment
|
taxDocumentData.advancePayment | string |
Advance payment of premium tax credit |
|
Issuer Name
|
taxDocumentData.issuerName | string |
Issuer name |
|
Coverage Months
|
taxDocumentData.coverageMonths | string |
Months of coverage |
|
Offer Of Coverage
|
taxDocumentData.offerOfCoverage | string |
Offer of coverage |
|
Safe Harbor
|
taxDocumentData.safeHarbor | string |
Safe harbor code |
|
Offer Of Coverage Code
|
taxDocumentData.offerOfCoverageCode | string |
Offer of coverage code |
|
Employee Share Lowest Cost Premium
|
taxDocumentData.employeeShareOfLowestCostMonthlyPremium | string |
Employee share of lowest cost monthly premium |
|
Multiple Jobs Or Spouse Works
|
taxDocumentData.multipleJobsOrSpouseWorks | string |
Multiple jobs or spouse works indicator |
|
Claim Dependents
|
taxDocumentData.claimDependents | string |
Claim dependents amount |
|
Deductions
|
taxDocumentData.deductions | string |
Deductions |
|
Extra Withholding
|
taxDocumentData.extraWithholding | string |
Extra withholding amount |
|
Step 3 Dependents Total
|
taxDocumentData.step3DependentsTotal | string |
Step 3 dependents total |
|
Step 4a Other Income
|
taxDocumentData.step4aOtherIncome | string |
Step 4a other income |
|
Step 4b Deductions
|
taxDocumentData.step4bDeductions | string |
Step 4b deductions |
|
Income
|
taxDocumentData.income | string |
Total income |
|
Credits
|
taxDocumentData.credits | string |
Tax credits |
|
Total Assets
|
taxDocumentData.totalAssets | string |
Total assets |
|
Liabilities
|
taxDocumentData.liabilities | string |
Liabilities |
|
Investments
|
taxDocumentData.investments | string |
Investments |
|
Raw OCR Text
|
taxDocumentData.rawOcrText | string |
Raw OCR text extracted from document |
|
CustomFieldsData
|
taxDocumentData.CustomFieldsData | array of CustomFieldsData |
MortgageDocumentResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Document Type
|
mortgageDocumentData.documentType | string | |
|
Lender Name
|
mortgageDocumentData.lenderName | string | |
|
Property Address
|
mortgageDocumentData.propertyAddress | string | |
|
Legal Description
|
mortgageDocumentData.legalDescription | string | |
|
Loan Amount
|
mortgageDocumentData.loanAmount | decimal | |
|
Interest Rate
|
mortgageDocumentData.interestRate | decimal | |
|
Loan Term
|
mortgageDocumentData.loanTerm | integer | |
|
Loan Type
|
mortgageDocumentData.loanType | string | |
|
Appraised Value
|
mortgageDocumentData.appraisedValue | decimal | |
|
Effective Date
|
mortgageDocumentData.effectiveDate | date-time | |
|
Borrower Name
|
mortgageDocumentData.borrowerName | string | |
|
Co-Borrower Name
|
mortgageDocumentData.coBorrowerName | string | |
|
Employer Name
|
mortgageDocumentData.employerName | string | |
|
Position
|
mortgageDocumentData.position | string | |
|
Income
|
mortgageDocumentData.income | decimal | |
|
Employment Status
|
mortgageDocumentData.employmentStatus | string | |
|
Employment Start Date
|
mortgageDocumentData.employmentStartDate | date-time | |
|
Appraiser Name
|
mortgageDocumentData.appraiserName | string | |
|
Appraiser License Number
|
mortgageDocumentData.appraiserLicenseNumber | string | |
|
Property Type
|
mortgageDocumentData.propertyType | string | |
|
Condition Rating
|
mortgageDocumentData.conditionRating | string | |
|
Comparable Sales
|
mortgageDocumentData.comparableSales | array of ComparableSale | |
|
Closing Costs
|
mortgageDocumentData.closingCosts | decimal | |
|
Cash To Close
|
mortgageDocumentData.cashToClose | decimal | |
|
Settlement Agent
|
mortgageDocumentData.settlementAgent | string | |
|
Closing Date
|
mortgageDocumentData.closingDate | date-time | |
|
Disbursement Date
|
mortgageDocumentData.disbursementDate | date-time | |
|
Current Owner
|
mortgageDocumentData.currentOwner | string | |
|
Liens And Encumbrances
|
mortgageDocumentData.liensAndEncumbrances | array of string | |
|
Easements
|
mortgageDocumentData.easements | array of string | |
|
Title Insurance Amount
|
mortgageDocumentData.titleInsuranceAmount | decimal | |
|
Property Taxes Status
|
mortgageDocumentData.propertyTaxesStatus | string | |
|
Projected Payments
|
mortgageDocumentData.projectedPayments | array of ProjectedPayment | |
|
Notary Signature Witness
|
mortgageDocumentData.notarySignatureWitness | string | |
|
Control Number
|
mortgageDocumentData.controlNumber | string | |
|
Parish
|
mortgageDocumentData.parish | string | |
|
Currency
|
mortgageDocumentData.currency | string | |
|
Witness Name
|
mortgageDocumentData.witnessName | string | |
|
Witness Type
|
mortgageDocumentData.witnessType | string | |
|
Preparer Company
|
mortgageDocumentData.preparerCompany | string | |
|
Homestead Act Compliance
|
mortgageDocumentData.homesteadActCompliance | string | |
|
Farm Land Act Compliance
|
mortgageDocumentData.farmLandActCompliance | string | |
|
Secures Liabilities
|
mortgageDocumentData.securesLiabilities | string | |
|
Guarantee Mortgage
|
mortgageDocumentData.guaranteeMortgage | string | |
|
Collateral Mortgage
|
mortgageDocumentData.collateralMortgage | string | |
|
CustomFieldsData
|
mortgageDocumentData.CustomFieldsData | array of CustomFieldsData |
ComparableSale
| Name | Path | Type | Description |
|---|---|---|---|
|
Address
|
address | string | |
|
Sale Price
|
salePrice | decimal | |
|
Sale Date
|
saleDate | date-time | |
|
Adjustments
|
adjustments | decimal |
ProjectedPayment
| Name | Path | Type | Description |
|---|---|---|---|
|
Payment Type
|
paymentType | string | |
|
Principal And Interest
|
principalAndInterest | decimal | |
|
Mortgage Insurance
|
mortgageInsurance | decimal | |
|
Estimated Escrow
|
estimatedEscrow | decimal | |
|
Estimated Total Monthly Payment
|
estimatedTotalMonthlyPayment | decimal |
MarriageCertificateResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Certificate Number
|
marriageCertificateData.certificateNumber | string | |
|
Date Of Marriage
|
marriageCertificateData.dateOfMarriage | string | |
|
Place Of Marriage
|
marriageCertificateData.placeOfMarriage | string | |
|
Date Issued
|
marriageCertificateData.dateIssued | string | |
|
Issuing Authority
|
marriageCertificateData.issuingAuthority | string | |
|
Spouse1 Full Name
|
marriageCertificateData.spouse1FullName | string | |
|
Spouse1 Age
|
marriageCertificateData.spouse1Age | integer | |
|
Spouse1 Birth Date
|
marriageCertificateData.spouse1BirthDate | string | |
|
Spouse1 Birth place
|
marriageCertificateData.spouse1Birthplace | string | |
|
Spouse1 Residence Before Marriage
|
marriageCertificateData.spouse1ResidenceBeforeMarriage | string | |
|
Spouse2 Full Name
|
marriageCertificateData.spouse2FullName | string | |
|
Spouse2 Age
|
marriageCertificateData.spouse2Age | integer | |
|
Spouse2 Birth Date
|
marriageCertificateData.spouse2BirthDate | string | |
|
Spouse2 Birth Place
|
marriageCertificateData.spouse2Birthplace | string | |
|
Spouse2 Residence Before Marriage
|
marriageCertificateData.spouse2ResidenceBeforeMarriage | string | |
|
Officiant Name
|
marriageCertificateData.officiantName | string | |
|
Officiant Title
|
marriageCertificateData.officiantTitle | string | |
|
Officiant License Number
|
marriageCertificateData.officiantLicenseNumber | string | |
|
Witnesses
|
marriageCertificateData.witnesses | string |
Names of witnesses (comma-separated if multiple) |
|
Official Seal
|
marriageCertificateData.officialSeal | string | |
|
Signatures Present
|
marriageCertificateData.signaturesPresent | string | |
|
Authenticity Issues
|
marriageCertificateData.authenticityIssues | array of string | |
|
Fraud Indicators
|
marriageCertificateData.fraudIndicators | array of string | |
|
Authenticity Recommendation
|
marriageCertificateData.authenticityRecommendation | string | |
|
Extracted Fields
|
marriageCertificateData.extractedFields | object | |
|
Raw OCR Text
|
marriageCertificateData.rawOcrText | string |
Raw OCR text extracted from document |
|
CustomFieldsData
|
marriageCertificateData.CustomFieldsData | array of CustomFieldsData |
ReceiptResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Receipt Type
|
receiptData.receiptType | string | |
|
Transaction Date
|
receiptData.TransactionDate | string |
Transaction date as string |
|
Transaction Time
|
receiptData.transactionTime | string | |
|
Receipt Number
|
receiptData.receiptNumber | string | |
|
Analyze Items
|
receiptData.analyzeItems | array of ReceiptItem | |
|
Merchant Info List
|
receiptData.merchantInfoList | array of MerchantInfo | |
|
Financial Info List
|
receiptData.financialInfoList | array of FinancialInfo | |
|
Merchant Name
|
receiptData.merchantName | string | |
|
Merchant Address
|
receiptData.merchantAddress | string | |
|
Merchant Phone
|
receiptData.merchantPhone | string | |
|
Merchant Website
|
receiptData.merchantWebsite | string | |
|
Store Number
|
receiptData.storeNumber | string | |
|
Cashier Name
|
receiptData.cashierName | string | |
|
Subtotal
|
receiptData.subtotal | decimal | |
|
Tax Amount
|
receiptData.taxAmount | decimal | |
|
Total Amount
|
receiptData.totalAmount | decimal | |
|
Payment Method
|
receiptData.paymentMethod | string | |
|
Card Last Four
|
receiptData.cardLastFour | string | |
|
Room Number
|
receiptData.roomNumber | string | |
|
Check In Date
|
receiptData.checkInDate | string | |
|
Check Out Date
|
receiptData.checkOutDate | string | |
|
Fuel Type
|
receiptData.fuelType | string | |
|
Fuel Quantity
|
receiptData.fuelQuantity | decimal | |
|
Fuel Unit
|
receiptData.fuelUnit | string | |
|
Vehicle Number
|
receiptData.vehicleNumber | string | |
|
Service Type
|
receiptData.serviceType | string | |
|
Subscription Period
|
receiptData.subscriptionPeriod | string | |
|
Training Provider
|
receiptData.trainingProvider | string | |
|
Course Name
|
receiptData.courseName | string | |
|
Healthcare Provider
|
receiptData.healthcareProvider | string | |
|
Patient Name
|
receiptData.patientName | string | |
|
Insurance Info
|
receiptData.insuranceInfo | string | |
|
Additional Info
|
receiptData.additionalInfo | object | |
|
Raw OCR Text
|
receiptData.rawOcrText | string |
Raw OCR text extracted from document |
|
CustomFieldsData
|
receiptData.CustomFieldsData | array of CustomFieldsData |
ReceiptItem
| Name | Path | Type | Description |
|---|---|---|---|
|
Name
|
name | string | |
|
Quantity
|
quantity | decimal | |
|
Unit Price
|
unitPrice | decimal | |
|
Total Price
|
totalPrice | decimal | |
|
Category
|
category | string | |
|
Description
|
description | string | |
|
Item Code
|
itemCode | string | |
|
Brand
|
brand | string | |
|
Size
|
size | string | |
|
Color
|
color | string | |
|
SKU
|
sku | string |
MerchantInfo
| Name | Path | Type | Description |
|---|---|---|---|
|
Merchant Name
|
merchantName | string | |
|
Merchant Address
|
merchantAddress | string | |
|
Merchant Phone
|
merchantPhone | string | |
|
Merchant Website
|
merchantWebsite | string | |
|
Cashier Name
|
cashierName | string | |
|
Store Number
|
storeNumber | string |
FinancialInfo
| Name | Path | Type | Description |
|---|---|---|---|
|
Subtotal
|
subtotal | decimal | |
|
Tax Amount
|
taxAmount | decimal | |
|
Total Amount
|
totalAmount | decimal | |
|
Payment Method
|
paymentMethod | string | |
|
Card Last Four
|
cardLastFour | string |
OrderResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Sales Order Number
|
orderData.salesOrderNumber | string | |
|
Agent Name
|
orderData.agentName | string | |
|
Department Code
|
orderData.deptCode | string | |
|
Date Of Order
|
orderData.dateOfOrder | string | |
|
Date Required
|
orderData.dateRequired | string | |
|
Category
|
orderData.category | string | |
|
Invoice To Name
|
orderData.invoiceToName | string | |
|
Invoice To Address
|
orderData.invoiceToAddress | string | |
|
Invoice To Post Code
|
orderData.invoiceToPostCode | string | |
|
Invoice To Home Tel
|
orderData.invoiceToHomeTel | string | |
|
Invoice To Mobile
|
orderData.invoiceToMobile | string | |
|
Invoice To Email
|
orderData.invoiceToEmail | string | |
|
Deliver To Name
|
orderData.deliverToName | string | |
|
Deliver To Address
|
orderData.deliverToAddress | string | |
|
Deliver To Post Code
|
orderData.deliverToPostCode | string | |
|
Account Reference
|
orderData.accountReference | string | |
|
New Account
|
orderData.newAccount | boolean | |
|
Products
|
orderData.products | array of OrderProduct | |
|
VAT
|
orderData.vat | decimal | |
|
Total
|
orderData.total | decimal | |
|
Special Instructions
|
orderData.specialInstructions | string | |
|
Stock Information
|
orderData.stockInformation | array of StockInformation | |
|
Grass Silage Details
|
orderData.grassSilageDetails | array of GrassSilageDetail | |
|
Signature
|
orderData.signature | string | |
|
Print Name
|
orderData.printName | string |
OrderProduct
| Name | Path | Type | Description |
|---|---|---|---|
|
Product
|
product | string | |
|
Pack Size
|
packSize | string | |
|
Quantity
|
quantity | integer | |
|
Price Each
|
priceEach | decimal | |
|
Total
|
total | decimal |
StockInformation
| Name | Path | Type | Description |
|---|---|---|---|
|
Type Of Stock
|
typeOfStock | string | |
|
Stock Numbers
|
stockNumbers | integer | |
|
Calving Date
|
calvingDate | string | |
|
Lambing Date
|
lambingDate | string | |
|
Stores Or Finishers
|
storesOrFinishers | integer | |
|
All Year Housing
|
allYearHousing | boolean |
GrassSilageDetail
| Name | Path | Type | Description |
|---|---|---|---|
|
Silage Detail
|
silageDetail | string | |
|
Additive Used
|
additiveUsed | boolean | |
|
Additive Name
|
additiveName | string |
ShippingLabelResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Shipping Carrier
|
shippingLabelData.classification | string | |
|
Tracking Number
|
shippingLabelData.trackingNumber | string | |
|
FedEx Vertical Tracking Number
|
shippingLabelData.fedExVerticalTrackingNumber | string | |
|
Sender Name
|
shippingLabelData.senderName | string | |
|
Sender Street
|
shippingLabelData.senderStreet | string | |
|
Sender City
|
shippingLabelData.senderCity | string | |
|
Sender State
|
shippingLabelData.senderState | string | |
|
Sender Zip Code
|
shippingLabelData.senderZip | string | |
|
Sender Country
|
shippingLabelData.senderCountry | string | |
|
Recipient Name
|
shippingLabelData.recipientName | string | |
|
Recipient Street
|
shippingLabelData.recipientStreet | string | |
|
Recipient City
|
shippingLabelData.recipientCity | string | |
|
Recipient State
|
shippingLabelData.recipientState | string | |
|
Recipient Zip Code
|
shippingLabelData.recipientZip | string | |
|
Recipient Country
|
shippingLabelData.recipientCountry | string | |
|
Service Type
|
shippingLabelData.serviceType | string | |
|
Ship Date
|
shippingLabelData.shipDate | string | |
|
Package Weight
|
shippingLabelData.weight | string | |
|
Package Count
|
shippingLabelData.packageCount | integer | |
|
Reference Numbers
|
shippingLabelData.referenceNumbers | array of string | |
|
Special Instructions
|
shippingLabelData.specialInstructions | string |
UniversalDocumentResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Extracted Data
|
extractedData | array of ExtractedField | |
|
Warnings
|
warnings | array of string | |
|
Fallback Used
|
fallbackUsed | boolean |
ExtractedField
| Name | Path | Type | Description |
|---|---|---|---|
|
Field Key
|
key | string | |
|
Field Value
|
value | string |