This endpoint is used to create a single Credit Note
.
The credit note service period configuration supports two explicit modes:
Global service periods: Specify start_date and end_date at the credit note level. These dates will be applied to all line items uniformly.
Individual service periods: Specify start_date and end_date for each line item. When using this mode, ALL line items must have individual periods specified.
Default behavior: If no service periods are specified (neither global nor individual), the original invoice line item service periods will be used.
Note: Mixing global and individual service periods in the same request is not allowed to prevent confusion.
Service period dates are normalized to the start of the day in the customer’s timezone to ensure consistent handling across different timezones.
Date Format: Use start_date and end_date with format “YYYY-MM-DD” (e.g., “2023-09-22”) to match other Orb APIs like /v1/invoice_line_items.
Note: Both start_date and end_date are inclusive - the service period will cover both the start date and end date completely (from start of start_date to end of end_date).
API Keys can be issued in the Orb's web application.
Created
The Credit Note resource represents a credit that has been applied to a particular invoice.