Sign in

v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Webhooks

Webhook to notify when a credit memo is created.

postWebhookcredit-memo-created

Headers

X-Rillet-Signaturestring required

Signature of the webhook event. Computed using HMAC-SHA256 and AES encrypted with the configured webhook token. The contents of the body are prefixed with the timestamp and id before hashing.

X-Rillet-Timestampstring date-time required

Timestamp of the webhook event in ISO-8601 format

X-Rillet-Idstring uuid required

ID of the webhook event

X-Rillet-Entitystring required

Entity type of the webhook event

X-Rillet-Eventstring required

Event type of the webhook event

Payload

idstring uuid required
subsidiary_idstring uuid required
credit_memo_numberstring required
customer_idstring uuid required
credit_memo_datestring date required
status'UNAPPLIED' | 'PARTIALLY_APPLIED' | 'APPLIED' | 'REFUNDED' required
updated_atstring date-time required

ISO 8601 timestamp in UTC timezone (must end with 'Z')

Example payload

{
  "credit_memo_number": "CM01",
  "items": [
    {
      "description": "Description",
      "revenue": {
        "account_code": "11112"
      },
      "total_amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "taxed_amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "net_amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "quantity": 1
    }
  ],
  "address": {
    "line1": "123 Main St",
    "line2": "Apt 4B",
    "city": "Nashville",
    "state": "TN",
    "zip_code": "37201",
    "country": "US"
  },
  "net_amount": {
    "amount": "1.01",
    "currency": "USD"
  },
  "total": {
    "amount": "1.01",
    "currency": "USD"
  },
  "applied_amount": {
    "amount": "1.01",
    "currency": "USD"
  },
  "remaining_amount": {
    "amount": "1.01",
    "currency": "USD"
  },
  "applications": [
    {
      "amount": {
        "amount": "1.01",
        "currency": "USD"
      }
    }
  ],
  "exchange_rate": {
    "base": "USD",
    "target": "USD"
  },
  "taxed_amount": {
    "amount": "1.01",
    "currency": "USD"
  },
  "external_references": [
    {
      "type": "xyzSystemId",
      "id": "234",
      "url": "https://xyzsystempage.com/ids/234"
    }
  ]
}

Response

OK

string required

A placeholder indicating a response from a webhook. The contents of this response are ignored.