# CreditNote

Credit notes adjust an invoice amount after it has been finalized. Used to issue credit or refunds.

## Properties

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `object` | string | Yes | Type of object is always `creditNote`. |
| `id` | string | Yes | Unique identifier for the credit note. |
| `createdAt` | string | Yes | Time when the credit note was created. |
| `creditTo` | outOfBand | userBalance | Yes | Specifies where the credit amount should be credited to. It can have one of the following values:    - `outOfBand`: The amount should be handled outside the system by the customer.   - `userBalance`: The amount should be added to the user balance at Gigs.  |
| `fees` | object[] | Yes | The credited fees. |
| `fileUrl` | string,null | Yes | A signed URL to download the credit note PDF file. The URL is valid for 1 minute.  This field is only available for select projects and will be `null` for all others.   <!-- theme: info --> > #### Preview > > This property is currently in preview and might change in the future. > > We’re excited to hear your feedback and ideas. Please send an email > to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.  |
| `invoice` | string | Yes | The unique identifier for the invoice that the credit note applies to. |
| `lineItems` | object[] | Yes | The line items for the credit note. |
| `status` | issued | voided | Yes | The status of the credit note. It can have one of the following values:    - `issued`: The credit note was issued.   - `voided`: The credit note was voided and no longer has any effect.  |
| `subtotal` | object | Yes | The total amount credited before any taxes or fees. |
| `tax` | object | Yes | The sum of the amounts in taxes credited for each line item. |
| `total` | object | Yes | The total amount credited after taxes and fees. |
| `voidedAt` | string,null | Yes | Time when the credit note was voided. |