Package com.fourjs.report.facturx.profiles.extended

Class PaymentInstructions

  • public class PaymentInstructions
extends Object
    BG-16:PAYMENT INSTRUCTIONS

    A group of business terms providing information about the payment.

    XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans

    • Method Detail

      • setPaymentMeansTypeCode

        public PaymentInstructions setPaymentMeansTypeCode​(Codes.PaymentMeansCode value)
        Parameters:
        value - BT-81:Payment means type code

        The means, expressed as code, for how a payment is expected to be or has been settled.

        Entries from the UNTDID 4461 code list [6] shall be used. Distinction should be made between SEPA and non-SEPA payments, and between credit payments, direct debits, card payments and other instruments.

        In particular, the following codes can be used:10: Species20: Check30: Transfer (includes SEPA transfer for CHORUSPRO)42: Payment on bank account48: Payment by credit card49: Direct debit (includes SEPA Direct Debit for CHORUSPRO)57 : Standing Agreement58: SEPA transfer (not used for CHORUSPRO: code 30)59: SEPA Direct Debit (not used for CHORUSPRO: code 49)97: ReportZZZ: agreed amoung trading partners on interim basis

        BR-49: A Payment instruction (BG-16) shall specify the Payment means type code (BT-81).

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:TypeCode

        Returns:
        PaymentInstructions

      • setPaymentMeansText

        public PaymentInstructions setPaymentMeansText​(String value)
        Parameters:
        value - BT-82:Payment means text

        The means, expressed as text, for how a payment is expected to be or has been settled.

        Such as cash, credit transfer, direct debit, credit card, etc.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:Information

        Returns:
        PaymentInstructions

      • setPaymentCardPrimaryAccountNumber

        public PaymentInstructions setPaymentCardPrimaryAccountNumber​(String value)
        Parameters:
        value - BT-87:Payment card primary account number

        The Primary Account Number (PAN) of the card used for payment.

        In accordance with card payments security standards an invoice should never include a full card primary account number. At the moment PCI Security Standards Council has defined that the first 6 digits and last 4 digits are the maximum number of digits to be shown.

        BR-51: The last 4 to 6 digits of the Payment card primary account number (BT-87) shall be present if Payment card information (BG-18) is provided in the Invoice.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:ApplicableTradeSettlementFinancialCard/ram:ID

        Returns:
        PaymentInstructions

      • setPaymentCardHolderName

        public PaymentInstructions setPaymentCardHolderName​(String value)
        Parameters:
        value - BT-88:Payment card holder name

        The name of the payment card holder.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:ApplicableTradeSettlementFinancialCard/ram:CardholderName

        Returns:
        PaymentInstructions

      • setDebitedAccountIdentifier

        public PaymentInstructions setDebitedAccountIdentifier​(Identifier value)
        Parameters:
        value - BT-91:Debited account identifier

        The account to be debited by the direct debit.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:PayerPartyDebtorFinancialAccount/ram:IBANID

        Returns:
        PaymentInstructions

      • setPaymentAccountIdentifier

        public PaymentInstructions setPaymentAccountIdentifier​(Identifier value)
        Parameters:
        value - BT-84:Payment account identifier

        A unique identifier of the financial payment account, at a payment service provider, to which payment should be made.

        Such as IBAN (in case of a SEPA payment) or a national account number.

        Use IBANID if applicable, ProprietaryID elseBR-50: A Payment account identifier (BT-84) shall be present if Credit transfer (BG-16) information is provided in the Invoice.BR-61: If the Payment means type code (BT-81) means SEPA credit transfer, Local credit transfer or Non-SEPA international credit transfer, the Payment account identifier (BT-84) shall be present.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:PayeePartyCreditorFinancialAccount/ram:IBANID

        Returns:
        PaymentInstructions

      • setPaymentAccountName

        public PaymentInstructions setPaymentAccountName​(String value)
        Parameters:
        value - BT-85:Payment account name

        The name of the payment account, at a payment service provider, to which payment should be made.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:PayeePartyCreditorFinancialAccount/ram:AccountName

        Returns:
        PaymentInstructions

      • setProprietaryID

        public PaymentInstructions setProprietaryID​(Identifier value)
        Parameters:
        value - BT-84-0:

        Use IBANID when appropriate, otherwise use ProprietaryID

        Use IBANID if applicable, ProprietaryID else

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:PayeePartyCreditorFinancialAccount/ram:ProprietaryID

        Returns:
        PaymentInstructions

      • setPaymentServiceProviderIdentifier

        public PaymentInstructions setPaymentServiceProviderIdentifier​(Identifier value)
        Parameters:
        value - BT-86:Payment service provider identifier

        An identifier for the payment service provider where a payment account is located.

        Such as a BIC or a national clearing code where required. No identification scheme to be used.

        To be used for Credit Transfer onlyCHORUS PRO: Only BIC format is allowed

        Use for credit transfer

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:PayeeSpecifiedCreditorFinancialInstitution/ram:BICID

        Returns:
        PaymentInstructions

      • getPaymentMeansTypeCode

        public Codes.PaymentMeansCode getPaymentMeansTypeCode()
        BT-81:Payment means type code

        The means, expressed as code, for how a payment is expected to be or has been settled.

        Entries from the UNTDID 4461 code list [6] shall be used. Distinction should be made between SEPA and non-SEPA payments, and between credit payments, direct debits, card payments and other instruments.

        In particular, the following codes can be used:10: Species20: Check30: Transfer (includes SEPA transfer for CHORUSPRO)42: Payment on bank account48: Payment by credit card49: Direct debit (includes SEPA Direct Debit for CHORUSPRO)57 : Standing Agreement58: SEPA transfer (not used for CHORUSPRO: code 30)59: SEPA Direct Debit (not used for CHORUSPRO: code 49)97: ReportZZZ: agreed amoung trading partners on interim basis

        BR-49: A Payment instruction (BG-16) shall specify the Payment means type code (BT-81).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:TypeCode

      • getPaymentMeansText

        public String getPaymentMeansText()
        BT-82:Payment means text

        The means, expressed as text, for how a payment is expected to be or has been settled.

        Such as cash, credit transfer, direct debit, credit card, etc.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:Information

      • getPaymentCardPrimaryAccountNumber

        public String getPaymentCardPrimaryAccountNumber()
        BT-87:Payment card primary account number

        The Primary Account Number (PAN) of the card used for payment.

        In accordance with card payments security standards an invoice should never include a full card primary account number. At the moment PCI Security Standards Council has defined that the first 6 digits and last 4 digits are the maximum number of digits to be shown.

        BR-51: The last 4 to 6 digits of the Payment card primary account number (BT-87) shall be present if Payment card information (BG-18) is provided in the Invoice.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:ApplicableTradeSettlementFinancialCard/ram:ID

      • getPaymentCardHolderName

        public String getPaymentCardHolderName()
        BT-88:Payment card holder name

        The name of the payment card holder.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:ApplicableTradeSettlementFinancialCard/ram:CardholderName

      • getDebitedAccountIdentifier

        public Identifier getDebitedAccountIdentifier()
        BT-91:Debited account identifier

        The account to be debited by the direct debit.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:PayerPartyDebtorFinancialAccount/ram:IBANID

      • getPaymentAccountIdentifier

        public Identifier getPaymentAccountIdentifier()
        BT-84:Payment account identifier

        A unique identifier of the financial payment account, at a payment service provider, to which payment should be made.

        Such as IBAN (in case of a SEPA payment) or a national account number.

        Use IBANID if applicable, ProprietaryID elseBR-50: A Payment account identifier (BT-84) shall be present if Credit transfer (BG-16) information is provided in the Invoice.BR-61: If the Payment means type code (BT-81) means SEPA credit transfer, Local credit transfer or Non-SEPA international credit transfer, the Payment account identifier (BT-84) shall be present.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:PayeePartyCreditorFinancialAccount/ram:IBANID

      • getPaymentAccountName

        public String getPaymentAccountName()
        BT-85:Payment account name

        The name of the payment account, at a payment service provider, to which payment should be made.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:PayeePartyCreditorFinancialAccount/ram:AccountName

      • getProprietaryID

        public Identifier getProprietaryID()
        BT-84-0:

        Use IBANID when appropriate, otherwise use ProprietaryID

        Use IBANID if applicable, ProprietaryID else

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:PayeePartyCreditorFinancialAccount/ram:ProprietaryID

      • getPaymentServiceProviderIdentifier

        public Identifier getPaymentServiceProviderIdentifier()
        BT-86:Payment service provider identifier

        An identifier for the payment service provider where a payment account is located.

        Such as a BIC or a national clearing code where required. No identification scheme to be used.

        To be used for Credit Transfer onlyCHORUS PRO: Only BIC format is allowed

        Use for credit transfer

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:PayeeSpecifiedCreditorFinancialInstitution/ram:BICID