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": "e887836f-2b18-43fe-a294-e18beb54ca48",
"Description": "sample string 2",
"StartDate": "2026-09-20T10:15:01.4857547+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": "d2dad367-03f5-4a86-9f65-00561f382a9d",
"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": "2026-09-20T10:15:01.4857547+00:00",
"LastActivity": "2026-09-20T10:15:01.4857547+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": "7c1da208-6a17-48f1-95a5-6e9d4292e40f",
"Contact": {
"$id": "8",
"SaveId": "0b531e2a-55cc-4957-a46c-b478823ba699",
"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": "2026-09-20T10:15:01.4857547+00:00",
"LastActivity": "2026-09-20T10:15:01.4857547+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": "332e5c9a-873a-43b6-8e98-eff018eab51a",
"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": "d72cdae9-1a43-4ab8-9ba9-0bc401731c77",
"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": "4a92c935-59f6-47ff-a894-7f3aca912ae9",
"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": "2026-09-20T10:15:01.4857547+00:00",
"UserName": "sample string 6",
"Message": "sample string 7",
"ContactId": "f1e6c64a-ae99-4721-ab3f-2c3c147850dd",
"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": "89f62d5c-c7f7-45c0-b804-0e22dd8c5442",
"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": "45eb4b55-487d-402d-8962-a49b05e93406",
"Contact": {
"$ref": "8"
},
"IsDeleted": true
},
{
"$ref": "21"
},
{
"$ref": "21"
}
]
},
"BankDetail": {
"$id": "22",
"AccountId": "c30cef5b-0405-44df-85f2-378e9c6a5273",
"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": "9d141692-69db-484e-9e00-88fff842c5c3",
"IsLicence": true,
"LicenceNo": "sample string 3",
"LicenceExpiryDate": "sample string 4",
"Contact": {
"$ref": "8"
},
"IsDeleted": true
},
"FinancialArrangement": {
"$id": "24",
"FinancialId": "ba3ced90-40f1-47fa-a4c9-e748579ee6d9",
"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": "3becdd75-55ab-4add-98a5-44bf10f81a34",
"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": "40d6cdbf-d1b3-48c5-942b-6673d9c05f25",
"EmailForQuote": "sample string 2",
"IsLogisticQuote": true,
"IsLogisticFirm": true,
"Contact": {
"$ref": "8"
}
},
"Category": {
"$id": "27",
"CategoryId": "8fb55408-f463-4503-9bb0-1487e39dc9c7",
"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": "b197097e-ca19-4d49-8241-666e52c24370",
"ContactSaveId": "29a3b869-d993-42d6-9922-46e96a43c58b",
"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": "5c52632e-a92d-4e0b-9a22-44301e8a3c59",
"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": "6bc75950-0673-4f70-9355-ec7302ddebc1",
"ContactMethod": {
"$ref": "30"
},
"IsDeleted": true
},
{
"$ref": "32"
},
{
"$ref": "32"
}
]
},
"Contact": {
"$ref": "8"
}
},
"BuyingCriteria": {
"$id": "33",
"CriteriaId": "952c2a4a-86ee-4b61-b036-8f702b32c052",
"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": "c268e831-b830-47b8-85aa-d076fd0b4e68",
"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": "a27ab688-2102-4ac1-8ceb-7eead5252ff2",
"SaleApproach": {
"$ref": "34"
},
"IsDeleted": true
},
{
"$ref": "36"
},
{
"$ref": "36"
}
]
},
"Suppliers": {
"$id": "37",
"$values": [
{
"$id": "38",
"Id": 1,
"SupplierName": "sample string 2",
"SaleId": "10b5c070-06b2-4c51-bf98-64e64f9d9afe",
"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": "2026-09-20T10:15:01.4857547+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": "348a265f-df62-49d2-8d81-5469fa7b9678",
"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": "2026-09-20T10:15:01.4857547+00:00",
"EndDate": "2026-09-20T10:15:01.4857547+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": "4400f06b-3d0b-4094-8e4d-c7da834970dc",
"Contact": {
"$ref": "8"
}
},
{
"$ref": "42"
},
{
"$ref": "42"
}
]
},
"CreatedTimestamp": "2026-09-20T10:15:01.4857547+00:00",
"IsClient": true,
"RpsStatus": "sample string 21",
"RpsUpdatedDate": "2026-09-20T10:15:01.4857547+00:00",
"PersonalInformation": {
"$id": "43",
"PersonalId": "03c32977-649a-44c6-a1e8-fd9b44858c36",
"Gender": "sample string 1",
"DateOfBirth": "2026-09-20T10:15:01.4857547+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": "4d5c92eb-689c-4dbb-9db5-dbcd99bfb6d2",
"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": "2026-09-20T10:15:01.4857547+00:00",
"OrganisationId": "sample string 35",
"Main": true,
"WBSBookingId": "fdce97ea-72f9-4a27-b9c4-d116f80dbb1b",
"WBSFirmSaveId": "34707313-b0f0-4cb7-aacf-073427dfa7cb",
"WBSDriverSaveId": "f1479548-78e4-4c08-8d59-b4e66b69e1d2",
"WBSUserId": "48ce9b51-b4a8-4170-bc06-af94f1b5c291",
"WBSUserSaveId": "5d3df37e-774b-4798-b8c9-d37b80a8a540"
},
"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": "2026-09-20T10:15:01.4857547+00:00",
"IsClient": true,
"RpsStatus": "sample string 27",
"RpsUpdatedDate": "2026-09-20T10:15:01.4857547+00:00",
"PersonalInformation": {
"$ref": "43"
},
"MinExpiryDays": 28,
"CountryList": {
"$id": "55",
"$values": [
{
"$ref": "45"
},
{
"$ref": "45"
},
{
"$ref": "45"
}
]
},
"XeroId": "a58a1a98-3fb0-45be-a42d-f64389f85c50",
"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": "2026-09-20T10:15:01.4857547+00:00",
"OrganisationId": "sample string 41",
"Main": true,
"WBSBookingId": "43d754b3-1a4f-492c-9a99-1bb1fa39da4d",
"WBSFirmSaveId": "00520bdc-e384-429b-8505-efaa93096f5e",
"WBSDriverSaveId": "2f42433b-38e1-4ab7-8faf-21414ec4ab79",
"WBSUserId": "17cbf7ef-5c9b-4f44-98b2-4dec13b5d4fc",
"WBSUserSaveId": "69b89218-ef47-4402-a33b-11f3c014ded0"
},
{
"$ref": "4"
},
{
"$ref": "4"
}
]
},
"SaveId": "b9671b59-44a3-4e1b-ad1f-d347db5da462",
"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": "2026-09-20T10:15:01.4857547+00:00",
"LastActivity": "2026-09-20T10:15:01.4857547+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": "2026-09-20T10:15:01.4857547+00:00",
"IsClient": true,
"RpsStatus": "sample string 22",
"RpsUpdatedDate": "2026-09-20T10:15:01.4857547+00:00",
"PersonalInformation": {
"$ref": "43"
},
"MinExpiryDays": 23,
"CountryList": {
"$id": "66",
"$values": [
{
"$ref": "45"
},
{
"$ref": "45"
},
{
"$ref": "45"
}
]
},
"XeroId": "7f6b3076-e941-42d1-9d9d-dac4fcfbda59",
"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": "2026-09-20T10:15:01.4857547+00:00",
"OrganisationId": "sample string 36",
"Main": true,
"WBSBookingId": "c97c6175-ca28-4b1c-84fd-3ec48399d43f",
"WBSFirmSaveId": "db4d9aca-706a-4ee1-807c-5e79f2f50808",
"WBSDriverSaveId": "4ca01eb1-fe3f-4956-84f3-059a32d7f563",
"WBSUserId": "205429c4-0a5e-4cb5-ab2f-02e5c153f0e2",
"WBSUserSaveId": "66672b47-9a3b-4a55-8797-5155ba362d0b"
}
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.