README
¶
moov-io/irs
IRS implemented a reader, writer, and HTTP server for IRS electronic Filing Information Returns Electronically (FIRE). Our tools and library operate at higher levels (JSON) which makes it easier for developers to leverage over the raw bytes (ASCII).
| Input | Output |
|---|---|
| JSON | JSON |
| ASCII FIRE | ASCII FIRE |
| PDF Form | |
| SQL |
Docs: Project | API Endpoints
Project Status
We are just getting started!
- 1099-MISC About Form 1099-MISC
- 1099-NEC About Form 1099-NEC
... more to come, open an issue or pull request!
Commands
Irs has command line interface to manage irs files and to lunch web service.
irs --help
Usage:
[command]
Available Commands:
convert Convert irs file format
help Help about any command
print Print irs file
validator Validate irs file
web Launches web server
Flags:
-h, --help help for this command
--input string input file (default is $PWD/irs.json)
Use " [command] --help" for more information about a command.
Each interaction that the library supports is exposed in a command-line option:
| Command | Info |
|---|---|
convert |
The convert command allows users to convert from a irs file to another format file. Result will create a irs file. |
print |
The print command allows users to print a irs file with special file format (json, irs). |
validator |
The validator command allows users to validate a irs file. |
web |
The web command will launch a web server with endpoints to manage irs files. |
file convert
irs convert --help
Usage:
convert [output] [flags]
Flags:
--format string format of irs file(required) (default "json")
-h, --help help for convert
Global Flags:
--input string input file (default is $PWD/irs.json)
The output parameter is the full path name to convert new irs file. The format parameter is supported 2 types, "json" and "irs". The generate parameter will replace new generated trailer record in the file. The input parameter is source irs file, supported raw type file and json type file.
example:
irs convert output/output.json --input testdata/packed_file.json --format json
file print
irs print --help
Usage:
print [flags]
Flags:
--format string print format (default "json")
-h, --help help for print
Global Flags:
--input string input file (default is $PWD/irs.json)
The format parameter is supported 2 types, "json" and "irs". The input parameter is source irs file, supported raw type file and json type file.
file validate
irs validator --help
Usage:
validator [flags]
Flags:
-h, --help help for validator
Global Flags:
--input string input file (default is $PWD/irs.json)
The input parameter is source irs file, supported raw type file and json type file.
example:
irs validator --input testdata/packed_file.dat
Error: is an invalid value of TotalConsumerSegmentsJ1
irs validator --input testdata/packed_file.json
web server
irs web --help
Usage:
web [flags]
Flags:
-h, --help help for web
-t, --test test server
Global Flags:
--input string input file (default is $PWD/irs.json)
The port parameter is port number of web service.
irs web
Web server have some endpoints to manage irs file
| Method | Endpoint | Content-Type | Info |
|---|---|---|---|
POST |
/convert |
multipart/form-data | convert irs file. will download new file. |
GET |
/health |
text/plain | check web server. |
POST |
/print |
multipart/form-data | print irs file. |
POST |
/validator |
multipart/form-data | validate irs file. |
web page example to use irs web server:
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Single file upload</title>
</head>
<body>
<h1>Upload single file with fields</h1>
<form action="http://localhost:8208/convert" method="post" enctype="multipart/form-data">
Format: <input type="text" name="format"><br>
Files: <input type="file" name="file"><br><br>
<input type="submit" value="Submit">
</form>
</body>
</html>
Docker
You can run the moov/irs Docker image which defaults to starting the HTTP server.
docker run -p 8208:8208 moov/irs:latest
Getting Started
Read through the project docs over here to get an understanding of the purpose of this project and how to run it.
Getting Help
| channel | info |
|---|---|
| Project Documentation | Our project documentation available online. |
| Twitter @moov | You can follow Moov.io's Twitter feed to get updates on our project(s). You can also tweet us questions or just share blogs or stories. |
| GitHub Issue | If you are able to reproduce a problem please open a GitHub Issue under the specific project that caused the error. |
| moov-io slack | Join our slack channel (#irs) to have an interactive discussion about the development of the project. |
Supported and Tested Platforms
- 64-bit Linux (Ubuntu, Debian), macOS, and Windows
Contributing
Yes please! Please review our Contributing guide and Code of Conduct to get started! Checkout our issues for first time contributors for something to help out with.
This project uses Go Modules and uses Go 1.14 or higher. See Golang's install instructions for help setting up Go. You can download the source code and we offer tagged and released versions as well. We highly recommend you use a tagged release for production.
Test Coverage
Improving test coverage is a good candidate for new contributors while also allowing the project to move more quickly by reducing regressions issues that might not be caught before a release is pushed out to our users. One great way to improve coverage is by adding edge cases and different inputs to functions (or contributing and running fuzzers).
Tests can run processes (like sqlite databases), but should only do so locally.
License
Apache License 2.0 See LICENSE for details.
Documentation
Source Files
Directories