Download as pdf or txt
Download as pdf or txt
You are on page 1of 24

Integration APIs

Sandbox Authentication:

URL https://misritalia--dev.sandbox.my.salesforce.com/services/oauth2/token?

HTTP Method Post

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
grant_type: password
client_id:
3MVG9vDPWAliPr7rq4CygCejnPA6itTrbwi2WFjxU9iC5HFTpd9WhhMO
KhHuAo1aF0jG5mwXwAZkPTXyyHPP.
client_secret:
131E7B4312FE2AE4EFACE5C2F2CA3D05904A25C0D46FFE64C05A96
5E3690649F
username: misritalia@cloudzlab.com.integration
password: MI1234567ODjmlfosOeLyThM8L7vbGCN4

Body

Response {
"access_token":
"00D7e00000GLED1!AQsAQGz6BejJhNaRkZB7SlLwaPkbh0s8kk_Q4O_vJ
7xtzzx9zgkuPGM3CwcBKTK3q5IxVexu6Tlg.oMEWOwBeBvOYNtP4Gsq",
"instance_url": "https://misritalia--dev.sandbox.my.salesforce.com",
"id":
"https://test.salesforce.com/id/00D7e00000GLED1EAP/0057e00000ThPq2
AAF",
"token_type": "Bearer",
"issued_at": "1672056867336",
"signature": "WU3v6Ayhl1N6VI7lWWn73xE4Ydfi8ULoGWI6hr/DbkQ="
}
Production Authentication:

URL https://misritalia.my.salesforce.com/services/oauth2/token?

HTTP Method Post

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
grant_type: password
client_id:
3MVG9riCAn8HHkYVroMgKgDnX3OgS_bN9QvWW5QStH.hMnJNb9qN
UhdZz9hYP6ISEyBBYF3QdeS0voM2IQYrC
client_secret:
0D2797712C8E2C3DF18785BA24DF7965A888D9B880C2177FE83DA23
8B89DB4BC
username: mc.misritalia@cloudzlab.com
password: CloudzLab003Hx81RWBu222nDpIbhGhGsq1Q

Body

Response {
"access_token":
"00D8c000007EPHF!ARcAQNPbS09qCD0W3DW.83nzqACFLlErRGJIlKu8
GRUO6I.jyTrf1ZaT86x7JVFIfki2B0NGN29FLgtoRvmet1bSLOfMD4da",
"instance_url": "https://misritalia.my.salesforce.com",
"id":
"https://login.salesforce.com/id/00D8c000007EPHFEA4/0058c00000DiPeiA
AF",
"token_type": "Bearer",
"issued_at": "1691673383155",
"signature": "aFEWkatFLr8YZVr9rfupoEZJ5FYo7+mMz4q4DQGuPj4="
}
Create new Company:

Sandbox URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje


cts/Company__c

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Company_
URL _c

HTTP Method Post

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token

Body {
"Name": "Misr Italia",
"Sap_Code__c" : "company1234"
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Fields Name → Required


Sap_Code__c → Required

Update Company:

URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Company__c/Sap_Code__c/{sapId}

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Company_
URL _c/Sap_Code__c/{sapId}

HTTP Method Patch

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token

Body {
"Name": "Misr Italia",
"Sap_Code__c" : "company1234"
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Create New Project:

URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Project__c

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Project__c
URL

HTTP Method Post

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token

Body {
"Name": "Misr Italia",
“Company_Sap_Code__c” : “SapId”,
"Sap_Code__c" : "project1234"
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Fields Name → Required


Sap_Code__c → Required
Company → Required

Update Project:

URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Project__c/Sap_Code__c/{SapId}

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Project__c
URL /Sap_Code__c/{SapId}

HTTP Method Patch

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token

Body {
"Name" : "Cairo Business Park",
“Company_Sap_Code__c” : “SapId”,
"Sap_Code__c" : "externalId"
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Create New Phase:


URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Phase__c

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Phase__c
URL

HTTP Method Post

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token

Body {
"Name" : "Cairo Business Park",
“Project_Sap_Code__c” :”SapId”,
"Sap_Code__c" : "externalId"
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Fields Name → Required


Sap_Code__c → Required
Project__c → Required

Update Phase:

URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Phase__c/Sap_Code__c/{sapId}

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Phase__c/
URL Sap_Code__c/{sapId}

HTTP Method Patch

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token
Body {
"Name" : "Cairo Business Park",
“Project_Sap_Code__c” :”SapId”,
"Sap_Code__c" : "externalId"
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Create New Building:

URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Building__c

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Building__
URL c

HTTP Method Post

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token

Body {
"Name" : "Cairo Business Park",
“Zone_Sap_Code__c” : “SapId”,
"Sap_Code__c" : "externalId"
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Fields Name → Required


Sap_Code__c → Required
Zone__c → Required

Update Building:

URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Building__c/Sap_Code__c/{SapId}

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Building__
URL c/Sap_Code__c/{SapId}

HTTP Method Patch

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token

Body {
"Name" : "Cairo Business Park",
“Zone_Sap_Code__c” : “SapId”,
"Sap_Code__c" : "externalId"
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Create New Zone:


URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Zone__c

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Zone__c
URL

HTTP Method Post

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token

Body {
"Name" : "Cairo Business Park",
“Phase_Sap_Code__c” : “SapId”,
"Sap_Code__c" : "externalId"
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Fields Name → Required


Sap_Code__c → Required
Phase__c → Required

Update Zone:

URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Zone__c/Sap_Code__c/{sapId}

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Zone__c/S
URL ap_Code__c/{sapId}

HTTP Method Patch

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token

Body {
"Name" : "Cairo Business Park",
“Phase_Sap_Code__c” : “SapId”,
"Sap_Code__c" : "externalId"
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Create New Unit:

URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Unit__c

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Unit__c
URL

HTTP Method Post

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token

Body
{
"Name" : "U-07",
"Stages__c" : "Booked",
"Type__c" : "Villa",
"Price__c" : 1340000.0,
"Area__c" : 800.0,
"Number_of_Beds__c" : "4",
"Maintenance_Price__c" : 100000.0,
"Estimated_Delivery_Date__c" : null,
"Club_Price__c" : 400000.0,
"Project__c" : "salesforceId",
"Delivery_Months__c" : null,
"Maintenance_Fees__c" : null,
"Floor__c" : null,
"Release_Date__c" : null,
"Unit_Usage__c" : "Residential",
"Finishing_Type__c" : "Fully Finished",
"Parking_Area__c" : null,
"Garden_Area__c" : null,
"Basement_2__c" : null,
"Roof__c" : null,
"Penthouse__c" : null,
"Court__c" : null,
"Basement__c" : null,
"Terrace__c" : null,
"Lower_1__c" : null,
"Lower_2__c" : null,
“Sap_Code_For_Project__c” :”SapId”,
“Sap_Code_For_Phase__c” :”SapId”,
“Sap_Code_For_Building__c” :”SapId”,
"Sap_Code__c" : "externalId"
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Fields Name → Required


Sap_Code__c → Required
Zone__c → Required
Building__c → Required
Stages__c → Required
Type__c → Required
Price__c → Required
Area__c → Required
Number_of_Beds__c → Required
Maintenance_Price__c → Required
Estimated_Delivery_Date__c → Required
Project__c → Required
Delivery_Months__c → Required
Unit_Usage__c → Required
Phase__c → Required
Sap_Code__c → Required

List of Values Stages__c:


Not Released
Hold
Available
Blocked
Temporarily Blocked
Reserved
Booked
Contracted

Number_Of_Beds__c:
1
2
3
4
5

Type__c:
Apartment
Villa
Twin House
Town House

Finishing_Type__c:
Core and Shell
Semi Finished
Fully Finished

Unit_Usage__c:
Residential
Commercial

Floor__c:
Ground
1st Floor
2nd Floor
3rd Floor
4th Floor
5th Floor
6th Floor
7th Floor

Update Unit:

URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Unit__c/Sap_Code__c/{sapId}

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Unit__c/Sa
URL p_Code__c/{sapId}

HTTP Method Patch

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token

Body
{
"Name" : "U-07",
"Stages__c" : "Booked",
"Type__c" : "Villa",
"Price__c" : 1340000.0,
"Area__c" : 800.0,
"Number_of_Beds__c" : "4",
"Maintenance_Price__c" : 100000.0,
"Estimated_Delivery_Date__c" : null,
"Club_Price__c" : 400000.0,
"Delivery_Months__c" : null,
"Maintenance_Fees__c" : null,
"Floor__c" : null,
"Release_Date__c" : null,
"Unit_Usage__c" : "Residential",
"Finishing_Type__c" : "Fully Finished",
"Parking_Area__c" : null,
"Garden_Area__c" : null,
"Basement_2__c" : null,
"Roof__c" : null,
"Penthouse__c" : null,
"Court__c" : null,
"Basement__c" : null,
"Terrace__c" : null,
"Lower_1__c" : null,
"Lower_2__c" : null,
“Sap_Code_For_Project__c” :”SapId”,
“Sap_Code_For_Phase__c” :”SapId”,
“Sap_Code_For_Building__c” :”SapId”,
"Sap_Code__c" : "externalId"
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Create new Payment Plan:

URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Payment_Term__c

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Payment_
URL Term__c

HTTP Method Post

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token

Body {
"Name" : "4 Years,5% DP,Monthly",
"CurrencyIsoCode" : "EGP",
"Installments_Frequency__c" : "Monthly",
"Years_of_Installment__c" : 4.0,
"Status__c" : "Active",
"Discount_Percentage__c" : null,
"Delivery_Percentage__c" : 5.0,
"First_Installment_Percentage__c" : 5.0,
"Down_Payment_Percentage__c" : 5.0,
"Total_Percentage_Till_Delivery__c" : 50.0,
"Reservation_Percentage__c" : 5.0,
"Start_Date__c" : "2022-10-31",
"End_Date__c" : null,
"Sap_Code__c" : “PP001”,
“Active__c”: FALSE
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Fields Name → Required


CurrencyIsoCode → Required
Installments_Frequency__c→ Required
Years_of_Installment__c → Required
Status__c → Required
Down_Payment_Percentage__c → Required
Total_Percentage_Till_Delivery__c : → Required
Reservation_Percentage__c : → Required
Start_Date__c → Required
Sap_Code__c → Required
Active → Required

List of Values Status__c:


Draft
In Approval
Approved
Rejected
Active

Installments_Frequency__c:
Cash
Monthly
Quarterly
Semi Annually
Annually
Update Payment Plan:

URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Payment_Term__c/Sap_Code__c/{sapid}

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Payment_
URL Term__c/Sap_Code__c/{sapid}

HTTP Method Patch

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token

Body {
"Name" : "4 Years,5% DP,Monthly",
"CurrencyIsoCode" : "EGP",
"Installments_Frequency__c" : "Monthly",
"Years_of_Installment__c" : 4.0,
"Status__c" : "Active",
"Discount_Percentage__c" : null,
"Delivery_Percentage__c" : 5.0,
"First_Installment_Percentage__c" : 5.0,
"Down_Payment_Percentage__c" : 5.0,
"Total_Percentage_Till_Delivery__c" : 50.0,
"Reservation_Percentage__c" : 5.0,
"Start_Date__c" : "2022-10-31",
"End_Date__c" : null,
"Sap_Code__c" : null,
“Active” : TRUE
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Create New Inventory Payment Plan:


URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Inventory_Payment_Term__c

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Inventory_
URL Payment_Term__c

HTTP Method Post

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token

Body {
"Name" : "Inv 002",
"Payment_Term__c" : "payment plan salesforce Id",
"Project__c" : "project salesforce Id",
"Phase__c" : "phase salesforce Id",
"Sap_Code__c" : null,
"Building__c" : null,
"Unit__c" : null,
"Company__c" : null,
"Zone1__c" : null
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Fields "Name" → Required


"Payment_Term__c" → Required
"Sap_Code__c" → Required
Project__c,Phase__c,Building__c,Unit__c,Zone1__c → At least one of
them must be filled

Update Inventory Payment Plan:


URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Inventory_Payment_Term__c/Sap_Code__c/{sapId}

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Inventory_
URL Payment_Term__c/Sap_Code__c/{sapId}

HTTP Method Patch

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token

Body {
"Name" : "Inv 002",
"Payment_Term__c" : "payment plan salesforce Id",
"Project__c" : "project salesforce Id",
"Phase__c" : "phase salesforce Id",
"Sap_Code__c" : null,
"Building__c" : null,
"Unit__c" : null,
"Company__c" : null,
"Zone1__c" : null
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Create New Installment:

URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Installment__c

Production https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
URL cts/Installment__c

HTTP Method Post


Header Content-Type: application/json; charset=UTF-8
Accept: application/json
Authorization: Bearer + Access Token

Body {
"Name" : "Down Payment",
"CurrencyIsoCode" : "EGP",
"Installment_Amount__c" : 134000.0,
"Installment_Date__c" : "2022-10-27",
"Installment_Percentage__c" : 10.0,
"Installment_Type__c" : "Down Payment",
"Status__c" :,
"Account_Sap_Code__c": sap Id,
"Unit_Sap_Code__c": sap Id,
"Sap_Code__c": sap Id
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Fields All fields are required

List of Values Status__c:


Not Due
Paid
Cancelled

Installment_Type__c:
Down Payment
Installment
Delivery
Maintenance

Update Installment:
URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Installment__c/Sap_Code__c/{SapId}

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Installment
URL __c/Sap_Code__c/{SapId}

HTTP Method Patch

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token

Body {
"Name" : "Down Payment",
"CurrencyIsoCode" : "EGP",
"Installment_Amount__c" : 134000.0,
"Installment_Date__c" : "2022-10-27",
"Installment_Percentage__c" : 10.0,
"Installment_Type__c" : "Down Payment",
"Status__c" :,
"Account_Sap_Code__c": sap Id,
"Unit_Sap_Code__c": sap Id,
"Sap_Code__c": sap Id
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Update Account:

URL https://misritalia--dev.sandbox.my.salesforce.com/services/data/v56.0/sobje
cts/Account/Sap_Code__c/{sapId}

Production https://misritalia.my.salesforce.com/services/data/v56.0/sobjects/Account/S
URL ap_Code__c/{sapId}
HTTP Method Patch

Header Content-Type: application/json; charset=UTF-8


Accept: application/json
Authorization: Bearer + Access Token

Body {
"LastName" : "Abdelaziz",
"FirstName" : "Ahmed",
"Salutation" : "Mr.",
"MiddleName" : null,
"Arabic_Name__c" : "Ahmed",
"ParentId" : null,
"BillingStreet" : null,
"BillingCity" : null,
"BillingState" : null,
"BillingPostalCode" : null,
"BillingCountry" : null,
"BillingStateCode" : null,
"BillingCountryCode" : null,
"BillingLatitude" : null,
"BillingLongitude" : null,
"BillingGeocodeAccuracy" : null,
"BillingAddress" : null,
"ShippingStreet" : null,
"ShippingCity" : null,
"ShippingState" : null,
"ShippingPostalCode" : null,
"ShippingCountry" : null,
"ShippingStateCode" : null,
"ShippingCountryCode" : null,
"ShippingLatitude" : null,
"ShippingLongitude" : null,
"ShippingGeocodeAccuracy" : null,
"ShippingAddress" : null,
"Phone" : "01009944873",
"PersonMobilePhone" : "01278193677",
"PersonEmail" : "aabdelaziz@cloudzlab.com",
"PersonTitle" : null,
"Date_of_Birth__c" : "1980-09-08",
"Passport_Number__c" : null,
"Customer_Name__c" : null,
"ID_Number__c" : 2.8009084866228E13,
"Sap_Code__c" : null,
"Occupation__c" : null,
"Residency_Number__c" : null,
"Nationality__c" : "EH",
"Gender__c" : null,
"Birth_Place__c" : null,
"Marital_Status__c" : null,
"Government__c" : null,
"Street3__c" : null,
"Street4__c" : null,
"Street5__c" : null,
"Street6__c" : null,
"Street7__c" : null,
"Street8__c" : null,
"Other_Mobile__c" : null,
"Id_Valid_From_Date__c" : null,
"Id_Valid_To_Date__c" : null,
"HouseNo1__c" : null,
"HouseNo2__c" : null,
"District1__c" : null,
"District2__c" : null,
"IDNumber__c" : null,
"ID_Type__c" : null,
"Average_Rating__pc" : "3"
}

Response {
"id" : "a097e00000Nyu72AAB",
"success" : true,
"errors" : [ ]
}

Update Unit Status:

URL https://misritalia--dev.sandbox.my.salesforce.com/services/apexrest/Update
UnitStatus

Production https://misritalia.my.salesforce.com/services/apexrest/UpdateUnitStatus
URL

HTTP Method Put


Header Content-Type: application/json; charset=UTF-8
Accept: application/json
Authorization: Bearer + Access Token

Body {
"UnitId" : "unit Sap Code",
"CustomerID" : "Account Sap Code",
"Status" : "Unit status",
"ContractID" : "",
"OfferID" : ""
}

Response {
"success" : true,
"errors" : [ ]
}

You might also like