com.gigs.creditNote.created

Name
object
Type
string
required
Description
Type of object is always event.
Name
id
Type
string
required
Description
Unique identifier for the event.
Example: evt_0SNlurA049MEWV5gNTcQ5A07h3Ol
Name
data
Type
object
PREVIEW
required
Description
Credit notes adjust an invoice amount after it has been finalized. Used for refunds or discounts applied after the sale.
Name
object
Type
string
required
Description
Type of object is always creditNote.
Name
id
Type
string
required
Description
Unique identifier for the credit note.
Example: crn_0SNlurA049MEWV49X25tqzNV2jji
Name
invoice
Type
string
required
Description
The unique identifier for the invoice that the credit note applies to.
Example: inv_0SNlurA049MEWV1QTRqvd18YuG25
Name
lineItems
Type
array
required
Description
The line items for the credit note.
Name
status
Type
string
required
Description
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.

Allowed values: issued, voided
Name
subtotal
Type
object
required
Description
The total amount credited before any taxes or fees.
Name
tax
Type
object
required
Description
The sum of the amounts in taxes credited for each line item.
Name
total
Type
object
required
Description
The total amount credited after taxes and fees.
Name
createdAt
Type
string
required
Description
Time when the credit note was created.
Example: 2024-06-14T19:38:34Z
Name
voidedAt
Type
nullable string
required
Description
Time when the credit note was voided.
Example: 2024-06-14T19:38:34Z
Name
datacontenttype
Type
string
required
Description
The RFC 2046 content-type.
Example: application/json
Default: application/json
Name
project
Type
string
required
Description
Unique identifier for the project where the event occurred.
Example: gigs
Name
source
Type
string
required
Description
URI identifying the event source.
Example: https://api.gigs.com
Default: https://api.gigs.com
Name
specversion
Type
string
required
Description
The CloudEvents spec version.
Example: 1.0
Default: 1.0
Name
time
Type
string
required
Description
Time when the event occurred.
Example: 2022-03-16T14:12:42Z
Name
type
Type
string
required
Description
Type is always com.gigs.creditNote.created.
Name
version
Type
string
required
Description
API version used to serialize the data and the event itself.
Default: 2024-08-29

Example

{
  "object": "event",
  "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
  "data": {
    "object": "creditNote",
    "id": "crn_0SNlurA049MEWV49X25tqzNV2jji",
    "invoice": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
    "status": "issued",
    "subtotal": {
      "amount": 999,
      "currency": "USD"
    },
    "tax": {
      "amount": 999,
      "currency": "USD"
    },
    "total": {
      "amount": 999,
      "currency": "USD"
    },
    "createdAt": "2024-06-14T19:38:34Z",
    "voidedAt": "2024-06-14T19:38:34Z"
  },
  "datacontenttype": "application/json",
  "project": "gigs",
  "source": "https://api.gigs.com",
  "specversion": "1.0",
  "time": "2022-03-16T14:12:42Z",
  "type": "com.gigs.creditNote.created",
  "version": "2024-08-29"
}