Root Schema : createOrganizationRequest_request
Type: object
Show Source
{
"properties":{
"organizationRequest":{
"properties":{
"approverComments":{
"description":"Org request approver comments",
"type":"string"
},
"relatedOrganizationName":{
"description":"Requester organization name.",
"type":"string"
},
"profile":{
"description":"Profile",
"type":"object",
"properties":{
"lastName":{
"description":"Last name of the profile",
"type":"string"
},
"firstName":{
"description":"first name of the profile",
"type":"string"
},
"customerContactId":{
"description":"The external customer contact id.",
"type":"string"
},
"id":{
"description":"Repository Id of the profile",
"type":"string"
},
"email":{
"description":"emailid of profile",
"type":"string"
}
}
},
"organization":{
"description":"Organization",
"properties":{
"customerType":{
"description":"Customer Type for Organization",
"type":"string"
},
"taxReferenceNumber":{
"description":"taxReferenceNumberof organization",
"type":"string"
},
"secondaryAddressesIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding secondaryAddresses property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"name":{
"description":"The name for Organization",
"type":"string"
},
"secondaryAddresses":{
"description":"Address associated with an Organization request, this is the address provided by the requestor at the time of request creation. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"address":{
"description":"Address created for the Organization.",
"type":"object",
"properties":{
"country":{
"description":"The country of the address",
"type":"string"
},
"phoneNumber":{
"description":"Phone Number of the address",
"type":"string"
},
"address2":{
"description":"The address2 of the secondary address",
"type":"string"
},
"city":{
"description":"The city of the secondary address",
"type":"string"
},
"address1":{
"description":"The address1 of the secondary address",
"type":"string"
},
"companyName":{
"description":"Company name of the secondary address",
"type":"string"
},
"postalCode":{
"description":"Postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"repository Id of the address",
"type":"string"
},
"state":{
"description":"The State of the address",
"type":"string"
}
}
},
"addressType":{
"description":"Address type represents nick name of account if present else repository ID of address item.",
"type":"string"
}
}
}
},
"id":{
"description":"Repository Id of the Organization",
"type":"string"
},
"type":{
"description":"Type of Organization",
"type":"string"
},
"vatReferenceNumber":{
"description":"Vat reference number for the organization",
"type":"string"
},
"dunsNumber":{
"description":"dunsNumber of organization",
"type":"string"
},
"uniqueId":{
"description":"Unique Id of the Organization",
"type":"string"
}
}
},
"name":{
"description":"Organization request name given by the requester",
"type":"string"
},
"createdTime":{
"format":"date-time",
"description":"The date the account request was created",
"type":"string"
},
"siteId":{
"description":"Site id captured during request creation",
"type":"string"
},
"id":{
"description":"Id of Organization Request",
"type":"string"
},
"requesterComments":{
"description":"Requester comments given at time of creating request",
"type":"string"
},
"status":{
"description":"Status of Organization Request",
"type":"string"
}
}
}
}
}
Nested Schema : organizationRequest
Type: object
Show Source
{
"properties":{
"approverComments":{
"description":"Org request approver comments",
"type":"string"
},
"relatedOrganizationName":{
"description":"Requester organization name.",
"type":"string"
},
"profile":{
"description":"Profile",
"type":"object",
"properties":{
"lastName":{
"description":"Last name of the profile",
"type":"string"
},
"firstName":{
"description":"first name of the profile",
"type":"string"
},
"customerContactId":{
"description":"The external customer contact id.",
"type":"string"
},
"id":{
"description":"Repository Id of the profile",
"type":"string"
},
"email":{
"description":"emailid of profile",
"type":"string"
}
}
},
"organization":{
"description":"Organization",
"properties":{
"customerType":{
"description":"Customer Type for Organization",
"type":"string"
},
"taxReferenceNumber":{
"description":"taxReferenceNumberof organization",
"type":"string"
},
"secondaryAddressesIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding secondaryAddresses property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"name":{
"description":"The name for Organization",
"type":"string"
},
"secondaryAddresses":{
"description":"Address associated with an Organization request, this is the address provided by the requestor at the time of request creation. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"address":{
"description":"Address created for the Organization.",
"type":"object",
"properties":{
"country":{
"description":"The country of the address",
"type":"string"
},
"phoneNumber":{
"description":"Phone Number of the address",
"type":"string"
},
"address2":{
"description":"The address2 of the secondary address",
"type":"string"
},
"city":{
"description":"The city of the secondary address",
"type":"string"
},
"address1":{
"description":"The address1 of the secondary address",
"type":"string"
},
"companyName":{
"description":"Company name of the secondary address",
"type":"string"
},
"postalCode":{
"description":"Postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"repository Id of the address",
"type":"string"
},
"state":{
"description":"The State of the address",
"type":"string"
}
}
},
"addressType":{
"description":"Address type represents nick name of account if present else repository ID of address item.",
"type":"string"
}
}
}
},
"id":{
"description":"Repository Id of the Organization",
"type":"string"
},
"type":{
"description":"Type of Organization",
"type":"string"
},
"vatReferenceNumber":{
"description":"Vat reference number for the organization",
"type":"string"
},
"dunsNumber":{
"description":"dunsNumber of organization",
"type":"string"
},
"uniqueId":{
"description":"Unique Id of the Organization",
"type":"string"
}
}
},
"name":{
"description":"Organization request name given by the requester",
"type":"string"
},
"createdTime":{
"format":"date-time",
"description":"The date the account request was created",
"type":"string"
},
"siteId":{
"description":"Site id captured during request creation",
"type":"string"
},
"id":{
"description":"Id of Organization Request",
"type":"string"
},
"requesterComments":{
"description":"Requester comments given at time of creating request",
"type":"string"
},
"status":{
"description":"Status of Organization Request",
"type":"string"
}
}
}
Nested Schema : organization
Type: object
Organization
Show Source
{
"description":"Organization",
"properties":{
"customerType":{
"description":"Customer Type for Organization",
"type":"string"
},
"taxReferenceNumber":{
"description":"taxReferenceNumberof organization",
"type":"string"
},
"secondaryAddressesIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding secondaryAddresses property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"name":{
"description":"The name for Organization",
"type":"string"
},
"secondaryAddresses":{
"description":"Address associated with an Organization request, this is the address provided by the requestor at the time of request creation. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"address":{
"description":"Address created for the Organization.",
"type":"object",
"properties":{
"country":{
"description":"The country of the address",
"type":"string"
},
"phoneNumber":{
"description":"Phone Number of the address",
"type":"string"
},
"address2":{
"description":"The address2 of the secondary address",
"type":"string"
},
"city":{
"description":"The city of the secondary address",
"type":"string"
},
"address1":{
"description":"The address1 of the secondary address",
"type":"string"
},
"companyName":{
"description":"Company name of the secondary address",
"type":"string"
},
"postalCode":{
"description":"Postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"repository Id of the address",
"type":"string"
},
"state":{
"description":"The State of the address",
"type":"string"
}
}
},
"addressType":{
"description":"Address type represents nick name of account if present else repository ID of address item.",
"type":"string"
}
}
}
},
"id":{
"description":"Repository Id of the Organization",
"type":"string"
},
"type":{
"description":"Type of Organization",
"type":"string"
},
"vatReferenceNumber":{
"description":"Vat reference number for the organization",
"type":"string"
},
"dunsNumber":{
"description":"dunsNumber of organization",
"type":"string"
},
"uniqueId":{
"description":"Unique Id of the Organization",
"type":"string"
}
}
}
Nested Schema : profile
Type: object
Profile
Show Source
{
"description":"Profile",
"type":"object",
"properties":{
"lastName":{
"description":"Last name of the profile",
"type":"string"
},
"firstName":{
"description":"first name of the profile",
"type":"string"
},
"customerContactId":{
"description":"The external customer contact id.",
"type":"string"
},
"id":{
"description":"Repository Id of the profile",
"type":"string"
},
"email":{
"description":"emailid of profile",
"type":"string"
}
}
}
Nested Schema : secondaryAddresses
Type: array
Address associated with an Organization request, this is the address provided by the requestor at the time of request creation. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
{
"description":"Address associated with an Organization request, this is the address provided by the requestor at the time of request creation. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"address":{
"description":"Address created for the Organization.",
"type":"object",
"properties":{
"country":{
"description":"The country of the address",
"type":"string"
},
"phoneNumber":{
"description":"Phone Number of the address",
"type":"string"
},
"address2":{
"description":"The address2 of the secondary address",
"type":"string"
},
"city":{
"description":"The city of the secondary address",
"type":"string"
},
"address1":{
"description":"The address1 of the secondary address",
"type":"string"
},
"companyName":{
"description":"Company name of the secondary address",
"type":"string"
},
"postalCode":{
"description":"Postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"repository Id of the address",
"type":"string"
},
"state":{
"description":"The State of the address",
"type":"string"
}
}
},
"addressType":{
"description":"Address type represents nick name of account if present else repository ID of address item.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"address":{
"description":"Address created for the Organization.",
"type":"object",
"properties":{
"country":{
"description":"The country of the address",
"type":"string"
},
"phoneNumber":{
"description":"Phone Number of the address",
"type":"string"
},
"address2":{
"description":"The address2 of the secondary address",
"type":"string"
},
"city":{
"description":"The city of the secondary address",
"type":"string"
},
"address1":{
"description":"The address1 of the secondary address",
"type":"string"
},
"companyName":{
"description":"Company name of the secondary address",
"type":"string"
},
"postalCode":{
"description":"Postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"repository Id of the address",
"type":"string"
},
"state":{
"description":"The State of the address",
"type":"string"
}
}
},
"addressType":{
"description":"Address type represents nick name of account if present else repository ID of address item.",
"type":"string"
}
}
}
Nested Schema : address
Type: object
Address created for the Organization.
Show Source
{
"description":"Address created for the Organization.",
"type":"object",
"properties":{
"country":{
"description":"The country of the address",
"type":"string"
},
"phoneNumber":{
"description":"Phone Number of the address",
"type":"string"
},
"address2":{
"description":"The address2 of the secondary address",
"type":"string"
},
"city":{
"description":"The city of the secondary address",
"type":"string"
},
"address1":{
"description":"The address1 of the secondary address",
"type":"string"
},
"companyName":{
"description":"Company name of the secondary address",
"type":"string"
},
"postalCode":{
"description":"Postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"repository Id of the address",
"type":"string"
},
"state":{
"description":"The State of the address",
"type":"string"
}
}
}