# List Credit Memos

`GET https://api.suger.cloud/ai/org/{orgId}/revenue/credit-memo`

Returns this organization's credit memos as a page, with the total count alongside them: issued credit memos, refunds recorded on a revenue record that has no credit memo, and GCP credit entries that are not yet matched to a refund. These are the rows of the Credit Memo report in the console. Each row has the issue and effective dates, channel, buyer, credit memo ID, linked invoice number, amount in the invoice and base currency, reason code, status, provider refund status and cash refund date. `partner` and the issue-date range `startDate` to `endDate` narrow the rows, and `limit` and `offset` page through them.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `orgId` | path | string | yes | Organization ID |
| `startDate` | query | string | no | First issue date to include, as YYYY-MM-DD. |
| `endDate` | query | string | no | Last issue date to include, as YYYY-MM-DD. The whole day is included. |
| `partner` | query | string | no | Only rows from this partner, for example AWS, AZURE, GCP or STRIPE. |
| `limit` | query | string | no | Rows per page. The default is 50 and the maximum is 200. |
| `offset` | query | string | no | Number of rows to skip. The default is 0. |

## Responses

### 200 — Credit memos

Content-Type: `application/json`

**`Response`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `columns` | array<string> | yes |  |
| `rows` | array<object> | yes |  |
| `totalRows` | integer | yes |  |
| `limit` | integer | yes |  |
| `offset` | integer | yes |  |

### 400 — Invalid credit memo query

Content-Type: `application/json`

**`Response`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `error` | string | yes |  |

### 403 — Missing Revenue permission

Content-Type: `application/json`

**`Response`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `error` | string | yes |  |

### 413 — Request body too large

Content-Type: `application/json` · Schema: `RevenuePayloadTooLargeResponse`

**`RevenuePayloadTooLargeResponse`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `error` | object | yes |  |

### 500 — Reporting query failed

Content-Type: `application/json`

**`Response`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `error` | string | yes |  |

## Example

_Generated from this operation's schema. Values are placeholders — substitute your own ids, and set `SUGER_TOKEN` to a bearer token from the [OAuth client-credentials exchange](https://doc.fours.com/settings/oauth-app/)._

### Request

```bash
curl -X GET 'https://api.suger.cloud/ai/org/{orgId}/revenue/credit-memo' \
  -H "Authorization: Bearer $SUGER_TOKEN"
```

### Response — 200

```json
{
  "columns": [
    "string"
  ],
  "rows": [
    {}
  ],
  "totalRows": 1,
  "limit": 1,
  "offset": 1
}
```

### Error — 400

```json
{
  "error": "string"
}
```

---

API reference: https://doc.fours.com/api/
