Оди на содржината

Потврда дека документот е преземен

POST
/api/integration/v1/inbound/{docUid}/ack

Acknowledges that an inbound document was taken over.

The document then stops appearing under onlyNotImported=true. Acknowledging again is not an error: the time of the first acknowledgement is returned unchanged. There is no way to take an acknowledgement back in v1, and the acknowledgement tells the sender nothing.

Примерот важи само за demo околината.

Request

curl -i -X POST "https://sandbox.api.earhiva.mk/api/integration/v1/inbound/<docUid>/ack" \
  -H "X-Api-Key: <ВАШИОТ КЛУЧ>" \
  -H "X-Software-Id: <ИМЕ И ВЕРЗИЈА НА ВАШАТА АПЛИКАЦИЈА>"

Секој повик носи X-Api-Key со клуч што го има опфатот IntegrationApi, и X-Software-Id со името и верзијата на твојот софтвер. Како се бара клуч стои во Автентикација.

Parameters

Сите параметри (2)
ParameterInTypePresenceDescription
docUidpathstringalwaysIdentifier of the document being acknowledged.
X-Software-IdheaderstringalwaysIdentifier of the calling software, e.g. SSBFocus/4.2.1. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.

Error codes

EARH-1001 · EARH-1002 · EARH-1003 · EARH-1004 · EARH-1005 · EARH-1006 · EARH-1008 · EARH-3001

Целосниот список шифри, со што значат и што да се направи, е во Каталог на грешки.

The acknowledgement stands; ackedAt is the time of the first one.

{
  "docUid": "",
  "ackedAt": "2026-08-26T23:24:17+02:00"
}
Сите полиња во телото (2)
FieldTypePresenceDescription
docUidstringnullableIdentifier of the acknowledged document.
ackedAtstring · date-timenullableTime of the FIRST acknowledgement; a repeated call does not move it.

The X-Software-Id header is missing — EARH-1008.

{
  "type": "https://earhiva.mk/errors/EARH-1008",
  "title": "X-Software-Id header is missing.",
  "status": 400,
  "code": "EARH-1008"
}
Сите полиња во телото (6)
FieldTypePresenceDescription
typestringnullableAddress of this code in the error catalogue (RFC 7807).
titlestringnullableShort, stable English summary of the error — the same string that appears in your log.
statusinteger · int32alwaysHTTP status code, repeated in the body (RFC 7807).
detailstringnullableWhat went wrong in this particular call, when there is more to say than the title.
codestringnullableThe EARH-xxxx code. This is the contract: match on it, not on the text.
eventIdstringnullableOnly on EARH-9000. Quote it when reporting the problem — the same reference we record in our log.

The API key is missing, unknown, expired or revoked — EARH-1001, EARH-1002, EARH-1003. Телото е стандардното тело на грешка — исто кај сите повици. Што да се направи со секоја шифра стои во Каталог на грешки.

The caller’s address is outside the allowed list, or the key does not carry the IntegrationApi scope — EARH-1004, EARH-1005. Телото е стандардното тело на грешка — исто кај сите повици. Што да се направи со секоја шифра стои во Каталог на грешки.

EARH-3001 — no such document. An unknown identifier and a document belonging to another tenant give an identical answer.

{
  "type": "https://earhiva.mk/errors/EARH-3001",
  "title": "Document not found.",
  "status": 404,
  "code": "EARH-3001"
}
Сите полиња во телото (6)
FieldTypePresenceDescription
typestringnullableAddress of this code in the error catalogue (RFC 7807).
titlestringnullableShort, stable English summary of the error — the same string that appears in your log.
statusinteger · int32alwaysHTTP status code, repeated in the body (RFC 7807).
detailstringnullableWhat went wrong in this particular call, when there is more to say than the title.
codestringnullableThe EARH-xxxx code. This is the contract: match on it, not on the text.
eventIdstringnullableOnly on EARH-9000. Quote it when reporting the problem — the same reference we record in our log.

The traffic limit for this key has been reached — EARH-1006. The response carries Retry-After. Телото е стандардното тело на грешка — исто кај сите повици. Што да се направи со секоја шифра стои во Каталог на грешки.

Unexpected error on our side — EARH-9000. The body carries eventId; quote it when reporting the problem. Телото е стандардното тело на грешка — исто кај сите повици. Што да се направи со секоја шифра стои во Каталог на грешки.