service/src/doc/asciidoc/api-docs.adoc

== Apache Fineract CN Financial Accounting API Documentation ==

== Accounts ==

==== Create An Account ====

.curl-request
include::{snippets}/test-account/should-create-account/curl-request.adoc[]

.http-request
include::{snippets}/test-account/should-create-account/http-request.adoc[]

.http-response
include::{snippets}/test-account/should-create-account/http-response.adoc[]

.httpie-request
include::{snippets}/test-account/should-create-account/httpie-request.adoc[]

==== Get An Account ====

.curl-request
include::{snippets}/test-account/should-find-account/curl-request.adoc[]

.http-request
include::{snippets}/test-account/should-find-account/http-request.adoc[]

.http-response
include::{snippets}/test-account/should-find-account/http-response.adoc[]

.httpie-request
include::{snippets}/test-account/should-find-account/httpie-request.adoc[]

==== Get An Account Using Alternative Account Number ====

.curl-request
include::{snippets}/test-account/should-find-account-with-alternative-account-number/curl-request.adoc[]

.http-request
include::{snippets}/test-account/should-find-account-with-alternative-account-number/http-request.adoc[]

.http-response
include::{snippets}/test-account/should-find-account-with-alternative-account-number/http-response.adoc[]

.httpie-request
include::{snippets}/test-account/should-find-account-with-alternative-account-number/httpie-request.adoc[]

==== Get Accounts ====

.curl-request
include::{snippets}/test-account/should-fetch-accounts/curl-request.adoc[]

.http-request
include::{snippets}/test-account/should-fetch-accounts/http-request.adoc[]

.http-response
include::{snippets}/test-account/should-fetch-accounts/http-response.adoc[]

.httpie-request
include::{snippets}/test-account/should-fetch-accounts/httpie-request.adoc[]

==== Get Account Entries ====

.curl-request
include::{snippets}/test-account/should-list-account-entries/curl-request.adoc[]

.http-request
include::{snippets}/test-account/should-list-account-entries/http-request.adoc[]

.http-response
include::{snippets}/test-account/should-list-account-entries/http-response.adoc[]

.httpie-request
include::{snippets}/test-account/should-list-account-entries/httpie-request.adoc[]

== Update Account Details ==

==== Update An Account ====

.curl-request
include::{snippets}/test-account/should-modify-account/curl-request.adoc[]

.http-request
include::{snippets}/test-account/should-modify-account/http-request.adoc[]

.http-response
include::{snippets}/test-account/should-modify-account/http-response.adoc[]

.httpie-request
include::{snippets}/test-account/should-modify-account/httpie-request.adoc[]

==== Delete An Account ====

.curl-request
include::{snippets}/test-account/should-delete-account/curl-request.adoc[]

.http-request
include::{snippets}/test-account/should-delete-account/http-request.adoc[]

.http-response
include::{snippets}/test-account/should-delete-account/http-response.adoc[]

.httpie-request
include::{snippets}/test-account/should-delete-account/httpie-request.adoc[]

== Command An Account ==

==== List An Account's Commands ====

.curl-request
include::{snippets}/test-account/should-return-only-available-commands/curl-request.adoc[]

.http-request
include::{snippets}/test-account/should-return-only-available-commands/http-request.adoc[]

.http-response
include::{snippets}/test-account/should-return-only-available-commands/http-response.adoc[]

.httpie-request
include::{snippets}/test-account/should-return-only-available-commands/httpie-request.adoc[]

==== Lock An Account ====

.curl-request
include::{snippets}/test-account/should-lock-account/curl-request.adoc[]

.http-request
include::{snippets}/test-account/should-lock-account/http-request.adoc[]

.http-response
include::{snippets}/test-account/should-lock-account/http-response.adoc[]

.httpie-request
include::{snippets}/test-account/should-lock-account/httpie-request.adoc[]

==== Unlock An Account ====

.curl-request
include::{snippets}/test-account/should-unlock-account/curl-request.adoc[]

.http-request
include::{snippets}/test-account/should-unlock-account/http-request.adoc[]

.http-response
include::{snippets}/test-account/should-unlock-account/http-response.adoc[]

.httpie-request
include::{snippets}/test-account/should-unlock-account/httpie-request.adoc[]

==== Close An Account ====

.curl-request
include::{snippets}/test-account/should-close-account/curl-request.adoc[]

.http-request
include::{snippets}/test-account/should-close-account/http-request.adoc[]

.http-response
include::{snippets}/test-account/should-close-account/http-response.adoc[]

.httpie-request
include::{snippets}/test-account/should-close-account/httpie-request.adoc[]

==== Reopen An Account ====

.curl-request
include::{snippets}/test-account/should-reopen-account/curl-request.adoc[]

.http-request
include::{snippets}/test-account/should-reopen-account/http-request.adoc[]

.http-response
include::{snippets}/test-account/should-reopen-account/http-response.adoc[]

.httpie-request
include::{snippets}/test-account/should-reopen-account/httpie-request.adoc[]

== Ledgers ==

==== Create A Ledger ====

.curl-request
include::{snippets}/test-ledger/should-create-ledger/curl-request.adoc[]

.http-request
include::{snippets}/test-ledger/should-create-ledger/http-request.adoc[]

.http-response
include::{snippets}/test-ledger/should-create-ledger/http-response.adoc[]

.httpie-request
include::{snippets}/test-ledger/should-create-ledger/httpie-request.adoc[]

==== Get A Ledger ====

.curl-request
include::{snippets}/test-ledger/should-find-ledger/curl-request.adoc[]

.http-request
include::{snippets}/test-ledger/should-find-ledger/http-request.adoc[]

.http-response
include::{snippets}/test-ledger/should-find-ledger/http-response.adoc[]

.httpie-request
include::{snippets}/test-ledger/should-find-ledger/httpie-request.adoc[]

==== Get Ledgers ====

.curl-request
include::{snippets}/test-ledger/should-fetch-ledgers/curl-request.adoc[]

.http-request
include::{snippets}/test-ledger/should-fetch-ledgers/http-request.adoc[]

.http-response
include::{snippets}/test-ledger/should-fetch-ledgers/http-response.adoc[]

.httpie-request
include::{snippets}/test-ledger/should-fetch-ledgers/httpie-request.adoc[]

==== Get A Ledger's Sub Ledgers ====

.curl-request
include::{snippets}/test-ledger/should-fetch-sub-ledgers/curl-request.adoc[]

.http-request
include::{snippets}/test-ledger/should-fetch-sub-ledgers/http-request.adoc[]

.http-response
include::{snippets}/test-ledger/should-fetch-sub-ledgers/http-response.adoc[]

.httpie-request
include::{snippets}/test-ledger/should-fetch-sub-ledgers/httpie-request.adoc[]

==== Get A Ledger's Accounts ====

.curl-request
include::{snippets}/test-ledger/should-stream-all-accounts-belonging-to-ledger/curl-request.adoc[]

.http-request
include::{snippets}/test-ledger/should-stream-all-accounts-belonging-to-ledger/http-request.adoc[]

.http-response
include::{snippets}/test-ledger/should-stream-all-accounts-belonging-to-ledger/http-response.adoc[]

.httpie-request
include::{snippets}/test-ledger/should-stream-all-accounts-belonging-to-ledger/httpie-request.adoc[]

==== Update A Ledger ====

.curl-request
include::{snippets}/test-ledger/should-modify-ledger/curl-request.adoc[]

.http-request
include::{snippets}/test-ledger/should-modify-ledger/http-request.adoc[]

.http-response
include::{snippets}/test-ledger/should-modify-ledger/http-response.adoc[]

.httpie-request
include::{snippets}/test-ledger/should-modify-ledger/httpie-request.adoc[]

==== Add A Sub Ledger ====

.curl-request
include::{snippets}/test-ledger/should-add-sub-ledger/curl-request.adoc[]

.http-request
include::{snippets}/test-ledger/should-add-sub-ledger/http-request.adoc[]

.http-response
include::{snippets}/test-ledger/should-add-sub-ledger/http-response.adoc[]

.httpie-request
include::{snippets}/test-ledger/should-add-sub-ledger/httpie-request.adoc[]

==== Delete A Ledger ====

.curl-request
include::{snippets}/test-ledger/should-delete-ledger/curl-request.adoc[]

.http-request
include::{snippets}/test-ledger/should-delete-ledger/http-request.adoc[]

.http-response
include::{snippets}/test-ledger/should-delete-ledger/http-response.adoc[]

.httpie-request
include::{snippets}/test-ledger/should-delete-ledger/httpie-request.adoc[]

== Journals ==

==== Create A Journal Entry ====

.curl-request
include::{snippets}/test-journal/should-create-journal-entry/curl-request.adoc[]

.http-request
include::{snippets}/test-journal/should-create-journal-entry/http-request.adoc[]

.http-response
include::{snippets}/test-journal/should-create-journal-entry/http-response.adoc[]

.httpie-request
include::{snippets}/test-journal/should-create-journal-entry/httpie-request.adoc[]

==== Get Journal Entries Within Date Range ====

.curl-request
include::{snippets}/test-journal/should-fetch-journal-entries-with-date-range/curl-request.adoc[]

.http-request
include::{snippets}/test-journal/should-fetch-journal-entries-with-date-range/http-request.adoc[]

.http-response
include::{snippets}/test-journal/should-fetch-journal-entries-with-date-range/http-response.adoc[]

.httpie-request
include::{snippets}/test-journal/should-fetch-journal-entries-with-date-range/httpie-request.adoc[]

==== Get Journal Entries Within Date Range And Account ====

.curl-request
include::{snippets}/test-journal/should-fetch-journal-entries-with-date-range-and-account/curl-request.adoc[]

.http-request
include::{snippets}/test-journal/should-fetch-journal-entries-with-date-range-and-account/http-request.adoc[]

.http-response
include::{snippets}/test-journal/should-fetch-journal-entries-with-date-range-and-account/http-response.adoc[]

.httpie-request
include::{snippets}/test-journal/should-fetch-journal-entries-with-date-range-and-account/httpie-request.adoc[]

==== Get Journal Entries Within Date Range, Account And Amount ====

.curl-request
include::{snippets}/test-journal/should-fetch-journal-entries-with-date-range-and-account-and-amount/curl-request.adoc[]

.http-request
include::{snippets}/test-journal/should-fetch-journal-entries-with-date-range-and-account-and-amount/http-request.adoc[]

.http-response
include::{snippets}/test-journal/should-fetch-journal-entries-with-date-range-and-account-and-amount/http-response.adoc[]

.httpie-request
include::{snippets}/test-journal/should-fetch-journal-entries-with-date-range-and-account-and-amount/httpie-request.adoc[]

== Transaction Types ==

==== Create Transaction Type ====

.curl-request
include::{snippets}/test-transaction/should-create-transaction-type/curl-request.adoc[]

.http-request
include::{snippets}/test-transaction/should-create-transaction-type/http-request.adoc[]

.http-response
include::{snippets}/test-transaction/should-create-transaction-type/http-response.adoc[]

.httpie-request
include::{snippets}/test-transaction/should-create-transaction-type/httpie-request.adoc[]

==== Get A Transaction Type ====

.curl-request
include::{snippets}/test-transaction/should-find-transaction-type/curl-request.adoc[]

.http-request
include::{snippets}/test-transaction/should-find-transaction-type/http-request.adoc[]

.http-response
include::{snippets}/test-transaction/should-find-transaction-type/http-response.adoc[]

.httpie-request
include::{snippets}/test-transaction/should-find-transaction-type/httpie-request.adoc[]

==== Get Transaction Types ====

.curl-request
include::{snippets}/test-transaction/should-fetch-pre-configured-types/curl-request.adoc[]

.http-request
include::{snippets}/test-transaction/should-fetch-pre-configured-types/http-request.adoc[]

.http-response
include::{snippets}/test-transaction/should-fetch-pre-configured-types/http-response.adoc[]

.httpie-request
include::{snippets}/test-transaction/should-fetch-pre-configured-types/httpie-request.adoc[]

==== Update A Transaction Type ====

.curl-request
include::{snippets}/test-transaction/should-change-transaction-type/curl-request.adoc[]

.http-request
include::{snippets}/test-transaction/should-change-transaction-type/http-request.adoc[]

.http-response
include::{snippets}/test-transaction/should-change-transaction-type/http-response.adoc[]

.httpie-request
include::{snippets}/test-transaction/should-change-transaction-type/httpie-request.adoc[]