opportunity resource type

Represents an opportunity in Business Central.

Note

For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

Methods

MethodReturn TypeDescription
GET opportunityopportunityGets an opportunity object.
DELETE opportunitynoneDeletes an opportunity object.
POST opportunityopportunityCreates an opportunity object.
PATCH opportunityopportunityUpdates an opportunity object.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the opportunity. Non-editable.
numberstringSpecifies the number of the opportunity.
contactNumberstringThe number of the contact.
contactNamestringThe name of the contact.
contactCompanyNamestring
salespersonCodestring
descriptionstringSpecifies the description of the opportunity.
statusNAV.opportunityStatus
closedboolean
creationDatedate
dateCloseddate
calculatedCurrentValuedecimal
chancesOfSuccessPrcdecimal
completedPrcdecimal
estimatedClosingDatedate
estimatedValuedecimal
systemCreatedAtdatetimeThe datetime the company was created.
lastModifiedDateTimedatetimeThe last datetime the opportunity was modified. Read-Only.

JSON representation

Here's a JSON representation of the opportunity resource.

{
    "id": "GUID",
    "number": "string",
    "contactNumber": "string",
    "contactName": "string",
    "contactCompanyName": "string",
    "salespersonCode": "string",
    "description": "string",
    "status": "NAV.opportunityStatus",
    "closed": "boolean",
    "creationDate": "date",
    "dateClosed": "date",
    "calculatedCurrentValue": "decimal",
    "chancesOfSuccessPrc": "decimal",
    "completedPrc": "decimal",
    "estimatedClosingDate": "date",
    "estimatedValue": "decimal",
    "systemCreatedAt": "datetime",
    "lastModifiedDateTime": "datetime"
}

GET opportunity
DELETE opportunity
POST opportunity
PATCH opportunity