Skip to main content

CreditNote

createdAtstring<date-time>nullable
creditAmountinteger<int64>required
creditNoteIdstringrequired
currencystringrequired
customerIdstringrequired
lineItems object[]required
  • Array [
    • amountinteger<int64>required
    createdAtstring<date-time>nullable
    creditNoteIdstringrequired
    descriptionstringrequired
    externalLineItemIdstringnullable
    idstringrequired
    quantityinteger<int32>required
    typestringrequired
    unitAmountinteger<int64>required
  • ]
    • merchantIdstringrequired
    numberstringnullable
    outOfBandAmountinteger<int64>required
    paymentIdstringrequired
    reasonstringnullable
    refundAmountinteger<int64>required
    refundedTipAmountinteger<int64>nullable
    statusCreditNoteStatusrequired

    Possible values: [PENDING, ISSUED, FAILED, VOID]

    totalinteger<int64>required
    updatedAtstring<date-time>nullable
    voidedAtstring<date-time>nullable
    CreditNote
    {
      "createdAt": "2024-07-29T15:51:28.071Z",
      "creditAmount": 0,
      "creditNoteId": "string",
      "currency": "string",
      "customerId": "string",
      "lineItems": [
        {
          "amount": 0,
          "createdAt": "2024-07-29T15:51:28.071Z",
          "creditNoteId": "string",
          "description": "string",
          "externalLineItemId": "string",
          "id": "string",
          "quantity": 0,
          "type": "string",
          "unitAmount": 0
        }
      ],
      "merchantId": "string",
      "number": "string",
      "outOfBandAmount": 0,
      "paymentId": "string",
      "reason": "string",
      "refundAmount": 0,
      "refundedTipAmount": 0,
      "status": "PENDING",
      "total": 0,
      "updatedAt": "2024-07-29T15:51:28.071Z",
      "voidedAt": "2024-07-29T15:51:28.071Z"
    }