Payer

This chapter provides an in-depth overview of the Payer business transaction message, which is published when a payer is created or updated.

Business Transaction Overview

Headers of the Payer Business Transaction Message

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

Header Description Value

X-Ocs-Io-transaction-id

ID of the transaction.

X-Ocs-Io-message-code

Code of the Message.

payers

X-Ocs-Io-message-payload

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

PayerEx

Fields of the Payer Business Transaction Payload

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

Field Description

refId

Ref ID of the AccountDetail.

account

ID of the Account.

accountType

Type of the Account.

paymentMethod

Payment Method.

deliveryMethod

Delivery Method.

invoicingExcluded

Indicates whether Payer is excluded from Invoicing.

dueDateOffset

Offset for calculation of Due Date of all Documents.

paymentMoral

Payment moral of the Account, calculated in flowing period for last X months.

paymentMoralCalculated

Last calculation of Payment moral for the Account.

bankAccountName

Payer’s (Billing Account) bank account name.

bankAccountNumber

Payer’s (Billing Account) bank account number, including prefix, without bank number code.

bankNumberCode

Payer’s (Billing Account) bank number code.

iban

Payer’s (Billing Account) bank account number in international format.

bic

BIC code of bank.

paymentRef1

Payer’s (Billing Account) Payment Reference No.1 in case Payment Reference No.1 is static.

paymentRef2

Payer’s (Billing Account) Payment Reference No.2 in case Payment Reference No.2 is static.

paymentRef3

Payer’s (Billing Account) Payment Reference No.3 in case Payment Reference No.3 is static.

bankAccountNumberDirectDebit

Payer’s (Billing Account) bank account number, including prefix, without bank number code for Direct debit.

bankNumberCodeDirectDebit

Payer’s (Billing Account) bank number code for Direct Debit.

bankAccountNumberDirectDebitProvider

Provider’s bank account number, including prefix, without bank number code for Direct debit.

bankNumberCodeDirectDebitProvider

Provider’s bank number code for Direct Debit.

vatLiable

Indicates whether Payer is liable for VAT.

vatLiableValidFrom

Date/Time from when Payer is liable for VAT.

vatLiableValidTo

Date/Time till when Payer is liable for VAT.

customAttributes

Custom attributes, Key - Value (String) Map.
Detailed API documentation and endpoint specifics are available here.