Commit Graph

27 Commits

Author SHA1 Message Date
Robert Dyer
7b7f6c904c Add example of orderBy with a descending order (#583)
This adds an example to show how to change the sort order.
2024-12-23 14:34:45 +00:00
bpaulien
bab4b799d8 Update reference.md (#557)
title case, edited for clarity
2024-12-11 23:58:35 +00:00
bpaulien
06ca5a87f4 Update index.md (#556)
title case, edited for clarity
2024-12-11 23:58:30 +00:00
bpaulien
4e041ce5bf Update types.js (#554)
edited for clarity
2024-12-11 23:58:10 +00:00
bpaulien
7ca1486bb0 Update examples.md (#564)
title case
2024-12-11 23:53:11 +00:00
bpaulien
2894d2f982 Update functions.md (#563)
title case, added words to make it flow better.
2024-12-11 23:53:04 +00:00
bpaulien
5c3d9bea85 Update index.md (#562)
title case, spelling
2024-12-11 23:52:34 +00:00
Matt Fiddaman
842bc40d0c fix some spelling issues, standardis(z)e to US English (#521)
Quick whip through to try and standardis(z)e some language, looks like
the most common English in the docs is US English so I chose that one,
but if we'd prefer the Queen's then that's okay too.

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2024-11-29 06:45:45 +01:00
Tobias Diez
7e2439f781 [WIP] Clarify post-processing in add/importTransactions (#438)
Clarify that `importTransactions` runs rules
2024-08-18 16:14:02 -04:00
Matiss Janis Aboltins
64a254b12d 📝 highlight that Actual does not have a HTTP API (#428) 2024-08-11 20:54:28 +01:00
rodriguestiago0
2f272b9733 Add documentation for holdBudgetForNextMonth and resetBudgetHold (#420)
Docs for [PR](https://github.com/actualbudget/actual/pull/3140)
2024-08-06 18:53:06 +01:00
Matiss Janis Aboltins
48c9efb354 📝 update the API docs information (#414)
Removing some outdated information. The API package has been available
for a while already.
2024-07-26 21:08:49 +01:00
Robert Dyer
ba2f767f83 Add getAccountBalance() API documentation (#403)
Docs for https://github.com/actualbudget/actual/pull/2930.
2024-07-12 08:12:37 -07:00
Matt Fiddaman
c5c5d55782 Add mergePayees to the API reference (#404) 2024-07-12 08:04:09 -07:00
Robert Dyer
aef82dee24 Add API docs for getLocalbudgets() and getRemoteBudgets(). (#377)
API docs for https://github.com/actualbudget/actual/pull/2928.
2024-07-11 13:18:51 -07:00
Robert Dyer
600d130d14 Add missing API documentation. (#373)
This adds missing documentation for existing API calls and removes one
that does not exist.

---------

Co-authored-by: Matiss Janis Aboltins <matiss@mja.lv>
2024-07-01 19:50:36 +01:00
Robert Dyer
cece84e9bc API: add docs for the rules API (#356)
This adds documentation for the new rules API
(https://github.com/actualbudget/actual/pull/2568).
2024-05-20 14:13:50 -07:00
Matiss Janis Aboltins
7360e35ace (api) ability to run bank sync via the API (#350) 2024-05-16 08:38:47 +01:00
Matiss Janis Aboltins
90c454450f 🔥 remove non-existing api methods from api docs (#340)
Removed api methods that do not exist. Since they don't exist - they
should not be in the docs.

It would be nice to implement them though.. but until they are
implemented - lets not mislead people.
2024-03-30 19:54:09 +00:00
qmph22
73ce8f511b Update index.md - "Using the API" (#331)
Added clarity about migrating from YNAB or Mint to Actual. 

Corrected grammatical error about what Actual officially supports for
importing from other budgeting apps.
2024-03-09 09:09:12 -07:00
DJ Mountney
1cb7459803 Add info on self-signed https connections from the API (#288)
Related to https://github.com/actualbudget/actual/issues/1695

It's pretty common for users to have self-signed certificates for
actual, but this presents some challenges for the API.

Give a little bit of guidance here, for new contributors. Really, all
the info here is just for Node.js and not for actual. (we would want to
create seperate http agents and our own certificate config system if we
wanted to have actual specific config for this).

For many of the existing api use-cases the
`NODE_TLS_REJECT_UNAUTHORIZED` option will be fine. But
`NODE_EXTRA_CA_CERTS` seems like the proper way to do things (and the
one I tested on nodejs 21, on ubuntu via asdf install). But I also made
sure to mention the option of using openssl's ca certificates, because
if you are in a situation where your node.js is configured to link to
the system openssl on Linux, it's going to be the easiest and most
familiar to Linux sysadmins. It's just not the cross-platform supported
option like `NODE_EXTRA_CA_CERTS`.
2023-12-12 12:04:44 -07:00
DJ Mountney
f1dccec274 API update learnCategory,runTransfers for addTransactions (#280)
To match changes from https://github.com/actualbudget/actual/pull/1944
2023-11-26 18:17:22 +00:00
Stefan Hall
b26bfc457b Update ynab4 + 5 importer links in api docs (#273)
So they point to existing implementations. The current links are broken
and Im hoping these links are correct - someone please let me know if
this is incorrect, thanks
2023-11-04 09:33:47 +00:00
shall0pass
f0e67d71d4 Spellchecker CI (#228) 2023-07-15 10:41:33 -04:00
Jed Fox
b84d3f0a75 Fix errors in import example (#215)
ref:
https://discord.com/channels/937901803608096828/1122664924582260786/1123052436219760691
2023-06-27 16:38:40 -04:00
Jed Fox
d61dbea744 A few minor updates (#194)
- fix broken issue link
- tweak the typography in the API docs
2023-06-13 05:19:50 +01:00
Jed Fox
5d433c617e Reorganize page URLs to match the sidebar (#185)
Principles:

- lowercase URLs only
- kebab-case
- generally match sidebar structure
2023-06-12 15:20:06 -04:00