1.5.1 Business Details
Event notification for amendment in business details of the party.
The business details Data Segment supports amendments via both PUT and PATCH API methods. When employing the PATCH API method for amendments, event publishing will be contingent on the information provided in the request and will solely include the attributes that have been modified.
The PATCH API method, an HTTP request method, is utilized for field-level modifications
within a Data Segment of customer information, rather than updating the entire Data
Segment Information. Through the PATCH Method, specific fields can be added, updated, or
deleted at the Data Segment level by specifying the attributes requiring modification.
recordStat field in the event identifies the nature of amendment as:
- "U" - Update to an existing record.
- "I" - Insert of a new record.
- "D" - Delete of an existing record.
Table 1-35 Data Segment
| Data Segment Code | Data Segment Name | Topic Name | Party Type |
|---|---|---|---|
| DS0081 | BUSINESS_DETAILS | obpySmbAmendBusinessDetails | SMB |
Event
Payload
{
"applicationNumber": "string",
"branchCode": "string",
"userId": "string",
"partyId": "string",
"externalCustomerId": "string",
"partyType": "S",
"eventType": "AMEND",
"handoffStatus": "SUCCESS",
"sourceProductId": "OBPY",
"datasegmentCode": "DS0081",
"datasegmentName": "BUSINESS_DETAILS",
"httpMethod": "PUT",
"amendPayload": {
"whereaboutsUnknown": "false",
"lineOfBusiness": "FAC",
"rmId": "string",
"deceased": "false",
"applicationNumber": "string",
"recordStat": "W",
"partySubType": "SMB",
"language": "ENG",
"updatedDate": "2018-03-30T00:00:00",
"partyType": "S",
"recordId": "string",
"handOffStatus": "false",
"versionNo": "1",
"currency": "USD",
"links": "[]",
"customerVersionNo": "1",
"incorporationDate": "2024-06-04",
"partyId": "string",
"countryOfRegistration": "US",
"isInstaOnboarded": "false",
"updatedBy": "string",
"organizationName": "string",
"taxIdNumber": "string",
"frozen": "false",
"externalCustomerNo": "string",
"sourceProductId": "string",
"branchCode": "string",
"isCustomer": "true",
"createdDate": "2018-03-30T00:00:00",
"createdBy": "string",
"smbRegistrationNumber": "string",
"shortName": "string",
"bankrupt": "false"
},
"amendDateTime": "2018-03-30T00:00:00.053035",
"applicationDate": "2018-03-30"
}
- SMB Party Status
Party Status event is published for an amendment in Party Status. Party status event is only published, in case of any amendment in the status of the party.
Parent topic: Small & Medium Business (SMB) Party Amendment