Skip to main content
The Credit Notes Data Model simplifies the handling and retrieval of credit notes from different payment gateways. The model provides a unified representation of credit notes, enabling you to easily access and manage credit note data from different platforms.
  • Unified credit note properties: The model provides a unified representation of credit notes, enabling you to easily access and manage credit note data from different platforms.
  • Comprehensive credit note information: The model provides a comprehensive representation of credit notes, including all financial details, line items, and associated invoice references.

​
Attributes

​
Credit Note Attributes

PropertyTypeDescription
rootfi_idintegerThe unique RootFi identifier assigned to this credit note record
rootfi_created_atstringThe ISO 8601 timestamp indicating when RootFi first synced this credit note
rootfi_updated_atstringThe ISO 8601 timestamp indicating when RootFi last updated this credit note
rootfi_company_idintegerThe RootFi company identifier associated with this credit note
platform_idstringThe unique identifier for this credit note on the payment platform
platform_unique_idstringAn additional unique identifier provided by the payment platform
contact_idstringThe identifier of the customer or contact associated with this credit note
document_numberstringThe reference number or document identifier for this credit note
total_amountnumberThe total monetary value of the credit note (including all taxes and fees)
total_discountnumberThe total discount amount applied to this credit note
remaining_creditnumberThe amount of credit that has not yet been applied or used
tax_amountnumberThe total tax amount included in the credit note
shipping_amountnumberThe shipping cost amount included in the credit note (if applicable)
posted_datestringThe date when this credit note was posted or finalized
currency_idstringThe currency code (e.g., USD, EUR) used for all amounts in this credit note
memostringAdditional notes or comments associated with this credit note
statusenumThe current status of the credit note (DRAFT, SUBMITTED, PAID, VOID, etc.)
invoice_idsstring[]An array of invoice identifiers that this credit note is associated with
created_atstringThe ISO 8601 timestamp when this credit note was created on the platform
updated_atstringThe ISO 8601 timestamp when this credit note was last updated on the platform
line_itemsLine Item[]An array of line items detailing the products or services in this credit note

​
Line Item Attributes

PropertyTypeDescription
platform_idstringThe unique identifier for this line item on the payment platform
line_item_type_idstringThe identifier of the parent document (credit note) this line item belongs to
item_idstringThe identifier of the product or service item associated with this line item
tax_idstringThe identifier of the tax rate applied to this line item
descriptionstringA detailed description of the product or service in this line item
quantitynumberThe quantity of items in this line item
unit_amountnumberThe price per unit for this line item
line_item_typestringThe type of line item (e.g., PAYMENT_CREDIT_NOTES)
sub_totalnumberThe subtotal amount for this line item (quantity × unit_amount)
tax_amountnumberThe tax amount calculated for this line item
total_amountnumberThe total amount for this line item (sub_total + tax_amount - discount)
total_discountnumberThe discount amount applied to this line item
updated_atstringThe ISO 8601 timestamp when this line item was last updated

​
Properties Supported

PropertyTypeDescription
platform_idstringThe unique identifier for this credit note on the payment platform
contact_idstringThe identifier of the customer or contact associated with this credit note
document_numberstringThe reference number or document identifier for this credit note
total_amountnumberThe total monetary value of the credit note (including all taxes and fees)
total_discountnumberThe total discount amount applied to this credit note
remaining_creditnumberThe amount of credit that has not yet been applied or used
tax_amountnumberThe total tax amount included in the credit note
shipping_amountnumberThe shipping cost amount included in the credit note (if applicable)
posted_datestringThe date when this credit note was posted or finalized
currency_idstringThe currency code (e.g., USD, EUR) used for all amounts in this credit note
memostringAdditional notes or comments associated with this credit note
statusenumThe current status of the credit note (DRAFT, SUBMITTED, PAID, VOID, etc.)
invoice_idsstring[]An array of invoice identifiers that this credit note is associated with
created_atstringThe ISO 8601 timestamp when this credit note was created on the platform
updated_atstringThe ISO 8601 timestamp when this credit note was last updated on the platform
line_itemsobject[]An array of line items detailing the products or services in this credit note
{
  "rootfi_id": 157,
  "rootfi_created_at": "2024-01-22T05:07:31.465Z",
  "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
  "rootfi_company_id": 1089,
  "platform_id": "cn_123456",
  "platform_unique_id": "cn_unique_123456",
  "contact_id": "cus_123456",
  "document_number": "CN-001",
  "total_amount": 110.00,
  "total_discount": 10.00,
  "remaining_credit": 110.00,
  "tax_amount": 10.00,
  "shipping_amount": 5.00,
  "posted_date": "2024-01-22T05:07:31.000Z",
  "currency_id": "USD",
  "memo": "Credit note for returned items",
  "status": "SUBMITTED",
  "invoice_ids": ["inv_123456", "inv_789012"],
  "created_at": "2024-01-22T05:07:31.000Z",
  "updated_at": "2024-01-22T05:07:31.000Z",
  "line_items": [
    {
      "platform_id": "li_123456",
      "line_item_type_id": "cn_123456",
      "item_id": "item_123",
      "tax_id": "tax_123",
      "description": "Returned product - refund",
      "quantity": 1,
      "unit_amount": 100.00,
      "line_item_type": "PAYMENT_CREDIT_NOTES",
      "sub_total": 100.00,
      "tax_amount": 10.00,
      "total_amount": 110.00,
      "total_discount": 0,
      "updated_at": "2024-01-22T05:07:31.000Z"
    }
  ]
}