Skip to main content

​
Credit issued invoices

A credit note is a document that can be used to decrease the amount due or issue a credit for an already issued invoice. Common situations for issuing a credit note include:
  • Duplicate - a duplicate invoice was sent to a customer for the same goods or services.
  • Fraudulent - a customer is disputing an erroneous invoice’s charges.
  • Order change - the number of items charged to the customer needs to be changed.
  • Unsatisfactory product - the customer is requesting a refund due to a product issue.
Credit notes can be applied to invoices that either have an issued status or a paid status. When a credit note is issued for an issued invoice, it is considered an adjustment. When a credit note is issued for a paid invoice, it is considered a refund. Credit notes cannot be applied to any invoices that have been synced to an external provider such as Stripe or QuickBooks. Any adjustments made to the invoice should be done with the external provider. There may be cases where credit notes are automatically added to synced invoices (typically as the result of a subscription change action). In these cases, the synced invoice is treated as a paid invoice, and the credit note is always treated as a refund credit note (thereby adding to the customer account balance). Credit notes will also include any applicable tax when associated with an invoice that included tax. Tax will be calculated when the credit note is issued.

​
Service period configuration

When creating credit notes via the API or dashboard, you can configure custom service periods that determine which portion of the original invoice’s service period is being credited. Orb supports multiple modes for service period configuration:
  • Original service period (Default): Use the original invoice line item service periods. This is the default behavior when no custom service periods are specified.
  • Issuance date: Set the service period to start from the credit note issuance date, useful for partial credits from a specific point in time.
  • Custom: Specify a custom start_date and end_date at the credit note level. These dates will be applied uniformly to all line items in the credit note.
  • Custom per line item: Specify custom start_date and end_date for each individual line item. When using this mode, all line items must have their own service periods specified.

​
Service period constraints

  • Date boundaries: Credit note service periods cannot extend beyond the service periods of the original invoice line items, and/or today’s date (issuance date).
  • Date format: Use “YYYY-MM-DD” format (e.g., “2023-09-22”) for consistency with other Orb APIs.
  • Inclusive dates: Both start and end dates are inclusive, covering the complete days specified
  • No mixing: You cannot combine global and individual service periods in the same request
Service period configuration is available both in the Orb dashboard and via the API. In the dashboard, use the “Service period” dropdown when creating a credit note to select from the available options. For API integration, use the start_date and end_date parameters as described in the API reference.

​
Issuing an adjustment credit note

To create a credit note, navigate to an issued invoice in the Orb dashboard. In the top right dropdown menu, select “Issue credit note”. image.png
  • Choose a reason for the credit note and, optionally, add a memo to your credit note.
  • Adjust the creditable amount for each line item in the invoice, and unselect line items that should not be credited.
    • The credit note will be populated with the current, maximum creditable amounts for each line item.
    • You can configure the service period using the “Service period” dropdown to determine which portion of the original service period to credit.
    • If a minimum amount was applied to the invoice or a line item, the outstanding amount can also be credited back.
  • The “Adjusted amount due” will reflect the new amount due on the invoice after issuance.
image.png Upon issuing the credit note, the invoice’s amount due will be adjusted and the credit note’s amounts will be shown on the invoice page. The invoice PDF will also be regenerated to include the credit note. image.png

​
Issuing a refund credit note

When a credit note is issued for a paid invoice, the flow is similar to issuing a credit note for an issued invoice with a few differences. When the credit note is issued, the amount due on the invoice will not be adjusted based on the credit note’s value, as the amount has already been collected. Instead, the customer balance will be incremented by the value of the credit note, and the credit note will linked on the invoice page. The credit note will not be attached to the invoice’s PDF in this instance. image.png

​
Adding multiple credit notes

Multiple credit notes can be applied to an invoice up to the total value of the invoice. After one credit note is applied to an invoice, the issue credit flow will populate the maximum creditable amounts for each line item. image.png All applied credit notes will appear on the invoice page. image.png

​
Voiding a credit note

To void a credit note, click on the credit note in the top left of the invoice page. From the dropdown at the top right of the page, click “Mark as void”. image.png After the confirmation modal, the credit note will now be marked as void. For adjustment credit notes, the invoice’s amount due will be changed to reflect the credit note’s value being removed. image.png Refund credit notes cannot be voided.

​
Credit notes and customer balance

An invoice’s amount due can be adjusted by either utilizing the customer balance or issuing a credit note. Whereas the customer balance is automatically applied at the invoice’s finalization by Orb, a credit note can be manually applied to an already-issued invoice. Further, credit notes can be applied to invoices that have already utilized the customer balance in order to further affect the amount due. Applying adjustment credit notes will revert any applied balance, apply the credit note’s amount, and then re-apply any applicable remaining balance. The same behavior occurs if the credit note is voided. For example, if an invoice has a customer balance adjustment of $5:
Invoice total$10.00
Balance adjustment-$5.00
Amount due$5.00
When a $3 credit note is applied, the customer balance adjustment will be removed from the invoice and the accompanying amount will be incremented on the customer’s balance (e.g. $5 will be returned to the balance). The credit note’s amount is then applied and then a maximum of $5 can be reapplied to the invoice. The resulting invoice’s amount due will be broken down as:
Invoice total$10.00
Credit note amount-$3.00
Balance adjustment-$5.00
Amount due$2.00
If the credit note is voided, the $3 balance adjustment is reverted, the credit note’s amount is removed from the invoice, and the maximum of $5 can be re-applied to the invoice.
Invoice total$10.00
Balance adjustment-$5.00
Amount due$5.00
Issuing refund credit notes will not affect the customer balance transactions on an invoice.

​
Credit notes and subscription cancellation

When cancelling a subscription during a billing period, Orb will issue a credit note against the original invoice for fees paid in-advance. The credit note will be for the remainder of the fee’s period that is no longer being used. Unpaid invoices’s total amount due will be reduced. If the relevant invoice has already been paid, the prorated amount is added to the customer’s balance via the credit note and can be consumed by future invoices.

​
Email delivery

If the account and customer are configured for email delivery, all credit notes will be delivered on creation. Adjustment credit notes will include two PDFs: one of the credit note and one for the updated invoice with the credit applied. Refund credit notes will only have the credit note’s PDF. Voiding a credit note will not send any emails.
⌘I