Class PaymentTerms

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

public class PaymentTerms extends Object
BT-20-00 (PAYMENT TERMS).

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

Business terms and groups implemented
RepresentsBT-20-00
Business terms (value fields)BT-9, BT-9-0, BT-X-275, BT-X-276, BT-X-276-0, BT-X-277, BT-X-278, BT-X-279, BT-X-280, BT-X-281, BT-X-282, BT-X-282-0, BT-X-283, BT-X-284, BT-X-285, BT-X-286, BT-X-287, BT-X-504, BT-X-505, BT-X-506, BT-X-508, BT-X-508-0, BT-X-510, BT-X-510-0, BT-X-511, BT-X-518, BT-X-519, BT-X-520, BT-X-521, BT-X-522, BT-X-523, BT-X-524, BT-X-525, BT-X-526, BT-X-527, BT-X-528, BT-X-529, BT-X-530, BT-X-531, BT-20, BT-89
Business groups (object lists)BG-X-78, BT-X-507, BT-X-509-00
Since:
1.0.06/2.2
  • Method Details

    • setPaymentTerms

      public PaymentTerms setPaymentTerms(String value)
      Sets BT-20 Payment terms — A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).

      Usage: This element may contain multiple lines and multiple terms.

      Rule: BR-CO-25: In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:Description

      FR: Conditions de paiement — Description textuelle des conditions de paiement applicables au montant à payer (y compris la description des pénalités éventuelles).

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

      public PaymentTerms setMandateReferenceIdentifier(String value)
      Sets BT-89 Mandate reference identifier — Unique identifier assigned by the Payee for referencing the direct debit mandate.

      Usage: Used in order to pre-notify the Buyer of a SEPA direct debit.

      Conditions (CIUS): This is the RUM (Unique Mandate Reference) for SEPA direct debits

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:DirectDebitMandateID

      FR: Identifiant de référence de mandat — Identifiant unique attribué par le Bénéficiaire, utilisé comme référence pour le mandat de prélèvement automatique.

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

      public PaymentTerms setPaymentDueDate(LocalDate value)
      Sets BT-9 Payment due date — The date when the payment is due.

      Usage: The payment due date reflects the due date of the net payment. For partial payments it states the first net due date. The corresponding description of more complex payment terms can be stated in BT-20 Payment terms.

      Rule: BR-CO-25: In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:DueDateDateTime/udt:DateTimeString

      FR: Date d'échéance — Date à laquelle le paiement est dû.

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

      public PaymentTerms setPartialPaymentAmount(Decimal value)
      Sets BT-X-275 PartialPaymentAmount.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PartialPaymentAmount

      FR: Montant d'un paiement partiel

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

      public PaymentTerms setPaymentPenaltyDateTime(LocalDate value)
      Sets BT-X-276 Maturity Reference Date.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:BasisDateTime/udt:DateTimeString

      FR: Date de référence à laquelle le paiement est dû, valeur

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

      public PaymentTerms setDueDatePeriod(Decimal value)
      Sets BT-X-277 Due date period.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:BasisPeriodMeasure

      FR: Période d'échéance — La période d'échéance, par exemple sous forme de nombre de jours (15 jours).

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

      public PaymentTerms setMaturityPeriodUnitCode(Codes.UnitOfMeasure value)
      Sets BT-X-278 Maturity Period Unit code.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:BasisPeriodMeasure/@unitCode

      FR: Période d'échéance, unité

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

      public PaymentTerms setPaymentPenaltyBaseAmount(UnitPriceAmount value)
      Sets BT-X-279 Payment penalty base amount.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:BasisAmount

      FR: Montant d'application des pénalités

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

      public PaymentTerms setPaymentPenaltyPercentage(Percentage value)
      Sets BT-X-280 Payment penalty percentage.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:CalculationPercent

      FR: Pourcentage d'application des pénalités

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

      public PaymentTerms setPaymentPenaltyAmount(UnitPriceAmount value)
      Sets BT-X-281 Payment penalty amount.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:ActualPenaltyAmount

      FR: Montant de pénalité

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

      public PaymentTerms setPaymentDiscountDateTime(LocalDate value)
      Sets BT-X-282 DateTimeString.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:BasisDateTime/udt:DateTimeString

      FR: Date de référence à laquelle le paiement est dû, valeur

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

      public PaymentTerms setBasisPeriodMeasure(Decimal value)
      Sets BT-X-283 Basis Period Measure.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:BasisPeriodMeasure

      FR: Période d'échéance — La période d'échéance, par exemple sous forme de nombre de jours (15 jours).

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

      public PaymentTerms setUnitCode(Codes.UnitOfMeasure value)
      Sets BT-X-284 unitCode.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:BasisPeriodMeasure/@unitCode

      FR: Période d'échéance, unité

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

      public PaymentTerms setBasisAmount(Decimal value)
      Sets BT-X-285 BasisAmount.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:BasisAmount

      FR: Montant d'application de l'escompte

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

      public PaymentTerms setCalculationPercent(Decimal value)
      Sets BT-X-286 CalculationPercent.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:CalculationPercent

      FR: Pourcentage d'application de l'escompte

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

      public PaymentTerms setActualDiscountAmount(Decimal value)
      Sets BT-X-287 ActualDiscountAmount.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:ActualDiscountAmount

      FR: Montant de l'ecompte

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

      public PaymentTerms setPaymentTermsPayeeName(String value)
      Sets BT-X-504 Payee name — The name of the Payee.

      Usage: Shall be used when the Payee is different from the Seller. The Payee name may however be the same as the Seller name.

      Conditions (CIUS): If the PAYEE party bock is present, the name of the Payee is mandatory

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:Name

      FR: Nom du bénéficiaire — Nom du Bénéficiaire.

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

      public PaymentTerms setPaymentTermsPayeeLegalOrganizationTradingName(String value)
      Sets BT-X-505 Trading Business Name — A name by which the party is known, other than party name (also known as business name).

      Usage: This may be used if different from the party name.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

      FR: Nom commercial — Un nom sous lequel le partenaire commercial est connu, s'il est différent du nom du partenaire commercial (également connu sous le nom de l'entreprise).

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

      public PaymentTerms setPaymentTermsPayeeIdentifier(String value)
      Sets BT-X-506 Payee identifier Scheme identifier — An identifier for the Payee.The identification scheme identifier of the Payee identifier.

      Usage: If no scheme is specified, it should be known by Buyer and Seller, e.g. a previously exchanged Buyer or Seller assigned identifier.If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

      Rule: GloablID, if global identifier exists and can be stated in @schemeID, ID else

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:ID

      FR: Identifiant du bénéficiaire — Identification du Bénéficiaire.

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

      public PaymentTerms setPaymentTermsPayeeLegalOrganizationIdentifer(String value)
      Sets BT-X-508 Payee legal registration identifier Scheme identifier — An identifier issued by an official registrar that identifies the Payee as a legal entity or person.

      Usage: If no scheme is specified, it should be known by Buyer and Seller, e.g. the identifier that is exclusively used in the applicable legal environment.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:ID

      FR: Identifiant d’enregistrement légal du bénéficiaire — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie la contrepartie comme une entité juridique ou une personne morale.

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

      public PaymentTerms setPaymentTermsPayeeLegalOrganizationSchemeIdentiferAttribute(String value)
      Sets BT-X-508-0 Scheme identifier — The identification scheme identifier of the Payee legal registration identifier.

      Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

      Conditions (CIUS): For a SIREN or a SIRET, the value of this field is "0002"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

      FR: Schéma de l'identifiant de l'organisation légale du lieu de livraison alternatif — L'identifiant du schéma d'identification de l'identifiant d'enregistrement légal du bénéficiaire.

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

      public PaymentTerms setPaymentTermsPayeeElectronicAddress(String value)
      Sets BT-X-510 URIID.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:URIUniversalCommunication/ram:URIID

      FR: Adresse électronique

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

      public PaymentTerms setPaymentTermsPayeeElectronicAddressScheme(Codes.ElectronicAddressScheme value)
      Sets BT-X-510-0 schemeID.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

      FR: Identifiant du schéma

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

      public PaymentTerms setPaymentTermsPayeeRoleCode(String value)
      Sets BT-X-511 Payee Role Code — A code qualifying the role

      Usage: To be chosen from UNTDID 3035.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:RoleCode

      FR: Code du Role du Bénéficiaire — Code qualifiant le rôle du Bénéficiaire

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

      public PaymentTerms setPaymentTermsPayeePostCode(String value)
      Sets BT-X-518 Post code — The identifier for an addressable group of properties according to the relevant postal service.

      Usage: Such as a ZIP code or a post code.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

      FR: Code postal du bénéficiaire — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.

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

      public PaymentTerms setPaymentTermsPayeeAddressLine1(String value)
      Sets BT-X-519 Address line 1 — The main address line in an address.

      Usage: Usually the street name and number or post office box.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:LineOne

      FR: Adresse du bénéficiaire - Ligne 1 — Ligne principale d'une adresse.

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

      public PaymentTerms setPaymentTermsPayeeAddressLine2(String value)
      Sets BT-X-520 Address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:LineTwo

      FR: Adresse du bénéficiaire - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

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

      public PaymentTerms setPaymentTermsPayeeAddressLine3(String value)
      Sets BT-X-521 Address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:LineThree

      FR: Adresse du bénéficiaire - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

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

      public PaymentTerms setPaymentTermsPayeeCity(String value)
      Sets BT-X-522 City — The common name of the city, town or village.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:CityName

      FR: Localité du bénéficiaire — Nom usuel de la commune, ville ou village.

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

      public PaymentTerms setPaymentTermsPayeeCountryCode(Codes.CountryCodeList value)
      Sets BT-X-523 Country code — A code that identifies the country.

      Usage: The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:CountryID

      FR: Code de pays du bénéficiaire — Code d'identification du pays.

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

      public PaymentTerms setPaymentTermsPayeeCountrySubdivision(String value)
      Sets BT-X-524 Country subdivision — The subdivision of a country.

      Usage: Such as a region, a county, a state, a province, etc.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionName

      FR: Subdivision du pays du bénéficiaire — Subdivision d'un pays.

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

      public PaymentTerms setPaymentTermsPayeeLegalOrganizationPostCode(String value)
      Sets BT-X-525 Post code — The identifier for an addressable group of properties according to the relevant postal service.

      Usage: Such as a ZIP code or a post code.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:PostcodeCode

      FR: Code postal de l'adresse légale — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.

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

      public PaymentTerms setPaymentTermsPayeeLegalOrganizationAddressLine1(String value)
      Sets BT-X-526 Address line 1 — The main address line in an address.

      Usage: Usually the street name and number or post office box.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineOne

      FR: Adresse légale - Ligne 1 — Ligne principale d'une adresse.

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

      public PaymentTerms setPaymentTermsPayeeLegalOrganizationAddressLine2(String value)
      Sets BT-X-527 Address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineTwo

      FR: Adresse légale - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

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

      public PaymentTerms setPaymentTermsPayeeLegalOrganizationAddressLine3(String value)
      Sets BT-X-528 Address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineThree

      FR: Adresse légale - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

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

      public PaymentTerms setPaymentTermsPayeeLegalOrganizationCity(String value)
      Sets BT-X-529 City — The common name of the city, town or village.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CityName

      FR: Localité de l'adresse légale — Nom usuel de la commune, ville ou village.

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

      public PaymentTerms setPaymentTermsPayeeLegalOrganizationCountryCode(Codes.CountryCodeList value)
      Sets BT-X-530 Country code — A code that identifies the country.

      Usage: The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CountryID

      FR: Code de pays de l'adresse légale — Code d'identification du pays.

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

      public PaymentTerms setPaymentTermsPayeeLegalOrganizationCountrySubdivision(String value)
      Sets BT-X-531 Country subdivision — The subdivision of a country.

      Usage: Such as a region, a county, a state, a province, etc.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CountrySubDivisionName

      FR: Subdivision du pays de l'adresse légale — Subdivision d'un pays.

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

      public String getPaymentTerms()
      Returns BT-20 Payment terms — A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).

      Usage: This element may contain multiple lines and multiple terms.

      Rule: BR-CO-25: In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:Description

      FR: Conditions de paiement — Description textuelle des conditions de paiement applicables au montant à payer (y compris la description des pénalités éventuelles).

      Returns:
      the BT-20 value
      Since:
      1.0.06/2.2
    • getMandateReferenceIdentifier

      public String getMandateReferenceIdentifier()
      Returns BT-89 Mandate reference identifier — Unique identifier assigned by the Payee for referencing the direct debit mandate.

      Usage: Used in order to pre-notify the Buyer of a SEPA direct debit.

      Conditions (CIUS): This is the RUM (Unique Mandate Reference) for SEPA direct debits

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:DirectDebitMandateID

      FR: Identifiant de référence de mandat — Identifiant unique attribué par le Bénéficiaire, utilisé comme référence pour le mandat de prélèvement automatique.

      Returns:
      the BT-89 value
      Since:
      1.09.2/2.5.2
    • getPaymentDueDate

      public LocalDate getPaymentDueDate()
      Returns BT-9 Payment due date — The date when the payment is due.

      Usage: The payment due date reflects the due date of the net payment. For partial payments it states the first net due date. The corresponding description of more complex payment terms can be stated in BT-20 Payment terms.

      Rule: BR-CO-25: In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:DueDateDateTime/udt:DateTimeString

      FR: Date d'échéance — Date à laquelle le paiement est dû.

      Returns:
      the BT-9 value
      Since:
      1.0.06/2.2
    • getFormat

      public Codes.DateFormat getFormat() throws ComputationException
      Returns BT-9-0 Format.

      Usage: Only value "102"

      Rule: Only value "102"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:DueDateDateTime/udt:DateTimeString/@format

      FR: Date, format

      Returns:
      the BT-9-0 value
      Throws:
      ComputationException
      Since:
      1.0.06/2.2
    • getPartialPaymentAmount

      public Decimal getPartialPaymentAmount()
      Returns BT-X-275 PartialPaymentAmount.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PartialPaymentAmount

      FR: Montant d'un paiement partiel

      Returns:
      the BT-X-275 value
      Since:
      1.0.06/2.2
    • getPaymentPenaltyDateTime

      public LocalDate getPaymentPenaltyDateTime()
      Returns BT-X-276 Maturity Reference Date.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:BasisDateTime/udt:DateTimeString

      FR: Date de référence à laquelle le paiement est dû, valeur

      Returns:
      the BT-X-276 value
      Since:
      1.09.2/2.5.2
    • getDateFormat

      public Codes.DateFormat getDateFormat() throws ComputationException
      Returns BT-X-276-0 Date format.

      Usage: Only value "102"

      Rule: Only value "102"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:BasisDateTime/udt:DateTimeString/@format

      FR: Date, format

      Returns:
      the BT-X-276-0 value
      Throws:
      ComputationException
      Since:
      1.09.2/2.5.2
    • getDueDatePeriod

      public Decimal getDueDatePeriod()
      Returns BT-X-277 Due date period.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:BasisPeriodMeasure

      FR: Période d'échéance — La période d'échéance, par exemple sous forme de nombre de jours (15 jours).

      Returns:
      the BT-X-277 value
      Since:
      1.09.2/2.5.2
    • getMaturityPeriodUnitCode

      public Codes.UnitOfMeasure getMaturityPeriodUnitCode()
      Returns BT-X-278 Maturity Period Unit code.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:BasisPeriodMeasure/@unitCode

      FR: Période d'échéance, unité

      Returns:
      the BT-X-278 value
      Since:
      1.09.2/2.5.2
    • getPaymentPenaltyBaseAmount

      public UnitPriceAmount getPaymentPenaltyBaseAmount()
      Returns BT-X-279 Payment penalty base amount.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:BasisAmount

      FR: Montant d'application des pénalités

      Returns:
      the BT-X-279 value
      Since:
      1.0.06/2.2
    • getPaymentPenaltyPercentage

      public Percentage getPaymentPenaltyPercentage()
      Returns BT-X-280 Payment penalty percentage.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:CalculationPercent

      FR: Pourcentage d'application des pénalités

      Returns:
      the BT-X-280 value
      Since:
      1.0.06/2.2
    • getPaymentPenaltyAmount

      public UnitPriceAmount getPaymentPenaltyAmount()
      Returns BT-X-281 Payment penalty amount.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:ActualPenaltyAmount

      FR: Montant de pénalité

      Returns:
      the BT-X-281 value
      Since:
      1.0.06/2.2
    • getPaymentDiscountDateTime

      public LocalDate getPaymentDiscountDateTime()
      Returns BT-X-282 DateTimeString.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:BasisDateTime/udt:DateTimeString

      FR: Date de référence à laquelle le paiement est dû, valeur

      Returns:
      the BT-X-282 value
      Since:
      1.09.2/2.5.2
    • getExtendedFormat

      public Codes.DateFormat getExtendedFormat() throws ComputationException
      Returns BT-X-282-0 format.

      Usage: Only value "102"

      Rule: Only value "102"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:BasisDateTime/udt:DateTimeString/@format

      FR: Date, format

      Returns:
      the BT-X-282-0 value
      Throws:
      ComputationException
      Since:
      1.0.06/2.2
    • getBasisPeriodMeasure

      public Decimal getBasisPeriodMeasure()
      Returns BT-X-283 Basis Period Measure.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:BasisPeriodMeasure

      FR: Période d'échéance — La période d'échéance, par exemple sous forme de nombre de jours (15 jours).

      Returns:
      the BT-X-283 value
      Since:
      1.0.06/2.2
    • getUnitCode

      public Codes.UnitOfMeasure getUnitCode()
      Returns BT-X-284 unitCode.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:BasisPeriodMeasure/@unitCode

      FR: Période d'échéance, unité

      Returns:
      the BT-X-284 value
      Since:
      1.0.06/2.2
    • getBasisAmount

      public Decimal getBasisAmount()
      Returns BT-X-285 BasisAmount.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:BasisAmount

      FR: Montant d'application de l'escompte

      Returns:
      the BT-X-285 value
      Since:
      1.0.06/2.2
    • getCalculationPercent

      public Decimal getCalculationPercent()
      Returns BT-X-286 CalculationPercent.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:CalculationPercent

      FR: Pourcentage d'application de l'escompte

      Returns:
      the BT-X-286 value
      Since:
      1.0.06/2.2
    • getActualDiscountAmount

      public Decimal getActualDiscountAmount()
      Returns BT-X-287 ActualDiscountAmount.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:ActualDiscountAmount

      FR: Montant de l'ecompte

      Returns:
      the BT-X-287 value
      Since:
      1.0.06/2.2
    • getPaymentTermsPayeeName

      public String getPaymentTermsPayeeName()
      Returns BT-X-504 Payee name — The name of the Payee.

      Usage: Shall be used when the Payee is different from the Seller. The Payee name may however be the same as the Seller name.

      Conditions (CIUS): If the PAYEE party bock is present, the name of the Payee is mandatory

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:Name

      FR: Nom du bénéficiaire — Nom du Bénéficiaire.

      Returns:
      the BT-X-504 value
      Since:
      1.0.06/2.2
    • getPaymentTermsPayeeLegalOrganizationTradingName

      public String getPaymentTermsPayeeLegalOrganizationTradingName()
      Returns BT-X-505 Trading Business Name — A name by which the party is known, other than party name (also known as business name).

      Usage: This may be used if different from the party name.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

      FR: Nom commercial — Un nom sous lequel le partenaire commercial est connu, s'il est différent du nom du partenaire commercial (également connu sous le nom de l'entreprise).

      Returns:
      the BT-X-505 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeIdentifier

      public String getPaymentTermsPayeeIdentifier()
      Returns BT-X-506 Payee identifier Scheme identifier — An identifier for the Payee.The identification scheme identifier of the Payee identifier.

      Usage: If no scheme is specified, it should be known by Buyer and Seller, e.g. a previously exchanged Buyer or Seller assigned identifier.If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

      Rule: GloablID, if global identifier exists and can be stated in @schemeID, ID else

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:ID

      FR: Identifiant du bénéficiaire — Identification du Bénéficiaire.

      Returns:
      the BT-X-506 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeLegalOrganizationIdentifer

      public String getPaymentTermsPayeeLegalOrganizationIdentifer()
      Returns BT-X-508 Payee legal registration identifier Scheme identifier — An identifier issued by an official registrar that identifies the Payee as a legal entity or person.

      Usage: If no scheme is specified, it should be known by Buyer and Seller, e.g. the identifier that is exclusively used in the applicable legal environment.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:ID

      FR: Identifiant d’enregistrement légal du bénéficiaire — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie la contrepartie comme une entité juridique ou une personne morale.

      Returns:
      the BT-X-508 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeLegalOrganizationSchemeIdentiferAttribute

      public String getPaymentTermsPayeeLegalOrganizationSchemeIdentiferAttribute()
      Returns BT-X-508-0 Scheme identifier — The identification scheme identifier of the Payee legal registration identifier.

      Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

      Conditions (CIUS): For a SIREN or a SIRET, the value of this field is "0002"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

      FR: Schéma de l'identifiant de l'organisation légale du lieu de livraison alternatif — L'identifiant du schéma d'identification de l'identifiant d'enregistrement légal du bénéficiaire.

      Returns:
      the BT-X-508-0 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeElectronicAddress

      public String getPaymentTermsPayeeElectronicAddress()
      Returns BT-X-510 URIID.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:URIUniversalCommunication/ram:URIID

      FR: Adresse électronique

      Returns:
      the BT-X-510 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeElectronicAddressScheme

      public Codes.ElectronicAddressScheme getPaymentTermsPayeeElectronicAddressScheme()
      Returns BT-X-510-0 schemeID.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

      FR: Identifiant du schéma

      Returns:
      the BT-X-510-0 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeRoleCode

      public String getPaymentTermsPayeeRoleCode()
      Returns BT-X-511 Payee Role Code — A code qualifying the role

      Usage: To be chosen from UNTDID 3035.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:RoleCode

      FR: Code du Role du Bénéficiaire — Code qualifiant le rôle du Bénéficiaire

      Returns:
      the BT-X-511 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeePostCode

      public String getPaymentTermsPayeePostCode()
      Returns BT-X-518 Post code — The identifier for an addressable group of properties according to the relevant postal service.

      Usage: Such as a ZIP code or a post code.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

      FR: Code postal du bénéficiaire — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.

      Returns:
      the BT-X-518 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeAddressLine1

      public String getPaymentTermsPayeeAddressLine1()
      Returns BT-X-519 Address line 1 — The main address line in an address.

      Usage: Usually the street name and number or post office box.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:LineOne

      FR: Adresse du bénéficiaire - Ligne 1 — Ligne principale d'une adresse.

      Returns:
      the BT-X-519 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeAddressLine2

      public String getPaymentTermsPayeeAddressLine2()
      Returns BT-X-520 Address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:LineTwo

      FR: Adresse du bénéficiaire - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Returns:
      the BT-X-520 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeAddressLine3

      public String getPaymentTermsPayeeAddressLine3()
      Returns BT-X-521 Address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:LineThree

      FR: Adresse du bénéficiaire - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Returns:
      the BT-X-521 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeCity

      public String getPaymentTermsPayeeCity()
      Returns BT-X-522 City — The common name of the city, town or village.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:CityName

      FR: Localité du bénéficiaire — Nom usuel de la commune, ville ou village.

      Returns:
      the BT-X-522 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeCountryCode

      public Codes.CountryCodeList getPaymentTermsPayeeCountryCode()
      Returns BT-X-523 Country code — A code that identifies the country.

      Usage: The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:CountryID

      FR: Code de pays du bénéficiaire — Code d'identification du pays.

      Returns:
      the BT-X-523 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeCountrySubdivision

      public String getPaymentTermsPayeeCountrySubdivision()
      Returns BT-X-524 Country subdivision — The subdivision of a country.

      Usage: Such as a region, a county, a state, a province, etc.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionName

      FR: Subdivision du pays du bénéficiaire — Subdivision d'un pays.

      Returns:
      the BT-X-524 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeLegalOrganizationPostCode

      public String getPaymentTermsPayeeLegalOrganizationPostCode()
      Returns BT-X-525 Post code — The identifier for an addressable group of properties according to the relevant postal service.

      Usage: Such as a ZIP code or a post code.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:PostcodeCode

      FR: Code postal de l'adresse légale — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.

      Returns:
      the BT-X-525 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeLegalOrganizationAddressLine1

      public String getPaymentTermsPayeeLegalOrganizationAddressLine1()
      Returns BT-X-526 Address line 1 — The main address line in an address.

      Usage: Usually the street name and number or post office box.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineOne

      FR: Adresse légale - Ligne 1 — Ligne principale d'une adresse.

      Returns:
      the BT-X-526 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeLegalOrganizationAddressLine2

      public String getPaymentTermsPayeeLegalOrganizationAddressLine2()
      Returns BT-X-527 Address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineTwo

      FR: Adresse légale - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Returns:
      the BT-X-527 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeLegalOrganizationAddressLine3

      public String getPaymentTermsPayeeLegalOrganizationAddressLine3()
      Returns BT-X-528 Address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineThree

      FR: Adresse légale - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Returns:
      the BT-X-528 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeLegalOrganizationCity

      public String getPaymentTermsPayeeLegalOrganizationCity()
      Returns BT-X-529 City — The common name of the city, town or village.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CityName

      FR: Localité de l'adresse légale — Nom usuel de la commune, ville ou village.

      Returns:
      the BT-X-529 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeLegalOrganizationCountryCode

      public Codes.CountryCodeList getPaymentTermsPayeeLegalOrganizationCountryCode()
      Returns BT-X-530 Country code — A code that identifies the country.

      Usage: The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CountryID

      FR: Code de pays de l'adresse légale — Code d'identification du pays.

      Returns:
      the BT-X-530 value
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeLegalOrganizationCountrySubdivision

      public String getPaymentTermsPayeeLegalOrganizationCountrySubdivision()
      Returns BT-X-531 Country subdivision — The subdivision of a country.

      Usage: Such as a region, a county, a state, a province, etc.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CountrySubDivisionName

      FR: Subdivision du pays de l'adresse légale — Subdivision d'un pays.

      Returns:
      the BT-X-531 value
      Since:
      1.09.2/2.5.2
    • appendNewPaymentTermsPayeeIdentifierSchemeIdentifier

      public PaymentTermsPayeeIdentifierSchemeIdentifier appendNewPaymentTermsPayeeIdentifierSchemeIdentifier(String paymentTermsPayeeIdentifierIdentificationSchemeIdentifier, String paymentTermsPayeeIdentifierSchemeIdentifier)
      Creates, appends and returns a new PaymentTermsPayeeIdentifierSchemeIdentifier (BT-X-507 Payee scheme identifier).
      Parameters:
      paymentTermsPayeeIdentifierIdentificationSchemeIdentifier - BT-X-507-0 Scheme identifier — Identifiant du schéma de l'identifiant du bénéficiaire

      Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

      FR: Identifiant du schéma — Identifiant du schéma de l'identifiant du bénéficiaire

      paymentTermsPayeeIdentifierSchemeIdentifier - BT-X-507 Payee scheme identifier

      Usage: GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

      Rule: GloablID, if global identifier exists and can be stated in @schemeID, ID else

      FR: Identifiant du bénéficiaire

      Returns:
      the new PaymentTermsPayeeIdentifierSchemeIdentifier
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayeeIdentifierSchemeIdentifiers

      public List<PaymentTermsPayeeIdentifierSchemeIdentifier> getPaymentTermsPayeeIdentifierSchemeIdentifiers()
    • appendNewPaymentTermsPayee

      public PaymentTermsPayee appendNewPaymentTermsPayee()
      Creates, appends and returns a new PaymentTermsPayee (BG-X-78 Payee CONTACT).
      Returns:
      the new PaymentTermsPayee
      Since:
      1.09.2/2.5.2
    • getPaymentTermsPayees

      public List<PaymentTermsPayee> getPaymentTermsPayees()
    • appendNewPayeeVATID

      public PayeeVATID appendNewPayeeVATID(Codes.SchemeIdentifierAttribute paymentTermsPayeeVATIdentifierSchemeIdentifier, String paymentTermsPayeeVATIdentifier)
      Creates, appends and returns a new PayeeVATID (BT-X-509-00 Payee VAT ID).
      Parameters:
      paymentTermsPayeeVATIdentifierSchemeIdentifier - BT-X-509-0 Tax Scheme identifier

      Usage: Value = VA

      Rule: @schemeID="VA"

      FR: Type d'identifiant fiscal

      paymentTermsPayeeVATIdentifier - BT-X-509 VAT ID

      FR: Identifiant fiscal (local)Identifiant à la TVA

      Returns:
      the new PayeeVATID
      Since:
      1.09.2/2.5.2
    • getPayeeVATIDs

      public List<PayeeVATID> getPayeeVATIDs()