KVSKBABEOFrediMappingAPIV2
Summary: Mapping logic for BEO Fredi API V2 responses and requests.
Events
OnBeforeMapRecipientContactPerson(Record KVSKBAPostedDispatchHandHeader, JsonObject, Boolean) :
Summary: This event allows to influence the mapping of the recipient contact person. Since the contact person information on the Posted Dispatch Handling Header is very limited, this allows to fill in more details based on the existing information on the header or by using custom logic (e.g. retrieving data from a custom table). If IsHandled is set to true, the standard mapping logic will be skipped.
[IntegrationEvent(false, false)]
local procedure OnBeforeMapRecipientContactPerson(PostedDispatchHandHeader: Record "KVSKBAPostedDispatchHandHeader"; var ReturnObject: JsonObject; var IsHandled: Boolean):
Parameters:
PostedDispatchHandHeader: The posted dispatch handling header record for which the mapping is executedReturnObject: The JSON object that will be sent to BEO Fredi as part of the shipment information. The mapping logic fills in the contact person details in this object, so it can be influenced here.IsHandled: If set to true, the standard mapping logic in the MapRecipientContactPerson procedure will be skipped. This allows for custom handling of the recipient contact person mapping.
Remarks: This event is raised before the standard mapping logic for the recipient contact person is executed. It allows for custom handling of the mapping process.
OnAfterMapDeliveryObject(Record KVSKBAPostedDispatchHandHeader, JsonObject) :
Summary: This event allows to influence the mapping of the delivery object. It is raised after the standard mapping logic for the delivery object has been executed, allowing for custom modifications to the resulting JSON object.
[IntegrationEvent(false, false)]
local procedure OnAfterMapDeliveryObject(PostedDispatchHandHeader: Record "KVSKBAPostedDispatchHandHeader"; var ReturnObject: JsonObject):
Parameters:
PostedDispatchHandHeader: The posted dispatch handling header record for which the mapping is executedReturnObject: The JSON object that represents the delivery object. It can be modified to influence the final mapping result.
OnAfterMapPickupObject(Record KVSKBAPostedDispatchHandHeader, JsonObject) :
Summary: This event allows to influence the mapping of the pickup object. It is raised after the standard mapping logic for the pickup object has been executed, allowing for custom modifications to the resulting JSON object.
[IntegrationEvent(false, false)]
local procedure OnAfterMapPickupObject(PostedDispatchHandHeader: Record "KVSKBAPostedDispatchHandHeader"; var ReturnObject: JsonObject):
Parameters:
PostedDispatchHandHeader: The posted dispatch handling header record for which the mapping is executedReturnObject: The JSON object that represents the delivery object. It can be modified to influence the final mapping result.
OnAfterMapCarrierOptionsObject(Record KVSKBAPostedDispatchHandHeader, JsonObject) :
Summary: This event allows to influence the mapping of the carrier options object. It is raised after the standard mapping logic for the carrier options object has been executed, allowing for custom modifications to the resulting JSON object.
[IntegrationEvent(false, false)]
local procedure OnAfterMapCarrierOptionsObject(PostedDispatchHandHeader: Record "KVSKBAPostedDispatchHandHeader"; var ReturnObject: JsonObject):
Parameters:
PostedDispatchHandHeader: The posted dispatch handling header record for which the mapping is executedReturnObject: The JSON object that represents the delivery object. It can be modified to influence the final mapping result.
OnAfterMapUnitsObject(JsonObject) :
Summary: This event allows to influence the mapping of the units object. It is raised after the standard mapping logic for the units object has been executed, allowing for custom modifications to the resulting JSON object.
[IntegrationEvent(false, false)]
local procedure OnAfterMapUnitsObject(var ReturnObject: JsonObject):
Parameters:
ReturnObject: The JSON object that represents the units object. It can be modified to influence the final mapping result.
OnAfterMapPaymentObject(Record KVSKBAPostedDispatchHandHeader, Record KVSKBAShippingType, JsonObject) :
Summary: This event allows to influence the mapping of the payment object. It is raised after the standard mapping logic for the payment object has been executed, allowing for custom modifications to the resulting JSON object.
[IntegrationEvent(false, false)]
local procedure OnAfterMapPaymentObject(PostedDispatchHandHeader: Record "KVSKBAPostedDispatchHandHeader"; ShippingType: Record "KVSKBAShippingType"; var ReturnObject: JsonObject):
Parameters:
PostedDispatchHandHeader: The posted dispatch handling header record for which the mapping is executedShippingType: The shipping type record associated with the payment mappingReturnObject: The JSON object that represents the payment object. It can be modified to influence the final mapping result.
OnAfterMapCustomsObject(Record KVSKBAPostedDispatchHandHeader, JsonObject) :
Summary: This event allows to influence the mapping of the customs object. It is raised after the standard mapping logic for the customs object has been executed, allowing for custom modifications to the resulting JSON object.
[IntegrationEvent(false, false)]
local procedure OnAfterMapCustomsObject(PostedDispatchHandHeader: Record "KVSKBAPostedDispatchHandHeader"; var ReturnObject: JsonObject):
Parameters:
PostedDispatchHandHeader: The posted dispatch handling header record for which the mapping is executedReturnObject: The JSON object that represents the customs object. It can be modified to influence the final mapping result.
OnAfterMapReferencesObject(Record KVSKBAPostedDispatchHandHeader, JsonObject) :
Summary: This event allows to influence the mapping of the references object. It is raised after the standard mapping logic for the references object has been executed, allowing for custom modifications to the resulting JSON object.
[IntegrationEvent(false, false)]
local procedure OnAfterMapReferencesObject(PostedDispatchHandHeader: Record "KVSKBAPostedDispatchHandHeader"; var ReturnObject: JsonObject):
Parameters:
PostedDispatchHandHeader: The posted dispatch handling header record for which the mapping is executedReturnObject: The JSON object that represents the references object. It can be modified to influence the final mapping result.
OnAfterAddItemToArray(Record KVSKBAPostedDispatchHandlLine, JsonObject) :
Summary: This event allows to influence the addition of an item to the array. It is raised after the standard logic for adding an item to the array has been executed, allowing for custom modifications to the resulting JSON object.
[IntegrationEvent(false, false)]
local procedure OnAfterAddItemToArray(PostedDispatchHandlLine: Record "KVSKBAPostedDispatchHandlLine"; var ReturnObject: JsonObject):
Parameters:
PostedDispatchHandlLine: The posted dispatch handling line record for which the item is addedReturnObject: The JSON object representing the item. It can be modified to influence the final mapping result.
OnAfterAddPackageLineToPackagesArray(Record KVSKBAPostedDispatchHandlLine, JsonArray) :
Summary: This event allows to influence the addition of a package line to the packages array. It is raised after the standard logic for adding a package line to the array has been executed, allowing for custom modifications to the resulting JSON array.
[IntegrationEvent(false, false)]
local procedure OnAfterAddPackageLineToPackagesArray(var PostedDispatchHandlLine: Record "KVSKBAPostedDispatchHandlLine"; var ReturnArray: JsonArray):
Parameters:
PostedDispatchHandlLine: The posted dispatch handling line record for which the package line is addedReturnArray: The JSON array representing the packages. It can be modified to influence the final mapping result.
OnAfterMapRecipientContact(Record KVSKBAPostedDispatchHandHeader, JsonObject) :
Summary: This event allows to influence the mapping of the recipient contact object. It is raised after the standard mapping logic for the recipient contact object has been executed, allowing for custom modifications to the resulting JSON object.
[IntegrationEvent(false, false)]
local procedure OnAfterMapRecipientContact(PostedDispatchHandHeader: Record "KVSKBAPostedDispatchHandHeader"; var ReturnObject: JsonObject):
Parameters:
PostedDispatchHandHeader: The posted dispatch handling header record for which the mapping is executedReturnObject: The JSON object that represents the recipient contact object. It can be modified to influence the final mapping result.
OnAfterMapIdentifiersArray(Text, Text[2], JsonArray) :
Summary: This event allows to influence the mapping of the identifiers array. It is raised after the standard mapping logic for the identifiers array has been executed, allowing for custom modifications to the resulting JSON array.
[IntegrationEvent(false, false)]
local procedure OnAfterMapIdentifiersArray(VATRegistrationNo: Text; CountryIsoCode: Text[2]; var ReturnArray: JsonArray):
Parameters:
VATRegistrationNo: The VAT registration number to be included in the identifiers arrayCountryIsoCode: The country ISO code to be included in the identifiers arrayReturnArray: The JSON array representing the identifiers. It can be modified to influence the final mapping result.
OnAfterMapRecipientObject(Record KVSKBAPostedDispatchHandHeader, JsonObject) :
Summary: This event allows to influence the mapping of the recipient object. It is raised after the standard mapping logic for the recipient object has been executed, allowing for custom modifications to the resulting JSON object.
[IntegrationEvent(false, false)]
local procedure OnAfterMapRecipientObject(PostedDispatchHandHeader: Record "KVSKBAPostedDispatchHandHeader"; var ReturnObject: JsonObject):
Parameters:
PostedDispatchHandHeader: The posted dispatch handling header record for which the mapping is executedReturnObject: The JSON object that represents the recipient object. It can be modified to influence the final mapping result.
OnAfterMapSenderContactByCompanyInfo(Record Company Information, JsonObject) :
Summary: This event allows to influence the mapping of the sender contact object based on company information. It is raised after the standard mapping logic for the sender contact object has been executed, allowing for custom modifications to the resulting JSON object.
[IntegrationEvent(false, false)]
local procedure OnAfterMapSenderContactByCompanyInfo(CompanyInformation: Record "Company Information"; var ReturnObject: JsonObject):
Parameters:
CompanyInformation: The company information record for which the mapping is executedReturnObject: The JSON object that represents the sender contact object. It can be modified to influence the final mapping result.
OnAfterMapSenderObjectByCompanyInfo(JsonObject) :
Summary: This event allows to influence the mapping of the sender object based on company information. It is raised after the standard mapping logic for the sender object has been executed, allowing for custom modifications to the resulting JSON object.
[IntegrationEvent(false, false)]
local procedure OnAfterMapSenderObjectByCompanyInfo(var ReturnObject: JsonObject):
Parameters:
ReturnObject: The JSON object that represents the sender object. It can be modified to influence the final mapping result.
OnAfterMapSenderContactByLocation(Record Location, JsonObject) :
Summary: This event allows to influence the mapping of the sender contact object based on location information. It is raised after the standard mapping logic for the sender contact object has been executed, allowing for custom modifications to the resulting JSON object.
[IntegrationEvent(false, false)]
local procedure OnAfterMapSenderContactByLocation(Location: Record "Location"; var ReturnObject: JsonObject):
Parameters:
Location: The location record for which the mapping is executedReturnObject: The JSON object that represents the sender contact object. It can be modified to influence the final mapping result.
OnAfterMapSenderObjectByLocation(Record Location, JsonObject) :
Summary: This event allows to influence the mapping of the sender object based on location information. It is raised after the standard mapping logic for the sender object has been executed, allowing for custom modifications to the resulting JSON object.
[IntegrationEvent(false, false)]
local procedure OnAfterMapSenderObjectByLocation(Location: Record "Location"; var ReturnObject: JsonObject):
Parameters:
Location: The location record for which the mapping is executedReturnObject: The JSON object that represents the sender object. It can be modified to influence the final mapping result.
OnAfterMapShipmentObject(Record KVSKBAPostedDispatchHandHeader, JsonObject) :
Summary: This event allows to influence the mapping of the shipment object. It is raised after the standard mapping logic for the shipment object has been executed, allowing for custom modifications to the resulting JSON object.
[IntegrationEvent(false, false)]
local procedure OnAfterMapShipmentObject(PostedDispatchHandHeader: Record "KVSKBAPostedDispatchHandHeader"; var ReturnObject: JsonObject):
Parameters:
PostedDispatchHandHeader: The posted dispatch header record for which the mapping is executedReturnObject: The JSON object that represents the shipment object. It can be modified to influence the final mapping result.