Technical
description scope-document
Scope Standard Document Archive Interface
Document Change History
| Date | Change |
|---|---|
| 2026-03-16 | Corrected House Bill of Lading document descriptions |
| 2025-03-15 | Added new CH customs documents |
| 2025-03-04 | Added new documents to section Uploaded Documents |
| 2025-02-05 | Added ATLAS customs document ‘Komprimierter Ausdruck Bescheid/Befund’ |
| 2024-12-06 | Section Uploaded Documents revised |
| 2024-02-08 | Update to the new interface version 2.3 |
Description
The Scope Document Archive interface enables the export of selected documents, either produced within or uploaded to Scope, to an external document archive. To facilitate indexing in the document archive, each document is exported along with associated metadata.
The metadata available for a document is determined by its document class, which corresponds to the base entity in Scope to which the document is associated. Scope categorizes documents into the following classes:
- Invoice
- Shipment
- Customs
- Quotation
The document class of an uploaded file is defined by the entity to which it is uploaded. For instance, a document uploaded on a shipment will be exported through the Document Archive interface with the metadata corresponding to the shipment document class.
Documents to be Archived
The documents to be exported to a document archive can be configured in Scope. The followings sections list all document types that are supported by this interface.
Invoice
The following invoice related documents are exported for finalized or cancelled invoices by the interface as only finalized invoices are complete and in a consistent state. Documents uploaded before the invoice finalization are exported automatically at the time of finalization.
| Scope Document | <subType> in Document Message |
|---|---|
| Outgoing Invoice / Ausgangsrechung | accountsReceivable |
| Outgoing Invoice Cancellation / Storno Ausgangsrechung | accountsReceivableCancellation |
| Outgoing Credit Note / Ausgangsgutschrift | accountsReceivableCreditNote |
| Outgoing Credit Note Cancellation / Storno Ausgangsgutschrift | accountsReceivableCreditNoteCancellation |
| Aggregated Invoice / Sammelrechnung | aggregatedAccountsReceivable |
| Aggregated Invoice Cancellation / Storno Sammelrechnung | aggregatedAccountsReceivableCancellation |
| Aggregated Credit Note / Sammelgutschrift | aggregatedAccountsReceivableCreditNote |
| Aggregated Credit Note Cancellation / Storno Sammelgutschrift | aggregatedAccountsReceivableCreditNoteCancellation |
| Incoming Invoice / Eingangsrechnung | accountsPayable |
| Incoming Invoice Cancellation / Eingangsrechnung Storno | accountsPayableCancellation |
| Incoming Credit Note / Eingangsgutschrift | accountsPayableCreditNote |
| Incoming Credit Note Cancellation / Eingangsgutschrift Storno | accountsPayableCreditNoteCancellation |
| Accounting Invoice / Buchhaltungsbeleg | accountingInvoice |
The following metadata are available for invoice related documents.
- Branch
- User ID
- Invoice type
- Invoice number
- In case of cancellation: The finalization invoice number
- In case of incoming invoices: External number
- Invoice date
- Economic date
- Invoice party (incl. address)
- Subledger account number
- Total amount
- Net amount
- Tax amount
- Exchange rate (into local currency of branch)
- Cost center(s)
- Shipment number(s)
- Transport document number(s)
- House document number(s)
Shipment / Booking
The following shipment related documents are exported by the interface.
| Scope Document | <subType> in Document Message |
|---|---|
| File cover / Aktendeckel | fileCover |
| Booking Confirmation / Buchungsbestätigung | bookingConfirmation |
| Export Declaration / Ausfuhrbescheinigung | exportDeclaration |
| Shipping Instructions / B/L Instruktionen | shippingInstructions |
| Export FOB Delivery / FOB-Andienung | fobDelivery |
| Export Container Release / Container Freistellung | containerRelease |
| B/L Instructions / B/L Instruktionen | blInstructions |
| House Bill of Lading Original (incl. combined and customized versions) House Bill of Lading Original (inkl. kombinierte und kundenspezifische Varianten) |
houseBillOfLadingOriginal |
| House Bill of Lading Copy (incl. combined and customized versions) House Bill of Lading Kopie (inkl. kombinierte und kundenspezifische Varianten) |
houseBillOfLadingCopy |
| House Bill of Lading Draft (incl. combined and customized versions) House Bill of Lading Entwurf (inkl. kombinierte und kundenspezifische Varianten) |
houseBillOfLadingDraftCopy |
| Fiata FCR | fiataFCROriginal |
| fiataFCRCopy | |
| fiataFCRDraftCopy | |
| fiataFCRAttachment | |
| Airwaybill | carrierAirWayBill |
| carrierAirWayBillShipper | |
| carrierAirWayBillConsignee | |
| carrierAirWayBillShipperComplete | |
| carrierAirWayBillConsigneeComplete | |
| IATA AWB Shipper Delivery Note | carrierShipperDeliveryNote |
| IATA AWB e-freight Pouch | carrierEfreightPouch |
| House Airwaybill | houseAirWayBill |
| houseAirWayBillShipper | |
| houseAirWayBillConsignee | |
| houseAirWayBillShipperComplete | |
| houseAirWayBillConsigneeComplete | |
| House AWB Shipper Delivery Note | houseShipperDeliveryNote |
| House AWB e-freight Pouch | houseEfreightPouch |
| AirCargo Manifest | cargoManifest |
| MRN Manifest | mrnManifest |
| Customs Manifest | customsManifest |
| Preadvice/-alert | preAdvice |
| Shipping Advise / Versandbenachrichtigung (Versand-Avise) | shippingAdvice |
| Claim Notification / Haftbarhaltung | claimNotification |
| Liner Agent Booking / Liner-Agent-Buchung | bookingLinerAgent |
| Consol Manifest | consolManifest |
| Clearing Instructions / Verzollungsinstruktionen | customsInstructions |
| Release Order / Freistellung | releaseOrder |
| Notice of Arrival / Ankunftsavis | arrivalNotice |
| Delivery Note / Auslieferschein | deliveryNote |
| Container Unloading List / Container Entladeliste | containerUnloadingList |
| Truck Manifest / Truckmanifest | truckManifest |
| Transport Order / Transportaufträge | pickupOrder |
| deliveryOrder | |
| transferOrder | |
| containerDeliveryOrder | |
| emptyContainerPickupOrder | |
| Air Export Screening Order / Luftfrachtsicherungsauftrag | securityMeasure |
| IATA Consignment Security Declaration | securityDeclaration |
| Air Export Master MAWB Acceptance Statement | awbAcceptance |
| Warehouse Manifest | warehouseManifest |
The following metadata are available for shipment related documents.
- Branch
- User ID
- Shipment number
- Transport document number
- House document number
- Container number(s)
- Shipper (incl. address)
- Consignee (incl. address)
- Customer (incl. address)
- Cost center
- Order date
- Incoterms
Export Master Shipments
There is a specific rule for export master shipments: documents generated on an export master shipment without a shipment number are not exported to the document archive.
DE Customs
The following ATLAS customs related documents are exported by the interface.
| Scope File Document Type | <subType> in Document Message |
|---|---|
| CurRel - Entscheidung der Zollstelle zu einer Anmeldung | impcustomsCurrel |
| NffTax - Gründe für die nicht abschließende Festsetzung von Einfuhrabgaben | impcustomsNfftax |
| FinTax - Bescheid über die abschließende Festsetzung von Einfuhrabgaben | impcustomsFintax |
| CusTax - Bescheid/Befund | impcustomsCustax |
| Komprimierter Ausdruck Bescheid/Befund | impcustomsCustaxKomprimiert |
| Kombinierter Ausdruck Anmeldung und Bescheid/Befund (Einfuhr) | impcustomsCustaxCfcdec |
| ETufRel - Überlassung | nctsETufRel |
| EUp - Entladeerlaubnis | nctsEUp |
| ETufSta - Statusmeldung zur Überführung/Überwachung | nctsETufSta |
| Versandbegleitdokument | nctsVbdA |
| Kopie des Versandbegleitdokuments | nctsVbdC |
| Versandbegleitdokument Variante V | nctsVbdV |
| EExpRel - Überlassung zur Ausfuhr | aesEExpRel |
| EExpNot - Mitteilung zur Ausfuhr | aesEExpNot |
| EExpSta - Statusmeldung zur Ausfuhr | aesEExpSta |
| EExpFup - Wiedervorlage zur Ausfuhr | aesEExpFup |
| EExtCtl - Kontrollmaßnahme am Ausgang | aesEExtCtl |
| EExtSta - Statusmeldung zum Ausgang | aesEExtSta |
| EExtDat - Daten zum Ausgang | aesEExtDat |
| Ausfuhrbegleitdokument | aesAbdA |
| INF 2 Dokument | aesAbdB |
| Ausgangsvermerk Dokument | aesAvA |
| Ausgangsnachweis (Vorübergehende Ausfuhr) | aesAvB |
| Ausgangsvermerk “Nichtgemeinschaftsware” | aesAvC |
| Ausgangsvermerk zur zollrechtlichen PV | aesAvD |
| Ausgangsvermerk zur wirtschaftlichen PV | aesAvE |
| Ausgangsvermerk gilt nicht für Umsatzsteuerzwecke | aesAvF |
| Zollamtliche Freigabe Dokument | aesZfA |
The following metadata are available for ATLAS customs related documents.
- Niederlassung
- Benutzer ID
- Sendungsnummer (falls vorhanden)
- Bezugsnummer
- Registriernummer
CH Customs
| Scope File Document | <subType> in Document Message |
|---|---|
| EZV e-dec Veranlagungsverfügung Export | edecVeranlagungsverfuegungExport |
| EZV e-dec Veranlagungsverfügung MwSt | edecVeranlagungsverfuegungMwst |
| EZV e-dec Veranlagungsverfügung Zoll | edecVeranlagungsverfuegungZoll |
| EZV e-dec Rückerstattungsbeleg MwSt | edecRueckerstattungsbelegMwst |
| EZV e-dec Rückerstattungsbeleg Zoll | edecRueckerstattungsbelegZoll |
| EZV e-dec Bezugsschein (frei mit) | edecBezugsscheinFreiMit |
| EZV e-dec Bezugsschein (frei ohne) | edecBezugsscheinFreiOhne |
| EZV e-dec Bezugsschein (gesperrt) | edecBezugsscheinGesprerrt |
| EZV e-dec Sammelbezugsschein | edecSammelbezugsschein |
| EZV e-dec Sammelbezugsschein und Einfuhrlisten | edecSammelbezugsscheinEinfuhrlisten |
| EZV e-dec Einfuhrliste (frei mit) | edecEinfuhrlisteFreiMit |
| EZV e-dec Einfuhrliste (frei ohne) | edecEinfuhrlisteFreiOhne |
| EZV e-dec Einfuhrliste (gesperrt) | edecEinfuhrlisteGesprerrt |
| EZV e-dec Ausfuhrliste (frei mit) | edecAusfuhrlisteFreiMit |
| EZV e-dec Ausfuhrliste (frei ohne) | edecAusfuhrlisteFreiOhne |
| EZV e-dec Ausfuhrliste (gesperrt) | edecAusfuhrlisteGesperrt |
| EZV e-dec Pannenlösung | edecKontrollblattPannenloesung |
| EZV e-dec Zollbeschau | edecRevision |
| EZV e-dec Prüfbericht | edecTaxReceiptValidationResult |
| EZV e-dec Bordereau | edecBordereau |
| PTAD5 Versandbegleitdokument mit und ohne Sicherheitsdaten | ptad5 |
| PTADD5 Versandbegleitdokument mit und ohne Sicherheitsdaten Draft | ptadd5 |
| PTADD Versandbegleitdokument Draft | ptadd |
| PTSADD Versandbegleitdokument mit Sicherheitsdaten Draft | ptsadd |
| PTSAD Versandbegleitdokument mit Sicherheitsdaten | ptsad |
| PAEAD Veranlagungsverfügung Ausfuhr | paead |
| PAEDS Warenanmeldung Ausfuhr eingereicht | paeds |
| PAERD Rückweisungs-/Rückzugsverfügung einer Ausfuhr im Warenverkehr | paerd |
| PAERVD Widerruf Veranlagungsverfügung Ausfuhr | paervd |
| PATDS Warenanmeldung Durchfuhr eingereicht | patds |
| PTAD Versandbegleitdokument | ptad |
| PASTDS Warenanmeldung nationale Durchfuhr eingereicht | pastds |
| PAIAD Veranlagungsverfügung für Einfuhren | paiad |
| PAIVAD Veranlagungsverfügung MwSt für Einfuhren | paivad |
| PADTS Digital Transport Slip | padts |
| PABSD Zusammenzug Abgaben | pabsd |
| PABSV Zusammenzug MwSt | pabsv |
| PAIRD Rückweisungs-/Rückzugsverfügung einer Einfuhr im Warenverkehr | paird |
| PAIRVD Widerruf Veranlagungsverfügung Einfuhr | pairvd |
The following metadata are available for CH customs related documents.
- Niederlassung
- Benutzer ID
- Sendungsnummer (falls vorhanden)
- Deklarationsnummer Zoll
- Deklarationsnummer Spediteur
- Dossiernummer
- Schweizer UID, ie. eine Nummer die das Unternehmen, das die Anmeldung vornimmt eindeutig identifiziert
- Empfängerreferenz (falls vorhanden)
NL Customs
| Scope File Document Type | <subType> in Document Message |
|---|---|
| NL DMS Export Accompanying Document | nl.dms.exportAccompanyingDocument |
| NL DMS Confirmation of Exit | nl.dms.exitOfGoods |
| NL DMS Release Document | nl.dms.importReleaseDocument |
| NL DMS Payment Details | nl.dms.importTaxPaymentDocument |
| NL NCTS Transit Accompanying Document | nl.ncts.transitAccompanyingDocument |
| NL NCTS MRN Allocation | nl.ncts.mrnAllocation |
| NL NCTS Unloading Permission | nl.ncts.unloadPermission |
Metadata:
- Shipment Number
- LRN - Local Reference Number
- MRN - Main/Movement Reference Number
- Shipment/Trader reference Number
Quotations
| Scope File Document Type | <subType> in Document Message |
|---|---|
| Quotation | quotation |
| Quotation Air/Sea-Export/Import File cover | quotationFileCover |
| Quotation Simple Shipment File cover | quotationFileCover |
Metadata:
- Quotation number
- Quotation date
- Shipment type
- Prospect party (incl. address)
- Inco terms
- Cost center
- Valid from date
- Valid to date
Uploaded Documents
External documents uploaded to Scope can also be exported through the Document Archive interface based on the configured settings. These documents can be manually uploaded via the Scope client, imported through the Scope Documents interface or imported via an event interface. Documents are eligible for export when they are linked to one of the following entities and have one of the document types listed below:
- Invoice
- Shipment
- Transport Order
- Booking
- Quotation
| Scope File Document Type | <subType> in Document Message |
|---|---|
| Accounts payable / Eingangsbeleg | accountsPayable |
| Air cargo security screening report | UN_EDI_1001_CODE_588 |
| Air waybill | UN_EDI_1001_CODE_740 |
| Arrival notice (goods) / Ankunftsbenachrichtigung (Güter) | UN_EDI_1001_CODE_781 |
| ATA carnet | UN_EDI_1001_CODE_955 |
| Booking request / Buchungsanfrage | UN_EDI_1001_CODE_335 |
| Cargo manifest | UN_EDI_1001_CODE_785 |
| Cargo release notification / Benachrichtigung über die Freigabe der Ladung | UN_EDI_1001_CODE_99 |
| Carrier booking confirmation / Carrier Buchungsbestätigung | UN_EDI_1001_CODE_770 |
| Cartage order (local transport) / Transportanweisungen (lokaler Transport) | UN_EDI_1001_CODE_343 |
| Certificate / Zertifikat | UN_EDI_1001_CODE_16 |
| Certificate of Analysis / Analysebescheinigung | UN_EDI_1001_CODE_1 |
| Certificate of origin / Ursprungszertifikat | UN_EDI_1001_CODE_861 |
| Commercial invoice / Handelsrechnung | UN_EDI_1001_CODE_380 |
| Container stuffing order | UN_EDI_1001_CODE_184 |
| Court judgment / Gerichtsurteil | UN_EDI_1001_CODE_854 |
| Customs Clearance Notice / Zollabfertigungsbescheid | UN_EDI_1001_CODE_132 |
| Customs declaration for external community transit (T1) / Zollanmeldung für den externen Gemeinschaftstransit (T1) | UN_EDI_1001_CODE_578 |
| Customs declaration for internal community transit (T2) / Zollanmeldung für den internen Gemeinschaftstransit (T2) | UN_EDI_1001_CODE_579 |
| Customs declaration for TIR Carnet goods / Zollanmeldung für TIR-Carnet-Waren | UN_EDI_1001_CODE_587 |
| Customs document / Zolldokument | customsDocument |
| Customs invoice / Zollabrechnung | UN_EDI_1001_CODE_935 |
| Damage certification / Schadensmeldung | UN_EDI_1001_CODE_49 |
| Dangerous goods declaration / Gefahrguterklärung | shippersDeclaration |
| Dangerous goods list / Gefahrgutliste | UN_EDI_1001_CODE_298 |
| Delivery note / Lieferschein | UN_EDI_1001_CODE_270 |
| Delivery order / Lieferauftrag | UN_EDI_1001_CODE_640 |
| Delivery verification certificate / Auslieferungsnachweis | UN_EDI_1001_CODE_901 |
| Documentary credit / Akkreditiv | UN_EDI_1001_CODE_465 |
| Documentary credit amendment / Akkreditivänderung | UN_EDI_1001_CODE_469 |
| Document for establishing the Community status of goods (T2L) / Dokument zum Nachweis des Gemeinschaftsstatus von Waren (T2L) | UN_EDI_1001_CODE_584 |
| Export licence / Ausfuhrgenehmigung | UN_EDI_1001_CODE_811 |
| Food grade certificate / Zertifikat für Lebensmittelqualität | UN_EDI_1001_CODE_637 |
| Forwarders advice to import agent (Prealert) / Benachrichtigung des Spediteurs an den Importagenten (Prealert) | UN_EDI_1001_CODE_621 |
| Forwarding Instructions / Speditionsauftrag | UN_EDI_1001_CODE_610 |
| Fumigation certificate | UN_EDI_1001_CODE_267 |
| Goods declaration for customs transit / Warenanmeldung für den Zolltransit | UN_EDI_1001_CODE_950 |
| Goods receipt / Wareneingang | UN_EDI_1001_CODE_632 |
| Handling order / Bearbeitungsauftrag | UN_EDI_1001_CODE_650 |
| Health certificate / Gesundheitszertifikat | UN_EDI_1001_CODE_636 |
| Heat treatment certificate / Wärmebehandlungszertifikat | UN_EDI_1001_CODE_625 |
| House bill of lading | UN_EDI_1001_CODE_714 |
| House bill of lading (Draft) | UN_EDI_1001_CODE_714 |
| House waybill | UN_EDI_1001_CODE_703 |
| Image / Bild | image |
| Import Licence / Einfuhrgenehmigung | UN_EDI_1001_CODE_911 |
| Inquiry | UN_EDI_1001_CODE_251 |
| Insurance certificate / Versicherungszertifikat | UN_EDI_1001_CODE_520 |
| Insurance declaration sheet / Versicherungsanmeldung | UN_EDI_1001_CODE_550 |
| Insurance policy / Versicherungsschein | UN_EDI_1001_CODE_530 |
| Invoicing data sheet / Rechnungsdatenblatt | UN_EDI_1001_CODE_130 |
| Letter of attorney / Vollmacht | UN_EDI_1001_CODE_173 |
| Letter of indemnity for non-surrender of bill of lading / Entschädigungserklärung für die Nichtaushändigung des Frachtbriefs | UN_EDI_1001_CODE_715 |
| Master air waybill | UN_EDI_1001_CODE_741 |
| Master B/L (Draft) | oceanBillOfLadingDraft |
| Master-B/L | UN_EDI_1001_CODE_705 |
| Offer/quotation / Angebot | UN_EDI_1001_CODE_310 |
| Other documents to be archived / Weitere zu archivierende Dokumente | UN_EDI_1001_CODE_916 |
| Packing instructions / Packanweisungen | UN_EDI_1001_CODE_140 |
| Packing list / Packliste | UN_EDI_1001_CODE_271 |
| Pickup notice / Abholbenachrichtigung | UN_EDI_1001_CODE_171 |
| Previous correspondence / Vorhergegangener Schriftverkehr | UN_EDI_1001_CODE_653 |
| Price quote / Kostenvoranschlag | UN_EDI_1001_CODE_361 |
| Proforma invoice / Proforma-Rechnung | UN_EDI_1001_CODE_325 |
| Proof of delivery | UN_EDI_1001_CODE_737 |
| Purchase order / Auftrag | UN_EDI_1001_CODE_105 |
| Phytosanitary certificate / Phytosanitäres Zertifikat | UN_EDI_1001_CODE_851 |
| Remittance advice / Zahlungsavis | UN_EDI_1001_CODE_481 |
| Request for quote / Angebotsanfrage | UN_EDI_1001_CODE_311 |
| Safety and hazard data sheet / Sicherheits- und Gefahrendatenblatt | UN_EDI_1001_CODE_53 |
| Shippers letter of instructions (Air) / Weisungsschreiben des Versenders (Luftfracht) | UN_EDI_1001_CODE_341 |
| Shipping documents / Versanddokumente | shippingDocuments |
| Shipping instructions / Versandanweisungen | UN_EDI_1001_CODE_340 |
| Thermographic reading report / Temperaturausdruck | UN_EDI_1001_CODE_641 |
| Transport cargo release order / Freigabeauftrag für Frachttransport | UN_EDI_1001_CODE_129 |
| Transport discharge report / Transportentladungsbericht | UN_EDI_1001_CODE_119 |
| Transport empty equipment advice / Hinweise zum Transport leerer Geräte | UN_EDI_1001_CODE_125 |
| Transport equipment gross mass verification message / Meldung zur Überprüfung des Bruttogewichts von Transportmitteln | UN_EDI_1001_CODE_749 |
| Transport loading Report / Transportbeladungsbericht | UN_EDI_1001_CODE_122 |
| Waybill / Frachtbrief | UN_EDI_1001_CODE_700 |
| Weight certificate / Gewichtsbescheinigung | UN_EDI_1001_CODE_14 |
Data Format
By default, documents are exported as embedded content within an XML file, along with their associated metadata.
XML schema: scope_document-2.3.xsd
Examples:
- Accounts receivable: scope_document-2.3-accounts_receivable.xml
- Accounts receivable MX: scope_document-2.3-accounts_receivable-MX.xml
- Payment receipt MX: scope_document-2.3-payment_receipt-MX.xml
- Accounts payable: scope_document-2.3-accounts_payable.xml
- Import release order: scope_document-2.3-import_release_order.xml
- Screening report: scope_document-2.3-screening-report.xml
- Transport order on shipment: scope_document-2.3-transport_order.xml
- Transport order on booking: scope_document-2.3-transport_order_booking.xml
- Customs assessment: scope_document-2.3-customs_assessment.xml
- Quotation: scope_document-2.3-quotation.xml