GET invoices/show
This method returns information related with an invoice. A single invoice is returned by each call
Resource URL
Parameters
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 |
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 invoice |
| number | String | The number of the retrieved invoice |
| reference_number | String | The reference number of the retrieved invoice |
| life_cycle_state | String | The state of the retrieved invoice which can be one of the following: DRAFT, REJECTED, POSTED, CANCELLED |
| discount_amount | Number | The total discount amount provided by the invoice |
| vat_amount | Number | The total VAT amount applied on the invoice Deprecated from CRM.COM R17.0.0 |
| tax_amount | Number | The Total Tax amount applied on the invoice Available from CRM.COM R12.0.0 |
| net_amount | Number | The total net amount of the invoice |
| total_amount | Number | The total amount which is invoiced |
| outstanding_amount | Number | The outstanding amount of this invoice |
| unsettled_amount | Number | The unsettled amount of this invoice |
| issued_on | Date | The date that the invoice was issued |
| posted_on | Date | The date that the invoice was posted |
| due_on | Date | The date that the invoice was received |
| notes | String | Shared notes for the invoice |
| back_office_code | String | The back office code of the retrieved invoice |
udf_string_1 | String | User DefinedField of type String |
udf_string_2 | String | User DefinedField of type String |
udf_string_3 | String | User DefinedField of type String |
udf_string_4 | String | User DefinedField of type String |
udf_string_5 | String | User DefinedField of type String |
udf_string_6 | String | User DefinedField of type String |
udf_string_7 | String | User DefinedField of type String |
udf_string_8 | String | User DefinedField 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_receivable | Accounts receivable object | The related accounts receivable |
| member_account | Accounts receivable object | The member accounts receivable. Applicable only if the retrieved Invoice was issued because the member account is funded by a parent account. |
| type | Financial transaction type object | The financial transaction type of this invoice |
| category | Financial transaction category object | The category of the invoice |
| rejection_reason | Financial transaction rejection reason object | The reason that the invoice was rejected |
| accounting_period_information | Accounting Period Information object | The accounting period information of the retrieved invoice. This is applicable only if the invoice was processed during an Accounting Period Closing process run |
| currency_rate_period | Currency Rate Period object | The currency rate period based on which the invoice's amounts were calculated Available from CRM.COM R10.0.0 |
Log Information Object | The log information relatedwiththe retrieved invoice | |
| invoice_item_set | Set of invoice item objects | A list of items which are invoiced by this invoice |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"notes": null,
"udf_float_1": 10,
"udf_float_2": 20,
"invoice_item_set":
[
{
"vat_percentage": 0,
"sub_total": 57,
"discount_amount": 3,
"vat_rate":
{
"name": "Zero",
"id": "EDE5318C0AA394902E8C7DAE0227CB01",
"description": "No VAT applied",
"alternative_code": "ZR"
},
"discount_percentage": 5,
"net_amount": 60,
"id": "FF61765F8AABD432D28A8B4FFFCC397A",
"quantity": 0,
"cost": 0,
"vat_amount": 0,
"product":
{
"product_type":
{
"physical_good_type": null,
"service_type": "USAGE",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "3Play ",
"id": "92F0AFC840E91633C5212162303BE8DF",
"description": "3Play Packages (Gold, Silver etc)",
"alternative_code": "3PLAY"
},
"id": "F43EBDCE48CAADEC32CB26F59904ECCD",
"description": "Smart Card",
"code": "Smart Card",
"alternative_code": null
}
}
],
"udf_float_3": 30,
"number": "I00000498",
"udf_float_4": 40,
"due_on": "2014-11-05T15:49:59",
"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",
"accounts_receivable":
{
"account_owner":
{
"last_name": "Papapavlou",
"life_cycle_state": "FINANCIAL",
"middle_name": "Andreas",
"company_profile": null,
"title": "Ms",
"type": "PERSON",
"first_name": "Lucia",
"name": "Lucia Papapavlou",
"id": "1D92B269658D80DEDF2499E25201739E",
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_issued_by_country":
{
"name": "GREECE",
"id": "209"
},
"passport_number": "113115",
"social_security_number": "113116",
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector":
{
"name": "GOVERNMENTAL",
"id": "A9BDEBD4D8FAEDB0BACE40C041156D12"
},
"date_of_birth":
{
"month": 1,
"day": 1,
"year": 1990
},
"name_day":
{
"month": 5,
"day": 5
},
"id_number": "113114",
"id_issued_by_country":
{
"name": "GREECE",
"id": "209"
},
"industry":
{
"name": "Interior Design",
"id": "06B638258885DA26FA2BD40D9128D04E"
}
}
},
"life_cycle_state": "ACTIVE",
"number": "401",
"name": "Loucia Papapavlou",
"id": "ACAED91501DC6856A93E1E7E5AF6E5C0"
},
"discount_amount": 3,
"id": "399ABC9CAAFF820100582EDEB842F026",
"outstanding_amount": 0,
"posted_on": "2014-10-29T18:20:40",
"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",
"vat_amount": 0,
"log_information":
{
"updated_date": "2014-10-30T15:58:36",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-10-29T18:20:40",
"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"
}
},
"issued_on": "2014-10-29T18:20:40",
"total_amount": 57,
"life_cycle_state": "POSTED",
"unsettled_amount": 0,
"back_office_code": null,
"rejection_reason": null,
"net_amount": 60,
"type":
{
"classification": "INVOICE",
"name": "Invoice 1",
"id": "D75737F9C4EDF822BBC1024ADE086695",
"description": "Invoice 1",
"alternative_code": "I1"
},
"reference_number": "542",
"category":
{
"name": "Invoice Category 1",
"id": "77F4DAEBBADDD57BD974CD206A791AE0",
"description": "Invoice Category 1",
"code": "IC1"
}
}
}
HTTP Method: GET
Request:
Response:
{
"data": {
"notes": null,
"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": "2016-06-14T13:12:31",
"updated_date": "2016-06-15T12:02:14",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"discount_amount": 0,
"currency_rate_period": {
"from_date": "C7D7ED57F21B47028144967E015DCBE5",
"to_date": 2.3,
"rate": 2.3,
"inverse_rate": 0.23000000417232513,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "£",
"decimal_part_name": null,
"code": "GBP",
"integer_part_name": null,
"id": "9"
},
"id": "C7D7ED57F21B47028144967E015DCBE5"
},
"udf_date_2": null,
"type": {
"alternative_code": "INV",
"name": "Invoice",
"description": null,
"id": "INVOICE",
"classification": "INVOICE"
},
"udf_date_1": null,
"due_on": "2016-06-16T13:13:01",
"udf_date_4": null,
"udf_date_3": null,
"invoice_item_set": [
{
"product": {
"code": "aionet",
"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": "aionet",
"description": null,
"id": "100D15C611CD4B0591EF62F2163266B9"
},
"quantity": 1,
"cost": 10,
"vat_amount": 0.9,
"discount_amount": 0,
"sub_total": 10.9,
"id": "66B27469E6C840808720D8BE2F75CBFD",
"net_amount": 10,
"discount_percentage": 0,
"vat_percentage": 9,
"vat_rate": {
"alternative_code": "VAT 9%",
"name": "VAT 9%",
"description": null,
"id": "48ADFA77916048328685049A3B7E3F64"
}
}
],
"number": "I00000591",
"udf_float_3": null,
"udf_float_4": null,
"vat_amount": 0.9,
"rejection_reason": null,
"id": "DE2A2E7E85C546AD9D9CEB066A0912CF",
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"udf_string_3": null,
"accounting_period_information": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"accounts_receivable": {
"number": "ACR0000000221",
"name": "ACR0000000221 Kyriacos16 Clerides",
"id": "F73BD30B13F64BE1A181AD4115B8D758",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Kyriacos16 Clerides",
"last_name": "Clerides",
"id": "7747BAF431E9457D93D8E4A800DFFB1E",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Kyriacos16",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "45786",
"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
}
}
},
"life_cycle_state": "POSTED",
"reference_number": "67",
"posted_on": "2016-06-14T13:13:01",
"total_amount": 10.9,
"unsettled_amount": 0,
"issued_on": "2016-06-14T13:12:31",
"net_amount": 10,
"outstanding_amount": 0,
"udf_string_6": null,
"category": null,
"udf_string_7": null,
"udf_string_8": null,
"back_office_code": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
GET invoices/list
This method returns information related with invoices. Multiple invoices are returned by each 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 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:
| ||||||||||||
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 |
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 invoice |
| number | String | The number of the retrieved invoice |
| reference_number | String | The reference number of the retrieved invoice |
| life_cycle_state | String | The state of the retrieved invoice which can be one of the following: DRAFT, REJECTED, POSTED, CANCELLED |
| discount_amount | Number | The total discount amount provided by the invoice |
| vat_amount | Number | The total VAT amount applied on the invoice Deprecated from CRM.COM R17.0.0 |
| tax_amount | Number | The Total Tax amount applied on the invoice Available from CRM.COM R12.0.0 |
| net_amount | Number | The total net amount of the invoice |
| total_amount | Number | The total amount which is invoiced |
| outstanding_amount | Number | The outstanding amount of this invoice |
| unsettled_amount | Number | The unsettled amount of this invoice |
| issued_on | Date | The date that the invoice was issued |
| posted_on | Date | The date that the invoice was posted |
| due_on | Date | The date that the invoice was received |
| notes | String | Shared notes for the invoice |
| back_office_code | String | The back office code of the retrieved invoice |
udf_string_1 | String | User DefinedField of type String |
udf_string_2 | String | User DefinedField of type String |
udf_string_3 | String | User DefinedField of type String |
udf_string_4 | String | User DefinedField of type String |
udf_string_5 | String | User DefinedField of type String |
udf_string_6 | String | User DefinedField of type String |
udf_string_7 | String | User DefinedField of type String |
udf_string_8 | String | User DefinedField 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_receivable | Accounts receivable object | The related accounts receivable |
| member_account | Accounts receivable object | The member accounts receivable. Applicable only if the retrieved Invoice was issued because the member account is funded by a parent account. |
| type | Financial transaction type object | The financial transaction type of this invoice |
| category | Financial transaction category object | The category of the invoice |
| rejection_reason | Financial transaction rejection reason object | The reason that the invoice was rejected |
| accounting_period_information | Accounting Period Information object | The accounting period information of the retrieved invoice. This is applicable only if the invoice was processed during an Accounting Period Closing process run |
| currency_rate_period | Currency Rate Period object | The currency rate period based on which the invoice's amounts were calculated Available from CRM.COM R10.0.0 |
Log Information Object | The log information relatedwiththe retrieved invoice | |
| invoice_item_set | Set of invoice item objects | A list of items which are invoiced by this invoice |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"notes": null,
"udf_float_1": 10,
"udf_float_2": 20,
"invoice_item_set":
[
{
"vat_percentage": 0,
"sub_total": 57,
"discount_amount": 3,
"vat_rate":
{
"name": "Zero",
"id": "EDE5318C0AA394902E8C7DAE0227CB01",
"description": "No VAT applied",
"alternative_code": "ZR"
},
"discount_percentage": 5,
"net_amount": 60,
"id": "98321FC800F824D847A9EC9C2A2E8809",
"quantity": 0,
"cost": 0,
"vat_amount": 0,
"product":
{
"product_type":
{
"physical_good_type": null,
"service_type": "USAGE",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "3Play ",
"id": "92F0AFC840E91633C5212162303BE8DF",
"description": "3Play Packages (Gold, Silver etc)",
"alternative_code": "3PLAY"
},
"id": "F43EBDCE48CAADEC32CB26F59904ECCD",
"description": "Smart Card",
"code": "Smart Card",
"alternative_code": null
}
}
],
"udf_float_3": 30,
"number": null,
"udf_float_4": 40,
"due_on": "2014-08-05T15:49:59",
"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",
"accounts_receivable":
{
"account_owner":
{
"last_name": "Papapavlou",
"life_cycle_state": "FINANCIAL",
"middle_name": "Andreas",
"company_profile": null,
"title": "Ms",
"type": "PERSON",
"first_name": "Lucia",
"name": "Lucia Papapavlou",
"id": "1D92B269658D80DEDF2499E25201739E",
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_issued_by_country":
{
"name": "GREECE",
"id": "209"
},
"passport_number": "113115",
"social_security_number": "113116",
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector":
{
"name": "GOVERNMENTAL",
"id": "A9BDEBD4D8FAEDB0BACE40C041156D12"
},
"date_of_birth":
{
"month": 1,
"day": 1,
"year": 1990
},
"name_day":
{
"month": 5,
"day": 5
},
"id_number": "113114",
"id_issued_by_country":
{
"name": "GREECE",
"id": "209"
},
"industry":
{
"name": "Interior Design",
"id": "06B638258885DA26FA2BD40D9128D04E"
}
}
},
"life_cycle_state": "ACTIVE",
"number": "401",
"name": "Loucia Papapavlou",
"id": "ACAED91501DC6856A93E1E7E5AF6E5C0"
},
"discount_amount": 3,
"id": "D694E2A3199433F7957AF223326D3124",
"outstanding_amount": 0,
"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",
"vat_amount": 0,
"log_information":
{
"updated_date": "2014-10-29T18:17:39",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-10-29T18:17:38",
"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"
}
},
"issued_on": "2014-10-29T18:17:38",
"total_amount": 57,
"life_cycle_state": "DRAFT",
"unsettled_amount": 0,
"rejection_reason": null,
"net_amount": 60,
"type":
{
"classification": "INVOICE",
"name": "Invoice 1",
"id": "D75737F9C4EDF822BBC1024ADE086695",
"description": "Invoice 1",
"alternative_code": "I1"
},
"reference_number": "540",
"category":
{
"name": "Invoice Category 1",
"id": "77F4DAEBBADDD57BD974CD206A791AE0",
"description": "Invoice Category 1",
"code": "IC1"
}
},
{
"notes": null,
"udf_float_1": 10,
"udf_float_2": 20,
"invoice_item_set":
[
{
"vat_percentage": 0,
"sub_total": 57,
"discount_amount": 3,
"vat_rate":
{
"name": "Zero",
"id": "EDE5318C0AA394902E8C7DAE0227CB01",
"description": "No VAT applied",
"alternative_code": "ZR"
},
"discount_percentage": 5,
"net_amount": 60,
"id": "FF61765F8AABD432D28A8B4FFFCC397A",
"quantity": 0,
"cost": 0,
"vat_amount": 0,
"product":
{
"product_type":
{
"physical_good_type": null,
"service_type": "USAGE",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "3Play ",
"id": "92F0AFC840E91633C5212162303BE8DF",
"description": "3Play Packages (Gold, Silver etc)",
"alternative_code": "3PLAY"
},
"id": "F43EBDCE48CAADEC32CB26F59904ECCD",
"description": "Smart Card",
"code": "Smart Card",
"alternative_code": null
}
}
],
"udf_float_3": 30,
"number": "I00000498",
"udf_float_4": 40,
"due_on": "2014-11-05T15:49:59",
"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",
"accounts_receivable":
{
"account_owner":
{
"last_name": "Papapavlou",
"life_cycle_state": "FINANCIAL",
"middle_name": "Andreas",
"company_profile": null,
"title": "Ms",
"type": "PERSON",
"first_name": "Lucia",
"name": "Lucia Papapavlou",
"id": "1D92B269658D80DEDF2499E25201739E",
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_issued_by_country":
{
"name": "GREECE",
"id": "209"
},
"passport_number": "113115",
"social_security_number": "113116",
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector":
{
"name": "GOVERNMENTAL",
"id": "A9BDEBD4D8FAEDB0BACE40C041156D12"
},
"date_of_birth":
{
"month": 1,
"day": 1,
"year": 1990
},
"name_day":
{
"month": 5,
"day": 5
},
"id_number": "113114",
"id_issued_by_country":
{
"name": "GREECE",
"id": "209"
},
"industry":
{
"name": "Interior Design",
"id": "06B638258885DA26FA2BD40D9128D04E"
}
}
},
"life_cycle_state": "ACTIVE",
"number": "401",
"name": "Loucia Papapavlou",
"id": "ACAED91501DC6856A93E1E7E5AF6E5C0"
},
"discount_amount": 3,
"id": "399ABC9CAAFF820100582EDEB842F026",
"outstanding_amount": 0,
"posted_on": "2014-10-29T18:20:40",
"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",
"vat_amount": 0,
"log_information":
{
"updated_date": "2014-10-30T15:58:36",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-10-29T18:20:40",
"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"
}
},
"issued_on": "2014-10-29T18:20:40",
"total_amount": 57,
"life_cycle_state": "POSTED",
"unsettled_amount": 0,
"rejection_reason": null,
"net_amount": 60,
"type":
{
"classification": "INVOICE",
"name": "Invoice 1",
"id": "D75737F9C4EDF822BBC1024ADE086695",
"description": "Invoice 1",
"alternative_code": "I1"
},
"reference_number": "542",
"category":
{
"name": "Invoice Category 1",
"id": "77F4DAEBBADDD57BD974CD206A791AE0",
"description": "Invoice Category 1",
"code": "IC1"
}
},
{
"notes": null,
"udf_float_1": null,
"udf_float_2": null,
"invoice_item_set":
[
{
"vat_percentage": 15,
"sub_total": 31.05,
"discount_amount": 3,
"vat_rate":
{
"name": "Standard",
"id": "B07FADC7060C61AC7B721252A6A0C5C2",
"description": null,
"alternative_code": "STN"
},
"discount_percentage": 10,
"net_amount": 30,
"id": "852A14314A3C33AC1DB28E84B8903BCF",
"quantity": 0,
"cost": 0,
"vat_amount": 4.05,
"product":
{
"product_type":
{
"physical_good_type": null,
"service_type": "USAGE",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Subscription",
"id": "2B0EC029035C637200648C9B2D6A2FFB",
"description": "Subscription channels",
"alternative_code": "SUBSCRIPTION"
},
"id": "E32627E0EBB8EC74E8C4FBA0865CDF50",
"description": "Entertainment",
"code": "Entertainment",
"alternative_code": null
}
},
{
"vat_percentage": 6,
"sub_total": 9.01,
"discount_amount": 1.5,
"vat_rate":
{
"name": "Low VAT Rate",
"id": "152BFE506603FFF5B71C9B45248B0637",
"description": null,
"alternative_code": "LVR"
},
"discount_percentage": 15,
"net_amount": 10,
"id": "C4E82DB571AFCEDCD4AD039BA892F5D2",
"quantity": 0,
"cost": 0,
"vat_amount": 0.51,
"product":
{
"product_type":
{
"physical_good_type": null,
"service_type": "USAGE",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Subscription",
"id": "2B0EC029035C637200648C9B2D6A2FFB",
"description": "Subscription channels",
"alternative_code": "SUBSCRIPTION"
},
"id": "DE37CF1696E3CD4E8EF89F522019D385",
"description": "Documentaries",
"code": "Documentaries",
"alternative_code": null
}
},
{
"vat_percentage": 6,
"sub_total": 42.4,
"discount_amount": 0,
"vat_rate":
{
"name": "Standard 2",
"id": "17C3CC33CED167090E68D6802A5E0CE0",
"description": "reerddd",
"alternative_code": "STN2"
},
"discount_percentage": 0,
"net_amount": 40,
"id": "CF2E917C1B4EF21C9F2D8FDC4D3B5B0A",
"quantity": 0,
"cost": 0,
"vat_amount": 2.4,
"product":
{
"product_type":
{
"physical_good_type": null,
"service_type": "USAGE",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "3Play ",
"id": "92F0AFC840E91633C5212162303BE8DF",
"description": "3Play Packages (Gold, Silver etc)",
"alternative_code": "3PLAY"
},
"id": "F43EBDCE48CAADEC32CB26F59904ECCD",
"description": "Smart Card",
"code": "Smart Card",
"alternative_code": null
}
}
],
"udf_float_3": null,
"number": "I00000499",
"udf_float_4": null,
"due_on": "2014-10-30T18:33:57",
"udf_string_1": null,
"udf_string_2": null,
"udf_string_3": null,
"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": "Papapavlou",
"life_cycle_state": "FINANCIAL",
"middle_name": "Andreas",
"company_profile": null,
"title": "Ms",
"type": "PERSON",
"first_name": "Lucia",
"name": "Lucia Papapavlou",
"id": "1D92B269658D80DEDF2499E25201739E",
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_issued_by_country":
{
"name": "GREECE",
"id": "209"
},
"passport_number": "113115",
"social_security_number": "113116",
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector":
{
"name": "GOVERNMENTAL",
"id": "A9BDEBD4D8FAEDB0BACE40C041156D12"
},
"date_of_birth":
{
"month": 1,
"day": 1,
"year": 1990
},
"name_day":
{
"month": 5,
"day": 5
},
"id_number": "113114",
"id_issued_by_country":
{
"name": "GREECE",
"id": "209"
},
"industry":
{
"name": "Interior Design",
"id": "06B638258885DA26FA2BD40D9128D04E"
}
}
},
"life_cycle_state": "ACTIVE",
"number": "401",
"name": "Loucia Papapavlou",
"id": "ACAED91501DC6856A93E1E7E5AF6E5C0"
},
"discount_amount": 4.5,
"id": "4150AED0A46C0237888DC2C3C22C5D01",
"outstanding_amount": 0,
"posted_on": "2014-10-29T18:36:11",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"vat_amount": 6.96,
"log_information":
{
"updated_date": "2014-10-30T15:58:36",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-10-29T18:32:40",
"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"
}
},
"issued_on": "2014-10-29T18:32:40",
"total_amount": 82.46,
"life_cycle_state": "POSTED",
"unsettled_amount": 0,
"rejection_reason": null,
"net_amount": 80,
"type":
{
"classification": "INVOICE",
"name": "Invoice 1",
"id": "D75737F9C4EDF822BBC1024ADE086695",
"description": "Invoice 1",
"alternative_code": "I1"
},
"reference_number": "543",
"category":
{
"name": "Invoice Category 1",
"id": "77F4DAEBBADDD57BD974CD206A791AE0",
"description": "Invoice Category 1",
"code": "IC1"
}
}
]
}
HTTP Method: GET
Request:
Response:
{
"data": [
{
"number": "I00000591",
"currency_rate_period": {
"from_date": "C7D7ED57F21B47028144967E015DCBE5",
"to_date": 2.3,
"rate": 2.3,
"inverse_rate": 0.23000000417232513,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "£",
"decimal_part_name": null,
"code": "GBP",
"integer_part_name": null,
"id": "9"
},
"id": "C7D7ED57F21B47028144967E015DCBE5"
},
"id": "DE2A2E7E85C546AD9D9CEB066A0912CF"
},
{
"number": "I00000622",
"currency_rate_period": null,
"id": "F18D988453A24B99810783462D0F5DB7"
},
{
"number": "I00000623",
"currency_rate_period": null,
"id": "3CF95CCB7A174EBBAF02C84D2290B6B2"
},
{
"number": "I00000592",
"currency_rate_period": null,
"id": "5A4135C1852445678D57F76420665FD6"
},
{
"number": null,
"currency_rate_period": null,
"id": "989E035318914A689E6B12FAAEAE6A90"
},
{
"number": "I00000584",
"currency_rate_period": null,
"id": "2BE8D473289842CCA78F53FC202FC2B6"
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST invoices/create
This method is creating a new invoice either in Draft or Posted state
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 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:
| ||||||||||||
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 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 | 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 |
Referred Parameter Objects
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"4BCD003AC90E8DECBA474A03AB185CBB",
"accounts_receivable_identifier":{"number":"401"},
"type_identifier":{"name":"Invoice 1"},
"life_cycle_state":"POSTED",
"category_identifier":{"name":"Invoice Category 1"},
"due_on":"2014-11-05T15:49:59",
"notes":"to be issued later",
"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",
"invoice_item_set":
[
{
"product_identifier": {"code": "Smart Card"},
"quantity":3,
"cost":20,
"discount_percentage":5,
"vat_rate_identifier":{"name":"Zero"},
"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"
}
]
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"total_amount": 57,
"issued_on": "2014-10-29T18:20:40",
"life_cycle_state": "POSTED",
"unsettled_amount": null,
"number": "I00000498",
"due_on": "2014-11-05T15:49:59",
"id": "399ABC9CAAFF820100582EDEB842F026",
"outstanding_amount": null,
"reference_number": "542",
"posted_on": "2014-10-29T18:20:40"
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR0000000214"},
"type_identifier":{"name":"Invoice"},
"life_cycle_state":"POSTED",
"notes":"to be issued later",
"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",
"invoice_item_set":
[
{
"product_identifier": {"code": "Smartcard"},
"quantity":3,
"cost":20,
"discount_percentage":5,
"vat_rate_identifier":{"name":"Zero"},
"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"
}
]
}
Response:
{
"data": {
"posted_on": "2016-07-05T15:33:48",
"number": "I00000678",
"total_amount": 57,
"unsettled_amount": null,
"issued_on": "2016-07-05T15:33:48",
"currency_rate_period": null,
"id": "C83F011A58E0450EB9ADAF3416692284",
"life_cycle_state": "POSTED",
"outstanding_amount": null,
"reference_number": "97",
"due_on": "2016-07-07T15:33:48"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST invoices/post
This method is used to post an invoice which is in draft state.
Resource URL
Parameters
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:
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token": "B8D7A12E9F91AFADE914B7330AFD08CB",
"invoice_identifier":{"reference_number":"559"}
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"total_amount": 57,
"issued_on": "2014-11-07T11:38:48",
"life_cycle_state": "POSTED",
"unsettled_amount": 57,
"number": "I00000519",
"due_on": "2014-11-10T15:49:59",
"id": "7968903798226F14CB73E59E2DD8712B",
"outstanding_amount": 0,
"reference_number": "559",
"posted_on": "2014-11-07T11:45:41"
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"invoice_identifier":{"reference_number":"55"}
}
Response:
{
"data": {
"posted_on": "2016-07-05T15:46:36",
"number": "I00000679",
"total_amount": 5,
"unsettled_amount": -5,
"issued_on": "2015-04-14T06:41:39",
"currency_rate_period": null,
"id": "2C2374687D424D8AA6A3E02772900492",
"life_cycle_state": "POSTED",
"outstanding_amount": -5,
"reference_number": "55",
"due_on": "2016-07-05T20:42:13"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST invoices/reject
This method is used to reject an invoice which is in draft state.
Resource URL
Parameters
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:
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token": "B8D7A12E9F91AFADE914B7330AFD08CB",
"invoice_identifier":{"reference_number":"559"},
"rejection_reason_identifier":{"name":"Reject Due to Business Request"}
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"total_amount": 57,
"issued_on": "2014-11-07T11:38:48",
"life_cycle_state": "REJECTED",
"unsettled_amount": 0,
"number": "I00000519",
"due_on": "2014-11-10T15:49:59",
"id": "7968903798226F14CB73E59E2DD8712B",
"outstanding_amount": 0,
"reference_number": "559",
"posted_on": "2014-11-07T11:45:41"
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"invoice_identifier":{"reference_number":"541"},
"rejection_reason_identifier":{"name":"Reject Due to Error"}
}
Response:
{
"data": {
"posted_on": "2016-04-14T06:43:24",
"number": "542",
"total_amount": 100,
"unsettled_amount": 0,
"issued_on": "2016-04-15T00:00:00",
"currency_rate_period": null,
"id": "01A75EF631294253B24B2401CA65F15D",
"life_cycle_state": "REJECTED",
"outstanding_amount": 0,
"reference_number": "541",
"due_on": "2016-04-16T06:43:24"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST invoices/cancel
This method is used to cancel a posted invoice. An invoice cancellation is created and posted to cancel the specified invoice
Resource URL
Parameters
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 |
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 |
| invoice | Invoice object | The invoice that was cancelled |
| invoice_cancellation | Invoice cancellation object | The invoice cancellation that was created |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token": "B8D7A12E9F91AFADE914B7330AFD08CB",
"invoice_identifier":{"reference_number":"559"},
"type_identifier":{"name":"Invoice Cancellation"}
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"invoice_cancellation":
{
"issued_on": "2014-11-07T11:53:50",
"total_amount": 57,
"life_cycle_state": "POSTED",
"number": "51",
"id": "576831622F3735D9B734B419B4BC6C7A",
"reference_number": "2",
"posted_on": "2014-11-07T11:53:50"
},
"invoice":
{
"total_amount": 57,
"issued_on": "2014-11-07T11:38:48",
"life_cycle_state": "POSTED",
"unsettled_amount": 0,
"number": "I00000519",
"due_on": "2014-11-10T15:49:59",
"id": "7968903798226F14CB73E59E2DD8712B",
"outstanding_amount": 0,
"reference_number": "559",
"posted_on": "2014-11-07T11:45:41"
}
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"invoice_identifier":{"reference_number":"55"},
"type_identifier":{"name":"Invoice Cancellation"}
}
Response:
{
"data": {
"invoice": {
"posted_on": "2016-07-05T15:46:36",
"number": "I00000679",
"total_amount": 5,
"unsettled_amount": 0,
"issued_on": "2015-04-14T06:41:39",
"currency_rate_period": null,
"id": "2C2374687D424D8AA6A3E02772900492",
"life_cycle_state": "POSTED",
"outstanding_amount": 0,
"reference_number": "55",
"due_on": "2016-07-05T20:42:13"
},
"invoice_cancellation": {
"posted_on": "2016-07-05T15:59:57",
"number": "15",
"total_amount": 5,
"issued_on": "2016-07-05T15:59:57",
"id": "CA9A48B203FD413296866132184838DA",
"life_cycle_state": "POSTED",
"reference_number": "15"
}
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST invoices/update
Available from CRM.COM R9.1.0
This method is used to update a single invoice but only as long it is in Draft life cycle state.
Resource URL
Parameters
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:
| |||||||||||||||
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 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",
...........
}
]
|
Referred Parameters Objects Data
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 invoice |
| number | String | The number of the retrieved invoice |
| reference_number | String | The reference number of the retrieved invoice |
| life_cycle_state | String | The state of the retrieved invoice which can be one of the following: DRAFT, REJECTED, POSTED, CANCELLED |
| discount_amount | Number | The total discount amount provided by the invoice |
| vat_amount | Number | The total VAT amount applied on the invoice Deprecated from CRM.COM R17.0.0 |
| tax_amount | Number | The Total Tax amount applied on the invoice Available from CRM.COM R12.0.0 |
| net_amount | Number | The total net amount of the invoice |
| total_amount | Number | The total amount which is invoiced |
| outstanding_amount | Number | The outstanding amount of this invoice |
| unsettled_amount | Number | The unsettled amount of this invoice |
| issued_on | Date | The date that the invoice was issued |
| posted_on | Date | The date that the invoice was posted |
| due_on | Date | The date that the invoice was received |
| notes | String | Shared notes for the invoice |
| back_office_code | String | The back office code of the retrieved invoice |
udf_string_1 | String | User DefinedField of type String |
udf_string_2 | String | User DefinedField of type String |
udf_string_3 | String | User DefinedField of type String |
udf_string_4 | String | User DefinedField of type String |
udf_string_5 | String | User DefinedField of type String |
udf_string_6 | String | User DefinedField of type String |
udf_string_7 | String | User DefinedField of type String |
udf_string_8 | String | User DefinedField 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_receivable | Accounts receivable object | The related accounts receivable |
| member_account | Accounts receivable object | The member accounts receivable. Applicable only if the retrieved Invoice was issued because the member account is funded by a parent account. |
| type | Financial transaction type object | The financial transaction type of this invoice |
| category | Financial transaction category object | The category of the invoice |
| rejection_reason | Financial transaction rejection reason object | The reason that the invoice was rejected |
| accounting_period_information | Accounting Period Information object | The accounting period information of the retrieved invoice. This is applicable only if the invoice was processed during an Accounting Period Closing process run |
| currency_rate_period | Currency Rate Period object | The currency rate period based on which the invoice's amounts were calculated Available from CRM.COM R10.0.0 |
Log Information Object | The log information relatedwiththe retrieved invoice | |
| invoice_item_set | Set of invoice item objects | A list of items which are invoiced by this invoice |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"35FA3612DEB94BF7A2FE2C9EC9EF406D",
"invoice_identifier":{"reference_number":"1013"},
"accounts_receivable_identifier":{"name":"Mathew Spector 3"},
"type_identifier":{"name":"Invoice 2"},
"category_identifier":{"name":"Invoice Categories"},
"due_on":"2014-11-05T15:49:59",
"notes":"to be issued later",
"back_office_code":"000112",
"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",
"invoice_item_set":
[
{
"action":"add",
"product_identifier": {"code": "Smartcard 2"},
"quantity":2,
"cost":15,
"discount_percentage":5,
"vat_rate_identifier":{"name":"Zero"},
"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_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"
},
{
"action":"remove",
"invoice_item_identifier": {"id": "09E3B818BB644A57AD1D19FB95007C64"}
}
]
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"notes": "Marios Lannister\t4/5/2016 00:21:36\tto be issued later\tMarios Lannister\t4/5/2016 00:25:07\tto be issued later\tMarios Lannister\t4/5/2016 09:18:53\tto be issued later\tMarios Lannister\t4/5/2016 11:30:01\tto be issued later\tMarios Lannister\t4/5/2016 11:38:58\tto be issued later\tMarios Lannister\t4/5/2016 11:42:25\tto be issued later\tMarios Lannister\t4/5/2016 11:44:12\tto be issued later\tMarios Lannister\t4/5/2016 11:45:35\tto be issued later",
"udf_float_1": 10,
"udf_float_2": 20,
"invoice_item_set": [
{
"vat_percentage": 0,
"sub_total": 0,
"discount_amount": 0,
"vat_rate": {
"id": "EDE5318C0AA394902E8C7DAE0227CB01",
"name": "Zero",
"description": "No VAT applied",
"alternative_code": "ZR"
},
"discount_percentage": 0,
"net_amount": 0,
"id": "C21B99AA435742EF89B9398C60593DE9",
"quantity": 1,
"cost": 0,
"vat_amount": 0,
"product": {
"product_type": {
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "6173FC99331504AD1ACB5D697D54DA8C",
"name": "Smartcards",
"description": "Smartcards",
"alternative_code": "SC"
},
"id": "EAC7A30429364176616CFEF5DF709941",
"description": "Smartcard 1",
"code": "Smartcard 1",
"alternative_code": "SC1"
}
},
{
"vat_percentage": 0,
"sub_total": 28.5,
"discount_amount": 1.5,
"vat_rate": {
"id": "EDE5318C0AA394902E8C7DAE0227CB01",
"name": "Zero",
"description": "No VAT applied",
"alternative_code": "ZR"
},
"discount_percentage": 5,
"net_amount": 30,
"id": "794A7B5C1660432D906A487062376666",
"quantity": 2,
"cost": 15,
"vat_amount": 0,
"product": {
"product_type": {
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "6173FC99331504AD1ACB5D697D54DA8C",
"name": "Smartcards",
"description": "Smartcards",
"alternative_code": "SC"
},
"id": "80EEE8F6F46767AE32E6ABE68603E9F2",
"description": "SmartCards 2",
"code": "Smartcard 2",
"alternative_code": "SC2"
}
}
],
"udf_float_3": 30,
"udf_float_4": 40,
"number": null,
"due_on": "2014-11-05T15:49:59",
"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",
"accounts_receivable": {
"account_owner": {
"last_name": "Spector",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Mathew",
"type": "PERSON",
"id": "95548C3522A249E6B452D20C700BA95C",
"name": null,
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": "1245",
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "454545",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "168",
"id": "B3FB252765AF2AA339BAA0156E15E3C3",
"name": "Mathew Spector 3"
},
"discount_amount": 1.5,
"id": "4015E251C7CC4F738918454379B988C5",
"outstanding_amount": null,
"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",
"vat_amount": 0,
"log_information": {
"updated_date": "2016-05-04T08:45:37",
"created_date": "2015-04-07T17:36:43",
"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": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"issued_on": "2015-04-07T17:36:43",
"total_amount": 28.5,
"life_cycle_state": "DRAFT",
"unsettled_amount": null,
"back_office_code": "000112",
"rejection_reason": null,
"type": {
"classification": "INVOICE",
"id": "AD2930A767CA6BDB51E2BF7072D82E68",
"name": "Invoice 2",
"description": "Invoice 2",
"alternative_code": "I2"
},
"net_amount": 30,
"reference_number": "1013",
"category": {
"id": "1AABE70F46D5937ABE25B2FDCBD7BCF5",
"name": "Invoice Categories",
"description": "Invoice Categories",
"code": "IC"
}
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"invoice_identifier":{"number":"I00000581"},
"type_identifier":{"name":"Invoice"},
"due_on":"2014-11-05T15:49:59",
"notes":"to be issued later",
"back_office_code":"000112",
"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",
"invoice_item_set":
[
{
"action":"add",
"product_identifier": {"code": "Smartcard"},
"quantity":2,
"cost":15,
"discount_percentage":5,
"vat_rate_identifier":{"name":"Zero"},
"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_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"
}
]
}
Response:
{
"data": {
"notes": "CRM COM\t5/7/2016 18:55:07\tto be issued later",
"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": "2015-04-14T06:42:47",
"updated_date": "2016-07-05T15:55:07",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "k_clerides",
"id": "1C21EB0EDC614C6888A77D076C1B7018",
"email": null,
"username": "k_clerides"
}
},
"discount_amount": 1.5,
"currency_rate_period": null,
"udf_date_2": "2014-06-05T15:49:59",
"type": {
"alternative_code": "INV",
"name": "Invoice",
"description": null,
"id": "INVOICE",
"classification": "INVOICE"
},
"udf_date_1": "2014-05-05T15:49:59",
"due_on": "2014-11-05T15:49:59",
"udf_date_4": "2014-08-05T15:49:59",
"udf_date_3": "2014-07-05T15:49:59",
"invoice_item_set": [
{
"product": {
"code": "Smartcard",
"product_type": {
"service_type": null,
"used_for_provisioning": true,
"alternative_code": "S",
"composition_method": "FLAT",
"name": "SMARTCARD",
"description": "SMARTCARD",
"id": "D6BE0209EC0149989A89972CE889DF8B",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
},
"alternative_code": "S",
"description": null,
"id": "4F656ED5DAC44168B0805227881202CD"
},
"quantity": 2,
"cost": 15,
"vat_amount": 0,
"discount_amount": 1.5,
"sub_total": 28.5,
"id": "6097885683D243B092D48BB90274F595",
"net_amount": 30,
"discount_percentage": 5,
"vat_percentage": 0,
"vat_rate": {
"alternative_code": "Z",
"name": "Zero",
"description": null,
"id": "B975C041156341D8A9D2F83FC8D36E87"
}
},
{
"product": {
"code": "aionet",
"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": "aionet",
"description": null,
"id": "100D15C611CD4B0591EF62F2163266B9"
},
"quantity": 1,
"cost": 9,
"vat_amount": 0,
"discount_amount": 0,
"sub_total": 9,
"id": "641A3AA0B58146D1818239931BA17C4B",
"net_amount": 9,
"discount_percentage": 0,
"vat_percentage": 0,
"vat_rate": {
"alternative_code": "VAT 9%",
"name": "VAT 9%",
"description": null,
"id": "48ADFA77916048328685049A3B7E3F64"
}
}
],
"number": "I00000581",
"udf_float_3": 30,
"udf_float_4": 40,
"vat_amount": 0,
"rejection_reason": null,
"id": "00115409F875439DBF1C757039AA3D08",
"udf_float_1": 10,
"udf_float_2": 20,
"udf_string_2": "udf string 2",
"udf_string_3": "udf string 3",
"accounting_period_information": null,
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"udf_string_1": "udf string 1",
"accounts_receivable": {
"number": "ACR0000000217",
"name": "ACR0000000217 Andreas1 Georgiou",
"id": "38A43B82198F4E508AD05F88EE6ACCFA",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Georgiou",
"id": "5E106D94863C4709BA3A8AA5621D1789",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Andreas1",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "6453214",
"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": "57",
"posted_on": "2015-04-14T06:43:18",
"total_amount": 37.5,
"unsettled_amount": null,
"issued_on": "2015-04-14T06:42:47",
"net_amount": 39,
"outstanding_amount": null,
"udf_string_6": "udf string 6",
"category": null,
"udf_string_7": "udf string 7",
"udf_string_8": "udf string 8",
"back_office_code": "000112"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}