Opportunities
Retrieve all opportunities
API Reference Overview
Authentication
Consumers
Connections
Accounting
- Folders
- Book years
- Clients
- Suppliers
- Invoices
- Ledger accounts
- Journals
- Journal entries
- Employees
- Analytic plans
- Analytic accounts
- Miscellaneous operations
- Outstandings
Invoicing
- Contacts
- Invoices
- Products
- Taxes
- Opportunities
- Payments
- Payment methods
POS
- Orders
- Payment methods
- Payments
- Closure info
- Locations
- Products
- Categories
- Customers
eCommerce
- Orders
- Products & variants
- Categories
- Customers
- Payment methods
- Locations
- Countries
- Taxes
PMS
- Orders
- Invoices
- Payment methods
- Payments
- Closure info
- Locations
- Categories
- Customers
Payment
- Payments
- Balances
- Transactions
- Refunds
Banking
- Financial institutions
- Banking accounts
- Transactions
Advanced
- Webhooks
- Syncs
- Issues
- Datastores
Opportunities
Retrieve all opportunities
Returns a list of all the opportunities
GET
/
consumers
/
{consumer_id}
/
invoicing
/
opportunities
curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/invoicing/opportunities \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"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>"
}
}
],
"total": 1,
"page": 2,
"size": 2
}
Authorizations
This access token needs to be included in each of your request to the Chift API.
Path Parameters
Query Parameters
Required range:
x >= 1
Required range:
1 <= x <= 100
Response
200
application/json
Successful Response
Technical id in Chift
Name
Total
Probability of success
Status
Available options:
open
, won
, lost
, cancelled
, closed
Technical id of the customer in Chift
Comment
Currency matching target sofware name
Description
Current stage in pipeline
Pipeline name
Date creation
Due Date
End Date
Is won?
Required range:
x >= 0
Required range:
x >= 1
Required range:
x >= 1
curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/invoicing/opportunities \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"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>"
}
}
],
"total": 1,
"page": 2,
"size": 2
}