Table of Contents

maxLevel	2

...

Name

Type

Description

token

String

The token retrieved from the login method

payment_identifier

(mandatory)

Payment identifier

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

Include Page

	V4:payment_identifier
	V4:payment_identifier

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

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "invoices_to_pay_set":
        [
            {
                "total_amount": 138,
                "issued_on": "2014-07-14T10:31:15",
                "life_cycle_state": "POSTED",
                "number": "I00000294",
                "due_on": "2014-08-17T10:35:57",
                "id": "176AB06AE6DBFDB103182C67C68A2A8B",
                "outstanding_amount": 0,
                "reference_number": "322",
                "posted_on": "2014-07-14T10:35:57"
            }
        ],
        "udf_float_1": null,
        "udf_float_2": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "number": "96",
        "udf_string_1": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "received_by_unit":
        {
            "community_name": "Main Community",
            "group_name": "Main Group",
            "name": "Admin Unit",
            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
            "description": "r1",
            "alternative_code": "MG"
        },
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Johnson",
                "middle_name": null,
                "company_profile": null,
                "type": "PERSON",
                "first_name": "Peter",
                "name": "Peter Johnson",
                "id": "C73D1572FEA76C37A08945ECE4DECC98",
                "company_name": null,
                "demographics":
                {
                    "gender": "MALE",
                    "passport_issued_by_country": null,
                    "passport_number": "7839023",
                    "social_security_number": "98374",
                    "country_of_residence":
                    {
                        "name": "CYPRUS",
                        "id": "181"
                    },
                    "industry_sector":
                    {
                        "name": "GOVERNMENTAL",
                        "id": "A9BDEBD4D8FAEDB0BACE40C041156D12"
                    },
                    "date_of_birth":
                    {
                        "month": 4,
                        "day": 6,
                        "year": 1985
                    },
                    "name_day":
                    {
                        "month": 6,
                        "day": 29
                    },
                    "id_number": "984783",
                    "id_issued_by_country":
                    {
                        "name": "CYPRUS",
                        "id": "181"
                    },
                    "industry": null
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "192",
            "name": "Peter Johnson Premium",
            "id": "2C5FC6F615FA9E798487AC0C293ECCE6"
        },
        "received_by_user":
        {
            "person_name": "JackH",
            "username": "JackH",
            "id": "B8650C555C4EA8C741103961276E7773",
            "email": "j_hadjicosti@crm.com"
        },
        "bills_to_pay_set":
        [
        ],
        "id": "830C6B800A1EAB42EA8D670ED6871E41",
        "posted_on": "2014-07-14T10:41:13",
        "udf_date_1": null,
        "udf_date_2": null,
        "udf_date_3": null,
        "udf_date_4": null,
        "log_information":
        {
            "updated_date": "2014-07-14T10:41:14",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2014-07-14T10:40:29",
            "updated_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "JackH",
                "username": "JackH",
                "id": "B8650C555C4EA8C741103961276E7773",
                "email": "j_hadjicosti@crm.com"
            },
            "updated_by_user":
            {
                "person_name": "JackH",
                "username": "JackH",
                "id": "B8650C555C4EA8C741103961276E7773",
                "email": "j_hadjicosti@crm.com"
            }
        },
        "payment_amount": 60,
        "issued_on": "2014-07-14T10:40:29",
        "life_cycle_state": "POSTED",
        "type":
        {
            "classification": "PAYMENT",
            "name": "Invoices Balance Payment",
            "id": "9CC46F8C0A203CCA7A40B58825E74704",
            "description": null,
            "alternative_code": "INVBALPAY"
        },
        "payment_method":
        {
            "name": "Bank Transfer",
            "id": "PM7",
            "description": "Bank Transfer",
            "alternative_code": "BT"
        },
        "back_office_code": null,
        "rejection_reason": null,
        "received_on": "2014-07-14T10:40:29",
        "reference_number": "111",
        "category": null
    }
}

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "data": {
    "notes": null,
    "received_by_user": {
      "person_name": "mmay",
      "id": "969C508EE99B478EB34570A3BD9BBC13",
      "email": null,
      "username": "mmay"
    },
    "log_information": {
      "created_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2016-03-17T08:30:19",
      "updated_date": "2016-03-17T08:30:41",
      "updated_by_user": {
        "person_name": "mmay",
        "id": "969C508EE99B478EB34570A3BD9BBC13",
        "email": null,
        "username": "mmay"
      },
      "created_by_user": {
        "person_name": "mmay",
        "id": "969C508EE99B478EB34570A3BD9BBC13",
        "email": null,
        "username": "mmay"
      }
    },
    "currency_rate_period": {
      "from_date": "C7D7ED57F21B47028144967E015DCBE5",
      "to_date": 2.3,
      "rate": 2.3,
      "inverse_rate": 0.23000000417232513,
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "£",
        "decimal_part_name": null,
        "code": "GBP",
        "integer_part_name": null,
        "id": "9"
      },
      "id": "C7D7ED57F21B47028144967E015DCBE5"
    },
    "udf_date_2": null,
    "type": {
      "alternative_code": "P",
      "name": "Payment",
      "description": null,
      "id": "PAYMENT",
      "classification": "PAYMENT"
    },
    "udf_date_1": null,
    "udf_date_4": null,
    "udf_date_3": null,
    "number": "71",
    "udf_float_3": null,
    "udf_float_4": null,
    "invoices_to_pay_set": [],
    "received_by_unit": {
      "alternative_code": "adminunit",
      "group_name": "Main Group",
      "community_name": "Community",
      "name": "Admin Unit",
      "description": "admin unit",
      "id": "1"
    },
    "rejection_reason": null,
    "received_on": "2016-03-17T08:30:19",
    "id": "DC9A5F1BF6194B24A71723D721E7AAD1",
    "udf_float_1": null,
    "udf_float_2": null,
    "payment_method": {
      "alternative_code": "C",
      "name": "Cash",
      "description": "Cash",
      "id": "C"
    },
    "udf_string_2": null,
    "udf_string_3": null,
    "accounting_period_information": null,
    "udf_string_4": null,
    "udf_string_5": null,
    "udf_string_1": null,
    "bills_to_pay_set": [],
    "payment_amount": 50,
    "accounts_receivable": {
      "number": "ACR0000000083",
      "name": "ACR0000000083 Bob A",
      "id": "A124AE2BB6604E18AFDEA2B5AB0D6E2B",
      "life_cycle_state": "TERMINATED",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "Bob A",
        "last_name": "A",
        "id": "7F1E4BDCE2D4430791FCB9F00B43F1A9",
        "life_cycle_state": "MARKETING",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Bob",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": null,
          "gender": null,
          "country_of_residence": {
            "alternative_code": "IRN",
            "three_character_code": null,
            "name": "IRAN (ISLAMIC REPUBLIC OF)",
            "id": "231",
            "two_character_code": null
          },
          "date_of_birth": {
            "month": null,
            "year": null,
            "day": null
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      }
    },
    "life_cycle_state": "POSTED",
    "reference_number": "111",
    "posted_on": "2016-03-17T08:30:40",
    "issued_on": "2016-03-17T08:30:19",
    "udf_string_6": null,
    "category": null,
    "udf_string_7": null,
    "udf_string_8": null,
    "card": null,
    "back_office_code": null
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

GET payments/list

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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

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

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

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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

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

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

(mandatory)

Number

The number of payments to be retrieved, starting from the latest one

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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

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

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

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

life_cycle_state

(mandatory)

String

The state of the retrieved payment which can be one of the following:

DRAFT, POSTED

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

payment_amount

(mandatory)

Number

The amount of the payment

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

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

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

Tip
Available from CRM.COM R5.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

invoices_to_pay_set

(optional)

Set of invoice objects

The invoices that are intended to be paid

bills_to_pay_set

(optional)

Set of bill objects

The bills that are intended to be paid

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

Anchor
payment referred parameters
payment referred parameters
Referred Parameter Objects

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

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

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

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

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)

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

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

Tip
Available from CRM.COM R5.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.

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

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

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

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

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

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

(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

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

Tip
Available from CRM.COM R5.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.

...

Name

Type

Description

token

String

The token retrieved from the login method

payment_identifier

(mandatory)

Payment identifier

The identifier of the payment that should be posted. Only payments in draft state can be specified.The allowed payment identifier fields are the following:

Include Page

	V4:payment_identifier
	V4:payment_identifier

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.

...

Name

Type

Description

token

String

The token retrieved from the login method

payment_identifier

(mandatory)

Payment Identifier

The identifier of the payment that should be posted. Only payments in draft state can be specified.The allowed payment identifier fields are the following:

Include Page

	V4:payment_identifier
	V4:payment_identifier

rejection_reason_identifier

Rejection reason identifier

The reason that the payment is rejected. The allowed rejection reason identifier fields are the following:

Include Page

	V4:financial_transaction_rejection_reason_identifier
	V4:financial_transaction_rejection_reason_identifier

...

Name

Type

Description

token

String

The token retrieved from the login method

payment_identifier

(mandatory)

Payment Identifier

The identifier of the payment that should be posted. Only payments in draft state can be specified.The allowed payment identifier fields are the following:

Include Page

	V4:payment_identifier
	V4:payment_identifier

type_identifier

(mandatory)

Financial transaction type identifier

The financial transaction type of the payment cancellation. 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 cancellation. The allowed financial transaction category identifier fields are the following:

Include Page

	V4:financial_transaction_category_identifier
	V4:financial_transaction_category_identifier

notes

(optional)

String

Shared notes for the payment cancellation

back_office_code

(optional)

String

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

Tip
Available from CRM.COM R9.1.0

issue_reason

(optional)

String

A description of the reason that the payment cancellation is issued

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

...

Name

Type

Description

token

String

The token retrieved from the login method

payment_identifier

(mandatory)

Payment Identifier

The identifier of the payment that should be updated. Only payments in draft state can be specified.The allowed payment identifier fields are the following:

Include Page

	V4:payment_identifier
	V4:payment_identifier

accounts_receivable_identifier

(optional)

Accounts receivable identifier

The identifier of the payment's updated accounts receivable. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

type_identifier

(optional)

Financial transaction type identifier

The updated financial transaction type of the payment. Only financial transaction types with Payment classification can be specified. The allowed financial transaction type identifier fields 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. 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 updated Payment Method of the payment. The allowed payment method identifier fields are the following:

Include Page

	V4:payment_method_identifier
	V4:payment_method_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

received_by_user_identifier

(optional)

User identifier

The user who actually received the payment. 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

received_on

(optional)

Date

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

payment_amount

(optional)

Number

The Payment's updated amount

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

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

invoices_to_pay_set

(optional)

Set of invoice objects

The invoices that are intended to be paid

Include Page

	V4:Web API - Updating Sets
	V4:Web API - Updating Sets

bills_to_pay_set

(optional)

Set of bill objects

The bills that are intended to be paid

Include Page

	V4:Web API - Updating Sets
	V4:Web API - Updating Sets

...

Versions Compared

Old Version 45

New Version 46

Key

GET payments/list

Anchor
payment referred parameters
payment referred parameters
Referred Parameter Objects

Restrictions

Restrictions

Restrictions

Page Comparison

Versions Compared

Old Version 45

New Version 46

Key

GET payments/list

Anchorpayment referred parameterspayment referred parametersReferred Parameter Objects

Restrictions

Restrictions

Restrictions

Anchor
payment referred parameters
payment referred parameters
Referred Parameter Objects