---
title: "Search credits"
method: GET
path: "/v1/Credits"
tags: ["Credits"]
---

# Search credits

`GET /v1/Credits`

Search for one or more credits.

## Query parameters

- `search.credit_memo_id` integer[]
- `search.customer_id` integer[]
- `search.product_id` integer[]
- `search.service_product_id` integer[]
- `search.service_id` integer[]
- `search.description` string[]
- `search.bill_id` integer[]
- `search.created_date_start` string, date-time
- `search.created_date_end` string, date-time
- `search.page_size` integer
- `search.page` integer
- `search.sort` string

## Response `200`

OK

- RevWebAPIModelsGetOrSearchOfRevAppSearchModelsResponseOfRevAppModelsCredit
  - `ok` boolean
  - `has_more` boolean — Helper for pagination. Indicates there are more records returned.
  - `record_count` integer — Total number of records found by the search.
  - `records` RevAppModelsCredit[] — List of records returned.
    - `credit_memo_id` integer — Primary identifier for this credit.
    - `description` string, required — Memo for credit.
    - `product_type_id` integer — ID of the product type on this credit.
    - `product_id` integer — ID of the product on this credit.
    - `service_product_id` integer — ID of the service product on this credit.
    - `balance` number, double — Customer balance at the time the credit was applied.
    - `closed_date` string, date-time
    - `buy_rate` number, double
    - `atype` string — Type of credit. (FCC, MRC, NRC, OCC, ADJ)
    - `created_date` string, date-time — Date the credit was created.
    - `created_by` integer — ID of user that created the credit.
    - `tax_class_id` integer — ID of tax class on the credit.
    - `customer_id` integer, required — ID of customer on the credit.
    - `bill_id` integer — ID of bill the credit is applied to.
    - `service_id` integer — ID of service on a customer account.
    - `amount` number, double — Total dollar amount including taxes and product amounts on credit.
    - `product_amount` number, double — Dollar amount of product on this credit.
    - `tax_amount` number, double — Tax amount on this credit.
    - `geocode` string — Location of the credit.
    - `proration` number, double — Dollar amount prorated over the credit's start and end dates.
    - `is_tax_included` boolean, required — Tax amounts are included in the credit amount field.
    - `cost` number, double — Cost of the credit.
    - `is_bad_debt` boolean — Identifies a credit as bad debt.
    - `quantity` number, double, required — Units of product or product type on the transaction.
    - `rate` number, double, required — Rate of product associated to this transaction
    - `is_prorated` boolean, required — Is proration of transaction required
    - `start_date` string, date-time, required — Billing start date of product or product type associated to this transaction
    - `end_date` string, date-time, required — Billing end date of product or product type associated to this transaction
    - `links` RevAppComponentsLink[]
      - `rel` string
      - `href` string

## Other responses

- `500` — InternalServerError

---

[API](https://skmtc.net/rev-io/apis/rev-io-api.md) · [All operations](https://skmtc.net/rev-io/apis/rev-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rev-io/rev-io-api/revisions/135571434f6c/schema)