BaselineAmendmentRequestV05

tsmt.009.001.05

Scope The BaselineAmendmentRequest message is sent by a primary party involved in a transaction to the matching application. The message is used to request the amendment of an established baseline. Usage The BaselineAmendmentRequest message may only be sent if the transaction is in the state Established or Active. The BaselineAmendmentRequest message can be sent to the matching application by one of the primary parties involved in a transaction established in the push-through mode to request the amendment of an established baseline. The matching application acknowledges the receipt of the amendment request by sending a DeltaReport message to the submitter of the BaselineAmendmentRequest message. It passes on the newly proposed baseline to the counterparty by sending a FullPushThroughReport message, a DeltaReport message and a pre-calculated BaselineReport message. The counterparty is expected to either accept or reject the amendment request by submitting an AmendmentAcceptance or AmendmentRejection message. or The BaselineAmendmentRequest message can be sent by the party involved in a transaction established in the lodge mode to the matching application to amend an established baseline. The matching application amends the baseline according to the BaselineAmendmentRequest message and confirms the execution of the request by sending a DeltaReport and calculated BaselineReport message to the requester of the amendment.

Message Construction

Every ISO20022 message has at the highest level what we call ‘building blocks’. Because the message is constructed as immutable records, the association is by composition. Below you can see the relationship between the message and its constituent building blocks: For comparison, see the ISO20022 official specification

classDiagram
     direction LR
%% BaselineAmendmentRequestV05 recursion level 0 with max 0
BaselineAmendmentRequestV05 *-- "1..1" MessageIdentification1 : RequestIdentification
BaselineAmendmentRequestV05 *-- "1..1" SimpleIdentificationInformation : TransactionIdentification
BaselineAmendmentRequestV05 *-- "0..1" SimpleIdentificationInformation : SubmitterTransactionReference
BaselineAmendmentRequestV05 *-- "1..1" Baseline5 : Baseline
BaselineAmendmentRequestV05 *-- "0..1" ContactIdentification1 : BuyerContactPerson
BaselineAmendmentRequestV05 *-- "0..1" ContactIdentification1 : SellerContactPerson
BaselineAmendmentRequestV05 *-- "0..1" ContactIdentification1 : BuyerBankContactPerson
BaselineAmendmentRequestV05 *-- "0..1" ContactIdentification1 : SellerBankContactPerson
BaselineAmendmentRequestV05 *-- "0..1" ContactIdentification3 : OtherBankContactPerson
  

Now, we will zero-in one-by-one on each of these building blocks.

RequestIdentification building block

Identifies the request message. Identifies a message by a unique identifier and the date and time when the message was created by the sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MessageIdentification1 recursion level 0 with max 1
class MessageIdentification1{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
  

MessageIdentification1 members

TransactionIdentification building block

Unique identification assigned by the matching application to the transaction. This identification is to be used in any communication between the parties. Information related to an identification, eg, party identification or account identification. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SimpleIdentificationInformation recursion level 0 with max 1
class SimpleIdentificationInformation{
    Identification IsoMax35Text
}
  

SimpleIdentificationInformation members

SubmitterTransactionReference building block

Reference to the transaction for the requesting financial institution. Information related to an identification, eg, party identification or account identification. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SimpleIdentificationInformation recursion level 0 with max 1
class SimpleIdentificationInformation{
    Identification IsoMax35Text
}
  

SimpleIdentificationInformation members

Baseline building block

Specifies the commercial details of the underlying transaction. Specifies the commercial details of the underlying transaction. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Baseline5 recursion level 0 with max 1
class Baseline5{
    ServiceCode TradeFinanceService2Code
    LatestMatchDate IsoISODate
    IntentToPayExpected IsoYesNoIndicator
}
Baseline5 *-- "1..1" DocumentIdentification1 : SubmitterBaselineIdentification
Baseline5 *-- "1..1" DocumentIdentification7 : PurchaseOrderReference
Baseline5 *-- "1..1" PartyIdentification26 : Buyer
Baseline5 *-- "1..1" PartyIdentification26 : Seller
Baseline5 *-- "1..1" BICIdentification1 : BuyerBank
Baseline5 *-- "1..1" BICIdentification1 : SellerBank
Baseline5 *-- "0..0" BICIdentification1 : BuyerSideSubmittingBank
Baseline5 *-- "0..0" BICIdentification1 : SellerSideSubmittingBank
Baseline5 *-- "0..1" PartyIdentification26 : BillTo
Baseline5 *-- "0..1" PartyIdentification26 : ShipTo
Baseline5 *-- "0..1" PartyIdentification26 : Consignee
Baseline5 *-- "1..1" LineItem13 : Goods
Baseline5 *-- "1..0" PaymentTerms5 : PaymentTerms
Baseline5 *-- "0..1" SettlementTerms3 : SettlementTerms
Baseline5 *-- "0..0" PaymentObligation2 : PaymentObligation
Baseline5 *-- "1..1" RequiredSubmission2 : CommercialDataSetRequired
Baseline5 *-- "0..1" RequiredSubmission2 : TransportDataSetRequired
Baseline5 *-- "0..1" RequiredSubmission3 : InsuranceDataSetRequired
Baseline5 *-- "0..0" RequiredSubmission4 : CertificateDataSetRequired
Baseline5 *-- "0..0" RequiredSubmission6 : OtherCertificateDataSetRequired
%% DocumentIdentification1 recursion level 1 with max 1
class DocumentIdentification1{
    Identification IsoMax35Text
    Version IsoNumber
}
DocumentIdentification1 *-- "1..1" BICIdentification1 : Submitter
%% DocumentIdentification7 recursion level 1 with max 1
class DocumentIdentification7{
    Identification IsoMax35Text
    DateOfIssue IsoISODate
}
%% PartyIdentification26 recursion level 1 with max 1
class PartyIdentification26{
    Name IsoMax70Text
}
PartyIdentification26 *-- "0..1" GenericIdentification4 : ProprietaryIdentification
PartyIdentification26 *-- "1..1" PostalAddress5 : PostalAddress
%% PartyIdentification26 recursion level 1 with max 1
class PartyIdentification26{
    Name IsoMax70Text
}
PartyIdentification26 *-- "0..1" GenericIdentification4 : ProprietaryIdentification
PartyIdentification26 *-- "1..1" PostalAddress5 : PostalAddress
%% BICIdentification1 recursion level 1 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
%% BICIdentification1 recursion level 1 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
%% BICIdentification1 recursion level 1 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
%% BICIdentification1 recursion level 1 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
%% PartyIdentification26 recursion level 1 with max 1
class PartyIdentification26{
    Name IsoMax70Text
}
PartyIdentification26 *-- "0..1" GenericIdentification4 : ProprietaryIdentification
PartyIdentification26 *-- "1..1" PostalAddress5 : PostalAddress
%% PartyIdentification26 recursion level 1 with max 1
class PartyIdentification26{
    Name IsoMax70Text
}
PartyIdentification26 *-- "0..1" GenericIdentification4 : ProprietaryIdentification
PartyIdentification26 *-- "1..1" PostalAddress5 : PostalAddress
%% PartyIdentification26 recursion level 1 with max 1
class PartyIdentification26{
    Name IsoMax70Text
}
PartyIdentification26 *-- "0..1" GenericIdentification4 : ProprietaryIdentification
PartyIdentification26 *-- "1..1" PostalAddress5 : PostalAddress
%% LineItem13 recursion level 1 with max 1
class LineItem13{
    GoodsAndOrServicesDescription IsoMax70Text
    PartialShipment IsoYesNoIndicator
    TransShipment IsoYesNoIndicator
    LineItemsTotalAmount IsoCurrencyAndAmount
    TotalNetAmount IsoCurrencyAndAmount
}
LineItem13 *-- "0..1" ShipmentDateRange1 : ShipmentDateRange
LineItem13 *-- "1..0" LineItemDetails13 : LineItemDetails
LineItem13 *-- "0..1" TransportMeans5 : RoutingSummary
LineItem13 *-- "0..1" Incoterms4 : Incoterms
LineItem13 *-- "0..0" Adjustment7 : Adjustment
LineItem13 *-- "0..1" Charge24 : FreightCharges
LineItem13 *-- "0..0" Tax23 : Tax
LineItem13 *-- "0..0" UserDefinedInformation1 : BuyerDefinedInformation
LineItem13 *-- "0..0" UserDefinedInformation1 : SellerDefinedInformation
%% PaymentTerms5 recursion level 1 with max 1
PaymentTerms5 *-- "1..1" IPaymentCodeOrOther2Choice : PaymentTerms
PaymentTerms5 *-- "1..1" IAmountOrPercentage2Choice : AmountOrPercentage
%% SettlementTerms3 recursion level 1 with max 1
SettlementTerms3 *-- "0..1" IFinancialInstitutionIdentification4Choice : CreditorAgent
SettlementTerms3 *-- "1..1" CashAccount24 : CreditorAccount
%% PaymentObligation2 recursion level 1 with max 1
class PaymentObligation2{
    ExpiryDate IsoISODate
    ApplicableLaw CountryCode
}
PaymentObligation2 *-- "1..1" BICIdentification1 : ObligorBank
PaymentObligation2 *-- "1..1" BICIdentification1 : RecipientBank
PaymentObligation2 *-- "1..1" IAmountOrPercentage2Choice : PaymentObligationAmount
PaymentObligation2 *-- "0..0" Charges5 : Charges
PaymentObligation2 *-- "0..1" IBPOApplicableRules1Choice : ApplicableRules
PaymentObligation2 *-- "0..1" Location2 : PlaceOfJurisdiction
PaymentObligation2 *-- "0..0" PaymentTerms4 : PaymentTerms
PaymentObligation2 *-- "0..1" SettlementTerms3 : SettlementTerms
%% RequiredSubmission2 recursion level 1 with max 1
RequiredSubmission2 *-- "1..0" BICIdentification1 : Submitter
%% RequiredSubmission2 recursion level 1 with max 1
RequiredSubmission2 *-- "1..0" BICIdentification1 : Submitter
%% RequiredSubmission3 recursion level 1 with max 1
class RequiredSubmission3{
    MatchIssueDate IsoYesNoIndicator
    MatchTransport IsoYesNoIndicator
    MatchAmount IsoYesNoIndicator
    ClausesRequired InsuranceClauses1Code
    MatchAssuredParty AssuredType1Code
}
RequiredSubmission3 *-- "1..0" BICIdentification1 : Submitter
RequiredSubmission3 *-- "0..1" PartyIdentification27 : MatchIssuer
%% RequiredSubmission4 recursion level 1 with max 1
class RequiredSubmission4{
    CertificateType TradeCertificateType1Code
    MatchIssueDate IsoYesNoIndicator
    MatchInspectionDate IsoYesNoIndicator
    AuthorisedInspectorIndicator IsoYesNoIndicator
    MatchConsignee IsoYesNoIndicator
    LineItemIdentification IsoMax70Text
}
RequiredSubmission4 *-- "1..0" BICIdentification1 : Submitter
RequiredSubmission4 *-- "0..1" PartyIdentification27 : MatchIssuer
RequiredSubmission4 *-- "0..1" PartyIdentification27 : MatchManufacturer
%% RequiredSubmission6 recursion level 1 with max 1
class RequiredSubmission6{
    CertificateType IsoExact4AlphaNumericText
    CertificateTypeDescription IsoMax140Text
}
RequiredSubmission6 *-- "1..0" BICIdentification1 : Submitter
  

Baseline5 members

BuyerContactPerson building block

Person to be contacted in the organisation of the buyer. Information needed to contact a physical person. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContactIdentification1 recursion level 0 with max 1
class ContactIdentification1{
    Name IsoMax35Text
    NamePrefix NamePrefix1Code
    GivenName IsoMax35Text
    Role IsoMax35Text
    PhoneNumber IsoPhoneNumber
    FaxNumber IsoPhoneNumber
    EmailAddress IsoMax256Text
}
  

ContactIdentification1 members

SellerContactPerson building block

Person to be contacted in the organisation of the seller. Information needed to contact a physical person. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContactIdentification1 recursion level 0 with max 1
class ContactIdentification1{
    Name IsoMax35Text
    NamePrefix NamePrefix1Code
    GivenName IsoMax35Text
    Role IsoMax35Text
    PhoneNumber IsoPhoneNumber
    FaxNumber IsoPhoneNumber
    EmailAddress IsoMax256Text
}
  

ContactIdentification1 members

BuyerBankContactPerson building block

Person to be contacted in the buyer’s bank. Information needed to contact a physical person. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContactIdentification1 recursion level 0 with max 1
class ContactIdentification1{
    Name IsoMax35Text
    NamePrefix NamePrefix1Code
    GivenName IsoMax35Text
    Role IsoMax35Text
    PhoneNumber IsoPhoneNumber
    FaxNumber IsoPhoneNumber
    EmailAddress IsoMax256Text
}
  

ContactIdentification1 members

SellerBankContactPerson building block

Person to be contacted in the seller’s bank. Information needed to contact a physical person. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContactIdentification1 recursion level 0 with max 1
class ContactIdentification1{
    Name IsoMax35Text
    NamePrefix NamePrefix1Code
    GivenName IsoMax35Text
    Role IsoMax35Text
    PhoneNumber IsoPhoneNumber
    FaxNumber IsoPhoneNumber
    EmailAddress IsoMax256Text
}
  

ContactIdentification1 members

OtherBankContactPerson building block

Person to be contacted in another bank than the seller or buyer’s bank. Information needed to contact a physical person. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContactIdentification3 recursion level 0 with max 1
class ContactIdentification3{
    BIC IsoBICIdentifier
    Name IsoMax35Text
    NamePrefix NamePrefix1Code
    GivenName IsoMax35Text
    Role IsoMax35Text
    PhoneNumber IsoPhoneNumber
    FaxNumber IsoPhoneNumber
    EmailAddress IsoMax256Text
}
  

ContactIdentification3 members

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the BaselineAmendmentRequestV05 implementation follows a specific implementaiton pattern. First of all, BaselineAmendmentRequestV05 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, BaselineAmendmentRequestV05Document implements IOuterDocument. Because BaselineAmendmentRequestV05 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type BaselineAmendmentRequestV05.

classDiagram
    class IOuterRecord
    BaselineAmendmentRequestV05 --|> IOuterRecord : Implements
    BaselineAmendmentRequestV05Document --|> IOuterDocument~BaselineAmendmentRequestV05~ : Implements
    class IOuterDocument~BaselineAmendmentRequestV05~ {
        BaselineAmendmentRequestV05 Message
     }
  

Document wrapper for serialization

The only real purpose BaselineAmendmentRequestV05Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:tsmt.009.001.05’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using BaselineAmendmentRequestV05.ToDocument() method. The returned BaselineAmendmentRequestV05Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    BaselineAmendmentRequestV05Document *-- BaselineAmendmentRequestV05 : Document
  

Sample of message format

This is an abbreviated version of what the message should look like.

<Document xmlns="urn:iso:std:iso:20022:tech:xsd:tsmt.009.001.05">
    <BaselnAmdmntReq>
        <ReqId>
            <!-- RequestIdentification inner content -->
        </ReqId>
        <TxId>
            <!-- TransactionIdentification inner content -->
        </TxId>
        <SubmitrTxRef>
            <!-- SubmitterTransactionReference inner content -->
        </SubmitrTxRef>
        <Baseln>
            <!-- Baseline inner content -->
        </Baseln>
        <BuyrCtctPrsn>
            <!-- BuyerContactPerson inner content -->
        </BuyrCtctPrsn>
        <SellrCtctPrsn>
            <!-- SellerContactPerson inner content -->
        </SellrCtctPrsn>
        <BuyrBkCtctPrsn>
            <!-- BuyerBankContactPerson inner content -->
        </BuyrBkCtctPrsn>
        <SellrBkCtctPrsn>
            <!-- SellerBankContactPerson inner content -->
        </SellrBkCtctPrsn>
        <OthrBkCtctPrsn>
            <!-- OtherBankContactPerson inner content -->
        </OthrBkCtctPrsn>
    </BaselnAmdmntReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_Nd_okQgGEeSeS5xdjFfOTw"
  previousVersion="_glyJkdM7EeK-v49t1oWkNA"
  name="BaselineAmendmentRequestV05"
  definition="Scope&#xD;&#xA;The BaselineAmendmentRequest message is sent by a primary party involved in a transaction to the matching application.&#xD;&#xA;The message is used to request the amendment of an established baseline.&#xD;&#xA;Usage&#xD;&#xA;The BaselineAmendmentRequest message may only be sent if the transaction is in the state Established or Active.&#xD;&#xA;The BaselineAmendmentRequest message can be sent to the matching application by one of the primary parties involved in a transaction established in the push-through mode to request the amendment of an established baseline.&#xD;&#xA;The matching application acknowledges the receipt of the amendment request by sending a DeltaReport message to the submitter of the BaselineAmendmentRequest message. It passes on the newly proposed baseline to the counterparty by sending a FullPushThroughReport message, a DeltaReport message and a pre-calculated BaselineReport message.&#xD;&#xA;The counterparty is expected to either accept or reject the amendment request by submitting an AmendmentAcceptance or AmendmentRejection message.&#xD;&#xA;or&#xD;&#xA;The BaselineAmendmentRequest message can be sent by the party involved in a transaction established in the lodge mode to the matching application to amend an established baseline.&#xD;&#xA;The matching application amends the baseline according to the BaselineAmendmentRequest message and confirms the execution of the request by sending a DeltaReport and calculated BaselineReport message to the requester of the amendment."
  registrationStatus="Registered"
  messageSet="_1a374FXOEeOkkLyrDUP66g"
  xmlTag="BaselnAmdmntReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_Nd_okwgGEeSeS5xdjFfOTw"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_Nd_olQgGEeSeS5xdjFfOTw"
    previousVersion="_glywodM7EeK-v49t1oWkNA"
    name="RequestIdentification"
    definition="Identifies the request message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="ReqId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_Nd_olwgGEeSeS5xdjFfOTw"
    previousVersion="_glywo9M7EeK-v49t1oWkNA"
    name="TransactionIdentification"
    definition="Unique identification assigned by the matching application to the transaction.&#xA;This identification is to be used in any communication between the parties."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="TxId"
    complexType="_P-ile9p-Ed-ak6NoX_4Aeg_745508310" />
  <messageBuildingBlock
    xmi:id="_Nd_omQgGEeSeS5xdjFfOTw"
    previousVersion="_glywpdM7EeK-v49t1oWkNA"
    name="SubmitterTransactionReference"
    definition="Reference to the transaction for the requesting financial institution."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SubmitrTxRef"
    complexType="_P-ile9p-Ed-ak6NoX_4Aeg_745508310" />
  <messageBuildingBlock
    xmi:id="_Nd_omwgGEeSeS5xdjFfOTw"
    previousVersion="_glywp9M7EeK-v49t1oWkNA"
    name="Baseline"
    definition="Specifies the commercial details of the underlying transaction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Baseln"
    complexType="_Jxr5cQgHEeSeS5xdjFfOTw" />
  <messageBuildingBlock
    xmi:id="_Nd_onQgGEeSeS5xdjFfOTw"
    previousVersion="_glywqdM7EeK-v49t1oWkNA"
    name="BuyerContactPerson"
    definition="Person to be contacted in the organisation of the buyer."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="BuyrCtctPrsn"
    complexType="_QBOtE9p-Ed-ak6NoX_4Aeg_-1391367345" />
  <messageBuildingBlock
    xmi:id="_Nd_onwgGEeSeS5xdjFfOTw"
    previousVersion="_glywq9M7EeK-v49t1oWkNA"
    name="SellerContactPerson"
    definition="Person to be contacted in the organisation of the seller."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="SellrCtctPrsn"
    complexType="_QBOtE9p-Ed-ak6NoX_4Aeg_-1391367345" />
  <messageBuildingBlock
    xmi:id="_Nd_ooQgGEeSeS5xdjFfOTw"
    previousVersion="_glywrdM7EeK-v49t1oWkNA"
    name="BuyerBankContactPerson"
    definition="Person to be contacted in the buyer's bank."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="BuyrBkCtctPrsn"
    complexType="_QBOtE9p-Ed-ak6NoX_4Aeg_-1391367345" />
  <messageBuildingBlock
    xmi:id="_Nd_oowgGEeSeS5xdjFfOTw"
    previousVersion="_glywr9M7EeK-v49t1oWkNA"
    name="SellerBankContactPerson"
    definition="Person to be contacted in the seller's bank."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="SellrBkCtctPrsn"
    complexType="_QBOtE9p-Ed-ak6NoX_4Aeg_-1391367345" />
  <messageBuildingBlock
    xmi:id="_Nd_opQgGEeSeS5xdjFfOTw"
    previousVersion="_glywsdM7EeK-v49t1oWkNA"
    name="OtherBankContactPerson"
    definition="Person to be contacted in another bank than the seller or buyer's bank."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="OthrBkCtctPrsn"
    complexType="_QDTwsdp-Ed-ak6NoX_4Aeg_-1939165929" />
  <messageDefinitionIdentifier
    businessArea="tsmt"
    messageFunctionality="009"
    flavour="001"
    version="05" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.