Tracelink University

Table of contents

Credit and debit adjustments are bi-directional transactions that allows buyers and sellers to ensure the accuracy of financial records and reconcile discrepancies between invoices, payments, and inventory.

Canonical Element Type Definition Description IDoc mapping X12 mapping EDIFACT Credit mapping EDIFACT Debit mapping
Canonical Element   - 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. - - - -
  canonicalCreditDebitAdjustmentHeader - Header data for credit or debit adjustment . Credit/Debit memos in SAP used to change the amount already invoiced to a customer, without changing the invoice. - - -
    creditDebitAdjustmentIdentifier string Reference document identifier for the credit or debit adjustment transaction. Required value for all three formats. E1IDKU1/BGMREF (transaction reference number) E1EDK02/BELNR set QUALF to 011 (referenced document) where b2bTransactionIdentifierType = CREDITDEBITADJUSTMENT BCD02 where b2bTransactionIdentifierType = CREDITDEBITADJUSTMENT BGM020-010 where b2bTransactionIdentifierType = CREDITDEBITADJUSTMENT BGM020-010 where b2bTransactionIdentifierType = CREDITDEBITADJUSTMENT
    dateOfAdjustment string Date of credit or debit adjustment in string date format YYYY-MM-DD. E1EDK02/DATUM where QUALF = 011 BCD01 DTM020 set DMT010 to 137 - doc issue date DTM020 set DMT010 to 137 - doc issue date
    epochDateOfAdjustment integer Date of credit or debit adjustment in epoch integer date format. - - - -
    CONSTANT[CREDITDEBITADJUSTMENT] - Hard coded transaction identifier type for screen, search, to. Hard code CREDITDEBITADJUSTMENT to b2bTransactionIdentifierType Hard code CREDITDEBITADJUSTMENT to b2bTransactionIdentifierType Hard code CREDITDEBITADJUSTMENT to b2bTransactionIdentifierType Hard code CREDITDEBITADJUSTMENT to b2bTransactionIdentifierType
    processingFunctionTypeCode string

Processing function type code.

Valid values:

  • ORIGINAL

  • CANCEL

  • DUPLICATE

E1IDKU1/BGMLEV

IDoc values:

  • ORG - Original

  • DUP - Double

  • CAN - Cancel

BCD11

X12 values that match IDoc:

  • 00 - Original

  • 01 - Cancel

  • 07 - Duplicate

BGM030

EDIFACT values that match IDoc:

  • 1 - Cancellation

  • 7 - Duplicate

  • 9 - Original

BGM030

EDIFACT values that match IDoc:

  • 1 - Cancellation

  • 7 - Duplicate

  • 9 - Original

    creditDebitAmount number Net amount of the credit or debit at the header level. Credit amount is a negative value, debit amount is positive.

E1IDKU5/MOABETR where QUALF =

  • 023 (total debits) or

  • 024 (total credits)

BCD04

If isCreditFlag = true, amount is negative, else amount is posiive

MOA020 where MOA010 =

  • 210 (credit note amt) or

  • 211 (debit note amt)

MOA020 where MOA010 =

  • 210 (credit note amt) or

  • 211 (debit note amt)

    currencyCode string Currency for payment or remittance. E1IDKU5/CUXWAERZ if MOABETR is present - MOA030 MOA030
    isCreditFlag boolean

Credit or debit boolean.

Valid values:

  • true - credit

  • false - debit

E1IDKU1/BGMTP

  • If isCreditFlag - true, hard code CRM.

  • If isCreditDebit - false, hard code DBM

BCD05

  • If source - true, hard C.

  • If source - false or is missing, hard code D

BGM010-040 where BGM010-010 =

  • 381 (credit note) or

  • 383 (debit note)

BGM010-040 where BGM010-010 =

  • 381 (credit note) or

  • 383 (debit note)

    creditDebitHandlingCode string

Code identifying action to be taken by all parties, concerning the credit or debit recorded in the message.

  • A - OFFINVOICE
  • B - DEBITCREDIT
  • C - PAYMENTREMITTANCE
  • D - PAYMENT
  • E - REMITTANCEDEBITCREDIT
  • H - NOTIFICATION
  • I - REMITTANCE
  • J - PAYMENTREQUESTED
  • K - REIMBURSEMENT
  • L - APPLYONACCOUNT
  • M - ADDITIONALDETAIL
  • N - CHECKISSUE
  • O - DEDUCTFROMNEXT
  • P - PRENOTIFICATION
  • Q - CREDITDUE
  • R - RECURRINGDEBIT
  • S - SINGLEDEBIT
  • T - ADJUSTMENTREQUESTED
  • U - SPLIT
  • Z - CUSTOM
E1IDT01/TXT01 Must be present IB. Not mapped OB. BCD03 where transactionHandlingCode in enum worksheet mapping table. FTX030010 BCD header level. Must be present IB. Not mapped OB. FTX030010 BGM header level. Must be present IB. Not mapped OB.
    documentName string Document or message name. E1IDKU1/BGMNAME -

BGM010-040 where BGM010-010 =

  • 381 (credit note) or

  • 383 (debit note)

BGM010-040 where BGM010-010 =

  • 381 (credit note) or

  • 383 (debit note)

    documentReferenceConfirmationLevel string Identifies if confirmation is required for referenced document.

E1IDKU1/BGMACC

001 = No confirmation required

Else not populated

-

BGMG040

NA = No confirmation required Else do not map

BGMG040

NA = No confirmation required Else do not map

    documentTypeCode string

Code specifying the type of transaction document supporting the message.

Valid values:

  • 6S - SUPPLEMENTAL

  • 74 - AMENDMENT

  • CG - CONSOLIDATEDCREDITMEMO

  • DO - DROPSHIPINVOICE

  • 33 - NORMAL

  • DR - DEBITMEMO

  • CR - CREDITMEMO

  • CA - CASH

  • PP - PREPAIDINVOICE

- BCD12 where documentTypeCode = any one of the enum options. - -
    transactionReferenceIdentifierList(1) array Transaction references for mapping to BCD elements for invoice, PO and supplier sales order. segment E1EDK02 segment BCD segment group 1 RFF segment group 1 RFF
      b2bTransactionIdentifierType string

Referenced document type.

Valid values:

  • BATCH

  • CHECK

  • CONTRACT

  • CREDITDEBITADJUSTMENT

  • CREDITADVICE

  • CREDITMEMO

  • DEBITADVICE

  • DEBITMEMO

  • INVOICE

  • PAYMENT

  • PURCHASEORDER

  • REMITTANCEADVICE

  • RETURNAUTHORIZATION

  • SUPPLIERORDER

  • THIRDPARTYREFERENCE

QUALF =

  • 001 (PURCHASEORDER) or

  • 002 (SUPPLIERORDER) or

  • 009 (INVOICE) or

  • 026 (CHECK) or

  • 011 (CREDITDEBITADJUSTMENT) or

  • 029 (PAYMENT)

BCD13 =

  • CK (CHECK) or

  • BT (BATCH)

  • CREDITDEBITADJUSTMENT mapped to BCD02 and to transactionReferenceIdentifierList

RFF010-010 =

  • OR (PURCHASEORDER) or

  • CK (CHECK) or

  • IV (INVOICE) VN (SUPPLIERORDER) or

  • CM (CREDITDEBITADJUSTMENT)

RFF010-010 =

  • OR (PURCHASEORDER) or

  • CK (CHECK) or

  • IV (INVOICE) VN (SUPPLIERORDER) or

  • DM (CREDITDEBITADJUSTMENT)

      b2bTransactionIdentifierValue string Identifier for transaction referenced by b2bTransactionIdentifierType. BELNR

  • BCD07 - INVOICE

  • BCD08 - SUPPLIERORDER

  • BCD10 - PURCHASEORDER

  • BCD14 - CHECK

RFF010-020 RFF010-020
      transactionDate string Date transaction created in string date format YYYY-MM-DD. DATUM

  • BCD06 - Invoice date

  • BCD09 - PO date

- -
      epochTransactionDate integer Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. - - - -
      lineItemNumber string Line item number in customer purchase order. Line item level only. - - - -
    transactionReferenceIdentifierList(2) array Transaction references for mapping to N9 reference segment elements for other document types. segment E1EDK02 segment N9 segment group 1 RFF segment group 1 RFF
      b2bTransactionIdentifierType string

Referenced document type.

Valid values:

  • BATCH

  • CHECK

  • CONTRACT

  • CREDITDEBITADJUSTMENT

  • CREDITADVICE

  • CREDITMEMO

  • DEBITADVICE

  • DEBITMEMO

  • INVOICE

  • PAYMENT

  • PURCHASEORDER

  • REMITTANCEADVICE

  • RETURNAUTHORIZATION

  • SUPPLIERORDER

  • THIRDPARTYREFERENCE

  • QUALF =

  • 079 (BATCH) or

  • 005 (CONTRACT)

  • 028 (CREDITMEMO) or

  • 033 (THIRDPARTYREFERENCE) or

  • RA (RETURNAUTHORIZATION)

N901 =

  • BT (BATCH) or

  • CM (CREDITMEMO) or

  • DL (DEBITMEMO) GK (THIRDPARTYREFERENCE) or

  • RZ (RETURNAUTHORIZATION) or

  • CT (CONTRACT)

RFF010-010 =

  • BT (BATCH) or

  • CM (CREDITMEMO) or

  • DL (DEBITMEMO)

  • ANK (THIRDPARTYREFERENCE) or

  • ALQ (RETURNAUTHORIZATION) or

  • CT (CONTRACT)

RFF010-010 =

  • BT (BATCH) or

  • CM (CREDITMEMO) or

  • DL (DEBITMEMO)

  • ANK (THIRDPARTYREFERENCE) or

  • ALQ (RETURNAUTHORIZATION) or

  • CT (CONTRACT)

      b2bTransactionIdentifierValue string Identifier for transaction referenced by b2bTransactionIdentifierType. BELNR N102 RFF010-020 RFF010-020
      transactionDate string Date transaction created in string date format YYYY-MM-DD. DATUM - - -
      epochTransactionDate integer Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. - - - -
      lineItemNumber string Line item number in customer purchase order. Line item level only. - - - -
    mpcDates array Dates relevant for header level of credit or debit adjustment. segment E1EDK03 segment DTM segment DTM segment DTM
      dateType string

Date type at header level relevant for credit debit adjustment.

Valid values:

  • PROCESSING

  • PROMOTIONSTART

  • PROMOTIONEND

  • PROMOTIONORDERSTART

  • PROMOTIONORDEREND

  • EXPIRATION

  • PROMOTIONSHIPSTART

  • PROMOTIONSHIPEND

  • SHIPPED

IDDAT =

  • 010 (SHIPPED)

  • 011 (PROCESSING) or

  • 045 (EXPIRATION)

DTM01 =

  • 009 (PROCESSING) or

  • 011 (SHIPPED) or

  • 015 (PROMOTIONSTART) or

  • 016 (PROMOTIONEND) or

  • 023 (PROMOTIONORDERSTART) or 024 (PROMOTIONORDEREND) or

  • 025 (PROMOTIONSHIPSTART) or

  • 026 (PROMOTIONSHIPEND) or

  • 036 (EXPIRATION)

DTM010-010 =

  • 9 (PROCESSING) or

  • 11 (SHIPPED) or

  • 15 (PROMOTIONSTART) or

  • 16 (PROMOTIONEND) or

  • 36 (EXPIRATION)

DTM010-010 =

  • 9 (PROCESSING) or

  • 11 (SHIPPED) or

  • 15 (PROMOTIONSTART) or

  • 16 (PROMOTIONEND) or

  • 36 (EXPIRATION)

      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 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. - - - -
    mpcCurrency - Currency for payment or remittance. - - - -
      currencyCode string Currency code. - - - -
      exchangeRateCurrencyCode string To currency code for exchange. - - - -
      exchangeRate string Exchange rate at which the currency code will convert to the exchangeRateCurrencyCode. - - - -
      validityDate string Date that the exchange rate is valid for the currency exchange in date format YYYY-MM-DD. - - - -
      epochValidityDate integer Validity date for exchange rate in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. - - - -
      currencyEntityCode string Currency entity code pass-thru for X12. - - - -
    termsOfPayment array Terms of payment looping group. - segment ITD - -
      termsOfPaymentTypeCode string

Code identifying type of payment terms.

Valid values:

  • BASIC

  • ENDOFMONTH

  • FIXEDDATE

  • DEFERRED

  • DISCOUNTNOTAPPLICABLE

  • MIXED

  • EXTENDED

  • BASICDISCOUNT

  • PROXIMO

-

ITD01 =

  • 01 (BASIC) or

  • 02 (ENDOFMONTH) or

  • 03 (FIXEDDATE) or

  • 04 (DEFERRED) or

  • 05 (DISCOUNTNOTAPPLICABLE) or

  • 07 (EXTENDED) or

  • 08 (BASICDISCOUNT) or

  • 09 (PROXIMO)

- -
      termsOfPaymentKey string Terms of payment. - - - -
      termsOfPaymentDateBasis string

Code identifying the beginning of the terms period.

Valid values:

  • SHIPDATE

  • DELIVERYDATE

  • INVOICEDATE

  • INVOICERECEIPTDATE

  • EFFECTIVEDATE

  • PURCHASEORDERDATE

-

ITD02 =

  • 1 (SHIPDATE) or

  • 2 (DELIVERYDATE) or

  • 3 (INVOICEDATE) or

  • 5 (INVOICERECEIPTDATE)

- -
      numberOfDays string Terms of payment: number of days until total invoice amount is due (discount not applicable). - ITD07 - -
      discountDueNumberOfDays number Terms Discount Days Due. Number of days in the terms discount period by which payment is due if terms discount is earned. - ITD05 - -
      termsOfPaymentPercent string Terms of payment: percentage. - ITD03 - -
      invoicePayablePercent string Percentage of invoice payable. - ITD11 - -
      discountDueDate string Discount due date in string date format YYYY-MM-DD. - ITD04 - -
      epochDiscountDueDate integer Discount due date in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. - - - -
      paymentDueDate string Date when total invoice amount becomes due in string date format YYYY-MM-DD. - ITD06 - -
      epochPaymentDueDate integer Payment due date in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. - - - -
      paymentDeferredToDate string Terms of payment deferred due date. Date deferred payment or percent of invoice payable is due. - ITD09 - -
      paymentDeferredDueAmount string Deferred amount due for payment. - ITD10 - -
      epochPaymentDeferredToDate integer Bank name code. - - - -
      description string Name of bank. - ITD12 - -
      totalTermDiscountAmount number Terms of payment discount amount. Total amount of terms discount. - ITD08 - -
      dayOfMonth integer The numeric value of the day of the month between 1 and the maximum day of the month being referenced. - ITD13 - -
    creditsAndCharges array Credits and charges on invoice including invoice total, discounts, allowances, promotions, services, and others. segment E1IDKU5 segment SAC segment group 2 MOA segment group 3 MOA
      creditChargeKeyType string

Key identifies credit or charges as discounts or additional charges.

Valid values:

  • ALLOWANCE - Amt in SAC05 added for credit, subtracted for debit

  • CHARGE - Amt in SAC05 subtracted for credit, added for debit

  • NONE - Amt in SAC05 added for credit, subtracted for debit

-

SAC01 =

  • A (ALLOWANCE) or

  • C (CHARGE) or

  • N (NONE)

- -
      creditChargeType string

Code representing type of credit or charge.

Valid values:

  • ADJUSTMENT

  • ADMINISTRATIVE

  • ADVANCE

  • ADVANCEALLOWANCE

  • ADVANCEFEE

  • ADVERTISINGALLOWANCE

  • AIRTRANSPORT

  • ASSEMBLY

  • BASE

  • BOLCHARGE

  • CANCELLATION

  • CARRIER

  • CARRIERCREDIT

  • CARRIERDEBIT

  • CARTAGE

  • DELIVERY

  • DELIVERYSURCHARGE

  • DEPOSIT

  • DESTINATIONCHARGE

  • DISCOUNT

  • DISTRIBUTION

  • DISTRIBUTORDISCOUNT

  • DIVERSION

  • DOCUMENTATION

  • EXCESSWEIGHT

  • FINANCE

  • FLATRATE

  • MAXIMUMCHARGE

  • MINIMUMCHARGE

  • NONPERFORMANCEALLOWANCE

  • PROMOTIONALALLOWANCE

  • PROMOTIONALDISCOUNT

  • SPECIALALLOWANCE

  • UNSALEABLEGOODS

  • FREIGHT

  • HANDLING

  • ADDITIONTOINVOICE

  • PERITEM

  • RENTAL

  • SALESTAX

  • TRANSPORTATIONALLOWANCE

  • RETURNSALLOWANCE

  • TAX

  • FREIGHTCHARGESTODESTINATION

  • SPECIALBUY

  • SPECIALHANDLING

  • FEDERALEXCISETAX

  • TOTALFEES

  • CREDIT

E1IDPU5/MOAQUAL =

  • 018 (ADJUSTMENT) or

  • 003 (DISCOUNT) or

  • 005 (SALESTAX) or

  • 024 (CREDIT)

  • if isCreditFlag = true, amount is credit, hard code 024 (total credits)

  • if isCreditFlag = false, hard code 023 (total debits)

SAC02 =

  • A170 (ADJUSTMENT) or

  • D500 (HANDLING) or

  • F240 (PERITEM) or

  • C310 (DISCOUNT) or

  • D240 (FREIGHT) or

  • E063 (ADDITIONTOINVOICE) or

  • G330 (RENTAL) or

  • H740 (SALESTAX)

Use call out table CL_CreditChargeType

MOA010-010 =

  • 5 (ADJUSTMENT) or

  • 21 (DISCOUNT) or

  • 64 (FREIGHT) or

  • 120 (SALESTAX) or

  • 136 (ADDITIONTOINVOICE)

  • 146 (PERITEM) or

  • 505 (RENTAL)

MOA010-010 =

  • 5 (ADJUSTMENT) or

  • 21 (DISCOUNT) or

  • 64 (FREIGHT) or

  • 120 (SALESTAX) or

  • 136 (ADDITIONTOINVOICE)

  • 146 (PERITEM) or

  • 505 (RENTAL)

      creditChargeAmount string Total amount for the service, promotion, allowance, or charge. MOABETR SAC05 MOA010-020 MOA010-020
      creditChargeCurrencyCode string Currency code for credit or charge. CUXWAERZ - MOA010-030 MOA010-030
      qualifyingAmount string Amount qualifying for cash discount, allowance, promotion, service or charge. - - - -
      creditChargePercentRate string Percentage rate for cash discount, allowance, promotion, service or charge. - - - -
      percentRateBasisTypeCode string

Code indicating basis that allowance or charge percent is calculated.

  • BASEPRICE

  • BASEPRICELESSDISCOUNT

  • BASEUNITPRICE

  • DISCOUNTGROSS

  • DISCOUNTNET

  • GROSS

  • ITEMLIST

  • ITEMNET

  • ITEMTOTAL

  • ITEMUNIT

  • LATEPAYMENT

  • NETMONTHLYPASTDUE

  • TOTAL

- - - -
      creditChargeHandlingCode string

Method of handling for discount or charge.

Valid values:

  • ADVANCE

  • BILLBACK

  • CALCULATE

  • CANCELALLOWANCE

  • COLLECT

  • CREDITCUSTOMER

  • CUSTOMERPAID

  • GROSSINVOICED

  • INFORMATION

  • OFFINVOICE

  • OPTIONAL

  • PREPAID

  • RESELLERALLOWANCE

  • TAXNONPAYABLE

  • VENDORALLOWANCE

  • VENDORDENIED

  • VENDORPAID

- SAC12 - -
      description string Description of credit or charge. - SAC15 - -
      unitPriceAmount string Unit price amount. - SAC08 - -
      unitPriceBasisQuantity string Quantity basis for the unit price. - - - -
      itemQuantity string Item quantity. - SAC10 - -
      unitOfMeasure string

Unit or Basis for Measurement Code. Quantity UOM's:

  • 02 – Statute Mile
  • 4G – Microliter
  • AM – Ampoule
  • AV – Capsule
  • BD – Bundle
  • BG – Bag
  • BO – Bottle
  • BX – Box
  • C3 – Centiliter
  • CA – Case
  • CC – Cubic Centimeter
  • CF – Cubic Feet
  • CG – Card, Blister
  • CI – Cubic Inches
  • CL – Cylinder
  • CM – Centimeter
  • CN – Can
  • CP – Crate
  • CQ – Cartridge
  • CR – Cubic Meters
  • CT – Carton
  • DA – Day
  • DI – Dispenser
  • DK – Kilometers
  • DL – Deciliter
  • DM – Decimeter
  • DR – Drum
  • DS – Display
  • DZ – Dozen
  • EA – Each
  • FO – Fluid Ounce
  • FT – Foot
  • GA – Gallon
  • GL – Gram/liter
  • GR – Gram
  • GS – Gross
  • H4 – Hectoliter
  • HF – Hundred Feet
  • HR – Hours
  • IN – Inch
  • K6 – Kiloliters
  • KG – Kilogram
  • KT – Kit
  • LB – Pounds
  • LF – Linear Foot
  • LO – Lot (unit of procurement)
  • LT – Liter
  • LY – Linear Yard
  • MC – Microgram
  • ME – Milligram
  • ML – Milliliter
  • MM – Millimeter
  • MO – Months
  • MR – Meter
  • OZ – Ounces
  • PC – Piece
  • PF – Pallet
  • PK – Package
  • PR – Pair
  • PT – Pint
  • QT – Quart
  • RL – Roll
  • SC – Square Centimeter
  • SF – Square Foot
  • SH – Sheet
  • SI – Square Inch
  • SM – Square Meter
  • ST – Set
  • SY – Square Yard
  • T3 – Thousand Pieces
  • TB – Tube
  • TH – Thousand
  • TY – Tray
  • U2 – Tablet
  • UM – Million
  • UN – Unit
  • V2 – Pouch
  • VI – Vial
  • WK – Week
  • YD – Yard
  • YR – Years
 - SAC09 - -
      baseValue string Base value to which pricing condition refers. SAP pass thru. - - - -
      creditChargeConditionType string Credit or charge condition type. - - - -
    sendingBankInformation array Sending bank info for IDoc and EDIFACT. Sending bank (payer) info in segment E1IDB02 - Segment group 3 FII Segment group 4 FII
      bankFunctionCode string

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

Valid values:

  • SOLDTO

  • CONTACT

  • BANKSOLDTO

  • BANKBENEFICIARY

  • BENEFICIARY

  • COMPETITORS

  • BUYER

  • CORRESPONDENTSENDER

  • INTERMEDIARY

  • CORRESPONDENTRECIPIENT

  • VENDOR

  • ORDERBANK

  • PAYEE

  • PAYER

  • INVOICINGPARTY

  • CARRIER

  • GOODSRECIPIENT

FIIQUALI -

FII010 =

  • SO or

  • OX or

  • I2 or

  • OZ

FII010 =

  • SO or

  • OX or

  • I2 or

  • OZ

      bankIdentifierType string

Depository Financial Institution identifier type. Valid values:

  • ABA

  • SWIFT

  • CHIPS

  • CANADIANBANK

  • CUSTOM

FIIBKCDE -

FII030-030 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ

FII030-030 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ

      bankIdentifierValue string Depository Financial Institution identifier value. FIIBKUCD -

FII030-020 where FII030-030 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ

FII030-020 where FII030-030 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ

      bankNameCode string Bank name code. FIIBKENN - FII030-010 FII030-010
      bankName string Name of bank. FIIBKNAME - FII030-070 FII030-070
      bankBranchIdentifierType string

Bank branch identifier type.

Valid values:

  • ABA

  • SWIFT

  • CHIPS

  • CANADIANBANK

  • CUSTOM

- -

FII030-060 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ

FII030-060 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ

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

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

Valid values:

  • SOLDTO

  • CONTACT

  • BANKSOLDTO

  • BANKBENEFICIARY

  • BENEFICIARY

  • COMPETITORS

  • BUYER

  • CORRESPONDENTSENDER

  • INTERMEDIARY

  • CORRESPONDENTRECIPIENT

  • VENDOR

  • ORDERBANK

  • PAYEE

  • PAYER

  • INVOICINGPARTY

  • CARRIER

  • GOODSRECIPIENT

FIIQUALI -

FII010 =

  • SO or

  • OX or

  • I2 or

  • OZ

FII010 =

  • SO or

  • OX or

  • I2 or

  • OZ

      bankIdentifierType string

Depository Financial Institution identifier type.

Valid values:

  • ABA

  • SWIFT

  • CHIPS

  • CANADIANBANK

  • CUSTOM

FIIBKCDE -

FII030-030 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ

FII030-030 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ

      bankIdentifierValue string Depository Financial Institution identifier value. FIIBKUCD -

FII030-020 where FII030-030 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ

FII030-020 where FII030-030 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ

      bankNameCode string Bank name code. FIIBKENN - FII030-010 FII030-010
      bankName string Name of bank. FIIBKNAM - FII030-070 FII030-070
      bankBranchIdentifierType string

Bank branch identifier type.

Valid values:

  • ABA

  • SWIFT

  • CHIPS

  • CANADIANBANK

  • CUSTOM

- -

FII030-060 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ

FII030-060 =

  • 114 or

  • 17 or

  • 240 or

  • ZZZ

      bankBranchIdentifier string Bank branch identifier value. FIIBKUKN - FII030-040 FII030-040
      bankBranchName string Name of bank branch. FIIBKORT - FII030-080 FII030-080
      country string Bank country. FIIBLAND - FII040 FII040
      accountHolderInformation - Account and account holder information. - - - -
        accountType string Bank account type. X12 pass thru. - - - -
        accountIdentifier string Bank account identifier number. FIIKONTO - FII020-010 FII020-010
        accountHolderName string Name of bank account holder. FIIKNAME - FII020-020 FII020-020
        accountHolderName2 string Name of bank account holder. FIIKNAM2 - FII020-030 FII020-030
        currency string Default currency code for the account. FIIKWAER - FII020-040 FII020-040
        companyIdentifier string Company identifier for sending company. X12 pass-thru for sender only. - - - -
        companyIdentifierSupplementalCode string Sending company's identifier supplemental code. X12 pass-thru for sender only. - - - -
    billToBusinessInformation - Bill to customer party company identifiers and address information. E1EDKA1 where PARVW = "AG" N101 = "BT" NAD010 = "BT" NAD010 = "BT"
      businessName string Business name for partner or location. E1EDKA1/NAME1 N102 NAD030-010 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.

  • AM_TIN - Armenia Taxpayer Identification Number
  • AR_CUIT - Argentina Tax ID
  • BR_CNES - Brazil National Registry of Health Facilities Number
  • BR_CNPJ - Brazil Tax / Legal Entity ID
  • BR_CPF - Brazil Individual Taxpayer Registration Number
  • BR_PROF_REG - Brazil Professional Registration Number
  • BY_TIN - Belarus Taxpayer Identification Number
  • CN_CHINA_ID - China identifier (alphanumeric)
  • CN_USCID - China Unified Social Credit Identifier
  • CN_FOREIGN_MFR - China Foreign Manufacturer ID
  • CN_FOREIGN_MAH - China Foreign MAH ID
  • COMPANYID - Internal company identifier
  • COMPANYSITEID - Internal location / plant / site identifier
  • DEA US -Drug Enforcement Agency Number
  • DE_IFA_REG_NUM - Informationsstelle für Arzneispezialitäten (IFA) Registration Number
  • DUNS - Dunn and Bradstreet Number
  • DUNS4 - Dunn and Bradstreet Number with 4 digit extension
  • GCP GS1 -Global Company Prefix
  • GLN - Global Location Number
  • HIN - Health Industry Number assigned by HIBCC
  • IN_COMPANY_ID - India Company ID
  • IN_IEC - India Importer Exporter Code
  • IN_GSTN - India Goods and Services Tax ID
  • IN_LOCATION_ID - India Location ID
  • IN_MFR - India Manufacturing Code
  • IN_MRCH - India Merchant Exporter Code
  • IN_PAN - India Permanent Account Number
  • IN_TIN - India Taxpayer Identification Number
  • KG_TIN - Kyrgyzstan Taxpayer Identification Number
  • KR_BUS_REG_NUMBER - South Korea Corporate Registration Number
  • KR_PROVIDER_CODE - South Korea Provider Code
  • KZ_BIN - Kazakhstan Business Identification Number
  • RU_ACCOUNT_NUMBER - Russia Account Number
  • RU_INN_FOREIGN_ENTITY - Russia Foreign Business Taxpayer Identification Number
  • RU_INN_INDIV - Russia Individual Taxpayer Identification Number
  • RU_INN_KPP_TAX_CODE - Russia KPP Registration Code
  • RU_INN_LOCAL_ENTITY - Russia Local Business Taxpayer Identification Number
  • SCAC - Standard Carrier Alpha Code - industry standard carrier identifier in North America
  • SGLN - SGLN format representation of Global Location Number
  • TRACELINK_ID - LSC automatically generates internal ID called as TraceLink ID for all Companies.
 - N103 NAD020-030 NAD020-030
        companyIdentifierValue string Company identifier value for business partner. PARTN where companyIdentifierType = COMPANYID N104 NAD020-010 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. LIFNR - - -
      address - Party address information. - - - -
        address1 string Main street address. STRAS N301 NAD050-010 NAD050-010
        address2 string Supplemental street address. STRS2 N302 NAD050-020 NAD050-020
        city string City. ORT01 N401 NAD060 NAD060
        state string State or region code. REGIO N402 NAD070-010 NAD070-010
        postalCode string Postal code. PSTLZ N403 NAD080 NAD080
        country string Country code. LAND1 N404 NAD090 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 - - - Hard code PER01 to "AJ" primary contact Hard code CTA010 to "RP" responsible person Hard code CTA010 to "RP" responsible person
        contactName string Contact name. - PER02 CTA020-020 CTA020-020
        contactTitle string Title of contact. - - - -
        contactPhone string Contact phone number. - PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE" COM010-010 where COM010-020 = "TE"
        contactEmail string Contact email address. - PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM" COM010-010 where COM010-020 = "EM"
    partnerBusinessInformation array Business Parties identifiers and address information. - N1 Loop NAD Loop NAD Loop
      partnerEntityType string

Denotes type of the entity involved in this business transaction.

Valid values:

  • ACCOUNTPARTY

  • BANK

  • BILLTOSHIPTO

  • BILLTO

  • CUSTOMER

  • CONTRACTHOLDER

  • CARRIER

  • CONSIGNOR

  • CONTAINERLOCATION

  • CONSIGNEE

  • DRIVER

  • DELIVERYPARTY

  • DESTINATIONTERMINAL

  • EXPORTER

  • SENDER

  • FREIGHTFORWARDER

  • OWNER

  • MANUFACTURER

  • NOTIFYPARTY

  • NOTIFYPARTYTWO

  • SHIPORDERNOTIFYPARTY

  • ORDEREDBY

  • BOOKINGOFFICE

  • ORIGINTERMINAL

  • INVOICEPARTY

  • PAYER

  • PICKUP

  • DESTINATIONRAMP

  • REPORTINGPARTY

  • ORIGINRAMP

  • SHIPFROM

  • SHIPPER

  • SHIPTO

  • SUPPLIER

  • RECEIVER

  • VENDOR

  • WAREHOUSE

  • ENDCUSTOMER

  • REQUESTOR

  • ORIGINHAULER

  • LOGISTICSERVICEPROVIDER

  • ORDERPARTY

  • INVOICERECIPIENT

  • CONTACT

  • DISTRIBUTOR

  • PURCHASINGGROUP

  • DISTRIBUTORBRANCH

  • HEADOFFICE

  • STORENUMBER

  • PUBLICHEALTHSERVICEFACILITY

  • PHARMACY

  • CONTRACTSERVICEPROVIDER

  • THIRDPARTY

  • SHIPPINGINSTRUCTION

  • NOTIFYPARTYTHREE

  • SUBMITTER

  • WEIGHMASTER

- N101 Use java call-out table CL_PartnerEntityType.txt NAD01 Use java call-out table CL_PartnerEntityType.txt NAD01 Use java call-out table CL_PartnerEntityType.txt
      businessName string Business name for partner or location. - N102 NAD040-010 NAD040-010
      additionalBusinessName string Additonal Business name for partner or location. - N201 - -
      companyLocationPartnerName string Additonal Location of same Business partner. - - - -
      mpcCompanyLocationIdentifierList array Identifier list for business party. - - - -
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - - -
        companyIdentifierType string

Company identifier type for business partner.

  • AM_TIN - Armenia Taxpayer Identification Number
  • AR_CUIT - Argentina Tax ID
  • BR_CNES - Brazil National Registry of Health Facilities Number
  • BR_CNPJ - Brazil Tax / Legal Entity ID
  • BR_CPF - Brazil Individual Taxpayer Registration Number
  • BR_PROF_REG - Brazil Professional Registration Number
  • BY_TIN - Belarus Taxpayer Identification Number
  • CN_CHINA_ID - China identifier (alphanumeric)
  • CN_USCID - China Unified Social Credit Identifier
  • CN_FOREIGN_MFR - China Foreign Manufacturer ID
  • CN_FOREIGN_MAH - China Foreign MAH ID
  • COMPANYID - Internal company identifier
  • COMPANYSITEID - Internal location / plant / site identifier
  • DEA US -Drug Enforcement Agency Number
  • DE_IFA_REG_NUM - Informationsstelle für Arzneispezialitäten (IFA) Registration Number
  • DUNS - Dunn and Bradstreet Number
  • DUNS4 - Dunn and Bradstreet Number with 4 digit extension
  • GCP GS1 -Global Company Prefix
  • GLN - Global Location Number
  • HIN - Health Industry Number assigned by HIBCC
  • IN_COMPANY_ID - India Company ID
  • IN_IEC - India Importer Exporter Code
  • IN_GSTN - India Goods and Services Tax ID
  • IN_LOCATION_ID - India Location ID
  • IN_MFR - India Manufacturing Code
  • IN_MRCH - India Merchant Exporter Code
  • IN_PAN - India Permanent Account Number
  • IN_TIN - India Taxpayer Identification Number
  • KG_TIN - Kyrgyzstan Taxpayer Identification Number
  • KR_BUS_REG_NUMBER - South Korea Corporate Registration Number
  • KR_PROVIDER_CODE - South Korea Provider Code
  • KZ_BIN - Kazakhstan Business Identification Number
  • RU_ACCOUNT_NUMBER - Russia Account Number
  • RU_INN_FOREIGN_ENTITY - Russia Foreign Business Taxpayer Identification Number
  • RU_INN_INDIV - Russia Individual Taxpayer Identification Number
  • RU_INN_KPP_TAX_CODE - Russia KPP Registration Code
  • RU_INN_LOCAL_ENTITY - Russia Local Business Taxpayer Identification Number
  • SCAC - Standard Carrier Alpha Code - industry standard carrier identifier in North America
  • SGLN - SGLN format representation of Global Location Number
  • TRACELINK_ID - LSC automatically generates internal ID called as TraceLink ID for all Companies.
 - N103 Use java call-out table CL_CompanyIdentifierType.txt

NAD020-030

EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

Use Java call-out to enumeration lookup table CL_CompanyIdentifierType

NAD020-030

EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

Use Java call-out to enumeration lookup table CL_CompanyIdentifierType

        companyIdentifierValue string Company identifier value for business partner. - N104 NAD020-010 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - - -
      address - Party address information. - N3, N4, - -
        address1 string Main street address. - N301 NAD050-010 NAD050-010
        address2 string Supplemental street address. - N302 NAD050-020 NAD050-020
        city string City. - N401 NAD060 NAD060
        district string District. - - - -
        state string State or region code. - N402 NAD070-010 NAD070-010
        postalCode string Postal code. - N403 NAD080 NAD080
        country string Country code. - N404 NAD090 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   - - - N1-G61 CTA CTA
        contactType string

Contact type.

Valid values:

  • INFORMATION - Information contact

  • FORWARDER - Forwarder contact

  • CONFIRMEDWITH - Person whom the content of the PO has been discussed and agreed prior to sending this message.

  • EMERGENCYDANGEROUS - Emergency dangerous goods contact

  • SENDER - Message sender contact

  • RESPONSIBLE - Responsible person contact

-

G6101 =

  • IC (INFORMATION) or

  • FW (FORWARDER) or

  • RP (RESPONSIBLE)

CTA010 = IC (INFORMATION) CTA010 = IC (INFORMATION)
        contactName string Contact name. - G6102 CTA020-020 CTA020-020
        contactTitle string Title of contact. - - - -
        contactPhone string Contact phone number. - G6104 where G6103 = "TE" COM010-010 where COM010-020 = "TE" COM010-010 where COM010-020 = "TE"
      contactEmail string Contact email address. - G6104 where G6103 = "EM" COM010-010 where COM010-020 = "EM" COM010-010 where COM010-020 = "EM"
      mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. - - - -
        externalERPUserName string External ERP system user name for user who generated message. - - - -
        organizationCode string Code for organization responsible for generating the messager. - - - -
        organizationDescription string Description of the organization responsible for generating the message. - - - -
        groupCode string Code identifying group responsible for generating the message. - - - -
        language string Language key for message. - - - -
        languageCode string ISO language code for message. - - - -
        referenceIdentifier string Partner reference identifier. - - - -
        orderType string Order Type. - - - -
        address3 string Additional address information that is not included in addressTypeDefinition. - N202 - -
        address4 string Additional address information that is not included in addressTypeDefinition. - - - -
        postalArea string Postal Area. - - - -
        timeZone string Time zone for referenced dates. - - - -
        telephone string Telephone Number. - - - -
        emailAddress string Email Address. - - - -
        vatRegistrationNumber string Vat Registration Number. - - - -
        taxExemptCode string Tax exempt Code. - - - -
        locationType string Business Partner Location Type. - N405 - -
        locationIdentifier string Business Partner location Identifier. - N406 - -
        countrySubDivisionCode string Describes the country subdivision. - N407 - -
    partnerBusinessInformation array Partner business information, company identifiers and address information. - N101 = "BS" NAD010 = "BS" NAD010 = "BT"
      businessName string Business name for partner or location. - N102 NAD030-010 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.

  • AM_TIN - Armenia Taxpayer Identification Number
  • AR_CUIT - Argentina Tax ID
  • BR_CNES - Brazil National Registry of Health Facilities Number
  • BR_CNPJ - Brazil Tax / Legal Entity ID
  • BR_CPF - Brazil Individual Taxpayer Registration Number
  • BR_PROF_REG - Brazil Professional Registration Number
  • BY_TIN - Belarus Taxpayer Identification Number
  • CN_CHINA_ID - China identifier (alphanumeric)
  • CN_USCID - China Unified Social Credit Identifier
  • CN_FOREIGN_MFR - China Foreign Manufacturer ID
  • CN_FOREIGN_MAH - China Foreign MAH ID
  • COMPANYID - Internal company identifier
  • COMPANYSITEID - Internal location / plant / site identifier
  • DEA US -Drug Enforcement Agency Number
  • DE_IFA_REG_NUM - Informationsstelle für Arzneispezialitäten (IFA) Registration Number
  • DUNS - Dunn and Bradstreet Number
  • DUNS4 - Dunn and Bradstreet Number with 4 digit extension
  • GCP GS1 -Global Company Prefix
  • GLN - Global Location Number
  • HIN - Health Industry Number assigned by HIBCC
  • IN_COMPANY_ID - India Company ID
  • IN_IEC - India Importer Exporter Code
  • IN_GSTN - India Goods and Services Tax ID
  • IN_LOCATION_ID - India Location ID
  • IN_MFR - India Manufacturing Code
  • IN_MRCH - India Merchant Exporter Code
  • IN_PAN - India Permanent Account Number
  • IN_TIN - India Taxpayer Identification Number
  • KG_TIN - Kyrgyzstan Taxpayer Identification Number
  • KR_BUS_REG_NUMBER - South Korea Corporate Registration Number
  • KR_PROVIDER_CODE - South Korea Provider Code
  • KZ_BIN - Kazakhstan Business Identification Number
  • RU_ACCOUNT_NUMBER - Russia Account Number
  • RU_INN_FOREIGN_ENTITY - Russia Foreign Business Taxpayer Identification Number
  • RU_INN_INDIV - Russia Individual Taxpayer Identification Number
  • RU_INN_KPP_TAX_CODE - Russia KPP Registration Code
  • RU_INN_LOCAL_ENTITY - Russia Local Business Taxpayer Identification Number
  • SCAC - Standard Carrier Alpha Code - industry standard carrier identifier in North America
  • SGLN - SGLN format representation of Global Location Number
  • TRACELINK_ID - LSC automatically generates internal ID called as TraceLink ID for all Companies.
 		 - N103 NAD020-030 NAD020-030
        companyIdentifierValue string Company identifier value for business partner. - N104 NAD020-010 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - - -
      address - Party address information. - - - -
        address1 string Main street address. - N301 NAD050-010 NAD050-010
        address2 string Supplemental street address. - N302 NAD050-020 NAD050-020
        city string City. - N401 NAD060 NAD060
        state string State or region code. - N402 NAD070-010 NAD070-010
        postalCode string Postal code. - N403 NAD080 NAD080
        country string Country code. - N404 NAD090 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 - - - Hard code PER01 to "AJ" primary contact Hard code CTA010 to "RP" responsible person Hard code CTA010 to "RP" responsible person
        contactName string Contact name. - PER02 CTA020-020 CTA020-020
        contactTitle string Title of contact. - - - -
        contactPhone string Contact phone number. - PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE" COM010-010 where COM010-020 = "TE"
        contactEmail string Contact email address. - PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM" COM010-010 where COM010-020 = "EM"
    headOfficeBusinessInformation - Can be used for retail or institutional central headquarter location. - Segment BCD/N1 looping group 1200 N101 = "LB" - -
      businessName string Business name for partner or location - N102 - -
      mpcCompanyLocationIdentifierList array Identifier list for business party. - - - -
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - - -
        companyIdentifierType string

Company identifier type for business partner.

 -

N103

X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • US_340B_ID - PI

  • PHARMACY_PROCESSOR_NUMBER - PP

  • GLN - UL

- -
        companyIdentifierValue string Company identifier value for business partner. - N104 - -
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - - -
      address - Party address information. - - - -
        address1 string Main street address. - N301 - -
        address2 string Supplemental street address. - N302 - -
        city string City. - N401 - -
        district string District. - - - -
        state string State or region code. - N402 - -
        postalCode string Postal code. - N403 - -
        country string Country code. - N404 - -
        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 - - - Hard code PER01 to "AJ" primary contact - -
- -     contactName string Contact name. - PER02 - -
- -     contactTitle string Title of contact. - - - -
- -     contactPhone string Contact phone number. - PER04 where PER03 = "TE" - -
- -     contactEmail string Contact email address. - PER06 where PER05 = "EM" - -
- - pharmacyBusinessInformation - Either a retail or institutional pharmacy dispenser operating as a contracted third party pharmacy supporting a 340B covered entity. - Segment BCD/N1 looping group 1200 N101 = "QA" - -
      businessName string Business name for partner or location. - N102 - -
      mpcCompanyLocationIdentifierList array Identifier list for business party. - - - -
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - - -
        companyIdentifierType string Company identifier type for business partner -

N103

X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • US_340B_ID - PI

  • PHARMACY_PROCESSOR_NUMBER - PP

  • GLN - UL

- -
        companyIdentifierValue string Company identifier value for business partner. - N104 - -
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - - -
      address - Party address information. - - - -
        address1 string Main street address. - N301 - -
        address2 string Supplemental street address. - N302 - -
        city string City. - N401 - -
        district string District. - - - -
        state string State or region code. - N402 - -
        postalCode string Postal code. - N403 - -
        country string Country code. - N404 - -
        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 - - - Hard code PER01 to "AJ" primary contact - -
        contactName string Contact name. - PER02 - -
        contactTitle string Title of contact. - - - -
        contactPhone string Contact phone number. - PER04 where PER03 = "TE" - -
        contactEmail string Contact email address. - PER06 where PER05 = "EM" - -
    supplierBusinessInformation - Supplier party company identifiers and address information. Segment E1EDKA1 where PARVW = "LF" Segment BCD/N1 looping group 1200 N101 = "SU" Segment BGM/NAD looping group 3 NAD01 = "SU" Segment BGM/NAD looping group 3 NAD01 = "SU"
      businessName string Business name for partner or location. NAME1 N102 NAD040-010 NAD040-010
      mpcCompanyLocationIdentifierList array Identifier list for business party. - - - -
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - - -
        companyIdentifierType string Company identifier type for business partner. PARTNER_Q hard code "LF" companyIdentifierType = "GLN" hard code "100" to E1ADRE1/EXTEND_Q child of E1ADRM1 Required value for sender

N103

X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • US_340B_ID - PI

  • PHARMACY_PROCESSOR_NUMBER - PP

  • GLN - UL

NAD020-030

EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

NAD020-030

EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

        companyIdentifierValue string Company identifier value for business partner. PARTNER_ID companyIdentifierType = "GLN" map companyIdentifierValue to E1ADRE1/EXTEND_D Required value N104 NAD020-010 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - - -
      address - Party address information. - - - -
        address1 string Main street address. STREET1 N301 NAD050-010 NAD050-010
        address2 string Supplemental street address. STREET2 N302 NAD050-020 NAD050-020
        city string City. CITY1 N401 NAD060 NAD060
        district string District. - - - -
        state string State or region code. REGION N402 NAD070-010 NAD070-010
        postalCode string Postal code. POSTL_COD1 N403 NAD080 NAD080
        country string Country code. COUNTRY1 N404 NAD090 NAD090
        telephone string Telephone number. TELEPHONE1 - - -
        fax string Fax number. TELEFAX - - -
        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 - - - Hard code PER01 to "AJ" primary contact Hard code CTA010 to "RP" responsible person Hard code CTA010 to "RP" responsible person
        contactName string Contact name. - PER02 CTA020-020 CTA020-020
        contactTitle string Title of contact. - - - -
        contactPhone string Contact phone number. - PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE" COM010-010 where COM010-020 = "TE"
        contactEmail string Contact email address. - PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM" COM010-010 where COM010-020 = "EM"
    thirdPartyLogisticsInformation - Third party logistics provider. - Segment BCD/N1 looping group 1200 N101 = "YE" - -
      businessName string Business name for partner or location. - N102 - -
      mpcCompanyLocationIdentifierList array Identifier list for business party. - - - -
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - - -
        companyIdentifierType string Company identifier type for business partner. -

N103

X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • US_340B_ID - PI

  • PHARMACY_PROCESSOR_NUMBER - PP

  • GLN - UL

- -
        companyIdentifierValue string Company identifier value for business partner. - N104 - -
      alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - - -
      address - Party address information. - - - -
        address1 string Main street address. - N301 - -
        address2 string Supplemental street address. - N302 - -
        city string City. - N401 - -
        district string District. - - - -
        state string State or region code. - N402 - -
        postalCode string Postal code. - N403 - -
        country string Country code. - N404 - -
        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 - - - Hard code PER01 to "AJ" primary contact - -
        contactName string Contact name. - PER02 - -
        contactTitle string Title of contact. - - - -
        contactPhone string Contact phone number. - PER04 where PER03 = "TE" - -
        contactEmail string Contact email address. - PER06 where PER05 = "EM" - -
    originalClaimantBusinessInformation - Originating processor if the returns are going through more than third party processor. - Segment BCD/N1 looping group 1200 N101 = "XI" - -
      businessName string Business name for partner or location. - N102 - -
      mpcCompanyLocationIdentifierList array Identifier list for business party. - - - -
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - - -
        companyIdentifierType string Company identifier type for business partner. -

N103

X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • US_340B_ID - PI

  • PHARMACY_PROCESSOR_NUMBER - PP

  • GLN - UL

- -
        companyIdentifierValue string Company identifier value for business partner. - N104 - -
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - - -
      address - Party address information. - - - -
        address1 string Main street address. - N301 - -
        address2 string Supplemental street address - N302 - -
        city string City - N401 - -
        district string District - - - -
        state string State or region code - N402 - -
        postalCode string Postal code - N403 - -
        country string Country code - N404 - -
        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 - - - Hard code PER01 to "AJ" primary contact - -
        contactName string Contact name - PER02 - -
        contactTitle string Title of contact - - - -
        contactPhone string Contact phone number - PER04 where PER03 = "TE" - -
        contactEmail string Contact email address - PER06 where PER05 = "EM" - -
    remitToBusinessInformation - Remit to party … The payee or beneficiary of a remittance. The party that will receive the credit for the return. Segment E1EDKA1 where PARVW = "BE Segment BCD/N1 looping group 1200 N101 = "RI" Segment BGM/NAD looping group 3 NAD01 = "RE" Segment BGM/NAD looping group 3 NAD01 = "RE"
      businessName string Business name for partner or location NAME1 N102 NAD040-010 NAD040-010
      mpcCompanyLocationIdentifierList array Identifier list for business party. - - - -
        isIdentifierPresentInEvent boolean Is identifier present in event boolean - - - -
        companyIdentifierType string Company identifier type for business partner PARTNER_Q hard code "MF"

N103

X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • US_340B_ID - PI

  • PHARMACY_PROCESSOR_NUMBER - PP

  • GLN - UL

NAD020-030

EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

NAD020-030

EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

        companyIdentifierValue string Company identifier value for business partner PARTNER_ID N104 NAD020-010 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value - - - -
      address - Party address information - - - -
        address1 string Main street address STREET1 N301 NAD050-010 NAD050-010
        address2 string Supplemental street address STREET2 N302 NAD050-020 NAD050-020
        city string City CITY1 N401 NAD060 NAD060
        district string District - - - -
        state string State or region code REGION N402 NAD070-010 NAD070-010
        postalCode string Postal code POSTL_COD1 N403 NAD080 NAD080
        country string Country code COUNTRY1 N404 NAD090 NAD090
        telephone string Telephone number TELEPHONE1 - - -
        fax string Fax number TELEFAX - - -
        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 - - - Hard code PER01 to "AJ" primary contact Hard code CTA010 to "RP" responsible person Hard code CTA010 to "RP" responsible person
        contactName string Contact name - PER02 CTA020-020 CTA020-020
        contactTitle string Title of contact - - - -
        contactPhone string Contact phone number - PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE" COM010-010 where COM010-020 = "TE"
        contactEmail string Contact email address - PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM" COM010-010 where COM010-020 = "EM"
    shipToLocationInformation - Ship to location identifiers and address information. Segment E1EDKA1 where PARVW = "WE Segment BCD/N1 looping group 1200 N101 = "ST" Segment BGM/NAD looping group 3 NAD01 = "DS" Segment BGM/NAD looping group 3 NAD01 = "DS"
      businessName string Business name for partner or location NAME1 N102 NAD040-010 NAD040-010
      mpcCompanyLocationIdentifierList array Identifier list for business party. - - - -
        isIdentifierPresentInEvent boolean Is identifier present in event boolean - - - -
        companyIdentifierType string Company identifier type for business partner PARTNER_Q hard code "MF"

N103

X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • US_340B_ID - PI

  • PHARMACY_PROCESSOR_NUMBER - PP

  • GLN - UL

NAD020-030

EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

NAD020-030

EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

        companyIdentifierValue string Company identifier value for business partner PARTNER_ID N104 NAD020-010 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value - - - -
      address - Party address information - - - -
        address1 string Main street address STREET1 N301 NAD050-010 NAD050-010
        address2 string Supplemental street address STREET2 N302 NAD050-020 NAD050-020
        city string City CITY1 N401 NAD060 NAD060
        district string District - - - -
        state string State or region code REGION N402 NAD070-010 NAD070-010
        postalCode string Postal code POSTL_COD1 N403 NAD080 NAD080
        country string Country code COUNTRY1 N404 NAD090 NAD090
        telephone string Telephone number TELEPHONE1 - - -
        fax string Fax number TELEFAX - - -
        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 - - - Hard code PER01 to "AJ" primary contact Hard code CTA010 to "RP" responsible person Hard code CTA010 to "RP" responsible person
        contactName string Contact name - PER02 CTA020-020 CTA020-020
        contactTitle string Title of contact - - - -
        contactPhone string Contact phone number - PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE" COM010-010 where COM010-020 = "TE"
        contactEmail string Contact email address - PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM" COM010-010 where COM010-020 = "EM"
    distributorBusinessInformation - Supplier party company identifiers and address information. N/A Segment BCD/N1 looping group 1200 N101 = "DS" Segment BGM/NAD looping group 3 NAD01 = "DS" Segment BGM/NAD looping group 3 NAD01 = "DS"
      businessName string Business name for partner or location - N102 NAD040-010 NAD040-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

X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • US_340B_ID - PI

  • PHARMACY_PROCESSOR_NUMBER - PP

  • GLN - UL

NAD020-030

EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

NAD020-030

EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

        companyIdentifierValue string Company identifier value for business partner - N104 NAD020-010 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value - - - -
      address - Party address information - - - -
        address1 string Main street address - N301 NAD050-010 NAD050-010
        address2 string Supplemental street address - N302 NAD050-020 NAD050-020
        city string City - N401 NAD060 NAD060
        district string District - - - -
        state string State or region code - N402 NAD070-010 NAD070-010
        postalCode string Postal code - N403 NAD080 NAD080
        country string Country code - N404 NAD090 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 - - - Hard code PER01 to "AJ" primary contact Hard code CTA010 to "RP" responsible person Hard code CTA010 to "RP" responsible person
        contactName string Contact name - PER02 CTA020-020 CTA020-020
        contactTitle string Title of contact - - - -
        contactPhone string Contact phone number - PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE" COM010-010 where COM010-020 = "TE"
        contactEmail string Contact email address - PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM" COM010-010 where COM010-020 = "EM"
    distributorBranchInformation - Supplier party company identifiers and address information. - Segment BCD/N1 looping group 1200 N101 = "DB" Segment BGM/NAD looping group 3 NAD01 = "DB" Segment BGM/NAD looping group 3 NAD01 = "DB"
      businessName string Business name for partner or location - N102 NAD040-010 NAD040-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

X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • US_340B_ID - PI

  • PHARMACY_PROCESSOR_NUMBER - PP

  • GLN - UL

NAD020-030

EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

NAD020-030

EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

        companyIdentifierValue string Company identifier value for business partner - N104 NAD020-010 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value - - - -
      address - Party address information - - - -
        address1 string Main street address - N301 NAD050-010 NAD050-010
        address2 string Supplemental street address - N302 NAD050-020 NAD050-020
        city string City - N401 NAD060 NAD060
        district string District - - - -
        state string State or region code - N402 NAD070-010 NAD070-010
        postalCode string Postal code - N403 NAD080 NAD080
        country string Country code - N404 NAD090 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 - - - Hard code PER01 to "AJ" primary contact. Hard code CTA010 to "RP" responsible person. Hard code CTA010 to "RP" responsible person.
        contactName string Contact name. - PER02 CTA020-020 CTA020-020
        contactTitle string Title of contact. - - - -
        contactPhone string Contact phone number. - PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE" COM010-010 where COM010-020 = "TE"
        contactEmail string Contact email address. - PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM" COM010-010 where COM010-020 = "EM"
    distributorBranchformation - Supplier party company identifiers and address information. N/A Segment BCD/N1 looping group 1200 N101 = "DB" Segment BGM/NAD looping group 3 NAD01 = "DB" Segment BGM/NAD looping group 3 NAD01 = "DB"
      businessName string Business name for partner or location. - N102 NAD040-010 NAD040-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

X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • US_340B_ID - PI

  • PHARMACY_PROCESSOR_NUMBER - PP

  • GLN - UL

NAD020-030

EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

NAD020-030

EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

        companyIdentifierValue string Company identifier value for business partner. - N104 NAD020-010 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - - -
      address - Party address information. - - - -
        address1 string Main street address. - N301 NAD050-010 NAD050-010
        address2 string Supplemental street address. - N302 NAD050-020 NAD050-020
        city string City. - N401 NAD060 NAD060
        district string District. - - - -
        state string State or region code. - N402 NAD070-010 NAD070-010
        postalCode string Postal code. - N403 NAD080 NAD080
        country string Country code. - N404 NAD090 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 - - - Hard code PER01 to "AJ" primary contact Hard code CTA010 to "RP" responsible person Hard code CTA010 to "RP" responsible person
        contactName string Contact name. - PER02 CTA020-020 CTA020-020
        contactTitle string Title of contact. - - - -
        contactPhone string Contact phone number. - PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE" COM010-010 where COM010-020 = "TE"
        contactEmail string Contact email address. - PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM" COM010-010 where COM010-020 = "EM"
    freeTextNote array Ship to party company identifiers and address information. - - - -
      textReferenceCode string Text reference or subject code. Will map whatever is found. - - - -
      textFunctionCode string Text function code. Will map whatever is found. - - - -
      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. - - - -
  canonicalCreditDebitAdjustmentItemDetails array Line item details for credit or debit adjustments. - CDD credit/debit adjustment line item details loop. segment group 7 with line item details only loops 5 times with allocations (where is the payment coming from). Each allocation includes a child loop with details of the credit or debit amounts with only 20 loops. Segment group 7 only supports a total of 100 loops with details of credit/debit adjustment payments -- 5 allocations x 20 payment details. The IDoc detail segment E1IDPU5 supports up to 200,000 loops. X12 segment details supports an unlimited number of loops. segment group 7 with line item details only loops 5 times with allocations (where is the payment coming from). Each allocation includes a child loop with details of the credit or debit amounts with only 20 loops. Segment group 7 only supports a total of 100 loops with details of credit/debit adjustment payments -- 5 allocations x 20 payment details. The IDoc detail segment E1IDPU5 supports up to 200,000 loops. X12 segment details supports an unlimited number of loops.
    lineItemNumber string Credit or debit adjustment line item number (HDA). - CDD03 (HDA) - -
    isCreditFlag boolean

Credit or debit boolean.

Valid values:

  • true - credit

  • false - debit

-

CDD02

If source = true, hard C. If source = false or is missing, hard code D

- -
    creditDebitAdjustmentReasonCode string

Code indicating reason for debit or credit memo or adjustment to invoice, debit or credit memo, or payment.

  • 01 - Pricing error
  • 02 - Allowance or charge error
  • 03 - Extension error
  • 04 - Item not accepted - damaged
  • 05 - Item not accepted - quality
  • 06 - Quantity contested
  • 07 - Incorrect product
  • 09 - Terms of sale error
  • 11 - Returns - damaged. HDA: Use for concealed damaged product or damaged in transit.
  • 12 - Returns - quality
  • 13 - Returns - dating
  • 14 - Returns - promotion
  • 15 - Returns - recall
  • 16 - Non-invoice related allowance or charge
  • 19 - Duplicate billing
  • 24 - Incorrect discount
  • 25 - Item not accepted
  • 46 - Transportation charge incorrect
  • 54 - Freight deducted
  • 55 - Tax deducted
  • 56 - Advertising allowance taken
  • 59 - Item not received
  • 71 - Advertising allowance
  • 72 - Authorized return - HDA: Examples include customer ordering error, excess inventory, label problem and stock reduction agreement.
  • 75 - Total order not received
  • 79 - Cooperative advertising
  • 81 - Credit as agreed
  • 83 - Delivery change
  • 93 - Field destroy
  • A2 - Misshipped - wrong product received
  • A5 - Overage
  • A6 - Packing violations
  • A7 - Payment on account
  • A8 - Promotional allowance
  • B6 - Repay discount
  • CB - Collected balance adjustment incorrected
  • D3 - Unauthorized deduction
  • E9 - Order cancelled
  • F1 - Defective. HDA: Use for defective merchandise, defective packaging, store inspection, DSCSA Transaction Information invalid/not received from supplier.
  • GG - Unsaleable merchandise
  • IS - Interim settlement
  • L2 - Discount
  • L7 - Miscellaneous deductions
  • L8 - Miscellaneous credits
  • MC - Miscellaneous costs
  • RM - Returned material
 E1IDPU1/DOCSTATU IB IDoc mapping only. Not mapped to OB IDoc. CDD01 where X12 qualifier = canonical code in enum mapping worksheet. - -
    adjustmentAmount number Monetary amount for the credit or debit adjustment. E1IDPU5/ MOABETR

CDD04

If isCreditFlag = true, amount is negative, else amount is posiive

MOA010-010 = 210 (credit note amt) or

211 (debit note amt) Loop segment group FCA required element FCA010 = 5 (charge to be paid by vendor) or

6 (charge to be paid by customer)

MOA010-010 = 210 (credit note amt) or 211 (debit note amt) Loop segment group FCA required element FCA010 = 5 (charge to be paid by vendor) or 6 (charge to be paid by customer)
    currencyCode string Currency code for credit or charge amount. Credit amount is a negative value, debit amount is positive E1IDPU5/CUXWAERZ - CUX010-020 where CUX010-010 = 1 (charge payment currency) Child of MOA above. CUX010-020 where CUX010-010 = 1 (charge payment currency) Child of MOA above.
    unitPrice string Unit price. Price per unit of product, service, commodity, etc. - CDD11 - -
    creditDebitQuantity number Number of supplier units credited or debited. HDA: May use a decimal to indicate a quantity variance, fractions or partials. - CDD07 - -
    unitOfMeasure string

Unit or Basis for Measurement Code.

  • 02 – Statute Mile
  • 4G – Microliter
  • AM – Ampoule
  • AV – Capsule
  • BD – Bundle
  • BG – Bag
  • BO – Bottle
  • BX – Box
  • C3 – Centiliter
  • CA – Case
  • CC – Cubic Centimeter
  • CF – Cubic Feet
  • CG – Card, Blister
  • CI – Cubic Inches
  • CL – Cylinder
  • CM – Centimeter
  • CN – Can
  • CP – Crate
  • CQ – Cartridge
  • CR – Cubic Meters
  • CT – Carton
  • DA – Day
  • DI – Dispenser
  • DK – Kilometers
  • DL – Deciliter
  • DM – Decimeter
  • DR – Drum
  • DS – Display
  • DZ – Dozen
  • EA – Each
  • FO – Fluid Ounce
  • FT – Foot
  • GA – Gallon
  • GL – Gram/liter
  • GR – Gram
  • GS – Gross
  • H4 – Hectoliter
  • HF – Hundred Feet
  • HR – Hours
  • IN – Inch
  • K6 – Kiloliters
  • KG – Kilogram
  • KT – Kit
  • LB – Pounds
  • LF – Linear Foot
  • LO – Lot (unit of procurement)
  • LT – Liter
  • LY – Linear Yard
  • MC – Microgram
  • ME – Milligram
  • ML – Milliliter
  • MM – Millimeter
  • MO – Months
  • MR – Meter
  • OZ – Ounces
  • PC – Piece
  • PF – Pallet
  • PK – Package
  • PR – Pair
  • PT – Pint
  • QT – Quart
  • RL – Roll
  • SC – Square Centimeter
  • SF – Square Foot
  • SH – Sheet
  • SI – Square Inch
  • SM – Square Meter
  • ST – Set
  • SY – Square Yard
  • T3 – Thousand Pieces
  • TB – Tube
  • TH – Thousand
  • TY – Tray
  • U2 – Tablet
  • UM – Million
  • UN – Unit
  • V2 – Pouch
  • VI – Vial
  • WK – Week
  • YD – Yard
  • YR – Years
 - CDD08 - -
    priceIdentifierCode string

Code identifying pricing specification. X12 mapping only: pass thru. No conversion. Possible valid values:

  • UCP - Unit cost price (HDA)

  • CON - Contract price

  • OPP - Original PO

- CDD10 - -
    transactionReferenceIdentifierList(1) array Transaction references for mapping to N9 reference segment elements for other document types. Mapping to IDoc segment E1IDPU1 and DOC segment in EDIFACT. segment E1IDPU1 segment N9 segment group 10 DOC loop segment group 11 DOC loop
      b2bTransactionIdentifierType string

Referenced document type.

Valid values:

  • BATCH
  • CHECK
  • CONTRACT
  • CREDITDEBITADJUSTMENT
  • CREDITADVICE
  • CREDITMEMO
  • DEBITADVICE
  • DEBITMEMO
  • INVOICE
  • PAYMENT
  • PURCHASEORDER
  • REMITTANCEADVICE
  • RETURNAUTHORIZATION
  • SUPPLIERORDER
  • THIRDPARTYREFERENCE

E1IDPU1/DOCNAME =

  • INV (INVOICE) or

  • CRM (CREDITMEMO) or

  • DBM (DEBITMEMO) or

  • REM (REMITTANCEADVICE) or

  • PAO (PAYMENT) or

  • CRE (CREDITADVICE) or

  • DEB (DEBITADVICE)

N901 =

  • BT (BATCH) or

  • CM (CREDITMEMO) or

  • DL (DEBITMEMO)

  • GK (THIRDPARTYREFERENCE) or

  • RZ (RETURNAUTHORIZATION) or

  • CT (CONTRACT)

DOC010-010 =

  • 380 (INVOICE) or

  • 381 (CREDITMEMO) or

  • 383 (DEBITMEMO) or

  • 454 (CREDITADVICE) or

  • 456 (DEBITADVICE) or

  • 481 (REMITTANCEADVICE) or

  • 450 (PAYMENT)

DOC010-010 =

  • 380 (INVOICE) or

  • 381 (CREDITMEMO) or

  • 383 (DEBITMEMO) or

  • 454 (CREDITADVICE) or

  • 456 (DEBITADVICE) or

  • 481 (REMITTANCEADVICE) or

  • 450 (PAYMENT)

      b2bTransactionIdentifierValue string Identifier for transaction referenced by b2bTransactionIdentifierType DOCNUMMR N902 DOC020-010 DOC020-010
      transactionDate string Date transaction created in string date format YYYY-MM-DD DOCDATUM - DOC/DTM02 where DTM010 = 137 (Doc issue date) DOC/DTM02 where DTM010 = 137 (Doc issue date)
      epochTransactionDate integer Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. - - - -
      lineItemNumber string Line item number in customer purchase order. Line item level only. - - - -
    transactionReferenceIdentifierList(2) array Transaction references for mapping to IDoc segment E1IDP02. segment E1EDP02 - - -
    b2bTransactionIdentifierType string

Referenced document type.

Valid values:

  • BATCH
  • CHECK
  • CONTRACT
  • CREDITDEBITADJUSTMENT
  • CREDITADVICE
  • CREDITMEMO
  • DEBITADVICE
  • DEBITMEMO
  • INVOICE
  • PAYMENT
  • PURCHASEORDER
  • REMITTANCEADVICE
  • RETURNAUTHORIZATION
  • SUPPLIERORDER
  • THIRDPARTYREFERENCE

E1IDP02/QUALF =

  • 009 (INVOICE) or

  • 028 (CREDITMEMO) or

  • 022 (PAYMENT) or

  • 029 (REMITTANCEADVICE) or

  • 073 (CREDITADVICE)

- - -
      b2bTransactionIdentifierValue string Identifier for transaction referenced by b2bTransactionIdentifierType. DOCNUMMR - - -
      transactionDate string Date transaction created in string date format YYYY-MM-DD DOCDATUM - - -
      epochTransactionDate integer Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. - - - -
      lineItemNumber string Line item number in customer purchase order. Line item level only. - - - -
    productCodesIdentifiers(1) array Product code identifiers mapping to LIN02/LIN03. X12 mapping only. IDoc and EDIFACT do not map product code identifiers. - Loop group 1600 CDD-LIN - -
    productCodeType string

Code to qualify product identifier type.

Valid values:

  • GTIN12

  • GTIN14

  • MANUFACTURER

  • VENDORCATALOG

  • UPC

  • UPN

  • US_NDC442

  • US_NDC532

  • US_NDC541

  • US_NDC542

  • US_NHRIC55

  • US_NHRIC64

  • US_NHRIC - Elizabeth

Conform to HDA requirements.

-

LIN02 =

  • MF (MANUFACTURER) or

  • N1 (US_NDC442) or

  • N2 (US_NDC532) or

  • N3 (US_NDC541) or

  • N4 (US_NDC542) or

  • N5 (US_NHRIC55) or

  • N6 (US_NHRIC64) or

  • NH (US_NHRIC) or

  • UK (GTIN14) or

  • UP (UPC) or

  • UX (UPN) or

  • VC (VENDORCATALOG)

- -
    productCodeValue string Product code identifier value. - LIN03 - -
    productCodesIdentifiers(2) array Product code identifiers mapping to LIN04/LIN05. X12 mapping only. IDoc and EDIFACT do not map product code identifiers. - Loop group 1600 CDD-LIN - -
      productCodeType string

Code to qualify product identifier type.

Valid values:

  • BUYER
  • GTIN12
  • GTIN14
  • MANUFACTURER
  • VENDORCATALOG
  • UPC
  • UPN
  • US_NDC442
  • US_NDC532
  • US_NDC541
  • US_NDC542
  • US_NHRIC55
  • US_NHRIC64
  • US_NHRIC - Elizabeth

Conform to HDA requirements.

-

LIN04 =

  • IN (BUYER)

  • MF (MANUFACTURER) or

  • N1 (US_NDC442) or

  • N2 (US_NDC532) or

  • N3 (US_NDC541) or

  • N4 (US_NDC542) or

  • N5 (US_NHRIC55) or

  • N6 (US_NHRIC64) or

  • NH (US_NHRIC) or

  • UK (GTIN14) or

  • UP (UPC) or

  • UX (UPN) or

  • VC (VENDORCATALOG)

- -
      productCodeValue string Product code identifier value. - LIN05 - -
    creditsAndCharges array Credits and charges at line item detail including invoice total, discounts, allowances, promotions, services, and others. segment E1IDPU5 segment loop 2030 SAC in loop 1600 CDD segment group 7 MOA segment group 8 MOA
      creditChargeKeyType string

Key identifies credit or charges as discounts or additional charges.

Valid values:

  • ALLOWANCE - Amt in SAC05 added for credit, subtracted for debit

  • CHARGE - Amt in SAC05 subtracted for credit, added for debit

  • NONE - Amt in SAC05 added for credit, subtracted for debit

-

SAC01 =

  • A (ALLOWANCE) or

  • C (CHARGE) or

  • N (NONE)

- -
      creditChargeType string

Code representing type of credit or charge. Valid values (HDA and other company guidelines):

  • ADJUSTMENT
  • HANDLING
  • PERITEM
  • DISCOUNT
  • CREDIT
  • DEBIT
  • FREIGHT
  • ADDITIONTOINVOICE
  • RENTAL
  • SALESTAX

E1IDPU5/MOAQUAL =

  • 018 (ADJUSTMENT) or

  • 003 (DISCOUNT) or

  • 005 (SALESTAX) or

  • 023 (DEBIT) or

  • 024 (CREDIT)

SAC02 =

  • A170 (ADJUSTMENT) or

  • D500 (HANDLING) or

  • F240 (PERITEM) or

  • C310 (DISCOUNT) or

  • D240 (FREIGHT) or

  • E063 (ADDITIONTOINVOICE) or

  • G330 (RENTAL) or

  • H740 (SALESTAX)

Use call out table CL_CreditChargeType

FCA / ALC / MOA020 where MOA010 =

  • 5 (ADJUSTMENT) or

  • 21 (DISCOUNT) or

  • 64 (FREIGHT) or

  • 120 (SALESTAX) or

  • 136 (ADDITIONTOINVOICE)

  • 146 (PERITEM) or

  • 505 (RENTAL)

In loop segment group 7 where FCA010 =

  • 5 (charge to be paid by vendor) or

  • 6 (charge to be paid by customer).

And child segment group 8 where ALC010 =

  • A (allowance) or

  • C (charge)

FCA / ALC / MOA020 where MOA010 =

  • 5 (ADJUSTMENT) or

  • 21 (DISCOUNT) or

  • 64 (FREIGHT) or

  • 120 (SALESTAX) or

  • 136 (ADDITIONTOINVOICE)

  • 146 (PERITEM) or

  • 505 (RENTAL)

In loop segment group 8 where FCA010 =

  • 5 (charge to be paid by vendor) or

  • 6 (charge to be paid by customer).

And child segment group 9 where ALC010 =

  • A (allowance) or

  • C (charge)

      creditChargeAmount string Total amount for the service, promotion, allowance, or charge. MOABETR SAC05 CUX010-020 where CUX010-010 = 1 (charge payment currency) Child of MOA above. CUX010-020 where CUX010-010 = 1 (charge payment currency) Child of MOA above.
      creditChargeCurrencyCode string Currency code for credit or charge CUXWAERZ - MOA010-030 MOA010-030
      qualifyingAmount string Amount qualifying for cash discount, allowance, promotion, service or charge - - - -
      creditChargePercentRate string Percentage rate for cash discount, allowance, promotion, service or charge. - SAC07 - -
      percentRateBasisTypeCode string Code indicating basis that allowance or charge percent is calculated. - SAC06 - -
      creditChargeHandlingCode string

Method of handling for discount or charge. Valid values:

  • ADVANCE
  • BILLBACK
  • CALCULATE
  • CANCELALLOWANCE
  • COLLECT
  • CREDITCUSTOMER
  • CUSTOMERPAID
  • GROSSINVOICED
  • INFORMATION
  • OFFINVOICE
  • OPTIONAL
  • PREPAID
  • RESELLERALLOWANCE
  • TAXNONPAYABLE
  • VENDORALLOWANCE
  • VENDORDENIED
  • VENDORPAID
- SAC12 - -
      description string Description of credit or charge. - SAC15 - -
      unitPriceAmount string Unit price amount. - SAC08 - -
      unitPriceBasisQuantity string Quantity basis for the unit price. - - - -
      itemQuantity string Item quantity. - SAC10 - -
      unitOfMeasure string

Unit or Basis for Measurement Code.

  • 02 – Statute Mile
  • 4G – Microliter
  • AM – Ampoule
  • AV – Capsule
  • BD – Bundle
  • BG – Bag
  • BO – Bottle
  • BX – Box
  • C3 – Centiliter
  • CA – Case
  • CC – Cubic Centimeter
  • CF – Cubic Feet
  • CG – Card, Blister
  • CI – Cubic Inches
  • CL – Cylinder
  • CM – Centimeter
  • CN – Can
  • CP – Crate
  • CQ – Cartridge
  • CR – Cubic Meters
  • CT – Carton
  • DA – Day
  • DI – Dispenser
  • DK – Kilometers
  • DL – Deciliter
  • DM – Decimeter
  • DR – Drum
  • DS – Display
  • DZ – Dozen
  • EA – Each
  • FO – Fluid Ounce
  • FT – Foot
  • GA – Gallon
  • GL – Gram/liter
  • GR – Gram
  • GS – Gross
  • H4 – Hectoliter
  • HF – Hundred Feet
  • HR – Hours
  • IN – Inch
  • K6 – Kiloliters
  • KG – Kilogram
  • KT – Kit
  • LB – Pounds
  • LF – Linear Foot
  • LO – Lot (unit of procurement)
  • LT – Liter
  • LY – Linear Yard
  • MC – Microgram
  • ME – Milligram
  • ML – Milliliter
  • MM – Millimeter
  • MO – Months
  • MR – Meter
  • OZ – Ounces
  • PC – Piece
  • PF – Pallet
  • PK – Package
  • PR – Pair
  • PT – Pint
  • QT – Quart
  • RL – Roll
  • SC – Square Centimeter
  • SF – Square Foot
  • SH – Sheet
  • SI – Square Inch
  • SM – Square Meter
  • ST – Set
  • SY – Square Yard
  • T3 – Thousand Pieces
  • TB – Tube
  • TH – Thousand
  • TY – Tray
  • U2 – Tablet
  • UM – Million
  • UN – Unit
  • V2 – Pouch
  • VI – Vial
  • WK – Week
  • YD – Yard
  • YR – Years

 - SAC09 - -
      baseValue string Base value to which pricing condition refers. SAP pass thru. - - - -
      creditChargeConditionType string Credit or charge condition type. - - - -
    transactionReferenceInformation array Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents. segment E1EDP02 segment CDD-N9 - -
    transactionReferenceType string

Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier.

Valid values:

  • LOTNUMBER

  • LINEITEMNUMBER

  • VENDORNUMBER

  • INTERNALVENDORNUMBER

  • CHANGEREASON

  • STORENUMBER

  • PROMOTIONDEALNUMBER

  • CUSTOM

This list will be added to over time.

QUALF = 079 (LOTNUMBER)

N901 =

  • LT (LOTNUMBER) or

  • LI (LINEITENUMBER) or

  • VR (VENDORNUMBER)

  • IA (INTERNALVENDORNUMBER) or

  • TD (CHANGEREASON) or

  • ST (STORENUMBER) or

  • PD (PROMOTIONDEALNUMBER) or

  • ZZ (CUSTOM)

- -
      transactionReferenceIdentifier - Transaction reference identifier value as defined by enum in transactionReferenceType. BELNR N902 - -
      description - Description for transaction reference. - N903 - -
      transactionReferenceDate - Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. DATUM - - -
      epochTransactionReferenceDate - Transaction reference date and time in EPOCH date time format. - - - -
    mpcDates array Dates relevant for header level of remittance advice or payment order. segment E1EDP03 segment CDD-DTM segment DTM segment DTM
      dateType string

Date type at header level relevant for credit debit adjustment.

Valid values (HDA):

  • EXPIRATION

  • SHIPPED

  • PROCESSING

  • PROMOTIONSTART

  • PROMOTIONEND

  • PROMOTIONORDERSTART

  • PROMOTIONORDEREND

  • PROMOTIONSHIPSTART

  • PROMOTIONSHIPEND

IDDAT =

  • 010 (SHIPPED) or

  • 045 (EXPIRATION)

DTM01 =

  • 011 (SHIPPED) or

  • 036 (EXPIRATION)

DTM010-010 =

  • 11 (SHIPPED) or

  • 36 (EXPIRATION)

DTM010-010 =

  • 11 (SHIPPED) or

  • 36 (EXPIRATION)

      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 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 Ship to party company identifiers and address information. - Loop group 2300 ENT-ADX-NTE - -
      textReferenceCode string Text reference or subject code. Will map whatever is found. - NTE01 - -
      textFunctionCode string Text function code. Will map whatever is found. - - - -
      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. - - - -

Table of contents