Learn how to create simple entities
Use the POST method along with the JSON payload and the API will create an Entity.
POST {Host Name}/api/v1/base/{EntityType}
where {Host Name} is derived from GetCompanyWsdkUrlCommand.Url, and
{EntityType} is a class listed in Entities section*, and
{Request body} which contains both valid Entity and PropertySet statement as shown in examples below
Entities that do not use POST
WorkOrder, Space, and WorkZone entities require specialized creation commands described in Executing Commands and cannot be created by the POST method
Contact Example
Contact entities represent work requestors and approvers and provide the linkage for Corrigo Enterprise Customer Portal SSO.
POST <<AM Host Name>>/api/v1/base/Contact HTTP/1.1
Accept-Encoding: gzip,deflate
CompanyName: <<Sample Company>>
Content-Type: application/json
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LjQ0MjAiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJXZWQsIDA4IERlYyAyMDIxIDIxOjI5OjQ0IEdNVCIsIi5leHBpcmVzIjoiV2VkLCAwOCBEZWMgMjAyMSAyMTo0OTo0NCBHTVQifX19<---->O9RD14W5vnmsXkD2Yw3Yx4dnP-p87vKynKbHidH_nXH77pMpYiHz34HQbj1iQvcPSzuOvzN_JDf3aaMrFnYu8G5NfzZp25h1zMOmbdS7MRzNyHBIjmHIHppKgj_V_XpA1S2pUu4hgb7QoCIk_5c-5rxykPCdS3DobsjKIOuafYmCHuRf71QIsxu9AnucnU9RNF8xH0hn7vc9psQAN7v-SOiZdGI9ad2tU72nzTa8xxKcnl4ret6XKdtJJpVF9onvfFm18mhR4JRW3Xt6mo9_kgfToq61qkmnCGOsGMyHpcoib20Q-rvluImtoYm_ga_kkLbuz4qQkYtlyxX2r2T0Ag
Content-Length: 676
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.2 (Java/16.0.1)
{
"Entity": {
"FirstName": "Test API",
"LastName": "API Test",
"TypeId": 3,
"CustomerId": 371,
"CanViewAnyRequest": true,
"CanCreateRequest": true,
"PriorityThreshold": 255,
"CustomFields": [],
"ContactAddresses": [],
"GroupsBridge": [],
"Username": "APITEst12345611",
"Number": "",
"MustResetPassword": false,
"NoAlertEmails": false,
"Comment": "",
"UnlimitedRequest": false,
"UnlimitedAuthorization": false,
"SupervisorId": 0,
"LanguageId": 0,
"CustomerNoteAccessId": 2,
"NoPwdExpirationAlert": false,
"Currencies": [],
"IsRemoved": false,
"ConcurrencyId": 4,
"Id": 0
}
}
{
"EntitySpecifier" : {
"ConcurrencyId" : 1, //how many updates have been applied since creation?
"EntityType" : "Contact",
"Id" : 20378 //internal Corrigo entity id
}
}
Employee Example
Employee entities represent potential assignees to WorkOrders. This includes internal technicians and service professionals.
POST <<AM Host Name>>/api/v1/base/Employee HTTP/1.1
CompanyName: <<Sample Company>>
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmI5ZmUiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJXZWQsIDI5IERlYyAyMDIxIDA2OjUwOjUwIEdNVCIsIi5leHBpcmVzIjoiV2VkLCAyOSBEZWMgMjAyMSAwNzoxMDo1MCBHTVQifX19<---->2yQI8aIM_oTAcvNgzyIQk8MNbfXjPKGzUh70lGkiMHuhQEi4VqucT4YBd7A4ATtpL3hRnnD39sQaY2o8jg6h82FydaMQWCLNnjG6-8A8eWgYcGZQdCoGubvzNgzaIHJINV0jbsyqiq5abDnMrft5CfW8WX23QU5gMH6ie00urKUpXxJDKD9t9PLg5uK4qSLaPi5wA0CubfsyLkHHECw2OJes40HpQ_g_52lUlRSr53PbQ5-p8vmpOWXJd-MI2i0psWsAF83Fzxb9kqUdTu99P8bkx0mkla8MG-BqjSzQY3srQIcsrSSPH1y4KEjfyekVC4UYmUzrUbnFeDjc4TxIow
Content-Type: application/json
Content-Length: 1501
{
"Entity": {
"FirstName": "Erik",
"LastName": "Blomberg",
"DisplayAs": "1Blomberg, Erik",
"Role":{ "Id":1},
"AccessToAllWorkZones": false,
"LanguageId": 1033,
"ActorTypeId": "Employee",
"Username": "87BA26DD-1A2F-4EC3-BC88-E3D522093F57",
"DtPwdChange": "2016-07-11T00:00:00",
"Instructions": "2",
"WonMemberId": 0,
"WonLocationId": 0,
"WonServiceRadius": 0,
"IsElectronicPayment": false,
"ProviderStatusId": "NA",
"LabelId": 0,
"FreeTextAllowed": true,
"RadiusUnit": "Mile",
"Password": "Password",
"Number": "2",
"JobTitle": "test",
"FederalId": "",
"ExternalId": "",
"ForcePasswordReset": false,
"TaxWarnOnly": false,
"PriceLists": [],
"CustomFields": [],
"BillAtZero": false,
"IsSupplier": false,
"ProviderTypeId": "Regular",
"ContactAddresses": [],
"Teams": [],
"WorkZones": [],
"Portfolios": [],
"CustomerGroups": [],
"Specialties": [],
"PayRates": [],
"StockLocations": [],
"Services": [],
"AlertSubscriptions": [],
"TaxExempt": false,
"LimitAssignmentByPortfolioId": 0,
"IsRemoved": true,
"ConcurrencyId": 4,
"Id": 5,
"PerformDeletion": false,
"IsNew": true
}
}
{
"EntitySpecifier": {
"ConcurrencyId": 1,
"EntityType": "Employee",
"Id": 13205
}
}
Customer Example
A Customer entity represents a postal address where service is delivered. For retail and foodservice portfolios a Customer represents a 'store'. For commercial office properties a Customer represents a Building. For service management applications of Corrigo Enterprise platform, a Customer entity is the bill-to address of a Customer Job Site.
POST <<AM Host Name>>/api/v1/base/Customer HTTP/1.1
CompanyName: <<Sample Company>>
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LjlhMDciLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJNb24sIDIwIERlYyAyMDIxIDEwOjQyOjU2IEdNVCIsIi5leHBpcmVzIjoiTW9uLCAyMCBEZWMgMjAyMSAxMTowMjo1NiBHTVQifX19<---->v8ljTS1wBJlRA2nmcegmc9p-dKuSvvcSANBghVbAIoDNHg3U2Wxz6fth3N49WPyTjftdUkWwiEk_I85yOMwTJbzbmPu0hRRGipM41B5uQxAZQlooi_vtconoQBZtJrBH8mQxJLd7gWmJ1SZU7xZSSpJxXfnh0OQTRAwroFoE2cppAd-J7UtYk1d84KjEVaBF0rOpdDg8CN7XpvnTukpBO-9jK3loZDAnskjxvfPLFdztRE9dHSZWpRD5L-pCzhohZajyungOiiiMoxaviZ_lhwmirpPVEkUx4DuEAdCJhDeyVKXS2zHgmktwOgWr3eYXHiO7Esj-OPUe04tZbLP0Xw
Content-Type: application/json
Content-Length: 2552
{
"Entity": {
"DisplayAs": "Sachin",
"Name": "Sachin",
"WorkZone": {
"DisplayAs": "",
"TimeZone": 0,
"LanguageId": 0,
"WoNumberPrefix": "",
"Entity": "",
"SchedulingWindow": 0,
"NoIncompleteProcedure": false,
"AccessOptionsMask": 0,
"Number": "",
"AdvanceNotice": 0,
"WoNumberDigits": 0,
"RoundApptTimeTo": 0,
"WorkPlanAutoCancel": false,
"WorkPlanChildResolution": false,
"WorkPlanAutoDependency": false,
"CpThemeId": 0,
"DefaultAccess": "Unknown",
"AutoAssignEnabled": false,
"BackupRoutingId": "Unassigned",
"NoIncompleteItem": false,
"UiShowProvidersFirst": false,
"CurrencyTypeId": "Unknown",
"IsOffline": false,
"ContactAddresses": [],
"CustomFields": [],
"Portfolios": [],
"SlaValues": [],
"Teams": [],
"BizHours": [],
"EscalationRules": [],
"SpecDispatchRules": [],
"OnCallRules": [],
"Responsibilities": [],
"UseBizHours": false,
"UseHolidays": false,
"UseOnCall": false,
"UseEscalation": false,
"DefaultBillToLogic": 0,
"TurnKickOffAuto": false,
"TurnKickOffLagDays": 0,
"TurnKickOffOnDays": 0,
"EarliestSlot": 0,
"LatestSlot": 0,
"SlotsCount": 0,
"IsPrecalculatedSchedule": false,
"AllowTimePreference": false,
"TurnTemplateId": 0,
"IsmSpecGroupId": 0,
"IsmUrl": "",
"ExcludeNonCompliantProviders": "InheritGlobalSettings",
"IsNteAuto": true,
"IsRemoved": false,
"ConcurrencyId": 0,
"Id": 1,
"PerformDeletion": false,
"IsNew": false
},
"Dba": "Toluca",
"Instructions": "",
"TenantCode": "",
"TaxExempt": false,
"Spaces": [],
"Contacts": [],
"CustomFields": [],
"Notes": [],
"Addresses": [],
"GroupsBridge": [],
"ApprovalScopes": [],
"IsRemoved": true,
"ConcurrencyId": 2,
"Id": 1,
"PerformDeletion": false,
"IsNew": false
}
}
{
"EntitySpecifier": {
"ConcurrencyId": 1,
"EntityType": "Customer",
"Id": 8600
}
}
Document Example
A Document entity represents an attachment to a WorkOrder or Customer or Warranty.
POST <<AM Host Name>>/api/v1/base/Document HTTP/1.1
CompanyName: <<Sample Company>>
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmI5ZmUiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJXZWQsIDI5IERlYyAyMDIxIDA2OjUwOjUwIEdNVCIsIi5leHBpcmVzIjoiV2VkLCAyOSBEZWMgMjAyMSAwNzoxMDo1MCBHTVQifX19<---->2yQI8aIM_oTAcvNgzyIQk8MNbfXjPKGzUh70lGkiMHuhQEi4VqucT4YBd7A4ATtpL3hRnnD39sQaY2o8jg6h82FydaMQWCLNnjG6-8A8eWgYcGZQdCoGubvzNgzaIHJINV0jbsyqiq5abDnMrft5CfW8WX23QU5gMH6ie00urKUpXxJDKD9t9PLg5uK4qSLaPi5wA0CubfsyLkHHECw2OJes40HpQ_g_52lUlRSr53PbQ5-p8vmpOWXJd-MI2i0psWsAF83Fzxb9kqUdTu99P8bkx0mkla8MG-BqjSzQY3srQIcsrSSPH1y4KEjfyekVC4UYmUzrUbnFeDjc4TxIow
Content-Type: application/json
Content-Length: 1501
{
"Entity": {
"ActorId": 31716,
"ActorTypeId": "WO",
"Description": "Received from CorrigoNet at 7.3.5 provider copy",
"Title": "Fax message",
"DocType": {
"ConcurrencyId": 0,
"Id": 1
},
"StartDate": "2011-08-23T00:00:00",
"UpdatedDate": "2011-08-23T11:18:57",
"ExtensionId": 0,
"IsShared": false,
"IsPublic": false,
"StorageTypeId": "URL",
"DocUrl": "https://cdn.pixabay.com/photo/2022/02/05/08/13/tulip-6994245_1280.jpg",
"MimeType": "application/octet-stream",
"CreatedBy": {
"Id": 593,
"TypeId": "Provider"
},
"WonId": 56575,
"WonMemberId": 4315,
"ConcurrencyId": 1,
"Id": 0
}
}
{
"EntitySpecifier": {
"ConcurrencyId": 1,
"EntityType": "Document",
"Id": 801
}
}
BillingAccount Example
Customer entities are collected into BillingAccount entity for billing the responsible party.
POST <<AM Host Name>>/api/v1/base/BillingAccount HTTP/1.1
CompanyName: <<Sample Company>>
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmI5ZmUiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJXZWQsIDI5IERlYyAyMDIxIDA2OjUwOjUwIEdNVCIsIi5leHBpcmVzIjoiV2VkLCAyOSBEZWMgMjAyMSAwNzoxMDo1MCBHTVQifX19<---->2yQI8aIM_oTAcvNgzyIQk8MNbfXjPKGzUh70lGkiMHuhQEi4VqucT4YBd7A4ATtpL3hRnnD39sQaY2o8jg6h82FydaMQWCLNnjG6-8A8eWgYcGZQdCoGubvzNgzaIHJINV0jbsyqiq5abDnMrft5CfW8WX23QU5gMH6ie00urKUpXxJDKD9t9PLg5uK4qSLaPi5wA0CubfsyLkHHECw2OJes40HpQ_g_52lUlRSr53PbQ5-p8vmpOWXJd-MI2i0psWsAF83Fzxb9kqUdTu99P8bkx0mkla8MG-BqjSzQY3srQIcsrSSPH1y4KEjfyekVC4UYmUzrUbnFeDjc4TxIow
Content-Type: application/json
Content-Length: 15201
{
"Entity":{
"DisplayAs": "ARB_Samples12",
"CpThemeId": 1,
"IsBillAcct": true,
"Number": "2577-ARB12",
"PaymentTerms": "",
"PaymentNumberOfDays": 1,
"PaymentInstrustions": "",
"IsCreditHold": false,
"AccrualMargin": 0,
"SalesRep": "",
"IsTaxExempt": false,
"Balance": 0.0000,
"PayDayType": 1,
"PayDayNumber": 1,
"IsSelfSelect": false,
"CurrencyTypeId": "USD",
"Users": [],
"Customers": [],
"Contacts": [],
"CustomFields": [],
"Notes": [],
"SynchronizeNte": false,
"IsRemoved": true,
"ConcurrencyId": 2,
"Id": 0,
"PerformDeletion": false,
"IsNew": false
}
}
{
"EntitySpecifier": {
"ConcurrencyId": 1,
"EntityType": "BillingAccount",
"Id": 221
}
}
CustomField2 Example
CustomField2 entities provide ability for consumer to retrieve, add and update values for user-defined fields.
POST <<AM Host Name>>/api/v1/base/CustomField2 HTTP/1.1
CompanyName: <<Sample Company>>
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmI5ZmUiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJXZWQsIDI5IERlYyAyMDIxIDA2OjUwOjUwIEdNVCIsIi5leHBpcmVzIjoiV2VkLCAyOSBEZWMgMjAyMSAwNzoxMDo1MCBHTVQifX19<---->2yQI8aIM_oTAcvNgzyIQk8MNbfXjPKGzUh70lGkiMHuhQEi4VqucT4YBd7A4ATtpL3hRnnD39sQaY2o8jg6h82FydaMQWCLNnjG6-8A8eWgYcGZQdCoGubvzNgzaIHJINV0jbsyqiq5abDnMrft5CfW8WX23QU5gMH6ie00urKUpXxJDKD9t9PLg5uK4qSLaPi5wA0CubfsyLkHHECw2OJes40HpQ_g_52lUlRSr53PbQ5-p8vmpOWXJd-MI2i0psWsAF83Fzxb9kqUdTu99P8bkx0mkla8MG-BqjSzQY3srQIcsrSSPH1y4KEjfyekVC4UYmUzrUbnFeDjc4TxIow
Content-Type: application/json
Content-Length: 2131
{
"Entity": {
"Descriptor": {
"ActorTypeId": "Org",
"Length": 0,
"Type": "Unknown",
"SharedWithProvider": false,
"SharedByRequestor": false,
"CpnRequestorId": 0,
"Name": "",
"Options": [],
"IsRemoved": false,
"ConcurrencyId": 0,
"Id": 1
},
"ObjectId": 408,
"ObjectTypeId": "LeaseUser",
"Value": "232311",
"CurrencyTypeId": "Usd",
"Id": 0
}
}
{
"EntitySpecifier": {
"ConcurrencyId": 1,
"EntityType": "CustomField2",
"Id": 43422
}
}
Location Example
Location entity represents a node in the AssetTree of which the WorkZone is the root. Every node of this tree is represented by a Location entity, including properties, buildings, floors, units, room/areas, equipment and services/utilities.
POST <<AM Host Name>>/api/v1/base/Location HTTP/1.1
CompanyName: <<Sample Company>>
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmI5ZmUiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJXZWQsIDI5IERlYyAyMDIxIDA2OjUwOjUwIEdNVCIsIi5leHBpcmVzIjoiV2VkLCAyOSBEZWMgMjAyMSAwNzoxMDo1MCBHTVQifX19<---->2yQI8aIM_oTAcvNgzyIQk8MNbfXjPKGzUh70lGkiMHuhQEi4VqucT4YBd7A4ATtpL3hRnnD39sQaY2o8jg6h82FydaMQWCLNnjG6-8A8eWgYcGZQdCoGubvzNgzaIHJINV0jbsyqiq5abDnMrft5CfW8WX23QU5gMH6ie00urKUpXxJDKD9t9PLg5uK4qSLaPi5wA0CubfsyLkHHECw2OJes40HpQ_g_52lUlRSr53PbQ5-p8vmpOWXJd-MI2i0psWsAF83Fzxb9kqUdTu99P8bkx0mkla8MG-BqjSzQY3srQIcsrSSPH1y4KEjfyekVC4UYmUzrUbnFeDjc4TxIow
Content-Type: application/json
Content-Length: 1230
{
"entity":{
"Name": "Floor Drain - Dining Room_ARB",
"ModelId": 1262,
"Orphan": true,
"TypeId": "Regular",
"ParentId": 1,
"RootId": 0,
"IsTemplate": false,
"Documents": [],
"IsOffline": true,
"IsLocked": false,
"Attributes": [],
"Id": 0,
"PerformDeletion": false,
"IsNew": false
}
}
{
"EntitySpecifier": {
"ConcurrencyId": 1,
"EntityType": "Location",
"Id": 862312112
}
}
Product Example
A Product is a class of materials to be inventoried, also known as 'part code', 'sku' or 'inventoried item'.
POST <<AM Host Name>>/api/v1/base/Product HTTP/1.1
CompanyName: <<Sample Company>>
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmI5ZmUiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJXZWQsIDI5IERlYyAyMDIxIDA2OjUwOjUwIEdNVCIsIi5leHBpcmVzIjoiV2VkLCAyOSBEZWMgMjAyMSAwNzoxMDo1MCBHTVQifX19<---->2yQI8aIM_oTAcvNgzyIQk8MNbfXjPKGzUh70lGkiMHuhQEi4VqucT4YBd7A4ATtpL3hRnnD39sQaY2o8jg6h82FydaMQWCLNnjG6-8A8eWgYcGZQdCoGubvzNgzaIHJINV0jbsyqiq5abDnMrft5CfW8WX23QU5gMH6ie00urKUpXxJDKD9t9PLg5uK4qSLaPi5wA0CubfsyLkHHECw2OJes40HpQ_g_52lUlRSr53PbQ5-p8vmpOWXJd-MI2i0psWsAF83Fzxb9kqUdTu99P8bkx0mkla8MG-BqjSzQY3srQIcsrSSPH1y4KEjfyekVC4UYmUzrUbnFeDjc4TxIow
Content-Type: application/json
Content-Length: 1501
{
"Entity":{
"DisplayAs": "Element HENNY PENNY_ARB3",
"PartName": "00010",
"Description": "Element HENNY PENNY_NEW",
"Discontinued": false,
"UnitOfMeasureId": "Unit",
"Comments": "",
"Manufacturer": "HENNY PENNY",
"PartNumber": "Product-D1",
"ScanCode": "",
"Category": {
"IsRemoved": false,
"ConcurrencyId": 0,
"Id": 259,
"PerformDeletion": false,
"IsNew": false
},
"Suppliers": [],
"CustomFields": [],
"Currencies": [],
"IsRemoved": false,
"ConcurrencyId": 1,
"Id": 0,
"PerformDeletion": false,
"IsNew": false
}
}
{
"EntitySpecifier": {
"ConcurrencyId": 1,
"EntityType": "Product",
"Id": 1272989
}
}
StockLocation Example
StockLocation entities represent warehouses, vehicles, storerooms or any other named inventory location.
POST <<AM Host Name>>/api/v1/base/StockLocation HTTP/1.1
CompanyName: <<Sample Company>>
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmI5ZmUiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJXZWQsIDI5IERlYyAyMDIxIDA2OjUwOjUwIEdNVCIsIi5leHBpcmVzIjoiV2VkLCAyOSBEZWMgMjAyMSAwNzoxMDo1MCBHTVQifX19<---->2yQI8aIM_oTAcvNgzyIQk8MNbfXjPKGzUh70lGkiMHuhQEi4VqucT4YBd7A4ATtpL3hRnnD39sQaY2o8jg6h82FydaMQWCLNnjG6-8A8eWgYcGZQdCoGubvzNgzaIHJINV0jbsyqiq5abDnMrft5CfW8WX23QU5gMH6ie00urKUpXxJDKD9t9PLg5uK4qSLaPi5wA0CubfsyLkHHECw2OJes40HpQ_g_52lUlRSr53PbQ5-p8vmpOWXJd-MI2i0psWsAF83Fzxb9kqUdTu99P8bkx0mkla8MG-BqjSzQY3srQIcsrSSPH1y4KEjfyekVC4UYmUzrUbnFeDjc4TxIow
Content-Type: application/json
Content-Length: 3301
{
"Entity":{
"DisplayAs": "Arb_Sample_Edit1",
"Number": "Dummy12",
"TypeId": "StoreRoom",
"ShipToName": "",
"BillToName": "",
"DeliveryInstructions": "",
"Comments": "",
"AllowNegativeQty": true,
"MoneyId": "USD",
"TimeZoneId": 20,
"StreetAddresses": [],
"ContactAddresses": [],
"CustomFields": [],
"ConcurrencyId": 1,
"Id": 5,
"PerformDeletion": false,
"IsNew": false
}
}
{
"EntitySpecifier": {
"ConcurrencyId": 1,
"EntityType": "StockLocation",
"Id": 81
}
}