POST api/OrgApi
No documentation available.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| organisation | No documentation available. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"Business": {
"$id": "2",
"Id": "4f0d697c-901b-435e-9a20-5cc83a24d82e",
"Description": "sample string 2",
"StartDate": "2025-11-05T23:18:09.5525754+00:00",
"FirstOwner": "sample string 3",
"AnnualTurnOver": "sample string 4",
"GroupClassification": "sample string 5",
"Division": "sample string 6",
"NoOfPeople": 7,
"Contact": {
"$ref": "1"
}
},
"Individual": {
"$id": "3",
"$values": [
{
"$id": "4",
"Title": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Postition": "sample string 4",
"Organisation": {
"$id": "5",
"$values": [
{
"$ref": "1"
},
{
"$ref": "1"
},
{
"$ref": "1"
}
]
},
"IsCompanyBased": true,
"SaveId": "bf96c99c-2a2b-4f8d-84b2-7268f174f634",
"TenantId": "sample string 8",
"EdgeTenantId": "sample string 9",
"EdgeCompanyName": "sample string 10",
"ContactSignature": "sample string 11",
"UserId": "sample string 12",
"ContactSource": "sample string 13",
"UserName": "sample string 14",
"Status": "sample string 15",
"PreferredTradeCurrency": "sample string 16",
"MaxCreditLimit": 17.1,
"CreditCurrency": "sample string 18",
"DueTimeTill": 19,
"KnownSince": "2025-11-05T23:18:09.5525754+00:00",
"LastActivity": "2025-11-05T23:18:09.5525754+00:00",
"XeroShortCode": "sample string 20",
"Image": "sample string 21",
"Categories": "sample string 22",
"CreditRating": "sample string 23",
"Grade": "sample string 24",
"Phone": {
"$id": "6",
"$values": [
{
"$id": "7",
"Id": 1,
"PhoneNo": "sample string 2",
"PhoneExt": "sample string 3",
"PhoneType": "sample string 4",
"ContactId": "328586ba-18a0-48ed-9b0f-5dff3852d247",
"Contact": {
"$id": "8",
"SaveId": "19e0d15b-76c3-4184-9cde-b578d0cf0883",
"TenantId": "sample string 2",
"EdgeTenantId": "sample string 3",
"EdgeCompanyName": "sample string 4",
"ContactSignature": "sample string 5",
"UserId": "sample string 6",
"ContactSource": "sample string 7",
"UserName": "sample string 8",
"Status": "sample string 9",
"PreferredTradeCurrency": "sample string 10",
"MaxCreditLimit": 11.1,
"CreditCurrency": "sample string 12",
"DueTimeTill": 13,
"KnownSince": "2025-11-05T23:18:09.5525754+00:00",
"LastActivity": "2025-11-05T23:18:09.5525754+00:00",
"XeroShortCode": "sample string 14",
"Image": "sample string 15",
"Categories": "sample string 16",
"CreditRating": "sample string 17",
"Grade": "sample string 18",
"Phone": {
"$id": "9",
"$values": [
{
"$ref": "7"
},
{
"$ref": "7"
},
{
"$ref": "7"
}
]
},
"SocialChannel": {
"$id": "10",
"$values": [
{
"$id": "11",
"Id": 1,
"ContactChannel": "sample string 2",
"ChannelType": "sample string 3",
"ContactId": "4fdfca20-2e4b-4359-b0be-bf92b2176b36",
"Contact": {
"$ref": "8"
},
"IsDeleted": true
},
{
"$ref": "11"
},
{
"$ref": "11"
}
]
},
"Website": {
"$id": "12",
"$values": [
{
"$id": "13",
"Id": 1,
"WebName": "sample string 2",
"WebType": "sample string 3",
"ContactId": "a5612e97-2b14-45ae-94aa-f06c9428ec47",
"IsDeleted": true,
"Contact": {
"$ref": "8"
}
},
{
"$ref": "13"
},
{
"$ref": "13"
}
]
},
"Email": {
"$id": "14",
"$values": [
{
"$id": "15",
"Id": 1,
"ContactEmail": "sample string 2",
"EmailType": "sample string 3",
"ContactId": "6fb9b7d4-353c-492d-8fe9-d47483e2947f",
"Contact": {
"$ref": "8"
},
"IsDeleted": true
},
{
"$ref": "15"
},
{
"$ref": "15"
}
]
},
"Note": {
"$id": "16",
"$values": [
{
"$id": "17",
"Id": 1,
"UserId": "sample string 2",
"Activity": "sample string 3",
"Detail": "sample string 4",
"CreatdTimestamp": "2025-11-05T23:18:09.5525754+00:00",
"UserName": "sample string 6",
"Message": "sample string 7",
"ContactId": "7487f8e4-d038-459b-9f74-adc424095570",
"Contact": {
"$ref": "8"
}
},
{
"$ref": "17"
},
{
"$ref": "17"
}
]
},
"Address": {
"$id": "18",
"$values": [
{
"$id": "19",
"AddressId": 1,
"CountryName": "sample string 2",
"AddressType": "sample string 3",
"AddressLine1": "sample string 4",
"AddressLine2": "sample string 5",
"TownLocality": "sample string 6",
"CityRegion": "sample string 7",
"PostalZipCode": "sample string 8",
"State": "sample string 9",
"INState": "sample string 10",
"MXState": "sample string 11",
"BRState": "sample string 12",
"CAState": "sample string 13",
"SiteName": "sample string 14",
"IsMain": true,
"ContactId": "52587a69-218f-4801-a7c3-e0c0bf95d5a7",
"Contact": {
"$ref": "8"
},
"IsDeleted": true
},
{
"$ref": "19"
},
{
"$ref": "19"
}
]
},
"Carrier": {
"$id": "20",
"$values": [
{
"$id": "21",
"CarrierId": 1,
"LogisticCompany": "sample string 2",
"AccountNumber": "sample string 3",
"TaxNumber": "sample string 4",
"TaxType": "sample string 5",
"IsMain": true,
"ContactId": "bc2b93ad-ab03-49dd-8566-cc54c962da1c",
"Contact": {
"$ref": "8"
},
"IsDeleted": true
},
{
"$ref": "21"
},
{
"$ref": "21"
}
]
},
"BankDetail": {
"$id": "22",
"AccountId": "61471703-5212-4c1d-9d63-aed6247a5931",
"AccountName": "sample string 2",
"AccountNo": "sample string 3",
"SortCode": "sample string 4",
"BankIBAN": "sample string 5",
"BankSwift": "sample string 6",
"Contact": {
"$ref": "8"
}
},
"ControlsLicence": {
"$id": "23",
"ControlsLicenceId": "1cebe104-3ee4-401a-8c76-fb1cf06df732",
"IsLicence": true,
"LicenceNo": "sample string 3",
"LicenceExpiryDate": "sample string 4",
"Contact": {
"$ref": "8"
},
"IsDeleted": true
},
"FinancialArrangement": {
"$id": "24",
"FinancialId": "00546ce5-350b-4ee9-9959-0285f24e4869",
"PaymentTerm": "sample string 2",
"PaymentTermValue": "sample string 3",
"PaymentMethod": "sample string 4",
"PaymentMethodValue": "sample string 5",
"Discount": 6.1,
"Commission": 7.1,
"BankAccountName": "sample string 8",
"BankAccountNumber": "sample string 9",
"BankSortCode": "sample string 10",
"SaleTaxRegistration": "sample string 11",
"SaleTax": "sample string 12",
"CompanyRegistrationNumber": "sample string 13",
"CustomerAccNo": "sample string 14",
"EoriNumber": "sample string 15",
"Contact": {
"$ref": "8"
}
},
"Supplier": {
"$id": "25",
"Id": "0464e0b1-519e-4bc2-84de-34fdfc34fe73",
"AccountNo": "sample string 2",
"SupplierId": "sample string 3",
"NormalLeadTime": 4.0,
"ActualLeadTime": 5.0,
"OrderQuantity": 6.0,
"OrderValue": 7.0,
"CallOff": 8.0,
"IsSupplier": true,
"Contact": {
"$ref": "8"
}
},
"Logistic": {
"$id": "26",
"Id": "7c0c89b9-c932-4273-8f30-e0cb10de1b52",
"EmailForQuote": "sample string 2",
"IsLogisticQuote": true,
"IsLogisticFirm": true,
"Contact": {
"$ref": "8"
}
},
"Category": {
"$id": "27",
"CategoryId": "7e950864-355c-4b94-8d2b-2860d0463286",
"IsAgent": true,
"IsConsultant": true,
"IsCustomer": true,
"IsDistributor": true,
"IsFinancer": true,
"IsFreightForwarder": true,
"IsInsurer": true,
"IsReferrer": true,
"IsManufacturer": true,
"IsFriend": true,
"IsProcessor": true,
"IsStaff": true,
"IsOther": true,
"IsConsignor": true,
"IsSupplier": true,
"IsInstaller": true,
"IsDriver": true,
"IsSubContractor": true,
"Miscellaneous": "sample string 20",
"IsRetailer": true,
"IsSeller": true,
"Contact": {
"$ref": "8"
}
},
"ContactFiles": {
"$id": "28",
"$values": [
{
"$id": "29",
"ContactFileId": "c60bd855-dc2a-47f9-b185-74ddbf4f40a2",
"ContactSaveId": "540cce2e-a1f8-47f3-bd39-18f50900955d",
"SpecificationType": "sample string 3",
"FileName": "sample string 4",
"DocType": "sample string 5",
"WhenAttached": "sample string 6",
"ValidTillDateTime": "sample string 7",
"NoOfPages": "sample string 8",
"FileData": "sample string 9",
"FilePath": "sample string 10",
"Comments": "sample string 11",
"Contact": {
"$ref": "8"
}
},
{
"$ref": "29"
},
{
"$ref": "29"
}
]
},
"ContactMethod": {
"$id": "30",
"ContactMethodId": "9cb51589-e267-40b4-bc25-1298de0dcfca",
"LinkedIn": "sample string 2",
"Twitter": "sample string 3",
"FaceBook": "sample string 4",
"IM": {
"$id": "31",
"$values": [
{
"$id": "32",
"Id": 1,
"Message": "sample string 2",
"IMType": "sample string 3",
"ContactMethodId": "ea6f59e4-bbe4-489a-853a-b56eabcf796a",
"ContactMethod": {
"$ref": "30"
},
"IsDeleted": true
},
{
"$ref": "32"
},
{
"$ref": "32"
}
]
},
"Contact": {
"$ref": "8"
}
},
"BuyingCriteria": {
"$id": "33",
"CriteriaId": "c83248f5-9e11-404a-a609-0d7f7eb28b9d",
"AuthoriseToBuy": "sample string 2",
"Period": "sample string 3",
"Method": "sample string 4",
"Power": "sample string 5",
"Expectation": "sample string 6",
"Need": "sample string 7",
"Contact": {
"$ref": "8"
}
},
"SaleApproach": {
"$id": "34",
"Id": "e73f8c57-3331-47ce-a4ed-1aace0844e60",
"GiveDiscounts": "sample string 2",
"ContactEvery": "sample string 3",
"EmailMarketing": "sample string 4",
"CurrentSupplier": "sample string 5",
"Competitor": "sample string 6",
"Competitors": {
"$id": "35",
"$values": [
{
"$id": "36",
"Id": 1,
"CompetitorName": "sample string 2",
"SaleId": "4eaa7fd9-2a98-442c-84da-c2e2de782159",
"SaleApproach": {
"$ref": "34"
},
"IsDeleted": true
},
{
"$ref": "36"
},
{
"$ref": "36"
}
]
},
"Suppliers": {
"$id": "37",
"$values": [
{
"$id": "38",
"Id": 1,
"SupplierName": "sample string 2",
"SaleId": "040441ce-0362-457c-9145-20e21818987f",
"SaleApproach": {
"$ref": "34"
},
"IsDeleted": true
},
{
"$ref": "38"
},
{
"$ref": "38"
}
]
},
"OurRelationship": "sample string 7",
"RelationshipMgr": "sample string 8",
"Contact": {
"$ref": "8"
}
},
"AppendNotes": {
"$id": "39",
"$values": [
{
"$id": "40",
"AppendNoteId": 1,
"CreatedDate": "2025-11-05T23:18:09.5525754+00:00",
"CreatedBy": "sample string 3",
"ActivityNote": "sample string 4",
"AppendNote": "sample string 5",
"Subject": "sample string 6",
"ContactName": "sample string 7",
"ContactMethod": "sample string 8",
"Location": "sample string 9",
"ChildAppendNotes": "sample string 10",
"ContactId": "c28be182-d3d9-4acc-bc7a-fe6f253ecfe6",
"Contact": {
"$ref": "8"
}
},
{
"$ref": "40"
},
{
"$ref": "40"
}
]
},
"Event": {
"$id": "41",
"$values": [
{
"$id": "42",
"EventId": 1,
"Subject": "sample string 2",
"EventType": "sample string 3",
"AssignTo": "sample string 4",
"StartDate": "2025-11-05T23:18:09.5525754+00:00",
"EndDate": "2025-11-05T23:18:09.5525754+00:00",
"IsAllDayEvent": "sample string 7",
"ContactName": "sample string 8",
"ContactEmail": "sample string 9",
"ContactMethod": "sample string 10",
"Location": "sample string 11",
"Status": "sample string 12",
"IsCalendarEvent": "sample string 13",
"Note": "sample string 14",
"SenderComapny": "sample string 15",
"SenderEmail": "sample string 16",
"MainEventId": 17,
"ContactId": "4d8d21d5-ae33-484c-af42-3f6855cdb3a3",
"Contact": {
"$ref": "8"
}
},
{
"$ref": "42"
},
{
"$ref": "42"
}
]
},
"CreatedTimestamp": "2025-11-05T23:18:09.5525754+00:00",
"IsClient": true,
"RpsStatus": "sample string 21",
"RpsUpdatedDate": "2025-11-05T23:18:09.5525754+00:00",
"PersonalInformation": {
"$id": "43",
"PersonalId": "5de3f8d2-ca4f-4e62-b1ea-644d1a5fa8be",
"Gender": "sample string 1",
"DateOfBirth": "2025-11-05T23:18:09.5525754+00:00",
"NotifyBirthday": "sample string 2",
"Occupation": "sample string 3",
"MaritalStatus": "sample string 4",
"PersonalStatus": "sample string 5",
"Interests": "sample string 6",
"NationalInsuranceNo": "sample string 7",
"Contact": {
"$ref": "8"
}
},
"MinExpiryDays": 22,
"CountryList": {
"$id": "44",
"$values": [
{
"$id": "45",
"Id": 1,
"CountryCode": "sample string 2",
"Name": "sample string 3",
"Type": "sample string 4"
},
{
"$ref": "45"
},
{
"$ref": "45"
}
]
},
"XeroId": "d2c6feb0-814a-420f-ad52-bbcd1c3b9104",
"OwingAmount": 24.1,
"OwingCcy": "sample string 25",
"FreeAgentId": "sample string 26",
"QuickBookId": "sample string 27",
"QuickBookSupplierId": "sample string 28",
"SageOneId": "sample string 29",
"ShopifyId": "sample string 30",
"BigCommerceId": "sample string 31",
"FaireId": "sample string 32",
"WooCommerceId": "sample string 33",
"UpdatedDateTimeStamp": "2025-11-05T23:18:09.5525754+00:00",
"OrganisationId": "sample string 35",
"Main": true,
"WBSBookingId": "b92d9b06-86b4-4a7d-a0dc-2b1f5118061c",
"WBSFirmSaveId": "acfb5e92-1569-4116-b849-67e03fbc10f4",
"WBSDriverSaveId": "080fb6e9-b251-4783-b0ac-e83e73df3a03",
"WBSUserId": "cdadb885-d197-4e3b-8b29-58d2efebe888",
"WBSUserSaveId": "e599deaf-b382-480a-8e43-210c5334a2cf"
},
"IsDeleted": true
},
{
"$ref": "7"
},
{
"$ref": "7"
}
]
},
"SocialChannel": {
"$id": "46",
"$values": [
{
"$ref": "11"
},
{
"$ref": "11"
},
{
"$ref": "11"
}
]
},
"Website": {
"$id": "47",
"$values": [
{
"$ref": "13"
},
{
"$ref": "13"
},
{
"$ref": "13"
}
]
},
"Email": {
"$id": "48",
"$values": [
{
"$ref": "15"
},
{
"$ref": "15"
},
{
"$ref": "15"
}
]
},
"Note": {
"$id": "49",
"$values": [
{
"$ref": "17"
},
{
"$ref": "17"
},
{
"$ref": "17"
}
]
},
"Address": {
"$id": "50",
"$values": [
{
"$ref": "19"
},
{
"$ref": "19"
},
{
"$ref": "19"
}
]
},
"Carrier": {
"$id": "51",
"$values": [
{
"$ref": "21"
},
{
"$ref": "21"
},
{
"$ref": "21"
}
]
},
"BankDetail": {
"$ref": "22"
},
"ControlsLicence": {
"$ref": "23"
},
"FinancialArrangement": {
"$ref": "24"
},
"Supplier": {
"$ref": "25"
},
"Logistic": {
"$ref": "26"
},
"Category": {
"$ref": "27"
},
"ContactFiles": {
"$id": "52",
"$values": [
{
"$ref": "29"
},
{
"$ref": "29"
},
{
"$ref": "29"
}
]
},
"ContactMethod": {
"$ref": "30"
},
"BuyingCriteria": {
"$ref": "33"
},
"SaleApproach": {
"$ref": "34"
},
"AppendNotes": {
"$id": "53",
"$values": [
{
"$ref": "40"
},
{
"$ref": "40"
},
{
"$ref": "40"
}
]
},
"Event": {
"$id": "54",
"$values": [
{
"$ref": "42"
},
{
"$ref": "42"
},
{
"$ref": "42"
}
]
},
"CreatedTimestamp": "2025-11-05T23:18:09.5525754+00:00",
"IsClient": true,
"RpsStatus": "sample string 27",
"RpsUpdatedDate": "2025-11-05T23:18:09.5525754+00:00",
"PersonalInformation": {
"$ref": "43"
},
"MinExpiryDays": 28,
"CountryList": {
"$id": "55",
"$values": [
{
"$ref": "45"
},
{
"$ref": "45"
},
{
"$ref": "45"
}
]
},
"XeroId": "3092cf48-8b26-4761-9f35-662f2f9641eb",
"OwingAmount": 30.1,
"OwingCcy": "sample string 31",
"FreeAgentId": "sample string 32",
"QuickBookId": "sample string 33",
"QuickBookSupplierId": "sample string 34",
"SageOneId": "sample string 35",
"ShopifyId": "sample string 36",
"BigCommerceId": "sample string 37",
"FaireId": "sample string 38",
"WooCommerceId": "sample string 39",
"UpdatedDateTimeStamp": "2025-11-05T23:18:09.5525754+00:00",
"OrganisationId": "sample string 41",
"Main": true,
"WBSBookingId": "9475176e-4a30-45ad-9220-a007b79cfdc1",
"WBSFirmSaveId": "e2ff24ff-463e-4fac-ae03-03e338db73f8",
"WBSDriverSaveId": "4626ee15-c526-4299-a6b5-b27fc3904d73",
"WBSUserId": "fdfa5090-230d-43b1-a4ce-f69c0c9b91c3",
"WBSUserSaveId": "55cfe199-a945-4cad-a182-e4b264742efc"
},
{
"$ref": "4"
},
{
"$ref": "4"
}
]
},
"SaveId": "14b2e41c-f824-4087-a872-da3d76eff043",
"TenantId": "sample string 3",
"EdgeTenantId": "sample string 4",
"EdgeCompanyName": "sample string 5",
"ContactSignature": "sample string 6",
"UserId": "sample string 7",
"ContactSource": "sample string 8",
"UserName": "sample string 9",
"Status": "sample string 10",
"PreferredTradeCurrency": "sample string 11",
"MaxCreditLimit": 12.1,
"CreditCurrency": "sample string 13",
"DueTimeTill": 14,
"KnownSince": "2025-11-05T23:18:09.5525754+00:00",
"LastActivity": "2025-11-05T23:18:09.5525754+00:00",
"XeroShortCode": "sample string 15",
"Image": "sample string 16",
"Categories": "sample string 17",
"CreditRating": "sample string 18",
"Grade": "sample string 19",
"Phone": {
"$id": "56",
"$values": [
{
"$ref": "7"
},
{
"$ref": "7"
},
{
"$ref": "7"
}
]
},
"SocialChannel": {
"$id": "57",
"$values": [
{
"$ref": "11"
},
{
"$ref": "11"
},
{
"$ref": "11"
}
]
},
"Website": {
"$id": "58",
"$values": [
{
"$ref": "13"
},
{
"$ref": "13"
},
{
"$ref": "13"
}
]
},
"Email": {
"$id": "59",
"$values": [
{
"$ref": "15"
},
{
"$ref": "15"
},
{
"$ref": "15"
}
]
},
"Note": {
"$id": "60",
"$values": [
{
"$ref": "17"
},
{
"$ref": "17"
},
{
"$ref": "17"
}
]
},
"Address": {
"$id": "61",
"$values": [
{
"$ref": "19"
},
{
"$ref": "19"
},
{
"$ref": "19"
}
]
},
"Carrier": {
"$id": "62",
"$values": [
{
"$ref": "21"
},
{
"$ref": "21"
},
{
"$ref": "21"
}
]
},
"BankDetail": {
"$ref": "22"
},
"ControlsLicence": {
"$ref": "23"
},
"FinancialArrangement": {
"$ref": "24"
},
"Supplier": {
"$ref": "25"
},
"Logistic": {
"$ref": "26"
},
"Category": {
"$ref": "27"
},
"ContactFiles": {
"$id": "63",
"$values": [
{
"$ref": "29"
},
{
"$ref": "29"
},
{
"$ref": "29"
}
]
},
"ContactMethod": {
"$ref": "30"
},
"BuyingCriteria": {
"$ref": "33"
},
"SaleApproach": {
"$ref": "34"
},
"AppendNotes": {
"$id": "64",
"$values": [
{
"$ref": "40"
},
{
"$ref": "40"
},
{
"$ref": "40"
}
]
},
"Event": {
"$id": "65",
"$values": [
{
"$ref": "42"
},
{
"$ref": "42"
},
{
"$ref": "42"
}
]
},
"CreatedTimestamp": "2025-11-05T23:18:09.5525754+00:00",
"IsClient": true,
"RpsStatus": "sample string 22",
"RpsUpdatedDate": "2025-11-05T23:18:09.5525754+00:00",
"PersonalInformation": {
"$ref": "43"
},
"MinExpiryDays": 23,
"CountryList": {
"$id": "66",
"$values": [
{
"$ref": "45"
},
{
"$ref": "45"
},
{
"$ref": "45"
}
]
},
"XeroId": "90e3ed30-6954-4dee-9aaf-ee13b77ea7b5",
"OwingAmount": 25.1,
"OwingCcy": "sample string 26",
"FreeAgentId": "sample string 27",
"QuickBookId": "sample string 28",
"QuickBookSupplierId": "sample string 29",
"SageOneId": "sample string 30",
"ShopifyId": "sample string 31",
"BigCommerceId": "sample string 32",
"FaireId": "sample string 33",
"WooCommerceId": "sample string 34",
"UpdatedDateTimeStamp": "2025-11-05T23:18:09.5525754+00:00",
"OrganisationId": "sample string 36",
"Main": true,
"WBSBookingId": "6dcfc24d-234f-417f-b3b7-cca37fc9cdce",
"WBSFirmSaveId": "f13cd8fd-b5b9-42c0-9101-2d47a443acf8",
"WBSDriverSaveId": "b730f18a-195e-4f92-ae2f-0fd736e24b3a",
"WBSUserId": "cbdcbca9-a7d3-47a7-80f9-6542f3b0b650",
"WBSUserSaveId": "23842533-8ecb-4bd1-88b3-81b8bc9caefb"
}
application/xml
Sample:
text/xml
Sample:
application/x-www-form-urlencoded
Sample:
Response Information
No documentation available.
Response body formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.