Skip to content

Commit

Permalink
Adding some info to the ledgers documentation (2600hz#6455)
Browse files Browse the repository at this point in the history
Added a note explaining the intended purpose of the source.id field
  • Loading branch information
mroux authored and jamesaimonetti committed Apr 8, 2020
1 parent f3579f5 commit aa3d7ef
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions applications/crossbar/doc/ledgers.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ Key | Description | Type | Default | Required | Support Level
`usage.unit` | Usage unit | `string()` | | `true` |
`usage` | Usage for ledger | `object()` | | `true` |



## Get Available Ledgers

List available ledger sources from the account's reseller.
Expand Down Expand Up @@ -202,10 +200,11 @@ curl -v -X GET \

## Credit / Debit

Credit or Debit a specific ledger.
the `account_id` for `AUTH_TOKEN` must be reseller of target account.
Credit or Debit a specific ledger.

Parameter "impact_reseller" (boolean not required) when true will also create the document in the reseller
* The `account_id` for `AUTH_TOKEN` must be reseller of target account.
* The parameter `impact_reseller` (boolean not required) when true will also create the document in the reseller.
* The `source.id` field must be representative of a specific ledger entry. To that effect, the combination of that field, the `period.start` field, and the `period.end` field must be unique. This prevents mistakenly submitting the same ledger entry multiple times.

> PUT /v2/accounts/{ACCOUNT_ID}/ledgers/debit
Expand Down

0 comments on commit aa3d7ef

Please sign in to comment.