API reference
Books check tolerances
The vendors a daily books check is wider for, and by how much, so a vendor whose amounts vary is not flagged every month.
- GET
/v1/qa_tolerancesList the vendors a books check is wider for - POST
/v1/qa_tolerancesWiden a books check for one vendor - GET
/v1/qa_tolerances/{tolerance_id}Get a vendor's tolerance on a books check - DELETE
/v1/qa_tolerances/{tolerance_id}Put a vendor back on a check's default threshold
Guides: Work the inbox
List the vendors a books check is wider for
GET/v1/qa_tolerances
client.qaTolerances.list()
The vendors a books check is wider for, the newest first: which check, and by how much.
Parameters
| Name | Type | Description |
|---|---|---|
kindQuery | string or null | Only those widening this check. unusual_amount, possible_repeat, missing_accrual |
counterparty_idQuery | string or null | An id that starts with |
limitQuery | integer | Page size, 1–200. |
cursorQuery | string or null | The |
Response
Errors
- 400
- The request was malformed or a parameter is invalid.
- 401
- No valid credential was sent.
- 403
- The credential or the member's role does not allow this.
- 404
- No such resource in this ledger.
- 409
- A conflicting request, e.g. one with the same Idempotency-Key still running.
- 422
- A well-formed request a business rule refused.
- 429
- Too many requests; retry after the Retry-After header.
- 500
- Something failed on our side; the request_id identifies it.
Example
curl "https://api.ledgerit.ai/v1/qa_tolerances" \
-H "Authorization: Bearer $LEDGERIT_TOKEN"Widen a books check for one vendor
POST/v1/qa_tolerances· Idempotent
client.qaTolerances.create()
Widen one check for one vendor, by a multiple of its threshold. A vendor has one tolerance per check: change it by deleting it and setting another, or by dismissing an item with "This vendor varies".
Request body
Response
Errors
- 400
- The request was malformed or a parameter is invalid.
- 401
- No valid credential was sent.
- 403
- The credential or the member's role does not allow this.
- 404
- No such resource in this ledger.
- 409
- A conflicting request, e.g. one with the same Idempotency-Key still running.
- 422
- A well-formed request a business rule refused.
- 429
- Too many requests; retry after the Retry-After header.
- 500
- Something failed on our side; the request_id identifies it.
Example
curl -X POST "https://api.ledgerit.ai/v1/qa_tolerances" \
-H "Authorization: Bearer $LEDGERIT_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"counterparty_id":"…","kind":"unusual_amount"}'Get a vendor's tolerance on a books check
GET/v1/qa_tolerances/{tolerance_id}
client.qaTolerances.get()
One vendor's tolerance on one check.
Parameters
| Name | Type | Description |
|---|---|---|
tolerance_idPath · Required | string | An id that starts with |
Response
Errors
- 400
- The request was malformed or a parameter is invalid.
- 401
- No valid credential was sent.
- 403
- The credential or the member's role does not allow this.
- 404
- No such resource in this ledger.
- 409
- A conflicting request, e.g. one with the same Idempotency-Key still running.
- 422
- A well-formed request a business rule refused.
- 429
- Too many requests; retry after the Retry-After header.
- 500
- Something failed on our side; the request_id identifies it.
Example
curl "https://api.ledgerit.ai/v1/qa_tolerances/{tolerance_id}" \
-H "Authorization: Bearer $LEDGERIT_TOKEN"Put a vendor back on a check's default threshold
DELETE/v1/qa_tolerances/{tolerance_id}
client.qaTolerances.delete()
Put the vendor back on the check's default threshold.
Parameters
| Name | Type | Description |
|---|---|---|
tolerance_idPath · Required | string | An id that starts with |
Response
204No content
Errors
- 400
- The request was malformed or a parameter is invalid.
- 401
- No valid credential was sent.
- 403
- The credential or the member's role does not allow this.
- 404
- No such resource in this ledger.
- 409
- A conflicting request, e.g. one with the same Idempotency-Key still running.
- 422
- A well-formed request a business rule refused.
- 429
- Too many requests; retry after the Retry-After header.
- 500
- Something failed on our side; the request_id identifies it.
Example
curl -X DELETE "https://api.ledgerit.ai/v1/qa_tolerances/{tolerance_id}" \
-H "Authorization: Bearer $LEDGERIT_TOKEN"Objects
The objects these operations take and return.
QaTolerancePage
| Name | Type | Description |
|---|---|---|
dataRequired | array of QaToleranceOut | |
has_moreRequired | boolean | |
next_cursorRequired | string or null |
QaToleranceCreate
| Name | Type | Description |
|---|---|---|
counterparty_idRequired | string | The vendor to widen it for. |
kindRequired | string | The check to widen. unusual_amount, possible_repeat, missing_accrual |
multiplier | number | string | How many times wider: 2 (the default) doubles the threshold. |
note | string or null | Why. |
QaToleranceOut
| Name | Type | Description |
|---|---|---|
counterparty_idRequired | string | The vendor it widens the check for. |
counterparty_name | string or null | The vendor's name. |
created_atRequired | string (date-time) | |
created_by | string or null | An id that starts with |
idRequired | string | An id that starts with |
kindRequired | string | The check it widens: unusual_amount, possible_repeat, missing_accrual |
multiplierRequired | string | How many times wider the check's threshold is for this vendor: 2 doubles it. |
note | string or null | Why, as whoever set it wrote. |
updated_atRequired | string (date-time) |