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
- VAT codes
- Attachments
Invoicing
- Contacts
- Invoices
- Products
- Taxes
- Opportunities
- Payments
- Payment methods
POS
- Orders
- Payment methods
- Payments
- Closure info
- Locations
- Products
- Categories
- Customers
- Objectives
eCommerce
- Orders
- Products & variants
- Categories
- Customers
- Payment methods
- Locations
- Countries
- Taxes
PMS
- Orders
- Invoices
- Payment methods
- Payments
- Closure info
- Locations
- Categories
- Customers
- Taxes
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
Page number
Required range:
x >= 1
Page size
Required range:
1 <= x <= 100
Response
200
application/json
Successful Response
The response is of type object
.
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
}
Assistant
Responses are generated using AI and may contain mistakes.