Ocrolus API

Ocrolus API Documentation

Welcome to Ocrolus' API Documentation. You'll find comprehensive guides and documentation here to help you get started with the Ocrolus API. Let's jump right in!

Disbursement Form

A disbursement form authorizes payment to be made to a given party.

The form_type parameter DISBURSEMENT_FORM for the Upload PDF endpoint is required for this Form Type.

Optional fields captured

Field data attributed directly to the Disbursement Form is captured as Form Data objects, each one keyed off the following attribute names.

πŸ“˜

Configuration-Driven Output

All fields below are optionally captured, depending on your order form. To adjust fields captured, please speak with your Ocrolus Account Manager.

JSON Attribute

Data Type

Description

disbursement_form-Part1-Member:memberName

Text

Member Name

disbursement_form-Part1-Member:memberId

Text

Member ID

disbursement_form-Part1-Member:methodSent

FAX,MAIL,EMAIL

Method Sent

disbursement_form-Part1-Member:sentFrom

Text

Sent From

disbursement_form-Part1-Member:specialInstructions-CircleOne:

Multiple Choice

ADDRESS CHANGE
ACCOUNT # CHANGE
MAIL TO DIFFERENT ADDRESS
OVERNIGHT ADDRESS

disbursement_form-Part1-Member:specialInstructions-IncludeInstructionsHere:

Text

Special Instructions

disbursement_form-Part2-Disbursement1:bill1-AccountNumber

Text

Bill 1 - Account Number

disbursement_form-Part2-Disbursement1:bill1-Desciption

Text

Bill 1 - Description

disbursement_form-Part2-Disbursement1:bill1-CheckPaybaleTo

Text

Bill 1 - Check Payable To

disbursement_form-Part2-Disbursement1:bill1-BillingAddress:addressLine1

Text

Bill 1 - Address Line 1

disbursement_form-Part2-Disbursement1:bill1-BillingAddress:addressLine2

Text

Bill 1 - Address Line 2

disbursement_form-Part2-Disbursement1:bill1-BillingAddress:city

Text

Bill 1 - Address City

disbursement_form-Part2-Disbursement1:bill1-BillingAddress:state

Text

Bill 1 - Address State (formatted 2 character State code)

disbursement_form-Part2-Disbursement1:bill1-BillingAddress:zip

Text

Bill 1 - Address Zip Code (formatted 5 digit code)

disbursement_form-Part2-Disbursement1:bill1-BillAmount

Money

Bill 1 - Bill Amount

disbursement_form-Part2-Disbursement1:bill1-AmountToBePaid

Money

Bill 1 - Amount to be Paid

disbursement_form-Part3-Disbursement2:bill2-AccountNumber

Text

Bill 2 - Account Number

disbursement_form-Part3-Disbursement2:bill2-Desciption

Text

Bill 2 - Description

disbursement_form-Part3-Disbursement2:bill2-CheckPaybaleTo

Text

Bill 2 - Check Payable To

disbursement_form-Part3-Disbursement2:bill2-BillingAddress:addressLine1

Text

Bill 2 - Address Line 1

disbursement_form-Part3-Disbursement2:bill2-BillingAddress:addressLine2

Text

Bill 2 - Address Line 2

disbursement_form-Part3-Disbursement2:bill2-BillingAddress:city

Text

Bill 2 - Address City

disbursement_form-Part3-Disbursement2:bill2-BillingAddress:state

Text

Bill 2 - Address State (formatted 2 character State code)

disbursement_form-Part3-Disbursement2:bill2-BillingAddress:zip

Text

Bill 2 - Address Zip Code (formatted 5 digit code)

disbursement_form-Part3-Disbursement2:bill2-BillAmount

Money

Bill 2 - Bill Amount

disbursement_form-Part3-Disbursement2:bill2-AmountToBePaid

Money

Bill 2 - Amount to be Paid

disbursement_form-Part4-Disbursement3:bill3-AccountNumber

Text

Bill 3 - Account Number

disbursement_form-Part4-Disbursement3:bill3-Desciption

Text

Bill 3 - Description

disbursement_form-Part4-Disbursement3:bill3-CheckPaybaleTo

Text

Bill 3 - Check Payable To

disbursement_form-Part4-Disbursement3:bill3-BillingAddress:addressLine1

Text

Bill 3 - Address Line 1

disbursement_form-Part4-Disbursement3:bill3-BillingAddress:addressLine2

Text

Bill 3 - Address Line 2

disbursement_form-Part4-Disbursement3:bill3-BillingAddress:city

Text

Bill 3 - Address City

disbursement_form-Part4-Disbursement3:bill3-BillingAddress:state

Text

Bill 3 - Address State (formatted 2 character State code)

disbursement_form-Part4-Disbursement3:bill3-BillingAddress:zip

Text

Bill 3 - Address Zip Code (formatted 5 digit code)

disbursement_form-Part4-Disbursement3:bill3-BillAmount

Money

Bill 3 - Bill Amount

disbursement_form-Part4-Disbursement3:bill3-AmountToBePaid

Money

Bill 3 - Amount to be Paid

disbursement_form-Part5-Disbursement4:bill4-AccountNumber

Text

Bill 4 - Account Number

disbursement_form-Part5-Disbursement4:bill4-Desciption

Text

Bill 4 - Description

disbursement_form-Part5-Disbursement4:bill4-CheckPaybaleTo

Text

Bill 4 - Check Payable To

disbursement_form-Part5-Disbursement4:bill4-BillingAddress:addressLine1

Text

Bill 4 - Address Line 1

disbursement_form-Part5-Disbursement4:bill4-BillingAddress:addressLine2

Text

Bill 4 - Address Line 2

disbursement_form-Part5-Disbursement4:bill4-BillingAddress:city

Text

Bill 4 - Address City

disbursement_form-Part5-Disbursement4:bill4-BillingAddress:state

Text

Bill 4 - Address State (formatted 2 character State code)

disbursement_form-Part5-Disbursement4:bill4-BillingAddress:zip

Text

Bill 4 - Address Zip Code (formatted 5 digit code)

disbursement_form-Part5-Disbursement4:bill4-BillAmount

Money

Bill 4 - Bill Amount

disbursement_form-Part5-Disbursement4:bill4-AmountToBePaid

Money

Bill 4 - Amount to be Paid

Sample Form

The below Ocrolus Sample PDF (input) matches the below Sample JSON Result (output).

Sample JSON Result

{
    "status": 200,
    "message": "OK",
    "response": {
        "forms": [
            {
                "tables": [],
                "form_config_pk": 3629,
                "uuid": "e68667af-f6f9-4889-bf59-080a44c82afb",
                "form_type": "DISBURSEMENT_FORM",
                "pk": 10587757,
                "raw_fields": {
                    "disbursement_form-Part2-Disbursement1:bill1-CheckPayableTo": {
                        "is_empty": false,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "YOGURT INDUSTRIES",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part4-Disbursement3:bill3-CheckPayableTo": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part4-Disbursement3:bill3-AmountToBePaid": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part5-Disbursement4:bill4-AccountNumber": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part1-Member:specialInstructions-IncludeInstructionsHere:": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part3-Disbursement2:bill2-AmountToBePaid": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part5-Disbursement4:bill4-BillAmount": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part5-Disbursement4:bill4-BillingAddress:state": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part4-Disbursement3:bill3-AccountNumber": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part2-Disbursement1:bill1-Description": {
                        "is_empty": false,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "AUTO SCENT",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part2-Disbursement1:bill1-AccountNumber": {
                        "is_empty": false,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "53648561",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part1-Member:specialInstructions-CircleOne:": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part4-Disbursement3:bill3-BillingAddress:addressLine2": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part4-Disbursement3:bill3-BillingAddress:addressLine1": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part2-Disbursement1:bill1-BillingAddress:addressLine1": {
                        "is_empty": false,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "750 MIDDLE COUNTRY ROAD",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part2-Disbursement1:bill1-BillingAddress:addressLine2": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part5-Disbursement4:bill4-BillingAddress:city": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part1-Member:sentFrom": {
                        "is_empty": false,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "ALVARO JEFFRY",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part1-Member:memberName": {
                        "is_empty": false,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "JAMES ROBERT",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part3-Disbursement2:bill2-AccountNumber": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part3-Disbursement2:bill2-BillingAddress:city": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part4-Disbursement3:bill3-BillAmount": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part3-Disbursement2:bill2-CheckPayableTo": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part5-Disbursement4:bill4-CheckPayableTo": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part1-Member:memberId": {
                        "is_empty": false,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "AF2486",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part2-Disbursement1:bill1-BillingAddress:zip": {
                        "is_empty": false,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "11953",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part4-Disbursement3:bill3-Description": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part3-Disbursement2:bill2-BillingAddress:zip": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part2-Disbursement1:bill1-BillingAddress:state": {
                        "is_empty": false,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "NY",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part2-Disbursement1:bill1-BillingAddress:city": {
                        "is_empty": false,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "MIDDLE ISLAND",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part5-Disbursement4:bill4-AmountToBePaid": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part5-Disbursement4:bill4-Description": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part5-Disbursement4:bill4-BillingAddress:zip": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part5-Disbursement4:bill4-BillingAddress:addressLine2": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part5-Disbursement4:bill4-BillingAddress:addressLine1": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part3-Disbursement2:bill2-BillingAddress:addressLine1": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part3-Disbursement2:bill2-BillingAddress:addressLine2": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part2-Disbursement1:bill1-AmountToBePaid": {
                        "is_empty": false,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "167.80",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part4-Disbursement3:bill3-BillingAddress:state": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part3-Disbursement2:bill2-Description": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part1-Member:methodSent": {
                        "is_empty": false,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "EMAIL",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part4-Disbursement3:bill3-BillingAddress:city": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part3-Disbursement2:bill2-BillAmount": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part2-Disbursement1:bill1-BillAmount": {
                        "is_empty": false,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "167.80",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part4-Disbursement3:bill3-BillingAddress:zip": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    },
                    "disbursement_form-Part3-Disbursement2:bill2-BillingAddress:state": {
                        "is_empty": true,
                        "source_filename": "Sample 1 - Disbursement Form (1).pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87761462
                    }
                }
            }
        ],
        "pk": 11534533,
        "uuid": "cfc3806c-360b-490f-92e0-bd6b64076e3f"
    }
}

Updated 7 days ago

Disbursement Form


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.