GET credit_notes/show
This method returns information related with a credit note. A single credit note is returned by each call
Resource URL
Parameters
Name | Type | Description | |||||||||||||||
token | String | The token retrieved from the login method | |||||||||||||||
| credit_note_identifier (mandatory) | Credit note identifier | The identifier of the credit not that should be returned as a result. The allowed credit note identifier fields are the following:
| |||||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
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 credit note |
| number | String | The number of the retrieved credit note |
| reference_number | String | The reference number of the retrieved credit note |
| life_cycle_state | String | The state of the retrieved credit note which can be one of the following: DRAFT, REJECTED, POSTED, CANCELLED |
| discount_amount | Number | The total discount amount provided by the credit note |
| vat_amount | Number | The total VAT amount applied on the credit note Deprecated from CRM.COM R17.0.0 |
| tax_amount | Number | The total Tax amount applied on the credit note Available from CRM.COM R12.0.0 |
| net_amount | Number | The total net amount of the credit note |
| total_amount | Number | The total amount which is credited |
| issued_on | Date | The date that the credit note was issued |
| posted_on | Date | The date that the credit note was posted |
| notes | String | Shared notes for the credit note |
| back_office_code | String | The back office code of the retrieved credit note |
| issue_reason | String | A description of the reason that the credit note is issued |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field 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 Credit Note was issued against a parent accounts receivable which fund the member accounts of its group. |
| type | Financial transaction type object | The financial transaction type of this credit note |
| category | Financial transaction category object | The category of the credit note |
| rejection_reason | Financial transaction rejection reason object | The reason that the credit note was rejected |
| accounting_period_information | Accounting Period Information object | The Accounting Period Information of the credit note which includes the Accounting period of the credit note and the date on which it was set. This is applicable only if the credit note is processed during an Accounting Period Closing process |
| currency_rate_period | Currency Rate Period object | The currency rate period based on which the credit note's amounts were calculated Available from CRM.COM R10.0.0 |
Log Information Object | The log information relatedwiththe retrieved credit note | |
| credit_note_item_set | Set of invoice item objects | A list of items which are credited by this credit note |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"notes": "Marios Lannister 30/1/2015 16:05:12 standard credit note",
"udf_float_1": 10,
"udf_float_2": 20,
"udf_float_3": 30,
"number": "CT00000182",
"udf_float_4": 40,
"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",
"alternative_code": "GOV"
},
"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",
"code": "INTDS"
}
}
},
"life_cycle_state": "ACTIVE",
"number": "401",
"name": "Loucia Papapavlou",
"id": "ACAED91501DC6856A93E1E7E5AF6E5C0"
},
"discount_amount": 2.5,
"id": "29DDF6B839BE577AD087AAB0B6C42596",
"credit_note_item_set":
[
{
"vat_percentage": 20,
"sub_total": 33,
"discount_amount": 2.5,
"vat_rate":
{
"name": "Standard",
"id": "B07FADC7060C61AC7B721252A6A0C5C2",
"description": null,
"alternative_code": "STN"
},
"discount_percentage": 8.333333,
"net_amount": 30,
"id": "4C91D62351FDF56DA07AB8C0FE704AA9",
"quantity": 2,
"cost": 15,
"vat_amount": 5.5,
"product":
{
"product_type": null,
"id": "F43EBDCE48CAADEC32CB26F59904ECCD",
"description": "Smart Card",
"code": "Smart Card",
"alternative_code": null
}
}
],
"posted_on": "2015-01-30T16:05:14",
"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": 5.5,
"log_information":
{
"updated_date": "2015-01-30T16:05:15",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2015-01-30T16:05:11",
"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": "2015-01-30T16:05:11",
"total_amount": 33,
"life_cycle_state": "POSTED",
"net_amount": 30,
"type":
{
"classification": "CREDIT_NOTE",
"name": "Credit Note 1",
"id": "B0BE932944DAFF4196DB5E54FEFDD9DC",
"description": "Credit Note 1",
"alternative_code": "CN1"
},
"back_office_code": null,
"rejection_reason": null,
"reference_number": "197",
"category":
{
"name": "Credit Note Categories",
"id": "952343B09192BEECEE2E1FAE55EE46FF",
"description": "Credit Note Categories",
"code": "CNC"
}
}
}
HTTP Method: GET
Request:
Response:
{
"data": {
"issue_reason": null,
"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": "2014-06-14T06:19:55",
"updated_date": "2014-06-14T06:20:32",
"updated_by_user": {
"person_name": "k_clerides",
"id": "1C21EB0EDC614C6888A77D076C1B7018",
"email": null,
"username": "k_clerides"
},
"created_by_user": {
"person_name": "k_clerides",
"id": "1C21EB0EDC614C6888A77D076C1B7018",
"email": null,
"username": "k_clerides"
}
},
"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": "CN",
"name": "Credit Note",
"description": null,
"id": "CREDITNOTE",
"classification": "CREDIT_NOTE"
},
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": "73",
"udf_float_3": null,
"udf_float_4": null,
"vat_amount": 0,
"rejection_reason": null,
"id": "0ABC0B2A82614701B183612330385D6D",
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"udf_string_3": null,
"accounting_period_information": {
"accounting_period_date": "2016-06-22 00:00:00.0",
"accounting_period": {
"number": "2014",
"closed_date": "2016-06-22 14:08:05.0",
"from_date": "2014-01-01 06:19:41.0",
"to_date": "2014-12-31 06:19:41.0",
"name": "January 2014",
"life_cycle_state": "CLOSED"
}
},
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"credit_note_item_set": [
{
"product": {
"code": "Expense 1",
"alternative_code": "E1",
"description": null,
"id": "A9917A7895044BEF9499DD6958539D33"
},
"quantity": 1,
"cost": 15,
"vat_amount": 0,
"discount_amount": 0,
"sub_total": 15,
"id": "6A0F318C0E3D40F19489167C5BD8DC59",
"net_amount": 15,
"discount_percentage": 0,
"vat_percentage": 0,
"vat_rate": {
"alternative_code": "VAT 9%",
"name": "VAT 9%",
"description": null,
"id": "48ADFA77916048328685049A3B7E3F64"
}
}
],
"accounts_receivable": {
"number": "ACR0000000214",
"name": "ACR0000000214 Marios Georgiou",
"id": "A708CC64DBB3433B9971070FB82B8577",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Marios Georgiou",
"last_name": "Georgiou",
"id": "CC9EC2D3047D4BB7B2FB6268293F1397",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Marios",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "4578985",
"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": "12",
"posted_on": "2014-06-14T06:20:32",
"total_amount": 15,
"issued_on": "2014-06-14T06:19:55",
"net_amount": 15,
"udf_string_6": null,
"category": null,
"udf_string_7": null,
"udf_string_8": null,
"back_office_code": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
GET credit_notes/list
This method returns information related with credit notes. Multiple credit notes 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 credit note that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:
| ||||||||||||
type_identifier (optional) | Financial transaction type identifier | The financial transaction type of the credit note that should be returned as a result. The allowed financial transaction type identifier field are the following:
| ||||||||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the credit note that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
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 credit note |
| number | String | The number of the retrieved credit note |
| reference_number | String | The reference number of the retrieved credit note |
| life_cycle_state | String | The state of the retrieved credit note which can be one of the following: DRAFT, REJECTED, POSTED, CANCELLED |
| discount_amount | Number | The total discount amount provided by the credit note |
| vat_amount | Number | The total VAT amount applied on the credit note Deprecated from CRM.COM R17.0.0 |
| tax_amount | Number | The total Tax amount applied on the credit note Available from CRM.COM R12.0.0 |
| net_amount | Number | The total net amount of the credit note |
| total_amount | Number | The total amount which is credited |
| issued_on | Date | The date that the credit note was issued |
| posted_on | Date | The date that the credit note was posted |
| notes | String | Shared notes for the credit note |
| back_office_code | String | The back office code of the retrieved credit note |
| issue_reason | String | A description of the reason that the credit note is issued |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field 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 Credit Note was issued against a parent accounts receivable which fund the member accounts of its group. |
| type | Financial transaction type object | The financial transaction type of this credit note |
| category | Financial transaction category object | The category of the credit note |
| rejection_reason | Financial transaction rejection reason object | The reason that the credit note was rejected |
| accounting_period_information | Accounting Period Information object | The Accounting Period Information of the credit note which includes the Accounting period of the credit note and the date on which it was set. This is applicable only if the credit note is processed during an Accounting Period Closing process |
| currency_rate_period | Currency Rate Period object | The currency rate period based on which the credit note's amounts were calculated Available from CRM.COM R10.0.0 |
Log Information Object | The log information relatedwiththe retrieved credit note | |
| credit_note_item_set | Set of invoice item objects | A list of items which are credited by this credit note |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"number": "CT00000101",
"id": "D1A78308D64F9CDEC08FAE8287216E83",
"reference_number": "115"
},
{
"number": "CT00000102",
"id": "F19FC4591AEF34011F377DEF49D100AB",
"reference_number": "116"
}
]
}
HTTP Method: GET
Request:
Response:
{
"data": [
{
"number": "104",
"currency_rate_period": null,
"id": "94CEC3FC20AF4017900CF0BFF6F8A5F8"
},
{
"number": "73",
"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": "0ABC0B2A82614701B183612330385D6D"
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST credit_notes/create
This method is creating a new credit note 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 credit note should be allocated to. The allowed accounts receivable identifier fields are the following:
| ||||||||||||
type_identifier (mandatory) | Financial transaction type identifier | The financial transaction type of the credit note. The allowed financial transaction type identifier field are the following:
| ||||||||||||
life_cycle_state (mandatory) | String | The state of the retrieved credit note which can be one of the following: DRAFT, POSTED | ||||||||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the credit note that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||||||||
notes (optional) | String | Shared notes for the credit note | ||||||||||||
back_office_code (optional) | String | A back office code for the credit note. If specified then it should be unique | ||||||||||||
issue_reason (optional) | String | A description of the reason that the credit note is issued | ||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||||||||
(optional) | Set of invoice objects | The invoices that are intended to be credited | ||||||||||||
(mandatory) | Set of credit item objects | The items of the credit not |
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": "E55F0CADDDFEAC5C5F269A71039DDA40",
"accounts_receivable_identifier":{"number":"401"},
"type_identifier":{"name":"Credit Note 1"},
"life_cycle_state":"POSTED",
"category_identifier":{"name":"Credit Note Categories"},
"notes":"standard credit note",
"issue_reason":"Cancellation of prepaid service",
"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",
"invoices_to_credit_set":
[
{
"invoice_identifier":{"number":"I0010210"}
},
{
"invoice_identifier":{"number":"I0010211"}
}
],
"credit_note_item_set":
[
{
"product_identifier":{"code":"Smart Card"},
"quantity":2,
"cost":18,
"discount_amount":3,
"vat_rate_identifier":{"name":"Standard"},
"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": 33,
"issued_on": "2014-10-30T11:34:37",
"life_cycle_state": "POSTED",
"number": "CT00000158",
"id": "48E6B743D21A8F284EE0CB99805E4CF9",
"reference_number": "171",
"posted_on": "2014-10-30T11:36:27"
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR0000000214"},
"type_identifier":{"name":"Credit Note"},
"life_cycle_state":"POSTED",
"notes":"standard credit note",
"issue_reason":"Cancellation of prepaid service",
"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",
"credit_note_item_set":
[
{
"product_identifier":{"code":"Smartcard"},
"quantity":2,
"cost":18,
"discount_amount":3,
"vat_rate_identifier":{"name":"Standard"},
"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:04:02",
"number": "107",
"total_amount": 0,
"issued_on": "2016-07-05T15:04:02",
"currency_rate_period": null,
"id": "1D975E651947499EAC1733ED1E0EE6FD",
"life_cycle_state": "POSTED",
"reference_number": "38"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST credit_notes/post
This method is used to post a credit note which is in draft state.
Resource URL
Parameters
Name | Type | Description | |||||||||||||||
token | String | The token retrieved from the login method | |||||||||||||||
| credit_note_identifier (mandatory) | Credit note identifier | The identifier of the credit note that should be posted. Only credit notes in draft state can be specified.The allowed credit note identifier fields are the following:
|
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",
"credit_note_identifier":{"reference_number":"118"},
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"total_amount": 9,
"issued_on": "2014-07-14T14:26:04",
"life_cycle_state": "POSTED",
"number": "CT00000104",
"id": "6C918645DCFE24C866EF51986AB71E41",
"reference_number": "118",
"posted_on": "2014-07-14T14:26:50"
}
}
POST credit_notes/reject
This method is used to reject a credit note which is in draft state.
Resource URL
Parameters
Name | Type | Description | |||||||||||||||
token | String | The token retrieved from the login method | |||||||||||||||
| credit_note_identifier (mandatory) | Credit note identifier | The identifier of the credit note that should be posted. Only credit notes in draft state can be specified.The allowed credit note identifier fields are the following:
| |||||||||||||||
| rejection_reason_identifier | Rejection reason identifier | The reason that the credit note is rejected. The allowed rejection reason identifier fields are the following:
|
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",
"credit_note_identifier":{"reference_number":"119"},
"rejection_reason_identifier":{"name":"Reject Due to Business Request"},
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"total_amount": 18,
"issued_on": "2014-07-14T14:28:51",
"life_cycle_state": "REJECTED",
"number": null,
"id": "FFB55C221FE17BF201AEAF2E5A504E94",
"reference_number": "119",
"posted_on": null
}
}
POST credit_notes/update
Available from CRM.COM R9.1.0
This method is updating a single Credit Note but only as long as it is in Draft life cycle state
Resource URL
Parameters
Name | Type | Description | |||||||||||||||
token | String | The token retrieved from the login method | |||||||||||||||
credit_note_identifier (mandatory) | Credit Note identifier | The identifier of the credit note that should be updated. Only credit notes in draft state can be specified.The allowed credit note identifier fields are the following:
| |||||||||||||||
| accounts_receivable_identifier (optional) | Accounts receivable identifier | The identifier of the accounts receivable in which the credit note should be allocated to. The allowed accounts receivable identifier fields are the following:
| |||||||||||||||
type_identifier (optional) | Financial transaction type identifier | The financial transaction type of the credit note. Only financial transaction types with classification Credit Note can be specified. The allowed financial transaction type identifier field are the following:
| |||||||||||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the credit note that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| |||||||||||||||
notes (optional) | String | Shared notes for the credit note | |||||||||||||||
back_office_code (optional) | String | A back office code for the credit note. If specified then it should be unique
| |||||||||||||||
issue_reason (optional) | String | A description of the reason that the credit note is issued | |||||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String | |||||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String | |||||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String | |||||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String | |||||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String | |||||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String | |||||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String | |||||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String | |||||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | |||||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | |||||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | |||||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | |||||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | |||||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | |||||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | |||||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | |||||||||||||||
(optional) | Set of invoice objects | The invoices that are intended to be credited 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",
...........
}
]
| |||||||||||||||
(optional) | Set of credit item objects | The items of the credit note 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 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
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved credit note |
| number | String | The number of the retrieved credit note |
| reference_number | String | The reference number of the retrieved credit note |
| life_cycle_state | String | The state of the retrieved credit note which can be one of the following: DRAFT, REJECTED, POSTED, CANCELLED |
| discount_amount | Number | The total discount amount provided by the credit note |
| vat_amount | Number | The total VAT amount applied on the credit note Deprecated from CRM.COM R17.0.0 |
| tax_amount | Number | The total Tax amount applied on the credit note Available from CRM.COM R12.0.0 |
| net_amount | Number | The total net amount of the credit note |
| total_amount | Number | The total amount which is credited |
| issued_on | Date | The date that the credit note was issued |
| posted_on | Date | The date that the credit note was posted |
| notes | String | Shared notes for the credit note |
| back_office_code | String | The back office code of the retrieved credit note |
| issue_reason | String | A description of the reason that the credit note is issued |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field 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 Credit Note was issued against a parent accounts receivable which fund the member accounts of its group. |
| type | Financial transaction type object | The financial transaction type of this credit note |
| category | Financial transaction category object | The category of the credit note |
| rejection_reason | Financial transaction rejection reason object | The reason that the credit note was rejected |
| accounting_period_information | Accounting Period Information object | The Accounting Period Information of the credit note which includes the Accounting period of the credit note and the date on which it was set. This is applicable only if the credit note is processed during an Accounting Period Closing process |
| currency_rate_period | Currency Rate Period object | The currency rate period based on which the credit note's amounts were calculated Available from CRM.COM R10.0.0 |
Log Information Object | The log information relatedwiththe retrieved credit note | |
| credit_note_item_set | Set of invoice item objects | A list of items which are credited by this credit note |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"BBF4751F690743CD860E518662A15026",
"credit_note_identifier":{"reference_number":"145"},
"accounts_receivable_identifier":{"name":"CityFlat Sub"},
"type_identifier":{"name":"Credit Note 2"},
"category_identifier":{"name":"Global Categories"},
"back_office_code":"CRN000001",
"notes":"Credit note",
"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",
"invoices_to_credit_set":
[
{
"action":"add",
"invoice_identifier":{"number":"I00000173"}
}
],
"credit_note_item_set":
[
{
"action":"remove",
"credit_note_item_identifier":{"id":"4B47E5F350EA4F98959FDECA4E2E87DD"}
},
{
"action":"add",
"product_identifier":{"code":"Smartcard 2"},
"quantity":2,
"sub_total":15,
"discount_amount":5,
"vat_rate_identifier":{"name":"Zero"}
}
]
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"notes": "Marios Lannister\t4/5/2016 15:48:24\tCredit note\tMarios Lannister\t4/5/2016 15:55:05\tCredit note\tMarios Lannister\t4/5/2016 15:55:28\tCredit note\tMarios Lannister\t4/5/2016 15:56:29\tCredit note\tMarios Lannister\t4/5/2016 15:56:43\tCredit note\tMarios Lannister\t4/5/2016 16:08:54\tCredit note\tMarios Lannister\t4/5/2016 16:11:11\tCredit note",
"udf_float_1": 10,
"udf_float_2": 20,
"udf_float_3": 30,
"number": null,
"udf_float_4": 40,
"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": "Clark",
"middle_name": "S.",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mrs",
"first_name": "Kathy",
"type": "PERSON",
"id": "460BB0DB7A4EB61D9D6E3DFEE8566C08",
"name": null,
"company_name": null,
"demographics": {
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": "88996633",
"passport_number": "4564455",
"industry_sector": null,
"name_day": {
"month": 1,
"day": 1
},
"date_of_birth": {
"month": 1,
"day": 1,
"year": 1980
},
"id_number": "87878000",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "253",
"id": "3CCC9B1B4D2AB43F57E49751DF63B916",
"name": "CityFlat Sub"
},
"discount_amount": 10,
"id": "E391DC06C890D7A58D73DA030B922B01",
"credit_note_item_set": [
{
"vat_percentage": 0,
"sub_total": 15,
"discount_amount": 5,
"vat_rate": {
"id": "EDE5318C0AA394902E8C7DAE0227CB01",
"name": "Zero",
"description": "No VAT applied",
"alternative_code": "ZR"
},
"discount_percentage": 25,
"net_amount": 20,
"id": "4B47E5F350EA4F98959FDECA4E2E87DD",
"quantity": 2,
"cost": 10,
"vat_amount": 0,
"product": {
"id": "80EEE8F6F46767AE32E6ABE68603E9F2",
"description": "SmartCards 2",
"code": "Smartcard 2",
"alternative_code": "SC2"
}
},
{
"vat_percentage": 0,
"sub_total": 15,
"discount_amount": 5,
"vat_rate": {
"id": "EDE5318C0AA394902E8C7DAE0227CB01",
"name": "Zero",
"description": "No VAT applied",
"alternative_code": "ZR"
},
"discount_percentage": 25,
"net_amount": 20,
"id": "C96703BE1CDA47B0889DED7AA83445DA",
"quantity": 10,
"cost": 2,
"vat_amount": 0,
"product": {
"id": "80EEE8F6F46767AE32E6ABE68603E9F2",
"description": "SmartCards 2",
"code": "Smartcard 2",
"alternative_code": "SC2"
}
},
{
"vat_percentage": 0,
"sub_total": 15,
"discount_amount": 5,
"vat_rate": {
"id": "EDE5318C0AA394902E8C7DAE0227CB01",
"name": "Zero",
"description": "No VAT applied",
"alternative_code": "ZR"
},
"discount_percentage": 25,
"net_amount": 20,
"id": "A54EE4337C6144D196B521BC7CECF92D",
"quantity": 2,
"cost": 10,
"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"
}
}
],
"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",
"issue_reason": null,
"udf_date_4": "2014-08-05T15:49:59",
"vat_amount": 0,
"log_information": {
"updated_date": "2016-05-04T13:11:16",
"created_date": "2014-11-05T13:08:37",
"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": "2014-11-06T00:00:00",
"total_amount": 30,
"life_cycle_state": "DRAFT",
"back_office_code": "CRN000001",
"rejection_reason": null,
"type": {
"classification": "CREDIT_NOTE",
"id": "CD0946E1DB7D9524000E72DAC88AB124",
"name": "Credit Note 2",
"description": "Credit Note 2",
"alternative_code": "CN2"
},
"net_amount": 40,
"reference_number": "145",
"category": {
"id": "A2BC929D02D8CA9E6C2C639A91DFBE4B",
"name": "Global Categories",
"description": "Global Categories",
"code": "GC"
}
}
}
{
"data": [
{
"number": "104",
"currency_rate_period": null,
"id": "94CEC3FC20AF4017900CF0BFF6F8A5F8"
},
{
"number": "73",
"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": "0ABC0B2A82614701B183612330385D6D"
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}