API Reference

Upload Order

post
https://api.lumos.com/orders

Upload a newly discovered document (e.g. Order Form, Quote) to Lumos

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

A unique ID for the contract being uploaded. This can be an ID from an external system like Ironclad, an internal ID such as a PO number, or simply the name of the vendor + date of the contract.

vendor
object
required

Information about the vendor associated with this contract. Currently, we will only support a name field.

date
required

The start date of the attached contract

date
required

The end date of the attached contract

The date by which a vendor must be notified before terminating the order

boolean
required

Whether or not the contract auto-renews

The currency in which the contract is being paid in ISO 4217 format

line_items
array of objects
required

The list of currently active line items for this Vendor Agreement. If there are no currently active line items, the most recent set of line items is returned.

Line Items*
custom_attributes
object

Any additional attributes that you would like to save on the Order. The set of available options must be configured in advance in Lumos.

UUID of the application in Lumos where this order was sourced (e.g. the ID of Ironclad within Lumos)

Responses

Updated 10 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago