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": "af052243-0c7f-44e5-9073-ef0067017460",
"Description": "sample string 2",
"StartDate": "2026-02-04T02:34:24.147753+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": "8d6bb2c7-1291-4249-9f33-5fda615d1890",
"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-02-04T02:34:24.147753+00:00",
"LastActivity": "2026-02-04T02:34:24.147753+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": "a38779a5-0d32-4a03-888b-1667963491ad",
"Contact": {
"$id": "8",
"SaveId": "7f7b1170-c5eb-4127-8cf8-b29e65bb0c0f",
"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-02-04T02:34:24.147753+00:00",
"LastActivity": "2026-02-04T02:34:24.147753+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": "d4e05500-1581-4bf3-886d-0b95a746775b",
"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": "4a313b62-451e-4bc6-8d40-96e478614739",
"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": "e23c0322-a267-475b-aa09-7c6f93b2a333",
"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-02-04T02:34:24.147753+00:00",
"UserName": "sample string 6",
"Message": "sample string 7",
"ContactId": "af015c21-096e-4af0-91ec-2811e3e0094c",
"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": "1301f52b-2ca5-41c7-9850-581f5437eae0",
"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": "7e7614d1-8854-40f6-809e-4952aaf0df2a",
"Contact": {
"$ref": "8"
},
"IsDeleted": true
},
{
"$ref": "21"
},
{
"$ref": "21"
}
]
},
"BankDetail": {
"$id": "22",
"AccountId": "05ea96e6-5b70-474f-9fab-cbebe12dc00f",
"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": "f3a83a1d-0a5f-47ef-a070-1b092c0318c3",
"IsLicence": true,
"LicenceNo": "sample string 3",
"LicenceExpiryDate": "sample string 4",
"Contact": {
"$ref": "8"
},
"IsDeleted": true
},
"FinancialArrangement": {
"$id": "24",
"FinancialId": "72cd5404-cf48-4619-9ac4-0da08ae92bb2",
"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": "d60be557-65a2-4285-a57c-593b5c0c10d1",
"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": "5f1a1866-5bef-47d1-aea7-baad8daca3dc",
"EmailForQuote": "sample string 2",
"IsLogisticQuote": true,
"IsLogisticFirm": true,
"Contact": {
"$ref": "8"
}
},
"Category": {
"$id": "27",
"CategoryId": "0676a78a-34af-42d5-9afe-a9ab72bffef1",
"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": "26103314-9fa0-42d1-90ca-92c1598c5a82",
"ContactSaveId": "253df2cd-183b-4b72-9cb0-81b0b088efe2",
"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": "85dfbece-ca0e-4fec-990d-d09a57eb8f31",
"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": "a36ab8ee-99db-482b-a706-3d23aaf5b655",
"ContactMethod": {
"$ref": "30"
},
"IsDeleted": true
},
{
"$ref": "32"
},
{
"$ref": "32"
}
]
},
"Contact": {
"$ref": "8"
}
},
"BuyingCriteria": {
"$id": "33",
"CriteriaId": "8c31aa55-2750-4e8b-80f3-0fdfb61b2879",
"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": "aaae252b-a92d-4041-bb10-fe23e1cc8db6",
"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": "e1d5cca4-6517-498e-b957-4acdbe8a9c52",
"SaleApproach": {
"$ref": "34"
},
"IsDeleted": true
},
{
"$ref": "36"
},
{
"$ref": "36"
}
]
},
"Suppliers": {
"$id": "37",
"$values": [
{
"$id": "38",
"Id": 1,
"SupplierName": "sample string 2",
"SaleId": "4a905e4f-decb-462b-9a38-8cd33f2ad85b",
"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-02-04T02:34:24.147753+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": "20e936dc-5830-4988-8132-b4f7184a89c1",
"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-02-04T02:34:24.147753+00:00",
"EndDate": "2026-02-04T02:34:24.147753+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": "0c3ed5b7-c48a-478d-86fd-f0304aa789ce",
"Contact": {
"$ref": "8"
}
},
{
"$ref": "42"
},
{
"$ref": "42"
}
]
},
"CreatedTimestamp": "2026-02-04T02:34:24.147753+00:00",
"IsClient": true,
"RpsStatus": "sample string 21",
"RpsUpdatedDate": "2026-02-04T02:34:24.147753+00:00",
"PersonalInformation": {
"$id": "43",
"PersonalId": "21d53515-f555-4201-be2c-20027eb7001b",
"Gender": "sample string 1",
"DateOfBirth": "2026-02-04T02:34:24.147753+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": "8a66d484-a0b4-444e-b646-479846cbf1b5",
"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-02-04T02:34:24.147753+00:00",
"OrganisationId": "sample string 35",
"Main": true,
"WBSBookingId": "8f5b1bb8-2167-41ff-80f9-8b48d3b99f0c",
"WBSFirmSaveId": "d34c32cc-d6c9-43c2-9e16-0b9c51468489",
"WBSDriverSaveId": "c76283c6-cf3b-4690-be26-f6bf75027463",
"WBSUserId": "5fc5df36-2dff-4f9e-8879-64b00ae06e71",
"WBSUserSaveId": "611a1ea7-50c3-4025-b74d-125917913d7b"
},
"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-02-04T02:34:24.147753+00:00",
"IsClient": true,
"RpsStatus": "sample string 27",
"RpsUpdatedDate": "2026-02-04T02:34:24.147753+00:00",
"PersonalInformation": {
"$ref": "43"
},
"MinExpiryDays": 28,
"CountryList": {
"$id": "55",
"$values": [
{
"$ref": "45"
},
{
"$ref": "45"
},
{
"$ref": "45"
}
]
},
"XeroId": "2a7c4859-fa2f-4c5e-913b-b67bc9ee4e18",
"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-02-04T02:34:24.147753+00:00",
"OrganisationId": "sample string 41",
"Main": true,
"WBSBookingId": "d7affe23-aa2d-4002-8025-ede849849cd0",
"WBSFirmSaveId": "447af998-ff40-4dc5-b002-d76e32c74ffd",
"WBSDriverSaveId": "eab428a7-c861-4f0b-810a-69fe53a12fa6",
"WBSUserId": "c8c6d3b2-0c68-491d-8696-7cd1a1d804ee",
"WBSUserSaveId": "5e8d288b-1060-46b2-a256-8104c3c967a2"
},
{
"$ref": "4"
},
{
"$ref": "4"
}
]
},
"SaveId": "8d2b9806-d3fe-4916-ac4d-5851480381ef",
"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-02-04T02:34:24.147753+00:00",
"LastActivity": "2026-02-04T02:34:24.147753+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-02-04T02:34:24.147753+00:00",
"IsClient": true,
"RpsStatus": "sample string 22",
"RpsUpdatedDate": "2026-02-04T02:34:24.147753+00:00",
"PersonalInformation": {
"$ref": "43"
},
"MinExpiryDays": 23,
"CountryList": {
"$id": "66",
"$values": [
{
"$ref": "45"
},
{
"$ref": "45"
},
{
"$ref": "45"
}
]
},
"XeroId": "f1ec5735-079e-4f6e-9fd2-d21186b38bd1",
"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-02-04T02:34:24.147753+00:00",
"OrganisationId": "sample string 36",
"Main": true,
"WBSBookingId": "70055fca-6576-486b-a8c6-0e4b715794b0",
"WBSFirmSaveId": "51fa85e7-40d6-42e6-8762-0b1cb2192f5d",
"WBSDriverSaveId": "72bbbce9-f3c6-44dd-8e90-2ca1eb0a01b4",
"WBSUserId": "ad7998e6-1141-4d13-b11f-dbc35c572fcf",
"WBSUserSaveId": "25cee717-e314-449b-873f-4ad010287822"
}
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.