SAP IDoc Interface Specification Document Template
A good interface specification prevents the argument that starts when the first IDoc fails in production. This template gives you a structured document for an IDoc-based interface that you can fill in, export and send for sign-off.
Fill in
SAP IDoc Interface Specification Document Template
Document control
| Item | Value |
|---|---|
| Interface ID | INT-SD-014 |
| Name | Customer sales orders to SAP S/4HANA |
| Business owner | Head of Order Management |
| Author | Integration developer |
| Date | 2026-10-20 |
1. Purpose and scope
This document specifies interface INT-SD-014, Customer sales orders to SAP S/4HANA. Direction: Inbound to SAP. Partner: Customer EDI platform via middleware.
In scope: the message flow described below. Out of scope: changes to the partner system and any master data replication not listed here.
2. IDoc definition
| Attribute | Value |
|---|---|
| Message type | ORDERS |
| Basic IDoc type | ORDERS05 |
| Process code or function module | To be confirmed in WE42 |
| Partner profile (WE20) | Partner number, type and role to be documented |
| Port (WE21) | To be documented |
3. Volume and timing
Expected volume: About 3,000 IDocs per day, peak 800 per hour.
Frequency and schedule: Near real time, processed every 5 minutes in background.
4. Field mapping summary
| Source field | IDoc segment and field | Rule or conversion | Mandatory |
|---|---|---|---|
5. Error handling and monitoring
Failed IDocs (status 51) reported daily to the order desk. Mapping errors corrected at source and resent. Application errors reprocessed through BD87 after the cause is fixed.
Monitoring: WE02 or WE05 for IDoc status, BD87 for reprocessing. Alert owner and escalation path to be named.
6. Security and compliance
Secured transport between middleware and SAP. Technical user with only the authorizations needed for the inbound process. No personal data stored outside SAP.
7. Test scenarios
| No. | Scenario | Expected result | Status |
|---|---|---|---|
| 1 | Valid message, all mandatory fields | IDoc status 53, document created | |
| 2 | Unknown partner or missing master data | IDoc status 51 with clear message | |
| 3 | Duplicate message | Handled per duplicate rule | |
| 4 | Peak volume run | No backlog beyond agreed time |
Approvals
Starting point to adapt to your project standards. Replace placeholders in the mapping and partner profile sections with the details of your own system and confirm names and process codes in your SAP release.
Interface documentation automation
Optional: discuss generating interface documentation from your live SAP configuration.
Optional. The tool and every export work without this. No spam.
How to use the template
Complete the fields for one interface, then export. Each interface should have its own document with a unique ID, a named business owner, and a clear direction. Fill the IDoc definition from WE30 and WE81 in your system, and the partner profile and port from WE20 and WE21. Then complete the mapping table with one row per target field, including the conversion rule.
- One document per interface, not per project.
- Name an owner on the business side, not only IT.
- Attach sample payloads and an IDoc from WE19 test runs.
What the sections cover
Purpose and scope fix what the interface does and does not do. The IDoc definition identifies the message type, basic type and process code that decide how SAP handles the message. Volume and timing feed sizing and scheduling. The mapping section is where most defects originate, so require a rule for every mandatory field. Error handling and monitoring state who is told when status 51 or another error appears and what they do about it.
Review checklist
Before sign-off, confirm the process code exists in WE42 and is assigned to the message type, the partner profile has the correct inbound or outbound parameters, and test scenarios include failure cases as well as success. Check that a duplicate message does not create a second document, that authorizations are limited, and that volume assumptions match what the processing capacity can handle.
Common mistakes
Specs that describe only the happy path produce interfaces that nobody knows how to support. Others copy the IDoc structure but omit conversion rules, so each developer guesses unit-of-measure, plant and currency handling differently. Finally, many specs never name who monitors the interface after go-live, leaving errors to age in the IDoc monitor.
Frequently Asked Questions
What should an IDoc interface spec include?
Purpose, direction, partner, message and basic IDoc type, process code, volume and schedule, field mapping with conversion rules, error handling, monitoring, security and test cases. Add sample payloads as attachments.
Where do I find the basic IDoc type definition?
Use WE30 to display the IDoc type and its segments, and WE81 and WE82 to see message types and their assignment to IDoc types. WE60 provides generated documentation.
Is this a legal or contractual document?
No. It is a technical and functional specification template. If it forms part of a contract with a partner or vendor, have the contractual wording reviewed separately.
Can I use it for non-IDoc interfaces?
Yes with small edits. Replace the IDoc definition section with the service, API or function module details and keep the rest, which applies to any integration.
If you want interface specifications generated from your actual partner profiles and IDoc metadata rather than typed by hand, Netray can build that as a read-only assistant for your team.
Related Tools
SAP IDoc Error Backlog Clearance Calculator
Plan the cleanup of failed IDocs: how many can be reprocessed in bulk after a root-cause fix, how many need hands-on work, and how long it takes.
SAPSAP IDoc Database Growth Calculator
Estimate IDoc table growth from daily volume, segments per IDoc and retention days, and see when archiving pays off.
SAPSAP Interface Retry and Backoff Window Calculator
See how long an interface keeps retrying before it gives up, using initial delay, multiplier, retry count and jitter.
SAPSAP IDoc Processing Work Process Sizing Calculator
Work out how many work processes inbound IDoc processing needs at peak, and what throughput your current setup can sustain.
More SAP tools
See all- SAP Sales Document Types Reference
- SAP Pricing Procedure Design Worksheet
- SAP Item Category Determination Reference
- SAP Delivery Block Reasons Template
- SAP Credit Management Checklist
- SAP Output Determination Checklist
- SAP Billing Types Reference
- SAP Incompletion Log Checklist
- SAP SD Tables Reference (VBAK, VBAP, LIKP, VBRK and More)