Ocrolus API

Ocrolus API Documentation

Welcome to the 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!

Rent Bills

Rent bills are a type of invoice issued by the owner of a property to the entity renting that property. Rent bills contain information such as the month being rented, payment terms and parties involved in the rental agreement.

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

Optional fields captured

📘

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

rent_bills-part1:invoicerEntityName

Text

Name of the entity who owns/services the rented location

rent_bills-part1:invoicerAddress:addressLine1

Text

Address of the entity who owns/services the rented location

rent_bills-part1:invoicerAddress:addressLine2

Text

Address 2 of the entity who owns/services the rented location

rent_bills-part1:invoicerAddress:city

Text

City of the entity who owns/services the rented location

rent_bills-part1:invoicerAddress:state

Text

State of the entity who owns/services the rented locaiton

rent_bills-part1:invoicerAddress:zip

Text

Zip of the entity who owns/services the rented vacation

rent_bills-part1:invoicerPhoneNumber

Text

Phone number for the location owner/servicer

rent_bills-part2:renterName

Text

Name of the entity renting the location

rent_bills-part2:renterAddress:addressLine1

Text

Address of the entity renting the locaiton

rent_bills-part2:renterAddress:addressLine2

Text

Address 2 of the entity renting the locaiton

rent_bills-part2:renterAddress:city

Text

City in which the entitiy rentiing the location resides

rent_bills-part2:renterAddress:state

Text

State in which the entity renting the location resides

rent_bills-part2:renterAddress:zip

Text

Zip in which the entity renting the locaiton resides

rent_bills-part3:invoicedAccountNumber

Text

Account number of the renting entity with the property owner

rent_bills-part3:invoiceDate

Date

Date invoice was generated

rent_bills-part3:invoiceDueDate

Date

Date invoice amount is due

rent_bills-part3:priorPaymentPostingDate

Date

Date prior payment posted

rent_bills-part3:priorPaymentTotalPaid

Money

Prior total amount paid

rent_bills-part3:invoiceBalanceDue

Money

Total amount due

rent_bills-part3:invoiceNumber

Text

Serial number of the invoice

rent_bills-part4:addressOfRentedLocation:addressLine1

Text

Address of the property being rented

rent_bills-part4:addressOfRentedLocation:addressLine2

Text

Address 2 of the property being rented

rent_bills-part4:addressOfRentedLocation:city

Text

City in which the rented property resides

rent_bills-part4:addressOfRentedLocation:state

Text

State in which the rented property resides

rent_bills-part4:addressOfRentedLocation:zip

Text

Zip in which the rented property resides

rent_bills-part4:utilitiesIncluded?

YES
NO

Boolean if utilites are inclided in the invoice

rent_bills-part4:monthBeingRented

JANUARY
FEBRUARY
MARCH
APRIL
MAY
JUNE
JULY
AUGUST
SEPTEMBER
OCTOBER
NOVEMBER
DECEMBER

Month for which the rent is for

rent_bills-part4:payableTo

Text

Entity check should be made payable to

Sample Form

Sample JSON Result

{
  "form_type": "RENT_BILLS",
  "pk": 7890902,
  "form_config_pk": 2348,
  "raw_fields": {
    "rent_bills-part1:invoicerAddress:addressLine1": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "18 TIGER HWY"
    },
    "rent_bills-part1:invoicerAddress:addressLine2": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": ""
    },
    "rent_bills-part1:invoicerAddress:city": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "EAST  FALMOUTH"
    },
    "rent_bills-part1:invoicerAddress:state": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "MA"
    },
    "rent_bills-part1:invoicerAddress:zip": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "15100"
    },
    "rent_bills-part1:invoicerPhoneNumber": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "(997) 450-1101"
    },
    "rent_bills-part2:renterAddress:addressLine1": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "180 GREENTREE ROAD,"
    },
    "rent_bills-part2:renterAddress:addressLine2": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": ""
    },
    "rent_bills-part2:renterAddress:city": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "LEOMINSTER"
    },
    "rent_bills-part2:renterAddress:state": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "MA"
    },
    "rent_bills-part2:renterAddress:zip": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "14535"
    },
    "rent_bills-part2:renterName": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "MEH KING LLC"
    },
    "rent_bills-part3:invoiceDate": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "10/01/2019"
    },
    "rent_bills-part3:invoiceDueDate": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "10/15/2019"
    },
    "rent_bills-part3:invoicedAccountNumber": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "1002598"
    },
    "rent_bills-part3:priorPaymentPostingDate": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "09/15/2019"
    },
    "rent_bills-part3:priorPaymentTotalPaid": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "4658.00"
    },
    "rent_bills-part4:addressOfRentedLocation:addressLine1": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "2 DEN HWY EAST"
    },
    "rent_bills-part4:addressOfRentedLocation:addressLine2": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": ""
    },
    "rent_bills-part4:addressOfRentedLocation:city": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "LEOMINSTER"
    },
    "rent_bills-part4:addressOfRentedLocation:state": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "MA"
    },
    "rent_bills-part4:addressOfRentedLocation:zip": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "14535"
    },
    "rent_bills-part4:monthBeingRented": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "SEPTEMBER"
    },
    "rent_bills-part4:payableTo": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": ""
    },
    "rent_bills-part4:utilitiesIncluded?": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72860854,
      "source_filename": "Ocrolus Sample PDF - Rent Bills.pdf",
      "value": "YES"
    }
  },
  "tables": []
}

Updated 2 months ago

Rent Bills


Suggested Edits are limited on API Reference Pages

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