Class PaymentInstructions

java.lang.Object
com.fourjs.report.facturx.profiles.extended.PaymentInstructions

public class PaymentInstructions extends Object
BG-16 PAYMENT INSTRUCTIONS — A group of business terms providing information about the payment.

The EN 16931 business terms and groups implemented by this class:

Business terms and groups implemented
RepresentsBG-16
Business terms (value fields)BT-81, BT-82, BT-84, BT-84-0, BT-85, BT-86, BT-87, BT-88, BT-91, BT-215, BT-216

Documentation of the represented business group:

BG-16 — PAYMENT INSTRUCTIONS
DescriptionENA group of business terms providing information about the payment.
FRGroupe de termes métiers fournissant des informations sur le paiement.
Since:
1.0.06/2.2
  • Method Details

    • setDebitedAccountPaymentServiceProviderIdentifier

      public PaymentInstructions setDebitedAccountPaymentServiceProviderIdentifier(String value)
      Sets BT-215 Debited account payment service provider identifier — An identifier for the payment service provider where a payment account is located.Usage Note: Such as a BIC or a national clearing code where required. No Identification Scheme to be used.

      Usage: Use IBANID when appropriate, otherwise use ProprietaryID

      Rule: Use IBANID if applicable, ProprietaryID else

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

      FR: Identifiant du prestataire de services de paiement du compte débité — Identifiant du prestataire de services de paiement auprès duquel est ouvert un compte de paiement.Remarque d'utilisation : par exemple, un code BIC ou un code de compensation national, le cas échéant. Aucun schéma d'identification ne doit être utilisé.

      Parameters:
      value - the value to set
      Returns:
      this PaymentInstructions for chaining
      Since:
      1.09.2/2.5.2
    • setDebitedAccountName

      public PaymentInstructions setDebitedAccountName(String value)
      Sets BT-216 Debited account name — The name of the payment account, at a payment service provider, from which payment should be made.

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

      FR: Nom du compte bancaire débité — Le nom du compte de paiement, auprès d'un prestataire de services de paiement, à partir duquel le paiement doit être effectué.

      Parameters:
      value - the value to set
      Returns:
      this PaymentInstructions for chaining
      Since:
      1.09.2/2.5.2
    • setPaymentMeansTypeCode

      public PaymentInstructions setPaymentMeansTypeCode(Codes.PaymentMeansCode value)
      Sets BT-81 Payment means type code — The means, expressed as code, for how a payment is expected to be or has been settled.

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

      Conditions (CIUS): 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

      Rule: 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

      FR: Code de type de moyen de paiement — Code indiquant le mode selon lequel un paiement doit être ou a été effectué.

      Parameters:
      value - the value to set
      Returns:
      this PaymentInstructions for chaining
      Since:
      1.0.06/2.2
    • setPaymentMeansText

      public PaymentInstructions setPaymentMeansText(String value)
      Sets BT-82 Payment means text — The means, expressed as text, for how a payment is expected to be or has been settled.

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

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

      FR: Libellé du moyen de paiement — Texte indiquant le mode selon lequel un paiement doit être ou a été effectué.

      Parameters:
      value - the value to set
      Returns:
      this PaymentInstructions for chaining
      Since:
      1.0.06/2.2
    • setPaymentAccountIdentifier

      public PaymentInstructions setPaymentAccountIdentifier(String value)
      Sets BT-84 Payment account identifier — A unique identifier of the financial payment account, at a payment service provider, to which payment should be made.

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

      Rule: 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

      FR: Identifiant de compte bancaire — Identifiant unique du compte bancaire, domicilié dans un établissement financier, sur lequel il convient que soit effectué le paiement.

      Parameters:
      value - the value to set
      Returns:
      this PaymentInstructions for chaining
      Since:
      1.09.2/2.5.2
    • setProprietaryID

      public PaymentInstructions setProprietaryID(String value)
      Sets BT-84-0.

      Usage: Use IBANID when appropriate, otherwise use ProprietaryID

      Rule: Use IBANID if applicable, ProprietaryID else

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

      Parameters:
      value - the value to set
      Returns:
      this PaymentInstructions for chaining
      Since:
      1.09.2/2.5.2
    • setPaymentAccountName

      public PaymentInstructions setPaymentAccountName(String value)
      Sets 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

      FR: Nom du compte bancaire — Nom d'un compte bancaire, domicilié dans un établissement financier, sur lequel il convient que soit effectué le paiement.

      Parameters:
      value - the value to set
      Returns:
      this PaymentInstructions for chaining
      Since:
      1.0.06/2.2
    • setPaymentServiceProviderIdentifier

      public PaymentInstructions setPaymentServiceProviderIdentifier(String value)
      Sets BT-86 Payment service provider identifier — An identifier for the payment service provider where a payment account is located.

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

      Conditions (CIUS): To be used for Credit Transfer onlyCHORUS PRO: Only BIC format is allowed

      Rule: Use for credit transfer

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

      FR: Identifiant d'établissement financier — Identifiant de l'établissement financier dans lequel est domicilié un compte bancaire.

      Parameters:
      value - the value to set
      Returns:
      this PaymentInstructions for chaining
      Since:
      1.09.2/2.5.2
    • setPaymentCardPrimaryAccountNumber

      public PaymentInstructions setPaymentCardPrimaryAccountNumber(String value)
      Sets BT-87 Payment card primary account number — The Primary Account Number (PAN) of the card used for payment.

      Usage: 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 following: The first 6 digits and last 4 digits are the maximum number of digits to be shown.

      Rule: 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

      FR: Numéro de compte primaire de carte de paiement — Numéro de compte primaire (PAN) de la carte utilisée pour le paiement.

      Parameters:
      value - the value to set
      Returns:
      this PaymentInstructions for chaining
      Since:
      1.0.06/2.2
    • setPaymentCardHolderName

      public PaymentInstructions setPaymentCardHolderName(String value)
      Sets 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

      FR: Nom du titulaire de la carte de paiement — Nom du titulaire de la carte de paiement

      Parameters:
      value - the value to set
      Returns:
      this PaymentInstructions for chaining
      Since:
      1.0.06/2.2
    • setDebitedAccountIdentifier

      public PaymentInstructions setDebitedAccountIdentifier(String value)
      Sets 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

      FR: Identifiant du compte débité — Compte à débiter par prélèvement.

      Parameters:
      value - the value to set
      Returns:
      this PaymentInstructions for chaining
      Since:
      1.09.2/2.5.2
    • getDebitedAccountPaymentServiceProviderIdentifier

      public String getDebitedAccountPaymentServiceProviderIdentifier()
      Returns BT-215 Debited account payment service provider identifier — An identifier for the payment service provider where a payment account is located.Usage Note: Such as a BIC or a national clearing code where required. No Identification Scheme to be used.

      Usage: Use IBANID when appropriate, otherwise use ProprietaryID

      Rule: Use IBANID if applicable, ProprietaryID else

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

      FR: Identifiant du prestataire de services de paiement du compte débité — Identifiant du prestataire de services de paiement auprès duquel est ouvert un compte de paiement.Remarque d'utilisation : par exemple, un code BIC ou un code de compensation national, le cas échéant. Aucun schéma d'identification ne doit être utilisé.

      Returns:
      the BT-215 value
      Since:
      1.09.2/2.5.2
    • getDebitedAccountName

      public String getDebitedAccountName()
      Returns BT-216 Debited account name — The name of the payment account, at a payment service provider, from which payment should be made.

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

      FR: Nom du compte bancaire débité — Le nom du compte de paiement, auprès d'un prestataire de services de paiement, à partir duquel le paiement doit être effectué.

      Returns:
      the BT-216 value
      Since:
      1.09.2/2.5.2
    • getPaymentMeansTypeCode

      public Codes.PaymentMeansCode getPaymentMeansTypeCode()
      Returns BT-81 Payment means type code — The means, expressed as code, for how a payment is expected to be or has been settled.

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

      Conditions (CIUS): 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

      Rule: 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

      FR: Code de type de moyen de paiement — Code indiquant le mode selon lequel un paiement doit être ou a été effectué.

      Returns:
      the BT-81 value
      Since:
      1.0.06/2.2
    • getPaymentMeansText

      public String getPaymentMeansText()
      Returns BT-82 Payment means text — The means, expressed as text, for how a payment is expected to be or has been settled.

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

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

      FR: Libellé du moyen de paiement — Texte indiquant le mode selon lequel un paiement doit être ou a été effectué.

      Returns:
      the BT-82 value
      Since:
      1.0.06/2.2
    • getPaymentAccountIdentifier

      public String getPaymentAccountIdentifier()
      Returns BT-84 Payment account identifier — A unique identifier of the financial payment account, at a payment service provider, to which payment should be made.

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

      Rule: 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

      FR: Identifiant de compte bancaire — Identifiant unique du compte bancaire, domicilié dans un établissement financier, sur lequel il convient que soit effectué le paiement.

      Returns:
      the BT-84 value
      Since:
      1.09.2/2.5.2
    • getProprietaryID

      public String getProprietaryID()
      Returns BT-84-0.

      Usage: Use IBANID when appropriate, otherwise use ProprietaryID

      Rule: Use IBANID if applicable, ProprietaryID else

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

      Returns:
      the BT-84-0 value
      Since:
      1.09.2/2.5.2
    • getPaymentAccountName

      public String getPaymentAccountName()
      Returns 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

      FR: Nom du compte bancaire — Nom d'un compte bancaire, domicilié dans un établissement financier, sur lequel il convient que soit effectué le paiement.

      Returns:
      the BT-85 value
      Since:
      1.0.06/2.2
    • getPaymentServiceProviderIdentifier

      public String getPaymentServiceProviderIdentifier()
      Returns BT-86 Payment service provider identifier — An identifier for the payment service provider where a payment account is located.

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

      Conditions (CIUS): To be used for Credit Transfer onlyCHORUS PRO: Only BIC format is allowed

      Rule: Use for credit transfer

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

      FR: Identifiant d'établissement financier — Identifiant de l'établissement financier dans lequel est domicilié un compte bancaire.

      Returns:
      the BT-86 value
      Since:
      1.09.2/2.5.2
    • getPaymentCardPrimaryAccountNumber

      public String getPaymentCardPrimaryAccountNumber()
      Returns BT-87 Payment card primary account number — The Primary Account Number (PAN) of the card used for payment.

      Usage: 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 following: The first 6 digits and last 4 digits are the maximum number of digits to be shown.

      Rule: 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

      FR: Numéro de compte primaire de carte de paiement — Numéro de compte primaire (PAN) de la carte utilisée pour le paiement.

      Returns:
      the BT-87 value
      Since:
      1.0.06/2.2
    • getPaymentCardHolderName

      public String getPaymentCardHolderName()
      Returns 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

      FR: Nom du titulaire de la carte de paiement — Nom du titulaire de la carte de paiement

      Returns:
      the BT-88 value
      Since:
      1.0.06/2.2
    • getDebitedAccountIdentifier

      public String getDebitedAccountIdentifier()
      Returns 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

      FR: Identifiant du compte débité — Compte à débiter par prélèvement.

      Returns:
      the BT-91 value
      Since:
      1.09.2/2.5.2