| Table of Contents | ||
|---|---|---|
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| credit_note_identifier (mandatory) | Credit note identifier | The identifier of the credit not that should be returned as a result. The allowed credit note identifier fields are the following:
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| accounts_receivable_identifier (mandatory) | Accounts receivable identifier | The identifier of the accounts receivable in which the credit note that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:
| ||||||
type_identifier (optional) | Financial transaction type identifier | The financial transaction type of the credit note that should be returned as a result. The allowed financial transaction type identifier field are the following:
| ||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the credit note that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
| accounts_receivable_identifier (mandatory) | Accounts receivable identifier | The identifier of the accounts receivable in which the credit note should be allocated to. The allowed accounts receivable identifier fields are the following:
| ||||||||
type_identifier (mandatory) | Financial transaction type identifier | The financial transaction type of the credit note. The allowed financial transaction type identifier field are the following:
| ||||||||
life_cycle_state (mandatory) | String | The state of the retrieved credit note which can be one of the following: DRAFT, POSTED | ||||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the credit note that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||||
notes (optional) | String | Shared notes for the credit note | ||||||||
back_office_code (optional) | String | A back office code for the credit note. If specified then it should be unique
| ||||||||
issue_reason (optional) | String | A description of the reason that the credit note is issued | ||||||||
intended_currency_identifier (optional) | Currency Identifier | The currency that the user was intended to use for the credit note. 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:
| ||||||||
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 | ||||||||
(optional) | Set of invoice objects | The invoices that are intended to be credited | ||||||||
(mandatory) | Set of credit item objects | The items of the credit not | ||||||||
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 | ||||||
| credit_note_identifier (mandatory) | Credit note identifier | The identifier of the credit note that should be posted. Only credit notes in draft state can be specified.The allowed credit note identifier fields are the following:
| ||||||
fields_set | 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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| credit_note_identifier (mandatory) | Credit note identifier | The identifier of the credit note that should be posted. Only credit notes in draft state can be specified.The allowed credit note identifier fields are the following:
| ||||||
| rejection_reason_identifier | Rejection reason identifier | The reason that the credit note is rejected. The allowed rejection reason identifier fields are the following:
| ||||||
fields_set | 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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
credit_note_identifier (mandatory) | Credit Note identifier | The identifier of the credit note that should be updated. Only credit notes in draft state can be specified.The allowed credit note identifier fields are the following:
| ||||||||
| accounts_receivable_identifier (optional) | Accounts receivable identifier | The identifier of the accounts receivable in which the credit note should be allocated to. The allowed accounts receivable identifier fields are the following:
| ||||||||
type_identifier (optional) | Financial transaction type identifier | The financial transaction type of the credit note. Only financial transaction types with classification Credit Note can be specified. The allowed financial transaction type identifier field are the following:
| ||||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the credit note that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||||
notes (optional) | String | Shared notes for the credit note | ||||||||
back_office_code (optional) | String | A back office code for the credit note. If specified then it should be unique
| ||||||||
issue_reason (optional) | String | A description of the reason that the credit note is issued | ||||||||
intended_currency_identifier (optional) | Currency Identifier | The currency that the user was intended to use for the credit note. 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:
| ||||||||
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 | ||||||||
(optional) | Set of invoice objects | The invoices that are intended to be credited
| ||||||||
(optional) | Set of credit item objects | The items of the credit note
| ||||||||
fields_set | 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 |
Anchor credit note update referred parameters credit note update referred parameters
Referred Parameter Objects
| credit note update referred parameters | |
| credit note update referred parameters |
...