Giter VIP home page Giter VIP logo

developers's Introduction

Current Status

The developer API is officially in open public beta. During this time, please continue to heed caution and use this API at your own risk as any and all changes are irreversible.

We welcome feedback via email ([email protected]). These docs are also on Github, so if you see a mistake or something that could be improved, feel free to open a pull request!

developers's People

Contributors

adamtaylor13 avatar chachan avatar daynil avatar douwem avatar icco avatar iloveitaly avatar jpjpjp avatar juftin avatar justin-pierce avatar lunchbag avatar mdolbin avatar mmenanno avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

developers's Issues

Document external ID

It's unclear exactly what the external ID does. Is it just transaction metadata? It seems to protect against duplicates. However, if you delete transaction(s) in LM it's not clear if you can add another transaction with the same external ID again.

User Object Doesn't Correspond to JSON Response

https://github.com/lunch-money/developers/blob/master/source/includes/_user.md#user-object

The fields on the user object don't match the JSON response (i.e. the field is called "user_id" instead of "id")

Attribute Name Type Description
id number Unique identifier for user
name string User's' name
email string User's email
account_id number Unique identifier for the associated budgeting account
budget_name string Name of the associated budgeting account

Get User

Use this endpoint to get details on the current user.

{
  "user_name": "User 1",
  "user_email": "[email protected]",
  "user_id": 18328,
  "account_id": 18221,
  "budget_name": "๐Ÿ  Family budget"
}

Nullable attributes

It would be nice if the various Object documentations had a column listing which attributes are nullable. Some of them currently say so in their description, but some do not.

Document missing fields on Budget object

The Budget object can always returns an order and archived field and sometimes returns a recurring field. All of which are currently undocumented.

Example recurring field object returned

"recurring": {
  "list": [
    {"payee": "Apple", "amount": "38.3600", "currency": "cad", "to_base": 38.36},
    {"payee": "Weebly", "amount": "25.0000", "currency": "cad", "to_base": 25}
  ]
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.