Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Name

Type

Description

id

String

The ID of the retrieved credit note

number

String

The number of the retrieved credit note

reference_numberStringThe reference number of the retrieved credit note
life_cycle_stateString

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

DRAFT, REJECTED, POSTED, CANCELLED

discount_amountNumberThe total discount amount provided by the credit note
vat_amountNumber

The total VAT amount applied on the credit note

Tip

Deprecated from CRM.COM R17.0.0


tax_amountNumber

The total Tax amount applied on the credit note

Tip

Available from CRM.COM R12.0.0


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

The back office code of the retrieved credit note

Tip

Available from CRM.COM R9.1.0


issue_reasonStringA description of the reason that the credit note is issued

udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

accounts_receivableAccounts receivable objectThe related accounts receivable
member_accountAccounts receivable object

The member accounts receivable. Applicable only if the retrieved Credit Note was issued against a parent accounts receivable which fund the member accounts of its group.

Tip

Available from CRM.COM R13.0.0


typeFinancial transaction type objectThe financial transaction type of this credit note
categoryFinancial transaction category objectThe category of the credit note
rejection_reasonFinancial transaction rejection reason objectThe reason that the credit note was rejected
accounting_period_informationAccounting Period Information object

The Accounting Period Information of the credit note which includes the Accounting period of the credit note and the date on which it was set. This is applicable only if the credit note is processed during an Accounting Period Closing process

Tip

Available from CRM.COM R10.0.0


currency_rate_periodCurrency Rate Period object

The currency rate period based on which the credit note's amounts were calculated

Tip

Available from CRM.COM R10.0.0


log_information

Log Information Object

The log information related with the relatedwiththe retrieved credit note

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

...

Include Page
credit_note_item_short
credit_note_item_short

Include Page
accounting_period_information_short
accounting_period_information_short

Include Page
currency_rate_period_short
currency_rate_period_short

Include Page
log_information_short
log_information_short