In Fusebill, a credit note is issued whenever charges are reversed on an invoice. If charges are reversed multiple times on an invoice, multiple credit notes are created for that invoice. A credit note details information about the charge reversal such as the net amount, IDs for the customer and invoice, and details from the invoice itself.
Credit Note Object Fields
| Property | Type | Description |
|---|---|---|
netAmount | Decimal | The total amount of this credit note |
creditNotesNumber | String | A specially formatted string. It's the invoice number concatenated with "-CR-" concatenated with the credit note number e.g. "360-CR-02" [Read Only] |
reference | String | The customer reference value |
customerId | Integer | The Fusebill Generated ID that uniquely identifies the customer this credit note is associated with. |
invoiceNumber | Integer | The invoice number this credit note was applied against |
invoice | Object. See Invoice and Statements: Invoice Object for details | A slightly summarized version of an invoice object. |
currency | String | 3-character ISO code identifying the currency being used. |
customerName | String | The name of the customer |
customerCompany | String | The name of the customer's company |
invoicePostedDate | DateTime | The posted timestamp of the invoice this credit note is for. |
effectiveTimestamp | DateTime | The effective timestamp of the invoice this credit note is for. |
lineItems | A list of objects. Definition below | The collection of line items partially or fully reversed by this credit note |
id | Integer | The Fusebill generated ID that uniquely identifies this credit note [Read Only] |
uri | String | The full string path to this resource [Read Only] |
Line Items Fields
| Property | Type | Description |
|---|---|---|
chargeGroupName | String | The name of the charge group. Typically a subscription name |
chargeGroupDescription | String | The description for the charge group. |
chargeGroupReference | String | The reference value for the charge group. |
lineItems | List of Objects. | The line items listed under the charge group. Each will have a field called lineItem, a field called discounts and a field called taxes, all of which are defined below. |
Line Item Fields
| Property | Type | Description |
|---|---|---|
originalChargeId | Integer | The Fusebill generated ID that uniquely identifies the original transaction [Read Only] |
netAmount | Decimal | The amount of the charge that was reversed |
name | String | The name used for the line item |
Taxes Fields
| Property | Type | Description |
|---|---|---|
netAmount | Decimal | The amount of the charge that was reversed |
name | String | The name used for the line item |
Discounts Fields
| Property | Type | Description |
|---|---|---|
netAmount | Decimal | The amount of the charge that was reversed |
name | String | The name used for the line item |