https://github.com/invopop/gobl
Go Business Language
https://github.com/invopop/gobl
gobl
Last synced: about 2 months ago
JSON representation
Go Business Language
- Host: GitHub
- URL: https://github.com/invopop/gobl
- Owner: invopop
- License: apache-2.0
- Created: 2020-09-02T14:50:03.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-09-25T15:30:23.000Z (6 months ago)
- Last Synced: 2025-09-25T17:35:54.351Z (6 months ago)
- Topics: gobl
- Language: Go
- Homepage:
- Size: 6.56 MB
- Stars: 207
- Watchers: 8
- Forks: 22
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Notice: NOTICE
Awesome Lists containing this project
- awesome-go-cn - gobl
- fucking-awesome-go - gobl - Invoice and billing document framework. JSON Schema based. Automates tax calculations and validation, with tooling to convert into global formats. (Financial / Search and Analytic Databases)
- awesome-go - gobl - Invoice and billing document framework. JSON Schema based. Automates tax calculations and validation, with tooling to convert into global formats. (Financial / Search and Analytic Databases)
- awesome-go-with-stars - gobl - 03-03 | (Financial / Search and Analytic Databases)
- awesome-go - invopop/gobl
- awesome-go - gobl - Invoice and billing document framework. JSON Schema based. Automates tax calculations and validation, with tooling to convert into global formats. (Financial / Search and Analytic Databases)
README
# GOBL
Go Business Language. Core library, schemas, and CLI.
Released under the Apache 2.0 [LICENSE](https://github.com/invopop/gobl/blob/main/LICENSE), Copyright 2021-2025 [Invopop S.L.](https://invopop.com).
[](https://github.com/invopop/gobl/actions/workflows/lint.yaml)
[](https://github.com/invopop/gobl/actions/workflows/test.yaml)
[](https://goreportcard.com/report/github.com/invopop/gobl)
[](https://codecov.io/gh/invopop/gobl)
[](https://godoc.org/github.com/invopop/gobl)
[](https://deepwiki.com/invopop/gobl)
[](https://github.com/avelino/awesome-go)
[Official GOBL documentation site](https://docs.gobl.org).
## Introduction
GOBL, the Go Business Language library and tools, aim to:
- Help developers build electronic business documents, especially invoices, anywhere in the world.
- Define a set of open [JSON Schema](https://json-schema.org/).
- Build a global database of local tax categories and, whenever practical to do so, provide current and historical tax rates in code.
- Validate business documents according to local requirements, including tax ID validation.
- Define the algorithms used to make tax calculations while avoiding rounding errors.
- Provide built-in support for signing documents using [JSON Web Signatures](https://en.wikipedia.org/wiki/JSON_Web_Signature).
- Output simple and easy-to-read JSON documents that emphasize the use of keys instead of abstract codes, like `credit-transfer` instead of `30` (UNTDID4461 code for sender-initiated bank or wire transfer).
- Be flexible enough to support extreme local complexity but produce output that is easily legible in other countries.
- Build a global community of contributors tired of the complexity of current standards based on XML or EDI.
For examples on what GOBL document data looks like, please see the [examples directory](https://github.com/invopop/gobl/tree/main/examples).
## Community
The complexity around invoicing, particularly electronic invoicing, can quickly become overwhelming. Check out the following resources and get in touch:
- [Documentation](https://docs.gobl.org) contains details on how to use GOBL, and the schema.
- [Builder](https://build.gobl.org) helps try out GOBL and quickly figure out what is possible, all from your browser.
- [Issues](https://github.com/invopop/gobl/issues) if you have a specific problem with GOBL related to code or usage.
- [Discussions](https://github.com/invopop/gobl/discussions) for open discussions about the future of GOBL, complications with a specific country, or any open-ended issues.
- [Pull Requests](https://github.com/invopop/gobl/pulls) are very welcome, especially if you'd like to see a new local country or features.
- [Slack](https://join.slack.com/t/goblschema/shared_invite/zt-20qu1s0cm-AUE8oYbGly681EsYdDiqxw) for real-time chat about something specific or urgent. We always encourage you to use one of the other options, which are indexed and searchable, but if you'd like to bring something to attention quickly, this is a great resource.
## Companion Projects
GOBL makes it easy to create business documents, like invoices, but check out some of the companion projects that help create, use, and convert into other formats:
- [Builder](https://github.com/invopop/gobl.builder) - Available to try at [build.gobl.org](https://build.gobl.org), this tool makes it easy to build, test, and discover the features of GOBL using the [wasm](https://webassembly.org/) binary in the browser.
- [Generator](https://github.com/invopop/gobl.generator) - Ruby project to convert GOBL JSON Schema into libraries for other languages or documentation.
- [Docs](https://github.com/invopop/gobl.docs) - Content of the official GOBL Documentation Site [docs.gobl.org](https://docs.gobl.org).
- [GOBL for Ruby](https://github.com/invopop/gobl.ruby) - Easily build or read GOBL documents in Ruby.
Conversion to local and international formats:
- [GOBL to HTML](https://github.com/invopop/gobl.html) - generate printable versions of GOBL documents ready to be converted to PDF.
- [GOBL to FacturaE (Spain)](https://github.com/invopop/gobl.facturae) - convert into the [Spanish FacturaE](https://www.facturae.gob.es/Paginas/Index.aspx) format.
- [GOBL to CFDI (Mexico)](https://github.com/invopop/gobl.cfdi) - convert into the Mexican CFDI format.
- [GOBL to FatturaPA (Italy)](https://github.com/invopop/gobl.fatturapa) - convert into the [Italian FatturaPA](https://www.fatturapa.gov.it/it/index.html) format.
- [GOBL to FA_VAT / KSeF (Poland)](https://github.com/invopop/gobl.ksef) - convert to the Polish FA_VAT format and send to [KSeF](https://www.podatki.gov.pl/ksef/)
- [GOBL to TicketBAI (Spain/Euskadi)](https://github.com/invopop/gobl.ticketbai) - convert into [TicketBAI](https://www.batuz.eus/fitxategiak/batuz/ticketbai/ticketBaiV1-2.xsd) documents, required in the Euskadi (northern region of Spain)
- [GOBL to VERI\*FACTU (Spain)](https://github.com/invopop/gobl.verifactu) - convert and send to the Spanish tax authorities.
- [GOBL UBL](https://github.com/invopop/gobl.ubl) - convert to and from the OASIS Universal Business Language, including support for local and global profiles such as for Peppol and XRechnung (Germany)
- [GOBL CII](https://github.com/invopop/gobl.cii) - convert to and from the Cross Industry Invoice (CII) XML format, including regional variants including Factur-X (France), ZUGFeRD and XRechnung (Germany).
- [GOBL to Stripe](https://github.com/invopop/gobl.stripe) - support for creating GOBL invoices from stripe API data.
## Usage
GOBL is primarily a Go library, so the following instructions assume you'd like to build documents from your own Go applications. See some of the links above if you'd like to develop in another language or use a CLI.
### Installation
Run the following command to install the package:
```
go get github.com/invopop/gobl
```
### Building an Invoice
There are many different ways to get data into GOBL, but for the following example, we're going to try to build an invoice in several steps.
First define a minimal or "partial" GOBL Invoice Document:
```go
inv := &bill.Invoice{
Series: "F23",
Code: "00010",
IssueDate: cal.MakeDate(2023, time.May, 11),
Supplier: &org.Party{
TaxID: &tax.Identity{
Country: l10n.US,
},
Name: "Provider One Inc.",
Alias: "Provider One",
Emails: []*org.Email{
{
Address: "billing@provideone.com",
},
},
Addresses: []*org.Address{
{
Number: "16",
Street: "Jessie Street",
Locality: "San Francisco",
Region: "CA",
Code: "94105",
Country: l10n.US,
},
},
},
Customer: &org.Party{
Name: "Sample Customer",
Emails: []*org.Email{
{
Address: "email@sample.com",
},
},
},
Lines: []*bill.Line{
{
Quantity: num.MakeAmount(20, 0),
Item: &org.Item{
Name: "A stylish mug",
Price: num.MakeAmount(2000, 2),
Unit: org.UnitHour,
},
Taxes: []*tax.Combo{
{
Category: common.TaxCategoryST,
Percent: num.NewPercentage(85, 3),
},
},
},
},
}
```
Notice that the are no sums or calculations yet. The next step involves "inserting" the invoice document into an "envelope". In GOBL, we use the concept of an envelope to hold data and provide functionality to guarantee that no modifications have been made to the payload.
Insert our previous Invoice into an envelope as follows:
```go
// Prepare an "Envelope"
env := gobl.NewEnvelope()
if err := env.Insert(inv); err != nil {
panic(err)
}
```
## CLI
This repo contains a `gobl` CLI tool which can be used to manipulate GOBL documents from the command line or shell scripts.
Build with:
```sh
mage -v build
```
Install with:
```sh
mage -v install
```
### Build
Build expects a partial GOBL Envelope or Document, in either YAML or JSON as input. It'll automatically run the Calculate and Validate methods and output JSON data as either an envelope or document, according to the input source.
Example uses:
```sh
# Calculate and validate a YAML invoice
gobl build ./examples/es/invoice-es-es.yaml
# Output using indented formatting
gobl build -i ./examples/es/party.yaml
# Set the supplier from an external file
gobl build -i ./examples/es/invoice-es-es.yaml \
--set-file customer=./examples/es/party.yaml
# Set arbitrary values from the command line. Inputs are parsed as YAML.
gobl build -i ./examples/es/invoice-es-es.yaml \
--set meta.bar="a long string" \
--set series="TESTING"
# Set the top-level object:
gobl build -i ./examples/es/invoice-es-es.yaml \
--set-file .=./examples/es/invoice-es-es.env.yaml
# Insert a document into an envelope
gobl build -i --envelop ./examples/es/invoice-es-es.yaml
```
### Correct
The GOBL CLI makes it easy to use the library and tax regime specific functionality that create a corrective document that reverts or amends a previous document. This is most useful for invoices and issuing refunds for example.
```sh
# Correct an invoice with a credit note (this will error for ES invoice!)
gobl correct -i ./examples/es/invoice-es-es.yaml --credit
# Specify tax regime specific details
gobl correct -i -d '{"credit":true,"changes":["line"],"method":"complete"}' \
./examples/es/invoice-es-es.yaml
```
### Sign
GOBL encourages users to sign data embedded into envelopes using digital signatures. To get started, you'll need to have a JSON Web Key. Use the following commands to generate one:
```sh
# Generate a JSON Web Key and store in ~/.gobl/id_es256.jwk
gobl keygen
# Generate and output a JWK into a new file
gobl keygen ./examples/key.jwk
```
Use the key to sign documents:
```sh
# Add a signature to the envelope using our personal key
gobl sign -i ./examples/es/invoice-es-es.env.yaml
# Add a signature using a specific key
gobl sign -i --key ./examples/key.jwk ./examples/es/invoice-es-es.env.yaml
```
It is only possible to sign non-draft envelopes, so the CLI will automatically remove this flag during the signing process. This implies that the document must be completely valid before signing.
## Development
GOBL uses the `go generate` command to automatically generate JSON schemas, definitions, and some Go code output. After any changes, be sure to run:
```bash
go generate .
```