@getopenpay/client/apis/CreditNotesApi.d.ts

OpenPay API TypeScript SDK

/**
 * OpenPay API
 * super charge your subscription management.
 *
 * The version of the OpenAPI document: 1.2.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import * as runtime from '../runtime';
import type { CreateCreditNoteRequest, CreditNoteExternal, CreditNoteQueryParams, ListResponseCreditNoteExternal } from '../models/index';
export interface CreateCreditNoteOperationRequest {
    createCreditNoteRequest: CreateCreditNoteRequest;
}
export interface GetCreditNoteRequest {
    creditNoteId: string;
}
export interface ListCreditNotesRequest {
    creditNoteQueryParams: CreditNoteQueryParams;
}
/**
 *
 */
export declare class CreditNotesApi extends runtime.BaseAPI {
    /**
     * Issue a credit note to adjust the amount of a finalized invoice. You may issue multiple credit notes for an invoice. The sum of all credit notes issued for an invoice can’t exceed the  total amount of the invoice. For a paid invoice, the sum of the refund and credit must equal the invoice total. Each credit note will increment the invoice’s pre_payment_credit_notes_amount_atom  or post_payment_credit_notes_amount_atom depending on its status at the time  of credit note creation.
     * Create Credit Note
     */
    createCreditNoteRaw(requestParameters: CreateCreditNoteOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreditNoteExternal>>;
    /**
     * Issue a credit note to adjust the amount of a finalized invoice. You may issue multiple credit notes for an invoice. The sum of all credit notes issued for an invoice can’t exceed the  total amount of the invoice. For a paid invoice, the sum of the refund and credit must equal the invoice total. Each credit note will increment the invoice’s pre_payment_credit_notes_amount_atom  or post_payment_credit_notes_amount_atom depending on its status at the time  of credit note creation.
     * Create Credit Note
     */
    createCreditNote(requestParameters: CreateCreditNoteOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreditNoteExternal>;
    /**
     * Get Credit Note
     */
    getCreditNoteRaw(requestParameters: GetCreditNoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreditNoteExternal>>;
    /**
     * Get Credit Note
     */
    getCreditNote(requestParameters: GetCreditNoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreditNoteExternal>;
    /**
     * List Credit Notes
     */
    listCreditNotesRaw(requestParameters: ListCreditNotesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseCreditNoteExternal>>;
    /**
     * List Credit Notes
     */
    listCreditNotes(requestParameters: ListCreditNotesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseCreditNoteExternal>;
}