Page Comparison

payment_codebill's number. Applicable and mandatory if the bill to be paid has such a check digit

Name	Type	Description
token	String	The token retrieved from the login method
accounts_receivable_identifier (semi-optional)	Accounts Receivable Identifier	The identifier of the accounts receivable in which the payment should be allocated to. The allowed accounts receivable identifier fields are the following: Include Page V4:accounts_receivable_identifier V4:accounts_receivable_identifier Tip For releases prior CRM.COM R14.0.0, this parameter is mandatory
wallet_identifier (semi-optional)	Wallet Identifier	The identifier of the wallet in which the payment should be allocated to. The allowed wallet identifier fields are the following: Include Page V4:wallet_identifier V4:wallet_identifier Only the unconditional wallet funds can be used in order to pay off Bills Tip Available from CRM.COM R14.0.0 If the payment using unconditional wallet funds is not enabled through the Wallet Definition, then this parameter is not applicable
type_identifier (mandatory)	Financial Transaction Type Identifier	The financial transaction type of the payment. The allowed financial transaction type identifier field are the following: Include Page V4:accountsfinancial_transaction_receivabletype_identifier V4:accountsfinancial_transaction_receivabletype_identifier Tip For releases prior From CRM.COM R14.0.0 and onwards, if the wallet_identifier parameter is set then this parameter is mandatory wallet cannot include Payment Gateways
category_identifier (semi-optional)	Wallet IdentifierFinancial transaction category identifier	The identifier of the wallet in which financial transaction category of the payment that should be allocated toreturned as a result. The allowed wallet financial transaction category identifier fields are the following: type Include Page V4:wallet_identifier V4:wallet_identifier Only the unconditional wallet funds can be used in order to pay off Bills Tip Available from CRM.COM R14.0.0 If the payment using unconditional wallet funds is not enabled through the Wallet Definition, then this parameter is not applicable financial_transaction_category_identifier V4:financial_transaction_category_identifier
payment_method_identifier (mandatory)	Financial Transaction Type IdentifierPayment method identifier	The financial transaction type payment method of the payment. The allowed financial transaction type identifier field allowed payment method identifier fields are the following: Include Page V4:financial_transactionpayment_typemethod_identifier V4:financialpayment_transaction_typemethod_identifier Tip From CRM.COM R14.0.0 and onwards, if the wallet_identifier parameter is set then this parameter cannot include Payment Gateways
categorybill_identifier (optionalmandatory)	Financial transaction category Bill identifier	The financial transaction category of the payment that should be returned as a resultinvoice to be paid. The allowed financial transaction category invoice identifier fields are the following: Include Page V4:financial_transaction_categorybill_identifier V4:financial_transaction_categorybill_identifier
paymentbill_number_methodcheck_identifierdigit (mandatory on conditions) Payment method identifier	Number	The payment method check digit of the payment. The allowed payment method identifier fields are the following:
Include Page
V4:payment_method_identifier	V4:payment_method_identifier	bill_identifier (mandatory)	Bill identifier	The invoice to be paid. The allowed invoice identifier fields are the following:
Include Page
V4:bill_identifier	V4:bill_identifier

Tip
Available from CRM.COM R14.0.0

accounts_receivable_check_digit

(mandatory on conditions)

Number

The check digit of the bill's accounts receivable number. Applicable and mandatory if the bill to be paid has such a check digit

Tip
Available from CRM.COM R14.0.0

bill_amount_check_digit

(mandatory on conditions)

Number

The payment code if the bill that will be paidcheck digit of the bill's accounts receivable number. Applicable and mandatory if the bill to be paid has a payment code and the payment code rules are enabled for the type of the payment being postedsuch a check digit

Tip
Available from CRM.COM R14.0.0

received_on

(optional)

DateThe date that the payment was received. It defaults to the issued date if not specified

received_by_user_identifier

(optional)

User identifier

The user who actually received the payment. It defaults to the issued by user if not specified. The allowed user identifier fields are the following:

Include Page
V4:user_identifier V4:user_identifier

received_by_unit_identifier

(optional)

Unit identifierThe unit who actually received the payment. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier V4:unit_identifier

card_identifier

(mandatory on conditions)

Payment Gateway Card Identifier

The card that will be charged for the amount specified on the payment, by the related payment gateway provider. The allowed payment gateway card identifier fields are the following:

Include Page
V4:payment_gateway_card_identifier V4:payment_gateway_card_identifier

The card is applicable and mandatory if the specified payment method is linked with a payment gateway system. Note that the retrieved cards are filtered based on the cards owned by the specified accounts receivable owner

 

accounts_receivable_payment_preference_identifier

(mandatory on conditions)

Accounts Receivable Payment Preference Identifier

The accounts receivable payment preferences that will be used by generic payment gateways to process the payment. The specified accounts receivable payment preferences should belong to the specified accounts receivable. This information is applicable and mandatory only if the payment will be processed by a generic payment gateway, as denoted by the selected payment method. The allowed accounts receivable payment preference identifier fields are the following:

Include Page
V4:accounts_receivable_payment_preference_identifier V4:accounts_receivable_payment_preference_identifier

Tip
Available from CRM.COM R11.0.0

notes

(optional)

StringShared notes for the payment

back_office_code

(optional)

String

A back office code for the payment. If specified then it should be unique

Tip
Available from CRM.COM R9.1.0

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

fields_set

(optional)

List of Strings, comma separated

 A list of fields that should be included in the results. If not specified then all the available fields will be returned

Tip
Available from CRM.COM R10.0.0