com.gigs.creditNote.created

Name
object
Type
string
Description
Type of object is always event.
Allowed values: event
Name
id
Type
string
Description
Unique identifier for the event.
Example: "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
Name
data
Type
CreditNote
Description
Credit notes adjust an invoice amount after it has been finalized. Used to issue credit or refunds.
Name
datacontenttype
Type
string
Description
The RFC 2046 content-type.
Example: "application/json"
Default: application/json
Name
project
Type
string
Description
Unique identifier for the project where the event occurred.
Example: "gigs"
Name
source
Type
string
Description
URI identifying the event source.
Example: "https://api.gigs.com"
Default: https://api.gigs.com
Name
specversion
Type
string
Description
The CloudEvents spec version.
Example: "1.0"
Default: 1.0
Name
time
Type
string
Description
Time when the event occurred.
Example: "2022-03-16T14:12:42Z"
Name
type
Type
string
Description
Type is always com.gigs.creditNote.created.
Allowed values: com.gigs.creditNote.created
Name
version
Type
string
Description
API version used to serialize the data and the event itself.
Default: 2024-12-20

Example

{
  "object": "event",
  "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
  "data": {
    "object": "creditNote",
    "id": "crn_0SNlurA049MEWV49X25tqzNV2jji",
    "createdAt": "2024-06-14T19:38:34.0Z",
    "fees": [
      {
        "amount": {
          "amount": 100,
          "currency": "USD"
        },
        "name": "Recovery Fee",
        "type": "recoveryFee"
      }
    ],
    "invoice": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
    "lineItems": [
      {
        "amount": {
          "amount": 999,
          "currency": "USD"
        },
        "invoiceLineItem": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
        "tax": {
          "amount": 200,
          "currency": "USD"
        },
        "taxes": [
          {
            "amount": {
              "amount": 200,
              "currency": "USD"
            },
            "inclusive": false,
            "name": "State Sales Tax",
            "invoiceTax": "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3"
          }
        ],
        "total": {
          "amount": 1199,
          "currency": "USD"
        }
      }
    ],
    "status": "issued",
    "subtotal": {
      "amount": 999,
      "currency": "USD"
    },
    "tax": {
      "amount": 200,
      "currency": "USD"
    },
    "total": {
      "amount": 1199,
      "currency": "USD"
    },
    "voidedAt": "2024-06-14T19:38:34Z"
  },
  "datacontenttype": "application/json",
  "project": "gigs",
  "source": "https://api.gigs.com",
  "specversion": "1.0",
  "time": "2022-03-16T14:12:42.0Z",
  "type": "com.gigs.creditNote.created",
  "version": "2024-12-20"
}