Retrieve one opportunity

curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/invoicing/opportunities/{opportunity_id}

const options = {method: 'GET'};

fetch('https://api.chift.eu/consumers/{consumer_id}/invoicing/opportunities/{opportunity_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chift.eu/consumers/{consumer_id}/invoicing/opportunities/{opportunity_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chift.eu/consumers/{consumer_id}/invoicing/opportunities/{opportunity_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/consumers/{consumer_id}/invoicing/opportunities/{opportunity_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "source_ref": {
    "id": "<string>",
    "model": "<string>"
  },
  "name": "<string>",
  "total": 123,
  "probability": 123,
  "status": "open",
  "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>"
  }
}

{
  "message": "Error while trying to perform your request",
  "status": "error"
}

{
  "message": "The opportunity doesn't exist in the invoicing system.",
  "status": "error",
  "error_code": "ERROR_OPPORTUNITY_NOT_FOUND"
}

{
  "message": "Validation error",
  "status": "error",
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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}

const options = {method: 'GET'};

fetch('https://api.chift.eu/consumers/{consumer_id}/invoicing/opportunities/{opportunity_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chift.eu/consumers/{consumer_id}/invoicing/opportunities/{opportunity_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chift.eu/consumers/{consumer_id}/invoicing/opportunities/{opportunity_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/consumers/{consumer_id}/invoicing/opportunities/{opportunity_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "source_ref": {
    "id": "<string>",
    "model": "<string>"
  },
  "name": "<string>",
  "total": 123,
  "probability": 123,
  "status": "open",
  "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>"
  }
}

{
  "message": "Error while trying to perform your request",
  "status": "error"
}

{
  "message": "The opportunity doesn't exist in the invoicing system.",
  "status": "error",
  "error_code": "ERROR_OPPORTUNITY_NOT_FOUND"
}

{
  "message": "Validation error",
  "status": "error",
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Learn more:

What is an opportunity? ↗

Path Parameters

consumer_id

string<uuid>

required

opportunity_id

string

required

Response

Successful Response

string

required

Technical id in Chift

source_ref

Ref · object

required

Technical id in the target software

Show child attributes

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 | null

Employee/User

Show child attributes

API Reference Overview

Access & Connections

Accounting

Invoicing

POS

eCommerce

PMS

Payment

Banking

Other

Retrieve one opportunity

Path Parameters

Response