Versions Compared

Old Version 8

changes.mady.by.user Joseph Ioannou

Saved on

compared with

New Version 9

changes.mady.by.user Christina Georgiou (Unlicensed)

Saved on

Key

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

This method is creating a new payment with the intention to pay the whole outstanding amount of a specific invoice. The method can be applied on a single invoice only. The payment is created in a posted state

...

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 unconditional wallet funds can be used in order to pay off Invoices

Tip

Available from CRM.COM R14.0.0

If the payment using Wallet funds functionality 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:financial_transaction_type_identifier
V4:financial_transaction_type_identifier

Tip

From CRM.COM R14.0.0 and onwards, if the wallet_identifier parameter is set then this parameter cannot include Payment Gateways

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

(mandatory)

Payment method identifier

The payment method of the payment. The allowed payment method identifier fields are the following:

Include Page
V4:payment_method_identifier
V4:payment_method_identifier

invoice_identifier

(mandatory)

Invoice identifier

The invoice to be paid. The allowed invoice identifier fields are the following:

Include Page
V4:invoice_identifier
V4:invoice_identifier

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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...

Expand
titleExample 2

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
	"token": "B8D7A12E9F91AFADE914B7330AFD08CB",
    "accounts_receivable_identifier":{"name":"Dina Mika"},
    "fields_set":"number,reference_number,id,issued_on,payment_amount",
    "type_identifier":{"name":"Payment 1"},
    "payment_method_identifier":{"name":"Direct Debit"},
    "category_identifier":{"name":"Payment Category 1"},
    "invoice_identifier":{"reference_number":"2023"},
    "received_on":"2014-07-14T09:12:54",
    "received_by_user_identifier":{"username":"MPAdministrator"},
    "received_by_unit_identifier":{"name":"Admin Unit"}
}


Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "payment_amount": 55,
    "issued_on": "2016-06-09T13:15:44",
    "number": "367",
    "id": "10303722803F4FAAAF420243C30889F9",
    "reference_number": "388"
  }
}
Expand
titleExample 3

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token": {{token}},
    "wallet_identifier":{"number":"W0000007376"},
    "type_identifier":{"name":"Cash Payment"},
    "payment_method_identifier":{"name":"Cash Payment"},
    "invoice_identifier":{"id":"54F3A49F23024C51AFF21B7C728F3549"}
}


Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "data": {
        "posted_on": "2017-09-15T11:26:28",
        "number": "3869",
        "payment_amount": 5,
        "issued_on": "2017-09-15T11:26:28",
        "currency_rate_period": null,
        "id": "70E2AE4819E4462E94EB55381491259E",
        "life_cycle_state": "POSTED",
        "reference_number": "4878"
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}