Update Payer

The UpdatePayer API is used to update the payer with RM related information in OCS.io.

The attributes in the OCS.io are not versioned. Any changes to these attributes take effect immediately upon update. Please note that these changes do not have a retrospective effect, meaning they do not alter the attributes of documents that were created prior to the update.

API Overview

Fields Required for Updating Payer

The following table lists and describes the fields required to update the payer through the UpdatePayer API:

Field	Description
account	ID (Ref ID/ External ID) of the Account.
paymentMethod	PaymentMethod assigned to Account.
deliveryMethod	DeliveryMethod assigned to Account.
invoicingExcluded	Indicates whether Payer is excluded from Invoicing.
invoicingExcludedTo	If Payer is excluded from Invoicing, this is an optional date till when Payer is excluded.
dueDateOffset	Offset for calculation of Due Date of the Document. If null, document(s) will be created with default offset.
bankAccountNumber	Payer’s (Billing Account) bank account number, including prefix, without bank number code.
bankNumberCode	Payer’s (Billing Account) bank number code.
iban	IBAN number of bank account.
bic	BIC code of bank.
bankAccountName	Payer’s (Billing Account) bank account name.
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.
vatLiableEffectiveDate	Effective Date/Time from or till when Payer is liable for VAT.
customAttributes	Custom attributes, Key - Value (String) Map.

Field

Description

account

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

paymentMethod

PaymentMethod assigned to Account.

deliveryMethod

DeliveryMethod assigned to Account.

invoicingExcluded

Indicates whether Payer is excluded from Invoicing.

invoicingExcludedTo

If Payer is excluded from Invoicing, this is an optional date till when Payer is excluded.

dueDateOffset

Offset for calculation of Due Date of the Document. If null, document(s) will be created with default offset.

bankAccountNumber

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

bankNumberCode

Payer’s (Billing Account) bank number code.

iban

IBAN number of bank account.

bic

BIC code of bank.

bankAccountName

Payer’s (Billing Account) bank account name.

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.

vatLiableEffectiveDate

Effective Date/Time from or till when Payer is liable for VAT.

customAttributes

Custom attributes, Key - Value (String) Map.

Detailed API documentation and endpoint specifics are available here.

Request Validations

The following validations are performed when updating a payer:

Account must be provided in the request, it must be already created in the system and must not be in Deactivated State.

Update Payer Example

Use the following request’s body to update a payer:

{
  "requestId": "{{$guid}}",
  "user": "crm",
  "account": {
    "externalId": "account_external_id"
  },
  "paymentMethod": "payment_method_code",
  "deliveryMethod": "delivery_method_code",
  "invoicingExcluded": true,
  "invoicingExcludedTo": "2024-12-31T23:59:59Z",
  "dueDateOffset": 10,
  "bankAccountNumber": "bank_account_number",
  "bankNumberCode": "bank_number_code",
  "iban": "iban_number",
  "bic": "bic_code",
  "bankAccountName": "bank_account_name",
  "paymentRef1": "payment_reference_1",
  "paymentRef2": "payment_reference_2",
  "paymentRef3": "payment_reference_3",
  "bankAccountNumberDirectDebit": "bank_account_number_direct_debit",
  "bankNumberCodeDirectDebit": "bank_number_code_direct_debit",
  "bankAccountNumberDirectDebitProvider": "bank_account_number_direct_debit_provider",
  "bankNumberCodeDirectDebitProvider": "bank_number_code_direct_debit_provider",
  "vatLiable": true,
  "vatLiableEffectiveDate": "2023-01-01T00:00:00Z",
  "customAttributes": {
    "key1": "value1",
    "key2": "value2"
  }
}

The outcome of the API call is as follows:

It is validated that the account with External ID account_external_id exists.
The payer’s information is updated as per the provided values.