| Table of Contents | ||
|---|---|---|
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| invoice_identifier (mandatory) | Invoice identifier | The identifier of the invoice that should be returned as a result. The allowed invoice 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 invoice 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 invoice 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 invoice that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||
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
| ||||||
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 invoice 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 invoice. The allowed financial transaction type identifier field are the following:
| ||||||||
life_cycle_state (mandatory) | String | The state of the retrieved invoice which can be one of the following: DRAFT, POSTED | ||||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the invoice that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||||
member_accounts_receivable_identifier (optional) | Accounts Receivable Identifier | The member accounts receivable. Applicable only if the Invoice is issued against a parent accounts receivable within a group which funds its members. The allowed accounts receivable identifier fields are the following:
| ||||||||
due_on (optional) | Date | The date that the credit period for that specific invoice is ending. | ||||||||
intended_currency_identifier (optional) | Currency Identifier | The currency that the user was intended to use for the invoice. If specified then it is validated against the currency of the specified accounts receivable and if they don't match then an error is thrown. 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:
| ||||||||
notes (optional) | String | Shared notes for the invoice | ||||||||
back_office_code (optional) | String | A back office code for the invoice. If specified then it should be unique
| ||||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||||
(mandatory) | Set of invoice item objects | The items of the invoice | ||||||||
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 | ||||||
| invoice_identifier (mandatory) | Invoice identifier | The identifier of the invoice that should be returned as a result. The allowed invoice 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 | ||||||
| invoice_identifier (mandatory) | Invoice identifier | The identifier of the invoice that should be rejected. The allowed invoice identifier fields are the following:
| ||||||
| rejection_reason_identifier | Rejection reason identifier | The reason that the invoice is rejected. The allowed rejection reason 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 | ||||||
| invoice_identifier (mandatory) | Invoice identifier | The identifier of the invoice that should be cancelled. The allowed invoice identifier fields are the following:
| ||||||
type_identifier (mandatory) | Financial transaction type identifier | The financial transaction type of the invoice cancellation. The allowed financial transaction type identifier field are the following:
| ||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the invoice cancellation. The allowed financial transaction category identifier fields are the following:
| ||||||
notes (optional) | String | Shared notes for the invoice cancellation | ||||||
back_office_code (optional) | String | A back office code for the invoice cancellation. If specified then it should be unique
| ||||||
issue_reason (optional) | String | A description of the reason that the invoice cancellation is issued | ||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||
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 | ||||||||
| invoice_identifier (mandatory) | Invoice identifier | The identifier of the invoice that should be updated. Only invoices in draft state can be specified.The allowed invoice identifier fields are the following:
| ||||||||
accounts_receivable_identifier (optional) | Accounts receivable identifier | The identifier of the invoice's updated accounts receivable. The allowed accounts receivable identifier fields are the following:
| ||||||||
type_identifier (optional) | Financial Transaction Type identifier | The identifier of the invoice's updated type. Only Financial transaction Types with classification Invoice are allowed to be specified. The allowed financial transaction type identifier fields are the following:
| ||||||||
category_identifier (optional) | Financial Transaction Category identifier | The identifier of the invoice's updated category. The allowed financial transaction category identifier fields are the following:
| ||||||||
member_accounts_receivable_identifier (optional) | Accounts receivable identifier | The member accounts receivable. Applicable only if the invoice is issues against a parent accounts receivable which fund its member accounts. The allowed accounts receivable identifier fields are the following:
| ||||||||
due_on (optional) | Date | The Date on which the Invoice will be due on. | ||||||||
intended_currency_identifier (optional) | Currency Identifier | The currency that the user was intended to use for the invoice. 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:
| ||||||||
notes (optional) | String | Shared notes for the invoice | ||||||||
back_office_code (optional) | String | The back office code of the invoice
| ||||||||
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 | ||||||||
| invoice_item_set | Set of Invoice Item objects | The information related to the items of the invoice to be updated
| ||||||||
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 | ||||||
| invoice_identifier (mandatory) | Invoice identifier | The identifier of the invoice that should be written off. Only Invoices in Posted life cycle state are allowed to be specified and only as long as they are not paid. The allowed invoice identifier fields are the following:
| ||||||
type_identifier (mandatory) | Financial transaction type identifier | The financial transaction type of the Write Off. The allowed financial transaction type identifier fields are the following:
| ||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the Write Off. The allowed financial transaction category identifier fields are the following:
| ||||||
notes (optional) | String | Shared notes for the Write off | ||||||
back_office_code (optional) | String | A back office code for the Write off. If specified then it should be unique
| ||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||
| fields_set (optional) | Lis 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 |
...