--- title: "List CustomerCredit records" method: GET path: "/public/v1/customer-credits/" tags: ["Customer Credits"] --- # List CustomerCredit records `GET /public/v1/customer-credits/` Retrieve a paginated list of CustomerCredit records with filtering and ordering options. ## Query parameters - `search` string, nullable - `company_id` integer[], nullable - `number` integer[], nullable - `customer_id` integer[], nullable - `start_date` string, date, nullable - `end_date` string, date, nullable - `transaction_currency` SystemCurrencies[], nullable - `record_status` RecordStatus[], nullable - `updated_after` string, date-time, nullable - `updated_before` string, date-time, nullable - `ordering` string, nullable - `limit` integer — Number of records to return per page (capped at 100) - `offset` integer — Number of records to skip before starting to return results ## Response `200` OK - PagedPublicCustomerCreditSchemaOut - `items` PublicCustomerCreditSchemaOut[], required - `bill_to_address` string, required — Deprecated: send the structured billing_address / shipping_address instead. - `ship_to_address` string, required — Deprecated: send the structured billing_address / shipping_address instead. - `billing_address` AddressSchemaOut - `name` string, nullable - `street` string, required - `second_line` string, required - `city` string, required - `state` string, required - `postal_code` string, required - `country` string, required - `shipping_address` AddressSchemaOut - `name` string, nullable - `street` string, required - `second_line` string, required - `city` string, required - `state` string, required - `postal_code` string, required - `country` string, required - `customer_id` integer, nullable - `customer_name` string, nullable - `transaction_ids` integer[], required - `attachments` PublicAttachmentSchemaOut[] - `id` integer, required - `file_name` string, required - `file_size` integer, required - `download_url` string, nullable - `custom_fields` CustomFieldValuePairOutputSchema[] - `field` CustomFieldSchemaOut, required - `id` integer, required - `company_id` integer, nullable - `company_ids` integer[], nullable - `name` string, required - `description` string, nullable, required - `helper_text` string, nullable, required - `field_type` 'text' | 'number' | 'currency' | 'date' | 'boolean' | 'single_select' | 'multi_select' | 'link' | 'paragraph', required - `applies_to` AppliesToItemSchema[], required - `type` 'invoice' | 'bill' | 'direct_expense' | 'journal_entry' | 'vendor_prepayment' | 'vendor_credit' | 'vendor_payment' | 'vendor_refund' | 'customer_payment' | 'customer_prepayment' | 'customer_refund' | 'customer_deposit' | 'currency_revaluation' | 'contract' | 'fixed_asset' | 'customer' | 'vendor' | 'company' | 'sales_order' | 'cash_sale' | 'customer_credit', required - `is_active` boolean - `is_required` boolean - `default_value` union - string - string[] - `options` string[], nullable, required - `is_active` boolean, nullable, required - `value` CustomFieldValueSchemaOut - `id` integer, required - `custom_field_id` integer, required - `custom_field_name` string, required - `custom_field_type` string, required - `custom_field_value_id` integer, required - `value` unknown, required - `created_at` string, required - `updated_at` string, required - `integration_remote_records` IntegrationRemoteRecordSchemaOut[] - `transactional_date` string, date-time, nullable - `external_source` ExternalIntegrationSourceOut - `integration_type` union, required - 'bill_com' | 'ramp' | 'zoho' | 'fivetran' | 'stripe' | 'finch' | 'hubspot' | 'brex' | 'cubby' | 'avalara' | 'deel' | 'tax1099' | 'sitelink' | 'postgresql' | 'qlik' | 'power_bi' | 'snowflake' | 'avidxchange' | 'concur' | 'salesforce' | 'hmrc' | 'rippling' - 'quickbooks' | 'xero' | 'stripe' - string - `external_integration_url` string, nullable, required - `id` integer, required - `source_id` string, required - `connection_id` integer, nullable - `integration_id` integer, nullable - `integration_provider` IntegrationProviderSchemaOut - `id` integer, required - `name` string, required - `integration_type` union, required - 'bill_com' | 'ramp' | 'zoho' | 'fivetran' | 'stripe' | 'finch' | 'hubspot' | 'brex' | 'cubby' | 'avalara' | 'deel' | 'tax1099' | 'sitelink' | 'postgresql' | 'qlik' | 'power_bi' | 'snowflake' | 'avidxchange' | 'concur' | 'salesforce' | 'hmrc' | 'rippling' - string - `logo_url` string, nullable - `website` string, nullable - `description` string, nullable - `category` string, nullable - `url` string, nullable - `created_by` AuditActorSchemaOut — Schema for audit actor information. - `actor_type` string, nullable - `email` string, nullable - `first_name` string, nullable - `last_name` string, nullable - `timestamp` string, date-time, nullable - `updated_by` AuditActorSchemaOut — Schema for audit actor information. - `actor_type` string, nullable - `email` string, nullable - `first_name` string, nullable - `last_name` string, nullable - `timestamp` string, date-time, nullable - `internal_id` integer, required - `number` integer, required - `invoice_number` integer, nullable, required - `cash_sale_number` integer, nullable, required - `date` string, date, required — Posting date (GL date) - the date when the transaction is recorded in the general ledger - `transaction_date` string, date, required — Transaction date (inception date) - the date when the transaction actually occurred - `company_id` integer, required - `company_name` string, required - `company_currency` string, required - `currency_iso_4217_code` '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', required - `exchange_rate` string, required - `amount` string, required — Total transaction amount - `used_amount` string, required — Amount that was already applied to Invoices through Customer Refunds or Customer Prepayment Applications - `remaining_amount` string, required — Amount that can be applied to Invoices through Customer Refunds or Customer Prepayment Applications - `memo` string, required - `items` PublicCustomerCreditItemOut[], required - `classifications` PublicRecordClassificationsSchemaOut[] - `id` integer, required - `name` string, required - `line_id` integer, required - `line_name` string, required - `parent_classification_id` integer, nullable - `parent_classification_line_id` integer, nullable - `item_type` string, nullable - `hsn_sac_code` string, nullable - `tax` ItemTaxDataOut - `code` string, required - `rate` string, required - `amount` string, required - `is_taxable` boolean, nullable - `tax_exempt_amount` string, nullable - `vat_rate_id` integer, nullable - `gst_tax_rate_id` integer, nullable - `tax_metadata` object, nullable - `tax_components` TaxComponentSchema[], nullable - `component_type` 'CGST' | 'SGST' | 'IGST' | 'CESS' | 'GST' | 'PST' | 'HST' | 'QST', required - `rate` string, required - `amount` string, required - `region` string, nullable - `position` integer, required - `amount_with_tax` string, nullable - `rate_name` string, nullable - `rate_type` string, nullable - `tax_treatment` string, nullable - `item_id` integer, required - `quantity` string, required - `rate` string, required - `position` integer, required - `memo` string, required - `net_amount` string, required — Net amount before tax - `tax_amount` string, required — Calculated tax amount - `gross_amount` string, required — Calculated total amount including tax - `amount` string, required — Calculated total amount including tax named amount for backward compatibility - `record_status` 'draft' | 'posted' | 'archived', required - `contract_id` integer, nullable - `contracted` boolean - `created_at` string, date-time, required — Date and time the record was created - `updated_at` string, date-time, required — Date and time the record was last updated - `count` integer, required ## Other responses - `400` — Bad Request --- [API](https://skmtc.net/dualentry/apis/dualentry-public-api-2.md) · [All operations](https://skmtc.net/dualentry/apis/dualentry-public-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dualentry/dualentry-public-api-2/versions/77cd3c6ec719/schema)