Document Open Balance Changed

This chapter provides an in-depth overview of the DocumentOpenBalanceChanged notification message, which is published when the open balance on a document changes.

Notification Overview

Headers of the DocumentOpenBalanceChanged Notification

The following table lists the headers in the DocumentOpenBalanceChanged notification:

Header Description Value

Header	Description	Value
X-Ocs-Io-transaction-id	ID of the transaction.
X-Ocs-Io-notification-code	Code of the Notification.	`documentOpenBalanceChanged`
X-Ocs-Io-notification-payload	Name (JAVA’s Simple Name) of the Notification’s Payload.	`DocumentOpenBalanceChangedNotification`

X-Ocs-Io-transaction-id

ID of the transaction.

X-Ocs-Io-notification-code

Code of the Notification.

documentOpenBalanceChanged

X-Ocs-Io-notification-payload

Name (JAVA’s Simple Name) of the Notification’s Payload.

DocumentOpenBalanceChangedNotification

Fields of the DocumentOpenBalanceChanged Notification Payload

The following table lists and describes the fields in the DocumentOpenBalanceChanged notification payload:

Field	Description
effectiveDate	Effective Date/Time of the Notification.
account	ID (Ref ID / External ID) of the Account.
documentNo	Number of the document (generated by RM module).
externalDocumentNo	External number of the document (generated by external system, e.g. OCS).
documentType	Type of the Document..
currency	Currency of the Document.
totalAmount	Total Amount of the Document. Excluding Tax.
totalAmountNet	Net Total Amount of the Document including Tax. Not present for Customers with VAT Exemption.
totalAmountTax	Tax part of the Total Amount of the Document. Not present for Customers with VAT Exemption.
dueAmount	Due amount of the account receivable or liability.
dueAmountType	Type of the Due Amount. 'AR' = 'Provider receives, Payer is liable', 'LIABILITY' = 'Provider is liable, Payer will receive'.
documentDueDate	Due date of the Document.

Field

Description

effectiveDate

Effective Date/Time of the Notification.

account

ID (Ref ID / External ID) of the Account.

documentNo

Number of the document (generated by RM module).

externalDocumentNo

External number of the document (generated by external system, e.g. OCS).

documentType

Type of the Document..

currency

Currency of the Document.

totalAmount

Total Amount of the Document. Excluding Tax.

totalAmountNet

Net Total Amount of the Document including Tax. Not present for Customers with VAT Exemption.

totalAmountTax

Tax part of the Total Amount of the Document. Not present for Customers with VAT Exemption.

dueAmount

Due amount of the account receivable or liability.

dueAmountType

Type of the Due Amount. 'AR' = 'Provider receives, Payer is liable', 'LIABILITY' = 'Provider is liable, Payer will receive'.

documentDueDate

Due date of the Document.

Detailed API documentation and endpoint specifics are available here.