Every error, with a remedy.
33 codes in 19 families. An error from https://api.eternifylabs.com is a problem document: its type links to its family below, its code names the exact case and its detail says what to change.
What an error looks like.
HTTP/1.1 422 Unprocessable Content
Content-Type: application/problem+json
{
"type": "https://www.eternifylabs.com/resources/developers/errors#validation-failed",
"title": "That request could not be accepted",
"status": 422,
"code": "validation_failed",
"detail": "billDate: expected a date written YYYY-MM-DD."
}The list of codes is open. The reference publishes the codes known today as x-extensible-enum on code, and a new code can appear without a new release. A client that meets a code it does not know should act on the type family and show the detail and remedy. The same holds for a job’s kind and result.
validation_failed
That request could not be accepted. Status 422.
validation_failed422That request could not be accepted.
What to do. Fix each field named in
fieldsand send the request again.public_api_field_not_allowed422That request could not be accepted.
What to do. Remove the field named in
fields. It cannot be set through the API.public_api_unknown_field422That request could not be accepted.
What to do. Remove the field named in
fields, or use one this operation's request lists.public_api_unknown_parameter422That request could not be accepted.
What to do. Remove the query parameter named in
fields, or use one this operation lists.idempotency_key_required400That request could not be accepted.
What to do. Send an Idempotency-Key header: a new value for each new request, the same value when you retry it.
unauthenticated
Sign in to continue. Status 401.
unauthenticated401Sign in to continue.
What to do. Send a valid key or access token as a bearer token. If the key was revoked or has expired, ask an administrator of the books to create a new one.
api_key_revoked401Sign in to continue.
What to do. Ask an administrator of the books to create a new key.
api_key_expired401Sign in to continue.
What to do. Ask an administrator of the books to create a new key.
permission_denied
You do not have permission to do that. Status 403.
permission_denied403You do not have permission to do that.
What to do. Use a key or a connection with the access this operation needs, or ask an administrator of the books to change it.
api_access_not_enabled403You do not have permission to do that.
What to do. API access is for Eternify Ledger customers. To turn it on for this workspace, write to info@eternifylabs.com.
api_access_ledger_closed403You do not have permission to do that.
What to do. These books are archived, so keys no longer reach them. Unarchive the books in the app, or revoke the key.
api_key_maker_left403You do not have permission to do that.
What to do. The person who made this key is no longer an administrator on these books. An administrator makes a new key.
not_found
Not found. Status 404.
not_found404Not found.
What to do. Check the identifier, and that it belongs to the books the key was made for.
operation_sunset410Not found.
What to do. The operation has passed its sunset day. Call the operation that replaces it; the changelog names it.
precondition_failed
The ledger refused that in its current state. Status 412.
precondition_failed412The ledger refused that in its current state.
What to do. Read
detail: it names the state the record is in. Bring the record to the state it asks for, then send the request again.
idempotency_conflict
That idempotency key was used for a different request. Status 422.
idempotency_conflict422That idempotency key was used for a different request.
What to do. Send a new Idempotency-Key for a different request, or send the first request again with its original key.
idempotency_in_flight
An identical request is still running. Status 409.
idempotency_in_flight409An identical request is still running.
What to do. Wait for the first request to finish, read the record, and only then decide whether to send it again.
conflict
That already exists. Status 409.
conflict409That already exists.
What to do. The record already exists. Read it instead of creating it again.
api_key_label_taken409That already exists.
What to do. Give the key a label no other live key has.
api_key_cap_reached409That already exists.
What to do. Revoke a key you no longer use, then make the new one.
api_key_already_revoked409That already exists.
What to do. Nothing to do: the key is already revoked.
counterparty_link_taken
That supplier reference is already linked to a vendor. Status 409.
counterparty_link_taken409That supplier reference is already linked to a vendor.
What to do. That supplier reference is linked to another vendor. Use the vendor it is linked to, or unlink it first.
payload_too_large
That file is too large. Status 413.
payload_too_large413That file is too large.
What to do. Send a smaller body or file.
maxBytesgives the limit.public_api_body_too_large413That file is too large.
What to do. Send a body under the limit in
maxBytes, in smaller requests if needed.
write_conflict
Another change reached that record first. Status 409.
write_conflict409Another change reached that record first.
What to do. Another change reached the record first. Read it again and send your change on top of that.
audit_chain_order
Nothing was saved, and the fault is in Eternify. Status 500.
audit_chain_order500Nothing was saved, and the fault is in Eternify.
What to do. Nothing was saved and the fault is ours. Send the same request again, and quote the X-Request-Id if it keeps failing.
unsupported_version
Unsupported API version. Status 400.
unsupported_version400Unsupported API version.
What to do. Send the Eternify-Version header the error names.
service_unavailable
The database was busy. Status 503.
service_unavailable503The database was busy.
What to do. Nothing was saved. Send the same request again after the number of seconds in Retry-After.
not_implemented
That is not available yet. Status 501.
not_implemented501That is not available yet.
What to do. Retrying will not help. Read
detailfor what would.
rate_limited
Too many requests. Status 429.
rate_limited429Too many requests.
What to do. Wait the number of seconds in Retry-After, then send the same request again.
payment_required
The provider account has run out of credits. Status 402.
payment_required402The provider account has run out of credits.
What to do. An administrator of the books has to top up the provider account. Retrying will not help.
bad_gateway
A provider did not answer. Status 502.
bad_gateway502A provider did not answer.
What to do. A provider did not answer. Nothing was saved. Try again later.
internal_error
Something went wrong. Status 500.
internal_error500Something went wrong.
What to do. The fault is ours. Quote the X-Request-Id when you write to us.
Stuck on an error?
Quote the X-Request-Id of the call when you write to us, and we can find it.