Collection Start

This chapter provides an in-depth overview of the CollectionStart notification message, which is published when a collection process is started for an account.

Notification Overview

Headers of the CollectionStart Notification

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

X-Ocs-Io-transaction-id

ID of the transaction.

X-Ocs-Io-notification-code

Code of the Notification.

collectionStart

X-Ocs-Io-notification-payload

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

CollectionStartNotification

Fields of the CollectionStart Notification Payload

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

Field	Description
effectiveDate	Effective Date/Time of the Notification.
account	ID (Ref ID / External ID) of the Account.
currency	Currency of the Account.
dueAmount	Sum of all Due amounts for the Account.
oldestDocumentDueDate	Oldest Document Due date

Field

Description

effectiveDate

Effective Date/Time of the Notification.

account

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

currency

Currency of the Account.

dueAmount

Sum of all Due amounts for the Account.

oldestDocumentDueDate

Oldest Document Due date

Detailed API documentation and endpoint specifics are available here.