Document Created

This chapter provides an in-depth overview of the DocumentCreatedNotification notification message, which is published when a document is created for an account.

Notification Overview

Headers of the DocumentCreatedNotification Notification

The following table lists the headers in the DocumentCreatedNotification 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.	`documentCreated`
X-Ocs-Io-notification-payload	Name (JAVA’s Simple Name) of the Notification’s Payload.	`DocumentCreatedNotification`

X-Ocs-Io-transaction-id

ID of the transaction.

X-Ocs-Io-notification-code

Code of the Notification.

documentCreated

X-Ocs-Io-notification-payload

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

DocumentCreatedNotification

Fields of the DocumentCreatedNotification Notification Payload

The following table lists and describes the fields in the DocumentCreatedNotification 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).
documentSource	Source of the Document
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.
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.
paymentRef1	Payment Reference No.1 associated with the Payment.
paymentRef2	Payment Reference No.2 associated with the Payment.
paymentRef3	Payment Reference No.3 associated with the Payment.
paymentMethod	Method of the Payment.
billingPeriodStart	Billing Period Start Date. Only for OCS Invoice Document.
billingPeriodEnd	Billing Period End Date. Only for OCS Invoice 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).

documentSource

Source of the Document

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.

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.

paymentRef1

Payment Reference No.1 associated with the Payment.

paymentRef2

Payment Reference No.2 associated with the Payment.

paymentRef3

Payment Reference No.3 associated with the Payment.

paymentMethod

Method of the Payment.

billingPeriodStart

Billing Period Start Date. Only for OCS Invoice Document.

billingPeriodEnd

Billing Period End Date. Only for OCS Invoice Document.

Detailed API documentation and endpoint specifics are available here.