# Get CustomerCredit record

Retrieve a specific CustomerCredit record by number with all related data.

Endpoint: GET /public/v1/customer-credits/{record_number}/
Version: 1.0.0

## Path parameters:

  - `record_number` (integer, required)

## Query parameters:

  - `search` (string,null)

  - `company_id` (array,null)

  - `number` (array,null)

  - `customer_id` (array,null)

  - `start_date` (string,null)

  - `end_date` (string,null)

  - `transaction_currency` (array,null)
    Enum: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "YER", "ZAR", "ZMW", "ZWL"

  - `record_status` (array,null)
    Enum: "draft", "posted", "archived"

## Response 200 fields (application/json):

  - `transaction_ids` (array, required)

  - `attachments` (array)

  - `attachments.id` (integer, required)

  - `attachments.file_name` (string, required)

  - `attachments.file_size` (integer, required)

  - `attachments.download_url` (string,null)

  - `custom_fields` (array)

  - `custom_fields.field` (object, required)

  - `custom_fields.field.company_id` (integer,null)

  - `custom_fields.field.company_ids` (array,null)

  - `custom_fields.field.name` (string, required)

  - `custom_fields.field.description` (string,null, required)

  - `custom_fields.field.helper_text` (string,null, required)

  - `custom_fields.field.field_type` (string, required)
    Enum: "text", "number", "currency", "date", "boolean", "single_select", "multi_select", "link", "paragraph"

  - `custom_fields.field.applies_to` (array, required)

  - `custom_fields.field.applies_to.type` (string, required)
    Enum: "invoice", "bill", "direct_expense", "journal_entry", "vendor_prepayment", "vendor_credit", "vendor_payment", "vendor_refund", "customer_payment", "customer_refund", "customer_deposit", "currency_revaluation", "contract", "customer", "vendor", "sales_order", "cash_sale", "customer_credit"

  - `custom_fields.field.applies_to.is_active` (boolean)

  - `custom_fields.field.applies_to.is_required` (boolean)

  - `custom_fields.field.default_value` (any)

  - `custom_fields.field.options` (array,null, required)

  - `custom_fields.value` (object,null)
    Schema for custom field values with full details.

  - `custom_fields.value.custom_field_id` (integer, required)

  - `custom_fields.value.custom_field_name` (string, required)

  - `custom_fields.value.custom_field_type` (string, required)

  - `custom_fields.value.custom_field_value_id` (integer, required)

  - `custom_fields.value.value` (any, required)

  - `custom_fields.value.created_at` (string, required)

  - `custom_fields.value.updated_at` (string, required)

  - `integration_remote_records` (array)

  - `integration_remote_records.transactional_date` (string,null)

  - `integration_remote_records.external_source` (object,null)

  - `integration_remote_records.external_source.integration_type` (any, required)

  - `integration_remote_records.external_source.external_integration_url` (string,null, required)

  - `integration_remote_records.source_id` (string, required)

  - `integration_remote_records.connection_id` (integer,null)

  - `integration_remote_records.integration_id` (integer,null)

  - `integration_remote_records.integration_provider` (object,null)

  - `integration_remote_records.integration_provider.logo_url` (string,null)

  - `integration_remote_records.integration_provider.website` (string,null)

  - `integration_remote_records.integration_provider.category` (string,null)

  - `integration_remote_records.url` (string,null)

  - `number` (integer, required)

  - `invoice_number` (integer,null, required)

  - `cash_sale_number` (integer,null, required)

  - `date` (string, required)

  - `company_name` (string, required)

  - `company_currency` (string, required)

  - `customer_id` (integer, required)

  - `customer_name` (string, required)

  - `bill_to_address` (string, required)

  - `billing_address` (object,null)

  - `billing_address.street` (string, required)

  - `billing_address.city` (string, required)

  - `billing_address.state` (string, required)

  - `billing_address.postal_code` (string, required)

  - `billing_address.country` (any)

  - `billing_address.second_line` (string)

  - `ship_to_address` (string, required)

  - `shipping_address` (object,null)

  - `currency_iso_4217_code` (string,null, required)
    Enum: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "YER", "ZAR", "ZMW", "ZWL"

  - `exchange_rate` (any, required)

  - `amount` (any, required)
    Total transaction amount

  - `used_amount` (any, required)
    Amount that was already applied to Invoices through Customer Refunds or Customer Prepayment Applications

  - `remaining_amount` (any, required)
    Amount that can be applied to Invoices through Customer Refunds or Customer Prepayment Applications

  - `memo` (string, required)

  - `items` (array, required)

  - `items.classifications` (array)

  - `items.classifications.line_id` (integer, required)

  - `items.classifications.line_name` (string, required)

  - `items.classifications.parent_classification_id` (integer,null)

  - `items.classifications.parent_classification_line_id` (integer,null)

  - `items.item_id` (integer, required)

  - `items.quantity` (any, required)

  - `items.rate` (any, required)

  - `items.position` (integer, required)

  - `record_status` (string, required)
    Enum: "draft", "posted", "archived"

## Response 400 fields (application/json):

  - `success` (boolean)

  - `errors` (object, required)

## Response 404 fields (application/json):

  - `success` (boolean)

  - `errors` (object, required)

## Response 500 fields (application/json):

  - `success` (boolean)

  - `errors` (object, required)