Page Comparison

...

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

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(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:

...

Tip
For releases prior CRM.COM R14.0.0, this parameter is mandatory

...

(semi-optional)

...

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

Resource URL

Parameters

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

wallet

accounts receivable identifier fields are the following:

Include Page

	V4:

wallet

accounts_receivable_identifier
	V4:

wallet

accounts_receivable_identifier

Tip

Available from

For releases prior 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 IdentifierThe financial transaction type of the payment. The allowed financial transaction type identifier field

, 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:

financial

wallet_

transaction_type_

identifier
	V4:

financial_transaction_type_identifier

wallet_identifier

Only the unconditional wallet funds can be used in order to pay off Bills

Tip

From

Available from CRM.COM R14.0.0

and onwards, if the wallet_identifier parameter is set then this parameter cannot include Payment Gateways

category

If the payment using unconditional wallet funds is not enabled through the Wallet Definition, then this parameter is not applicable

type_identifier

(

optional

mandatory)

Financial

transaction category identifier

Transaction Type Identifier

The financial transaction

category

type of the payment

that should be returned as a result

. The allowed financial

transaction category

transaction type identifier

fields

field are the following:

Include Page

	V4:financial_transaction_

category

type_identifier
	V4:financial_transaction_

category

type_identifier

payment_method

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

(

mandatory

optional)

Payment method

Financial transaction category identifier

The

payment method

financial transaction category of the payment that should be returned as a result. The

allowed payment method

allowed financial transaction category identifier fields are the following:

Include Page

	V4:

payment_method

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

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

received_on

bill_number_check_digit

(

optional

mandatory on conditions)

Date

Number

The

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 PageV4:user_identifierV4:user_identifier

received_by_unit_identifier

(optional)

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

card_identifier

(mandatory on conditions)

Payment Gateway Card IdentifierThe 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

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

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 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

received_on

(optional)

Date

The 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:

payment_gateway_card

user_identifier
	V4:

payment

user_

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

received_by_unit_identifier

(

mandatory on conditions

optional)

Accounts Receivable Payment Preference IdentifierThe 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

Unit identifier

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

Include Page

	V4:

accounts_receivable_payment_preference_

unit_identifier
	V4:

accounts_receivable_payment_preference

unit_identifier

Tip

Available

Deprecated from CRM.COM

R11

R18.0.0

notes

back_office_code

(optional)

String

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

received_by_business_unit_identifier

(optional)

StringShared notes for the payment

Business Unit identifier

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

Include Page

	business_unit_identifier
	business_unit_identifier

Tip
Available from CRM.COM

R9

R18.

1

0.0

udf

card_

string_1

identifier

(

optional

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

mandatory on conditions)

String

User Defined Field of type String

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)

String

Shared 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)

Float

String

User Defined Field of type

Float

String

udf_

float

string_3

(optional)

Float

String

User Defined Field of type

Float

String

udf_

float

string_4

(optional)

Float

String

User Defined Field of type

Float

String

udf_

date

string_

1

5

(optional)

Date

String

User Defined Field of type

Date

String

udf_

date

string_

2

6

(optional)

Date

String

User Defined Field of type

Date

String

udf_

date

string_

3

7

(optional)

Date

String

User Defined Field of type

Date

String

udf_

date

string_

4

8

(optional)

Date

String

User Defined Field of type

Date

String

fields

udf_float_

set

1

(optional)

Float

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.

Response Data

...

Examples

...

title	Example 1

HTTP Method: POST

...

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.

Response Data

Include Page

	V4:payment_short
	V4:payment_short

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

language	javascript
theme	Confluence
linenumbers	true

 {
	"token": "B8D7A12E9F91AFADE914B7330AFD08CB",
	"accounts_receivable_identifier":{"number":"186"},
	"type_identifier":{"name":"Invoices Balance Payment"},
	"payment_method_identifier":{"name":"Direct Debit"},
	"category_identifier":{"name":"Bill Payments"},
	"bill_identifier":{"number":"128"},
	"received_on":"2014-07-14T09:12:54",
	"received_by_user_identifier":{"username":"JackH"},
	"received_by_unit_identifier":{"name":"Admin Unit"},
}

Response:

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "payment_amount": 100,
        "issued_on": "2014-07-14T17:01:43",
        "life_cycle_state": "POSTED",
        "number": "101",
        "id": "B88388BA9E05BCBBB4579A2D2EBB22DC",
        "reference_number": "116",
        "posted_on": "2014-07-14T17:01:44"
    }
}

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

 {
	"token": "B8D7A12E9F91AFADE914B7330AFD08CB",
	"accounts_receivable_identifier":{"number":"186"},
	",
    "accounts_receivable_identifier":{"name":"Dina Mika"},
    "fields_set":"number,reference_number,id,issued_on,payment_amount",
    "type_identifier":{"name":"InvoicesPayment Balance Payment1"},
    	"payment_method_identifier":{"name":"Direct Debit"},
  	  "category_identifier":{"name":"BillPayment Category Payments1"},
	    "bill_identifier":{"number":"128BL001069"},
    	"received_on":"2014-07-14T09:12:54",
    	"received_by_user_identifier":{"username":"JackHMPAdministrator"},
   	 "received_by_unit_identifier":{"name":"Admin Unit"},
}

Response:

Code Block

language

language	javascript
theme	Confluence
javascript	linenumbers	true

{
    "status":
    {
        "message": null,
     
  "descriptionstatus": null,
   {
    "codemessage": "OK"
    },
    "datadescription":
    {
        "payment_amount": 100,
   
    "issued_oncode": "2014-07-14T17:01:43""OK"
  },
  "data": {
    "lifepayment_cycle_stateamount": "POSTED",
  10.11,
     "numberissued_on": "1012016-06-09T13:23:14",
   
    "idnumber": "B88388BA9E05BCBBB4579A2D2EBB22DC368",
        "reference_number"id": "1167AE6408C118E40D6A71BEE37186B370E",
 
      "postedreference_onnumber": "2014-07-14T17:01:44"
 389"
  }
}

Expand

title	Example 23

HTTP Method: POST

Request:

Body:

Code Block

language

language	javascript
theme	Confluence
javascript	linenumbers	true

 {
    	"token": {{token}},
    "B8D7A12E9F91AFADE914B7330AFD08CB""wallet_identifier":{"number":"W0000007376"},
    "accountstype_receivable_identifier":{"name":"DinaCash MikaPayment"},
    "fields_set":"number,reference_number,id,issued_on,payment_amount"payment_method_identifier":{"name":"Cash Payment"},
    "typebill_identifier":{"namenumber":"1196"Payment}
1"},}

Response:

Code Block

language	javascript
theme	Confluence
linenumbers	true

 {
    "payment_method_identifierdata":{"name":"Direct Debit"}, {
        "categoryposted_identifieron":{"name":"Payment Category 1"},
 "2017-09-15T11:43:11",
   "bill_identifier":{"number":"BL001069"},     "received_onnumber":"2014-07-14T09:12:54 "3873",
        "received_by_user_identifier":{"username":"MPAdministrator"},payment_amount": 15.11,
        "received_by_unit_identifierissued_on":{"name":"Admin Unit"}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{ "2017-09-15T11:43:10",
        "statuscurrency_rate_period": null,
   {     "messageid": "466932A351684A138E4D823F215B6E7F",
    "description    "life_cycle_state": "POSTED",
        "codereference_number": "OK4883"
    },
    "datastatus": {
    "payment_amount": 10.11,     "issued_oncode": "2016-06-09T13:23:14OK",
        "numberdescription": "368",
    "id": "7AE6408C118E40D6A71BEE37186B370E",     "reference_numbermessage": "389"
    }
}

Versions Compared

Old Version 10

New Version Current

Key

Resource URL

Parameters

Resource URL

Parameters

Response Data

Examples

Response Data

Examples