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_amountNumberThe total VAT amount applied on the credit note
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
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

log_information

Log Information Object

The log information related with the retrieved credit note

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

...