Page Comparison

...

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

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

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:

...

type_identifier

(mandatory)

...

The financial transaction type of the payment. The allowed financial transaction type identifier field are the following:

...

category_identifier

(optional)

...

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

...

payment_method_identifier

(mandatory)

...

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

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 accounts receivable identifier fields are the following:

Include Page

	V4:

payment

accounts_

method

receivable_identifier
	V4:

payment

accounts_

method

receivable_identifier

invoice

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

wallet_identifier

(

mandatory

semi-optional)

Invoice identifier

Wallet Identifier

The

invoice to be paid

identifier of the wallet in which the payment should be allocated to. The allowed

invoice

wallet identifier fields are the following:

Include Page

	V4:

invoice

wallet_identifier
	V4:

invoice

wallet_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 identifierThe user who actually received the payment. It defaults to the issued by user if not specified. The allowed user identifier fields

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:

user_identifier

financial_transaction_type_identifier
	V4:

user

financial_transaction_type_identifier

received_by_unit_

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)

Unit

Financial transaction category identifier

The

unit who actually received the payment. The allowed unit

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:

unit

financial_transaction_category_identifier
	V4:

unit

financial_transaction_category_identifier

card

payment_method_identifier

(mandatory

on conditions

)

Payment

Gateway Card Identifier

method 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

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

Include Page

	V4:payment_

gateway

method_

card_identifier

identifier
	V4:payment_

gateway_cardaccounts_receivable_payment_preference_

method_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

invoice_identifier

(mandatory

on conditions

notes

(optional)

StringShared notes for the payment

back_office_code

(optional)

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

)

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 PageV4:accounts_receivable_payment_preference_identifierV4:accounts_receivable_payment_preference_identifier

Tip
Available from CRM.COM R11.0.0

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)

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:user_identifier
	V4:user_identifier

received_by_unit_identifier

(optional)

Unit identifier

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

Include Page

	V4:unit_identifier
	V4:unit_identifier

Tip
Deprecated from CRM.COM R18.0.0

received_by_business_unit_identifier

(optional)

Business Unit identifier

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

Include Page

	V4:unit_identifier
	V4:unit_identifier

Tip
Available from CRM.COM

R9

R18.

1

0.0

udf

card_

string_1

identifier

(

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.

Response Data

...

Examples

...

title	Example 1

HTTP Method: POST

Request:

Body:

...

theme	Confluence
language	javascript
linenumbers	true

...

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)

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)

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.

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":"192"},
	"type_identifier":{"name":"Invoices Balance Payment"},
	"payment_method_identifier":{"name":"Direct Debit"},
	"category_identifier":{"name":"Invoice Payments"},
	"invoice_identifier":{"reference_number":"328"},
	"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": 225,
        "issued_on": "2014-07-14T16:49:11",
        "life_cycle_state": "POSTED",
        "number": "100",
        "id": "83DFE781350877933A6FA2A51EF0F102",
        "reference_number": "115",
        "posted_on": "2014-07-14T16:49:11"
    }
}

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

language	javascript
theme	Confluence
linenumbers	true

 {
	"token": "B8D7A12E9F91AFADE914B7330AFD08CB",
    "accounts_receivable_identifier":{"name":"InvoiceDina PaymentsMika"},
  	  "invoicefields_identifierset":{"number,reference_number":"328"},
	"received_on":"2014-07-14T09:12:54",
	"received_by_user_,id,issued_on,payment_amount",
    "type_identifier":{"usernamename":"JackHPayment 1"},
    	"receivedpayment_bymethod_unit_identifier":{"name":"AdminDirect UnitDebit"},
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
 
    "category_identifier":{"name":"Payment Category 1"},
    "invoice_identifier":{"reference_number":"2023"},
      "message": null"received_on":"2014-07-14T09:12:54",
        "description": null,
   "received_by_user_identifier":{"username":"MPAdministrator"},
    "codereceived_by_unit_identifier": {"name"OK:"Admin Unit"}
   },
 }

Response:

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
  "datastatus": {
   {    "message": "",
    "payment_amountdescription": 225"",
        "issued_on"code": "2014-07-14T16:49:11"OK"
  },
  "data": {
    "lifepayment_cycle_stateamount": "POSTED",
    55,
    "numberissued_on": "1002016-06-09T13:15:44",
  
     "idnumber": "83DFE781350877933A6FA2A51EF0F102367",
   
    "reference_numberid": "11510303722803F4FAAAF420243C30889F9",
        "postedreference_onnumber": "2014-07-14T16:49:11"
388"
   }
}

Expand

title	Example 23

HTTP Method: POST

Request:

Body:

Code Block

language

language	javascript
theme	Confluence
javascript	linenumbers	true

 {
 	   "token": "B8D7A12E9F91AFADE914B7330AFD08CB"{{token}},
    "accounts_receivablewallet_identifier":{"name":"Dina Mika"},
    "fields_setnumber":"number,reference_number,id,issued_on,payment_amount"W0000007376"},
    "type_identifier":{"name":"Cash Payment 1"},
    "payment_method_identifier":{"name":"Cash Payment"},
    "invoice_identifier":{"name":"Direct Debit"},":{"id":"54F3A49F23024C51AFF21B7C728F3549"}
}

Response:

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
     "category_identifierdata":{"name":"Payment Category 1"}, {
        "invoiceposted_identifieron":{"reference_number":"2023"} "2017-09-15T11:26:28",
    "received_on    "number":"2014-07-14T09:12:54", "3869",
        "received_by_user_identifier":{"username":"MPAdministrator"},payment_amount": 5,
        "received_by_unit_identifierissued_on":{"name":"Admin Unit"}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{ "2017-09-15T11:26:28",
        "statuscurrency_rate_period": { null,
        "messageid": "70E2AE4819E4462E94EB55381491259E",
        "descriptionlife_cycle_state": "POSTED",
        "codereference_number": "OK4878"
    },
    "datastatus": {
    "payment_amount": 55,     "issued_oncode": "2016-06-09T13:15:44OK",
        "numberdescription": "367",
 
  "id": "10303722803F4FAAAF420243C30889F9",     "reference_numbermessage": "388"
    }
}

Versions Compared

Old Version 4

New Version Current

Key

Resource URL

Parameters

Resource URL

Parameters

Restrictions

Response Data

Examples

Response Data

Examples