Endpoint Setups

GETTable: EONE Endpoint Setup

eOne/core/v1.0/endpointSetups

Read and write the per-endpoint processing configuration for the journal-wrapper documents. One row per document type, holding its processing mode (Manual / Auto Draft / Auto Post), approval requirement, and target journal. Built primarily for automated testing.

One row per journal-wrapper endpoint

Rows are seeded by the extension (one per journal-wrapper document type); you cannot insert or delete, only PATCH. documentType is the key. For example, make customer payments post automatically to a dedicated batch:

PATCH /endpointSetups(<id>)
{ "processingMode": "AutoPost", "journalBatchName": "EONE" }

allowManualDelete (on by default) decides whether a staged document of the type may be deleted before it is processed - in the Business Central client and over the API alike. A document that is pending approval or already approved can never be deleted, whatever it is set to.

API

BC field

Notes

id

SystemId

BC record GUID. ro

bcCompanyId

bcCompanyId

The company this row belongs to - the same GUID that appears in the request URL. Present on every endpoint so a store pooling several companies can keep them apart without relying on which URL it called. ro

bcCompanyName

bcCompanyName

The name of the company this row belongs to. ro

documentType

Document Type

The journal-wrapper endpoint this row configures. ro

processingMode

Processing Mode

Manual, Auto Draft to Journal, or Auto Post.

requiresApproval

Requires Approval

Whether a document must be approved before it is processed.

journalTemplateName

Journal Template Name

General journal template the endpoint posts through.

journalBatchName

Journal Batch Name

General journal batch the endpoint posts through.

allowBeforeInvoicePosts

Allow Before Invoice Posts

Whether a payment may reference an invoice that has not posted yet.

allowManualLineEdit

Allow Manual Line Edit

Whether a user may add, edit or delete a staged document's lines in the Business Central client - applications and distributions alike. When off, the lines are integration-owned and read-only there. It does not affect the API, which writes lines regardless. Applies to every document type, including expenses and inventory adjustments.

allowManualDelete

Allow Manual Delete

Whether a staged document of this type may be deleted before it is processed. Unlike allowManualLineEdit this gates the API too: when off, a DELETE on the staged endpoint is refused alongside the client's Delete action, marking the family integration-owned. On by default. Independent of the unconditional status rule - a document that is pending approval or already approved can never be deleted, whatever this is set to.

taxNeutral

Tax Neutral

Whether Business Central is prevented from calculating tax on documents of this type. ON by default. Setting an account on a journal line copies that account's posting groups and calculates tax from them, so a revenue or expense account carrying a tax posting group would SPLIT the amount you sent, using Business Central's rate rather than your source's - and because the document still balances, nothing reports it. Leave this on for any feed whose tax was already calculated at the source. Turn it off for a document type whose tax genuinely should be computed here.

taxPostingMethod

Tax Posting Method

How a tax amount you supply on a line reaches the ledger. G/L Only (the default) posts it to the tax account as an ordinary amount and creates no VAT Entry, which is right when the return is filed by the system that calculated the tax. Full VAT creates a VAT Entry so the VAT statement and return see it; it needs the tax account to carry VAT posting groups whose VAT Posting Setup is Full VAT, and it cannot be combined with Tax Neutral.

taxAccountNumber

Tax Account No.

G/L account a line's tax posts to when the line does not name one of its own. Set per line instead when one document carries tax for several jurisdictions filing to different accounts.

itemJournalTemplateName

Item Journal Template Name

InventoryAdjustment endpoint only: item journal template adjustments post through when they do not name one.

itemJournalBatchName

Item Journal Batch Name

InventoryAdjustment endpoint only: item journal batch adjustments post through when they do not name one. Its No. Series supplies the document number when the adjustment does not carry one.

lastModifiedDateTime

SystemModifiedAt