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

Список на примени документи

GET
/api/integration/v1/inbound

Lists inbound documents, newest first.

With onlyNotImported=true only documents that have not been acknowledged yet are returned. Without the filter the acknowledged ones come back too, each with a visible ackedAt.

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

Request

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

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

Parameters

Сите параметри (7)
ParameterInTypePresenceDescription
dateFromquerystring · date-timeoptionalLower bound on arrival time; omit for no lower bound.
dateToquerystring · date-timeoptionalUpper bound on arrival time; omit for no upper bound.
senderEdbquerystringoptionalTax number of the sender.
onlyNotImportedquerybooleanoptionalWhen true, only documents without an acknowledgement.
pagequeryinteger · int32optional1-based page index; defaults to 1.
pageSizequeryinteger · int32optionalDocuments per page; defaults to 100, maximum 500.
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-3005

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

The page of documents; an empty result is 200 with totalCount 0.

{
  "items": [
    {
      "docUid": "",
      "receivedAt": "2026-08-26T23:24:17+02:00",
      "senderName": "",
      "senderEdb": "",
      "ackedAt": "2026-08-26T23:24:17+02:00"
    }
  ],
  "totalCount": 0,
  "page": 0,
  "pageSize": 0,
  "totalPages": 0
}
Сите полиња во телото (5)
FieldTypePresenceDescription
itemsниза од објектnullableDocuments on the requested page, newest first.
totalCountinteger · int32alwaysNumber of documents matching the filter across all pages.
pageinteger · int32always1-based index of the returned page.
pageSizeinteger · int32alwaysNumber of documents per page (default 100, maximum 500).
totalPagesinteger · int32alwaysNumber of pages available for the current filter and page size.

EARH-3005 — the requested page size exceeds the allowed one; the response names it.

{
  "type": "https://earhiva.mk/errors/EARH-3005",
  "title": "Requested page size exceeds the allowed maximum.",
  "status": 400,
  "code": "EARH-3005"
}
Сите полиња во телото (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. Телото е стандардното тело на грешка — исто кај сите повици. Што да се направи со секоја шифра стои во Каталог на грешки.

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. Телото е стандардното тело на грешка — исто кај сите повици. Што да се направи со секоја шифра стои во Каталог на грешки.