Public/New-LedgerJournal.ps1
|
<# .SYNOPSIS Creates a new PSLedger journal. .DESCRIPTION Creates a new journal directory at the specified path with a journal.txt file containing company information. The journal is the top-level container for all bookkeeping data including chart of accounts, fiscal years, and verifications. .PARAMETER Path The path where the journal directory will be created. Typically ends with .ledger (e.g. 'C:\Bookkeeping\MyCompany.ledger'). .PARAMETER Name The company or organisation name. .PARAMETER OrgNumber Optional organisation number (e.g. '556677-8899'). .PARAMETER CompanyType Optional company form. One of AB (aktiebolag), EF (enskild firma), HB (handelsbolag) or KB (kommanditbolag). Drives year-end defaults such as which equity account the net result is booked to. .PARAMETER Metadata Optional hashtable of additional free-form company fields to store, such as @{ VatNumber = 'SE556677889901'; Email = 'info@firma.se' }. Keys must be simple identifiers; the reserved keys Name, OrgNumber, SchemaVersion and CompanyType are not allowed (use the dedicated parameters instead). .PARAMETER PassThru If specified, returns the created/updated journal. By default the command produces no output. .EXAMPLE New-LedgerJournal -Path .\MinFirma.ledger -Name 'MinFirma AB' Creates a basic journal without an organisation number. .EXAMPLE New-LedgerJournal -Path C:\Bokföring\Konsult.ledger -Name 'Konsult AB' -OrgNumber '556677-8899' -CompanyType AB -Metadata @{ VatNumber = 'SE556677889901' } Creates a journal with full company details including company form and a VAT number. #> function New-LedgerJournal { [OutputType([pscustomobject])] [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory)] [string]$Path, [Parameter(Mandatory)] [string]$Name, [string]$OrgNumber, [string]$CompanyType, [hashtable]$Metadata, [Parameter()] [switch]$PassThru ) if (Test-Path $Path) { throw "Journal already exists: $Path" } if ($CompanyType) { Test-LedgerCompanyType -CompanyType $CompanyType } if (-not $PSCmdlet.ShouldProcess($Path, 'Create journal')) { return } New-Item -ItemType Directory -Path $Path -Force | Out-Null $Lines = @( "; PSLedger Journal" "; Created: $(Get-Date -Format 'yyyy-MM-dd HH:mm:ss')" "" "SchemaVersion: $script:CurrentSchemaVersion" "Name: $(Format-LedgerMetadataValue -Value $Name)" ) if ($OrgNumber) { $Lines += "OrgNumber: $(Format-LedgerMetadataValue -Value $OrgNumber)" } if ($CompanyType) { $Lines += "CompanyType: $CompanyType" } if ($Metadata) { foreach ($Key in $Metadata.Keys) { Test-LedgerMetadataKey -Key $Key $Value = Format-LedgerMetadataValue -Value ([string]$Metadata[$Key]) if (-not [string]::IsNullOrEmpty($Value)) { $Lines += "${Key}: $Value" } } } $JournalFile = Join-Path $Path 'journal.txt' Set-LedgerFileContent -Path $JournalFile -Value $Lines if ($PassThru) { Get-LedgerJournal -Path $Path } } |