Přidejte objekty do XBRL dokumentů pomocí C#

XBRL(eXtensible Business Reporting Language) definuje a vyměňuje finanční informace, jako je finanční výkaz. Dokument instance XBRL je sbírka faktů, které dohromady tvoří obchodní zprávu. Můžeme snadno vytvořit dokument instance XBRL programově a přidat objekty nebo prvky, jako je odkaz na schéma, kontext, jednotka, položky atd. V tomto článku se naučíme, jak vytvořit dokument instance XBRL a přidávat objekty v C#.

Tento článek bude obsahovat následující témata:

  1. C# API pro vytvoření dokumentu instance XBRL a přidání objektů
  2. Vytvořit dokument instance XBRL
  3. Přidat odkaz na schéma do XBRL
  4. Přidat kontextový objekt do XBRL
  5. Vytvořit jednotku v XBRL
  6. Přidat objekt faktů do XBRL

C# API pro vytvoření dokumentu instance XBRL a přidání objektů

Pro vytváření dokumentu instance XBRL a přidávání objektů budeme používat Aspose.Finance for .NET API. Umožňuje vytváření instancí XBRL, analýzu a ověřování souborů XBRL nebo iXBRL.

Prosím buď stáhněte si DLL rozhraní API, nebo jej nainstalujte pomocí NuGet.

PM> Install-Package Aspose.Finance

Vytvořte dokument instance XBRL v C#

Dokument instance XBRL můžeme snadno vytvořit od začátku podle následujících kroků:

  1. Nejprve vytvořte instanci třídy XbrlDocument.
  2. Dále přistupte ke kolekci instancí z objektu XbrlDocument do objektu XbrlInstanceCollection.
  3. Poté přidejte novou instanci XBRL pomocí metody XbrlInstanceCollection.Add().
  4. Nakonec uložte soubor XBRL pomocí metody XbrlDocument.Save(). Jako argument bere cestu k výstupnímu souboru.

Následující ukázka kódu ukazuje, jak vytvořit dokument instance XBRL pomocí C#.

// Tento příklad kódu ukazuje, jak vytvořit dokument instance XBRL.
// Vytvořte instanci třídy XbrlDocument
XbrlDocument document = new XbrlDocument();

// Získejte XbrlInstance
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;

// Přidejte XbrlInstance
xbrlInstances.Add();

// Uložte výstupní soubor
document.Save(@"D:\Files\Finance\output.xbrl");

Přidat odkaz na schéma do XBRL pomocí C#

Do dokumentu instance XBRL můžeme přidat odkaz na schéma podle následujících kroků:

  1. Nejprve vytvořte instanci třídy XbrlDocument.
  2. Dále získejte kolekci instancí objektu XbrlDocument do objektu XbrlInstanceCollection.
  3. Poté pomocí metody XbrlInstanceCollection.Add() přidejte novou instanci XBRL.
  4. Dále získejte kolekci referencí schématu objektu XbrlInstance do objektu SchemaRefCollection.
  5. Poté přidejte nový odkaz na schéma pomocí metody SchemaRefCollection.Add().
  6. Nakonec uložte soubor XBRL pomocí metody XbrlDocument.Save(). Jako argument bere cestu k výstupnímu souboru.

Následující ukázka kódu ukazuje, jak přidat odkaz na schéma v dokumentu instance XBRL pomocí jazyka C#.

// Tento příklad kódu ukazuje, jak přidat objekt SchemaReference do XBRL.
// Vytvořte instanci třídy XbrlDocument
XbrlDocument document = new XbrlDocument();

// Získejte XbrlInstance
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;

// Přidejte XbrlInstance
xbrlInstances.Add();
XbrlInstance xbrlInstance = xbrlInstances[0];

// Získejte sbírku referencí Schema
SchemaRefCollection schemaRefs = xbrlInstance.SchemaRefs;

// Přidat odkaz na schéma
schemaRefs.Add(@"D:\Files\Finance\schema.xsd", "example", "http://example.com/xbrl/taxonomy");

// Uložte výstupní soubor
document.Save(@"D:\Files\Finance\output.xbrl");

Přidejte kontextový objekt do XBRL pomocí CSharp

Do dokumentu instance XBRL můžeme přidat kontext podle následujících kroků:

  1. Nejprve vytvořte instanci třídy XbrlDocument.
  2. Dále získejte kolekci instancí objektu XbrlDocument do objektu XbrlInstanceCollection.
  3. Poté pomocí metody XbrlInstanceCollection.Add() přidejte novou instanci XBRL.
  4. Dále vytvořte instanci třídy ContextPeriod s datem zahájení a ukončení.
  5. Poté vytvořte ContextEntity a zadejte schéma a identifikátor.
  6. Dále vytvořte instanci třídy Context s definovanými ContextPeriod a ContextEntity.
  7. Poté přidejte objekt Context do kolekce Context objects.
  8. Nakonec uložte soubor XBRL pomocí metody XbrlDocument.Save(). Jako argument bere cestu k výstupnímu souboru.

Následující ukázka kódu ukazuje, jak přidat kontextový objekt do dokumentu instance XBRL pomocí C#.

// Tento příklad kódu ukazuje, jak přidat objekt Context do XBRL.
// Vytvořte instanci třídy XbrlDocument
XbrlDocument document = new XbrlDocument();

// Získejte XbrlInstance
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;

// Přidejte XbrlInstance
xbrlInstances.Add();
XbrlInstance xbrlInstance = xbrlInstances[0];

// Definujte kontextové období
ContextPeriod contextPeriod = new ContextPeriod(DateTime.Parse("2020-01-01"), DateTime.Parse("2020-02-10"));

// Kontextový vstup Kréta
ContextEntity contextEntity = new ContextEntity("exampleIdentifierScheme", "exampleIdentifier");

// Vytvořte kontext
Context context = new Context(contextPeriod, contextEntity);

// Přidejte kontext
xbrlInstance.Contexts.Add(context);

// Uložte výstupní soubor
document.Save(@"D:\Files\Finance\Output.xbrl");

Vytvořte jednotky v XBRL pomocí C#

Jednotky v XBRL měří číselné položky. Jednotku můžeme přidat do dokumentu instance XBRL podle následujících kroků:

  1. Nejprve vytvořte instanci třídy XbrlDocument.
  2. Dále získejte kolekci instancí objektu XbrlDocument do objektu XbrlInstanceCollection.
  3. Poté pomocí metody XbrlInstanceCollection.Add() přidejte novou instanci XBRL.
  4. Dále vytvořte instanci třídy Unit s UnitType jako Measure.
  5. Poté přidejte QualifiedName do kolekce MeasureQualifiedNames.
  6. Poté přidejte Unit do kolekce Unit objects.
  7. Nakonec uložte soubor XBRL pomocí metody XbrlDocument.Save(). Jako argument bere cestu k výstupnímu souboru.

Následující ukázka kódu ukazuje, jak přidat objekt jednotky do dokumentu instance XBRL pomocí jazyka C#.

// Tento příklad kódu ukazuje, jak přidat objekt Unit do XBRL.
// Vytvořte instanci třídy XbrlDocument
XbrlDocument document = new XbrlDocument();

// Získejte XbrlInstance
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;

// Přidejte XbrlInstance
xbrlInstances.Add();
XbrlInstance xbrlInstance = xbrlInstances[0];

// Definujte jednotku
Unit unit = new Unit(UnitType.Measure);

// Přidejte název kvalifikátoru
unit.MeasureQualifiedNames.Add(new QualifiedName("USD", "iso4217", "http://www.xbrl.org/2003/iso4217"));

// Přidat jednotku
xbrlInstance.Units.Add(unit);

// Uložte výstupní soubor
document.Save(@"D:\Files\Finance\Output.xbrl");

Přidejte Fact Object do XBRL pomocí C#

Fakta v XBRL jsou definována pomocí prvků položky. Položka v XBRL obsahuje hodnotu prostého faktu a odkaz na kontext pro správnou interpretaci tohoto faktu. Položku můžeme přidat do dokumentu instance XBRL podle následujících kroků:

  1. Nejprve vytvořte instanci třídy XbrlDocument.
  2. Přidejte novou instanci XBRL k instancím objektu XbrlDocument.
  3. Přidejte nový odkaz na schéma k odkazům na schéma objektu XbrlInstance.
  4. Získejte SchemaRef podle jeho indexu ze SchemaRefCollection.
  5. Inicializujte instanci Context a přidejte ji do kolekce objektů Context.
  6. Definujte instanci Unit a přidejte ji do kolekce objektů Unit.
  7. Vytvořte instanci třídy Concept pomocí metody SchemaRef.GetConceptByName().
  8. Vytvořte instanci třídy Item s objektem Concept jako argumentem.
  9. Nastavte vlastnosti položky, jako je ContextRef, UnitRef, Precision, Value atd.
  10. Poté přidejte položku do kolekce Fact objects.
  11. Nakonec uložte soubor XBRL pomocí metody XbrlDocument.Save(). Jako argument bere cestu k výstupnímu souboru.

Následující ukázka kódu ukazuje, jak přidat fakt jako prvek položky v dokumentu instance XBRL pomocí C#.

// Tento příklad kódu ukazuje, jak přidat objekt Fact item do XBRL.
// Vytvořte XbrlDocument
XbrlDocument document = new XbrlDocument();
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;
XbrlInstance xbrlInstance = xbrlInstances[xbrlInstances.Add()];

// Definujte odkaz na schéma
SchemaRefCollection schemaRefs = xbrlInstance.SchemaRefs;
schemaRefs.Add(@"D:\Files\Finance\schema.xsd", "example", "http://example.com/xbrl/taxonomy");
SchemaRef schema = schemaRefs[0];

// Definujte kontext
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);

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

// Získejte koncept
Concept fixedAssetsConcept = schema.GetConceptByName("fixedAssets");
if (fixedAssetsConcept != null)
{
    // Definujte prvek položky pro fakt
    Item item = new Item(fixedAssetsConcept);
    item.ContextRef = context;
    item.UnitRef = unit;
    item.Precision = 4;
    item.Value = "1444";
    
    // Přidejte prvek položky k faktům
    xbrlInstance.Facts.Add(item);
}

// Uložte výstupní soubor
document.Save(@"D:\Files\Finance\Output.xbrl");

Získejte bezplatnou licenci

Můžete získat bezplatnou dočasnou licenci a vyzkoušet knihovnu bez omezení hodnocení.

Závěr

V tomto článku jsme se naučili, jak vytvořit dokument XBRL pomocí C#. Také jsme viděli, jak programově přidat různé objekty XBRL do vytvořeného dokumentu instance XBRL. Kromě toho se můžete dozvědět více o Aspose.Finance for .NET API pomocí dokumentace. V případě jakýchkoliv nejasností nás neváhejte kontaktovat na našem bezplatném fóru podpory.

Viz také