Remittance advice APIs
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.
Type = API Reference,; Topic = Multienterprise Information Network Tower (MINT),;Persona = TraceLink Administrator, User,; Orchestration = Manufacturing, Commerce,; Function = Supply Chain, IT, Procurement,
Remittance Advice (X12)
Buyers use remittance advices to notify suppliers of payment confirmation and details for one or more invoices.
Contact your TraceLink Services representative for more information about integrating with this message.
- Message Type: MPC_REMITTANCE_ADVICE (Remittance Advice)
- X12 Format: 820
- Transform Name: B2B_EDI_X12_820_RemittanceAdvice_IB_V2
- Direction: Inbound to TraceLink

Input Element | Occurs | Length | Description | Examplet | |||||
---|---|---|---|---|---|---|---|---|---|
ISA | – | ISA interchange envelope. | – | ||||||
ISA01 | 2/2 | Qualifier for authorization control number in ISA02. | 00 | ||||||
ISA02 | 10/10 | Information used for additional identification or authorization of the interchange sender or the data in the interchange/ 10 spaces a valid entry. | – | ||||||
ISA03 | 2/2 | Qualifier for security information in ISA04. | 00 | ||||||
ISA04 | 10/10 | Identifies security information about the interchange sender or data | – | ||||||
ISA05 | 2/2 |
Interchange sender partner ID qualifier. Valid values:
|
07 | ||||||
ISA06 | 15/15 | Interchange sender identification mapping to fileSenderNumber with party type defined in ISA05. | 7777776067344 | ||||||
ISA07 | 2/2 |
Interchange receiver partner ID qualifier. Valid values:
|
01 | ||||||
ISA08 | 15/15 | Instance 1 EDI receiver ID mapping to file control header and to ServiceLinkId. | 888888404358877 | ||||||
ISA09 | 6/6 | Interchange date in 6 char YYMMDD format | 231020 | ||||||
ISA10 | 4/4 | Interchange time in 4 char HHMM format | 1420 | ||||||
ISA11 | 1/1 |
This value is dependent on X12 version.
|
^ | ||||||
ISA12 | 5/5 | Interchange control version number. This could be any X12 version. | 00501 | ||||||
ISA13 | 9/9 | Interchange Control Number mapping to file control header | 0000000000619827 | ||||||
ISA14 | 1/1 |
Interchange level acknowledgement requested. Valid values:
|
0 | ||||||
ISA15 | 1/1 |
Indicates whether the interchange is for production, test, or information purposes. Valid values:
|
P | ||||||
ISA16 | 1/1 |
Component element separator. Delimiter that separates data elements within a composite data structure. Must be different than the data element separator and segment terminator |
> | ||||||
GS | – | GS group functional envelope. Child of ISA. Only one GS group expected per interchange. | – | ||||||
GS01 | 2/2 | GS group function code. The valid
value is RA - Payment Order/Remittance Advice X12 820. |
RA | ||||||
GS02 | 2/15 | Application sender's code. | 2222224043588 | ||||||
GS03 | 2/15 | Application receiver's code. | TRACELINK | ||||||
GS04 | 8/8 | Current date stamp in 8 char X12 date format YYYYMMDD. | 20301020 | ||||||
GS05 | 4/8 | Current time stamp in 6 char X12 time format HHMMSS. | 142000 | ||||||
GS06 | 1/9 | Group control ID number. | 619827 | ||||||
GS07 | 1/2 |
Responsible Agency Code. Valid values:
|
X | ||||||
GS08 | 1/12 | X12 message version code. This could be any X12 version. | 005010 | ||||||
ST | – | ST transaction set envelope. Child of GS group. Only one ST transaction expected. | – | ||||||
ST01 | 3/3 | Transaction set identifier code. | 820 | ||||||
ST02 | 4/9 | Transaction set ID number. Counter for each ST segment beginning with 1. | 0001 | ||||||
BPR | – |
Remittance advice beginning segment. Note: there is no transaction identifier in BPR. |
– | ||||||
BPR01 | 1/2 |
Transaction handling code specifying the action to be taken by all parties. Valid values:
|
I | ||||||
BPR02 | 1/18 | Amount of payment in remittance advice. | 4023567.26 | ||||||
BPR03 | 1/1 |
Credit or debit flag specifying the amount as a credit or debit. Valid values:
|
C | ||||||
BPR04 | '3/3 |
Payment method code. Valid values:
|
CHK | ||||||
BPR05 | 1/10 | Payment format code identifying the payment format to be used. Pass thru mapping for X12. | ARC | ||||||
BPR06 | 2/2 |
Depository financial institution (bank) identifier type code for the paying party. Valid values:
|
SWIFT | ||||||
BPR07 | 3/12 | Depository financial institution (bank) identifier value for the paying party. | 002356874148 | ||||||
BPR08 | 1/3 | Account identifier type for the paying party. X12 pass thru. No account type in IDoc or EDIFACT. | 03 | ||||||
BPR09 | 1/35 | Account identifier code for the paying party. | 0025841269 | ||||||
BPR10 | 1/10 | Originating company identifier code (paying party). X12 pass thru. | 123456 | ||||||
BPR11 | 9/9 | Originating company supplemental identifier code (paying party). X12 pass thru. | – | ||||||
BPR12 | 2/2 |
Depository financial institution (bank) identifier type code for the receiving payee party. Valid values:
|
SWIFT | ||||||
BPR13 | 3/12 | Depository financial institution (bank) identifier value for the receiving payee party. | 002356874148 | ||||||
BPR14 | 1/3 | Account identifier type for the receiving payee party. X12 pass thru. No account type in IDoc or EDIFACT. | 03 | ||||||
BPR15 | 1/35 | Account identifier code for the receiving payee party. | 0045872560 | ||||||
BPR16 | 8/8 | Payment date mapping to canonical header in date format YYYYMMDD. | 20240628 | ||||||
BPR17 | 1/3 | Business function code. Pass thru mapping for X12. | VEN | ||||||
TRN | – | TRN trace segment recording reference document identifier for Remittance Advice | – | ||||||
TRN01 | 1/2 |
Trace type code qualifying identifier value in TRN02. Valid values:
|
1 | ||||||
TRN02 | 1/80 | Transaction trace reference document identification value for Remittance Advice as qualified by TRN01 mapping to canonical header.transactionReferenceIdentifierList group. Required for TL internal system processing. | 002621337 | ||||||
TRN03 | 10/10 | Originating -- paying -- company identifier | – | ||||||
TRN04 | 1/80 | Additional reference document identification value as qualified by TRN01. | – | ||||||
CUR | – | Currency code info for payment record in Remittance Advice. | – | ||||||
CUR01 | 2/3 | Entity identifier code, for an
organization, physical location, property or individual for use of the
currency. The valid value is PR - Payer currency. |
PR | ||||||
CUR02 | 3/3 | Standard ISO currency code for the country in which the payments are specified. | USD | ||||||
CUR03 | 4/10 | Exchange rate value to be used as a multiplier conversion factor to convert monetary value from one currency to another | – | ||||||
REF | – | REF reference segment for mapping to the check number. | – | ||||||
REF01 | 2/3 |
Reference identification qualifier for the check number. Valid value:
|
CK | ||||||
REF02 | 1/80 |
Reference identifier value.
|
002621337 | ||||||
DTM | – | DTM date segment for mapping to the processing date | – | ||||||
DTM01 | 3/3 |
Date type qualifier for the processing date. Valid value:
|
009 | ||||||
DTM02 | 8/8 | Processing date in date format YYYYMMDD | 20240628 | ||||||
DTM03 | 4/8 | Processing time in time format HHMMSS | 123422 | ||||||
N1 | – |
Name segment loop for
|
– | ||||||
N101 | 2/3 |
Entity qualifier for the bill to party identifier and address information. Valid values:
|
BT | ||||||
N102 | 1/60 | Name | Pharma customer | ||||||
N103 | 1/2 |
Identifier code qualifier. ![]()
|
UL | ||||||
N104 | 2/80 | Bill to party identifier as qualified by N103 mapping to companyIdentifierValue. | 3333331013655 | ||||||
N3 | – | N3: Address: Child of warehouse party N1 name segment. | – | ||||||
N301 | 1/55 | Street address 1 | 555 Neelan Road | ||||||
N302 | 1/55 | Street address 2 | Suite 123 | ||||||
N4 | – | N4: Geographic Location. Child of warehouse party N1 name segment. | – | ||||||
N401 | 2/30 | City name | Sacramento | ||||||
N402 | 2/2 | State or province code. Code (Standard state/province) as defined by appropriate government agency | CA | ||||||
N403 | 3/15 | Postal code. Code defining international postal zone code excluding punctuation and blanks. | 95833 | ||||||
N404 | 2/3 | Country code | US | ||||||
PER | – | Contact Information. | – | ||||||
PER01 | 2/2 | Contact function code identifying
major duty or responsibility of person or group named as contact. The valid
value is AJ - Primary contact. |
AJ | ||||||
PER02 | 1/40 | Name of the contact person responsible for authenticating the pedigree information. | John Smith | ||||||
PER03 | 2/2 |
Communication Number Qualifier identifying the contact person's telephone number or email address. Valid values:
|
TE | ||||||
PER04 | 11/20 | Communication number: Telephone number of the contact person expected in this field. | +1.516.747.6849 | ||||||
PER04 | 11/20 | Communication number: Email address of the contact person. | jsmith@manufac.com | ||||||
PER05 | 2/2 |
Communication Number Qualifier identifying the contact person's telephone number or email address. Valid values:
|
EM | ||||||
PER06 | 6/50 | Communication numbe: Email address for the contact person expected in this field. | jsmith@manufac.com | ||||||
PER06 | 6/50 | Communication number: Telephone number of the contact person. | +1.516.747.6849 | ||||||
ENT | – | Entity payment loop 2000 for consolidated payments. | – | ||||||
ENT01 | 1/6 |
Assigned number for entity. This may appear only once or it may appear more than once, depending on the requirements of the recipient. It may be hard coded to 1 or it may represent some specific identifier required by a recipient. We will map whatever we find. |
1 | ||||||
ADX | – |
Standalone adjustment loop. Adjustments with reason codes but without reference to an invoice. |
– | ||||||
ADX01 | 1/18 | Monetary amount of adjustment. | –25.45 | ||||||
ADX02 | 2/2 | Adjustment reason code. Pass thru mapping to canonical. | 02 | ||||||
ADX03 | 2/3 |
Reference identification qualifier. Valid values:
|
CM | ||||||
ADX04 | 1/80 | Reference document identification value as qualified by ADX03. | 2194761 | ||||||
NTE | – | Note or special instruction about the standalone adjustment in ENT-ADX loop group 2300. | – | ||||||
NTE01 | 3/3 | Note reference code. | – | ||||||
NTE02 | 1/80 | Description, free text. | – | ||||||
REF | – | REF reference segment loop for standalone adjustment in ENT-ADX loop group 2300. | – | ||||||
REF01 | 2/3 |
Reference identification qualifier for the referenced document for the standalone adjustment in the ENT-ADX loop. Valid values:
|
PO | ||||||
REF02 | 1/80 | Reference identifier value: check number | 4500018486 | ||||||
DTM | – | DTM date segment for standalone adjustment in ENT-ADX loop group 2300. | – | ||||||
DTM01 | 3/3 |
Date type qualifier for the standalone adjustment in the ENT-ADX loop. Valid values:
|
003 | ||||||
DTM02 | 8/8 | Processing date in date format YYYYMMDD | 20240628 | ||||||
DTM03 | 4/8 | Processing time in time format HHMMSS. | 123422 | ||||||
RMR | – | Remittance advice accounts receivable open items reference in ENT-RMR loop 2400. | – | ||||||
RMR01 | 2/3 |
Reference identification qualifier. Valid values:
One of the top 3 invoice enumerations most likely to appear in RMR01. |
IK | ||||||
RMR02 | 1/80 | Reference document identifier as defined by RMR01. | 3629621 | ||||||
RMR03 | 2/2 |
Payment action code. Valid values:
|
PO | ||||||
RMR04 | 1/18 | Amount paid against referenced document. | 12547.25 | ||||||
RMR05 | 1/18 | Total amount invoiced. | 12600.00 | ||||||
RMR06 | 1/18 | Amount of discount | 52.75 | ||||||
REF | – | REF reference segment loop for standalone adjustment in ENT-RMR loop 2400. | – | ||||||
REF01 | 2/3 |
Reference identification qualifier for the referenced document for the standalone adjustment in the ENT-ADX loop. Valid values:
|
PO | ||||||
REF02 | 1/80 | Reference identifier value: check number | 002621337 | ||||||
DTM | – | DTM date segment for standalone adjustment in ENT-RMR loop 2400. | – | ||||||
DTM01 | 3/3 |
Date type qualifier for the standalone adjustment in the ENT-ADX loop. Valid values:
|
004 | ||||||
DTM02 | 8/8 | Processing date in date format YYYYMMDD | 20240628 | ||||||
DTM03 | 4/8 | Processing time in time format HHMMSS | 123422 | ||||||
ADX | – | ADX adjustments looping group 2420 within ENT-RMR 2400 loop, referencing invoice or other document identified in RMR01 and RMR02. | – | ||||||
ADX01 | 1/18 | Monetary amount of adjustment. | -25.45 | ||||||
ADX02 | 2/2 | Adjustment reason code. Pass thru mapping to canonical. | 02 | ||||||
ADX03 | 2/3 |
Reference identification qualifier. Valid values:
|
CM | ||||||
ADX04 | 1/80 | Reference document identification value as qualified by ADX03. | 2194761 | ||||||
NTE | – | Note or special instruction about the standalone adjustment in ENT-RMR-ADX loop group 2400. | – | ||||||
NTE01 | 3/3 | Note reference code. | – | ||||||
NTE02 | 1/80 | Description, free text | – | ||||||
REF | – | REF reference segment loop for standalone adjustment in ENT-RMR-ADX looping group 2400-2420. | – | ||||||
REF01 | 2/3 |
Reference identification qualifier for the referenced document for the standalone adjustment in the ENT-ADX loop. Valid values:
|
PO | ||||||
REF02 | 1/80 | Reference identifier value: check number | 002621337 | ||||||
SE | – | ST … SE transaction set trailer envelope. Child of GS group. Only one ST transaction expected. | – | ||||||
SE01 | 1/10 | Total count of segments in ST … SE transaction set including ST and SE segments. | 10 | ||||||
SE02 | 4/9 | Transaction set control number | 0001 | ||||||
GE | – | GS … GE functional group trailer envelope. Child of ISA interchange. Only one GS group expected. | – | ||||||
GE01 | 1/6 | Number of transaction sets in functional group | 5 | ||||||
GE02 | 1/9 | Functional group control number | 619827 | ||||||
IEA | – | ISA … IEA interchange control trailer envelope. Only one interchange expected per transmission. | – | ||||||
IEA01 | 1/5 | Number of functional groups in interchange. | 1 | ||||||
IEA02 | 9/9 | Interchange control number | 0000000000619827 |

ISA*00* *00* *01*7777776067344
*01*888888404358877*240424*1511*^*00501*000619827*0*P*>
GS*RA*2222224043588*TRACELINK*20240424*151112*619827*X*005010
ST*820*0001
BPR*I*4023567.26*C*CHK*ARC*01*002356874148*ANN*0025841269*1234567890*bpr126789*01*0
02356870099*03*0045872560*20240424*VEN
TRN*1*002621337*8965432712*Additional reference document identification value as
qualified by TRN01
CUR*PR*USD*4011
REF*CK*s44
DTM*020*20240421*161114
N1*BT*BT Pharma Customer*1*3333331013655
N3*555 Neelan Road*Suite123
N4*Sacramento*CA*95833*US
PER*AJ*John Smith*TE*+1.516.747.6849*EM*jsmith@manufac.com
N1*PR*PR Wholesale Inc*1*3333331013666
N3*556 Neelan Road*Suite456
N4*Sacramento*CA*95844*US
PER*AJ*Derek Smith*EM*derek@abc.com*TE*12344567890
N1*PE*PE Pharma supplier*1*8568745
N3*557 Neelam Road*Suite789
N4*Sacramento*CA*95855*US
PER*AJ*RemitTo*EM*remitto@email.com*TE*1-444-444-4444
ENT*90
ADX*-91.06*02*CM*2194761
NTE*AAA*Description, free text No 1
REF*PO*4500018486
DTM*003*20240524*154112
RMR*OI*3629621*PO*12547.25*12600.00*52.75
REF*6O*002621337
REF*LT*002621338
DTM*004*20240628*151112
SE*29*0001
GE*5*619827
IEA*1*000619827
Tag end
Type = API Reference,; Topic = Multienterprise Information Network Tower (MINT),;Persona = TraceLink Administrator, User,; Orchestration = Manufacturing, Commerce,; Function = Supply Chain, IT, Procurement,
Remittance Advice (IDoc)
Buyers use remittance advices to notify suppliers of payment confirmation and details for one or more invoices.
Contact your TraceLink Services representative for more information about integrating with this message.
- Message Type: MPC_REMITTANCE_ADVICE (Remittance Advice)
- IDoc Format: REMADV.PEXR2003
- Transform Name: B2B_IDoc_REMADV_PEXR2003_RemittanceAdvice_OB_V2
- Direction: Outbound from TraceLink
Tag end