rubynor / rubynor/stemplin

JSON output of reports

Open
#428 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Ruby
Stars
53
Forks
6
Avg merge
3d 20h
Merged PRs (30d)
6

Description

As a person who issues invoices, I would like to have invoice drafts created automatically based on time registrations for a specific period.

This could be made possible by exposing stemplin Report pages in JSON format. The existing URL params for the html version should work for .json as well. Based on this, a script could be made to read the exports and create the invoice drafts in our invoicing system.

Token based Authentication would most likely be a requirement for this to work smoothly.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Report pages and the existing HTML URL parameters. Determine how those parameters should apply to a JSON representation and what invoice data it must expose, then clarify the token-based authentication requirement. Done means period-filtered report data is available to an external invoicing script without breaking the HTML reports.

Written by the indexing model from the issue text.

Assessment

Tech stack
rails, ruby
Domain
api, authentication
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.