Versions Compared

Old Version 175

changes.mady.by.user Joseph Ioannou (Unlicensed)

Saved on

compared with

New Version 176

changes.mady.by.user Former user

Saved on

Key

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

Table of Contents
maxLevel2

...

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 that should be returned as a result. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_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

subscription_identifier

(semi-optional)

Subscriptions identifier

The identifier of the subscription related with the accounts that will be returned as results. The allowed subscription identifier fields are the following:

Include Page
V4:subscription_identifier
V4:subscription_identifier

contact_information_identifier

(semi-optional)

Contact information identifier

The identifier of the contact information related with the accounts that will be returned as results. The allowed contact information identifier fields are the following:

Include Page
V4:contact_information_identifier
V4:contact_information_identifier

payment_preference_identifier

(semi-optional)

Payment preference identifier

The identifier of the payment preference related with the accounts that will be returned as results. The allowed payment preference identifier fields are the following:

Include Page
V4:payment_preference_identifier
V4:payment_preference_identifier

presentment_preference_identifier

(semi-optional)

Presentment preference identifier

The identifier of the presentment preference related with the accounts that will be returned as results. The allowed presentment preference identifier fields are the following:

Include Page
V4:presentment_preference_identifier
V4:presentment_preference_identifier

wallet_identifier

(semi-optional)

Wallet identifier  

The identifier of the wallet elated with the accounts that should be returned as a result. The allowed wallet identifier fields are the following:

Include Page
V4:wallet_identifier
V4:wallet_identifier

Tip

Available from CRM.COM R10.0.0

email_address

(semi-optional)

String

The email address of the contact information owning the accounts that should be returned as a result.

Tip

Available from CRM.COM R13.0.0

phone_number

(semi-optional)

String

The phone number of the contact information owning the accounts that should be returned as a result.

Tip

Available from CRM.COM R13.0.0

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip

Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Tip

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

...

Name

Type

Description

token

String

The token retrieved from the login method

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

...

POST accounts_receivable/show

Tip

Available from CRM.COM R8.0.0

This method returns information related with an accounts receivable. This method is similar to the GET method, but it supports identifying the accounts receivable that will be retrieved using an access token.  Single accounts receivable is 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 that should be returned as a result. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

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

name

(mandatory)

String

The name of the account receivable

description

(optional)

StringThe description of the retrieved accounts receivable

notes

(optional)

StringThe notes of the retrieved accounts receivable

vat_number

(optional)

String

The VAT number of the retrieved accounts receivable

credit_limit

(optional)

Number

Is the maximum amount of credit that can be provided to the specific accounts receivable, or in other words the maximum balance that the accounts receivable can ever reach.

Tip

Deprecated from CRM.COM R11.0.0

credit_period_operator 

(optional)

String

The credit period operator. The supported values are the following:

PLUS,MINUS

credit_period

(optional)

NumberCredit period is the length of time for which a customer is allowed to settle any given debit

classification_identifier

(optional)

Accounts Receivable Classification Identifier

 The accounts receivable classification identifier. The allowed classification identifier fields are the following:

Include Page
V4:accounts_receivable_classification_identifier
V4:accounts_receivable_classification_identifier

credit_rating_code

(optional)

String

The code of  the credit rating. The supported codes are the following:

AAA, AA, A, BAA, BA, B, CAA, CA, C

 

owned_by_group_identifier

(optional)

Group identifier

The group owning the accounts receivable. The allowed group identifier fields are the following:

Include Page
V4:group_identifier
V4:group_identifier

privacy_level_identifier

(optional)

Privacy level identifier

The privacy level of the accounts receivable. The allowed privacy level identifier fields are the following:

Include Page
V4:privacy_level_identifier
V4:privacy_level_identifier

currency_identifier

(optional)

 

Currency identifier

The accounts receivable currency. If not specified, then CRM.COM's default currency is defined as the accounts receivable currency. The allowed currency identifier fields are the following:

Include Page
V4:currency_identifier
V4:currency_identifier

Tip

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

contact_information

(mandatory)

Contact information objectThe contact information of the accounts receivable owner.

billing_address

(mandatory)

Billing address object

 The accounts receivable billing address.

presentment_preferences_set 

(optional)

Set of Presentment Preferences Object            

The presentment preferences of the retrieved accounts receivable

payment_preferences_set

(optional)

Set of Payment Preferences Object      

The payment preferences of the retrieved accounts receivable

access_tokens_set

(mandatory on conditions)

Set of Access Token Objects

The access tokens that will be associated with the accounts receivable. This information is mandatory if the active access token definition is set up to require at least one access token for each accounts receivable

Tip

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

Tip

Available from CRM.COM R10.0.0

Anchor
accounts_receivable_create referred objects parameters
accounts_receivable_create referred objects parameters
Referred Parameter Objects Data

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Account Receivable Identifier

The identifier of the account receivable to be updated. The allowed account receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

name

(optional)

String

The name of the account receivable

description

(optional)

StringThe description of the retrieved accounts receivable

notes

(optional)

StringThe notes of the retrieved accounts receivable

vat_number

(optional)

String

The VAT number of the retrieved accounts receivable

credit_limit

(optional)

Number

Is the maximum amount of credit that can be provided to the specific accounts receivable, or in other words the maximum balance that the accounts receivable can ever reach.

Tip

Deprecated from CRM.COM R11.0.0

credit_period 

(optional)

NumberCredit period is the length of time for which a customer is allowed to settle any given debit

classification_identifier

(optional)		Accounts Receivable Classification Identifier

 The accounts receivable classification identifier. The allowed classification identifier fields are the following:

Include Page
V4:accounts_receivable_classification_identifier
V4:accounts_receivable_classification_identifier

credit_rating_identifier

(optional)

Credit rating identifier

 The accounts receivable credit rating identifier. The allowed credit rating identifier fields are the following:

Include Page
V4:credit_rating_identifier
V4:credit_rating_identifier

owned_by_group_identifier

(optional)

Group identifier

The group owning the accounts receivable. The allowed group identifier fields are the following:

Include Page
V4:group_identifier
V4:group_identifier

privacy_level_identifier

(optional)

Privacy level identifier

The privacy level of the accounts receivable. The allowed privacy level identifier fields are the following:

Include Page
V4:privacy_level_identifier
V4:privacy_level_identifier

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

billing_address

(mandatory)

Billing address object

 The accounts receivable billing address.

presentment_preferences_set 

(optional)

Set of accounts receivable presentment preferences objects           

The presentment preferences of the retrieved accounts receivable.

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

payment_preferences_set

(optional)

Set of accounts receivable payment preferences objects

The payment preferences of the retrieved accounts receivable

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

access_tokens_set

(mandatory on conditions)

Set of Access Token Objects

The access tokens that will be associated with the accounts receivable. This information is mandatory if the active access token definition is set up to require at least one access token for each accounts receivable

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

Code Block
themeConfluence
languagejavascript
linenumberstrue
"set": [
	   		{
            	"action": "add_existing",
            	...........
        	},
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add_new",
            	...........
			}
		]
Tip

Available from CRM.COM R8.0.0

Anchor
accounts_receivable_update referred objects parameters
accounts_receivable_update referred objects parameters
Referred Parameter Objects Data

...

POST accounts_receivable/change_credit_limit

Tip

Available from CRM.COM R11.0.0

This method changes the credit terms of accounts receivable i.e. either its credit limit or the credit rating or both. A single accounts receivable's credit terms can be updated by each call.

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Account Receivable Identifier

The identifier of the account receivable whose credit terms will be updated. The allowed account receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

credit_limit

(semi-optional)

Number

The new credit limit of the accounts receivable

credit_rating_code

(semi-optional)

String

The new credit rating's code of the accoutns receivable. The supported codes are the following:

AAA, AA, A, BAA, BA, B, CAA, CA, C

fields_set

(optional)

List of Strings, comma separatedA list of fields that should be included in the results. If not specified then all the available fields will be returned

...

GET accounts_receivable/write_off_account/show

Tip

Available from CRM.COM R13.0.0

This method returns information related with the system account which is specified as the write off account

...

Name

Type

Description

token

String

The token retrieved from the login method

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

...

GET accounts_receivable/assets/list

Tip

Available from CRM.COM R10.0.0

This method returns the physical goods assets that were purchased by the specified customer. Multiple assets are retrieved by this 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 that should be returned as a result. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_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

...

POST accounts_receivable/assets/return

Tip

Available from CRM.COM R11.5.0 and CRM.COM R12.1.0

This method is used when an Accounts Receivable Asset is returned back by a customer. Multiple assets can be returned through each call. The method returns a list of all of the accounts receivable assets which were successfully returned.

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Account receivable Identifier

The identifier of the account receivable that owns the asses to be returned. The allowed account receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

accounts_receivable_assets_set

(mandatory)

Set of Accounts Receivable AssetsA set of accounts receivable assets which will be returned by this call. All specified assets should be owned by the specified accounts receivable

fields_set

(optional)

List of Strings, comma separatedA list of fields that should be included in the results. If not specified then all the available fields will be returned

...

POST accounts_receivable/assets/transfer_ownership

Tip

Available from CRM.COM R13.0.0

This method is used when an Accounts Receivable Asset is moved from one Accounts Receivable to another because of a transfer of ownership. Multiple assets can be moved through each call but only as long as they are transferred to the same account owner. The method returns a list of all of the accounts receivable assets which were successfully transferred to another accounts receivable.

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Account receivable Identifier

The identifier of the account receivable that owns the assets whose ownership will be transferred to another accounts receivable. The allowed account receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

transfer_to_accounts_receivable_identifier

(mandatory)

Account receivable Identifier

The identifier of the account receivable to which the ownership of the assets will be transferred to. The allowed account receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

accounts_receivable_assets_set

(mandatory)

Set of Accounts Receivable AssetsA set of accounts receivable assets which will be transferred to another accounts receivable by this call. All specified assets should be owned by the specified accounts receivable

fields_set

(optional)

List of Strings, comma separatedA list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Include Page
V4:accounts_receivable_asset_history_complete
V4:accounts_receivable_asset_history_complete

GET accounts_receivable/vouchers/list

Tip

Available from CRM.COM R14.0.0

This method returns the Activated vouchers (used or not) that were assigned to the specified Accounts Receivable. Multiple vouchers are retrieved by this call.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

Accounts Receivable Identifier  

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

...

Examples

Expand
titleExample 1

HTTP Method: POST

{{server}}/crmapi/rest/v2/accounts_receivable/assets/transfer_ownership

Request:

Response:

Code Block
{
    "data": [
        {
            "ownership_transferred_to": {
                "number": "ACR0000012152",
                "name": "ACR0000012152",
                "id": "5F83167A0F1745E7821590B95365B694",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": null,
                    "company_name": null,
                    "name": null,
                    "last_name": "7002_1_6_1",
                    "id": "2979BB173D1D496AABA16ACEC63D4538",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Test",
                    "demographics": {
                        "name_day": {
                            "month": null,
                            "day": null
                        },
                        "id_number": null,
                        "gender": null,
                        "country_of_residence": {
                            "alternative_code": "CYP",
                            "three_character_code": "CYP",
                            "name": "CYPRUS",
                            "id": "181",
                            "two_character_code": "CY"
                        },
                        "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
                    }
                }
            },
            "product": {
                "code": "Decoder",
                "product_type": {
                    "service_type": null,
                    "used_for_provisioning": true,
                    "alternative_code": "D",
                    "composition_method": "FLAT",
                    "name": "Decoder",
                    "description": null,
                    "id": "719BA4754DDD44B394F02E87F8247369",
                    "classification": "PHYSICALGOODS",
                    "physical_good_type": "TRACEABLE"
                },
                "alternative_code": "D",
                "description": "a",
                "id": "B9ED693B156A4F2B97FFA2184DA56E66"
            },
            "performed_date": "2017-06-29T19:45:46",
            "performed_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "dev@crm.com",
                "username": "MPAdministrator"
            },
            "transferred_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "dev@crm.com",
                "username": "MPAdministrator"
            },
            "stock_in_warehouse_transaction": null,
            "ownership_transferred_from": {
                "number": "ACR0000001036",
                "name": "ACR0000001036",
                "id": "17EAD08FF1C74028B0CA7210B83F3336",
                "life_cycle_state": "ACTIVE"
            },
            "accounts_receivable": {
                "number": "ACR0000012093",
                "name": "ACR0000012093",
                "id": "03DA4190DB6E42F08E1A372197B0D90C",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": null,
                    "company_name": null,
                    "name": null,
                    "last_name": "Ioannou1",
                    "id": "D9FE4C817BE24DBBB7FCE1B56A698696",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Marios",
                    "demographics": {
                        "name_day": {
                            "month": null,
                            "day": null
                        },
                        "id_number": null,
                        "gender": null,
                        "country_of_residence": {
                            "alternative_code": "CYP",
                            "three_character_code": "CYP",
                            "name": "CYPRUS",
                            "id": "181",
                            "two_character_code": "CY"
                        },
                        "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
                    }
                }
            },
            "transfer_date": "2017-06-29T20:01:12",
            "credit_note": null,
            "installed_item": {
                "product": {
                    "code": "Decoder",
                    "product_type": {
                        "service_type": null,
                        "used_for_provisioning": true,
                        "alternative_code": "D",
                        "composition_method": "FLAT",
                        "name": "Decoder",
                        "description": null,
                        "id": "719BA4754DDD44B394F02E87F8247369",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "TRACEABLE"
                    },
                    "alternative_code": "D",
                    "description": "a",
                    "id": "B9ED693B156A4F2B97FFA2184DA56E66"
                },
                "alternative_code": "1323232321",
                "serial_number": "pk_decod31",
                "id": "2487BFB93E4C410BBFC44C026C5ACDF7",
                "state": "EFFECTIVE"
            },
            "sales_method": "DIRECT_SALE",
            "returned_by_user": null,
            "id": "1C0CB562B0F2428F84419367F4E7C922",
            "invoice": null,
            "job": {
                "number": "J00001000",
                "description": null,
                "rating_state": "COMPLETED",
                "accounts_receivable": {
                    "number": "ACR0000012245",
                    "name": "ACR0000012245",
                    "id": "9B8C4D865CA640FFB1E0FDC47E4EC973",
                    "life_cycle_state": "ACTIVE"
                },
                "id": "35F67FB92D384B8FB2858E866D674B96",
                "life_cycle_state": "COMPLETED",
                "type": {
                    "billing_method": "BILL_ON_STARTING_PROGRESS",
                    "alternative_code": "BOOG",
                    "name": "Based On Ordered GP (PK)",
                    "fulfillment_scope": "GENERIC_PURPOSE",
                    "description": null,
                    "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
                    "id": "E07903E59A514603B351E18A8B13B2EB",
                    "billing_directive": "BILLABLE"
                }
            },
            "stock_out_warehouse_transaction": null,
            "return_date": null
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

GET accounts_receivable/vouchers/list

Tip

Available from CRM.COM R14.0.0

This method returns the Activated vouchers (used or not) that were assigned to the specified Accounts Receivable. Multiple vouchers are retrieved by this call.

Resource URL

Parameters

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 that should be returned as a result. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

applicable_for_use

(optional)

Boolean

Determines if the retrieved results will be consisted by Activated vouchers that belong to that Account Receivable account and are available to be used or not

The following options are available

  • True - Will return only Activated Vouchers that are ready to be used and belong to that Account Receivable account
  • False - Will return only the vouchers that were used against the specified Account Receivable account
  • Not Specified - Will return all above vouchers

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

offset

(optional)

NumberDefines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

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

...

Include Page
V4:accounts_receivable_vouchers_list_short
V4:accounts_receivable_vouchers_list_short

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

 

 

Activated

{{server}}/crmapi/rest/v2/accounts_receivable/assets/transfer_ownership