Skip to main content
GET
/
consumers
/
{consumer_id}
/
invoicing
/
opportunities
/
{opportunity_id}
Retrieve one opportunity
curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/invoicing/opportunities/{opportunity_id}
{
  "id": "<string>",
  "source_ref": {
    "id": "<string>",
    "model": "<string>"
  },
  "name": "<string>",
  "total": 123,
  "probability": 123,
  "partner_id": "<string>",
  "comment": "<string>",
  "currency": "<string>",
  "description": "<string>",
  "pipe_status": "<string>",
  "pipe_name": "<string>",
  "created_date": "2023-12-25",
  "due_date": "2023-12-25",
  "end_date": "2023-12-25",
  "is_won": true,
  "owner_ref": {
    "id": "<string>",
    "model": "<string>",
    "name": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.chift.eu/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
consumer_id
string<uuid>
required
​
opportunity_id
string
required

Response

Successful Response

​
id
string
required

Technical id in Chift

​
source_ref
Ref · object
required

Technical id in the target software

​
name
string
required

Name

​
total
number
required

Total

​
probability
number
required

Probability of success

​
status
enum<string>
required

Status

Available options:
open,
won,
lost,
cancelled,
closed
​
partner_id
string | null

Technical id of the customer in Chift

​
comment
string | null

Comment

​
currency
string | null

Currency matching target sofware name

​
description
string | null

Description

​
pipe_status
string | null

Current stage in pipeline

​
pipe_name
string | null

Pipeline name

​
created_date
string<date> | null

Date creation

​
due_date
string<date> | null

Due Date

​
end_date
string<date> | null

End Date

​
is_won
boolean | null

Is won?

​
owner_ref
FieldRef · object

Employee/User