opportunity resource type

  • Article

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

Method Return Type Description
GET opportunity opportunity Gets a opportunity object.
DELETE opportunity none Deletes a opportunity object.
POST opportunity opportunity Creates a opportunity object.
PATCH opportunity opportunity Updates a opportunity object.

Properties

Property Type Description
id GUID The unique ID of the opportunity. Non-editable.
number string Specifies the number of the opportunity.
contactNumber string The number of the contact.
contactName string The name of the contact.
contactCompanyName string
salespersonCode string
description string Specifies the description of the opportunity.
status NAV.opportunityStatus
closed boolean
creationDate date
dateClosed date
calculatedCurrentValue decimal
chancesOfSuccessPrc decimal
completedPrc decimal
estimatedClosingDate date
estimatedValue decimal
systemCreatedAt datetime The datetime the company was created.
lastModifiedDateTime datetime The last datetime the opportunity was modified. Read-Only.

JSON representation

Here is 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