اضافه کردن اشیا به اسناد XBRL با استفاده از C#

XBRL (زبان گزارش‌دهی تجاری توسعه‌یافته) اطلاعات مالی مانند صورت‌های مالی را تعریف و مبادله می‌کند. یک سند نمونه XBRL مجموعه ای از حقایق است که با هم یک گزارش تجاری را تشکیل می دهند. ما به راحتی می توانیم یک سند نمونه XBRL را به صورت برنامه نویسی ایجاد کنیم و اشیا یا عناصری مانند مرجع طرحواره، زمینه، واحد، آیتم ها و غیره را اضافه کنیم. در این مقاله یاد می گیریم که چگونه با استفاده از سی شارپ، اشیاء را به اسناد نمونه 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. سپس، مجموعه مرجع طرحواره شی 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];

// مجموعه ارجاعات طرحواره را دریافت کنید
SchemaRefCollection schemaRefs = xbrlInstance.SchemaRefs;

// اضافه کردن مرجع طرحواره
schemaRefs.Add(@"D:\Files\Finance\schema.xsd", "example", "http://example.com/xbrl/taxonomy");

// فایل خروجی را ذخیره کنید
document.Save(@"D:\Files\Finance\output.xbrl");

اضافه کردن Context Object در 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() ذخیره کنید. مسیر فایل خروجی را به عنوان آرگومان می گیرد.

نمونه کد زیر نشان می دهد که چگونه می توان یک شی زمینه را با استفاده از C# در یک سند نمونه XBRL اضافه کرد.

// این مثال کد نحوه اضافه کردن شی 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"));

// مدخل بافت کرتا
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 را به مجموعه Unit objects اضافه کنید.
  7. در نهایت، فایل XBRL را با استفاده از روش XbrlDocument.Save() ذخیره کنید. مسیر فایل خروجی را به عنوان آرگومان می گیرد.

نمونه کد زیر نحوه اضافه کردن یک شی واحد در یک سند نمونه XBRL را با استفاده از C# نشان می دهد.

// این مثال کد نحوه اضافه کردن شی واحد به 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");

اضافه کردن Fact Object در XBRL با استفاده از C#

حقایق در XBRL با استفاده از عناصر مورد تعریف می شوند. یک مورد در XBRL حاوی مقدار واقعیت ساده و ارجاع به زمینه برای تفسیر صحیح آن واقعیت است. با دنبال کردن مراحل زیر می‌توانیم یک مورد را در یک سند نمونه XBRL اضافه کنیم:

  1. ابتدا یک نمونه از کلاس XbrlDocument ایجاد کنید.
  2. یک نمونه XBRL جدید به نمونه های شی XbrlDocument اضافه کنید.
  3. یک ارجاع طرح جدید به ارجاعات طرح شی XbrlInstance اضافه کنید.
  4. SchemaRef را با شاخص آن از SchemaRefCollection دریافت کنید.
  5. نمونه Context را مقداردهی اولیه کنید و آن را به مجموعه اشیاء زمینه اضافه کنید.
  6. یک نمونه واحد تعریف کنید و آن را به مجموعه Unit objects اضافه کنید.
  7. با استفاده از روش SchemaRef.GetConceptByName() یک نمونه کلاس Concept ایجاد کنید.
  8. یک نمونه از کلاس Item با شی Concept به عنوان آرگومان ایجاد کنید.
  9. ویژگی های مورد مانند ContextRef، UnitRef، Precision، Value و غیره را تنظیم کنید.
  10. پس از آن، آیتم را به مجموعه Fact objects اضافه کنید.
  11. در نهایت فایل XBRL را با استفاده از روش XbrlDocument.Save() ذخیره کنید. مسیر فایل خروجی را به عنوان آرگومان می گیرد.

نمونه کد زیر نشان می دهد که چگونه می توان یک واقعیت را به عنوان عنصر مورد در یک سند نمونه XBRL با استفاده از C# اضافه کرد.

// این مثال کد نحوه افزودن شی مورد Fact را به 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 با استفاده از سی شارپ را یاد گرفتیم. همچنین نحوه افزودن اشیاء مختلف XBRL به سند نمونه XBRL ایجاد شده را به صورت برنامه‌ریزی دیده‌ایم. علاوه بر این، می‌توانید با استفاده از مستندات درباره Aspose.Finance for .NET API اطلاعات بیشتری کسب کنید. در صورت وجود هرگونه ابهام، لطفاً با ما در تالار گفتمان تماس بگیرید.

همچنین ببینید