Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

This method returns information related with  to payments. Multiple payments are returned by each call

...

wallet

(semi-optional)

The identifier of the wallet in which the payment should be allocated to. The allowed wallet identifier fields are the following:

Available from CRM.COM R14.0.0

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optionalmandatory)

Accounts receivable identifier  

The identifier of the accounts receivable in which the payments that should be returned as a result should be allocated. 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

_identifier

Wallet Identifier
Include Page
V4:wallet_identifierV4:wallet_identifier
Tip

type_identifier

(optional)

Financial transaction type identifier

The financial transaction type of the payment that should be returned as a result. The allowed financial transaction type identifier field are the following:

Include Page
V4:financial_transaction_type_identifier
V4:financial_transaction_type_identifier

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:

Include Page
V4:financial_transaction_category_identifier
V4:financial_transaction_category_identifier

payment_method_identifier

(optional)

Payment method identifier

The payment method of the payment that should be returned as a result. The allowed payment method identifier fields are the following:

Include Page
V4:payment_method_identifier
V4:payment_method_identifier

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip

Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Tip

Available from CRM.COM R13.0.0

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

...