Skip to content
aimrack

getOpportunity

READ

Get opportunity.

POST /api/v1/sales/getOpportunity
curl -X POST '<your-host>/api/v1/sales/getOpportunity' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "opportunityId": "string"
  }'
Response
{
  "id": "string",
  "companyId": "string",
  "purchaseOrderDocumentPath": "string",
  "requestForQuoteDocumentPath": "string",
  "salesRfqs": [
    {
      "assignee": "string",
      "companyId": "string",
      "completedDate": "string",
      "createdAt": "string",
      "createdBy": "string",
      "customerContactId": "string",
      "customerEngineeringContactId": "string",
      "customerId": "string",
      "customerLocationId": "string",
      "customerReference": "string",
      "customFields": "…",
      "employeeId": "string",
      "expirationDate": "string",
      "externalNotes": "…",
      "id": "string",
      "internalNotes": "…",
      "locationId": "string",
      "locationName": "string",
      "noQuoteReasonId": "string",
      "opportunityId": "string",
      "revisionId": 0,
      "rfqDate": "string",
      "rfqId": "string",
      "salesPersonId": "string",
      "status": "Closed",
      "tags": [
        "string"
      ],
      "updatedAt": "string",
      "updatedBy": "string"
    }
  ],
  "quotes": [
    {
      "assignee": "string",
      "companyId": "string",
      "completedDate": "string",
      "completedLines": 0,
      "createdAt": "string",
      "createdBy": "string",
      "currencyCode": "string",
      "customerContactId": "string",
      "customerEngineeringContactId": "string",
      "customerId": "string",
      "customerLocationId": "string",
      "customerReference": "string",
      "customFields": "…",
      "digitalQuoteAcceptedBy": "string",
      "digitalQuoteAcceptedByEmail": "string",
      "digitalQuoteRejectedBy": "string",
      "digitalQuoteRejectedByEmail": "string",
      "dueDate": "string",
      "estimatorId": "string",
      "exchangeRate": 0,
      "exchangeRateUpdatedAt": "string",
      "expirationDate": "string",
      "externalLinkId": "string",
      "externalNotes": "…",
      "id": "string",
      "internalNotes": "…",
      "itemType": "Part",
      "lines": 0,
      "locationId": "string",
      "locationName": "string",
      "opportunityId": "string",
      "quoteId": "string",
      "revisionId": 0,
      "salesPersonId": "string",
      "shippingCost": 0,
      "status": "Cancelled",
      "tags": [
        "string"
      ],
      "thumbnailPath": "string",
      "updatedAt": "string",
      "updatedBy": "string"
    }
  ],
  "salesOrders": [
    {
      "assignee": "string",
      "closedAt": "string",
      "closedBy": "string",
      "companyId": "string",
      "completedDate": "string",
      "createdAt": "string",
      "createdBy": "string",
      "currencyCode": "string",
      "customerContactId": "string",
      "customerEngineeringContactId": "string",
      "customerId": "string",
      "customerLocationId": "string",
      "customerReference": "string",
      "customFields": "…",
      "displayStatus": "Closed",
      "dropShipment": true,
      "exchangeRate": 0,
      "exchangeRateUpdatedAt": "string",
      "externalId": "…",
      "externalNotes": "…",
      "id": "string",
      "incoterm": "EXW",
      "incotermLocation": "string",
      "internalNotes": "…",
      "itemType": "Part",
      "jobs": [
        "…"
      ],
      "lines": [
        "…"
      ],
      "locationId": "string",
      "opportunityId": "string",
      "orderDate": "string",
      "orderTotal": 0,
      "paymentTermId": "string",
      "receiptPromisedDate": "string",
      "receiptRequestedDate": "string",
      "revisionId": 0,
      "salesOrderId": "string",
      "salesPersonId": "string",
      "sentCompleteDate": "string",
      "shippingCost": 0,
      "shippingMethodId": "string",
      "shippingTermName": "string",
      "status": "Closed",
      "thumbnailPath": "string",
      "updatedAt": "string",
      "updatedBy": "string"
    }
  ]
}

Parameters

ParameterType

Input schema

schema
{
  "type": "object",
  "properties": {
    "opportunityId": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "opportunityId"
  ]
}