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:

Name

Type

Description

id

(semi-optional)

String

The ID of the credit note

number

(semi-optional)

String

The number of the credit note

reference_number

(semi-optional)

String

The reference number of  the credit note

back_office_code

(semi-optional)

String

The back office code of the credit note

Available from CRM.COM R9.1.0

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_numberStringThe reference number of the retrieved credit note
life_cycle_stateString

The state of the retrieved credit note which can be one of the following:

DRAFT, REJECTED, POSTED, CANCELLED

discount_amountNumberThe total discount amount provided by the credit note
vat_amountNumber

The total VAT amount applied on the credit note

Deprecated from CRM.COM R17.0.0

tax_amountNumber

The total Tax amount applied on the credit note

Available from CRM.COM R12.0.0

net_amountNumberThe total net amount of the credit note
total_amountNumberThe total amount which is credited
issued_onDateThe date that the credit note was issued
posted_onDateThe date that the credit note was posted
notesStringShared notes for the credit note
back_office_codeString

The back office code of the retrieved credit note

Available from CRM.COM R9.1.0

issue_reasonStringA 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_receivableAccounts receivable objectThe related accounts receivable
member_accountAccounts 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.

Available from CRM.COM R13.0.0

typeFinancial transaction type objectThe financial transaction type of this credit note
categoryFinancial transaction category objectThe category of the credit note
rejection_reasonFinancial transaction rejection reason objectThe reason that the credit note was rejected
accounting_period_informationAccounting 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

Available from CRM.COM R10.0.0

currency_rate_periodCurrency 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

Log Information Object

The log information relatedwiththe retrieved credit note

credit_note_item_setSet of invoice item objectsA list of items which are credited by this credit note

Referred Objects Response Data

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe name of the retrieved accounts receivable

life_cycle_state

String

The life cycle state of the accounts receivable. One of the following values is returned:

ACTIVE, SUSPENDED, TERMINATED

account_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

type

String

The type of the retrieved contact information which can be PERSON or COMPANY

life_cycle_state

String

The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL

name

String

The full name of the retrieved contact information

first_name

String

The first name of the retrieved contact information

middle_name

String

The middle name of the retrieved contact information

last_name

String

The last name of the retrieved contact information

title

String

The title of the retrieved contact information

company_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

The gender of the retrieved contact information which can be MALE or FEMALE

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

The ID number's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 financial_transaction_type response data object
NameType Description
IdStringThe ID of the retrieved financial transaction type
nameStringThe Name of the retrieved financial transaction type
alternative_codeStringThe Alternative code of the retrieved financial transaction type
descriptionStringThe Description of the retrieved financial transaction type
classificationSting

The Classification of the retrieved financial transaction category which can be one of the following:

INVOICE, INVOICE_CANCELLATION, CREDIT_NOTE, PAYMENT, PAYMENT_CANCELLATION, REFUND, WRITE_OFF

WRITE_OFF classification is available from CRM.COM R13.0.0

 financial_transaction_category response data object
NameType Description
IdStringThe ID of the retrieved financial transaction category
nameStringThe Name of the retrieved financial transaction category
codeStringThe code of the retrieved financial transaction category
descriptionStringThe Description of the retrieved financial transaction category

 rejection_reason response data object
NameType Description
IdStringThe ID of the retrieved financial transaction rejection reason
nameStringThe Name of the retrieved financial transaction rejection reason
alternative_codeStringThe Alternative code of the retrieved financial transaction rejection reason
descriptionStringThe Description of the retrieved financial transaction rejection reason

 credit note item object response data

Name

Type

Description

id

String

The ID of the retrieved credit note item

quantitynumberThe quantity of the product
costnumberThe cost of the product
net_amountnumberThe net amount for the specified product, as calculated by the system
discount_percentagenumberThe discount percentage that is applied
discount_amountnumberThe discount amount that is applied
vat_percentagenumber

The VAT percentage that is applied, based on the selected VAT rate

Deprecated from CRM.COM R17.0.0

vat_amountnumber

The VAT amount that is applied, based on the selected VAT rate

Deprecated from CRM.COM R17.0.0

tax_amountnumber

The total Tax amount applied

Available from CRM.COM R12.0.0

sub_totalnumberThe total amount that will be credited for the specified product
productProduct objectThe product that was credited
vat_rateVAT rate object

The VAT rate that is applied

Deprecated from CRM.COM R17.0.0

applied_tax_ratesSet of Tax Rate Objects

The Tax Rate(s) applied on the credit note item

Available from CRM.COM R12.0.0

Referred Objects Response Data

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_typeMeter Reading Type

The Meter Reading type related with the product type. This is applicable only for traceable physical goods

Available from CRM.COM R14.0.0

Referred Objects Response Data

 usage_detail_record_type object data response
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 global rate object response data

Name

Type

Description

id

String

The ID of the retrieved rate

rate_model

String

The price plan rate model which can be one of the following:

  • QUANTITYBASED
  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED
  • DURATIONBASED
  • FLATFEEBASED
  • USAGEBASED

From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

Available when the rate model is 'Quantity & Quantity Based' and it is a selection between

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

 vat_rate response data object
NameType Description
IdStringThe ID of the retrieved vat rate
nameStringThe Name of the retrieved vat rate
alternative_codeStringThe Alternative Code of the retrieved vat rate
descriptionStringThe Description of the retrieved vat rate

 applied_taxes response data object
NameTypeDescription
tax_amountNumberThe amount of tax that was applied by the related Tax Rate
tax_percentageNumberThe percentage of the applied Tax Rate.
tax_ratesTax Rate ObjectThe Tax Rate that was applied

Referred Objects Response Data

 tax_rate response data object
NameType Description
idStringThe ID of the retrieved Tax rate
nameStringThe Name of the retrieved Tax rate
alternative_codeStringThe Alternative Code of the retrieved Tax rate
descriptionStringThe Description of the retrieved Tax rate

 accounting period information object response data

Name

Type

Description

accounting_period_date

Date

The Date on which the Accounting Period was set on the financial transaction

 accounting_period

Accounting Period Object

The Accounting Period of the financial transaction.

Referred Objects Response Data

 accounting period object response data

Name

Type

Description

number

String

The Accounting Period's number

name

String

The Accounting Period's name

from_dateDateThe Accounting Period's from date
to_dateDateThe Accounting Period's to date
life_cycle_stateStingThe Accounting Period's life cycle state. Available values are OPEN and CLOSED
closed_dateDateThe Accounting Period's closed date. Available only for Accounting Periods in Closed life cycle state

 currency rate period object response data

Name

Type

Description

id

String

The ID of the retrieved currency rate period

rateNumberThe exchange rate of the currency rate period
inverse_rateNumberThe inverse exchange rate of the currency rate period
from_dateDateThe date from which the exchange rate is valid
to_dateDateThe date until which the exchange rate is valid
currencyCurrency ObjectThe Currency with which the returned exchange rate information refers to

Referred Objects Response Data

 currency object response data

Name

Type

Description

id

String

The ID of the retrieved currency

code

String

The code of the retrieved currency

prefix_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE

Available from CRM.COM R14.0.0

integer_part_nameStringThe integer part name for the specified currency
decimal_part_nameStringThe decimal part name for the specified currency

 log_information object response data

Name

Type

Description

created_date

Date

The date that the retrieved record was created

updated_date

Date

The last date that the retrieved record was updated

created_by_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

created_by_business_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Available from CRM.COM R18.0.0

created_by_user

User Object

The user that created the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

updated_by_unit

Unit Object

The last unit that updated the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

updated_by_business_unit

Unit Object

The last unit that updated the retrieved record

Available from CRM.COM R18.0.0

updated_by_user

User Object

The last user that updated the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

Examples

 Example 1

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"
        }
    }
}
 Example 2

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": ""
  }
}