Aritic Sales CRM API Doc
Welcome to the Aritic CRM API documentation! To simplify a developer's work, we at Aritic CRM have built developer-friendly APIs which are supported by the major programming languages to interact with your CRM instance.
We have language bindings for PHP, Java, Shell, Ruby and Python! You can view code examples on the right side of this page and use the top right tabs to switch between different programming languages.
Our APIs work over the HTTP protocol with JSON and build in an RPC-like manner, and you can do anything with the API's using their particular action provided. All the HTTP requests must be made over HTTPS URL given in the action defined in this documentation. All responses you receive from the API will return in JSON.
Requests should be made using the POST method with any parameters encoded as JSON in the body of the request.
Authentication
Basic Authentication Key
To use Aritic Sales CRM api you will be needing Access Token.
Go to top right corner next to your profile avatar image and select Settings then click API Settings. Click on Show Access Token and copy your access token.
Invoices
You can create the new invoices. And edit, update the existing invoices on Aritic CRM.
Create new Invoice
Creating the new Invoices
HTTP Request
POST /api/v1/invoices
Response
Expected Response Code: 200
Invoice Properties
| Name | Type | Description |
|---|---|---|
| reference_no | optional | Invoice reference code |
| title | optional | Invoice title |
| client_id | required | Invoice client ID |
| due_date | required | Invoice due date |
| currency | required | Invoice currency |
| notes | optional | Invoice notes |
| tax | optional | Invoice tax 1 percentage |
| tax2 | optional | Invoice tax 2 percentage |
| extra_fe | optional | Invoice extra fee percentage |
| discount | optional | Invoice discount percentage |
| project_i | optional | Project ID related to invoic |
| is_visible | optional | Set to 0 to hide invoice from client |
| line_items[] | optional | Array of invoice items |
| tags[] | optional | Array list of tags e.g tags[design] |
Get Invoices
You can get the Invoices information using the Invoice ID
{
"type": "invoices",
"id": "2",
"attributes": {
"id": 2,
"reference_no": "INV-20190524-0002",
"title": "",
"due_date": "2019-06-08T00:00:00+03:00",
"tax": "87.00",
"tax2": "0.00",
"discount": "0.00",
"currency": "INR",
"extra_fee": "50.00",
"status": "Not Paid",
"payable": "0.00",
"tax_total": "0.00",
"paid_amount": "0.00",
"late_fee": "10.00",
"balance": "0.00",
"business": {
"id": 2,
"name": "Monica",
"contact_person": "monica@dataaegis.com"
},
"created_at": "2019-05-24T10:06:50+03:00",
"updated_at": "2019-05-24T10:06:50+03:00"
}
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxx.aritic.com/acrm/api/v1/invoices/2")
.get()
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxx.aritic.com/acrm/api/v1/invoices/2",
"method": "GET",
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
},
"processData": false,
"data": ""
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxx.aritic.com/acrm/api/v1/invoices/2');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token,
'Content-Type' => 'application/json'
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxx.aritic.com/acrm/api/v1/invoices/2"
payload = ""
headers = {
'Content-Type': "application/json",
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxx.aritic.com/acrm/api/v1/invoices/2")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxx.aritic.com/acrm/api/v1/invoices/2 \
--header 'Authorization: Bearer your_access_token' \
--header 'Content-Type: application/json' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/invoices/{id}
Response
Expected Response Code: 200
Update Invoices
Updates the information to existing invoice.
HTTP Request
PUT /api/v1/invoices/{id}
Response
Expected Response Code: 200
Invoice Parameters
| Name | Type | Description |
|---|---|---|
| id | required | Invoice ID |
| reference_no | optional | Invoice reference code |
| title | optional | Invoice title |
| client_id | required | Invoice client ID |
| due_date | required | Invoice due date |
| notes | optional | Invoice notes |
| tax | optional | Invoice tax 1 percentage |
| tax2 | optional | Invoice tax 2 percentage |
| extra_fee | optional | Invoice extra fee percentage |
| discount | optional | Invoice discount percentage |
| project_id | optional | Project ID related to invoic |
| is_visible | optional | Set to 0 to hide invoice from client |
| line_items[] | optional | Array of invoice items |
Delete Invoice
Delete the invoice information using invoice Id.
{
"message": "Record will be deleted in a moment",
"redirect": "https://xxxxxxx.aritic.com/acrm/invoices",
"success": true
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxx.aritic.com/acrm/api/v1/invoices/2")
.delete(null)
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxx.aritic.com/acrm/api/v1/invoices/2",
"method": "DELETE",
"headers": {
"Authorization": "Bearer your_access_token",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/invoices/2');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxx.aritic.com/acrm/api/v1/invoices/2"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("DELETE", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxx.aritic.com/acrm/api/v1/invoices/2")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Delete.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request DELETE \
--url https://xxxx.aritic.com/acrm/api/v1/invoices/2 \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
DELETE /api/v1/invoices/{id}
Response
Expected Response Code: 200
List all Invoices
List the all invoices information
{
"data": [
{
"type": "invoices",
"id": "2",
"attributes": {
"id": 2,
"reference_no": "INV-20190524-0002",
"title": "",
"due_date": "2019-06-08T00:00:00+03:00",
"tax": "87.00",
"tax2": "0.00",
"discount": "0.00",
"currency": "INR",
"extra_fee": "50.00",
"status": "Not Paid",
"payable": "0.00",
"tax_total": "0.00",
"paid_amount": "0.00",
"late_fee": "10.00",
"balance": "0.00",
"business": {
"id": 2,
"name": "Monica",
"contact_person": "monica@dataaegis.com"
},
"created_at": "2019-05-24T10:06:50+03:00",
"updated_at": "2019-05-24T10:06:50+03:00"
}
},
{
"type": "invoices",
"id": "1",
"attributes": {
"id": 1,
"reference_no": "INV-20190521-0001",
"title": "",
"due_date": "2019-06-05T00:00:00+03:00",
"tax": "0.00",
"tax2": "0.00",
"discount": "0.00",
"currency": "USD",
"extra_fee": "0.00",
"status": "Not Paid",
"payable": "0.00",
"tax_total": "0.00",
"paid_amount": "0.00",
"late_fee": "10.00",
"balance": "0.00",
"business": {
"id": 1,
"name": "Arul",
"contact_person": "prem@dataaegis.com"
},
"created_at": "2019-05-21T21:14:39+03:00",
"updated_at": "2019-05-21T21:14:39+03:00"
}
}
]
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxx.aritic.com/acrm/api/v1/invoices")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxx.aritic.com/acrm/api/v1/invoices",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
require 'uri'
require 'net/http'
url = URI("https://xxxxx.aritic.com/acrm/api/v1/invoices")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/invoices');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
curl --request GET \
--url https://xxxxx.aritic.com/acrm/api/v1/invoices \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
import requests
url = "https://xxxxx.aritic.com/acrm/api/v1/invoices"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
HTTP Request
GET /api/v1/invoices/
Response
Expected Response Code: 200
Show Invoice Payments
Shows the Invoices of all payments
{
"data": []
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxx.aritic.com/acrm/api/v1/invoices/1/payments")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxx.aritic.com/acrm/api/v1/invoices/1/payments",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/invoices/1/payments');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
require 'uri'
require 'net/http'
url = URI("https://xxxxx.aritic.com/acrm/api/v1/invoices/1/payments")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
import requests
url = "https://xxxxx.aritic.com/acrm/api/v1/invoices/1/payments"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
print(response.text)
curl --request GET \
--url https://xxxx.aritic.com/acrm/api/v1/invoices/1/payments \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/invoices/{id}/payments
Response
Expected Response Code: 200
Show Invoice Comments
Shows the Invoice comments
{
"data": []
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxx.aritic.com/acrm/api/v1/invoices/2/comments")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxx.aritic.com/acrm/api/v1/invoices/2/comments",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/invoices/2/comments');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
require 'uri'
require 'net/http'
url = URI("https://xxxx.aritic.com/acrm/api/v1/invoices/2/comments")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
import requests
url = "https://xxxxx.aritic.com/acrm/api/v1/invoices/2/comments"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
curl --request GET \
--url https://xxxxx.aritic.com/acrm/api/v1/invoices/2/comments \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/invoices/{id}/comments
Response
Expected Response Code: 200
Show Invoice Products
Shows the Invoice product lines
{
"data": []
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxx.aritic.com/acrm/api/v1/invoices/1/items")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxx.aritic.com/acrm/api/v1/invoices/1/items",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/invoices/1/items');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
require 'uri'
require 'net/http'
url = URI("https://xxxx.aritic.com/acrm/api/v1/invoices/1/items")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
import requests
url = "https://xxxxx.aritic.com/acrm/api/v1/invoices/1/items"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
curl --request GET \
--url https://xxxx.aritic.com/acrm/api/v1/invoices/1/items \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/invoices/{id}/items
Response
Expected Response Code: 200
Leads
Create Lead
Creates a new Leads
HTTP Request
POST /api/v1/leads
Response
Expected Response Code: 200
Leads Parameters
| Name | Required | Description |
|---|---|---|
| required | Email address | |
| name | optional | Full Names |
| source | required | Lead source ID |
| lead_value | optional | Lead value |
| stage_id | optional | Lead stage id |
| sales_rep | optional | User responsible for this lead |
| job_title | optional | Lead Job Title |
| company | optional | The company associated with this lead |
| phone | optional | Lead phone number |
| address1 | optional | Lead address |
| city | optional | City |
| state | optional | State |
| zip_code | optional | Zip Code |
| country | optional | Country |
| website | optional | Website URL |
| skype | optional | Lead skype address |
| message | optional | Additional lead message |
| tags[] | optional | Array list of tags e.g tags[design] |
Get Lead by ID
Get the Lead information using "id"
{
"type": "leads",
"id": "1",
"attributes": {
"id": 1,
"name": "Monica",
"source": {
"id": 26,
"name": "Facebook"
},
"email": "monica@dataaegis.com",
"stage": {
"id": 24,
"name": "Contacted"
},
"job_title": "",
"company": "",
"phone": "",
"mobile": "",
"address": {
"address1": "",
"address2": "",
"city": "",
"state": "",
"zipcode": null,
"country": "Australia"
},
"timezone": "Indian/Maldives",
"website": "",
"social": {
"skype": "",
"facebook": "",
"twitter": "",
"linkedin": ""
},
"agent": {
"id": 1,
"name": "Arul Raj",
"email": "arul@dataaegis.com"
},
"lead_score": 10,
"due_date": "2019-06-12T20:59:57+03:00",
"lead_value": "$0.00",
"message": "",
"has_activity": 1,
"has_email": 0,
"next_followup": "2019-06-01T20:59:57+03:00",
"unsubscribed_at": null,
"archived_at": null,
"created_at": "2019-05-29T20:59:57+03:00",
"updated_at": "2019-05-29T22:01:25+03:00"
}
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxx.aritic.com/acrm/api/v1/leads/1")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxx.aritic.com/acrm/api/v1/leads/1",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxx.aritic.com/acrm/api/v1/leads/1');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
require 'uri'
require 'net/http'
url = URI("https://xxxxx.aritic.com/acrm/api/v1/leads/1")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
import requests
url = "https://xxxx.aritic.com/acrm/api/v1/leads/1"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
curl --request GET \
--url https://xxxx.aritic.com/acrm/api/v1/leads/1 \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/leads{id}
Response
Expected Response Code: 200
Update Lead
Updates the existing lead information
HTTP Request
PUT /api/v1/leads{id}
Response
Expected Response Code: 200
Lead Paramaeters
| Name | Required | Description |
|---|---|---|
| required | Email address | |
| lead_value | optional | Lead value |
| stage_id | optional | Lead stage id |
| sales_rep | optional | User responsible for this lead |
| job_title | optional | Lead Job Title |
| company | optional | The company associated with this lead |
| phone | optional | Lead phone number |
| address1 | optional | Lead address |
| city | optional | Citystate |
| zip_code | optional | Zip Code |
| country | optional | Country |
| website | optional | Website URL |
| skype | optional | Lead skype address |
| message | optional | Additional lead message |
Delete Lead
Deletes the existing Lead using id
{
"message": "Record will be deleted in a moment",
"redirect": "https://maildemo.aritic.com/acrm/public/leads",
"success": true
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxx.aritic.com/acrm/api/v1/leads/3")
.delete(null)
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxx.aritic.com/acrm/api/v1/leads/3",
"method": "DELETE",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/leads/3');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
require 'uri'
require 'net/http'
url = URI("https://xxxx.aritic.com/acrm/api/v1/leads/3")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Delete.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
import requests
url = "https://xxxxx.aritic.com/acrm/api/v1/leads/3"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("DELETE", url, data=payload, headers=headers)
print(response.text)
curl --request DELETE \
--url https://xxxxx.aritic.com/acrm/api/v1/leads/3 \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
DELETE /api/v1/leads/{id}
Response
Expected Response Code: 200
List all Leads
Lists all the saved Leads
{
"data": [
{
"type": "leads",
"id": "3",
"attributes": {
"id": 3,
"name": "monica",
"source": {
"id": 31,
"name": "Youtube"
},
"email": "monica@dataaegis.com",
"stage": {
"id": 42,
"name": "New Lead"
},
"job_title": "",
"company": "",
"phone": "",
"mobile": "",
"address": {
"address1": "",
"address2": "",
"city": "",
"state": "",
"zipcode": null,
"country": "Australia"
},
"timezone": "Asia/Kolkata",
"website": "",
"social": {
"skype": "",
"facebook": "",
"twitter": "",
"linkedin": ""
},
"agent": {
"id": 1,
"name": "Arul Raj",
"email": "arul@dataaegis.com"
},
"lead_score": 10,
"due_date": "2019-06-14T21:12:22+03:00",
"lead_value": "$18.90",
"message": "",
"has_activity": 0,
"has_email": 0,
"next_followup": "2019-06-03T21:12:22+03:00",
"unsubscribed_at": null,
"archived_at": null,
"created_at": "2019-05-31T21:12:22+03:00",
"updated_at": "2019-05-31T21:12:22+03:00"
}
}, {
"type": "leads",
"id": "1",
"attributes": {
"id": 1,
"name": "Shikha",
"source": {
"id": 26,
"name": "Facebook"
},
"email": "shikha@dataaegis.com",
"stage": {
"id": 24,
"name": "Contacted"
},
"job_title": "",
"company": "",
"phone": "",
"mobile": "",
"address": {
"address1": "",
"address2": "",
"city": "",
"state": "",
"zipcode": null,
"country": "Australia"
},
"timezone": "Indian/Maldives",
"website": "",
"social": {
"skype": "",
"facebook": "",
"twitter": "",
"linkedin": ""
},
"agent": {
"id": 1,
"name": "Arul Raj",
"email": "arul@dataaegis.com"
},
"lead_score": 10,
"due_date": "2019-06-12T20:59:57+03:00",
"lead_value": "$0.00",
"message": "",
"has_activity": 1,
"has_email": 0,
"next_followup": "2019-06-01T20:59:57+03:00",
"unsubscribed_at": null,
"archived_at": null,
"created_at": "2019-05-29T20:59:57+03:00",
"updated_at": "2019-05-29T22:01:25+03:00"
}
}
]
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxx.aritic.com/acrm/api/v1/leads")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxx.aritic.com/acrm/api/v1/leads",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxx.aritic.com/acrm/api/v1/leads');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxx.aritic.com/acrm/api/v1/leads"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
equest
`GET /api/v1/leads`
###Response
`Expected Response Code: 200`
--url https://xxxx.aritic.com/acrm/api/v1/leads \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
require 'uri'
require 'net/http'
url = URI("https://xxxxx.aritic.com/acrm/api/v1/leads")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
HTTP Request
GET /api/v1/leads
Response
Expected Response Code: 200
Show Lead Comments
Shows the particular Leads comment using id
{
"data": [
{
"type": "comments",
"id": "5",
"attributes": {
"id": 5,
"user_id": 1,
"entity": {
"id": 1,
"name": "Monica"
},
"parent": null,
"message": "Hello,\r\n\r\nThank you for contacting us. We hope product demo is useful as per your requirements.\r\n\r\nWe are looking forward to reach you.",
"unread": 1,
"created_at": "2019-05-31T22:28:36+03:00",
"updated_at": "2019-05-31T22:28:36+03:00"
}
}
]
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxx.aritic.com/acrm/api/v1/leads/1/comments")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxx.aritic.com/acrm/api/v1/leads/1/comments",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxx.aritic.com/acrm/api/v1/leads/1/comments');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxx.aritic.com/acrm/api/v1/leads/1/comments"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
curl --request GET \
--url https://xxxx.aritic.com/acrm/api/v1/leads/1/comments \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
require 'uri'
require 'net/http'
url = URI("https://xxxxx.aritic.com/acrm/api/v1/leads/1/comments")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
HTTP Request
GET /api/v1/leads/{id}/comments
Response
Expected Response Code: 200
Show Lead Todo List
Shows the existing Leat Todo list using the Lead id.
{
"data": [
{
"type": "todos",
"id": "3",
"attributes": {
"id": 3,
"subject": "Test_Template",
"order": 0,
"parent": 0,
"due_date": "2019-05-29T23:00:00+03:00",
"notes": "Helloo\r\n\r\nWelcome!",
"assignee": {
"id": 2,
"name": "Arul"
},
"reminded_at": null,
"entity": {
"id": 1,
"name": "Monica"
},
"is_visible": 0,
"completed": 0,
"user_id": 1,
"created_at": "2019-05-29T22:01:25+03:00",
"updated_at": "2019-05-29T22:01:25+03:00"
}
}
]
}
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxx.aritic.com/acrm/api/v1/leads/1/todos",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxx.aritic.com/acrm/api/v1/leads/1/todos")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/leads/1/todos');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxx.aritic.com/acrm/api/v1/leads/1/todos"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxx.aritic.com/acrm/api/v1/leads/1/todos")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxxx.aritic.com/acrm/api/v1/leads/1/todos \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/leads/{id}/todos
Response
Expected Response Code: 200
Show Lead Calls
Show the lead calls using Existing lead id.
{
"data": [
{
"type": "calls",
"id": "3",
"attributes": {
"id": 3,
"user_id": 1,
"assignee": {
"id": 3,
"namee": "monica@dataaegis.com"
},
"subject": "support",
"duration": 0,
"scheduled_date": null,
"reminder": null,
"type": "outbound",
"result": "",
"description": "",
"cancelled_at": null,
"entity": {
"id": 1,
"name": "Monica"
},
"notified_at": null,
"created_at": "2019-05-29T22:00:39+03:00",
"updated_at": "2019-05-29T22:00:39+03:00"
}
}
]
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxx.aritic.com/acrm/api/v1/leads/1/calls")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxx.aritic.com/acrm/api/v1/leads/1/calls",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/leads/1/calls');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxxx.aritic.com/acrm/api/v1/leads/1/calls"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxx.aritic.com/acrm/api/v1/leads/1/calls")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxxx.aritic.com/acrm/api/v1/leads/1/calls \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/leads/{id}/calls
Response
Expected Response Code: 200
Deals
You can create the new deals. And edit, update the existing deals on Aritic CRM.
Create Deal
Creating the new deals.
HTTP Request
POST /api/v1/deals
Response
Expected Response Code: 200
Deals Parameters
| Name | Required | Description |
|---|---|---|
| title | required | Deal title |
| pipeline | required | Pipeline ID |
| stage_id | required | Deal stage id |
| contact_person | required | Deal contact person |
| deal_value | optional | Deal value eg.500 |
| due_date | optional | The date a deal is expected to close |
| organization | optional | Deal Organization |
| status | optional | Deal status. Default open |
| source | optional | Deal source |
| currency | optional | Deal Currency |
| tags[] | optional | Array list of tags e.g tags[design] |
Get Deal by ID
Shows the deal information using Deal id
{
"type": "deals",
"id": "3",
"attributes": {
"id": 3,
"title": "testing",
"stage": {
"id": 51,
"name": "New-1"
},
"currency": "USD",
"deal_value": "150.00",
"contact_person": {
"id": 3,
"email": "monica@dataaegis.com"
},
"organization": {
"id": 2,
"name": "Monica",
"email": "monica@dataaegis.com"
},
"due_date": null,
"status": "open",
"won_time": null,
"lost_time": null,
"lost_reason": null,
"source": {
"id": 26,
"name": "Facebook"
},
"pipeline": {
"id": 19,
"name": "Sales"
},
"user_id": 1,
"next_followup": null,
"archived_at": null,
"created_at": "2019-05-29T21:21:32+03:00",
"updated_at": "2019-05-29T21:21:32+03:00"
}
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxx.aritic.com/acrm/api/v1/deals/3")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxx.aritic.com/acrm/api/v1/deals/3",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/deals/3');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxx.aritic.com/acrm/api/v1/deals/3"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxx.aritic.com/acrm/api/v1/deals/3")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxxx.aritic.com/acrm/api/v1/deals/3 \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/deals/{id}
Response
Expected Response Code: 200
Update Deal
Updates the new information with existing deals.
HTTP Request
PUT /api/v1/deals/{id}
Response
Expected Response Code: 200
Deals Parameters
| Name | Required | Description |
|---|---|---|
| title | required | Deal title |
| pipeline | required | Pipeline ID |
| stage_id | required | Deal stage id |
| contact_person | required | Deal contact person |
| deal_value | optional | Deal value eg.500 |
| due_date | optional | The date a deal is expected to close |
| organization | optional | Deal Organization |
| status | optional | Deal status. Default open |
| source | optional | Deal source |
| currency | optional | Deal Currency |
Delete Deal
Deletes the deal information using id
HTTP Request
DELETE /api/v1/deals/{id}
Response
Expected Response Code: 200
List all Deals
Lists the overall existing deals.
{
"data": [
{
"type": "deals",
"id": "3",
"attributes": {
"id": 3,
"title": "testing",
"stage": {
"id": 51,
"name": "New-1"
},
"currency": "USD",
"deal_value": "150.00",
"contact_person": {
"id": 3,
"email": "monica@dataaegis.com"
},
"organization": {
"id": 2,
"name": "Monica",
"email": "monica@dataaegis.com"
},
"due_date": null,
"status": "open",
"won_time": null,
"lost_time": null,
"lost_reason": null,
"source": {
"id": 26,
"name": "Facebook"
},
"pipeline": {
"id": 19,
"name": "Sales"
},
"user_id": 1,
"next_followup": null,
"archived_at": null,
"created_at": "2019-05-29T21:21:32+03:00",
"updated_at": "2019-05-29T21:21:32+03:00"
}
},
{
"type": "deals",
"id": "2",
"attributes": {
"id": 2,
"title": "Deomo",
"stage": {
"id": 38,
"name": "First Visit"
},
"currency": "USD",
"deal_value": "1200.00",
"contact_person": {
"id": 2,
"email": "prem@dataaegis.com"
},
"organization": {
"id": 1,
"name": "Arul",
"email": "prem@dataaegis.com"
},
"due_date": null,
"status": "open",
"won_time": null,
"lost_time": null,
"lost_reason": null,
"source": {
"id": 26,
"name": "Facebook"
},
"pipeline": {
"id": 19,
"name": "Sales"
},
"user_id": 1,
"next_followup": null,
"archived_at": null,
"created_at": "2019-05-21T21:27:30+03:00",
"updated_at": "2019-05-23T15:05:59+03:00"
}
},
{
"type": "deals",
"id": "1",
"attributes": {
"id": 1,
"title": "Dummy Deal",
"stage": {
"id": 37,
"name": "Untouched"
},
"currency": "USD",
"deal_value": "19.00",
"contact_person": {
"id": 1,
"email": "arul@dataaegis.com"
},
"organization": {
"id": 1,
"name": "Arul",
"email": "prem@dataaegis.com"
},
"due_date": null,
"status": "open",
"won_time": null,
"lost_time": null,
"lost_reason": null,
"source": {
"id": 27,
"name": "Google Organic"
},
"pipeline": {
"id": 19,
"name": "Sales"
},
"user_id": 1,
"next_followup": null,
"archived_at": null,
"created_at": "2019-05-21T20:46:31+03:00",
"updated_at": "2019-05-23T14:45:23+03:00"
}
}
]
}
kHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxx.aritic.com/acrm/api/v1/deals")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxx.aritic.com/acrm/api/v1/deals",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/deals');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxx.aritic.com/acrm/api/v1/deals"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxx.aritic.com/acrm/api/v1/deals")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxx.aritic.com/acrm/api/v1/deals \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/deals
Response
Expected Response Code: 200
Show Deal Todo List
Shows the Deals Todo List
{
"data": [
{
"type": "todos",
"id": "1",
"attributes": {
"id": 1,
"subject": "New task",
"order": 0,
"parent": 0,
"due_date": "2019-05-22T09:04:00+03:00",
"notes": "Need to finish",
"assignee": {
"id": 1,
"name": "Arul Raj"
},
"reminded_at": null,
"entity": {
"id": 1,
"name": "Dummy Deal"
},
"is_visible": 0,
"completed": 1,
"user_id": 1,
"created_at": "2019-05-21T21:04:57+03:00",
"updated_at": "2019-05-23T14:45:23+03:00"
}
}
]
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxx.aritic.com/acrm/api/v1/deals/1/todos")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxx.aritic.com/acrm/api/v1/deals/1/todos",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/deals/1/todos');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxx.aritic.com/acrm/api/v1/deals/1/todos"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxx.aritic.com/acrm/api/v1/deals/1/todos")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxx.aritic.com/acrm/api/v1/deals/1/todos \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/deals/{id}/todos
Response
Expected Response Code: 200
Show Deal Calls
Shows the information about deal calls.
{
"data": [
{
"type": "calls",
"id": "2",
"attributes": {
"id": 2,
"user_id": 1,
"assignee": {
"id": 1,
"namee": "Arul Raj"
},
"subject": "Call to customer",
"duration": 1800,
"scheduled_date": null,
"reminder": null,
"type": "outbound",
"result": "",
"description": "Call for next demo",
"cancelled_at": null,
"entity": {
"id": 2,
"name": "Deomo"
},
"notified_at": null,
"created_at": "2019-05-23T13:57:40+03:00",
"updated_at": "2019-05-23T13:57:40+03:00"
}
}
]
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxx.aritic.com/acrm/api/v1/deals/2/calls")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxx.aritic.com/acrm/api/v1/deals/2/calls",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxx.aritic.com/acrm/api/v1/deals/2/calls');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxx.aritic.com/acrm/api/v1/deals/2/calls"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxx.aritic.com/acrm/api/v1/deals/2/calls")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxx.aritic.com/acrm/api/v1/deals/2/calls \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/deals/{id}/calls
Response
Expected Response Code: 200
Show Deal Products
Shows the information about Deal Products.
{
"data": [
{
"type": "items",
"id": "2",
"attributes": {
"id": 2,
"name": "Aritic PinPoint",
"description": "Dummy Product as Aritic PinPoint",
"entity": {
"id": 1,
"name": "Dummy Deal"
},
"tax_rate": 0,
"quantity": 1,
"unit_cost": 19,
"discount": 0,
"tax_total": "0.00",
"total_cost": 19,
"created_at": "2019-05-23T14:29:34+03:00",
"updated_at": "2019-05-23T14:29:34+03:00"
}
}
]
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxx.aritic.com/acrm/api/v1/deals/1/products")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxx.aritic.com/acrm/api/v1/deals/1/products",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/deals/1/products');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxxxx.aritic.com/acrm/api/v1/deals/1/products"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxx.aritic.com/acrm/api/v1/deals/1/products")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxxx.aritic.com/acrm/api/v1/deals/1/products \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/deals/{id}/products
Response
Expected Response Code: 200
Close Deal
Closes the deal using the id.
{
"id": 3,
"message": "Changes saved successfully",
"redirect": "https://maildemo.aritic.com/acrm/public/deals/view/3",
"success": true
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxxxxx.aritic.com/acrm/api/v1/deals/3/close")
.post(null)
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxx.aritic.com/acrm/api/v1/deals/3/close",
"method": "POST",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/deals/3/close');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxx.aritic.com/acrm/api/v1/deals/3/close"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxx.aritic.com/acrm/api/v1/deals/3/close")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request POST \
--url https://xxxxxxx.aritic.com/acrm/api/v1/deals/3/close \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
POST /api/v1/deals/{id}/close
Response
Expected Response Code: 200
Proposals
You can create the new Proposalds. And edit, update the existing Proposals on Aritic CRM.
Create Proposal
Creating the new Proposals.
HTTP Request
POST /api/v1/proposals
Response
Expected Response Code: 200
Proposals Parameters
| Name | Required | Description |
|---|---|---|
| client_id | required | Client ID |
| reference_no | required | Proposal Reference Number |
| due_date | required | Proposal due date |
| tax | required | Tax 1 percentage |
| tax2 | required | Tax 2 percentage |
| discount | optional | Proposal discount percentage |
| currency | optional | Proposal Currency |
| deal_id | optional | Associated deal if any |
| is_visible | optional | Show/Hide proposal from client. Default 0 |
| tags[] | optional | Array list of tags e.g tags[design] |
Get Proposal by ID
Get the Proposals information using id.
"proposals",
"id": "2",
"attributes": {
"id": 2,
"reference_no": "EST-20190601-0002",
"title": "Product proposal",
"client_id": 2,
"deal_id": 2,
"due_date": "2019-07-03T00:00:00+03:00",
"tax": "0.00",
"tax2": "0.00",
"discount": "0.00",
"discount_percent": 1,
"currency": "USD",
"notes": "**Looking** forward to doing business with you.",
"sent_at": null,
"status": "Pending",
"viewed_at": null,
"invoiced_id": null,
"invoiced_at": null,
"accepted_time": null,
"rejected_time": null,
"rejected_reason": null,
"exchange_rate": "1.00000",
"sub_total": "0.00",
"amount": "0.00",
"discounted": "0.00",
"tax1_amount": "0.00",
"tax2_amount": "0.00",
"archived_at": null,
"business": {
"id": 2,
"name": "Monica",
"contact_person": "monica@dataaegis.com"
},
"created_at": "2019-06-01T22:19:20+03:00",
"updated_at": "2019-06-01T22:19:20+03:00"
}
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxx.aritic.com/acrm/api/v1/proposals/2")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxxxxxxx.aritic.com/acrm/api/v1/proposals/2",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/proposals/2');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxxxx.aritic.com/acrm/api/v1/proposals/2"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxx.aritic.com/acrm/api/v1/proposals/2")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
require 'uri'
require 'net/http'
url = URI("https://xxxx.aritic.com/acrm/api/v1/proposals/2")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
HTTP Request
GET /api/v1/proposals/{id}
Response
Expected Response Code: 200
Update Proposal
Updates the new information using existing proposals id.
HTTP Request
PUT /api/v1/proposals/{id}
Response
Expected Response Code: 200
Proposals Parameters
| Name | Required | Description |
|---|---|---|
| client_id | required | Client ID |
| reference_no | required | Proposal Reference Number |
| due_date | required | Proposal due date |
| tax | required | Tax 1 percentage |
| tax2 | required | Tax 2 percentage |
| discount | optional | Proposal discount percentage |
| currency | optional | Proposal Currency |
| deal_id | optional | Associated deal if any |
| is_visible | optional | Show/Hide proposal from client. Default 0 |
Delete Proposal
Deleting the Proposals information
HTTP Request
DELETE /api/v1/proposals/{id}
Response
Expected Response Code: 200
List all Proposal
Displays the all proposals using id
{
"data": [
{
"type": "proposals",
"id": "3",
"attributes": {
"id": 3,
"reference_no": "EST-20190601-0003",
"title": "Product proposal",
"client_id": 2,
"deal_id": 2,
"due_date": "2019-07-03T00:00:00+03:00",
"tax": "0.00",
"tax2": "0.00",
"discount": "0.00",
"discount_percent": 1,
"currency": "USD",
"notes": "**Looking** forward to doing business with you.",
"sent_at": null,
"status": "Pending",
"viewed_at": null,
"invoiced_id": null,
"invoiced_at": null,
"accepted_time": null,
"rejected_time": null,
"rejected_reason": null,
"exchange_rate": "1.00000",
"sub_total": "0.00",
"amount": "0.00",
"discounted": "0.00",
"tax1_amount": "0.00",
"tax2_amount": "0.00",
"archived_at": null,
"business": {
"id": 2,
"name": "Monica",
"contact_person": "monica@dataaegis.com"
},
"created_at": "2019-06-01T22:21:04+03:00",
"updated_at": "2019-06-01T22:21:17+03:00"
}
},
{
"type": "proposals",
"id": "2",
"attributes": {
"id": 2,
"reference_no": "EST-20190601-0002",
"title": "Product proposal",
"client_id": 2,
"deal_id": 2,
"due_date": "2019-07-03T00:00:00+03:00",
"tax": "0.00",
"tax2": "0.00",
"discount": "0.00",
"discount_percent": 1,
"currency": "USD",
"notes": "**Looking** forward to doing business with you.",
"sent_at": null,
"status": "Pending",
"viewed_at": null,
"invoiced_id": null,
"invoiced_at": null,
"accepted_time": null,
"rejected_time": null,
"rejected_reason": null,
"exchange_rate": "1.00000",
"sub_total": "0.00",
"amount": "0.00",
"discounted": "0.00",
"tax1_amount": "0.00",
"tax2_amount": "0.00",
"archived_at": null,
"business": {
"id": 2,
"name": "Monica",
"contact_person": "monica@dataaegis.com"
},
"created_at": "2019-06-01T22:19:20+03:00",
"updated_at": "2019-06-01T22:19:20+03:00"
}
},
{
"type": "proposals",
"id": "1",
"attributes": {
"id": 1,
"reference_no": "EST0001",
"title": "Proposal",
"client_id": 1,
"deal_id": 1,
"due_date": "2019-06-20T00:00:00+03:00",
"tax": "0.00",
"tax2": "0.00",
"discount": "0.00",
"discount_percent": 1,
"currency": "USD",
"notes": "**Looking** forward to doing business with you.",
"sent_at": null,
"status": "Accepted",
"viewed_at": null,
"invoiced_id": null,
"invoiced_at": null,
"accepted_time": "2019-05-21 21:20:58",
"rejected_time": null,
"rejected_reason": null,
"exchange_rate": "1.00000",
"sub_total": "0.00",
"amount": "0.00",
"discounted": "0.00",
"tax1_amount": "0.00",
"tax2_amount": "0.00",
"archived_at": null,
"business": {
"id": 1,
"name": "Arul",
"contact_person": "prem@dataaegis.com"
},
"created_at": "2019-05-21T21:19:47+03:00",
"updated_at": "2019-05-21T21:20:58+03:00"
}
}
]
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxx.aritic.com/acrm/api/v1/proposals")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxx.aritic.com/acrm/api/v1/proposals",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxx.aritic.com/acrm/api/v1/proposals');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxxxx.aritic.com/acrm/api/v1/proposals"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxx.aritic.com/acrm/api/v1/proposals")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxxxx.aritic.com/acrm/api/v1/proposals \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
Show Proposal Comments
Displays the Proposal comments using id
{
"data": [
{
"type": "comments",
"id": "20",
"attributes": {
"id": 20,
"user_id": 1,
"entity": {
"id": 2,
"name": "Product proposal"
},
"parent": null,
"message": "Thank you for purchasing",
"unread": 1,
"created_at": "2019-06-03T09:48:16+03:00",
"updated_at": "2019-06-03T09:48:16+03:00"
}
}
]
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxx.aritic.com/acrm/api/v1/proposals/2/comments")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxxxxx.aritic.com/acrm/api/v1/proposals/2/comments",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxxx.aritic.com/acrm/api/v1/proposals/2/comments');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxxx.aritic.com/acrm/api/v1/proposals/2/comments"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxxx.aritic.com/acrm/api/v1/proposals/2/comments")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxxx.aritic.com/acrm/api/v1/proposals/2/comments \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/proposals/{id}/comments
Response
Expected Response Code: 200
Show Proposal Items
Displays the information of Proposal items using id
{
"data": [
{
"type": "items",
"id": "5",
"attributes": {
"id": 5,
"name": "Aritic mail",
"description": "Transactional mail",
"entity": {
"id": 2,
"name": "Product proposal"
},
"tax_rate": 0,
"quantity": 5,
"unit_cost": 800,
"discount": 5,
"tax_total": "0.00",
"total_cost": 3800,
"created_at": "2019-06-01T22:20:14+03:00",
"updated_at": "2019-06-01T22:20:14+03:00"
}
}
]
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxx.aritic.com/acrm/api/v1/proposals/2/items")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxx.aritic.com/acrm/api/v1/proposals/2/items",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/proposals/2/items');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxxx.aritic.com/acrm/api/v1/proposals/2/items"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxx.aritic.com/acrm/api/v1/proposals/2/items")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxxxx.aritic.com/acrm/api/v1/proposals/2/items \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/proposals/{id}/items
Response
Expected Response Code: 200
Invoice an Proposal
Displays the information of invoice proposals using id
{
"id": 4,
"message": "app.proposal_invoiced_successfully",
"redirect": "https://maildemo.aritic.com/acrm/public/invoices/view/4",
"success": true
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxxxxx.aritic.com/acrm/api/v1/proposals/2/invoice")
.post(null)
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxx.aritic.com/acrm/api/v1/proposals/2/invoice",
"method": "POST",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxx.aritic.com/acrm/api/v1/proposals/2/invoice');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxx.aritic.com/acrm/api/v1/proposals/2/invoice"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxx.aritic.com/acrm/api/v1/proposals/2/invoice")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request POST \
--url https://xxxxxxx.aritic.com/acrm/api/v1/proposals/2/invoice \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
POST /api/v1/proposals/{id}/invoice
Response
Expected Response Code: 200
Duplicate an Proposal
Duplicating the proposals from existing to new one.
{
"id": 4,
"message": "Record saved successfully",
"redirect": "https://maildemo.aritic.com/acrm/public/proposals/view/4",
"success": true
}
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n\t\"id\" : \"2\"\n}");
Request request = new Request.Builder()
.url("https://xxxxxxxx.aritic.com/acrm/api/v1/proposals/2/copy")
.post(body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxx.aritic.com/acrm/api/v1/proposals/2/copy",
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
},
"processData": false,
"data": "{\n\t\"id\" : \"2\"\n}"
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxxx.aritic.com/acrm/api/v1/proposals/2/copy');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token,
'Content-Type' => 'application/json'
));
$request->setBody('{
"id" : "2"
}');
import requests
url = "https://xxxxxxx.aritic.com/acrm/api/v1/proposals/2/copy"
payload = "{\n\t\"id\" : \"2\"\n}"
headers = {
'Content-Type': "application/json",
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxx.aritic.com/acrm/api/v1/proposals/2/copy")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
request.body = "{\n\t\"id\" : \"2\"\n}"
response = http.request(request)
puts response.read_body
curl --request POST \
--url https://xxxxxx.aritic.com/acrm/api/v1/proposals/2/copy \
--header 'Authorization: Bearer your_access_token' \
--header 'Content-Type: application/json' \
--header 'cache-control: no-cache' \
--data '{\n "id" : "2"\n}'
HTTP Request
POST /api/v1/proposals/{id}/copy
Response
Expected Response Code: 200
Send Proposals
Sending the Proposals information to the client.
HTTP Request
POST /api/v1/proposals/{id}/send
Response
Expected Response Code: 200
Expected Parameters
Name|Required|Description id | required | Proposal ID to[] | required | Comma separated list of email addresses subject | required | Message subject
Convert Proposals to Project
Converting the Extimate information into the project.
{
"id": 1,
"message": "Record saved successfully",
"redirect": "https://maildemo.aritic.com/acrm/public/projects/view/1",
"success": true
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxxxxxxxx.aritic.com/acrm/api/v1/proposals/1/project")
.post(null)
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxx.aritic.com/acrm/api/v1/proposals/1/project",
"method": "POST",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxx.aritic.com/acrm/api/v1/proposals/1/project');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxx.aritic.com/acrm/api/v1/proposals/1/project"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxxx.aritic.com/acrm/api/v1/proposals/1/project")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request POST \
--url https://xxxxxxx.aritic.com/acrm/api/v1/proposals/1/project \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
POST /api/v1/proposals/{id}/project
Response
Expected Response Code: 200
Cancel Proposal
Cancelling the Extimates information.
{
"id": 1,
"message": "Changes saved successfully",
"redirect": "https://maildemo.aritic.com/acrm/public/proposals/view/1",
"success": true
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxxx.aritic.com/acrm/api/v1/proposals/1/cancel")
.post(null)
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxx.aritic.com/acrm/api/v1/proposals/1/cancel",
"method": "POST",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxx.aritic.com/acrm/api/v1/proposals/1/cancel');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxx.aritic.com/acrm/api/v1/proposals/1/cancel"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxxx.aritic.com/acrm/api/v1/proposals/1/cancel")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request POST \
--url https://xxxxxxx.aritic.com/acrm/api/v1/proposals/1/cancel \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
POST /api/v1/proposals/{id}/cancel
Response
Expected Response Code: 200
Credits
You can create the new credits. Meanwhile, you can edit, update and delete the existing credits on Aritic CRM.
Create Credit Note
Creating the New credit note.
HTTP Request
POST /api/v1/creditnotes
Response
Expected Response code: 200
Credit Notes parameters
| Name | Required | Description |
|---|---|---|
| client_id | required | Client ID |
| reference_no | required | Credit Reference Number |
| created_at | optional | Date created |
| tax | optional | Tax percentage |
| terms | optional | Creditnote terms |
| notes | optional | Creditnote notes |
| currency | optional | Creditnote Currency |
| is_refunded | optional | Set to 1 if credit was refunded |
| tags[] | optional | Array list of tags e.g tags[design] |
Get Credit Note
Shows the Particular credit notes information using id.
{
"type": "credits",
"id": "1",
"attributes": {
"id": 1,
"reference_no": "CN0001",
"client_id": 2,
"status": "open",
"currency": "USD",
"tax": "15.00",
"amount": "0.00",
"balance": "0.00",
"exchange_rate": "1.00000",
"is_refunded": 0,
"archived_at": null,
"terms": "Thanks for your business.",
"notes": null,
"sent_at": null,
"business": {
"id": 2,
"name": "Monica",
"contact_person": "monica@dataaegis.com"
},
"created_at": "2019-06-02T18:49:44+03:00",
"updated_at": "2019-06-02T18:49:44+03:00"
}
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxx.aritic.com/acrm/api/v1/creditnotes/1")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxx.aritic.com/acrm/api/v1/creditnotes/1",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/creditnotes/1');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxx.aritic.com/acrm/api/v1/creditnotes/1"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxx.aritic.com/acrm/api/v1/creditnotes/1")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxxx.aritic.com/acrm/api/v1/creditnotes/1 \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/creditnotes/{id}
Response
Expected Respected code:200
Update Credit Note
Updates the new information with any existing credit notes.
HTTP Request
PUT /api/v1/creditnotes/{id}
Response
Expected Response code: 200
Credit Notes parameters
| Name | Required | Description |
|---|---|---|
| client_id | required | Client ID |
| reference_no | required | Credit Reference Number |
| created_at | optional | Date created |
| tax | optional | Tax percentage |
| terms | optional | Creditnote terms |
| notes | optional | Creditnote notes |
| currency | optional | Creditnote Currency |
| is_refunded | optional | Set to 1 if credit was refunded |
Delete Credit Note
Deletes the existing credit note using id
{
"message": "Record will be deleted in a moment",
"redirect": "https://maildemo.aritic.com/acrm/public/creditnotes",
"success": true
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxxx.aritic.com/acrm/api/v1/creditnotes/2")
.delete(null)
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxxxxx.aritic.com/acrm/api/v1/creditnotes/2",
"method": "DELETE",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxx.aritic.com/acrm/api/v1/creditnotes/2');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxxx.aritic.com/acrm/api/v1/creditnotes/2"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("DELETE", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxx.aritic.com/acrm/api/v1/creditnotes/2")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Delete.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request DELETE \
--url https://xxxxxx.aritic.com/acrm/api/v1/creditnotes/2 \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
DELETE /api/v1/creditnotes/{id}
Response
Expected Response code: 200
Show all Credit Notes
Displays the all credit notes information
"data": [
{
"type": "credits",
"id": "2",
"attributes": {
"id": 2,
"reference_no": "CN-20190602-0002",
"client_id": 1,
"status": "open",
"currency": "USD",
"tax": "5.00",
"amount": "0.00",
"balance": "0.00",
"exchange_rate": "1.00000",
"is_refunded": 0,
"archived_at": null,
"terms": "Thanks for your business.",
"notes": null,
"sent_at": null,
"business": {
"id": 1,
"name": "Arul",
"contact_person": "prem@dataaegis.com"
},
"created_at": "2019-06-02T18:55:14+03:00",
"updated_at": "2019-06-02T18:55:14+03:00"
}
},
{
"type": "credits",
"id": "1",
"attributes": {
"id": 1,
"reference_no": "CN0001",
"client_id": 2,
"status": "open",
"currency": "USD",
"tax": "15.00",
"amount": "0.00",
"balance": "0.00",
"exchange_rate": "1.00000",
"is_refunded": 0,
"archived_at": null,
"terms": "Thanks for your business.",
"notes": null,
"sent_at": null,
"business": {
"id": 2,
"name": "Monica",
"contact_person": "monica@dataaegis.com"
},
"created_at": "2019-06-02T18:49:44+03:00",
"updated_at": "2019-06-02T18:49:44+03:00"
}
}
]
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxx.aritic.com/acrm/api/v1/creditnotes")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxx.aritic.com/acrm/api/v1/creditnotes",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxxx.aritic.com/acrm/api/v1/creditnotes');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxxxx.aritic.com/acrm/api/v1/creditnotes"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxx.aritic.com/acrm/api/v1/creditnotes")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxx.aritic.com/acrm/api/v1/creditnotes \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/creditnotes
Response
Expected Response code : 200
Show Credit Note Comments
Shows the all credit note comments
{
"data": [
{
"type": "comments",
"id": "19",
"attributes": {
"id": 19,
"user_id": 1,
"entity": {
"id": 1,
"name": "CN0001"
},
"parent": null,
"message": "Hope, we work together thank you",
"unread": 1,
"created_at": "2019-06-02T18:52:14+03:00",
"updated_at": "2019-06-02T18:52:14+03:00"
}
},
{
"type": "comments",
"id": "15",
"attributes": {
"id": 15,
"user_id": 1,
"entity": {
"id": 1,
"name": "CN0001"
},
"parent": null,
"message": "Thank you for your information",
"unread": 1,
"created_at": "2019-06-02T18:50:21+03:00",
"updated_at": "2019-06-02T18:50:21+03:00"
}
}
]
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxx.aritic.com/acrm/api/v1/creditnotes/1/comments")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxxx.aritic.com/acrm/api/v1/creditnotes/1/comments",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxxxxxxx.aritic.com/acrm/api/v1/creditnotes/1/comments');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxxxxxx.aritic.com/acrm/api/v1/creditnotes/1/comments"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxx.aritic.com/acrm/api/v1/creditnotes/1/comments")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxxxxxx.aritic.com/acrm/api/v1/creditnotes/1/comments \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/creditnotes/{id}/comments
Response
Expected Response code : 200
Show Credit Notes Items
Shows the Credit note items.
{
"data": [
{
"type": "items",
"id": "8",
"attributes": {
"id": 8,
"name": "Aritic desk",
"description": "support tickets",
"entity": {
"id": 1,
"name": "CN0001"
},
"tax_rate": 0,
"quantity": 1,
"unit_cost": 50,
"discount": 0,
"tax_total": "0.00",
"total_cost": 50,
"created_at": "2019-06-02T18:54:12+03:00",
"updated_at": "2019-06-02T18:54:12+03:00"
}
},
{
"type": "items",
"id": "7",
"attributes": {
"id": 7,
"name": "Aritic PinPoint",
"description": "Marketing Automation",
"entity": {
"id": 1,
"name": "CN0001"
},
"tax_rate": 0,
"quantity": 3,
"unit_cost": 19,
"discount": 0,
"tax_total": "0.00",
"total_cost": 57,
"created_at": "2019-06-02T18:51:21+03:00",
"updated_at": "2019-06-02T18:51:21+03:00"
}
}
]
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxxxxxx.aritic.com/acrm/api/v1/creditnotes/1/items")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxxxx.aritic.com/acrm/api/v1/creditnotes/1/items",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxx.aritic.com/acrm/api/v1/creditnotes/1/items');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
require 'uri'
require 'net/http'
url = URI("https://xxxx.aritic.com/acrm/api/v1/creditnotes/1/items")
http = Net::HTTP.new(url.host, url.port)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxxx.aritic.com/acrm/api/v1/creditnotes/1/items \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/creditnotes/{id}/items
Response
Expected Response code : 200
Use Credits
Displays the information of credits use.
HTTP Request
POST /api/v1/creditnotes/{id}/use-credits
Response
Expected Response code : 200
Credit notes parameters
| Name | Required | Description |
|---|---|---|
| invoice_id | required | Invoice ID |
| creditnote_id | required | Credit Note ID |
| credited_amount | required | Amount to be credited e.g 50 |
Delete Credits
Deleting the credits using the id.
HTTP Request
POST /api/v1/creditnotes/{id}/delete-credits
Response
Expected Response code : 200
Delete Credit Parameters
| Name | Required | Description |
|---|---|---|
| id | required | Credit Note ID |
Expenses
You can create the expenses for different information. Meanwhile, you can edit, update the existing expenses information
Create Expenses
Creating the new Expenses
HTTP Request
POST /api/v1/expenses
Response
Expected Response Code: 200
Expenses Parameters
| Name | Required | Description |
|---|---|---|
| amount | required | Expense amount e.g 1500.00 |
| category | required | Expense category |
| expense_date | required | Expense date |
| tax | required | Tax 1 percentage |
| tax2 | required | Tax 2 percentage |
| currency | optional | Expense Currency |
| billable | optional | Whether the expense is billable. Default 1 |
| notes | optional | Expense notes |
| project_id | optional | Associated project ID if any |
| client_id | optional | Associated client ID if any |
| vendor | optional | Associated vendor name |
| is_visible | optional | Show/Hide expense from client. Default 0 |
| tags[] | optional | Array list of tags e.g tags[design] |
Get Expense by ID
Get the Expenses information using Expenses id
{
"type": "expenses",
"id": "3",
"attributes": {
"id": 3,
"code": "EXP-AC0003",
"amount": "1500.00",
"before_tax": "0.00",
"currency": "USD",
"billable": 1,
"category": 23,
"vendor": "",
"tax": "0.00",
"tax2": "0.00",
"taxed": null,
"expense_date": "2019-06-05T00:00:00+03:00",
"billed": false,
"project_id": 0,
"client_id": 2,
"invoiced_id": null,
"is_recurring": 0,
"frequency": null,
"next_recur_date": null,
"recur_starts": null,
"recur_ends": null,
"exchange_rate": "1.00000",
"is_visible": 1,
"notes": "",
"user_id": 1,
"created_at": "2019-06-02T12:43:09+03:00",
"updated_at": "2019-06-02T12:43:09+03:00"
}
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxx.aritic.com/acrm/api/v1/expenses/3")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.build()
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxx.aritic.com/acrm/api/v1/expenses/3",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/expenses/3');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxxxxxxxx.aritic.com/acrm/api/v1/expenses/3"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
'Postman-Token': "aef3f6f9-3251-sd42-93f0-dd56fea9b2ab"
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxx.aritic.com/acrm/api/v1/expenses/3")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxx.aritic.com/acrm/api/v1/expenses/3 \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/expenses{id}
Response
Expected Response Code: 200
Update Expense
Updates the new information with existing expenses.
HTTP Request
PUT /api/v1/expenses{id}
Response
Expected Response Code: 200
Expenses Parameters
| Name | Required | Description |
|---|---|---|
| amount | required | Expense amount e.g 1500.00 |
| category | required | Expense category |
| expense_date | required | Expense date |
| tax | required | Tax 1 percentage |
| tax2 | required | Tax 2 percentage |
| currency | optional | Expense Currency |
| billable | optional | Whether the expense is billable. Default 1 |
| notes | optional | Expense notes |
| project_id | optional | Associated project ID if any |
| client_id | optional | Associated client ID if any |
| vendor | optional | Associated vendor name |
| is_visible | optional | Show/Hide expense from client. Default 0 |
Delete Expense
Deletes the expenses information using the ID.
{
"message": "Record will be deleted in a moment",
"redirect": "https://maildemo.aritic.com/acrm/public/expenses",
"success": true
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxx.aritic.com/acrm/api/v1/expenses/2")
.delete(null)
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxx.aritic.com/acrm/api/v1/expenses/2",
"method": "DELETE",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxxx.aritic.com/acrm/api/v1/expenses/2');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxxx.aritic.com/acrm/api/v1/expenses/2"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("DELETE", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxx.aritic.com/acrm/api/v1/expenses/2")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Delete.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request DELETE \
--url https://xxxxxxx.aritic.com/acrm/api/v1/expenses/2 \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
DELETE /api/v1/expenses{id}
Response
Expected Response Code: 200
List all Expenses
Shows the all expenses information.
{
"data": [
{
"type": "expenses",
"id": "3",
"attributes": {
"id": 3,
"code": "EXP-AC0003",
"amount": "1500.00",
"before_tax": "0.00",
"currency": "USD",
"billable": 1,
"category": 23,
"vendor": "",
"tax": "0.00",
"tax2": "0.00",
"taxed": null,
"expense_date": "2019-06-05T00:00:00+03:00",
"billed": false,
"project_id": 0,
"client_id": 2,
"invoiced_id": null,
"is_recurring": 0,
"frequency": null,
"next_recur_date": null,
"recur_starts": null,
"recur_ends": null,
"exchange_rate": "1.00000",
"is_visible": 1,
"notes": "",
"user_id": 1,
"created_at": "2019-06-02T12:43:09+03:00",
"updated_at": "2019-06-02T12:43:09+03:00"
}
},
{
"type": "expenses",
"id": "2",
"attributes": {
"id": 2,
"code": "EXP-AC0002",
"amount": "500.00",
"before_tax": "0.00",
"currency": "USD",
"billable": 1,
"category": 21,
"vendor": "",
"tax": "0.00",
"tax2": "0.00",
"taxed": null,
"expense_date": "2019-06-11T00:00:00+03:00",
"billed": false,
"project_id": 0,
"client_id": 1,
"invoiced_id": null,
"is_recurring": 1,
"frequency": null,
"next_recur_date": null,
"recur_starts": null,
"recur_ends": null,
"exchange_rate": "1.00000",
"is_visible": 1,
"notes": "payment",
"user_id": 1,
"created_at": "2019-06-01T22:29:24+03:00",
"updated_at": "2019-06-01T22:29:25+03:00"
}
},
{
"type": "expenses",
"id": "1",
"attributes": {
"id": 1,
"code": "EXP-AC0001",
"amount": "1000.00",
"before_tax": "0.00",
"currency": "USD",
"billable": 1,
"category": 22,
"vendor": "",
"tax": "0.00",
"tax2": "0.00",
"taxed": null,
"expense_date": "2019-06-01T00:00:00+03:00",
"billed": false,
"project_id": 0,
"client_id": 2,
"invoiced_id": null,
"is_recurring": 0,
"frequency": null,
"next_recur_date": null,
"recur_starts": null,
"recur_ends": null,
"exchange_rate": "1.00000",
"is_visible": 1,
"notes": "",
"user_id": 1,
"created_at": "2019-06-01T22:26:08+03:00",
"updated_at": "2019-06-01T22:26:08+03:00"
}
}
]
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxxxx.aritic.com/acrm/api/v1/expenses")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxxx.aritic.com/acrm/api/v1/expenses",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/expenses');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxx.aritic.com/acrm/api/v1/expenses"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxx.aritic.com/acrm/api/v1/expenses")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxx.aritic.com/acrm/api/v1/expenses \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/expenses
Response
Expected Response Code: 200
Show Expenses Comments
Shows the Expenses comments using id.
{
"data": [
{
"type": "comments",
"id": "12",
"attributes": {
"id": 12,
"user_id": 1,
"entity": {
"id": 1,
"name": "EXP-AC0001"
},
"parent": null,
"message": "We are looking forward to reach you.",
"unread": 1,
"created_at": "2019-06-01T22:27:34+03:00",
"updated_at": "2019-06-01T22:27:34+03:00"
}
},
{
"type": "comments",
"id": "11",
"attributes": {
"id": 11,
"user_id": 1,
"entity": {
"id": 1,
"name": "EXP-AC0001"
},
"parent": null,
"message": "Kindly refund the payment made for the product",
"unread": 1,
"created_at": "2019-06-01T22:26:50+03:00",
"updated_at": "2019-06-01T22:26:50+03:00"
}
}
]
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxxx.aritic.com/acrm/api/v1/expenses/1/comments")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxx.aritic.com/acrm/api/v1/expenses/1/comments",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxx.aritic.com/acrm/api/v1/expenses/1/comments');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxx.aritic.com/acrm/api/v1/expenses/1/comments"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxx.aritic.com/acrm/api/v1/expenses/1/comments")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxx.aritic.com/acrm/api/v1/expenses/1/comments \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/expenses/{id}/comments
Response
Expected Response Code: 200
Duplicate Expenses
Duplicating the Existing expenses.
{
"id": 4,
"message": "Record saved successfully",
"redirect": "https://maildemo.aritic.com/acrm/public/expenses/view/4",
"success": true
}
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n\t\"id\" : \"1\"\n}");
Request request = new Request.Builder()
.url("https://xxxxxx.aritic.com/acrm/api/v1/expenses/1/copy")
.post(body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxx.aritic.com/acrm/api/v1/expenses/1/copy",
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
},
"processData": false,
"data": "{\n\t\"id\" : \"1\"\n}"
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx.aritic.com/acrm/api/v1/expenses/1/copy');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token,
'Content-Type' => 'application/json'
));
$request->setBody('{
"id" : "1"
}');
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxx.aritic.com/acrm/api/v1/expenses/1/copy"
payload = "{\n\t\"id\" : \"1\"\n}"
headers = {
'Content-Type': "application/json",
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxxx.aritic.com/acrm/api/v1/expenses/1/copy")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
request.body = "{\n\t\"id\" : \"1\"\n}"
response = http.request(request)
puts response.read_body
curl --request POST \
--url https://xxxxxxxx.aritic.com/acrm/api/v1/expenses/1/copy \
--header 'Authorization: Bearer your_access_token' \
--header 'Content-Type: application/json' \
--data '{\n "id" : "1"\n}'
HTTP Request
POST /api/v1/expenses/{id}/copy
Response
Expected Response Code: 200
Expected Expenses Parameters
| Name | Required | Description |
|---|---|---|
| id | required | Expense ID |
Payments
You can create the new Payments.
Create Payment
Create a new payment.
HTTP Request
POST /api/v1/payments
Response
Expected Response Code: 200
Payment Parameters
| Name | Required | Description |
|---|---|---|
| invoice id | required | Invoice ID |
| payment date | required | Date when the payment was made |
| amount | required | Amount of payment made |
| payment method | required | Payment method ID |
| gateway | required | Must be set to offline |
| notes | required | Payment additional notes |
| currency | requiered | Payment Currency |
| send email | required | If an email should be sent to client. Default 1 |
Get Payment by ID
You can get the Payment information using the payment ID.
{
"type": "leads",
"id": "2",
"attributes": {
"id": 2,
"name": "Naga",
"source": {
"id": 31,
"name": "Youtube"
},
"email": "nagarjuna@dataaegis.com",
"stage": {
"id": 42,
"name": "New Lead"
},
"job_title": "",
"company": "",
"phone": "",
"mobile": "",
"address": {
"address1": "",
"address2": "",
"city": "",
"state": "",
"zipcode": null,
"country": "Australia"
},
"timezone": "Europe/Moscow",
"website": "",
"social": {
"skype": "",
"facebook": "",
"twitter": "",
"linkedin": ""
},
"agent": {
"id": 1,
"name": "Arul Raj",
"email": "arul@dataaegis.com"
},
"lead_score": 10,
"due_date": "2019-06-12T21:24:07+03:00",
"lead_value": "$10.00",
"message": "",
"has_activity": 0,
"has_email": 0,
"next_followup": "2019-06-01T21:24:07+03:00",
"unsubscribed_at": null,
"archived_at": null,
"created_at": "2019-05-29T21:24:07+03:00",
"updated_at": "2019-05-29T21:24:07+03:00"
}
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxxxx.aritic.com/acrm/api/v1/leads/2")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxx/acrm/api/v1/leads/2",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxx/acrm/api/v1/leads/2');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxx/acrm/api/v1/leads/2"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxxxx/acrm/api/v1/leads/2")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxxx/acrm/api/v1/leads/2 \
--header 'Authorization':Bearer your_access_token
HTTP Request
GET /api/v1/payments/{id}
Response
Expected Response Code: 200
Update Payment
We can update the payment via payment id.
HTTP Request
PUT /api/v1/payments/{id}
Response
Expected Response Code: 200
Parameters
| Name | required | description |
|---|---|---|
| invoice_id | required | Invoice ID |
| payment_date | required | Date when the payment was made |
| amount | required | Amount of payment made |
| payment_method | required | Payment method ID |
| notes | optional | Payment additional notes |
| currency | optional | Payment Currency |
Delete Payment
We can delete the payment.
HTTP Request
DELETE /api/v1/payments/{id}
Response
Expected Response Code: 200
List all Payments
Get a list of all payments.
{
"data": []
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxx/acrm/api/v1/payments")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxx/acrm/api/v1/payments",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxx/acrm/api/v1/payments');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxx/acrm/api/v1/payments"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxx/acrm/api/v1/payments")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxx/acrm/api/v1/payments \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/payments
Response
Expected Response Code: 200
Show Payment Comments
Show proposal payment comments.
HTTP Request
GET /api/v1/payments/{id}/comments
Response
Expected Response Code: 200
Mark Payment as Refunded
Mark a payment as refunded.
HTTP Request
POST /api/v1/payments/{id}/refund
Response
Expected Response Code: 200
Todos
Create a new todo.
Create Todo
With the help of this we can able to create new Todo.
HTTP Request
POST /api/v1/todos
Response
Expected Response Code: 200
Parameters
| Name | Required | Description |
|---|---|---|
| module | required | Module related to todo e.g deals, clients, leads |
| module_id | required | Entity ID e.g 18 |
| subject | required | Todo subject |
| due_date | optional | Todo start date |
| assignee | optional | User ID of the person responsible |
| notes | optional | Additional notes |
Get Todo by ID
Get todo information.
{
"data": [
{
"type": "todos",
"id": "2",
"attributes": {
"id": 2,
"subject": "Calling day after tomorrow about pricing",
"order": 0,
"parent": 0,
"due_date": "2019-05-25T03:01:00+03:00",
"notes": "Calling to him and talking about discount",
"assignee": {
"id": 1,
"name": "Arul Raj"
},
"reminded_at": null,
"entity": {
"id": 2,
"name": "Deomo"
},
"is_visible": 0,
"completed": 0,
"user_id": 1,
"created_at": "2019-05-23T14:02:59+03:00",
"updated_at": "2019-05-23T15:05:59+03:00"
}
},
{
"type": "todos",
"id": "1",
"attributes": {
"id": 1,
"subject": "New task",
"order": 0,
"parent": 0,
"due_date": "2019-05-22T09:04:00+03:00",
"notes": "Need to finish",
"assignee": {
"id": 1,
"name": "Arul Raj"
},
"reminded_at": null,
"entity": {
"id": 1,
"name": "Dummy Deal"
},
"is_visible": 0,
"completed": 1,
"user_id": 1,
"created_at": "2019-05-21T21:04:57+03:00",
"updated_at": "2019-05-23T14:45:23+03:00"
}
}
]
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxxx/acrm/api/v1/todos")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxx/acrm/api/v1/todos",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxxx/acrm/api/v1/todos');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxx/acrm/api/v1/todos"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxxx/acrm/api/v1/todos")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxxxxx/acrm/api/v1/todos \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/todos/{id}
Response
Expected Response Code: 200
Update Todo
Update todo information.
{
"type": "todos",
"id": "2",
"attributes": {
"id": 2,
"subject": "Calling day after tomorrow about pricing",
"order": 0,
"parent": 0,
"due_date": "2019-05-25T03:01:00+03:00",
"notes": "Calling to him and talking about discount",
"assignee": {
"id": 1,
"name": "Arul Raj"
},
"reminded_at": null,
"entity": {
"id": 2,
"name": "Deomo"
},
"is_visible": 0,
"completed": 0,
"user_id": 1,
"created_at": "2019-05-23T14:02:59+03:00",
"updated_at": "2019-05-23T15:05:59+03:00"
}
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxxx/acrm/api/v1/todos/2")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxx/acrm/api/v1/todos/2",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxx/acrm/api/v1/todos/2');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxxxxx/acrm/api/v1/todos/2"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxx/acrm/api/v1/todos/2")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxx/acrm/api/v1/todos/2 \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
PUT /api/v1/todos/{id}
Response
Expected Response Code: 200
Parameters
| Name | Required | Description |
|---|---|---|
| subject | required | Todo subject |
| due_date | optional | Todo start date |
| assignee | optional | User ID of the person responsible |
| notes | optional | Additional notes |
Delete Todo
Delete a todo.
{
"status": "success",
"message": "Record will be deleted in a moment"
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxxx/acrm/api/v1/todos/2")
.delete(null)
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxxx/acrm/api/v1/todos/2",
"method": "DELETE",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxxx/acrm/api/v1/todos/2');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxxxx/acrm/api/v1/todos/2"
payload = ""
headers = {
'Authorization': "Bearer your_access_token",
'cache-control': "no-cache",
}
response = requests.request("DELETE", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxx/acrm/api/v1/todos/2")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Delete.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body
curl --request DELETE \
--url https://xxxxxx/acrm/api/v1/todos/2 \
--header 'Authorization: Bearer your_access_token' \
--header 'cache-control: no-cache'
HTTP Request
DELETE /api/v1/todos/{id}
Response
Expected Response Code: 200
List all Todos
Get a list of all todos.
{
"data": [
{
"type": "todos",
"id": "1",
"attributes": {
"id": 1,
"subject": "New task",
"order": 0,
"parent": 0,
"due_date": "2019-05-22T09:04:00+03:00",
"notes": "Need to finish",
"assignee": {
"id": 1,
"name": "Arul Raj"
},
"reminded_at": null,
"entity": {
"id": 1,
"name": "Dummy Deal"
},
"is_visible": 0,
"completed": 1,
"user_id": 1,
"created_at": "2019-05-21T21:04:57+03:00",
"updated_at": "2019-05-23T14:45:23+03:00"
}
}
]
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://xxxx/acrm/api/v1/todos")
.get()
.addHeader("Authorization", "Bearer your_access_token")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
var settings = {
"async": true,
"crossDomain": true,
"url": "https://xxxxxx/acrm/api/v1/todos",
"method": "GET",
"headers": {
"Authorization": "Bearer your_access_token",
"cache-control": "no-cache",
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
$request = new HttpRequest();
$request->setUrl('https://xxxxxxx/acrm/api/v1/todos');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'cache-control' => 'no-cache',
'Authorization' => Bearer your_access_token
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
import requests
url = "https://xxxxxx/acrm/api/v1/todos"
payload = ""
headers = {
'cache-control': "no-cache",
}
response = requests.request("GET", url, data=payload, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://xxxxxx/acrm/api/v1/todos")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = Bearer your_access_token
request["cache-control"] = 'no-cache'
request["Postman-Token"] = 'hjkb1703-e2bf-4b42-89ab-934077dc9561'
response = http.request(request)
puts response.read_body
curl --request GET \
--url https://xxxxxxx/acrm/api/v1/todos \
--header 'Authorization: Bearer your_access_token' \
--header 'Postman-Token: hjk1909d-1fe0-4abf-9bde-87bdfc38d4a8' \
--header 'cache-control: no-cache'
HTTP Request
GET /api/v1/todos
Response
Expected Response Code: 200