Blyx

Ibis

Workflow framework · 0.1.1

Reconcile an invoice with split payments in integer minor units.

Reconcile split invoice payments

Two invoice lines total 300 minor units. The payments total 325, leaving 25 as credit.

Run the native CLI

Extract the workflow collection for your platform. Run .\bin\ibis.exe --help in PowerShell or ./bin/ibis --help on Linux and macOS. Running the command with no arguments prints the worked example.

Build from source

With Blyx 0.2.1, Rust and a host linker installed, run these commands to edit and rebuild the example.

git clone --depth 1 --branch v0.1.1 https://github.com/Rahulchaube1/blyx-ibis.git
cd blyx-ibis
blyxc native-run project.blyx -- "2,1" "125,50" "200,125"

Why this framework exists

Partial payments and overpayments must remain distinguishable when an invoice is reconciled. GnuCash, accounts receivable

Install Ibis in your editor

Extension RahulChaube.blyx-ibis · 0.1.0

The extension includes a runnable Blyx example, function completions and the framework source. For the modular project, extract the starter, open its folder and run blyxc native-run main.blyx with the native toolchain installed.

Create an empty .blyx file, type blyx-ibis-demo and accept the completion. Choose Blyx: Run File to run the example.

For an offline installation, choose Extensions: Install from VSIX for Blyx Language first, then for Ibis.

Download the companion Blyx Language VSIX

Libraries in this framework

Install with Conda

Create an environment containing Ibis 0.1.1, its Blyx source and a runnable example. Run the second command with Blyx 0.2.1, Rust and a host linker installed.

conda create -y --prefix ./blyx-env --override-channels -c https://rahulchaube1.github.io/blyx-packages blyx-ibis=0.1.1=0
blyxc native-run ./blyx-env/share/blyx/ibis/main.blyx

To use this package in your application, copy share/blyx/ibis/vendor/ibis from the environment into your project's vendor directory.

Install the full collection with Homebrew or Scoop

Import into a Blyx project

Install Blyx 0.2.1, Rust 1.85 or newer and a host linker. From the directory containing your entry file, clone this tagged release.

git clone --depth 1 --branch v0.1.1 https://github.com/Rahulchaube1/blyx-ibis.git vendor/ibis

You can also download Ibis as a ZIP. Extract its contents into vendor/ibis.

Save this as main.blyx beside vendor and run blyxc native-run main.blyx.

use vendor::ibis::ibis;

fn main() {
    let units = [2, 1];
    let prices = [125, 50];
    let payments = [200, 125];
    let result = ibis_reconcile(units, prices, payments);
    if len(result) == 0 { println!("invalid"); return; }
    let mut i = 0;
    while i < len(result) {
        println!(at(result, i));
        i += 1;
    }
}

Expected output

300
300
0
25

API and input requirements

Returns [subtotal, applied payment, open balance, credit]. Use a single currency and already-posted amounts. Invalid arguments and nonfinite results return an empty vector.

APIUse
ibis_reconcile(units, prices, payments)Returns [subtotal, applied payment, open balance, credit]. Use a single currency and already-posted amounts.

Develop and contribute

Open the tagged source to read the implementation and examples. Include the smallest reproducible Blyx program, compiler version and expected result when reporting an issue.