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:

Name	Type	Description
id (semi-optional)	String	The ID of the invoice
number (semi-optional)	String	The number of the invoice
reference_number (semi-optional)	String	The reference number of the invoice
back_office_code (semi-optional)	String	The back office code of the invoice 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 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 Available from CRM.COM R9.1.0
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. Available from CRM.COM R13.0.0
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 Available from CRM.COM R10.0.0
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	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

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
name	String	The 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_owner	Contact information object	The 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_name	Sting	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_date	Date	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_date	Date	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_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image 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
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The 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_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	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_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image 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
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The 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

Name	Type	Description
Id	String	The ID of the retrieved financial transaction type
name	String	The Name of the retrieved financial transaction type
alternative_code	String	The Alternative code of the retrieved financial transaction type
description	String	The Description of the retrieved financial transaction type
classification	Sting	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

Name	Type	Description
Id	String	The ID of the retrieved financial transaction category
name	String	The Name of the retrieved financial transaction category
code	String	The code of the retrieved financial transaction category
description	String	The Description of the retrieved financial transaction category

rejection_reason response data object

Name	Type	Description
Id	String	The ID of the retrieved financial transaction rejection reason
name	String	The Name of the retrieved financial transaction rejection reason
alternative_code	String	The Alternative code of the retrieved financial transaction rejection reason
description	String	The Description of the retrieved financial transaction rejection reason

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_date	Date	The Accounting Period's from date
to_date	Date	The Accounting Period's to date
life_cycle_state	Sting	The Accounting Period's life cycle state. Available values are OPEN and CLOSED
closed_date	Date	The 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
rate	Number	The exchange rate of the currency rate period
inverse_rate	Number	The inverse exchange rate of the currency rate period
from_date	Date	The date from which the exchange rate is valid
to_date	Date	The date until which the exchange rate is valid
currency	Currency Object	The 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_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The 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
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The 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

invoice item object response data

Name	Type	Description
id	String	The ID of the retrieved invoice item
quantity	Number	The quantity of the product
cost	Number	The cost of the product
net_amount	Number	The net amount for the specified product, as calculated by the system
discount_percentage	Number	The discount percentage that is applied
discount_amount	Number	The discount amount that is applied
vat_percentage	Number	The VAT percentage that is applied, based on the selected VAT rate Deprecated from CRM.COM R17.0.0
vat_amount	Number	The VAT amount that is applied, based on the selected VAT rate Deprecated from CRM.COM R17.0.0
tax_amount	Number	The Tax Amount that is applied based on Tax Rates. Available from CRM.COM R12.0.0
sub_total	Number	The total amount that will be invoiced for the specified product
product	Product object	The product that was invoiced
vat_rate	VAT rate object	The VAT rate that is applied Deprecated from CRM.COM R17.0.0
applied_tax_rates	Set of Applied Tax Rates	A list of Tax Rates applied on the invoice item Available from CRM.COM R12.0.0

Referred Objects Response Data

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The 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_type	Meter 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

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The 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_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The 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_code	String	The 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_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	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
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	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_value

Number

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

Name	Type	Description
Id	String	The ID of the retrieved vat rate
name	String	The Name of the retrieved vat rate
alternative_code	String	The Alternative Code of the retrieved vat rate
description	String	The Description of the retrieved vat rate

applied_taxes response data object

Name	Type	Description
tax_amount	Number	The amount of tax that was applied by the related Tax Rate
tax_percentage	Number	The percentage of the applied Tax Rate.
tax_rates	Tax Rate Object	The Tax Rate that was applied

Referred Objects Response Data

tax_rate response data object

Name	Type	Description
id	String	The ID of the retrieved Tax rate
name	String	The Name of the retrieved Tax rate
alternative_code	String	The Alternative Code of the retrieved Tax rate
description	String	The Description of the retrieved Tax rate

Examples

Example 1

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

Example 2

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

Example 3

HTTP Method: GET

Request:

Response:

{
  "data": {
    "tax_amount": 0,
    "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": "2017-04-05T17:28:29",
      "updated_date": "2017-04-05T17:28:29",
      "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": 4,
    "currency_rate_period": null,
    "udf_date_2": null,
    "type": {
      "alternative_code": "INV",
      "name": "Invoice",
      "description": null,
      "id": "INVOICE",
      "classification": "INVOICE"
    },
    "udf_date_1": null,
    "due_on": "2017-04-07T17:28:29",
    "udf_date_4": null,
    "udf_date_3": null,
    "invoice_item_set": [
      {
        "tax_amount": 0,
        "product": {
          "code": "Sports 1",
          "product_type": {
            "service_type": "TERMED",
            "used_for_provisioning": true,
            "alternative_code": "AS",
            "composition_method": "FLAT",
            "name": "Additional Services",
            "description": null,
            "id": "C8321F0BCA8A4051857BC35CEEE41555",
            "classification": "SERVICES",
            "physical_good_type": null
          },
          "alternative_code": "S1",
          "description": "Sports 1",
          "id": "02191FFC231D4FBD844D0BB66EBAB14B"
        },
        "quantity": 2,
        "cost": 10,
        "applied_tax_rates": [],
        "discount_amount": 1,
        "discount_percentage": 5,
        "vat_amount": 4.75,
        "sub_total": 23.75,
        "id": "029FF402294B41D7935DC4D7A95DFC2D",
        "net_amount": 20,
        "vat_percentage": 25,
        "vat_rate": {
          "alternative_code": "S_1",
          "name": "Standard(VATS)",
          "description": null,
          "id": "D8159982FCBE4316BEAD4F6E761FB40D"
        }
      },
      {
        "tax_amount": 0,
        "product": {
          "code": "Gold",
          "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": "G",
          "description": "Gold",
          "id": "D1EB074DFD904E54A0C67CAB9DC7E010"
        },
        "quantity": 1,
        "cost": 30,
        "applied_tax_rates": [],
        "discount_amount": 3,
        "discount_percentage": 10,
        "vat_amount": 6.75,
        "sub_total": 33.75,
        "id": "B892F4D76E994DF5AB20FC6C19D2F1ED",
        "net_amount": 30,
        "vat_percentage": 25,
        "vat_rate": {
          "alternative_code": "S_1",
          "name": "Standard(VATS)",
          "description": null,
          "id": "D8159982FCBE4316BEAD4F6E761FB40D"
        }
      }
    ],
    "number": "I00002949",
    "udf_float_3": null,
    "udf_float_4": null,
    "vat_amount": 11.5,
    "rejection_reason": null,
    "id": "2415A59E46F347CAB2392B4A000EB0A1",
    "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": "ACR0000008050",
      "name": "ACR0000008050",
      "id": "CFAA158682CA46F6BBED269342487732",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "Test Parent",
        "last_name": "Parent",
        "id": "BB44D23D6B3E4BDAA3E38E13708F9E8B",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Test",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "1234567",
          "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": "2762",
    "member_account": {
      "number": "ACR0000008052",
      "name": "ACR0000008052",
      "id": "00C60616F63148229B01E7FEFEF5B825",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": null,
        "last_name": "Member_2",
        "id": "FA724A77310B44839860956A9451AFBD",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Test",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": null,
          "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
        }
      }
    },
    "posted_on": "2017-04-05T17:28:29",
    "total_amount": 57.5,
    "unsettled_amount": 57.5,
    "issued_on": "2017-04-05T17:28:29",
    "net_amount": 50,
    "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:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the financial transaction type

name

(semi-optional)

String

The name of the financial transaction type

alternative_code

(semi-optional)

String

The alternative code of the financial transaction type

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the financial transaction category

name

(semi-optional)

String

The name of the financial transaction category

code

(semi-optional)

String

The code of the financial transaction category

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 Available from CRM.COM R9.1.0
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. Available from CRM.COM R13.0.0
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 Available from CRM.COM R10.0.0
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	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

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
name	String	The 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_owner	Contact information object	The 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_name	Sting	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_date	Date	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_date	Date	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_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image 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
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The 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_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	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_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image 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
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The 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

Name	Type	Description
Id	String	The ID of the retrieved financial transaction type
name	String	The Name of the retrieved financial transaction type
alternative_code	String	The Alternative code of the retrieved financial transaction type
description	String	The Description of the retrieved financial transaction type
classification	Sting	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

Name	Type	Description
Id	String	The ID of the retrieved financial transaction category
name	String	The Name of the retrieved financial transaction category
code	String	The code of the retrieved financial transaction category
description	String	The Description of the retrieved financial transaction category

rejection_reason response data object

Name	Type	Description
Id	String	The ID of the retrieved financial transaction rejection reason
name	String	The Name of the retrieved financial transaction rejection reason
alternative_code	String	The Alternative code of the retrieved financial transaction rejection reason
description	String	The Description of the retrieved financial transaction rejection reason

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_date	Date	The Accounting Period's from date
to_date	Date	The Accounting Period's to date
life_cycle_state	Sting	The Accounting Period's life cycle state. Available values are OPEN and CLOSED
closed_date	Date	The 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
rate	Number	The exchange rate of the currency rate period
inverse_rate	Number	The inverse exchange rate of the currency rate period
from_date	Date	The date from which the exchange rate is valid
to_date	Date	The date until which the exchange rate is valid
currency	Currency Object	The 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_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The 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
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The 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

invoice item object response data

Name	Type	Description
id	String	The ID of the retrieved invoice item
quantity	Number	The quantity of the product
cost	Number	The cost of the product
net_amount	Number	The net amount for the specified product, as calculated by the system
discount_percentage	Number	The discount percentage that is applied
discount_amount	Number	The discount amount that is applied
vat_percentage	Number	The VAT percentage that is applied, based on the selected VAT rate Deprecated from CRM.COM R17.0.0
vat_amount	Number	The VAT amount that is applied, based on the selected VAT rate Deprecated from CRM.COM R17.0.0
tax_amount	Number	The Tax Amount that is applied based on Tax Rates. Available from CRM.COM R12.0.0
sub_total	Number	The total amount that will be invoiced for the specified product
product	Product object	The product that was invoiced
vat_rate	VAT rate object	The VAT rate that is applied Deprecated from CRM.COM R17.0.0
applied_tax_rates	Set of Applied Tax Rates	A list of Tax Rates applied on the invoice item Available from CRM.COM R12.0.0

Referred Objects Response Data

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The 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_type	Meter 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

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The 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_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The 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_code	String	The 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_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	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
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	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_value

Number

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

Name	Type	Description
Id	String	The ID of the retrieved vat rate
name	String	The Name of the retrieved vat rate
alternative_code	String	The Alternative Code of the retrieved vat rate
description	String	The Description of the retrieved vat rate

applied_taxes response data object

Name	Type	Description
tax_amount	Number	The amount of tax that was applied by the related Tax Rate
tax_percentage	Number	The percentage of the applied Tax Rate.
tax_rates	Tax Rate Object	The Tax Rate that was applied

Referred Objects Response Data

tax_rate response data object

Name	Type	Description
id	String	The ID of the retrieved Tax rate
name	String	The Name of the retrieved Tax rate
alternative_code	String	The Alternative Code of the retrieved Tax rate
description	String	The Description of the retrieved Tax rate

Examples

Example 1

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

Example 2

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

type_identifier

(mandatory)

Financial transaction type identifier

The financial transaction type of the invoice. The allowed financial transaction type identifier field are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the financial transaction type

name

(semi-optional)

String

The name of the financial transaction type

alternative_code

(semi-optional)

String

The alternative code of the financial transaction type

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the financial transaction category

name

(semi-optional)

String

The name of the financial transaction category

code

(semi-optional)

String

The code of the financial transaction category

member_accounts_receivable_identifier

(optional)

Accounts Receivable Identifier

The member accounts receivable. Applicable only if the Invoice is issued against a parent accounts receivable within a group which funds its members. The allowed accounts receivable identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

due_on

(optional)

Date

The date that the credit period for that specific invoice is ending.

intended_currency_identifier

(optional)

Currency Identifier

The currency that the user was intended to use for the invoice. If specified then it is validated against the currency of the specified accounts receivable and if they don't match then an error is thrown. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the currency

code

(semi-optional)

String

The code of the currency

Available from CRM.COM R11.0.0

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

Available from CRM.COM R9.1.0

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

(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

invoice_item parameter object data

Name

Type

Description

product_identifier

(mandatory)

Products identifier

The product that will be related with the invoice item. The allowed product identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

installed_item_identifier

(mandatory based on conditions)

Installed Item identifier

The installed item sold to the account owner. Mandatory only if the physical good sold is a traceable item. The allowed installed item identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of a installed item

Available from CRM.COM R15.0.0

Deprecated from CRM.COM R17.0.0

from_warehouse

(optional on conditions)

String

The warehouse from which the installed items will be sold to the Partner. Applicable and mandatory only if the Accounts Receivable selected is related to a Partner that owns a warehouse as well. Only the Warehouses which are not owned by any Partner Group can be provided.

Name

Type

Description

id

(semi-optional)

String

The ID of the warehouse

name

(semi-optional)

String

The name of the warehouse

alternative_code

(semi-optional)

String

The alternative code of the warehouse

Available from CRM.COM R15.0.0

to_warehouse

(optional on conditions)

String

The warehouse to which the installed items sold to the Partner are moved to. Applicable and mandatory only if the Accounts Receivable selected is related to a Partner owning a Warehouse. Only the Warehouses owned by the specified Partner Group can be provided.

Name

Type

Description

id

(semi-optional)

String

The ID of the warehouse

name

(semi-optional)

String

The name of the warehouse

alternative_code

(semi-optional)

String

The alternative code of the warehouse

Available from CRM.COM R15.0.0

quantity

(mandatory)

number

The quantity of the product.

From CRM.COM R15.0.0, the quantity is applicable if the product provided is non-traceable

cost

(semi-optional)

number

The cost of the product. Cost cannot be specified if the sub total is specified

From CRM.COM R15.0.0, the cost or sub-total will be automatically provided by the pricing strategy thus they are not mandatory. If provided, then the specified value will be considered

discount_percentage

(optional)

number

The discount percentage that is applied. Discount percentage cannot be specified if the discount amount is specified.

From CRM.COM R15.0.0, discount_percentage should not be available for stockable physical goods.

discount_amount

(optional)

number

The discount amount that is applied. Discount amount cannot be specified if the discount percentage is specified

From CRM.COM R15.0.0, discount_amount should not be available for stockable physical goods.

vat_rate_identifier

(optional)

VAT rate identifier

The VAT rate that should be applied. If not specified then the VAT rate specified on the product will be applied. The allowed VAT rate identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the VAT rate

name

(semi-optional)

String

The name of the VAT rate

alternative_code

(semi-optional)

String

The alternative code of the VAT rate

Deprecated from CRM.COM R12.0.0

sub_total

(semi-optional)

number

The total amount that will be invoiced for the specified product. Sub total cannot be specified if the cost is specified

From CRM.COM R15.0.0, the cost or sub-total will be automatically provided by the pricing strategy thus they are not mandatory. If provided, then the specified value will be considered

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

installed_items_set

(mandatory based on conditions, applicable on add or remove)

Set of Installed Items

Defines a set of Installed Items to be sold to he account owner through the related Invoice. Applicable and mandatory (at least one installed item must be specified) only if the physical good sold is a traceable item.

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",
            	...........
			}
		]

Available from CRM.COM R17.0.0

Referred Parameter Objects Data

finacial_transaction_line_item parameter object data

Name

Type

Description

installed_item_identifier

(mandatory)

Installed Item identifier

The installed item which is related to the financial transaction line item. The allowed installed item identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of a installed item

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

invoice object 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 life cycle state of the invoice. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED
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 credit period for that specific invoice is ending.
total_amount	Number	The total amount of the invoice
outstanding_amount	Number	The total outstanding amount of the invoice
unsettled_amount	Number	The total unsettled amount of the invoice
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

Referred Objects Response Data

currency rate period object response data

Name	Type	Description
id	String	The ID of the retrieved currency rate period
rate	Number	The exchange rate of the currency rate period
inverse_rate	Number	The inverse exchange rate of the currency rate period
from_date	Date	The date from which the exchange rate is valid
to_date	Date	The date until which the exchange rate is valid
currency	Currency Object	The 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_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

Examples

Example 1

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

Example 2

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

Example 3

HTTP Method: POST

Request:

Body:

{
    "token": "{{token}}",
    "accounts_receivable_identifier":{"number":"ACR0000008050"},
    "type_identifier":{"name":"Invoice"},
    "life_cycle_state":"POSTED",
    "member_accounts_receivable_identifier":{"number":"ACR0000008052"},
    "invoice_item_set":
    [
        {
            "product_identifier":{"code":"Gold"},
            "quantity":1,
            "cost":30,
            "discount_percentage":10,
            "vat_rate_identifier":{"name":"Standard"}
        },
         {
            "product_identifier":{"code":"Sports 1"},
            "quantity":2,
            "cost":10,
            "discount_percentage":5,
            "vat_rate_identifier":{"name":"Standard"}
        }
    ]
}

Response:

{
  "data": {
    "posted_on": "2017-04-05T17:28:29",
    "number": "I00002949",
    "total_amount": 57.5,
    "unsettled_amount": null,
    "issued_on": "2017-04-05T17:28:29",
    "currency_rate_period": null,
    "id": "2415A59E46F347CAB2392B4A000EB0A1",
    "life_cycle_state": "POSTED",
    "outstanding_amount": null,
    "reference_number": "2762",
    "due_on": "2017-04-07T17:28:29"
  },
  "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:

Name	Type	Description
id (semi-optional)	String	The ID of the invoice
number (semi-optional)	String	The number of the invoice
reference_number (semi-optional)	String	The reference number of the invoice
back_office_code (semi-optional)	String	The back office code of the invoice 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

invoice object 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 life cycle state of the invoice. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED
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 credit period for that specific invoice is ending.
total_amount	Number	The total amount of the invoice
outstanding_amount	Number	The total outstanding amount of the invoice
unsettled_amount	Number	The total unsettled amount of the invoice
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

Referred Objects Response Data

currency rate period object response data

Name	Type	Description
id	String	The ID of the retrieved currency rate period
rate	Number	The exchange rate of the currency rate period
inverse_rate	Number	The inverse exchange rate of the currency rate period
from_date	Date	The date from which the exchange rate is valid
to_date	Date	The date until which the exchange rate is valid
currency	Currency Object	The 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_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

Examples

Example 1

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

Example 2

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:

Name	Type	Description
id (semi-optional)	String	The ID of the invoice
number (semi-optional)	String	The number of the invoice
reference_number (semi-optional)	String	The reference number of the invoice
back_office_code (semi-optional)	String	The back office code of the invoice Available from CRM.COM R9.1.0

rejection_reason_identifier

Rejection reason identifier

The reason that the invoice is rejected. The allowed rejection reason identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the rejection reason

name

(semi-optional)

String

The name of the rejection reason

alternative_code

(semi-optional)

String

The alternative code of the rejection reason

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

invoice object 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 life cycle state of the invoice. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED
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 credit period for that specific invoice is ending.
total_amount	Number	The total amount of the invoice
outstanding_amount	Number	The total outstanding amount of the invoice
unsettled_amount	Number	The total unsettled amount of the invoice
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

Referred Objects Response Data

currency rate period object response data

Name	Type	Description
id	String	The ID of the retrieved currency rate period
rate	Number	The exchange rate of the currency rate period
inverse_rate	Number	The inverse exchange rate of the currency rate period
from_date	Date	The date from which the exchange rate is valid
to_date	Date	The date until which the exchange rate is valid
currency	Currency Object	The 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_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

Examples

Example 1

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

Example 1

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:

Name	Type	Description
id (semi-optional)	String	The ID of the invoice
number (semi-optional)	String	The number of the invoice
reference_number (semi-optional)	String	The reference number of the invoice
back_office_code (semi-optional)	String	The back office code of the invoice Available from CRM.COM R9.1.0

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the financial transaction type

name

(semi-optional)

String

The name of the financial transaction type

alternative_code

(semi-optional)

String

The alternative code of the financial transaction type

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the financial transaction category

name

(semi-optional)

String

The name of the financial transaction category

code

(semi-optional)

String

The code of the financial transaction category

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

Available from CRM.COM R9.1.0

issue_reason

(optional)

String

A description of the reason that the invoice cancellation is issued

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

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

invoice object 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 life cycle state of the invoice. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED
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 credit period for that specific invoice is ending.
total_amount	Number	The total amount of the invoice
outstanding_amount	Number	The total outstanding amount of the invoice
unsettled_amount	Number	The total unsettled amount of the invoice
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

Referred Objects Response Data

currency rate period object response data

Name	Type	Description
id	String	The ID of the retrieved currency rate period
rate	Number	The exchange rate of the currency rate period
inverse_rate	Number	The inverse exchange rate of the currency rate period
from_date	Date	The date from which the exchange rate is valid
to_date	Date	The date until which the exchange rate is valid
currency	Currency Object	The 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_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

invoice cancellation object response data

Name	Type	Description
id	String	The ID of the retrieved invoice cancellation
number	String	The number of the retrieved invoice cancellation
reference_number	String	The reference number of the retrieved invoice cancellation
life_cycle_state	String	The life cycle state of the invoice cancellation. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED
issued_on	Date	The date that the invoice cancellation was issued
posted_on	Date	The date that the invoice cancellation was posted
total_amount	Number	The total amount of the invoice cancellation
currency_rate_period	Currency Rate Period	The currency rate period based on which the invoice cancellation was created Available from CRM.COM R10.0.0

Referred Objects Response Data

currency rate period object response data

Name	Type	Description
id	String	The ID of the retrieved currency rate period
rate	Number	The exchange rate of the currency rate period
inverse_rate	Number	The inverse exchange rate of the currency rate period
from_date	Date	The date from which the exchange rate is valid
to_date	Date	The date until which the exchange rate is valid
currency	Currency Object	The 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_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

Examples

Example 1

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

Example 2

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:

Name	Type	Description
id (semi-optional)	String	The ID of the invoice
number (semi-optional)	String	The number of the invoice
reference_number (semi-optional)	String	The reference number of the invoice
back_office_code (semi-optional)	String	The back office code of the invoice Available from CRM.COM R9.1.0

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the financial transaction type

name

(semi-optional)

String

The name of the financial transaction type

alternative_code

(semi-optional)

String

The alternative code of the financial transaction type

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the financial transaction category

name

(semi-optional)

String

The name of the financial transaction category

code

(semi-optional)

String

The code of the financial transaction category

member_accounts_receivable_identifier

(optional)

Accounts receivable identifier

The member accounts receivable. Applicable only if the invoice is issues against a parent accounts receivable which fund its member accounts. The allowed accounts receivable identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the currency

code

(semi-optional)

String

The code of the currency

Available from CRM.COM R11.0.0

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",
            	...........
			}
		]

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 Parameters Objects Data

invoice_item parameter object data

Name

Type

Description

action

(mandatory)

StringE

Defines if a new or existing information will be updated.The supported values are the following:

ADD, UPDATE, REMOVE

invoice_item_identifier

(mandatory and applicable only on update or remove)

Invoice Item Identifier

The identifier of the invoice item to be updated. The allowed invoice item identifier fields are the following:

Name

Type

Description

id

(mandatory)

String

The ID of the invoice item

product_identifier

(mandatory and applicable only on add)

Products identifier

The product that will be related with the invoice item. The allowed product identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

installed_item_identifier

(mandatory based on conditions)

Installed Item identifier

The installed item sold to the account owner. Mandatory only if the physical good sold is a traceable item. The allowed installed item identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of a installed item

Deprecated from CRM.COM R17.0.0

quantity

(mandatory and applicable on add, optional on update)

number

The quantity of the product

From CRM.COM R15.0.0, the quantity is applicable if the product provided is non-traceable

cost

(semi-optional and applicable on add, optional on update)

number

The cost of the product. Cost cannot be specified if the sub total is specified

From CRM.COM R15.0.0, the cost or sub-total will be automatically provided by the pricing strategy thus they are not mandatory. If provided, then the specified value will be considered

discount_percentage

(optional and applicable on add and update)

number

The discount percentage that is applied. Discount percentage cannot be specified if the discount amount is specified.

From CRM.COM R15.0.0, discount_percentage should not be available for stockable physical goods.

discount_amount

(optional and applicable on add and update)

number

The discount amount that is applied. Discount am

From CRM.COM R15.0.0, discount_amount should not be available for stockable physical goods.

ount cannot be specified if the discount percentage is specified

vat_rate_identifier

(optional and applicable on add and update)

VAT rate identifier

The VAT rate that should be applied. If not specified then the VAT rate specified on the product will be applied. The allowed VAT rate identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the VAT rate

name

(semi-optional)

String

The name of the VAT rate

alternative_code

(semi-optional)

String

The alternative code of the VAT rate

Deprecated from CRM.COM R12.0.0

sub_total

(semi-optional and applicable on add, optional on update)

number

The total amount that will be invoiced for the specified product. Sub total cannot be specified if the cost is specified

From CRM.COM R15.0.0, the cost or sub-total will be automatically provided by the pricing strategy thus they are not mandatory. If provided, then the specified value will be considered

udf_string_1

(optional and applicable on add and update)

String

User Defined Field of type String

udf_string_2

(optional and applicable on add and update)

String

User Defined Field of type String

udf_string_3

(optional and applicable on add and update)

String

User Defined Field of type String

udf_string_4

(optional and applicable on add and update)

String

User Defined Field of type String

udf_string_5

(optional and applicable on add and update)

String

User Defined Field of type String

udf_string_6

(optional and applicable on add and update)

String

User Defined Field of type String

udf_string_7

(optional and applicable on add and update)

String

User Defined Field of type String

udf_string_8

(optional and applicable on add and update)

String

User Defined Field of type String

udf_float_1

(optional and applicable on add and update)

Float

User Defined Field of type Float

udf_float_2

(optional and applicable on add and update)

Float

User Defined Field of type Float

udf_float_3

(optional and applicable on add and update)

Float

User Defined Field of type Float

udf_float_4

(optional and applicable on add and update)

Float

User Defined Field of type Float

udf_date_1

(optional and applicable on add and update)

Date

User Defined Field of type Date

udf_date_2

(optional and applicable on add and update)

Date

User Defined Field of type Date

udf_date_3

(optional and applicable on add and update)

Date

User Defined Field of type Date

udf_date_4

(optional and applicable on add and update)

Date

User Defined Field of type Date

installed_items_set

(mandatory based on conditions)

Set of Installed Items

Defines a set of Installed Items to be sold to the account owner through the related Invoice. Applicable and mandatory (at least one installed item must be specified) only if the physical good sold is a traceable item.

Available from CRM.COM R17.0.0

Referred Parameter Objects Data

finacial_transaction_line_item parameter object data

Name

Type

Description

installed_item_identifier

(mandatory)

Installed Item identifier

The installed item which is related to the financial transaction line item. The allowed installed item identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of a installed item

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 Available from CRM.COM R9.1.0
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. Available from CRM.COM R13.0.0
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 Available from CRM.COM R10.0.0
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	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

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
name	String	The 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_owner	Contact information object	The 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_name	Sting	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_date	Date	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_date	Date	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_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image 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
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The 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_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	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_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image 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
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The 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

Name	Type	Description
Id	String	The ID of the retrieved financial transaction type
name	String	The Name of the retrieved financial transaction type
alternative_code	String	The Alternative code of the retrieved financial transaction type
description	String	The Description of the retrieved financial transaction type
classification	Sting	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

Name	Type	Description
Id	String	The ID of the retrieved financial transaction category
name	String	The Name of the retrieved financial transaction category
code	String	The code of the retrieved financial transaction category
description	String	The Description of the retrieved financial transaction category

rejection_reason response data object

Name	Type	Description
Id	String	The ID of the retrieved financial transaction rejection reason
name	String	The Name of the retrieved financial transaction rejection reason
alternative_code	String	The Alternative code of the retrieved financial transaction rejection reason
description	String	The Description of the retrieved financial transaction rejection reason

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_date	Date	The Accounting Period's from date
to_date	Date	The Accounting Period's to date
life_cycle_state	Sting	The Accounting Period's life cycle state. Available values are OPEN and CLOSED
closed_date	Date	The 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
rate	Number	The exchange rate of the currency rate period
inverse_rate	Number	The inverse exchange rate of the currency rate period
from_date	Date	The date from which the exchange rate is valid
to_date	Date	The date until which the exchange rate is valid
currency	Currency Object	The 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_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The 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
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The 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

invoice item object response data

Name	Type	Description
id	String	The ID of the retrieved invoice item
quantity	Number	The quantity of the product
cost	Number	The cost of the product
net_amount	Number	The net amount for the specified product, as calculated by the system
discount_percentage	Number	The discount percentage that is applied
discount_amount	Number	The discount amount that is applied
vat_percentage	Number	The VAT percentage that is applied, based on the selected VAT rate Deprecated from CRM.COM R17.0.0
vat_amount	Number	The VAT amount that is applied, based on the selected VAT rate Deprecated from CRM.COM R17.0.0
tax_amount	Number	The Tax Amount that is applied based on Tax Rates. Available from CRM.COM R12.0.0
sub_total	Number	The total amount that will be invoiced for the specified product
product	Product object	The product that was invoiced
vat_rate	VAT rate object	The VAT rate that is applied Deprecated from CRM.COM R17.0.0
applied_tax_rates	Set of Applied Tax Rates	A list of Tax Rates applied on the invoice item Available from CRM.COM R12.0.0

Referred Objects Response Data

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The 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_type	Meter 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

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The 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_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The 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_code	String	The 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_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	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
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	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_value

Number

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

Name	Type	Description
Id	String	The ID of the retrieved vat rate
name	String	The Name of the retrieved vat rate
alternative_code	String	The Alternative Code of the retrieved vat rate
description	String	The Description of the retrieved vat rate

applied_taxes response data object

Name	Type	Description
tax_amount	Number	The amount of tax that was applied by the related Tax Rate
tax_percentage	Number	The percentage of the applied Tax Rate.
tax_rates	Tax Rate Object	The Tax Rate that was applied

Referred Objects Response Data

tax_rate response data object

Name	Type	Description
id	String	The ID of the retrieved Tax rate
name	String	The Name of the retrieved Tax rate
alternative_code	String	The Alternative Code of the retrieved Tax rate
description	String	The Description of the retrieved Tax rate

Examples

Example 1

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

Example 2

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

POST invoices/write_off

Available from CRM.COM R13.0.0

This method is used to write off a single invoice but only as long it is in Posted life cycle state and not fully allocated

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 written off. Only Invoices in Posted life cycle state are allowed to be specified and only as long as they are not paid. The allowed invoice identifier fields are the following:

Name	Type	Description
id (semi-optional)	String	The ID of the invoice
number (semi-optional)	String	The number of the invoice
reference_number (semi-optional)	String	The reference number of the invoice
back_office_code (semi-optional)	String	The back office code of the invoice Available from CRM.COM R9.1.0

type_identifier

(mandatory)

Financial transaction type identifier

The financial transaction type of the Write Off. The allowed financial transaction type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the financial transaction type

name

(semi-optional)

String

The name of the financial transaction type

alternative_code

(semi-optional)

String

The alternative code of the financial transaction type

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the Write Off. The allowed financial transaction category identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the financial transaction category

name

(semi-optional)

String

The name of the financial transaction category

code

(semi-optional)

String

The code of the financial transaction category

notes

(optional)

String

Shared notes for the Write off

back_office_code

(optional)

String

A back office code for the Write off. If specified then it should be unique

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

fields_set

(optional)

Lis of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

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 written off
write_off	Write Off object	The write off that was created

Referred Objects Response Data

invoice object 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 life cycle state of the invoice. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED
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 credit period for that specific invoice is ending.
total_amount	Number	The total amount of the invoice
outstanding_amount	Number	The total outstanding amount of the invoice
unsettled_amount	Number	The total unsettled amount of the invoice
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

Referred Objects Response Data

currency rate period object response data

Name	Type	Description
id	String	The ID of the retrieved currency rate period
rate	Number	The exchange rate of the currency rate period
inverse_rate	Number	The inverse exchange rate of the currency rate period
from_date	Date	The date from which the exchange rate is valid
to_date	Date	The date until which the exchange rate is valid
currency	Currency Object	The 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_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

write off object response data

Name	Type	Description
id	String	The ID of the retrieved write off
number	String	The number of the retrieved write off
reference_number	String	The reference number of the invoice write off
life_cycle_state	String	The life cycle state of the write off which can only be POSTED
issued_on	Date	The date that the write off was issued
posted_on	Date	The date that the write off was posted
total_amount	Number	The total amount of the write off
currency_rate_period	Currency Rate Period	The currency rate period based on which the invoice write off was created

Referred Objects Response Data

currency rate period object response data

Name	Type	Description
id	String	The ID of the retrieved currency rate period
rate	Number	The exchange rate of the currency rate period
inverse_rate	Number	The inverse exchange rate of the currency rate period
from_date	Date	The date from which the exchange rate is valid
to_date	Date	The date until which the exchange rate is valid
currency	Currency Object	The 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_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

Examples

Example 1

HTTP Method: POST

Request:

Body:

 {
    "token":"{{token}}",
    "invoice_identifier":{"reference_number":"1542"},
    "type_identifier":{"name":"Write Off"},
    "category_identifier":{"name":"Write Off"},
    "udf_string_1":"Write Off",
     "notes":"Write Off"
}

Response:

 {
  "data": [
    {
      "invoice": {
        "posted_on": "2017-02-16T14:37:01",
        "number": "I00002751",
        "total_amount": 22,
        "unsettled_amount": null,
        "issued_on": "2017-02-16T14:36:24",
        "currency_rate_period": {
          "from_date": "2016-06-23 08:15:08.0",
          "to_date": null,
          "rate": 0.84,
          "inverse_rate": 0.16,
          "currency": {
            "suffix_symbol": null,
            "prefix_symbol": "£",
            "decimal_part_name": null,
            "code": "GBP",
            "integer_part_name": null,
            "id": "9"
          },
          "id": "C7D7ED57F21B47028144967E015DCBE5"
        },
        "id": "D144BEC33B484BF4825344AC696A42D1",
        "life_cycle_state": "WRITTEN_OFF",
        "outstanding_amount": null,
        "reference_number": "1542",
        "due_on": "2017-02-18T14:37:01"
      },
      "write_off": {
        "posted_on": "2017-02-16T14:38:35",
        "number": "8",
        "total_amount": 22,
        "issued_on": "2017-02-16T14:38:34",
        "currency_rate_period": {
          "from_date": "2016-06-23 08:15:08.0",
          "to_date": null,
          "rate": 0.84,
          "inverse_rate": 0.16,
          "currency": null,
          "id": "C7D7ED57F21B47028144967E015DCBE5"
        },
        "id": "7B8017F31804419DB72D5C6A948BB89C",
        "life_cycle_state": "POSTED",
        "reference_number": "8"
      }
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}