e-invoice-api/resources/outbox.d.ts

The official TypeScript library for the e-invoice API

import { APIResource } from "../core/resource.js";
import * as InboxAPI from "./inbox.js";
import * as DocumentsAPI from "./documents/documents.js";
import { DocumentResponsesDocumentsNumberPage } from "./documents/documents.js";
import { type DocumentsNumberPageParams, PagePromise } from "../core/pagination.js";
import { RequestOptions } from "../internal/request-options.js";
export declare class Outbox extends APIResource {
    /**
     * Retrieve a paginated list of draft documents with filtering options.
     */
    listDraftDocuments(query?: OutboxListDraftDocumentsParams | null | undefined, options?: RequestOptions): PagePromise<DocumentResponsesDocumentsNumberPage, DocumentsAPI.DocumentResponse>;
    /**
     * Retrieve a paginated list of sent documents with filtering options including
     * state, type, sender, date range, and text search.
     */
    listReceivedDocuments(query?: OutboxListReceivedDocumentsParams | null | undefined, options?: RequestOptions): PagePromise<DocumentResponsesDocumentsNumberPage, DocumentsAPI.DocumentResponse>;
}
export interface OutboxListDraftDocumentsParams extends DocumentsNumberPageParams {
}
export interface OutboxListReceivedDocumentsParams extends DocumentsNumberPageParams {
    /**
     * Filter by issue date (from)
     */
    date_from?: string | null;
    /**
     * Filter by issue date (to)
     */
    date_to?: string | null;
    /**
     * Search in invoice number, seller/buyer names
     */
    search?: string | null;
    /**
     * Filter by sender ID
     */
    sender?: string | null;
    /**
     * Filter by document state
     */
    state?: InboxAPI.DocumentState | null;
    /**
     * Filter by document type
     */
    type?: DocumentsAPI.DocumentType | null;
}
export declare namespace Outbox {
    export { type OutboxListDraftDocumentsParams as OutboxListDraftDocumentsParams, type OutboxListReceivedDocumentsParams as OutboxListReceivedDocumentsParams, };
}
export { type DocumentResponsesDocumentsNumberPage };
//# sourceMappingURL=outbox.d.ts.map