Додавання об’єктів до документів XBRL за допомогою C#

XBRL(eXtensible Business Reporting Language) визначає та обмінюється фінансовою інформацією, такою як фінансовий звіт. Екземпляр документа XBRL — це набір фактів, які разом складають бізнес-звіт. Ми можемо легко створити документ екземпляра XBRL програмним шляхом і додати об’єкти або елементи, такі як посилання на схему, контекст, одиницю, елементи тощо. У цій статті ми дізнаємося, як створити документ екземпляра XBRL і додати об’єкти в C#.

У цій статті будуть розглянуті такі теми:

  1. API C# для створення документа екземпляра XBRL і додавання об’єктів
  2. Створити документ екземпляра XBRL
  3. Додати посилання на схему до XBRL
  4. Додати об’єкт контексту в XBRL
  5. Створіть одиницю в XBRL
  6. Додати об’єкт Fact у XBRL

C# API для створення документа екземпляра XBRL і додавання об’єктів

Для створення документа екземпляра XBRL і додавання об’єктів ми будемо використовувати API Aspose.Finance for .NET. Це дозволяє створювати екземпляри 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];

// Отримати колекцію посилань на схему
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 до колекції 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");

Додайте Fact Object у XBRL за допомогою C#

Факти в XBRL визначаються за допомогою елементів item. Елемент у XBRL містить значення простого факту та посилання на контекст для правильної інтерпретації цього факту. Ми можемо додати елемент у екземпляр документа XBRL, виконавши наведені нижче кроки:

  1. По-перше, створіть екземпляр класу XbrlDocument.
  2. Додайте новий екземпляр XBRL до екземплярів об’єкта XbrlDocument.
  3. Додайте нове посилання на схему до посилань на схему об’єкта XbrlInstance.
  4. Отримайте SchemaRef за його індексом із SchemaRefCollection.
  5. Ініціалізуйте екземпляр Context і додайте його до колекції об’єктів Context.
  6. Визначте екземпляр Unit і додайте його до колекції об’єктів Unit.
  7. Створіть екземпляр класу Concept за допомогою методу SchemaRef.GetConceptByName().
  8. Створіть екземпляр класу Item з об’єктом Concept як аргумент.
  9. Встановіть такі властивості елемента, як ContextRef, UnitRef, Precision, Value тощо.
  10. Після цього додайте Item до колекції Fact objects.
  11. Нарешті, збережіть файл XBRL за допомогою методу XbrlDocument.Save(). Він приймає вихідний шлях до файлу як аргумент.

У наведеному нижче прикладі коду показано, як додати факт як елемент елемента в документ екземпляра XBRL за допомогою C#.

// Цей приклад коду демонструє, як додати об’єкт Fact item до 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 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 for .NET API за допомогою документації. У разі будь-яких неясностей зв’яжіться з нами на нашому безкоштовному форумі підтримки.

Дивись також