Document Payments

This chapter provides an in-depth overview of the DocumentPayments business transaction message, which is published when a payment is linked with a document.

Business Transaction Overview

Headers of the DocumentPayments Business Transaction Message

The following table lists the headers in the DocumentPayments business transaction message:

Header Description Value

X-Ocs-Io-transaction-id

ID of the transaction.

X-Ocs-Io-message-code

Code of the Message.

documentPayments

X-Ocs-Io-message-payload

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

DocumentPaymentsEx

Fields of the DocumentPayments Business Transaction Payload

The following table lists and describes the fields in the DocumentPayments business transaction payload:

Field Description

refId

Ref ID of the Document.

account

ID of the Account.

sourceEntity

Source Entity (From).

  • 'DOCUMENT_AR' - Entity of type DocumentEx, used for Debt Documents (AR).

  • 'DOCUMENT_LIABILITY' - Entity of type DocumentEx, used for Credit Documents (LIABILITY).

targetEntity

Target Entity (To).

  • 'PAYMENT_IN' - Entity of type PaymentEx, used for Incoming payments.

  • 'PAYMENT_OUT' - Entity of type PaymentEx, used for Outgoing payments.

monetaryTransaction

Monetary Transaction - Payment assigned to Document.
Detailed API documentation and endpoint specifics are available here.