RETANN (Return Announcement)
The Return message intent is to exchange information related to returns
General usage
- The message includes functionality to differentiate classes of returns, and to permit financial valuation of returns facilitating price protection claims, auditing, statutory declarations, etc.
Name | Required | Description | Examples | Xpath | Type | Limits | Sort | Id |
---|---|---|---|---|---|---|---|---|
EDI message name | The name of the EDI message |
|
/b24Message/returnAnnouncement/@text | Text | 1000 | 1 | ||
Environment | Environment/test indicator - either "Production" or "Test" |
|
/b24Message/returnAnnouncement/@environment | Text | 1100 | 2 | ||
Currency | The currency in which the price information in the order is specified |
|
/b24Message/returnAnnouncement/@currency | Text | 1200 | 3 | ||
Btwentyfour message ID | Message ID set by Btwentyfour Open Commerce Platform. |
|
/b24Message/returnAnnouncement/@messageId | Number | 1300 | 4 | ||
Btwentyfour message date | Message date set by Btwentyfour Open Commerce Platform. |
|
/b24Message/returnAnnouncement/@messageDate | Date/Time | 1400 | 5 | ||
Sender | Yes | The sender of the EDI message, identified by a GLN |
|
/b24Message/returnAnnouncement/sender/@gln | Number | 1500 | 6 | |
Recipient | Yes | The recipient of the EDI message, identified by a GLN |
|
/b24Message/returnAnnouncement/recipient/@gln | Number | 1600 | 7 | |
Return Announcement number | Yes | The ID of the return announcement, set by the sender |
|
/b24Message/returnAnnouncement/documentReference[@documentType="ReturnAnnouncement"]/@id | Text | 1700 | 8 | |
Return Announcement date | Yes | The date of the return announcement, set by the sender |
|
/b24Message/returnAnnouncement/documentReference[@documentType="ReturnAnnouncement"]/@date | Date/Time | 1800 | 9 | |
Buyer order number | The purchase order number set by the buyer |
|
/b24Message/returnAnnouncement/documentReference[@documentType="BuyerOrder"]/@id | Text | 1900 | 10 | ||
Order date | The purchase order date set by the buyer |
|
/b24Message/returnAnnouncement/documentReference[@documentType="BuyerOrder"]/@date | Date/Time | 2000 | 11 | ||
Despatch advice identification | The despatch advice number set by the supplier |
|
/b24Message/returnAnnouncement/documentReference[@documentType="DespatchAdvice"]/@id | Text | 2100 | 12 | ||
Despatch advice date | The despatch advice date set by the supplier |
|
/b24Message/returnAnnouncement/documentReference[@documentType="DespatchAdvice"]/@date | Date/Time | 2200 | 13 | ||
Delivery note number | The delivery note number set by the supplier |
|
/b24Message/returnAnnouncement/documentReference[@documentType="DeliveryNote"]/@id | Text | 2300 | 14 | ||
Delivery note date | The delivery note date set by the supplier |
|
/b24Message/returnAnnouncement/documentReference[@documentType="DeliveryNote"]/@date | Date/Time | 2400 | 15 | ||
Agreement Number | The reference number/ID of an agreement |
|
/b24Message/returnAnnouncement/documentReference[@documentType="AgreementNumber"]/@id | Text | 2500 | 16 | ||
Agreement date | The reference date of an agreement |
|
/b24Message/returnAnnouncement/documentReference[@documentType="AgreementNumber"]/@date | Date/Time | 2600 | 17 | ||
Delivery date | The date when the goods were delivered |
|
/b24Message/returnAnnouncement/property[@name="deliveryDate"] | Date/Time | 2700 | 18 | ||
Earliest collection date | The collection date, earliest |
|
/b24Message/returnAnnouncement/property[@name="earliestCollectionDate"] | Date/Time | 2800 | 19 | ||
Latest collection date | The collection date, latest |
|
/b24Message/returnAnnouncement/property[@name="latestCollectionDate"] | Date/Time | 2900 | 20 | ||
Supplier GLN | Yes | The supplier/brand, identified by a GLN |
|
/b24Message/returnAnnouncement/supplier/@gln | Number | 3000 | 21 | |
Supplier Name | Name of the supplier party |
|
/b24Message/returnAnnouncement/supplier/@name | Text | 3100 | 22 | ||
Supplier Org Number | Corporate identity number of the supplier party |
|
/b24Message/returnAnnouncement/supplier/@orgNo | Text | 3200 | 23 | ||
Supplier VAT number | VAT number (value added tax number) of the supplier party |
|
/b24Message/returnAnnouncement/supplier/@vatNo | Text | 3300 | 24 | ||
Supplier Contact | Name of a contact person |
|
/b24Message/returnAnnouncement/supplier/@contact | Text | 3400 | 25 | ||
Supplier Address | Address of the supplier party |
|
/b24Message/returnAnnouncement/supplier/location/address | Text | 3500 | 26 | ||
Supplier Zip Code | Zip code of the supplier party |
|
/b24Message/returnAnnouncement/supplier/location/city/@code | Text | 3600 | 27 | ||
Supplier City | City of the supplier party |
|
/b24Message/returnAnnouncement/supplier/location/city | Text | 3700 | 28 | ||
Supplier Country | Country of the supplier party |
|
/b24Message/returnAnnouncement/supplier/location/country | Text | 3800 | 29 | ||
Supplier Country Code | Country code of the supplier party |
|
/b24Message/returnAnnouncement/supplier/location/country/@code | Text | 3900 | 30 | ||
Supplier Phone number | Telephone number of the contact person |
|
/b24Message/returnAnnouncement/supplier/location/telephoneNumber | Number | 4000 | 31 | ||
Supplier Email | An e-mail address of the contact person |
|
/b24Message/returnAnnouncement/supplier/location/emailAddress | Text | 4100 | 32 | ||
Supplier external ID | External identifier, set by sender of the message |
|
/b24Message/returnAnnouncement/supplier/property[@name="id"] | Text | 4200 | 33 | ||
Supplier internal ID | Internal identifier, mapped in the Btwentyfour Open Commerce Platform. |
|
/b24Message/returnAnnouncement/supplier/property[@name="internalId"] | Text | 4300 | 34 | ||
Supplier Name 2 | A second name field for the supplier party |
|
/b24Message/returnAnnouncement/supplier/property[@name="name2"] | Text | 4400 | 35 | ||
Buyer GLN | Yes | The buying party, identified by a GLN |
|
/b24Message/returnAnnouncement/buyer/@gln | Number | 4500 | 36 | |
Buyer Name | Name of the buyer party |
|
/b24Message/returnAnnouncement/buyer/@name | Text | 4600 | 37 | ||
Buyer Address | Address of the buyer party |
|
/b24Message/returnAnnouncement/buyer/location/address | Text | 4700 | 38 | ||
Buyer Zip Code | Zip code of the buyer party |
|
/b24Message/returnAnnouncement/buyer/location/city/@code | Text | 4800 | 39 | ||
Buyer City | City of the buyer party |
|
/b24Message/returnAnnouncement/buyer/location/city | Text | 4900 | 40 | ||
Buyer State | State of the buyer party |
|
/b24Message/returnAnnouncement/buyer/location/state | Text | 5000 | 41 | ||
Buyer State Code | State code of the buyer party |
|
/b24Message/returnAnnouncement/buyer/location/state/@code | Text | 5100 | 42 | ||
Buyer Country | Country of the buyer party |
|
/b24Message/returnAnnouncement/buyer/location/country | Text | 5200 | 43 | ||
Buyer Country Code | Country code of the buyer party |
|
/b24Message/returnAnnouncement/buyer/location/country/@code | Text | 5300 | 44 | ||
Buyer Phone number | Telephone number of the contact person |
|
/b24Message/returnAnnouncement/buyer/location/telephoneNumber | Number | 5400 | 45 | ||
Buyer Email | An e-mail address of the contact person |
|
/b24Message/returnAnnouncement/buyer/location/emailAddress | Text | 5500 | 46 | ||
Buyer external ID | External identifier, set by sender of the message |
|
/b24Message/returnAnnouncement/buyer/property[@name="id"] | Text | 5600 | 47 | ||
Buyer internal ID | Internal identifier, mapped in the Btwentyfour Open Commerce Platform. |
|
/b24Message/returnAnnouncement/buyer/property[@name="internalId"] | Text | 5700 | 48 | ||
Buyer Name 2 | A second name field for the buyer party |
|
/b24Message/returnAnnouncement/buyer/property[@name="name2"] | Text | 5800 | 49 | ||
Site GLN | The site/store location party, identified by a GLN |
|
/b24Message/returnAnnouncement/site/@gln | Number | 5900 | 50 | ||
Site Name | Name of the site party |
|
/b24Message/returnAnnouncement/site/@name | Text | 6000 | 51 | ||
Site Address | Address of the site party |
|
/b24Message/returnAnnouncement/site/location/address | Text | 6100 | 52 | ||
Site Zip Code | Zip code of the site party |
|
/b24Message/returnAnnouncement/site/location/city/@code | Text | 6200 | 53 | ||
Site City | City of the site party |
|
/b24Message/returnAnnouncement/site/location/city | Text | 6300 | 54 | ||
Site State | State of the site party |
|
/b24Message/returnAnnouncement/site/location/state | Text | 6400 | 55 | ||
Site State Code | State code of the site party |
|
/b24Message/returnAnnouncement/site/location/state/@code | Text | 6500 | 56 | ||
Site Country | Country of the site party |
|
/b24Message/returnAnnouncement/site/location/country | Text | 6600 | 57 | ||
Site Country Code | Country code of the site party |
|
/b24Message/returnAnnouncement/site/location/country/@code | Text | 6700 | 58 | ||
Site Phone number | Telephone number of the contact person |
|
/b24Message/returnAnnouncement/site/location/telephoneNumber | Number | 6800 | 59 | ||
Site Email | An e-mail address of the contact person |
|
/b24Message/returnAnnouncement/site/location/emailAddress | Text | 6900 | 60 | ||
Site external ID | External identifier, set by sender of the message |
|
/b24Message/returnAnnouncement/site/property[@name="id"] | Text | 7000 | 61 | ||
Site internal ID | Internal identifier, mapped in the Btwentyfour Open Commerce Platform. |
|
/b24Message/returnAnnouncement/site/property[@name="internalId"] | Text | 7100 | 62 | ||
Site Name 2 | A second name field for the site party |
|
/b24Message/returnAnnouncement/site/property[@name="name2"] | Text | 7200 | 63 | ||
Supplier Item ID | The supplier's unique item ID of the product |
|
/b24Message/returnAnnouncement/item/@id | Text | 7300 | 64 | ||
Return announcement line number | The return announcement line number |
|
/b24Message/returnAnnouncement/item/documentReference[@documentType="ReturnAnnouncement"]/@lineNo | Text | 7400 | 65 | ||
Article description | The supplier's article description |
|
/b24Message/returnAnnouncement/item/property[@name="description"] | Text | 7500 | 66 | ||
Unit of measure | Unit of measure |
|
/b24Message/returnAnnouncement/item/@unitOfMeasure | Text | 7600 | 67 | ||
Barcode with type | Yes | The supplier's EAN/UPC code of the product |
|
/b24Message/returnAnnouncement/item/itemReference[@registry="Supplier" and @coding="barcodeType"] | Number | 7700 | 68 | |
Buyer Item id | The buyer's unique item ID of the product |
|
/b24Message/returnAnnouncement/item/itemReference[@registry="Buyer" and @name="itemId"] | Text | 7800 | 69 | ||
Net price with currency | The net price of the product |
|
/b24Message/returnAnnouncement/item/price[@type="netPrice"]/@value and @currency | Number | 7900 | 70 | ||
Gross price with currency | The gross price of the product |
|
/b24Message/returnAnnouncement/item/price[@type="grossPrice"]/@value and @currency | Number | 8000 | 71 | ||
Discount percentage | The discount percentage for the product |
|
/b24Message/returnAnnouncement/item/price[@type="discountPercentage"]/@value | Number | 8100 | 72 | ||
Discount amount | The discount amount for the product |
|
/b24Message/returnAnnouncement/item/price[@type="discountAmount"]/@value | Number | 8200 | 73 | ||
Quantity Return | Yes | The quantity of the item |
|
/b24Message/returnAnnouncement/item/quantity[@type="Return" and @value] | Number | 8300 | 74 | |
Reason | Yes | Reason for return |
|
/b24Message/returnAnnouncement/item/quantity/quantityReason[@code & @value] | Text | 8400 | 75 |