Skip to content

Added doc for ledger entry entity for Export API.#44

Open
prazi wants to merge 5 commits intomainfrom
FINTECH-17023-add-ledgerentry-doc
Open

Added doc for ledger entry entity for Export API.#44
prazi wants to merge 5 commits intomainfrom
FINTECH-17023-add-ledgerentry-doc

Conversation

@prazi
Copy link
Copy Markdown

@prazi prazi commented Apr 13, 2026

Summary

We added LedgerEntry entity and exposed it via Export API, but we never update documentation related to that entity.
Adding it as part of the Export API now, so partners understand that entity.
https://mews.atlassian.net/browse/FINTECH-17023

Checklist

  • Documentation follows the contribution guidelines
  • Changelog accurately describes all changes
  • All hyperlinks tested
  • SUMMARY.md updated if new pages added

API

  • Changelog highlights the affected endpoints or operations
  • Changelog highlights any deprecations
  • Deprecation Table updated if any deprecations

@prazi prazi self-assigned this Apr 13, 2026
@prazi prazi requested a review from a team as a code owner April 13, 2026 11:06
Copilot AI review requested due to automatic review settings April 13, 2026 11:06
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates Connector API reference docs to include the LedgerEntry entity in the Export API and documents the associated export filters, with a corresponding changelog entry so partners can discover the addition.

Changes:

  • Extended Export API filter documentation with LedgerEntryFilters and its Posting date interval.
  • Added a Ledger entry entity schema and related enums to exports.md.
  • Added a 2026-04-13 changelog entry describing the Export API documentation update.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
connector-api/operations/exports.md Documents LedgerEntryFilters and adds the Ledger entry entity + enums in Export API docs.
connector-api/changelog/README.md Adds a dated changelog entry describing the Export API LedgerEntry documentation update.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 13, 2026 11:40
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 13, 2026 11:45
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@jonas-paul
Copy link
Copy Markdown
Contributor

@prazi The operations part of the docs are auto-generated, so we should find a better place to describe this export. It's a bit tricky since ledger entries are not exposed via the API. Maybe it could be a part of exports contracts. @jnv Do you have any ideas?

@jnv
Copy link
Copy Markdown
Member

jnv commented Apr 14, 2026

@prazi The operations part of the docs are auto-generated, so we should find a better place to describe this export. It's a bit tricky since ledger entries are not exposed via the API. Maybe it could be a part of exports contracts. @jnv Do you have any ideas?

We've already discussed it, I will move the manually added part to a separate document.

@jonas-paul
Copy link
Copy Markdown
Contributor

The changes to exports.md are missing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants