Create an opportunity
current_rms_create_opportunityCreate an opportunity (a rental job) as an Enquiry, Draft or Quotation. store_id is required (see current_rms_list_stores); set member_id for the customer and starts_at/ends_at for the job dates. Line items are added in Current RMS. Current RMS: POST /opportunities.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| state | No | 0 = Enquiry, 1 = Draft, 2 = Quotation. Converting to an Order is left to Current RMS. | |
| rating | No | Rating, 0-5. | |
| ends_at | No | Overall end / collection date-time (UTC). | |
| subject | No | The opportunity's subject (title). | |
| owned_by | No | User member id of the owner. | |
| store_id | Yes | The store the job is served from. | |
| tag_list | No | Tags. | |
| venue_id | No | The Venue member id. | |
| member_id | No | The customer (Organisation/Contact member) id. | |
| reference | No | Customer reference, e.g. their PO number. | |
| starts_at | No | Overall start / delivery date-time (UTC). | |
| project_id | No | The project this opportunity belongs to. | |
| description | No | Internal description. | |
| custom_fields | No | Custom field values by field name. | |
| charge_ends_at | No | Charging period end (UTC). | |
| charge_starts_at | No | Charging period start (UTC). | |
| billing_address_id | No | The member's address id used for billing. | |
| customer_returning | No | The customer returns the goods themselves. | |
| customer_collecting | No | The customer collects the goods themselves. | |
| external_description | No | Description shown on customer documents. | |
| delivery_instructions | No | Delivery instructions. | |
| collection_instructions | No | Collection instructions. |