Type = Technical Guides, Technical Tools, What's New,; Topic = Multienterprise Information Network Tower (MINT), Technical Documentation,;Persona = Solution Designer, TraceLink Administrator, User, Orchestration Architect, Solution Partner, Technology Partner,; Orchestration = Manufacturing, Logistics, Commerce, Transportation, Clinical Supply,; Function = IT, Quality, Procurement,

Remittance advice canonical guidelines

Remittance advices allow buyers to exchange data with suppliers confirming that payment has been made for one or more invoices. Communicating payment details, such as the invoice number, payment amount, and payment date, provides confirmation to suppliers that the correct payments for the correct invoices have been made, which helps to facilitate an efficient and transparent payment process for both parties.

Canonical Element Type Definition Description IDoc mapping X12 mapping EDIFACT mapping
data – JSon object type/root element. – – –
  controlFileHeader – Canonical control file header to store data for control segments and envelopes of IDocs, and X12 and EDIFACT EDI messages. – – –
  messageBody – Payload for canonical payment remittance message to be used for the Payment Order and Remittance Advice transactions. – – –
    canonicalPaymentRemittanceHeader – Payment remittance header data. – – –
      typeOfPaymentOrRemittance string

Code identifying type of payment or remittance transaction. Specifies action to be taken by all parties.

Valid values mapped:

  • REMITTANCE

  • PAYMENT

E1IDKU1/BGMTP where canonical =

  • REMITTANCE or

  • PAYMENT

BPR01 where canonical =

  • REMITTANCE or

  • PAYMENT

BGM010-010 where canonical =

  • REMITTANCE or

  • PAYMENT

      documentName string Document or message name. E1IDKU1/BGMNAME – –
      paymentRemittanceIdentifier string Reference document identifier for the remittance advice or payment order. Required value for all three formats. E1IDKU1/BGMREF (transaction reference number) TRN02 RFF010-020 where RFF010-010 = RA (remittance advice)
      documentReferenceType string Coded message type for referenced document.

E1IDKU1/BGMLEV

IDoc values:

  • ORG – Original

  • DUP – Double

  • CAN – Cancel

TRN01

-
      documentReferenceConfirmationLevel string Confirmation level for referenced document. E1IDKU1/BGMACC – –
      paymentRemittanceAmount number Total header amount in remittance advice or payment order. E1IDKU5/MOABETR where QUALF = 001 (payment in remittance) BPR02 MOA020 where MOA010 = 11 (payment) or 12 (remittance)
      currencyCode string Currency for payment or remittance. E1IDKU5/CUXWAERZ if MOABETR is present – MOA030
      isCreditFlag boolean

Credit or debit boolean.

Valid values:

  • True – Credit

  • False – Debit

 – BPR03 –
      paymentMethod string

Method of payment.

Valid values include:

  • ACH

  • CASH

  • CREDIT

  • BANKCHECK

  • CHECK

  • DIRECTDEPOSIT

  • DRAFT

  • CUSTOM

E1IDKU3/PAIART =

  • 001 (BANKCHECK) or

  • 002 (CHECK)

BPR04 =

  • ACH or

  • CAS (CASH) or

  • CCC (CREDIT) or

  • CCH (BANKCHECK) or

  • CHK (CHECK) or

  • DDP (DIRECTDEPOSIT) or

  • PBD (DRAFT) or

  • ZZZ (CUSTOM)

PAI010-030 =

  • 10 (CASH) or

  • 54 (CREDIT) or

  • 23 (BANKCHECK) or

  • 26 (CHECK) or

  • 21 (DRAFT) or

  • ZZZ (CUSTOM)
      paymentFormatCode string Payment format. Pass thru mapping for X12. – BPR05 –
      paymentDate string Payment or settlement date in date format YYYY-MM-DD. E1EDK03/DATUM where IDDAT = 017 …. If populated. BPR16 –
      epochPaymentDate integer Payment or settlement date generated in epoch integer date format. – – –
      businessFunctionCode string Pass thru mapping for X12. – BPR17 –
      transactionReferenceIdentifierList array

Transaction references for header level of remittance advice or payment order.

For Remittance Advice, REMITTANCE is required.

 segment E1EDK02 – –
        b2bTransactionIdentifierType string

Referenced document type.

Valid values:

  • CHECK

  • REMITTANCE

  • PAYMENT

  • TRANSACTIONREFERENCE

  • CREDITMEMO

  • DEBITMEMO

  • ELECTRONICPAYMENT

  • MASTERACCOUNT

  • DOCUMENT

QUALF =

  • 026 (CHECK) or

  • 029 (PAYMENT) or

  • 022 (REMITTANCE) or

  • 028 (CREDITMEMO)

REF01 =

  • CK (CHECK) or

  • EM (ELECTRONICPAYMENT) or

  • TN (TRANSACTIONREFERENCE) or

  • 14 (MASTERACCOUNT) or

  • CD (CREDITMEMO)

RFF010-010 =

  • CK (CHECK) or

  • RA (Remittance) or

  • AEK (PAYMENT) or

  • CM (CREDITMEMO) or

  • DL (DEBITMEMO) or

  • TN (TRANSACTIONREFERENCE) or

  • ASS (MASTERACCOUNT)
        b2bTransactionIdentifierValue string Identifier for transaction referenced by b2bTransactionIdentifierType. BELNR

REF02 where REF01 =

  • CK or

  • EM or

  • TN or

  • 14 or

  • CD

RFF010-020 where RFF010-010 =

  • CK or

  • RA or

  • AEK or

  • CM or

  • DL or

  • TN or

  • ASS
        transactionDate string Date transaction created. DATUM – –
        epochTransactionDate integer Date transaction created in epoch integer date format. – – –
        lineItemNumber string Line item number in customer purchase order. Line item level only. – – –
      mpcDates array Dates relevant for header level of remittance advice or payment order. segment E1EDK03 – –
        dateType string

Date type at header level for remittance advice or payment order.

Valid values:

  • PROCESSING

  • TRANSACTION

  • PAYMENT

  • DOCUMENT

  • REPORTSTART

  • CHECK

IDDAT =

  • 011 or

  • 017 or

  • 012

IDDAT 017 only if not populated by payment Date above.

DTM01 =

  • 009 or

  • 097 or

  • 814 or

  • 582 or

  • 020

DTM010-010 =

  • 9 or

  • 97 or

  • 140 or

  • 567 or

  • 20
        dateValue string Date defined by referenced date type in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time also populated. DATUM (+ UZEIT if present) DTM02 (+DTM03 if present) DTM010-020
        epochDateValue integer

Date defined by referenced date type generated in epoch integer date format.

– – –
        timeZone string Time zone for referenced dates. – – –
      mpcCurrency   Currency for payment or remittance. – – –
        currencyCode string Currency code. – CUR02 CUX010-020
        exchangeRateCurrencyCode string To currency code for exchange. – N/A N/A
        exchangeRate string Exchange rate at which the currency code will convert to the exchangeRateCurrencyCode. – CUR03 CUX010-040
        validityDate string Date that the exchange rate is valid for the currency exchange. – – –
        epochValidityDate integer

Date that the exchange rate is valid for the currency exchange generated in epoch integer date format.

– – –
        currencyEntityCode string Currency entity code pass-thru for X12. – CUR01 … hard code PR for Payer CUX010-010 hard code 2 for Reference currency
      sendingBankInformation array Sending bank info for BPR segment. Sending bank (payer) info in segment E1IDB02 – –
        bankFunctionCode string

Bank function code qualifier identifying the party function of the bank.

Valid value:

  • BANKSOLDTO

  • CORRESPONDENTSENDER

  • INTERMEDIARY

  • CORRESPONDENTRECIPIENT

FIIQUALI –

FII010 =

  • SO or

  • OX or

  • I2 or

  • OZ
        bankIdentifierType string

Depository Financial Institution identifier type.

Valid values:

  • ABA

  • SWIFT

  • CHIPS

  • CANADIANBANK

  • CUSTOM

 FIIBKCDE

BPR06 =

  • 01 or

  • 02 or

  • 03 or

  • 04 or

  • ZZ

FII030-030 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ
        bankIdentifierValue string Depository Financial Institution identifier value. FIIBKUCD

BPR07 where BPR06 =

  • 01 or

  • 02 or

  • 03 or

  • 04 or

  • ZZ

FII030-020 where FII030-030 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ
        bankNameCode string Bank name code. FIIBKENN – FII030-010
        bankName string Name of bank. FIIBKNAME – FII030-070
        bankBranchIdentifierType string Bank branch identifier type.   –

FII030-060 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ
        bankBranchIdentifier string Bank branch identifier value. FIIBKUKN – FII030-040
        bankBranchName string Name of bank branch. FIIBKORT – FII030-080
        country string Bank country. FIIBLAND – FII040
        accountHolderInformation – Account and account holder information. – – –
          accountType string Bank account type. – BPR08 –
          accountIdentifier string Bank account identifier number. FIIKONTO BPR09 FII020-010
          accountHolderName string Name of bank account holder. FIIKNAME – FII020-020
          accountHolderName2 string Name of bank account holder. FIIKNAM2 – FII020-030
          currencyCode string Default currency code for the account. FIIKWAER – FII020-040
          companyIdentifier string Company identifier for sending company. – BPR10 –
          companyIdentifierSupplementalCode string Sending company's identifier supplemental code. – BPR11 –
      receivingBankInformation array Receiving bank info for BPR segment. Receiving bank (payee) info in segment E1IDBL2 – –
        bankFunctionCode string

Bank function code qualifier identifying the party function of the bank.

Valid value:

  • BANKSOLDTO

  • CORRESPONDENTSENDER

  • INTERMEDIARY

  • CORRESPONDENTRECIPIENT

/FIIQUALI –

FII010 =

  • SO or

  • OX or

  • I2 or

  • OZ
        bankIdentifierType string

Depository Financial Institution identifier type.

Valid values:

  • ABA

  • SWIFT

  • CHIPS

  • CANADIANBANK

  • CUSTOM

 FIIBKCDE

BPR12 =

  • 01 or

  • 02 or

  • 03 or

  • 04 or

  • ZZ

FII030-030 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ
        bankIdentifierValue string Depository Financial Institution identifier value. FIIBKUCD

BPR13 where BPR06 =

  • 01 or

  • 02 or

  • 03 or

  • 04 or

  • ZZ

FII030-020 where FII030-030 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ
        bankNameCode string Bank name code. FIIBKENN – FII030-010
        bankName string Name of bank. FIIBKNAM – FII030-070
        bankBranchIdentifierType string Bank branch identifier type. N/A –

FII030-060 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ
        bankBranchIdentifier string Bank branch identifier value. FIIBKUKN – FII030-040
        bankBranchName string Name of bank branch. FIIBKORT – FII030-080
        country string Bank country. FIIBLAND – FII040
        accountHolderInformation – Account and account holder information. – – –
          accountType string Bank account type. – BPR14 –
          accountIdentifier string Bank account identifier number. FIIKONTO BPR15 FII020-010
          accountHolderName string Name of bank account holder. FIIKNAME – FII020-020
          accountHolderName2 string Name of bank account holder. FIIKNAM2 – FII020-030
          currency string Default currency code for the account. FIIKWAER – FII020-040
          companyIdentifier string Company identifier for sending company. – – –
          companyIdentifierSupplementalCode string Sending company's identifier supplemental code. – – –
      billToBusinessInformation – Bill to customer party company identifiers and address information. E1EDKA1 where PARVW = "AG" N101 = "BT" NAD010 = "BT"
        businessName string Business name for partner or location. E1EDKA1/NAME1 N102 NAD030-010
        mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
          companyIdentifierType string Company identifier type for business partner. – N103 NAD020-030
          companyIdentifierValue string Company identifier value for business partner. PARTN where companyIdentifierType = COMPANYID N104 NAD020-010
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value. LIFNR – –
        address – Party address information. – – –
          address1 string Main street address. STRAS N301 NAD050-010
          address2 string Supplemental street address. STRS2 N302 NAD050-020
          city string City. ORT01 N401 NAD060
          state string State or region code. REGIO N402 NAD070-010
          postalCode string Postal code. PSTLZ N403 NAD080
          country string Country code. LAND1 N404 NAD090
          telephone string Telephone number. – – –
          fax string Fax number. – – –
          url string Website URL. – – –
          buildingNumber string Building number. – – –
          plantNumber string Plant number. – – –
          floorNumber string Floor number in building. – – –
          lscAddressIdentifier string LSC address identifier. – – –
          village string Village name. – – –
          houseNumber string House number. – – –
          township string Township. – – –
          premisesCode string Premises code. – – –
        companyLocationContactInformation – – – - -
          contactName string Contact name. – PER02 CTA020-020
          contactTitle string Title of contact. – - -
          contactPhone string Contact phone number. – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"
          contactEmail string Contact email address. – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM"
      invoicePayerBusinessInformation – Payer party. The customer or party remitting the payment to the supplier. E1EDKA1 where PARVW = "RG" N101 = "PR" NAD010 = "PR"
        businessName string Business name for partner or location. E1EDKA1/NAME1 N102 NAD030-010
        mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
          companyIdentifierType string Company identifier type for business partner. – N103 NAD020-030
          companyIdentifierValue string Company identifier value for business partner. PARTN where companyIdentifierType = COMPANYID N104 NAD020-010
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value. LIFNR – –
        address – Party address information. – – –
          address1 string Main street address. STRAS N301 NAD050-010
          address2 string Supplemental street address. STRS2 N302 NAD050-020
          city string City. ORT01 N401 NAD060
          state string State or region code. REGIO N402 NAD070-010
          postalCode string Postal code. PSTLZ N403 NAD080
          country string Country code. LAND1 N404 NAD090
          telephone string Telephone number. – – –
          fax string Fax number. – – –
          url string Website URL. – – –
          buildingNumber string Building number. – – –
          plantNumber string Plant number. – – –
          floorNumber string Floor number in building. – – –
          lscAddressIdentifier string LSC address identifier. – – –
          village string Village name. – – –
          houseNumber string House number. – – –
          township string Township. – – –
          premisesCode string Premises code. – – –
        companyLocationContactInformation – – – - -
          contactName string Contact name. – PER02 CTA020-020
          contactTitle string Title of contact. – - -
          contactPhone string Contact phone number. – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"
          contactEmail string Contact email address. – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM"
      remitToBusinessInformation – Remit to party. The payee or beneficiary of remittance. Supplier. E1EDKA1 where PARVW = "BE" N101 = "PE" NAD010 = "PE"
        businessName string Business name for partner or location. E1EDKA1/NAME1 N102 NAD030-010
        mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
          companyIdentifierType string Company identifier type for business partner. – N103 NAD020-030
          companyIdentifierValue string Company identifier value for business partner. PARTN where companyIdentifierType = COMPANYID N104 NAD020-010
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value. LIFNR – –
        address – Party address information. – – –
          address1 string Main street address. STRAS N301 NAD050-010
          address2 string Supplemental street address. STRS2 N302 NAD050-020
          city string City. ORT01 N401 NAD060
          state string State or region code. REGIO N402 NAD070-010
          postalCode string Postal code. PSTLZ N403 NAD080
          country string Country code. LAND1 N404 NAD090
          telephone string Telephone number. – – –
          fax string Fax number. – – –
          url string Website URL. – – –
          buildingNumber string Building number. – – –
          plantNumber string Plant number. – – –
          floorNumber string Floor number in building. – – –
          lscAddressIdentifier string LSC address identifier. – – –
          village string Village name. – – –
          houseNumber string House number. – – –
          township string Township. – – –
          premisesCode string Premises code. – – –
        companyLocationContactInformation – – – – –
          contactName string Contact name. – PER02 CTA020-020
          contactTitle string Title of contact. – – –
          contactPhone string Contact phone number. – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"
          contactEmail string Contact email address. – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM"
      freeTextNote array Ship to party company identifiers and address information. – – –
        textReferenceCode string Text reference or subject code. – – –
        textFunctionCode string Text function code. – – –
        language string Language of free text. – – –
        textFormatCode string Format code for free text. – – –
        freeText string Free test string. – – –
      customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Header level. – – –
        name string Name of mapped field. – – –
        value string Value in named field. – – –
    canonicalPaymentRemittanceItemDetails array Canonical remittance or payment item details level. IDoc line item loop = E1BP2017_GM_ITEM_CREATE X12 line item loop = 0900 W19 EDIFACT line item loop = Segment Group 9 LIN
      entityAssignedIdentifier string Entity assigned identifier value. Pass thru for X12. – ENT01 –
      paymentRemittanceDetails array Payment and/or remittance details. segment E1EDPU1 Loop group 2400 ENT-RMR Loop segment group 5 DOC and MOA
        paymentRemittanceDocumentType string

Payment or remittance reference document type.

Valid values:

  • INVOICE

  • SELLERINVOICE

  • ORIGINALINVOICE

  • REMITTANCE

  • PAYMENT

  • CREDITMEMO

  • DEBITMEMO

E1IDPU1/DOCNAME =

  • INV (INVOICE) or

  • CRM (CREDITMEMO) or

  • REM (REMITTANCE) or

  • DBM (DEBITMEMO) or

  • CRE (CREDITADVICE) or

  • DEB (DEB) or

  • PAO (PAYMENT) or

  • PEX (PAYMENTEXTENDED) or

  • PMU (PAYMENTMULTIPLE) or

  • DIR (DIRECTDEBIT)

RMR01 =

  • IK (INVOICE)

  • IV (SELLERINVOICE) or

  • OI (ORIGINALINVOICE) or

  • CD (CREDITMEMO) or

  • DB (DEBITMEMO) or

  • IV (SELLERINVOICE)

DOC010-010 =

  • 380 (INVOICE) or

  • 381 (CREDITMEMO) or

  • 481 (REMITTANCE) or

  • 383 (DEBITMEMO) or

  • 454 (CREDITADVICE) or

  • 456 (DEBITADVICE) or

  • 450 (PAYMENT) or

  • 451 (PAYMENTEXTENDED) or

  • 452 (PAYMENTMULTIPLE) or

  • 214 (DIRECTDEBIT) or

  • 325 (PROFORMA)
        paymentRemittanceDocumentIdentifier string Product code identifier value E1IDPU1/DOCNUMMR RMR02 DOC020-010
        paymentActionCode string

Payment action code.

Valid values:

  • ADJUSTMENT

  • EVALUATEDRECEIPTSETTLEMENT

  • FINAL

  • PAYITEM

  • PAYMENTONACCOUNT

–

RMR03 =

  • AJ (ADJUSTMENT) or

  • ER (EVALUATEDRECEIPTSETTLEMENT) or

  • FL (FINAL) or

  • PI (PAYITEM) or

  • PO (PAYMENTONACCOUNT)

 –
        amountPaid number Total amount paid, including all debits and credits. E1IDPU5/MOABETR where MOAQUAL = 001 Pull currency for CUXWAERZ from: paymentRemittanceDetails/currencyCode. RMR04 MOA010-020 where MOA010-010 = 11 Pull currency for MOA010-030 from: paymentRemittanceDetails/currencyCode
        amountInvoiced number Total amount on invoice. E1IDPU5/MOABETR where MOAQUAL = 004 Pull currency for CUXWAERZ from: paymentRemittanceDetails/currencyCode. RMR05 MOA010-020 where MOA010-010 = 39 Pull currency for MOA010-030 from: paymentRemittanceDetails/currencyCode
        amountOfDiscount number Total amount of discount taken in payment. E1IDPU5/MOABETR where MOAQUAL = 003 Pull currency for CUXWAERZ from: paymentRemittanceDetails/currencyCode. RMR06 MOA010-020 where MOA010-010 = 13 Pull currency for MOA010-030 from: paymentRemittanceDetails/currencyCode
        currencyCode string Currency code for additional amounts. E1IDPU5/CUXWAERZ – –
        paymentRemittanceAdditionalAmounts array Payment or remittance additional amounts for IDoc segment E1EDPU5. segment E1IDPU5 – –
          paymentRemittanceAmountType string

Referenced document type.

Valid values:

  • NETAMOUNT

  • CREDITMEMO

  • TAX

  • TAXWITHHOLDING

  • DEDUCTIONS

  • TOTALDEBITS

  • TOTALCREDITS

  • OPENINGBALANCE

  • CLOSINGBALANCE

E1IDPU5/MOAQUALF =

  • 005 (TAX) or

  • 006 (NETAMOUNT) or

  • 007 (DEDUCTIONS) OR

  • 016 (CREDITMEMO) or

  • 019 (OPENINGBALANCE) OR

  • 021 (CLOSINGBALANCE) OR

  • 023 (TOTALDEBITS) OR

  • 024 (TOTALCREDITS) OR

  • 030 (TAXWITHHOLDING)

 – –
          paymentRemittanceAmountValue number Payment or remittance amount referenced by paymentRemittanceAmountType.

E1IDPU5/MOABETR where MOAQUAL =

  • 005 or

  • 006 or

  • 007 or

  • 016 or

  • 019 or

  • 021 or

  • 023 or

  • 024 or

  • 030

 – –
          currencyCode string Currency code for additional amounts. E1IDPU5/CUXWAERZ. – –
        paymentRemittanceReferenceIdentifiers array Payment or remittance references for ENT-RMR loop. segment E1EDP02. Loop group 2400 ENT-RMR-REF Loop segment group 5 REF sibling of DOC
          paymentRemittanceIdentifierType string

Referenced document type.

Valid values:

  • INVOICE

  • SELLERINVOICE

  • ORIGINALINVOICE

  • CONTRACT

  • PURCHASEORDER

  • LOT

  • STORE

  • LOCATION

  • DEPARTMENT

  • MICROFILM

  • MERCHANDISETYPE

  • CROSSREFERENCE

  • CUSTOMERREFERENCE

E1EDP02/QUALF =

  • 009 (INVOICE) or

  • 001 (PURCHASEORDER) or

  • 005 (CONTRACT) or

  • 079 (LOT)

REF01 =

  • IK (INVOICE) or

  • IV (SELLERINVOICE) or

  • OI (ORIGINALINVOICE) or

  • CT (CONTRACT) or

  • PO (PURCHASEORDER) or

  • LT (LOT) or

  • ST (STORE) or

  • LU (LOCATION) or

  • DP (DEPARTMENT) or

  • MC (MICROFILM) or

  • MR (MERCHANDISETYPE) or

  • CR (CUSTOMERREFERENCE)

RFF010-010 =

  • IV (INVOICE) or

  • OI (ORIGINALINVOICE) or

  • CT (CONTRACT) or

  • ON (PURCHASEORDER) or

  • BT (LOT) or

  • AMV (DEPARTMENT)
          paymentRemittanceIdentifierValue string Payment or remittance identifier value referenced by paymentRemittanceIdentifierType.

E1EDP02/BELNR where QUALF =

  • 009 or

  • 001 or

  • 005 or

  • 079

REF02 where REF01 =

  • IK or

  • IV or

  • OI or

  • CT or

  • PO or

  • LT or

  • ST or

  • LU or

  • DP or

  • MC or

  • MR

RFF010-020 where RFF010-010 =

  • IV or

  • OI or

  • CT or

  • ON or

  • BT or

  • AMV
        mpcDates array Reference dates for ENT-RMR loop. segment E1EDP03 Loop group 2400 ENT-RMR-DTM Loop segment group 5 DTM sibling of DOC
          dateType string

Date type at the item details level of the remittance advice or payment order remittance details.

Valid values:

  • INVOICE

  • DOCUMENT

  • PAYMENT

  • ACCOUNTSRECEIVABLE

IDDAT =

  • 016 (INVOICE) or

  • 012 (DOCUMENT) or

  • 017 (PAYMENT)

DTM01 =

  • 003 (INVOICE) or

  • 133 (ACCOUNTSRECEIVABLE) or

  • 814 (PAYMENT) or

  • 999 (DOCUMENT) or

  • 004 (PURCHASEORDER)

DTM010-010 =

  • 3 (INVOICE) or

  • 137 (DOCUMENT) or

  • 140 (PAYMENT)
          dateValue string Date defined by referenced date type in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time also populated. DATUM (+ UZEIT if present) DTM02 (+DTM03 if present) DTM010-020
          epochDateValue integer

Date defined by referenced date type in epoch integer date format.

Each string date recorded will have an epoch date format generated by a java exit.

 – – –
          timeZone string Time zone for referenced dates. – – –
        adjustmentPaymentRemittanceDetails array Adjustment details for payment or remittance. segment E1IDPU2 Loop group 2400 ENT-RMR-ADX Loop segment group 7 MOA and AJT child of loop segment group 5
          amountOfAdjustment number Adjustment amount on payment or remittance. E1IDPU2/MOABETRG ADX01 MOA020 Set MOA010 to 5 (Adjusted amount)
          currencyCode string Currency code for adjustment.

E1IDPU2/MOAWAERS

If currency Code not populated, read from: paymentRemittanceDetails/currencyCode

 –

MOA030

If currency Code not populated, read from: paymentRemittanceDetails/currencyCode
          adjustmentReasonCode string

Reason code for adjustment. Pass thru mapping.

SAP will take whatever value is mapped here from X12 or EDIFACT. We will have to map between X12 and EDIFACT.

We'll need to build a lookup table for this. But no conversion

 E1IDPU2/AJTGRUND ADX02 where … X12 codes in enumeration mapping worksheet

AJT010 where … EDIFACT codes in enumeration mapping worksheet
          adjustmentReferenceType string

Adjustment reference type.

Valid values:

  • CREDITMEMO

  • DEBITMEMO

– ADX03 = CM (CREDITMEMO) or DB (DEBITMEMO) RFF010-010 = CM (CREDITMEMO) or DL (DEBITMEMO)
          adjustmentReferenceIdentifier string Identifier value for adjustment reference. – ADX04 RFF010-020 where RFF010-010 = CM or DL
          lineItemNumber string Line item number from referenced invoice. For IDoc and EDIFACT. E1IDPU2/AJTRZEIL – AJT020
          adjustmentReferenceIdentifiers array Payment or remittance references for ENT-RMR loop. – Loop group 2400 ENT-RMR-ADX-REF Loop segment group 7 RFF child of loop segment group 5 sibling of AJT
            paymentRemittanceIdentifierType string

Referenced document type.

Valid values:

  • PURCHASEORDER

  • CREDITMEMO

  • DEBITMEMO

  • CROSSREFERENCE

 –

REF01 =

  • PO (PURCHASEORDER) or

  • CM (CREDITMEMO) or

  • DB (DEBITMEMO) or

  • 60 (CROSSREFERENCE)

RFF010-010 =

  • AAJ (DELIVERY) or

  • CT (CONTRACT) or

  • ON (PURCHASEORDER) or

  • CD (CREDITMEMO) or

  • DL (DEBITMEMO) or

  • DM (CROSSREFERENCE)
            paymentRemittanceIdentifierValue string Payment or remittance identifier value referenced by paymentRemittanceIdentifierType. –

REF02 where REF01 =

  • DO or

  • CT or

  • C7 or

  • PO or

  • CM or

  • DB or

  • 60

RFF010-020 where RFF010-010 =

  • AAJ or

  • CT or

  • ON or

  • CD or

  • DL or

  • DM
          mpcDates array Reference dates for ENT-RMR loop. – Loop group 2400 ENT-RMR-ADX-DTM Loop segment group 7 DTM child of loop segment group 5 sibling of AJT
            dateType string

Date type at the item details level of the remittance advice or payment order at the remittance level adjustment details.

Valid values:

  • INVOICE

  • DOCUMENT

  • PAYMENT

  • ACCOUNTSRECEIVABLE

 –

DTM01 =

  • 003 (INVOICE) or

  • 133 (ACCOUNTSRECEIVABLE) or

  • 814 (PAYMENT) or

  • 999 (DOCUMENT)

 DTM010-010 = 3 (INVOICE) or 137 (DOCUMENT) or 140 (PAYMENT)
            dateValue string Date defined by referenced date type in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time also populated. – DTM02 (+DTM03 if present) DTM010-020
            epochDateValue integer

Date defined by referenced date type in epoch integer date format.

Each string date recorded will have an epoch date format generated by a java exit.

 – – –
            timeZone string Time zone for referenced dates. – – –
          freeTextNote array ENT-RMR text note mapping. – Loop group 2400 ENT-RMR-ADX-NTE Loop segment group 7 FTX child of loop segment group 5 sibling of AJT
            textReferenceCode string Text reference or subject code. – NTE01 Hard code AFB (comment) to FTX010
            textFunctionCode string Text function code. – – –
            language string Language of free text. – – –
            textFormatCode string Format code for free text. – – –
            freeText string Free test string. HEADER_TXT NTE02 FTX040-010
      adjustmentDetails array

Adjustment details info group, independent of payment remittance details.

Note: When mapping to the IDoc, this group is mapped twice: once to E1IDPU5 and once to E1IDPU2.

Segments E1IDPU5 and E1IDPU2 are both used to report standalone adjustments to a payment.

The amounts reported in both segments are the same. The adjustment reason code is reported in E1IDPU2. The adjustment document identifier is reported in E1IDPU1.

Note: there could be one or more instances of both E1IDPU5 and E1IDPU2.

 Loop group 2300 ENT-ADX –
        amountOfAdjustment number Adjustment amount on payment or remittance.

E1IDPU5/MOABETR E1IDPU5/MOAQUAL = If E1IDPU1/DOCNAME = CRM, hard code "007", else

if DBM, hard code "023" (total debits). E1IDPU2/MOABETRG

 ADX01 –
        currencyCode string Currency code for adjustment. E1IDPU5/CUXWAERZ E1IDPU2/MOAWAERS If currencyCode not populated, read from: paymentRemittanceDetails/currencyCode – MOA030 If currencyCode not populated, read from: paymentRemittanceDetails/currencyCode
        adjustmentReasonCode string

Reason code for adjustment.

SAP will take whatever value is mapped here from X12 or EDIFACT. We will have to map between X12 and EDIFACT.

We'll need to build a lookup table for this. But no conversion.

 E1IDPU2/AJTGRUND ADX02 where … X12 codes in enumeration mapping worksheet –
        adjustmentReferenceType string

Adjustment reference type.

Valid values:

  • CREDITMEMO

  • DEBITMEMO

E1IDPU1/DOCNAME =

  • CRM (CREDITMEMO) or

  • DBM (DEBITMEMO)

E1IDPU2/RFFNUMQU (copy from PU1)

ADX03 =

  • CM (CREDITMEMO) or

  • DB (DEBITMEMO)

 –
        adjustmentReferenceIdentifier string Identifier value for adjustment reference. E1IDPU1/DOCNUMMR E1IDPU2/RFFNUMQU (copy from PU1) ADX04 –
        lineItemNumber string Line item number from referenced invoice. For IDoc and EDIFACT. E1IDPU2/AJTRZEIL – AJT020
        adjustmentReferenceIdentifiers array Payment or remittance references for ENT-RMR loop. Segment E1IDPU1/E1EDP02 … Adjustments only. Loop group 2300 ENT-ADX-REF –
          paymentRemittanceIdentifierType   string

Referenced document type.

Valid values:

  • CREDITMEMO

  • DEBITMEMO

  • INVOICE

  • PURCHASEORDER

  • DELIVERY

E1IDP02/QUALF =

  • 009 (INVOICE) or

  • 001 (PURCHASEORDER)

REF01 =

  • PO (PURCHASEORDER) or

  • CM (CREDITMEMO) or

  • DB (DEBITMEMO) or

  • IV (SELLERINVOICE) or

  • IK (INVOICE) or

  • 60 (CROSSREFERENCE)

 –
          paymentRemittanceIdentifierValue   string Payment or remittance identifier value referenced by paymentRemittanceIdentifierType. E1IDP02/BELNR where QUALF = 009 or 001

REF02 where REF01 =

  • PO or

  • CM or

  • DB or

  • IV or

  • 60

 –
        mpcDates array Reference dates for ENT-RMR loop. Segment E1IDPU1/E1EDP03 … Adjustments only. Loop group 2300 ENT-ADX-DTM –
          dateType   string

Date type at the item details level of the remittance advice or payment order adjustment level details.

Valid values:

  • INVOICE

  • DOCUMENT

  • PAYMENT

  • PURCHASEORDER

  • ACCOUNTSRECEIVABLE

E1IDP03/IDDAT =

  • 016 (INVOICE) or

  • 012 (DOCUMENT) or

  • 017 (PAYMENT) or

  • 022 (PURCHASEORDER)

DTM01 =

  • 003 (INVOICE) or

  • 133 (ACCOUNTSRECEIVABLE) or

  • 814 (PAYMENT) or

  • 999 (DOCUMENT)

 –
          dateValue   string Date defined by referenced date type in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time also populated.

E1IDP03/DATUM where IDDAT =

  • 016 or

  • 012 or

  • 017 or

  • 022

 DTM02 (+DTM03 if present) –
          epochDateValue   integer

Date defined by referenced date type in epoch integer date format.

Each string date recorded will have an epoch date format generated by a java exit.

 – – –
          timeZone   string Time zone for referenced dates. – – –
        freeTextNote array Ship to party company identifiers and address information. – Loop group 2300 ENT-ADX-NTE –
          textReferenceCode   string

Text reference or subject code.

– NTE01 –
          textFunctionCode   string Text function code. – – –
          language   string Language of free text. – – –
          textFormatCode   string Format code for free text. – – –
          freeText   string Free test string. – NTE02 –
      customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level. – – –
        name string Name of mapped field. – – –
        value string Value in named field. – – –
    canonicalPaymentRemittanceSummary array Summary totals of payment remittance. Segment E1IDLU5 – –
      summaryType string

Summary type for the payment remittance advice.

The valid value is TOTALAMOUNT.

 MOAQUAL if summaryType = TOTALAMOUNT. – –
      summaryValue string Summary value. MOABETR – –
      summaryValueUnit string Summary value unit of measure. CUXWAERZ – –

Tag end