Skilaboðategundir fyrir Innkomandi skjöl

Yfirlægja skjal: API_Reference.md Innleiðingarmappa: app/src/Message Type/Implementations/IncomingDocument/

Yfirlit

Þetta skjal lýsir skilaboðategundum innkomandi skjala í Cloud Events API. Þessar skilaboðategundir ná yfir allt líftíma innkomandi skjals í Business Central — frá móttöku skráar, yfir viðbótarviðhengi, afgreiðslu yfir í kaupnótu eða dagbókarlínu, og að fyrirspurn um skjalið og viðhengi þess.

Dæmigerð vinnuflæðið:

1. Kallaðu á Incoming.Document.Create til að hlaða upp aðalskrá og stofna innkomandi skjalið.
2. Kallaðu valfrjálst á Incoming.Document.Attach einu sinni eða oftar til að bæta við fylgigögnum.
3. Kallaðu á Incoming.Document.Process til að stofna kaupnótu eða dagbókarlínu úr skjalinu.
4. Kallaðu á Incoming.Document.Get hvenær sem er til að sækja núverandi stöðu skjalsins og öll viðhengi.
5. Kallaðu á Incoming.Document.SetDefault til að breyta hvaða viðhengi er aðalviðhengið (sjálfgefið).

Incoming.Document.Create

Stefna: Inn Hlutaauðkenni: Codeunit 65419 (IncomingDoc Create Impl), Codeunit 65423 (IncomingDoc Create Help)

Tilgangur

Stofnar nýtt innkomandi skjal í Business Central með aðalviðhengi. Innihald skráarinnar verður að vera gefið upp sem Base64-kóðaður strengur ásamt skráarheiti.

Beiðnisnið

{
  "specversion": "1.0",
  "type": "Incoming.Document.Create",
  "source": "MyApp v1.0",
  "data": "{\"fileName\":\"reikningur.pdf\",\"fileContent\":\"<base64-kóðað innihald>\"}"
}

Reitir beiðni

Svarsnið

{
  "status": "Success",
  "entryNo": 1001,
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "lineNo": 10000,
  "description": "Innkaup frá Fabrikam",
  "documentDate": "2026-04-01",
  "dueDate": "",
  "vendorNo": "V10000",
  "vendorName": "Fabrikam Inc.",
  "documentStatus": "New",
  "dataExchangeType": "",
  "processed": false,
  "posted": false,
  "record": {},
  "error": []
}

Reitir svars

Villutilfelli

Incoming.Document.Attach

Stefna: Inn Hlutaauðkenni: Codeunit 65422 (IncomingDoc Attach Impl), Codeunit 65426 (IncomingDoc Attach Help)

Tilgangur

Bætir viðbótarviðhengi við innkomandi skjal sem þegar er til. Skjalið er auðkennt með færslunúmeri eða SystemId í subject reitnum. Innihald skráar verður að vera gefið upp sem Base64-kóðaður strengur.

Beiðnisnið

{
  "specversion": "1.0",
  "type": "Incoming.Document.Attach",
  "source": "MyApp v1.0",
  "subject": "1001",
  "data": "{\"fileName\":\"fylgiseðill.xml\",\"fileContent\":\"<base64-kóðað innihald>\"}"
}

Reitir beiðni

Svarsnið

{
  "status": "Success",
  "entryNo": 1001,
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "lineNo": 20000,
  "description": "Innkaup frá Fabrikam",
  "documentDate": "2026-04-01",
  "dueDate": "2026-04-30",
  "vendorNo": "V10000",
  "vendorName": "Fabrikam Inc.",
  "documentStatus": "New",
  "dataExchangeType": "",
  "processed": false,
  "posted": false,
  "record": {},
  "error": []
}

Reitir svars

Villutilfelli

Incoming.Document.Process

Stefna: Inn Hlutaauðkenni: Codeunit 65425 (IncomingDoc Process Impl), Codeunit 65429 (IncomingDoc Process Help)

Tilgangur

Afgreiðir innkomandi skjal með hefðbundnu OCR/skjalvinnsluflæði Business Central, sem reynir að stofna kaupnótu eða dagbókarlínu úr skjalinu.

Beiðnisnið

{
  "specversion": "1.0",
  "type": "Incoming.Document.Process",
  "source": "MyApp v1.0",
  "subject": "1001"
}

Eða með SystemId:

{
  "subject": "{a1b2c3d4-e5f6-7890-abcd-ef1234567890}"
}

Svarsnið

{
  "status": "Success",
  "record": {
    "tableNo": 38,
    "tableName": "Purchase Header",
    "tableCaption": "Purchase Header",
    "recordSystemId": "c3d4e5f6-a1b2-7890-abcd-ef1234567890"
  },
  "entryNo": 1001,
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Ef afgreiðsla mistekst kemur "status": "Error" ásamt "error" fylki sem inniheldur BC-villuboð sem útskýra hvers vegna afgreiðslan náði ekki stöðunni Status = Created.

Reitir svars

Reitir record-hlutarins

Reitir villuboðahlutarins

Hver hlutur í error fylkinu hefur eftirfarandi reiti:

Villutilfelli

Incoming.Document.Get

Stefna: Út Hlutaauðkenni: Codeunit 65431 (IncomingDoc Get Impl), Codeunit 65430 (IncomingDoc Get Help)

Tilgangur

Sækir hausupplýsingar og öll skráarviðhengi innkomandi skjals. Viðhengjum er skipt í mainAttachment hlut og additionalAttachments fylki. Innihald skráa er skilað sem Base64-kóðaðir strengir.

Beiðnisnið

{
  "specversion": "1.0",
  "type": "Incoming.Document.Get",
  "source": "MyApp v1.0",
  "subject": "1001"
}

Eða með SystemId:

{
  "subject": "{a1b2c3d4-e5f6-7890-abcd-ef1234567890}"
}

Reiturinn subject tekur við annað hvort:

• Færslunúmeri (heiltölu sem texta, t.d. "1001")
• SystemId GUID (með eða án sviga)

Svarsnið

{
  "status": "Success",
  "entryNo": 1001,
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "description": "Innkaup frá Fabrikam",
  "documentDate": "2026-04-01",
  "dueDate": "2026-04-30",
  "vendorNo": "V10000",
  "vendorName": "Fabrikam Inc.",
  "documentStatus": "New",
  "dataExchangeType": "",
  "processed": false,
  "posted": false,
  "record": {
    "tableNo": 38,
    "tableName": "Purchase Header",
    "tableCaption": "Purchase Header",
    "recordSystemId": "c3d4e5f6-a1b2-7890-abcd-ef1234567890"
  },
  "error": [],
  "mainAttachment": {
    "lineNo": 10000,
    "fileName": "reikningur.pdf",
    "fileContent": "<base64-kóðað innihald skráar>"
  },
  "additionalAttachments": [
    {
      "lineNo": 20000,
      "fileName": "fylgiseðill.xml",
      "fileContent": "<base64-kóðað innihald skráar>"
    }
  ]
}

Reitir hauss í svari

Reitir record-hlutarins

Reitir viðhengja (mainAttachment og færslur í additionalAttachments)

Athugasemdir

• Hluturinn mainAttachment er sleppt úr svari ef innkomandi skjalið er án aðalviðhengis.
• Fylkið additionalAttachments er tómt ([]) ef engin viðbótarviðhengi eru til staðar.
• Hluturinn record inniheldur upplýsingar um tengt BC-skjal þegar slíkt er til staðar.
• Fylkið error inniheldur BC villuboð sem tengjast innkomandi skjalinu.
• Innihald skráa er alltaf Base64-kóðað; kallari verður að afkóða áður en hann notar það.

Villutilfelli

Incoming.Document.SetDefault

Stefna: Inn Hlutaauðkenni: Codeunit 65432 (IncomingDoc SetDef Impl), Codeunit 65433 (IncomingDoc SetDef Exec), Codeunit 65434 (IncomingDoc SetDef Help)

Tilgangur

Stillir sjálfgefið (aðal) viðhengi á innkomandi skjali sem þegar er til. Tilgreint viðhengi er eytt og sett inn á nýtt sem fyrsta viðhengið (línunúmer 10000) með fánann Aðalviðhengi (Main Attachment) stillt á satt. Öll önnur viðhengi eru sett inn á eftir í upprunalegri röð.

Beiðnisnið

{
  "specversion": "1.0",
  "type": "Incoming.Document.SetDefault",
  "source": "MyApp v1.0",
  "subject": "1001",
  "data": "{\"lineNo\": 20000}"
}

Eða með SystemId:

{
  "subject": "{a1b2c3d4-e5f6-7890-abcd-ef1234567890}",
  "data": "{\"lineNo\": 20000}"
}

Reitir beiðni

Svarsnið

{
  "status": "Success",
  "entryNo": 1001,
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Reitir svars

Athugasemdir

• Innkomandi skjalið verður að hafa a.m.k. 2 viðhengi. Ef færri en 2 eru til staðar kemur villa.
• Öllum viðhengjum er eytt og þeim sett inn á ný: tilgreint viðhengi verður línunúmer 10000 (aðal), restin fylgir á 20000, 30000, o.s.frv.
• Innihald skráa (BLOB gögn) er varðveitt við endurröðun.
• Upprunaleg hlutfallsleg röð annarra viðhengja er varðveitt.

Villutilfelli

© Origo – Cloud Events Base Extension