הוסף אובייקטים למסמכי XBRL באמצעות C#

XBRL(eXtensible Business Reporting Language) מגדירה ומחליפה מידע פיננסי, כגון דוח כספי. מסמך מופע XBRL הוא אוסף של עובדות המרכיבות יחד דוח עסקי. נוכל ליצור בקלות מסמך מופע XBRL באופן פרוגרמטי ולהוסיף אובייקטים או אלמנטים כגון הפניה לסכימה, הקשר, יחידה, פריטים וכו’. במאמר זה נלמד כיצד ליצור מסמך מופע XBRL ולהוסיף אובייקטים ב-C#.

הנושאים הבאים יכוסו במאמר זה:

  1. C# API ליצירת מסמך XBRL Instance והוספת אובייקטים
  2. צור מסמך XBRL Instance
  3. הוסף התייחסות סכמה ל-XBRL
  4. הוסף אובייקט הקשר ב-XBRL
  5. צור יחידה ב-XBRL
  6. הוסף אובייקט עובדה ב-XBRL

C# API ליצירת מסמך XBRL מופע והוספת אובייקטים

ליצירת מסמך מופע XBRL והוספת אובייקטים, נשתמש ב-Aspose.Finance for .NET API. זה מאפשר יצירת מופעי XBRL, ניתוח ואימות של קבצי XBRL או iXBRL.

אנא הורד את ה-DLL של ה-API או התקן אותו באמצעות NuGet.

PM> Install-Package Aspose.Finance

צור מסמך מופע XBRL ב-C#

אנו יכולים ליצור בקלות מסמך מופע XBRL מאפס על ידי ביצוע השלבים המפורטים להלן:

  1. ראשית, צור מופע של המחלקה XbrlDocument.
  2. לאחר מכן, גש לאוסף המופעים מהאובייקט XbrlDocument אל האובייקט XbrlInstanceCollection.
  3. לאחר מכן, הוסף מופע XBRL חדש באמצעות השיטה XbrlInstanceCollection.Add().
  4. לבסוף, שמור את קובץ XBRL בשיטת XbrlDocument.Save(). זה לוקח את נתיב קובץ הפלט כארגומנט.

דוגמת הקוד הבאה מראה כיצד ליצור מסמך מופע XBRL באמצעות C#.

// דוגמה זו מדגימה כיצד ליצור מסמך מופע XBRL.
// צור מופע של מחלקה XbrlDocument
XbrlDocument document = new XbrlDocument();

// קבל XbrlInstances
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;

// הוסף XbrlInstance
xbrlInstances.Add();

// שמור את קובץ הפלט
document.Save(@"D:\Files\Finance\output.xbrl");

הוסף התייחסות סכמה ל-XBRL באמצעות C#

אנו יכולים להוסיף הפניה לסכימה במסמך מופע XBRL על ידי ביצוע השלבים המפורטים להלן:

  1. ראשית, צור מופע של המחלקה XbrlDocument.
  2. לאחר מכן, קבל את אוסף המופעים של אובייקט XbrlDocument לתוך אובייקט XbrlInstanceCollection.
  3. לאחר מכן, הוסף מופע XBRL חדש באמצעות שיטת XbrlInstanceCollection.Add() .
  4. לאחר מכן, קבל את אוסף הפניות הסכימה של אובייקט XbrlInstance לאובייקט SchemaRefCollection.
  5. לאחר מכן, הוסף הפניה לסכימה חדשה באמצעות השיטה SchemaRefCollection.Add().
  6. לבסוף, שמור את קובץ XBRL באמצעות שיטת XbrlDocument.Save() . זה לוקח את נתיב קובץ הפלט כארגומנט.

דוגמת הקוד הבאה מראה כיצד להוסיף הפניה לסכימה במסמך מופע XBRL באמצעות C#.

// דוגמה זו מדגימה כיצד להוסיף אובייקט SchemaReference ל-XBRL.
// צור מופע של מחלקה XbrlDocument
XbrlDocument document = new XbrlDocument();

// קבל XbrlInstances
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;

// הוסף XbrlInstance
xbrlInstances.Add();
XbrlInstance xbrlInstance = xbrlInstances[0];

// קבל אוסף הפניות ל- Schema
SchemaRefCollection schemaRefs = xbrlInstance.SchemaRefs;

// הוסף הפניה לסכימה
schemaRefs.Add(@"D:\Files\Finance\schema.xsd", "example", "http://example.com/xbrl/taxonomy");

// שמור את קובץ הפלט
document.Save(@"D:\Files\Finance\output.xbrl");

הוסף אובייקט הקשר ב-XBRL באמצעות CSharp

אנו יכולים להוסיף הקשר למסמך מופע XBRL על ידי ביצוע השלבים המפורטים להלן:

  1. ראשית, צור מופע של המחלקה XbrlDocument.
  2. לאחר מכן, קבל את אוסף המופעים של אובייקט XbrlDocument לתוך אובייקט XbrlInstanceCollection.
  3. לאחר מכן, הוסף מופע XBRL חדש באמצעות שיטת XbrlInstanceCollection.Add() .
  4. לאחר מכן, צור מופע של המחלקה ContextPeriod עם תאריכי ההתחלה והסיום.
  5. לאחר מכן, צור ContextEntity וספק סכימה ומזהה.
  6. לאחר מכן, צור מופע של המחלקה Context עם ContextPeriod ו-ContextEntity המוגדרים.
  7. לאחר מכן, הוסף את האובייקט Context לאוסף Context objects.
  8. לבסוף, שמור את קובץ XBRL באמצעות שיטת XbrlDocument.Save() . זה לוקח את נתיב קובץ הפלט כארגומנט.

דוגמת הקוד הבאה מראה כיצד להוסיף אובייקט הקשר במסמך מופע XBRL באמצעות C#.

// דוגמה זו מדגימה כיצד להוסיף אובייקט Context ל-XBRL.
// צור מופע של מחלקה XbrlDocument
XbrlDocument document = new XbrlDocument();

// קבל XbrlInstances
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;

// הוסף XbrlInstance
xbrlInstances.Add();
XbrlInstance xbrlInstance = xbrlInstances[0];

// הגדר תקופת הקשר
ContextPeriod contextPeriod = new ContextPeriod(DateTime.Parse("2020-01-01"), DateTime.Parse("2020-02-10"));

// ערך ההקשר של Cretae
ContextEntity contextEntity = new ContextEntity("exampleIdentifierScheme", "exampleIdentifier");

// צור הקשר
Context context = new Context(contextPeriod, contextEntity);

// הוסף הקשר
xbrlInstance.Contexts.Add(context);

// שמור את קובץ הפלט
document.Save(@"D:\Files\Finance\Output.xbrl");

צור יחידות ב-XBRL באמצעות C#

היחידות ב-XBRL מודדות פריטים מספריים. אנו יכולים להוסיף יחידה במסמך מופע XBRL על ידי ביצוע השלבים המפורטים להלן:

  1. ראשית, צור מופע של המחלקה XbrlDocument.
  2. לאחר מכן, קבל את אוסף המופעים של אובייקט XbrlDocument לתוך אובייקט XbrlInstanceCollection.
  3. לאחר מכן, הוסף מופע XBRL חדש באמצעות שיטת XbrlInstanceCollection.Add() .
  4. לאחר מכן, צור מופע של המחלקה Unit עם UnitType בתור Measure.
  5. לאחר מכן, הוסף QualifiedName לאוסף MeasureQualifiedNames.
  6. לאחר מכן, הוסף את היחידה לאוסף Unit objects.
  7. לבסוף, שמור את קובץ XBRL באמצעות שיטת XbrlDocument.Save() . זה לוקח את נתיב קובץ הפלט כארגומנט.

דוגמת הקוד הבאה מראה כיצד להוסיף אובייקט יחידה במסמך מופע XBRL באמצעות C#.

// דוגמה זו מדגימה כיצד להוסיף אובייקט Unit ל-XBRL.
// צור מופע של מחלקה XbrlDocument
XbrlDocument document = new XbrlDocument();

// קבל XbrlInstances
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;

// הוסף XbrlInstance
xbrlInstances.Add();
XbrlInstance xbrlInstance = xbrlInstances[0];

// הגדר יחידה
Unit unit = new Unit(UnitType.Measure);

// הוסף את שם המוקדמות
unit.MeasureQualifiedNames.Add(new QualifiedName("USD", "iso4217", "http://www.xbrl.org/2003/iso4217"));

// הוסף יחידה
xbrlInstance.Units.Add(unit);

// שמור את קובץ הפלט
document.Save(@"D:\Files\Finance\Output.xbrl");

הוסף אובייקט עובדה ב-XBRL באמצעות C#

עובדות ב-XBRL מוגדרות באמצעות רכיבי פריט. פריט ב-XBRL מכיל את הערך של העובדה הפשוטה והתייחסות להקשר כדי לפרש נכון את העובדה הזו. אנו יכולים להוסיף פריט במסמך מופע XBRL על ידי ביצוע השלבים המפורטים להלן:

  1. ראשית, צור מופע של המחלקה XbrlDocument.
  2. הוסף מופע XBRL חדש למופעים של אובייקט XbrlDocument.
  3. הוסף הפניות לסכימה חדשה להפניות הסכימה של אובייקט XbrlInstance.
  4. קבל את SchemaRef לפי האינדקס שלו מ- SchemaRefCollection.
  5. אתחל את מופע ההקשר והוסף אותו לאוסף אובייקטי ההקשר.
  6. הגדר מופע של Unit והוסף אותו לאוסף האובייקטים של Unit.
  7. צור מופע מחלקה Concept באמצעות השיטה SchemaRef.GetConceptByName().
  8. צור מופע של המחלקה Item עם האובייקט Concept כארגומנט.
  9. הגדר מאפייני פריט כגון ContextRef, UnitRef, Precision, Value וכו'.
  10. לאחר מכן, הוסף את הפריט לאוסף אובייקטי עובדה.
  11. לבסוף, שמור את קובץ XBRL באמצעות שיטת XbrlDocument.Save() . זה לוקח את נתיב קובץ הפלט כארגומנט.

דוגמת הקוד הבאה מראה כיצד להוסיף עובדה כרכיב פריט במסמך מופע XBRL באמצעות C#.

// דוגמה זו מדגימה כיצד להוסיף אובייקט עובדה ל-XBRL.
// צור XbrlDocument
XbrlDocument document = new XbrlDocument();
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;
XbrlInstance xbrlInstance = xbrlInstances[xbrlInstances.Add()];

// הגדר התייחסות לסכימה
SchemaRefCollection schemaRefs = xbrlInstance.SchemaRefs;
schemaRefs.Add(@"D:\Files\Finance\schema.xsd", "example", "http://example.com/xbrl/taxonomy");
SchemaRef schema = schemaRefs[0];

// הגדר הקשר
ContextPeriod contextPeriod = new ContextPeriod(DateTime.Parse("2020-01-01"), DateTime.Parse("2020-02-10"));
ContextEntity contextEntity = new ContextEntity("exampleIdentifierScheme", "exampleIdentifier");
Context context = new Context(contextPeriod, contextEntity);
xbrlInstance.Contexts.Add(context);

// הגדר יחידה
Unit unit = new Unit(UnitType.Measure);
unit.MeasureQualifiedNames.Add(new QualifiedName("USD", "iso4217", "http://www.xbrl.org/2003/iso4217"));
xbrlInstance.Units.Add(unit);

// קבל קונספט
Concept fixedAssetsConcept = schema.GetConceptByName("fixedAssets");
if (fixedAssetsConcept != null)
{
    // הגדר רכיב פריט לעובדה
    Item item = new Item(fixedAssetsConcept);
    item.ContextRef = context;
    item.UnitRef = unit;
    item.Precision = 4;
    item.Value = "1444";
    
    // הוסף רכיב פריט לעובדות
    xbrlInstance.Facts.Add(item);
}

// שמור את קובץ הפלט
document.Save(@"D:\Files\Finance\Output.xbrl");

קבל רישיון חינם

אתה יכול לקבל רישיון זמני בחינם כדי לנסות את הספרייה ללא מגבלות הערכה.

סיכום

במאמר זה, למדנו כיצד ליצור מסמך XBRL באמצעות C#. ראינו גם כיצד להוסיף אובייקטי XBRL שונים למסמך מופע XBRL שנוצר באופן תוכנתי. חוץ מזה, אתה יכול ללמוד עוד על Aspose.Finance עבור .NET API באמצעות תיעוד. בכל מקרה של אי בהירות, אנא אל תהסס לפנות אלינו בפורום התמיכה החינמית שלנו.

ראה גם