Class PaymentInstructions

java.lang.Object
com.fourjs.report.facturx.profiles.basic.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-84, BT-84-0, BT-91

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.09.2/2.5.2
  • Method Details

    • 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.09.2/2.5.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
    • 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
    • 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.09.2/2.5.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
    • 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