Rev.io Developers

Integrate with Rev.io through our REST API.

Get Started

Required Fields

Mandatory request parameters.

Most actions have at least one required field, a parameter you must pass a value for.

In the API explorer, many required fields are marked as such. However, some actions share a set of parameters but have different required fields. Right now, these are not marked as required in the explorer, so we've made an effort to list them here.

πŸ“˜

Are we missing a required field? Help us add it!

Creation

The fields below are currently required when creating the specified resources.

Customers

Field name

Sample JSON

finance.bill_profile_id

"finance":{"bill_profile_id":1000}

service_address.company_name

OR

service_address.first_name AND service_address.last_name

"service_address":{"company_name":"Company A"}

OR

"service_address":{"first_name":"John"} AND "service_address":{"last_name":"Smith"}

service_address.line_1

"service_address":{"line_1":"123 Main St"}

service_address.city

"service_address":{"city":"New York"}

service_address.state_or_province

"service_address":{"state_or_province":"NY"}

service_address.postal_code

"service_address":{"postal_code":"10001"}

service_address.country_code

"service_address":{"country_code":"USA"}

billing_address.company_name

OR

billing_address.first_name AND billing_address.last_name

"billing_address":{"company_name":"Company A"}

OR

"billing_address":{"first_name":"John"} AND "billing_address":{"last_name":"Smith"}

billing_address.line_1

"billing_address":{"line_1":"123 Main St"}

billing_address.city

"billing_address":{"line_1":"123 Main St"}

billing_address.state_or_province

"billing_address":{"state_or_province":"NY"}

billing_address.postal_code

"billing_address":{"postal_code":"10001"}

billing_address.country_code

"billing_address":{"country_code":"USA"}

Requests

Field name

Sample JSON

request_status_id

"request_status_id":5

customer_id

"customer_id":201001

process_id

"process_id":34

Request contacts

Field name

Sample JSON

request_id

"request_id": 42

contact_id

"contact_id": 1944

Request products

Field name

Sample JSON

request_service_id

"request_service_id":56

request_id

"request_id":42

product_id

"product_id":540

quantity

"quantity":1

Request services

Field name

Sample JSON

request_address_id

"request_address_id":23

request_id

"request_id":42

service_type_id

"service_type_id":96

provider_id

"provider_id":1000

Updated 3 years ago

Required Fields


Mandatory request parameters.

Suggested Edits are limited on API Reference Pages

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