> ## Documentation Index > Fetch the complete documentation index at: https://docs.layerfi.com/llms.txt > Use this file to discover all available pages before exploring further. # Delete customer credit > Marks a customer credit as deleted (soft delete). ## OpenAPI ````yaml delete /v1/businesses/{businessId}/invoices/customer-credits/{customerCreditId} openapi: 3.0.1 info: title: API version: latest servers: [] security: - BearerAuth: [] tags: [] externalDocs: url: / paths: /v1/businesses/{businessId}/invoices/customer-credits/{customerCreditId}: delete: tags: [] summary: Delete customer credit description: Marks a customer credit as deleted (soft delete). operationId: business.invoices.customer-credits.delete parameters: - name: businessId in: path description: The UUID of the business the customer credit belongs to. required: true schema: type: string format: uuid - name: customerCreditId in: path description: The UUID of the customer credit to delete. required: true schema: type: string format: uuid responses: '200': description: Customer credit deleted successfully. content: application/json: schema: $ref: '#/components/schemas/ApiCustomerCredit' components: schemas: ApiCustomerCredit: type: object properties: id: type: string format: uuid description: Unique identifier for the customer credit. external_id: type: string description: External identifier for the customer credit. customer: $ref: '#/components/schemas/ApiCustomerData' description: The customer associated with this credit. sent_at: type: string format: date-time description: Timestamp when the customer credit was sent. line_items: type: array items: $ref: '#/components/schemas/ApiCustomerCreditLineItem' description: List of line items for this customer credit. allocations: type: array items: $ref: '#/components/schemas/ApiCustomerCreditAllocation' description: List of allocations for this customer credit. created_at: type: string format: date-time description: Timestamp when the customer credit was created. updated_at: type: string format: date-time description: Timestamp when the customer credit was last updated. deleted_at: type: string format: date-time description: Timestamp when the customer credit was deleted, if applicable. transaction_tags: type: array items: $ref: '#/components/schemas/ApiTag' description: List of tags associated with this customer credit. memo: type: string nullable: true description: >- Memo for any text you would like to associate with the customer credit (for example, to display to end users). metadata: $ref: '#/components/schemas/PlatformDefinedJson' nullable: true description: Arbitrary custom metadata in JSON format with a size limit of 1KB. reference_number: type: string nullable: true description: >- Any (typically user-visible) identifier you would like to associate with the customer credit. Can be used to filter when listing customer credits. required: - id - customer - received_at - line_items - created_at - updated_at - transaction_tags ApiCustomerData: type: object properties: id: type: string format: uuid description: Unique identifier for the customer. external_id: type: string description: >- Unique ID of the customer in your system for linking purposes. **Idempotency key**. example: '31415926535' individual_name: type: string nullable: true description: >- Full name of the individual customer or contact at a corporate customer. company_name: type: string nullable: true description: Name of the company customer. email: type: string nullable: true description: Email address of the customer. mobile_phone: type: string nullable: true description: Mobile phone number of the customer. office_phone: type: string nullable: true description: Office phone number of the customer. address_string: type: string nullable: true description: Address of the customer. memo: type: string nullable: true description: >- Memo for any text you would like to associate with the customer (for example, to display to end users). status: type: string description: 'Status of the customer. Possible values: `ACTIVE`, `ARCHIVED`.' example: ACTIVE transaction_tags: type: array items: $ref: '#/components/schemas/ApiTag' ApiCustomerCreditLineItem: type: object properties: id: type: string format: uuid description: Unique identifier for the customer credit line item. ledger_account: $ref: '#/components/schemas/SingleApiChartAccount' description: Ledger account for this line item. example: id: c4007474-f604-4d57-9690-b7f40f7a1cee name: 'Sales tax: CALIFORNIA' stable_name: SALES_TAXES_PAYABLE:CALIFORNIA normality: CREDIT account_type: value: LIABILITY display_name: Liabilities account_subtype: value: SALES_TAXES_PAYABLE display_name: Sales Taxes Payable amount: type: integer format: int64 description: Amount for the line item in cents. memo: type: string description: Description for the line item. metadata: $ref: '#/components/schemas/PlatformDefinedJson' nullable: true description: Arbitrary custom metadata in JSON format with a size limit of 1KB. reference_number: type: string nullable: true description: >- Any (typically user-visible) identifier you would like to associate with the customer credit line item. transaction_tags: type: array items: $ref: '#/components/schemas/ApiTag' description: List of tags associated with this customer credit line item. required: - id - amount ApiCustomerCreditAllocation: type: object properties: id: type: string format: uuid description: Unique identifier for the customer credit allocation. customer_credit_id: type: string format: uuid description: UUID of the customer credit this allocation belongs to. invoice_id: type: string format: uuid description: UUID of the invoice this allocation is for. amount: type: integer format: int64 description: Amount for the allocation in cents. required: - id - customer_credit_id - invoice_payment_id - amount ApiTag: type: object properties: id: type: string format: uuid description: ID for the tag. key: type: string description: Key for the tag. example: ExampleTagKey dimension_display_name: type: string nullable: true description: Display name for the tag dimension. value: type: string description: Value for the tag. example: ExampleTagValue value_display_name: type: string nullable: true description: Display name for the tag value definition. dimension_id: type: string format: uuid description: ID of the tag dimension this tag belongs to. definition_id: type: string format: uuid description: ID of the tag value definition. archived_at: type: string format: date-time nullable: true description: When the tag was archived. required: - id - key - value - dimension_id - definition_id PlatformDefinedJson: type: object description: Arbitrary JSON data defined by the caller, with a 1KB size constraint. additionalProperties: true example: custom_field: value any valid json: below 1kb nested: meaning of life: 42 array: [] SingleApiChartAccount: type: object properties: id: $ref: '#/components/schemas/AccountIdentifier' name: type: string description: Name of the account. example: Current Assets account_number: type: string nullable: true description: Account number if configured. example: '4000' stable_name: $ref: '#/components/schemas/AccountStableName' normality: $ref: '#/components/schemas/BankTransactionDirection' account_type: $ref: '#/components/schemas/ApiLedgerAccountType' account_subtype: $ref: '#/components/schemas/ApiLedgerAccountSubtype' description: A single ledger account without nested children. AccountIdentifier: oneOf: - $ref: '#/components/schemas/AccountId' description: ID of the account. title: Account ID - $ref: '#/components/schemas/AccountStableName' description: Stable name associated with the account. title: Account Stable Name AccountStableName: type: object required: - type - stable_name properties: type: type: string enum: - StableName description: Resource type. Value will be `StableName`. example: StableName stable_name: type: string example: CURRENT_ASSETS description: Stable name of the account. BankTransactionDirection: type: string enum: - CREDIT - DEBIT ApiLedgerAccountType: type: object properties: value: $ref: '#/components/schemas/LedgerAccountType' description: Type of the account. display_name: type: string description: Display name of the account type. example: Asset ApiLedgerAccountSubtype: type: object properties: value: $ref: '#/components/schemas/LedgerAccountSubtype' display_name: type: string description: Display name of the account subtype. example: Current Assets AccountId: type: object required: - type - id properties: type: type: string enum: - AccountId description: Resource type. Value will be `AccountId`. example: AccountId id: type: string format: uuid description: ID of the account. LedgerAccountType: type: string enum: - ASSET - LIABILITY - EQUITY - REVENUE - COGS - EXPENSE LedgerAccountSubtype: type: string enum: - BANK_ACCOUNTS - ACCOUNTS_RECEIVABLE - INVENTORY - PAYMENT_PROCESSOR_CLEARING_ACCOUNT - FIXED_ASSET - ACCUMULATED_DEPRECIATION - CASH - UNDEPOSITED_FUNDS - CURRENT_ASSET - NON_CURRENT_ASSET - PREPAID_EXPENSES - DEVELOPMENT_COSTS - LOANS_RECEIVABLE - INTANGIBLE_ASSET - ACCOUNTS_PAYABLE - CREDIT_CARD - TAXES_PAYABLE - INCOME_TAXES_PAYABLE - SALES_TAXES_PAYABLE - OTHER_TAXES_PAYABLE - PAYROLL_TAXES_PAYABLE - UNEARNED_REVENUE - PAYROLL_LIABILITY - PAYROLL_CLEARING - LINE_OF_CREDIT - TIPS - REFUND_LIABILITIES - UNDEPOSITED_OUTFLOWS - OUTGOING_PAYMENT_CLEARING_ACCOUNT - OTHER_CURRENT_LIABILITY - LOANS_PAYABLE - NOTES_PAYABLE - SHAREHOLDER_LOAN - NON_CURRENT_LIABILITY - CONTRIBUTIONS - DISTRIBUTIONS - COMMON_STOCK - PREFERRED_STOCK - ADDITIONAL_PAID_IN_CAPITAL - RETAINED_EARNINGS - ACCUMULATED_ADJUSTMENTS - OPENING_BALANCE_EQUITY - OTHER_EQUITY - SALES - UNCATEGORIZED_REVENUE - RETURNS_ALLOWANCES - DIVIDEND_INCOME - INTEREST_INCOME - OTHER_INCOME - COGS - OPERATING_EXPENSES - PAYROLL - TAXES_LICENSES - UNCATEGORIZED_EXPENSE - CHARITABLE_CONTRIBUTIONS - LOAN_EXPENSES - FINANCE_COSTS - INTEREST_EXPENSES - DEPRECIATION - AMORTIZATION - BAD_DEBT - OTHER_EXPENSES securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT ````