# Retrieve Filtered Credits

Get record(s) using filters

Endpoint: GET /rest/2.0/CREDIT
Version: 1.0
Security: JWT

## Query parameters:

  - `queryAnsiSql` (string, required)
    SQL Where part

## Header parameters:

  - `sessionId` (string, required)

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.AccountProductId` (any)
    AccountProductId

  - `retrieveResponse.AccountingPeriodId` (any)
    Accounting Period

  - `retrieveResponse.ApprovalNotes` (any)
    Approval Notes

  - `retrieveResponse.ApprovalRejectedNote` (any)
    ApprovalRejectedNote

  - `retrieveResponse.ApprovalStatus` (any)
    Approval Status

  - `retrieveResponse.ApproveRejectedUser` (any)
    Approved/Rejected By

  - `retrieveResponse.ApprovedRejectedDate` (any)
    Approved/Rejected Date

  - `retrieveResponse.AutoApproved` (any)
    Auto Approved

  - `retrieveResponse.AutoCreditAssociatedProduct` (any)
    Auto-Credit Product Hidden

  - `retrieveResponse.AutoCreditDiscount` (any)
    Auto-Credit Discount Hidden

  - `retrieveResponse.AutoCreditTax` (any)
    Auto-Credit Tax Hidden

  - `retrieveResponse.Autoallocate` (any)
    Auto-allocate: Once created, credits can be allocated to invoices to offset the balance due.  Auto-allocate ON: The credit will be allocated to the invoice from which the credit line items were created first (up to the balance due), and then to other invoices based on their due date (oldest first).Auto-allocate OFF: You can allocate the credit manually using the allocation table located below the credit line item table

  - `retrieveResponse.BillingProfileId` (any)
    Billing Profile Id: ACCOUNT NUMBER

  - `retrieveResponse.Created` (any)
    System controlled field: Date and time the record was created

  - `retrieveResponse.CreatedUserId` (any)
    System controlled field: Id of the user that created the record

  - `retrieveResponse.CreditCardCCV` (any)
    CreditCardCCV

  - `retrieveResponse.CreditCardExpDate` (any)
    CreditCardExpDate

  - `retrieveResponse.CreditCardName` (any)
    CreditCardName

  - `retrieveResponse.CreditCardNumber` (any)
    CreditCardNumber

  - `retrieveResponse.CreditDate` (any)
    Credit Date: Select the financial date of the credit. This field will be used to categorize the credit into an accounting period in certain cases based on the Accounting Period configuration

  - `retrieveResponse.CreditNote` (any)
    Notes: Notes attached to the credit (mandatory).

  - `retrieveResponse.CreditType` (any)
    Credit Type: Reason why the credit was given

  - `retrieveResponse.EcreditStatus` (any)
    E-invoicing Status

  - `retrieveResponse.Id` (any)
    Credit Item ID

  - `retrieveResponse.InvoiceDetail` (any)
    InvoiceDetail

  - `retrieveResponse.InvoiceIdDisplay` (any)
    InvoiceIdDisplay: Displayed on the invoice

  - `retrieveResponse.SourceRefundId` (any)
    Source Refund Id

  - `retrieveResponse.TaxEngineRequestId` (any)
    Tax Audit Log

  - `retrieveResponse.UnassignedCreditNote` (any)
    UnassignedCreditNote

  - `retrieveResponse.Updated` (any)
    System controlled field: Date and time the record was last updated

  - `retrieveResponse.UpdatedUserId` (any)
    System controlled field: Id of the last user that updated the record

  - `retrieveResponse.VoidCreditId` (any)
    Voided By

  - `retrieveResponse.VoidFlag` (any)
    Void Transaction

  - `retrieveResponse.VoidedCreditId` (any)
    Voided To

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error