| Table of Contents | ||
|---|---|---|
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| payment_identifier (mandatory) | Payment identifier | The identifier of the payment that should be returned as a result. The allowed payment identifier fields are the following:
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| accounts_receivable_identifier (mandatory) | Accounts receivable identifier | The identifier of the accounts receivable in which the payments that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:
| ||||||
type_identifier (optional) | Financial transaction type identifier | The financial transaction type of the payment that should be returned as a result. The allowed financial transaction type identifier field are the following:
| ||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||
payment_method_identifier (optional) | Payment method identifier | The payment method of the payment that should be returned as a result. The allowed payment method identifier fields are the following:
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| accounts_receivable_identifier (mandatory) | Accounts receivable identifier | The identifier of the accounts receivable in which the payments that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:
| ||||||
type_identifier (optional) | Financial transaction type identifier | The financial transaction type of the payment that should be returned as a result. The allowed financial transaction type identifier field are the following:
| ||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||
payment_method_identifier (optional) | Payment method identifier | The payment method of the payment that should be returned as a result. The allowed payment method identifier fields are the following:
| ||||||
number (mandatory) | Number | The number of payments to be retrieved, starting from the latest one | ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{ "status":{ "message":null, "description":null, "code":"OK" }, "data":[ { "invoices_to_pay_set":{ }, "udf_float_1":null, "udf_float_2":null, "udf_float_3":null, "udf_float_4":null, "number":"20", "udf_string_1":null, "udf_string_2":null, "udf_string_3":null, "received_by_unit":{ "community_name":"Main Community", "group_name":"Main Group", "name":"Admin Unit", "id":"48305F8849E3C18B227C5BE3A27BA6DF", "description":"r1", "alternative_code":"MG" }, "udf_string_4":null, "udf_string_5":null, "udf_string_6":null, "udf_string_7":null, "udf_string_8":null, "accounts_receivable":{ "account_owner":{ "last_name":"Perikleous", "middle_name":null, "company_profile":{ "tax_reference_number":null, "annual_turnover":null, "number_of_employees":null, "profile_year":null, "established_date":null, "industry_sector":{ }, "registered_in_country":null, "vat_registration_number":null, "industry":{ }, "vat_registration_date":null, "vat_registered_by":null, "registration_number":null }, "type":"PERSON", "first_name":"Iakovos", "name":null, "id":"FEF4B54E47529EF2F009A2BABA5441DF", "company_name":null, "demographics":{ "gender":"MALE", "passport_issued_by_country":{ }, "passport_number":null, "social_security_number":null, "country_of_residence":{ }, "industry_sector":{ }, "date_of_birth":{ "month":null, "day":null, "year":null }, "name_day":{ "month":null, "day":null }, "id_number":null, "id_issued_by_country":{ }, "industry":{ } } }, "life_cycle_state":"ACTIVE", "number":"8", "name":"Perikleous", "id":"FAD392F16B192C90DE913B18DB53FD7E" }, "received_by_user":{ "person_name":"MPAdministrator", "username":"MPAdministrator", "id":"1", "email":"mp@ministrator.com" }, "bills_to_pay_set":{ }, "id":"D568C793B1716124797E3783D927FB46", "posted_on":"2014-05-19T09:15:26", "udf_date_1":null, "udf_date_2":null, "udf_date_3":null, "udf_date_4":null, "log_information":{ "updated_date":"2014-05-19T09:15:26", "created_by_unit":{ "community_name":"Main Community", "group_name":"Main Group", "name":"Admin Unit", "id":"48305F8849E3C18B227C5BE3A27BA6DF", "description":"r1", "alternative_code":"MG" }, "created_date":"2014-05-19T09:15:26", "updated_by_unit":{ "community_name":"Main Community", "group_name":"Main Group", "name":"Admin Unit", "id":"48305F8849E3C18B227C5BE3A27BA6DF", "description":"r1", "alternative_code":"MG" }, "created_by_user":{ "person_name":"MPAdministrator", "username":"MPAdministrator", "id":"1", "email":"mp@ministrator.com" }, "updated_by_user":{ "person_name":"MPAdministrator", "username":"MPAdministrator", "id":"1", "email":"mp@ministrator.com" } }, "payment_amount":12, "issued_on":"2014-05-19T09:15:26", "life_cycle_state":"POSTED", "type":{ "classification":"PAYMENT", "name":"Payment 2", "id":"4035F322F9FA4DB7B917CED74634B51F", "description":null, "alternative_code":"P2" }, "payment_method":{ "name":"Bank Transfer", "id":"PM7", "description":"Bank Transfer", "alternative_code":"Bank Transfer" }, "rejection_reason":null, "received_on":"2014-05-19T09:15:26", "reference_number":"4", "category":{ "name":"Global Categories", "id":"F8C7CB6FE575A92F25641FD6C49F4262", "description":"Global Categories", "code":"Global Categories" } }, { "invoices_to_pay_set":{ }, "udf_float_1":null, "udf_float_2":null, "udf_float_3":null, "udf_float_4":null, "number":"19", "udf_string_1":null, "udf_string_2":null, "udf_string_3":null, "received_by_unit":{ "community_name":"Main Community", "group_name":"Main Group", "name":"Admin Unit", "id":"48305F8849E3C18B227C5BE3A27BA6DF", "description":"r1", "alternative_code":"MG" }, "udf_string_4":null, "udf_string_5":null, "udf_string_6":null, "udf_string_7":null, "udf_string_8":null, "accounts_receivable":{ "account_owner":{ "last_name":"Perikleous", "middle_name":null, "company_profile":{ "tax_reference_number":null, "annual_turnover":null, "number_of_employees":null, "profile_year":null, "established_date":null, "industry_sector":{ }, "registered_in_country":null, "vat_registration_number":null, "industry":{ }, "vat_registration_date":null, "vat_registered_by":null, "registration_number":null }, "type":"PERSON", "first_name":"Iakovos", "name":null, "id":"FEF4B54E47529EF2F009A2BABA5441DF", "company_name":null, "demographics":{ "gender":"MALE", "passport_issued_by_country":{ }, "passport_number":null, "social_security_number":null, "country_of_residence":{ }, "industry_sector":{ }, "date_of_birth":{ "month":null, "day":null, "year":null }, "name_day":{ "month":null, "day":null }, "id_number":null, "id_issued_by_country":{ }, "industry":{ } } }, "life_cycle_state":"ACTIVE", "number":"8", "name":"Perikleous", "id":"FAD392F16B192C90DE913B18DB53FD7E" }, "received_by_user":{ "person_name":"MPAdministrator", "username":"MPAdministrator", "id":"1", "email":"mp@ministrator.com" }, "bills_to_pay_set":{ }, "id":"11653A9A0025D11DB21D1D324F9907FD", "posted_on":"2014-05-19T09:12:54", "udf_date_1":null, "udf_date_2":null, "udf_date_3":null, "udf_date_4":null, "log_information":{ "updated_date":"2014-05-19T09:12:54", "created_by_unit":{ "community_name":"Main Community", "group_name":"Main Group", "name":"Admin Unit", "id":"48305F8849E3C18B227C5BE3A27BA6DF", "description":"r1", "alternative_code":"MG" }, "created_date":"2014-05-19T09:12:54", "updated_by_unit":{ "community_name":"Main Community", "group_name":"Main Group", "name":"Admin Unit", "id":"48305F8849E3C18B227C5BE3A27BA6DF", "description":"r1", "alternative_code":"MG" }, "created_by_user":{ "person_name":"MPAdministrator", "username":"MPAdministrator", "id":"1", "email":"mp@ministrator.com" }, "updated_by_user":{ "person_name":"MPAdministrator", "username":"MPAdministrator", "id":"1", "email":"mp@ministrator.com" } }, "payment_amount":12, "issued_on":"2014-05-19T09:12:54", "life_cycle_state":"POSTED", "type":{ "classification":"PAYMENT", "name":"Payment 2", "id":"4035F322F9FA4DB7B917CED74634B51F", "description":null, "alternative_code":"P2" }, "payment_method":{ "name":"Bank Transfer", "id":"PM7", "description":"Bank Transfer", "alternative_code":"Bank Transfer" }, "rejection_reason":null, "received_on":"2014-05-19T09:12:54", "reference_number":"3", "category":{ "name":"Global Categories", "id":"F8C7CB6FE575A92F25641FD6C49F4262", "description":"Global Categories", "code":"Global Categories" } } ] } |
POST payments/create
This method is creating a new payment either in Draft or Posted state
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| accounts_receivable_identifier (mandatory) | Accounts receivable identifier | The identifier of the accounts receivable in which the payment should be allocated to. The allowed accounts receivable identifier fields are the following:
| ||||||
type_identifier (mandatory) | Financial transaction type identifier | The financial transaction type of the payment. The allowed financial transaction type identifier field are the following:
| ||||||
life_cycle_state (mandatory) | String | The state of the retrieved payment which can be one of the following: DRAFT, POSTED | ||||||
payment_method_identifier (mandatory) | Payment method identifier | The payment method of the payment. The allowed payment method identifier fields are the following:
| ||||||
payment_amount (mandatory) | Number | The amount of the payment | ||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||
received_on (optional) | Date | The date that the payment was received. It defaults to the issued date if not specified | ||||||
received_by_user (optional) | User identifier | The user who actually received the payment. It defaults to the issued by user if not specified. The allowed user identifier fields are the following:
| ||||||
received_by_unit (optional) | Unit identifier | The unit who actually received the payment. The allowed unit identifier fields are the following:
| ||||||
notes (optional) | String | Shared notes for the payment | ||||||
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 paid | ||||||
(optional) | Set of bill objects | The bills that are intended to be paid |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| accounts_receivable_identifier (mandatory) | Accounts receivable identifier | The identifier of the accounts receivable in which the payment should be allocated to. The allowed accounts receivable identifier fields are the following:
| ||||||
type_identifier (mandatory) | Financial transaction type identifier | The financial transaction type of the payment. The allowed financial transaction type identifier field are the following:
| ||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||
payment_method_identifier (mandatory) | Payment method identifier | The payment method of the payment. The allowed payment method identifier fields are the following:
| ||||||
invoice_identifier (mandatory) | Invoice identifier | The invoice to be paid. The allowed invoice identifier fields are the following:
| ||||||
received_on (optional) | Date | The date that the payment was received. It defaults to the issued date if not specified | ||||||
received_by_user (optional) | User identifier | The user who actually received the payment. It defaults to the issued by user if not specified. The allowed user identifier fields are the following:
| ||||||
received_by_unit (optional) | Unit identifier | The unit who actually received the payment. The allowed unit identifier fields are the following:
| ||||||
notes (optional) | String | Shared notes for the payment | ||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_4 (optional) | Date | User Defined Field of type Date |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| accounts_receivable_identifier (mandatory) | Accounts receivable identifier | The identifier of the accounts receivable in which the payment should be allocated to. The allowed accounts receivable identifier fields are the following:
| ||||||
type_identifier (mandatory) | Financial transaction type identifier | The financial transaction type of the payment. The allowed financial transaction type identifier field are the following:
| ||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||
payment_method_identifier (mandatory) | Payment method identifier | The payment method of the payment. The allowed payment method identifier fields are the following:
| ||||||
bill_identifier (mandatory) | Bill identifier | The invoice to be paid. The allowed invoice identifier fields are the following:
| ||||||
received_on (optional) | Date | The date that the payment was received. It defaults to the issued date if not specified | ||||||
received_by_user (optional) | User identifier | The user who actually received the payment. It defaults to the issued by user if not specified. The allowed user identifier fields are the following:
| ||||||
received_by_unit (optional) | Unit identifier | The unit who actually received the payment. The allowed unit identifier fields are the following:
| ||||||
notes (optional) | String | Shared notes for the payment | ||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_4 (optional) | Date | User Defined Field of type Date |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| payment_identifier (mandatory) | Payment identifier | The identifier of the payment that should be posted. Only payments in draft state can be specified.The allowed payment identifier fields are the following:
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| payment_identifier (mandatory) | Payment Identifier | The identifier of the payment that should be posted. Only payments in draft state can be specified.The allowed payment identifier fields are the following:
| ||||||
| rejection_reason_identifier | Rejection reason identifier | The reason that the payment is rejected. The allowed rejection reason identifier fields are the following:
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| payment_identifier (mandatory) | Payment Identifier | The identifier of the payment that should be posted. Only payments in draft state can be specified.The allowed payment identifier fields are the following:
| ||||||
type_identifier (mandatory) | Financial transaction type identifier | The financial transaction type of the payment cancellation. The allowed financial transaction type identifier field are the following:
| ||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the payment cancellation. The allowed financial transaction category identifier fields are the following:
| ||||||
notes (optional) | String | Shared notes for the payment | ||||||
issue_reason (optional) | String | A description of the reason that the payment cancellation is issued | ||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_4 (optional) | Date | User Defined Field of type Date |
...