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": "1b4b806c-80bb-4196-9f2a-4d53212c5f6e",
"Description": "sample string 2",
"StartDate": "2026-05-06T12:50:17.177269+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": "81d10038-93b1-454e-8aee-9ecaea7d2d6c",
"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-05-06T12:50:17.177269+00:00",
"LastActivity": "2026-05-06T12:50:17.177269+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": "199f22b7-a409-4c3f-8606-dc62dc141359",
"Contact": {
"$id": "8",
"SaveId": "1fcf4cf0-cd8d-4f88-a48e-487f8deba8ac",
"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-05-06T12:50:17.177269+00:00",
"LastActivity": "2026-05-06T12:50:17.177269+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": "16624c36-8f53-4bf2-8add-c7679ac249b1",
"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": "c80e0722-6800-4fed-bf0d-d589cae245f6",
"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": "2a788e52-6867-49a1-9c6b-e51f9155f3b0",
"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-05-06T12:50:17.177269+00:00",
"UserName": "sample string 6",
"Message": "sample string 7",
"ContactId": "ce9ff4d3-b679-4e29-b140-ff53e430f9a7",
"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": "f671baae-baba-42c8-b214-286d83846ad2",
"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": "35588b01-d2f1-4d2d-bb27-9dfffbb751c5",
"Contact": {
"$ref": "8"
},
"IsDeleted": true
},
{
"$ref": "21"
},
{
"$ref": "21"
}
]
},
"BankDetail": {
"$id": "22",
"AccountId": "ffc2e7d9-3327-4282-b0e2-723e5d4bd779",
"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": "4d7efada-eeed-417a-ab75-63fa3e4f54db",
"IsLicence": true,
"LicenceNo": "sample string 3",
"LicenceExpiryDate": "sample string 4",
"Contact": {
"$ref": "8"
},
"IsDeleted": true
},
"FinancialArrangement": {
"$id": "24",
"FinancialId": "c4a26a8f-7a87-417b-91b1-d0855bf9a0ca",
"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": "cbb67a09-c13a-433f-85f4-c8ed4d7197ae",
"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": "408b2b6b-d80a-4804-b705-2442d50ce79b",
"EmailForQuote": "sample string 2",
"IsLogisticQuote": true,
"IsLogisticFirm": true,
"Contact": {
"$ref": "8"
}
},
"Category": {
"$id": "27",
"CategoryId": "430041dd-e6f2-4616-b152-c3372b8bdb4d",
"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": "d9ea6217-2676-4640-9e79-b9347edef849",
"ContactSaveId": "3d2139cc-be7b-4079-a7c6-556ae9b7f9d1",
"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": "2d8b5c9d-1388-4c52-a3a8-912a01e2672a",
"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": "34c95b75-7633-48e5-874f-0029f463e743",
"ContactMethod": {
"$ref": "30"
},
"IsDeleted": true
},
{
"$ref": "32"
},
{
"$ref": "32"
}
]
},
"Contact": {
"$ref": "8"
}
},
"BuyingCriteria": {
"$id": "33",
"CriteriaId": "a4a27e53-5a96-4d33-8340-1a8dc643e5ed",
"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": "ba82dc54-1bc7-4a11-90f4-0068809f5678",
"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": "fe08cf0e-f689-4653-b908-197400911de2",
"SaleApproach": {
"$ref": "34"
},
"IsDeleted": true
},
{
"$ref": "36"
},
{
"$ref": "36"
}
]
},
"Suppliers": {
"$id": "37",
"$values": [
{
"$id": "38",
"Id": 1,
"SupplierName": "sample string 2",
"SaleId": "c612e44e-66cf-4d5c-9bcc-f8e16a2eb976",
"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-05-06T12:50:17.177269+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": "d4c156d3-77dd-4f37-acc9-6ec937e6f689",
"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-05-06T12:50:17.177269+00:00",
"EndDate": "2026-05-06T12:50:17.177269+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": "337171fa-4918-4a7d-a3d3-cca79e875e9b",
"Contact": {
"$ref": "8"
}
},
{
"$ref": "42"
},
{
"$ref": "42"
}
]
},
"CreatedTimestamp": "2026-05-06T12:50:17.177269+00:00",
"IsClient": true,
"RpsStatus": "sample string 21",
"RpsUpdatedDate": "2026-05-06T12:50:17.177269+00:00",
"PersonalInformation": {
"$id": "43",
"PersonalId": "db3dfef2-fa83-46ef-9942-64c54133f9b8",
"Gender": "sample string 1",
"DateOfBirth": "2026-05-06T12:50:17.177269+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": "7c6608ca-98b9-4d43-ae03-9b06b5d562a2",
"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-05-06T12:50:17.177269+00:00",
"OrganisationId": "sample string 35",
"Main": true,
"WBSBookingId": "571998fd-08d3-439f-ba84-e9dcd8992ad9",
"WBSFirmSaveId": "6ba278fd-cd35-486e-8798-85eda4022897",
"WBSDriverSaveId": "cb3c9554-815b-4d75-bf62-a77afe288ea8",
"WBSUserId": "f0004a75-4ace-4046-af7b-6f46977644ea",
"WBSUserSaveId": "776eb6f5-b17f-4759-833e-31872652d881"
},
"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-05-06T12:50:17.177269+00:00",
"IsClient": true,
"RpsStatus": "sample string 27",
"RpsUpdatedDate": "2026-05-06T12:50:17.177269+00:00",
"PersonalInformation": {
"$ref": "43"
},
"MinExpiryDays": 28,
"CountryList": {
"$id": "55",
"$values": [
{
"$ref": "45"
},
{
"$ref": "45"
},
{
"$ref": "45"
}
]
},
"XeroId": "fc52554e-e6a8-49da-b5a1-c6c9c431cd2e",
"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-05-06T12:50:17.177269+00:00",
"OrganisationId": "sample string 41",
"Main": true,
"WBSBookingId": "e522b98e-d93a-46ae-bcf7-25dbcd44d3df",
"WBSFirmSaveId": "f563129e-39a9-40ff-a610-dfd0a05d8585",
"WBSDriverSaveId": "2ff7514f-2d16-44d1-8ca5-2867958df768",
"WBSUserId": "bf9b880e-94a0-46de-b82e-5327f776ce03",
"WBSUserSaveId": "6836f0cb-30ef-4952-85a3-4485f43f6737"
},
{
"$ref": "4"
},
{
"$ref": "4"
}
]
},
"SaveId": "f9a216c7-206d-4f9e-913f-cb3b8080aa46",
"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-05-06T12:50:17.177269+00:00",
"LastActivity": "2026-05-06T12:50:17.177269+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-05-06T12:50:17.177269+00:00",
"IsClient": true,
"RpsStatus": "sample string 22",
"RpsUpdatedDate": "2026-05-06T12:50:17.177269+00:00",
"PersonalInformation": {
"$ref": "43"
},
"MinExpiryDays": 23,
"CountryList": {
"$id": "66",
"$values": [
{
"$ref": "45"
},
{
"$ref": "45"
},
{
"$ref": "45"
}
]
},
"XeroId": "ce5c5748-928d-423c-a91b-49bf6f1f5f4d",
"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-05-06T12:50:17.177269+00:00",
"OrganisationId": "sample string 36",
"Main": true,
"WBSBookingId": "ff211caf-7b49-4370-83b6-742a9e2c72e9",
"WBSFirmSaveId": "470c67d4-25dd-49f6-823c-1a57c3a7a3dd",
"WBSDriverSaveId": "57b2d3a9-303b-4b04-9017-dc03ff81ca3e",
"WBSUserId": "053ad8db-c90a-4864-814b-cd254cfcfa6b",
"WBSUserSaveId": "96893ab8-583f-43e0-b40a-7cb7c876769b"
}
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.