C# kullanarak XBRL Belgelerine Nesne Ekleme

XBRL (Genişletilebilir İşletme Raporlama Dili), mali tablo gibi mali bilgileri tanımlar ve değiş tokuş eder. Bir XBRL örnek belgesi, birlikte bir iş raporu oluşturan gerçeklerin bir koleksiyonudur. Programlı olarak kolayca bir XBRL örnek belgesi oluşturabilir ve şema referansı, bağlam, birim, öğeler vb.

Bu yazıda aşağıdaki konular ele alınacaktır:

XBRL Örnek Belgelerine Nesne Eklemek için C# API’si

Bir XBRL örnek belgesi oluşturmak ve nesneler eklemek için Aspose.Finance for .NET API’sini kullanacağız. XBRL örnekleri oluşturmaya, XBRL veya iXBRL dosyalarını ayrıştırmaya ve doğrulamaya izin verir. Lütfen API’nin DLL’sini indirin veya NuGet kullanarak kurun.

PM> Install-Package Aspose.Finance

C# kullanarak XBRL’ye Şema Referansı Ekleme

Aşağıda verilen adımları izleyerek bir XBRL örnek belgesine şema referansı ekleyebiliriz:

  1. İlk olarak, XbrlDocument sınıfının bir örneğini oluşturun.
  2. Ardından, XbrlDocument nesnesinin örneklerinin koleksiyonunu XbrlInstanceCollection nesnesine alın.
  3. Ardından, XbrlInstanceCollection.Add() yöntemini kullanarak yeni bir XBRL örneği ekleyin.
  4. Ardından, XbrlInstance nesnesinin şema başvuru koleksiyonunu SchemaRefCollection nesnesine alın.
  5. Bundan sonra, SchemaRefCollection.Add() yöntemini kullanarak yeni bir şema referansı ekleyin.
  6. Son olarak, XBRL dosyasını XbrlDocument.Save() yöntemini kullanarak kaydedin. Çıktı dosyası yolunu bağımsız değişken olarak alır.

Aşağıdaki kod örneği, C# kullanarak bir XBRL örnek belgesine şema referansının nasıl ekleneceğini gösterir.

// Bu kod örneği, XBRL'ye SchemaReference nesnesinin nasıl ekleneceğini gösterir.
// XbrlDocument sınıfının bir örneğini oluşturun
XbrlDocument document = new XbrlDocument();

// XbrlInstances'ı Alın
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;

// XbrlÖrneği Ekle
xbrlInstances.Add();
XbrlInstance xbrlInstance = xbrlInstances[0];

// Şema referansları koleksiyonunu alın
SchemaRefCollection schemaRefs = xbrlInstance.SchemaRefs;

// Şema referansı ekle
schemaRefs.Add(@"D:\Files\Finance\schema.xsd", "example", "http://example.com/xbrl/taxonomy");

// Çıktı dosyasını kaydedin
document.Save(@"D:\Files\Finance\output.xbrl");

CSharp kullanarak XBRL’de Bağlam Nesnesi ekleyin

Aşağıda verilen adımları izleyerek bir XBRL örnek belgesine bağlam ekleyebiliriz:

  1. İlk olarak, XbrlDocument sınıfının bir örneğini oluşturun.
  2. Ardından, XbrlDocument nesnesinin örneklerinin koleksiyonunu XbrlInstanceCollection nesnesine alın.
  3. Ardından, XbrlInstanceCollection.Add() yöntemini kullanarak yeni bir XBRL örneği ekleyin.
  4. Ardından, başlangıç ve bitiş tarihleriyle ContextPeriod sınıfının bir örneğini oluşturun.
  5. Ardından, bir ContextEntity oluşturun ve şema ile tanımlayıcı sağlayın.
  6. Ardından, tanımlanmış ContextPeriod ve ContextEntity ile Context sınıfının bir örneğini oluşturun.
  7. Bundan sonra, Bağlam nesnesini Bağlam nesneleri koleksiyonuna ekleyin.
  8. Son olarak, XBRL dosyasını XbrlDocument.Save() yöntemini kullanarak kaydedin. Çıktı dosyası yolunu bağımsız değişken olarak alır.

Aşağıdaki kod örneği, C# kullanarak bir XBRL örnek belgesine bir bağlam nesnesinin nasıl ekleneceğini gösterir.

// Bu kod örneği, Bağlam nesnesinin XBRL'ye nasıl ekleneceğini gösterir.
// XbrlDocument sınıfının bir örneğini oluşturun
XbrlDocument document = new XbrlDocument();

// XbrlInstances'ı Alın
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;

// XbrlÖrneği Ekle
xbrlInstances.Add();
XbrlInstance xbrlInstance = xbrlInstances[0];

// Bağlam dönemini tanımlayın
ContextPeriod contextPeriod = new ContextPeriod(DateTime.Parse("2020-01-01"), DateTime.Parse("2020-02-10"));

// Cretae bağlam girişi
ContextEntity contextEntity = new ContextEntity("exampleIdentifierScheme", "exampleIdentifier");

// Bağlam oluştur
Context context = new Context(contextPeriod, contextEntity);

// Bağlam ekle
xbrlInstance.Contexts.Add(context);

// Çıktı dosyasını kaydedin
document.Save(@"D:\Files\Finance\Output.xbrl");

C# kullanarak XBRL’de Birimler Oluşturun

XBRL’deki birimler sayısal Öğeleri ölçer. Aşağıda verilen adımları izleyerek bir XBRL örnek belgesine bir birim ekleyebiliriz:

  1. İlk olarak, XbrlDocument sınıfının bir örneğini oluşturun.
  2. Ardından, XbrlDocument nesnesinin örneklerinin koleksiyonunu XbrlInstanceCollection nesnesine alın.
  3. Ardından, XbrlInstanceCollection.Add() yöntemini kullanarak yeni bir XBRL örneği ekleyin.
  4. Ardından, Measure olarak UnitType ile Unit sınıfının bir örneğini oluşturun.
  5. Ardından, QualifiedName’i MeasureQualifiedNames koleksiyonuna ekleyin.
  6. Bundan sonra, Birimi Birim nesneleri koleksiyonuna ekleyin.
  7. Son olarak, XBRL dosyasını XbrlDocument.Save() yöntemini kullanarak kaydedin. Çıktı dosyası yolunu bağımsız değişken olarak alır.

Aşağıdaki kod örneği, C# kullanarak bir XBRL örnek belgesine bir birim nesnesinin nasıl ekleneceğini gösterir.

// Bu kod örneği, Unit nesnesinin XBRL'ye nasıl ekleneceğini gösterir.
// XbrlDocument sınıfının bir örneğini oluşturun
XbrlDocument document = new XbrlDocument();

// XbrlInstances'ı Alın
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;

// XbrlÖrneği Ekle
xbrlInstances.Add();
XbrlInstance xbrlInstance = xbrlInstances[0];

// Birimi tanımla
Unit unit = new Unit(UnitType.Measure);

// Niteleyici adı ekle
unit.MeasureQualifiedNames.Add(new QualifiedName("USD", "iso4217", "http://www.xbrl.org/2003/iso4217"));

// Birim ekle
xbrlInstance.Units.Add(unit);

// Çıktı dosyasını kaydedin
document.Save(@"D:\Files\Finance\Output.xbrl");

C# kullanarak XBRL’de Gerçek Nesnesi Ekleme

XBRL’deki gerçekler, öğe öğeleri kullanılarak tanımlanır. XBRL’deki bir öğe, basit gerçeğin değerini ve bu gerçeği doğru şekilde yorumlamak için bağlama bir referans içerir. Aşağıda verilen adımları izleyerek bir XBRL örnek belgesine bir öğe ekleyebiliriz:

  1. İlk olarak, XbrlDocument sınıfının bir örneğini oluşturun.
  2. XbrlDocument nesnesinin örneklerine yeni bir XBRL örneği ekleyin.
  3. XbrlInstance nesnesinin şema referanslarına yeni bir şema referansı ekleyin.
  4. SchemaRefCollection’dan dizinine göre SchemaRef’i alın.
  5. Bağlam örneğini başlatın ve onu Bağlam nesneleri koleksiyonuna ekleyin.
  6. Bir Birim örneği tanımlayın ve onu Birim nesneleri koleksiyonuna ekleyin.
  7. SchemaRef.GetConceptByName() yöntemini kullanarak bir Concept sınıfı örneği oluşturun.
  8. Argüman olarak Concept nesnesiyle Item sınıfının bir örneğini oluşturun.
  9. ContextRef, UnitRef, Precision, Value vb. gibi öğe özelliklerini ayarlayın.
  10. Bundan sonra Öğeyi Fact object koleksiyonuna ekleyin.
  11. Son olarak, XBRL dosyasını XbrlDocument.Save() yöntemini kullanarak kaydedin. Çıktı dosyası yolunu bağımsız değişken olarak alır.

Aşağıdaki kod örneği, C# kullanarak bir XBRL örnek belgesinde bir olgunun öğe öğesi olarak nasıl ekleneceğini gösterir.

// Bu kod örneği, Fact item nesnesinin XBRL'ye nasıl ekleneceğini gösterir.
// XbrlDocument Oluştur
XbrlDocument document = new XbrlDocument();
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;
XbrlInstance xbrlInstance = xbrlInstances[xbrlInstances.Add()];

// Şema referansını tanımla
SchemaRefCollection schemaRefs = xbrlInstance.SchemaRefs;
schemaRefs.Add(@"D:\Files\Finance\schema.xsd", "example", "http://example.com/xbrl/taxonomy");
SchemaRef schema = schemaRefs[0];

// Bağlamı tanımla
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);

// Birimi tanımla
Unit unit = new Unit(UnitType.Measure);
unit.MeasureQualifiedNames.Add(new QualifiedName("USD", "iso4217", "http://www.xbrl.org/2003/iso4217"));
xbrlInstance.Units.Add(unit);

// Konsept al
Concept fixedAssetsConcept = schema.GetConceptByName("fixedAssets");
if (fixedAssetsConcept != null)
{
    // Gerçek için Öğe öğesini tanımla
    Item item = new Item(fixedAssetsConcept);
    item.ContextRef = context;
    item.UnitRef = unit;
    item.Precision = 4;
    item.Value = "1444";
    
    // Gerçeklere öğe öğesi ekle
    xbrlInstance.Facts.Add(item);
}

// Çıktı dosyasını kaydedin
document.Save(@"D:\Files\Finance\Output.xbrl");

Ücretsiz Lisans Alın

Kitaplığı değerlendirme sınırlamaları olmadan denemek için ücretsiz bir geçici lisans alabilirsiniz.

Çözüm

Bu yazımızda C# kullanarak XBRL belgesi oluşturmayı öğrendik. Oluşturulan XBRL örnek belgesine programlı olarak çeşitli XBRL nesnelerinin nasıl ekleneceğini de gördük. Ayrıca, belgeleri kullanarak Aspose.Finance for .NET API hakkında daha fazla bilgi edinebilirsiniz. Herhangi bir belirsizlik durumunda, lütfen [forum] üzerinden bizimle iletişime geçmekten çekinmeyin]36.

Ayrıca bakınız