Skip to end of banner
Go to start of banner

POST payments/update

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

Available from CRM.COM R9.1.0

This method is used to update a single Payment but only as long as it is in Draft state.

Resource URL

Parameters

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the payment

number

(semi-optional)

String

The number of the payment

reference_number

(semi-optional)

String

The reference number of  the payment

back_office_code

(semi-optional)

String

The back office code of the payment

Available from CRM.COM R9.1.0

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

From CRM.COM R14.0.0 and onwards, if the wallet_identifier parameter is set, then this parameter cannot be defined


wallet_identifier

(optional)

Wallet Identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the wallet

number

(semi-optional)

String

The number of the wallet

In addition the following conditions apply:

  • If the payment using Wallet funds functionality is not enabled through the Wallet Definition, then this parameter is not applicable
  • If the accounts_receivable_identifier parameter is set, then this parameter cannot be defined

Available from CRM.COM R14.0.0

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the financial transaction type

name

(semi-optional)

String

The name of the financial transaction type

alternative_code

(semi-optional)

String

The alternative code of  the financial transaction type

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

Name

Type

Description

id

(semi-optional)

String

The ID of the financial transaction category

name

(semi-optional)

String

The name of the financial transaction category

code

(semi-optional)

String

The code of  the financial transaction category

payment_method_identifier

(optional)

Payment Method identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the payment method

name

(semi-optional)

String

The name of the payment method

alternative_code

(semi-optional)

String

The alternative code of  the payment method

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:

Name

Type

Description

id

(semi-optional)

String

The id of the payment gateway card

payment_gateway_reference_number

(semi-optional)

String

The card's reference number as provided by the payment gateway

last_digits

(semi-optional)

String The last digits of the card as provided by the payment gateway provider

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:

Name

Type

Description

id

(semi-optional)

String

The ID of accounts receivable payment preference

payment_preference_identifier

(semi-optional)

Identifier  

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

Name

Type

Description

id

(semi-optional)

String

The ID of payment preference

name 

(semi-optional)

String

The name of payment preference

alternative_code 

(semi-optional)

String

The alternative code of payment preference

payment_medium_identifier

(semi-optional)

String

The payment medium identifier related with the accounts receivable payment preference

Available from CRM.COM R11.0.0

bank_account_number

(semi-optional)

StringThe bank account number related with the accounts receivable payment preference

Available from CRM.COM R11.0.0

 


Available from CRM.COM R11.0.0

From CRM.COM R14.0.0 and onwards, this parameter is mandatory only if the accounts_receivable_identifier parameter is specified. If the wallet_identifier parameter is specified then this information is not applicable

received_by_user_identifier

(optional)

User identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the user

username

(semi-optional)

String

The username of the user

received_by_unit_identifier

(optional)

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

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of  the Unit

received_on

(optional)

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

payment_amount

(optional)

NumberThe Payment's updated amount

intended_currency_identifier

(optional)

Currency Identifier

The currency that the user was intended to use for the payment. If specified then it is validated against the currency of the specified accounts receivable and if they don't match then an error is throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the currency

code

(semi-optional)

String

The code of the currency

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


job_identifier

(optional)

Job Identifier

The job for which the payment was done for. The allowed job identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the job

number

(semi-optional)

String

The number of the job

Available from CRM.COM R14.4.0

issue_date

(optional)

Date

The issue date of the financial transaction which is <= to the current date and not included in previous closed accounting periods. If not specified then the current date is applied. 

Available from CRM.COM R14.10.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

If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example:

"set": [
	   		{
            	"action": "update",
            	...........
        	},
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add",
            	...........
			}
		]

bills_to_pay_set

(optional)

Set of bill objects

The bills that are intended to be paid

If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example:

"set": [
	   		{
            	"action": "update",
            	...........
        	},
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add",
            	...........
			}
		]

products_to_pay_set

(optional)

Set of product objects

The service products that are intended to be paid through this payment. Applicable only if the account owner owns an effective wallet and the payment is also included as a wallet credit cause in active Wallet definititions.

If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example:

"set": [
	   		{
            	"action": "update",
            	...........
        	},
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add",
            	...........
			}
		]

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

Referred Parameters Objects Data

 invoice parameter object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, REMOVE

invoice_identifier

(mandatory)

Invoice identifierThe identifier of the invoice to be used. The allowed invoice identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the invoice

number

(semi-optional)

String

The number of the invoice

reference_number

(semi-optional)

String

The reference number of  the invoice

back_office_code

(semi-optional)

String

The back office code of the invoice

Available from CRM.COM R9.1.0

 bill parameter object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, REMOVE

bill_identifier

(mandatory)

Bill identifierThe identifier of the bill to be used. The allowed bill identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the bill

number

(semi-optional)

String

The number of the bill

bill_number_check_digit

(mandatory on conditions)

Number

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

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

Available from CRM.COM R14.0.0

bill_amount_check_digit

(mandatory on conditions)

Number

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

Available from CRM.COM R14.0.0


 products parameter object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, REMOVE

product_identifier

(mandatory)

Product Identifier

The service product for which the payment is submitted. Only products classified as Termed services are allowed to be specified and only as long as they exist in a subscription owned by the account owner. The allowed product identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of  the product

Restrictions

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

Response Data

Name

Type

Description

id

String

The ID of the retrieved payment

number

String

The number of the retrieved payment

reference_numberStringThe reference number of the retrieved payment
life_cycle_stateString

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

DRAFT, REJECTED, POSTED, CANCELLED

payment_amountNumberThe amount of the payment
issued_onDateThe date that the payment was issued
posted_onDateThe date that the payment was posted
received_onDateThe date that the payment was received
notesStringShared notes for the payment
processed_by_payment_gatewayString

The payment gateway that processed the payment. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed


payment_gateway_reference_numberString

A reference to the number of the payment that was created on the payment gateway. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed


back_office_codeString

The back office code of the retrieved payment

Available from CRM.COM R9.1.0

udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

accounts_receivableAccounts Receivable Object

The related accounts receivable

For releases prior CRM.COM R14.0.0, the related Accounts Receivable Object is retrieved always

From CRM.COM R14.0.0 and onwards, Accounts Receivable Object will be retrieved only if the payment was posted against it

voucherVoucher Object

The related voucher

Available from CRM.COM R14.0.0


typeFinancial transaction type objectThe financial transaction type of the payment
categoryFinancial transaction category objectThe category of the payment
payment_methodPayment method objectThe payment method of that payment
received_by_userUser objectThe user who actually received the payment
received_by_unitUnit object

The unit who actually received the payment

Deprecated from CRM.COM R18.0.0

received_by_business_unitBusiness Unit object

The business unit who actually received the payment

Available from CRM.COM R18.0.0

rejection_reasonFinancial transaction rejection reason objectThe reason that the payment was rejected
cardPayment Gateway Card Object

The card that was charged by the payment gateway that processed the payment. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed


payment_preferenceAccounts Receivable Payment Preference Object

The accounts receivable payment preference that were used by the payment gateway that processed the payment. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed

Available from CRM.COM R11.0.0

accounting_period_informationAccounting Period Information object

The accounting period information of the retrieved payment. This is applicable only if the payment was processed within an Accounting Period Closing process run.

Available from CRM.COM R10.0.0
currency_rate_periodCurrency Rate Period object

The currency rate period based on which the payment's amounts were calculated

Available from CRM.COM R10.0.0

invoices_to_pay_setSet of invoice objectsThe invoices that were intended to be paid
bills_to_pay_setSet of bill objectsThe bills that were intended to be paid
products_to_pay_setSet of products

The products that were intended to be paid

Available from CRM.COM R12.0.0

bills_paidSet of bill objects

The bill(s) actually paid through the payment

Available from CRM.COM R14.28.0

payment_cancellationPayment Cancellation Object

The payment cancellation related with the retrieved payment, if it was cancelled

Available from CRM.COM R14.5.0

log_information

Log Information Object

The log information related with the retrieved payment

Referred Objects Response Data

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe name of the retrieved accounts receivable

life_cycle_state

String

The life cycle state of the accounts receivable. One of the following values is returned:

ACTIVE, SUSPENDED, TERMINATED

account_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

type

String

The type of the retrieved contact information which can be PERSON or COMPANY

life_cycle_state

String

The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL

name

String

The full name of the retrieved contact information

first_name

String

The first name of the retrieved contact information

middle_name

String

The middle name of the retrieved contact information

last_name

String

The last name of the retrieved contact information

title

String

The title of the retrieved contact information

company_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

The gender of the retrieved contact information which can be MALE or FEMALE

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

The ID number's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 voucher response data object

Name

Type

Description

id

String

The ID of the retrieved voucher

number

String

The number of the retrieved voucher

valueNumberThe value of the retrieved voucher
extra_added_valueNumber

The extra added value of the retrieved voucher

From CRM.COM R14.0.0 and onwards this information is only available if the voucher type classification is "Payment Voucher"

life_cycle_state

String

The life cycle state of the retrieved voucher which can be DRAFT, ACCEPTED_FOR_ACTIVATION, NOT_ACCEPTED_FOR_ACTIVATION, ACTIVATED, USED, CANCELLED, PURGED

From CRM.COM R14.0.0 and onwards the applicable life cycle state of the retrieved voucher of type with classification "Refund Voucher" can be ACTIVATED, USED, PURGED

typeVoucher Type objectThe type information of the retrieved voucher
lotVouchers Lot Object

The lot of the retrieved voucher

From CRM.COM R14.0.0 and onwards this information is available only if the voucher type classification is "Payment Voucher"

 

Referred Objects Response Data

 voucher_type response data object
NameType Description
IdStringThe ID of the retrieved voucher type
nameStringThe Name of the retrieved voucher type
alternative_codeStringThe Alternative Code of the retrieved voucher type
value_optionsString

Defines if the value should be fixed, as defined in the voucher type, or a variable, as defined during the creation of the vouchers. The supported options are FIXED and VARIABLE

From CRM.COM R13.1.0 and onwards for voucher types of classification equal to "Electronic Voucher" the supported option is VARIABLE

From CRM.COM R14.0.0 and onwards for voucher types of classification equal to "Refund Voucher" the supported option is VARIABLE

classificationString

The Classification of the retrieved voucher type

Available from CRM.COM R13.1.0

descriptionStringThe Description of the retrieved voucher type

 lot response data object
NameType Description
IdStringThe ID of the retrieved lot
numberStringThe number of the retrieved lot
alternative_codeStringThe alternative code of the retrieved lot
descriptionStringThe description of the retrieved lot

 financial_transaction_type response data object
NameType Description
IdStringThe ID of the retrieved financial transaction type
nameStringThe Name of the retrieved financial transaction type
alternative_codeStringThe Alternative code of the retrieved financial transaction type
descriptionStringThe Description of the retrieved financial transaction type
classificationSting

The Classification of the retrieved financial transaction category which can be one of the following:

INVOICE, INVOICE_CANCELLATION, CREDIT_NOTE, PAYMENT, PAYMENT_CANCELLATION, REFUND, WRITE_OFF

WRITE_OFF classification is available from CRM.COM R13.0.0

 financial_transaction_category response data object
NameType Description
IdStringThe ID of the retrieved financial transaction category
nameStringThe Name of the retrieved financial transaction category
codeStringThe code of the retrieved financial transaction category
descriptionStringThe Description of the retrieved financial transaction category

 payment_method object response data

Name

Type

Description

id

String

The id of the retrieved payment method

name

String

The name of the retrieved payment method

alternative_code

String

The alternative code of the retrieved payment method

descriptionString

The description  of the retrieved payment method

 

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

 rejection_reason response data object
NameType Description
IdStringThe ID of the retrieved financial transaction rejection reason
nameStringThe Name of the retrieved financial transaction rejection reason
alternative_codeStringThe Alternative code of the retrieved financial transaction rejection reason
descriptionStringThe Description of the retrieved financial transaction rejection reason

 payment gateway card object response data

Name

Type

Description

id

String

The id of the retrieved payment gateway card

payment_gateway_reference_number

String

The card's reference number as provided by the payment gateway. This number is used to submit transactions on the payment gateway that will be processed using that card

card_holder_name

String

The card holders name, as provided during the registration of the card
brandString

The card's brand, as provided by the payment gateway provider. The supported brands by the payment gateways are the following

  • Stripe: VISA, AMERICAN_EXPRESS, MASTER_CARD, DISCOVER, JCB, DINERS_CLUB, UNKNOWN
  • Braintree: VISA, AMERICAN_EXPRESS, MAESTRO, MASTER_CARD, DISCOVER, JCB, DINERS_CLUB
  • Payeezy: VISA, AMERICAN_EXPRESS, MASTER_CARD, DISCOVER
  • Swedbank: VISA, MAESTRO, MASTER_CARD
expiration_monthNumberThe card's expiration month, which can be from 1 to 12
expiration_yearNumberThe card's expiration year which is a 4 digits number
typeString

The type of the card, as provided by the payment gateway provider. The supported types by the payment gateway are the following:

  • Stripe: CREDIT, DEBIT, PREPAID, UNKNOWN
last_digitsStringThe last 4 digits of the card as provided by the payment gateway provider. Those digits are masked with 12 asterisk characters for example **** ***** ***** 4242
consumer_tokenStringThe consumer token

 accounts_receivable_payment_preference object response data

Name

Type

Description

id

String

The ID of the retrieved payment preference

account_holder

String

The account holder of the retrieved payment preference

bank_account_number

String

The bank account number of the retrieved payment preference

default

Boolean

Indicates if the retrieved payment preference is the default for the related accounts receivable

stateString

Indicates if the retrieved payment preference is active or not. The supported values are ACTIVE or INACTIVE

Available from CRM.COM R15.0.0

use_for_recurring_payments

Boolean

Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable.

Depracated from CRM.COM R16.0.0 (and replaced by opt_in_for_subscriptions). The parameter will still function but it will not be maintained

 opt_in_for_subscriptions

 Boolean

Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable, related to its subscriptions.

Available from CRM.COM R16.0.0

 opt_in_for_purchases

 Boolean

Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable, related to purchases.

Available from CRM.COM R16.0.0

notesString

The notes of the retrieved payment preference object.

Available from CRM.COM R10.1.0

payment_medium_identifierString

The payment medium identifier related with the retrieved payment preference

Available from CRM.COM R11.0.0

iban

String

The international bank account number

Available from CRM.COM R13.1.0

business_identifier_code

String

The business identifier code that identifies the bank

Available from CRM.COM R13.1.0

unique_mandate_reference

Number

The unique reference, which identifies a mandate that was signed by a Debtor for any given Creditor

Available from CRM.COM R13.1.0

mandate_signing_date

Date

The date that the mandate was signed

Available from CRM.COM R13.1.0

mandate_termination_dateDate

The date that the mandate will be terminated. No payments should be send after that date (inclusive)

Available from CRM.COM R13.1.0

payment_preference

Payment Preference Object

The payment preference of the retrieved payment preference

bank_account_type

Bank Account Type Object

The bank account type related with the retrieved payment preference

bank

Bank Object

The bank related with the retrieved payment preference

bank_branch

Bank Branch Object

The bank branch related with the retrieved payment preference

payment_medium_typePayment Medium Type

The payment medium type related with the retrieved payment preference

Available from CRM.COM R11.0.0

payment_medium_brandPayment Medium Brand

The payment medium brand related with the retrieved payment preference

Available from CRM.COM R11.0.0

default_cardPayment Gateway Card Objects

It defines the default payment gateway card that should be used while automatically creating payments against that specific accounts receivable. The default card is also set on payments done using the specific payment preference, although the user can modify this information, by selecting an additional card. 

cards_setSet Payment Gateway Card Objects

The set of all payment gateway cards which are related with the specific accounts receivable payment preference

  Referred Objects Response Data

 payment_preference object response data

Name

Type

Description

id

String

The id of the retrieved payment preference

name

String

The name of the retrieved payment preference

alternative_code

String

The alternative code of the retrieved payment preference

typeSting

The type of the payment preference, such as

  • DIRECT_DEBIT,
  • STRIPE_PAYMENT_GATEWAY,
  • PAYPAL_PAYMENT_GATEWAY,
  • BRAINTREE_PAYMENT_GATEWAY
  • GENERIC_PAYMENT_GATEWAY,
  • CUSTOM_PAYMENT_GATEWAY,
  • WALLET,
  • OTHER,
  • CUSTOM_1,
  • CUSTOM_2,
  • CUSTOM_3,
  • CUSTOM_4,
  • CUSTOM_5

BRAINTREE_PAYMENT_GATEWAY and CUSTOM_PAYMENT_GATEWAY are available from CRM.COM R14.2.0

WALLET available from CRM.COM R17.0.0

descriptionStingThe description of the retrieved payment preference

 

 bank_account_type object response data

Name

Type

Description

id

String

The id of the retrieved bank account type

name

String

The name of the retrieved bank account type

alternative_code

String

The alternative code of the retrieved bank account type

 

 bank object response data

Name

Type

Description

id

String

The id of the retrieved bank

name

String

The name of the retrieved bank

alternative_code

String

The alternative code of the retrieved bank

 

 bank_branch object response data

Name

Type

Description

id

String

The id of the retrieved bank branch

name

String

The name of the retrieved bank branch

alternative_code

String

The alternative code of the retrieved bank branch

 payment_medium_type object response data

Name

Type

Description

id

String

The id of the retrieved payment medium type

name

String

The name of the retrieved payment medium type

alternative_code

String

The alternative code of the retrieved payment medium type

descriptionString

The description  of the retrieved payment medium type

 

 payment_medium_brand object response data

Name

Type

Description

id

String

The id of the retrieved payment medium brand

name

String

The name of the retrieved payment medium brand

alternative_code

String

The alternative code of the retrieved payment medium brand

descriptionString

The description  of the retrieved payment medium brand

 

 payment gateway card object response data

Name

Type

Description

id

String

The id of the retrieved payment gateway card

payment_gateway_reference_number

String

The card's reference number as provided by the payment gateway. This number is used to submit transactions on the payment gateway that will be processed using that card

card_holder_name

String

The card holders name, as provided during the registration of the card
brandString

The card's brand, as provided by the payment gateway provider. The supported brands by the payment gateways are the following

  • Stripe: VISA, AMERICAN_EXPRESS, MASTER_CARD, DISCOVER, JCB, DINERS_CLUB, UNKNOWN
  • Braintree: VISA, AMERICAN_EXPRESS, MAESTRO, MASTER_CARD, DISCOVER, JCB, DINERS_CLUB
  • Payeezy: VISA, AMERICAN_EXPRESS, MASTER_CARD, DISCOVER
  • Swedbank: VISA, MAESTRO, MASTER_CARD
expiration_monthNumberThe card's expiration month, which can be from 1 to 12
expiration_yearNumberThe card's expiration year which is a 4 digits number
typeString

The type of the card, as provided by the payment gateway provider. The supported types by the payment gateway are the following:

  • Stripe: CREDIT, DEBIT, PREPAID, UNKNOWN
last_digitsStringThe last 4 digits of the card as provided by the payment gateway provider. Those digits are masked with 12 asterisk characters for example **** ***** ***** 4242
consumer_tokenStringThe consumer token

 payment_gateway_cards object response data

Name

Type

Description

default

Boolean

Indicates if the retrieved payment gateway card is the default for the related accounts receivable payment preference

card

Payment Gateway Card Object

The represented payment gateway card

  Referred Objects Response Data

 payment gateway card object response data

Name

Type

Description

id

String

The id of the retrieved payment gateway card

payment_gateway_reference_number

String

The card's reference number as provided by the payment gateway. This number is used to submit transactions on the payment gateway that will be processed using that card

card_holder_name

String

The card holders name, as provided during the registration of the card
brandString

The card's brand, as provided by the payment gateway provider. The supported brands by the payment gateways are the following

  • Stripe: VISA, AMERICAN_EXPRESS, MASTER_CARD, DISCOVER, JCB, DINERS_CLUB, UNKNOWN
  • Braintree: VISA, AMERICAN_EXPRESS, MAESTRO, MASTER_CARD, DISCOVER, JCB, DINERS_CLUB
  • Payeezy: VISA, AMERICAN_EXPRESS, MASTER_CARD, DISCOVER
  • Swedbank: VISA, MAESTRO, MASTER_CARD
expiration_monthNumberThe card's expiration month, which can be from 1 to 12
expiration_yearNumberThe card's expiration year which is a 4 digits number
typeString

The type of the card, as provided by the payment gateway provider. The supported types by the payment gateway are the following:

  • Stripe: CREDIT, DEBIT, PREPAID, UNKNOWN
last_digitsStringThe last 4 digits of the card as provided by the payment gateway provider. Those digits are masked with 12 asterisk characters for example **** ***** ***** 4242
consumer_tokenStringThe consumer token

 accounting period information object response data

Name

Type

Description

accounting_period_date

Date

The Date on which the Accounting Period was set on the financial transaction

 accounting_period

Accounting Period Object

The Accounting Period of the financial transaction.

Referred Objects Response Data

 accounting period object response data

Name

Type

Description

number

String

The Accounting Period's number

name

String

The Accounting Period's name

from_dateDateThe Accounting Period's from date
to_dateDateThe Accounting Period's to date
life_cycle_stateStingThe Accounting Period's life cycle state. Available values are OPEN and CLOSED
closed_dateDateThe Accounting Period's closed date. Available only for Accounting Periods in Closed life cycle state

 currency rate period object response data

Name

Type

Description

id

String

The ID of the retrieved currency rate period

rateNumberThe exchange rate of the currency rate period
inverse_rateNumberThe inverse exchange rate of the currency rate period
from_dateDateThe date from which the exchange rate is valid
to_dateDateThe date until which the exchange rate is valid
currencyCurrency ObjectThe Currency with which the returned exchange rate information refers to

Referred Objects Response Data

 currency object response data

Name

Type

Description

id

String

The ID of the retrieved currency

code

String

The code of the retrieved currency

prefix_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE

Available from CRM.COM R14.0.0

integer_part_nameStringThe integer part name for the specified currency
decimal_part_nameStringThe decimal part name for the specified currency

 invoice object response data

Name

Type

Description

id

String

The ID of the retrieved invoice

number

String

The number of the retrieved invoice

reference_number

String

The reference number of the retrieved invoice

life_cycle_state

String

The life cycle state of the invoice. One of the following values is returned:

DRAFT, REJECTED, POSTED, CANCELLED
issued_onDateThe date that the invoice was issued
posted_onDateThe date that the invoice was posted
due_onDateThe date that the credit period for that specific invoice is ending.
total_amountNumberThe total amount of the invoice
outstanding_amountNumberThe total outstanding amount of the invoice
unsettled_amountNumberThe total unsettled amount of the invoice
currency_rate_periodCurrency Rate Period object

The currency rate period based on which the invoice's amounts were calculated

Available from CRM.COM R10.0.0

Referred Objects Response Data

 currency rate period object response data

Name

Type

Description

id

String

The ID of the retrieved currency rate period

rateNumberThe exchange rate of the currency rate period
inverse_rateNumberThe inverse exchange rate of the currency rate period
from_dateDateThe date from which the exchange rate is valid
to_dateDateThe date until which the exchange rate is valid
currencyCurrency ObjectThe Currency with which the returned exchange rate information refers to

Referred Objects Response Data

 currency object response data

Name

Type

Description

id

String

The ID of the retrieved currency

code

String

The code of the retrieved currency

prefix_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE

Available from CRM.COM R14.0.0

integer_part_nameStringThe integer part name for the specified currency
decimal_part_nameStringThe decimal part name for the specified currency

 bill object response data

Name

Type

Description

id

String

The ID of the retrieved bill

number

String

The number of the retrieved bill

life_cycle_state

String

The life cycle state of the bill. One of the following values is returned:

POSTED, PRESENTED, PRESENTED_CONFIRMED, PRESENTED_REJECTED

from_dateDateThe date from which the accounts receivable is billed for
to_dateDateThe date until which the accounts receivable is billed for
due_dateDate

The due date of bill. The field is calculated dynamically. The maximum due date of related invoices.

Available from CRM.COM R12.4.0

total_billed_amountNumberThe total billed amount
total_amount_to_be_paidNumberThe total amount to be paid
bill_statusString

The status of the bill in terms of it is settled or not.The supported values are the following:

SETTLED, UNSETTLED, PARTIALLY_SETTLED

currencyCurrency object

The bill's currency

Available from CRM.COM R10.0.0

Referred Objects Response Data

 currency object response data

Name

Type

Description

id

String

The ID of the retrieved currency

code

String

The code of the retrieved currency

prefix_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE

Available from CRM.COM R14.0.0

integer_part_nameStringThe integer part name for the specified currency
decimal_part_nameStringThe decimal part name for the specified currency

 bill_paid object response data

Name

Type

Description

id

String

The ID of the retrieved bill

number

String

The number of the retrieved bill



 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_typeMeter Reading Type

The Meter Reading type related with the product type. This is applicable only for traceable physical goods

Available from CRM.COM R14.0.0

Referred Objects Response Data

 usage_detail_record_type object data response
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 global rate object response data

Name

Type

Description

id

String

The ID of the retrieved rate

rate_model

String

The price plan rate model which can be one of the following:

  • QUANTITYBASED
  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED
  • DURATIONBASED
  • FLATFEEBASED
  • USAGEBASED

From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

Available when the rate model is 'Quantity & Quantity Based' and it is a selection between

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

 payment cancellation object response data

Name

Type

Description

id

String

The ID of the retrieved payment cancellation

number

String

The number of the retrieved payment cancellation

reference_number

String

The reference number of the retrieved payment cancellation

life_cycle_state

String

The life cycle state of the payment cancellation. the only available value is POSTED.

issued_onDateThe date that the payment cancellation was issued
posted_onDateThe date that the payment cancellation was posted
payment_amountNumberThe total amount of the payment cancellation
processed_by_payment_gatewayString

The payment gateway that processed the payment cancellation

payment_gateway_reference_numberString

A reference to the number of the payment cancellation that was created on the payment gateway

 log_information object response data

Name

Type

Description

created_date

Date

The date that the retrieved record was created

updated_date

Date

The last date that the retrieved record was updated

created_by_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

created_by_business_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Available from CRM.COM R18.0.0

created_by_user

User Object

The user that created the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

updated_by_unit

Unit Object

The last unit that updated the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

updated_by_business_unit

Unit Object

The last unit that updated the retrieved record

Available from CRM.COM R18.0.0

updated_by_user

User Object

The last user that updated the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user


Examples

 Example 1

HTTP Method: POST


Request:

Body:

{
 "token":"35FA3612DEB94BF7A2FE2C9EC9EF406D",
  "payment_identifier":{"reference_number":"179"},
   "accounts_receivable_identifier":{"name":"Jessie01"},
   "category_identifier":{"name":"Payment Categories"},
    "received_on":"2015-03-02T09:12:54",
    "received_by_user_identifier":{"username":"mpadministrator"},
    "received_by_unit_identifier":{"name":"Admin Unit"},
    "back_office_code":"P000001",
    "notes":"Payment note",
   "udf_string_1":"udf string 1",
   "udf_string_2":"udf string 2",
   "udf_string_3":"udf string 3",
   "udf_string_4":"udf string 4",
   "udf_string_5":"udf string 5",
   "udf_string_6":"udf string 6",
   "udf_string_7":"udf string 7",
   "udf_string_8":"udf string 8",
   "udf_float_1":10,
   "udf_float_2":20,
   "udf_float_3":30,
   "udf_float_4":40,
   "udf_float_5":50,
   "udf_float_6":60,
   "udf_float_7":70,
   "udf_float_8":80,
   "udf_date_1":"2014-05-05T15:49:59",
   "udf_date_2":"2014-06-05T15:49:59",
   "udf_date_3":"2014-07-05T15:49:59",
   "udf_date_4":"2014-08-05T15:49:59",
     "bills_to_pay_set":
    [
       {
        "action":"add",
         "bill_identifier":{"number":"BL000128"}
       }
   ],
    "invoices_to_pay_set":
    [
       {
        "action":"add",
         "invoice_identifier":{"number":"I00000181"}
       }
   ]
}
   


Response:

{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "invoices_to_pay_set": [
      {
        "issued_on": "2014-08-06T13:12:19",
        "total_amount": 16.5,
        "life_cycle_state": "POSTED",
        "unsettled_amount": null,
        "number": "I00000181",
        "due_on": "2014-08-05T00:00:00",
        "id": "3F8C3DE40431951F714C8162DBBA90BE",
        "reference_number": "181",
        "outstanding_amount": null,
        "posted_on": "2014-08-06T13:12:51"
      }
    ],
    "notes": "Panayiota Demou\t19/2/2015 11:48:47\tTest\tMarios Lannister\t4/5/2016 13:13:20\tPayment note\tMarios Lannister\t4/5/2016 13:20:34\tPayment note\tMarios Lannister\t4/5/2016 13:22:31\tPayment note\tMarios Lannister\t4/5/2016 13:24:53\tPayment note\tMarios Lannister\t4/5/2016 13:27:44\tPayment note\tMarios Lannister\t4/5/2016 13:30:03\tPayment note\tMarios Lannister\t4/5/2016 13:36:02\tPayment note\tMarios Lannister\t4/5/2016 13:36:50\tPayment note\tMarios Lannister\t4/5/2016 13:40:22\tPayment note\tMarios Lannister\t4/5/2016 13:40:43\tPayment note",
    "udf_float_1": 10,
    "udf_float_2": 20,
    "udf_float_3": 30,
    "number": null,
    "udf_float_4": 40,
    "udf_string_1": "udf string 1",
    "udf_string_2": "udf string 2",
    "udf_string_3": "udf string 3",
    "received_by_unit": {
      "community_name": "Internal Community",
      "id": "48305F8849E3C18B227C5BE3A27BA6DF",
      "name": "Admin Unit",
      "group_name": "Main Group",
      "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
      "alternative_code": "MG"
    },
    "udf_string_4": "udf string 4",
    "udf_string_5": "udf string 5",
    "card": null,
    "udf_string_6": "udf string 6",
    "udf_string_7": "udf string 7",
    "udf_string_8": "udf string 8",
    "received_by_user": {
      "person_name": "Marios Lannister",
      "username": "MPAdministrator",
      "id": "1",
      "email": "sakkascy1986@hotmail.com"
    },
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Pickman",
        "middle_name": "Li",
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": "Mr",
        "first_name": "Jessie",
        "type": "PERSON",
        "id": "F9A629E466B1EF473CECD46F2A4D63F3",
        "name": null,
        "company_name": null,
        "demographics": {
          "gender": "MALE",
          "passport_issued_by_country": {
            "three_character_code": "USA",
            "two_character_code": "US",
            "id": "127",
            "name": "UNITED STATES",
            "alternative_code": null
          },
          "social_security_number": "434567",
          "passport_number": "54567432",
          "country_of_residence": {
            "three_character_code": "USA",
            "two_character_code": "US",
            "id": "127",
            "name": "UNITED STATES",
            "alternative_code": null
          },
          "name_day": {
            "month": 4,
            "day": 2
          },
          "date_of_birth": {
            "month": 11,
            "day": 1,
            "year": 1988
          },
          "id_number": "983452",
          "id_issued_by_country": {
            "three_character_code": "USA",
            "two_character_code": "US",
            "id": "127",
            "name": "UNITED STATES",
            "alternative_code": null
          }
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "170",
      "id": "903B55B02EAC74FE25E12F8786D44011",
      "name": "Jessie01"
    },
    "bills_to_pay_set": [
      {
        "total_amount_to_be_paid": 40.000000000000014,
        "to_date": null,
        "from_date": null,
        "life_cycle_state": "POSTED",
        "total_billed_amount": 40,
        "number": "BL000128",
        "bill_status": null,
        "id": "C4442CB68A6C45D2B977D13C3FDFA434"
      }
    ],
    "id": "FD0553CC902A7C57D6CAC9393754E346",
    "posted_on": null,
    "udf_date_1": "2014-05-05T15:49:59",
    "udf_date_2": "2014-06-05T15:49:59",
    "udf_date_3": "2014-07-05T15:49:59",
    "udf_date_4": "2014-08-05T15:49:59",
    "log_information": {
      "updated_date": "2016-05-04T10:40:46",
      "created_date": "2014-10-07T15:51:26",
      "created_by_unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "updated_by_unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "created_by_user": {
        "person_name": "persia_xenopoulou",
        "username": "persia_xenopoulou",
        "id": "2A15084589E81D3DA7ABA3C7563F805E",
        "email": "p_xenopoulou@crm.com"
      },
      "updated_by_user": {
        "person_name": "Marios Lannister",
        "username": "MPAdministrator",
        "id": "1"
      }
    },
    "payment_amount": 150,
    "issued_on": "2014-10-07T15:51:26",
    "life_cycle_state": "DRAFT",
    "back_office_code": "P000001",
    "rejection_reason": null,
    "payment_method": {
      "id": "075CC59CC7EBCD818C6311E596615337",
      "name": "Cash",
      "description": "Cash",
      "alternative_code": "C"
    },
    "type": {
      "classification": "PAYMENT",
      "id": "84C4E6996B0DC91307D0D9DBBE7D325E",
      "name": "Payment 1",
      "description": "Payment 1",
      "alternative_code": "P1"
    },
    "received_on": "2015-03-02T09:12:54",
    "reference_number": "179",
    "category": {
      "id": "6BFF031A540EB9337C70022247C7A19B",
      "name": "Payment Categories",
      "description": "Payment Categories",
      "code": "PC"
    }
  }
}
 Example 2

HTTP Method: POST


Request:

Body:

{
    "token":{{token}},
    "payment_identifier": {
    	"id": "E69CA1CA4799432EAD605E1EEF562ACD"
    },
    "description": "Updated - Payment for Bill 1196 with 5 EUR cash"
}


Response:

{
    "data": {
        "payment_preference": null,
        "notes": "CRM COM\t15/9/2017 11:39:31\tPay with cash",
        "received_by_user": {
            "person_name": "CRM COM",
            "id": "1",
            "email": "dev@crm.com",
            "username": "MPAdministrator"
        },
        "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": "2017-09-15T11:39:31",
            "updated_date": "2017-09-15T11:39:46",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "dev@crm.com",
                "username": "MPAdministrator"
            }
        },
        "voucher": null,
        "currency_rate_period": null,
        "udf_date_2": null,
        "type": {
            "alternative_code": "P_1",
            "name": "Cash Payment",
            "description": null,
            "id": "6BAC034AD61A4C4FACFDA400DABE4106",
            "classification": "PAYMENT"
        },
        "udf_date_1": null,
        "udf_date_4": null,
        "udf_date_3": null,
        "number": null,
        "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": "2017-09-15T09:20:00",
        "id": "E69CA1CA4799432EAD605E1EEF562ACD",
        "udf_float_1": null,
        "udf_float_2": null,
        "payment_method": {
            "alternative_code": "CP",
            "name": "Cash Payment",
            "description": null,
            "id": "DCC326C50FB9434780FC0039A06DEF1C"
        },
        "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": [
            {
                "number": "1196",
                "from_date": "2018-11-01T00:00:00",
                "to_date": "2018-12-01T00:00:00",
                "currency": {
                    "suffix_symbol": null,
                    "prefix_symbol": "€",
                    "decimal_part_name": null,
                    "code": "EUR",
                    "integer_part_name": null,
                    "id": "2",
                    "life_cycle_state": "EFFECTIVE"
                },
                "id": "CFA820D298554488B335879815336720",
                "life_cycle_state": "POSTED",
                "total_billed_amount": 45.11,
                "total_amount_to_be_paid": 94.01,
                "bill_status": null
            }
        ],
        "payment_amount": 5,
        "accounts_receivable": {
            "number": "ACR0000012531",
            "name": "ACR0000012531 Marios Maurou",
            "id": "B76B18263F05490FBFDF182366AD4346",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
                "company_profile": null,
                "company_name": null,
                "name": null,
                "last_name": "Maurou",
                "id": "5E2D89776AE04081B01DA48CC098800F",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Marios",
                "demographics": {
                    "name_day": {
                        "month": null,
                        "day": null
                    },
                    "id_number": "234234234",
                    "gender": 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": "DRAFT",
        "reference_number": "4882",
        "posted_on": null,
        "issued_on": "2017-09-15T11:39:31",
        "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": ""
    }
}
 
 Example 3

HTTP Method: POST


Request:

Body:

{
"token":{{token}},
    "payment_identifier": {
        "reference_number": "637"
    },
   "products_to_pay_set": [
        {
           "action":"REMOVE",
            "product_identifier": {
                "code" : "MTV"
            }
},
        {
           "action":"ADD",
            "product_identifier": {
                "code" : "Movies 1"
            }
        }
    ]
}


Response:

    {
        "data":
        {
            "payment_preference": null,
            "notes": null,
            "received_by_user":
            {
                "person_name": "MPAdministrator",
                "id": "1",
                "email": null,
                "username": "MPAdministrator"
            },
            "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": "2017-09-18T16:52:43",
                "updated_date": "2017-09-19T08:33:58",
                "updated_by_user":
                {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": null,
                    "username": "MPAdministrator"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "id": "1",
                    "email": null,
                    "username": "MPAdministrator"
                }
            },
            "currency_rate_period": null,
            "udf_date_2": null,
            "type":
            {
                "alternative_code": "VP",
                "name": "Voucher Payment ",
                "description": null,
                "id": "67D4BED1D74309E14A5BC1707101C879",
                "classification": "PAYMENT"
            },
            "udf_date_1": null,
            "udf_date_4": null,
            "udf_date_3": null,
            "number": null,
            "products_to_pay_set":
            [
                {
                    "product":
                    {
                        "code": "Movies 1",
                        "product_type":
                        {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "AS",
                            "composition_method": "FLAT",
                            "name": "Additional Services",
                            "description": null,
                            "id": "C8321F0BCA8A4051857BC35CEEE41555",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "M1",
                        "description": "Movies 1",
                        "id": "571C10876AF840088372A94A14D0A02C",
                        "priority_level": null
                    }
                },
                {
                    "product":
                    {
                        "code": "Gold",
                        "product_type":
                        {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "Main Packages",
                            "composition_method": "FLAT",
                            "name": "Main Packages",
                            "description": null,
                            "id": "E186E293AAAB49EE86A729540A4287FE",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "G",
                        "description": "Gold",
                        "id": "D1EB074DFD904E54A0C67CAB9DC7E010",
                        "priority_level": null
                    }
                },
                {
                    "product":
                    {
                        "code": "Sports 1",
                        "product_type":
                        {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "AS",
                            "composition_method": "FLAT",
                            "name": "Additional Services",
                            "description": null,
                            "id": "C8321F0BCA8A4051857BC35CEEE41555",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "S1",
                        "description": "Sports 1",
                        "id": "02191FFC231D4FBD844D0BB66EBAB14B",
                        "priority_level": null
                    }
                }
            ],
            "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": "2017-09-18T16:52:43",
            "id": "2EEF4FB5337144B5AC39768F421BE343",
            "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": 2500,
            "accounts_receivable":
            {
                "number": "ACR0000001146",
                "name": "ACR0000001146 Test 7925_1",
                "id": "5FBEBF28DC54450785EC0ABE68966176",
                "life_cycle_state": "ACTIVE",
                "account_owner":
                {
                    "company_profile": null,
                    "company_name": null,
                    "name": null,
                    "last_name": "7925_1",
                    "id": "9516A184F5F84EBB8FB7E9464A566A67",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Test",
                    "demographics":
                    {
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": "7925_1",
                        "gender": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "year": null,
                            "day": null
                        },
                        "industry_sector": null,
                        "passport_number": null,
                        "industry": null,
                        "social_security_number": "7925_1",
                        "id_issued_by_country": null,
                        "passport_issued_by_country": null
                    }
                }
            },
            "life_cycle_state": "DRAFT",
            "reference_number": "637",
            "posted_on": null,
            "issued_on": "2017-09-18T16:52:43",
            "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": ""
        }
    }
  • No labels