/** * Generated by orval v8.5.3 🍺 * Do not edit manually. * Space Invoices API * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking. * OpenAPI spec version: 1.0.0 */ import * as zod from "zod"; /** * Record a payment against an outgoing document or an incoming purchase document. At least one document reference is required. For new direct outgoing payments, prefer `document_id`; the API infers `invoice_id`, `credit_note_id`, or `advance_invoice_id` from the ID prefix. Legacy type-specific fields remain supported for backward compatibility. For outgoing type `credit_note`, both `invoice_id` and `credit_note_id` are required. For incoming settlement type `credit_note`, both `incoming_purchase_document_id` and `applied_to_incoming_purchase_document_id` are required. Document payment totals are automatically updated. Credit note refunds or settlements cannot exceed the remaining credit balance. * @summary Create a new payment */ export declare const CreatePaymentHeader: zod.ZodObject<{ "x-entity-id": zod.ZodOptional; }, zod.z.core.$strip>; export declare const createPaymentBodyInvoiceIdMax = 36; export declare const createPaymentBodyCreditNoteIdMax = 36; export declare const createPaymentBodyAdvanceInvoiceIdMax = 36; export declare const createPaymentBodyIncomingPurchaseDocumentIdMax = 36; export declare const createPaymentBodyAppliedToIncomingPurchaseDocumentIdMax = 36; export declare const createPaymentBodyAmountExclusiveMin = 0; export declare const createPaymentBodyTagMax = 100; export declare const createPaymentBodyReferenceMax = 100; export declare const createPaymentBodyNoteMax = 500; export declare const createPaymentBodyDocumentIdMax = 36; export declare const CreatePaymentBody: zod.ZodObject<{ invoice_id: zod.ZodOptional>; credit_note_id: zod.ZodOptional>; advance_invoice_id: zod.ZodOptional>; incoming_purchase_document_id: zod.ZodOptional>; applied_to_incoming_purchase_document_id: zod.ZodOptional>; amount: zod.ZodNumber; type: zod.ZodEnum<{ advance: "advance"; other: "other"; credit_note: "credit_note"; cash: "cash"; card: "card"; bank_transfer: "bank_transfer"; paypal: "paypal"; coupon: "coupon"; check: "check"; }>; date: zod.ZodOptional; tag: zod.ZodOptional>; reference: zod.ZodOptional>; note: zod.ZodOptional>; metadata: zod.ZodOptional>>; document_id: zod.ZodOptional>; }, zod.z.core.$strip>; /** * Retrieve a paginated list of payments with optional filtering and sorting. Supports cursor-based pagination, flexible JSON querying with MongoDB-style operators, full-text search, and sorting across both outgoing and incoming purchase document payment references. * @summary List all payments */ export declare const getPaymentsQueryLimitDefault = 10; export declare const getPaymentsQueryLimitMax = 100; export declare const GetPaymentsQueryParams: zod.ZodObject<{ limit: zod.ZodDefault; next_cursor: zod.ZodOptional; prev_cursor: zod.ZodOptional; include_total_count: zod.ZodOptional; order_by: zod.ZodOptional, zod.ZodArray>]>>; query: zod.ZodOptional; search: zod.ZodOptional; include: zod.ZodOptional; deleted: zod.ZodOptional; }, zod.z.core.$strip>; export declare const GetPaymentsHeader: zod.ZodObject<{ "x-entity-id": zod.ZodOptional; }, zod.z.core.$strip>; export declare const getPaymentsResponseDataItemIdMax = 36; export declare const getPaymentsResponseDataItemInvoiceIdMax = 36; export declare const getPaymentsResponseDataItemCreditNoteIdMax = 36; export declare const getPaymentsResponseDataItemAdvanceInvoiceIdMax = 36; export declare const getPaymentsResponseDataItemIncomingPurchaseDocumentIdMax = 36; export declare const getPaymentsResponseDataItemAppliedToIncomingPurchaseDocumentIdMax = 36; export declare const getPaymentsResponseDataItemAmountMin = -140737488355328; export declare const getPaymentsResponseDataItemAmountMax = 140737488355327; export declare const getPaymentsResponseDataItemCurrencyCodeMax = 3; export declare const getPaymentsResponseDataItemAmountConvertedMin = -140737488355328; export declare const getPaymentsResponseDataItemAmountConvertedMax = 140737488355327; export declare const getPaymentsResponseDataItemTagMax = 100; export declare const getPaymentsResponseDataItemReferenceMax = 100; export declare const getPaymentsResponseDataItemNoteMax = 500; export declare const getPaymentsResponseDataItemEntityIdMax = 36; export declare const getPaymentsResponseDataItemInvoiceIdMaxOne = 36; export declare const getPaymentsResponseDataItemInvoiceNumberMax = 100; export declare const getPaymentsResponseDataItemCreditNoteIdMaxOne = 36; export declare const getPaymentsResponseDataItemCreditNoteNumberMax = 100; export declare const getPaymentsResponseDataItemAdvanceInvoiceIdMaxOne = 36; export declare const getPaymentsResponseDataItemAdvanceInvoiceNumberMax = 100; export declare const getPaymentsResponseDataItemIncomingPurchaseDocumentIdMaxOne = 36; export declare const getPaymentsResponseDataItemIncomingPurchaseDocumentSupplierDocumentNumberMax = 255; export declare const getPaymentsResponseDataItemIncomingPurchaseDocumentDateRegExp: RegExp; export declare const getPaymentsResponseDataItemIncomingPurchaseDocumentTotalWithTaxMin = -140737488355328; export declare const getPaymentsResponseDataItemIncomingPurchaseDocumentTotalWithTaxMax = 140737488355327; export declare const getPaymentsResponseDataItemAppliedToIncomingPurchaseDocumentIdMaxOne = 36; export declare const getPaymentsResponseDataItemAppliedToIncomingPurchaseDocumentSupplierDocumentNumberMax = 255; export declare const getPaymentsResponseDataItemAppliedToIncomingPurchaseDocumentDateRegExp: RegExp; export declare const getPaymentsResponseDataItemAppliedToIncomingPurchaseDocumentTotalWithTaxMin = -140737488355328; export declare const getPaymentsResponseDataItemAppliedToIncomingPurchaseDocumentTotalWithTaxMax = 140737488355327; export declare const GetPaymentsResponse: zod.ZodObject<{ data: zod.ZodArray>; credit_note_id: zod.ZodOptional>; advance_invoice_id: zod.ZodOptional>; incoming_purchase_document_id: zod.ZodOptional>; applied_to_incoming_purchase_document_id: zod.ZodOptional>; amount: zod.ZodNumber; currency_code: zod.ZodString; amount_converted: zod.ZodNumber; type: zod.ZodEnum<{ advance: "advance"; other: "other"; credit_note: "credit_note"; cash: "cash"; card: "card"; bank_transfer: "bank_transfer"; paypal: "paypal"; coupon: "coupon"; check: "check"; }>; date: zod.z.ZodISODateTime; tag: zod.ZodOptional>; reference: zod.ZodOptional>; note: zod.ZodOptional>; entity_id: zod.ZodString; metadata: zod.ZodOptional>>; deleted_at: zod.ZodOptional>; created_at: zod.z.ZodISODateTime; updated_at: zod.z.ZodISODateTime; Invoice: zod.ZodOptional>>; CreditNote: zod.ZodOptional>>; AdvanceInvoice: zod.ZodOptional>>; IncomingPurchaseDocument: zod.ZodOptional; supplier_document_number: zod.ZodOptional>; date: zod.ZodOptional>; total_with_tax: zod.ZodOptional>; }, zod.z.core.$strip>>>; AppliedToIncomingPurchaseDocument: zod.ZodOptional; supplier_document_number: zod.ZodOptional>; date: zod.ZodOptional>; total_with_tax: zod.ZodOptional>; }, zod.z.core.$strip>>>; }, zod.z.core.$strip>>; pagination: zod.ZodObject<{ total: zod.ZodNumber; next_cursor: zod.ZodNullable; prev_cursor: zod.ZodNullable; has_more: zod.ZodBoolean; }, zod.z.core.$strip>; }, zod.z.core.$strip>; /** * Retrieve a single payment by its unique identifier. Returns the complete payment details including amount, type, date, and reference information. * @summary Get payment by ID */ export declare const getPaymentByIdPathIdRegExp: RegExp; export declare const GetPaymentByIdParams: zod.ZodObject<{ id: zod.ZodCustomStringFormat<"resource-id">; }, zod.z.core.$strip>; export declare const GetPaymentByIdQueryParams: zod.ZodObject<{ include: zod.ZodOptional; }, zod.z.core.$strip>; export declare const GetPaymentByIdHeader: zod.ZodObject<{ "x-entity-id": zod.ZodOptional; }, zod.z.core.$strip>; export declare const getPaymentByIdResponseIdMax = 36; export declare const getPaymentByIdResponseInvoiceIdMax = 36; export declare const getPaymentByIdResponseCreditNoteIdMax = 36; export declare const getPaymentByIdResponseAdvanceInvoiceIdMax = 36; export declare const getPaymentByIdResponseIncomingPurchaseDocumentIdMax = 36; export declare const getPaymentByIdResponseAppliedToIncomingPurchaseDocumentIdMax = 36; export declare const getPaymentByIdResponseAmountMin = -140737488355328; export declare const getPaymentByIdResponseAmountMax = 140737488355327; export declare const getPaymentByIdResponseCurrencyCodeMax = 3; export declare const getPaymentByIdResponseAmountConvertedMin = -140737488355328; export declare const getPaymentByIdResponseAmountConvertedMax = 140737488355327; export declare const getPaymentByIdResponseTagMax = 100; export declare const getPaymentByIdResponseReferenceMax = 100; export declare const getPaymentByIdResponseNoteMax = 500; export declare const getPaymentByIdResponseEntityIdMax = 36; export declare const getPaymentByIdResponseInvoiceIdMaxOne = 36; export declare const getPaymentByIdResponseInvoiceNumberMax = 100; export declare const getPaymentByIdResponseCreditNoteIdMaxOne = 36; export declare const getPaymentByIdResponseCreditNoteNumberMax = 100; export declare const getPaymentByIdResponseAdvanceInvoiceIdMaxOne = 36; export declare const getPaymentByIdResponseAdvanceInvoiceNumberMax = 100; export declare const getPaymentByIdResponseIncomingPurchaseDocumentIdMaxOne = 36; export declare const getPaymentByIdResponseIncomingPurchaseDocumentSupplierDocumentNumberMax = 255; export declare const getPaymentByIdResponseIncomingPurchaseDocumentDateRegExp: RegExp; export declare const getPaymentByIdResponseIncomingPurchaseDocumentTotalWithTaxMin = -140737488355328; export declare const getPaymentByIdResponseIncomingPurchaseDocumentTotalWithTaxMax = 140737488355327; export declare const getPaymentByIdResponseAppliedToIncomingPurchaseDocumentIdMaxOne = 36; export declare const getPaymentByIdResponseAppliedToIncomingPurchaseDocumentSupplierDocumentNumberMax = 255; export declare const getPaymentByIdResponseAppliedToIncomingPurchaseDocumentDateRegExp: RegExp; export declare const getPaymentByIdResponseAppliedToIncomingPurchaseDocumentTotalWithTaxMin = -140737488355328; export declare const getPaymentByIdResponseAppliedToIncomingPurchaseDocumentTotalWithTaxMax = 140737488355327; export declare const GetPaymentByIdResponse: zod.ZodObject<{ id: zod.ZodString; invoice_id: zod.ZodOptional>; credit_note_id: zod.ZodOptional>; advance_invoice_id: zod.ZodOptional>; incoming_purchase_document_id: zod.ZodOptional>; applied_to_incoming_purchase_document_id: zod.ZodOptional>; amount: zod.ZodNumber; currency_code: zod.ZodString; amount_converted: zod.ZodNumber; type: zod.ZodEnum<{ advance: "advance"; other: "other"; credit_note: "credit_note"; cash: "cash"; card: "card"; bank_transfer: "bank_transfer"; paypal: "paypal"; coupon: "coupon"; check: "check"; }>; date: zod.z.ZodISODateTime; tag: zod.ZodOptional>; reference: zod.ZodOptional>; note: zod.ZodOptional>; entity_id: zod.ZodString; metadata: zod.ZodOptional>>; deleted_at: zod.ZodOptional>; created_at: zod.z.ZodISODateTime; updated_at: zod.z.ZodISODateTime; Invoice: zod.ZodOptional>>; CreditNote: zod.ZodOptional>>; AdvanceInvoice: zod.ZodOptional>>; IncomingPurchaseDocument: zod.ZodOptional; supplier_document_number: zod.ZodOptional>; date: zod.ZodOptional>; total_with_tax: zod.ZodOptional>; }, zod.z.core.$strip>>>; AppliedToIncomingPurchaseDocument: zod.ZodOptional; supplier_document_number: zod.ZodOptional>; date: zod.ZodOptional>; total_with_tax: zod.ZodOptional>; }, zod.z.core.$strip>>>; }, zod.z.core.$strip>; /** * Update an existing payment. Only the provided fields will be updated. Document references cannot be changed. If amount is changed, payment totals on all linked outgoing or incoming documents are automatically recalculated. System-managed settlement payments cannot be modified. * @summary Update a payment */ export declare const updatePaymentPathIdRegExp: RegExp; export declare const UpdatePaymentParams: zod.ZodObject<{ id: zod.ZodCustomStringFormat<"resource-id">; }, zod.z.core.$strip>; export declare const UpdatePaymentHeader: zod.ZodObject<{ "x-entity-id": zod.ZodOptional; }, zod.z.core.$strip>; export declare const updatePaymentBodyAmountExclusiveMin = 0; export declare const updatePaymentBodyTagMax = 100; export declare const updatePaymentBodyReferenceMax = 100; export declare const updatePaymentBodyNoteMax = 500; export declare const UpdatePaymentBody: zod.ZodObject<{ amount: zod.ZodOptional; type: zod.ZodOptional>; date: zod.ZodOptional; tag: zod.ZodOptional>; reference: zod.ZodOptional>; note: zod.ZodOptional>; metadata: zod.ZodOptional>>; }, zod.z.core.$strip>; export declare const updatePaymentResponseIdMax = 36; export declare const updatePaymentResponseInvoiceIdMax = 36; export declare const updatePaymentResponseCreditNoteIdMax = 36; export declare const updatePaymentResponseAdvanceInvoiceIdMax = 36; export declare const updatePaymentResponseIncomingPurchaseDocumentIdMax = 36; export declare const updatePaymentResponseAppliedToIncomingPurchaseDocumentIdMax = 36; export declare const updatePaymentResponseAmountMin = -140737488355328; export declare const updatePaymentResponseAmountMax = 140737488355327; export declare const updatePaymentResponseCurrencyCodeMax = 3; export declare const updatePaymentResponseAmountConvertedMin = -140737488355328; export declare const updatePaymentResponseAmountConvertedMax = 140737488355327; export declare const updatePaymentResponseTagMax = 100; export declare const updatePaymentResponseReferenceMax = 100; export declare const updatePaymentResponseNoteMax = 500; export declare const updatePaymentResponseEntityIdMax = 36; export declare const updatePaymentResponseInvoiceIdMaxOne = 36; export declare const updatePaymentResponseInvoiceNumberMax = 100; export declare const updatePaymentResponseCreditNoteIdMaxOne = 36; export declare const updatePaymentResponseCreditNoteNumberMax = 100; export declare const updatePaymentResponseAdvanceInvoiceIdMaxOne = 36; export declare const updatePaymentResponseAdvanceInvoiceNumberMax = 100; export declare const updatePaymentResponseIncomingPurchaseDocumentIdMaxOne = 36; export declare const updatePaymentResponseIncomingPurchaseDocumentSupplierDocumentNumberMax = 255; export declare const updatePaymentResponseIncomingPurchaseDocumentDateRegExp: RegExp; export declare const updatePaymentResponseIncomingPurchaseDocumentTotalWithTaxMin = -140737488355328; export declare const updatePaymentResponseIncomingPurchaseDocumentTotalWithTaxMax = 140737488355327; export declare const updatePaymentResponseAppliedToIncomingPurchaseDocumentIdMaxOne = 36; export declare const updatePaymentResponseAppliedToIncomingPurchaseDocumentSupplierDocumentNumberMax = 255; export declare const updatePaymentResponseAppliedToIncomingPurchaseDocumentDateRegExp: RegExp; export declare const updatePaymentResponseAppliedToIncomingPurchaseDocumentTotalWithTaxMin = -140737488355328; export declare const updatePaymentResponseAppliedToIncomingPurchaseDocumentTotalWithTaxMax = 140737488355327; export declare const UpdatePaymentResponse: zod.ZodObject<{ id: zod.ZodString; invoice_id: zod.ZodOptional>; credit_note_id: zod.ZodOptional>; advance_invoice_id: zod.ZodOptional>; incoming_purchase_document_id: zod.ZodOptional>; applied_to_incoming_purchase_document_id: zod.ZodOptional>; amount: zod.ZodNumber; currency_code: zod.ZodString; amount_converted: zod.ZodNumber; type: zod.ZodEnum<{ advance: "advance"; other: "other"; credit_note: "credit_note"; cash: "cash"; card: "card"; bank_transfer: "bank_transfer"; paypal: "paypal"; coupon: "coupon"; check: "check"; }>; date: zod.z.ZodISODateTime; tag: zod.ZodOptional>; reference: zod.ZodOptional>; note: zod.ZodOptional>; entity_id: zod.ZodString; metadata: zod.ZodOptional>>; deleted_at: zod.ZodOptional>; created_at: zod.z.ZodISODateTime; updated_at: zod.z.ZodISODateTime; Invoice: zod.ZodOptional>>; CreditNote: zod.ZodOptional>>; AdvanceInvoice: zod.ZodOptional>>; IncomingPurchaseDocument: zod.ZodOptional; supplier_document_number: zod.ZodOptional>; date: zod.ZodOptional>; total_with_tax: zod.ZodOptional>; }, zod.z.core.$strip>>>; AppliedToIncomingPurchaseDocument: zod.ZodOptional; supplier_document_number: zod.ZodOptional>; date: zod.ZodOptional>; total_with_tax: zod.ZodOptional>; }, zod.z.core.$strip>>>; }, zod.z.core.$strip>; /** * Soft delete a payment by its unique identifier. The payment is moved to trash and can be restored later. Payment totals on all linked outgoing or incoming documents are automatically recalculated after deletion. System-managed settlement payments remain immutable. * @summary Delete a payment */ export declare const deletePaymentPathIdRegExp: RegExp; export declare const DeletePaymentParams: zod.ZodObject<{ id: zod.ZodCustomStringFormat<"resource-id">; }, zod.z.core.$strip>; export declare const DeletePaymentHeader: zod.ZodObject<{ "x-entity-id": zod.ZodOptional; }, zod.z.core.$strip>; /** * Restore a soft-deleted payment from the trash. Document payment totals are automatically recalculated. * @summary Restore a deleted payment */ export declare const restorePaymentPathIdRegExp: RegExp; export declare const RestorePaymentParams: zod.ZodObject<{ id: zod.ZodCustomStringFormat<"resource-id">; }, zod.z.core.$strip>; export declare const RestorePaymentHeader: zod.ZodObject<{ "x-entity-id": zod.ZodOptional; }, zod.z.core.$strip>; export declare const restorePaymentResponseIdMax = 36; export declare const restorePaymentResponseInvoiceIdMax = 36; export declare const restorePaymentResponseCreditNoteIdMax = 36; export declare const restorePaymentResponseAdvanceInvoiceIdMax = 36; export declare const restorePaymentResponseIncomingPurchaseDocumentIdMax = 36; export declare const restorePaymentResponseAppliedToIncomingPurchaseDocumentIdMax = 36; export declare const restorePaymentResponseAmountMin = -140737488355328; export declare const restorePaymentResponseAmountMax = 140737488355327; export declare const restorePaymentResponseCurrencyCodeMax = 3; export declare const restorePaymentResponseAmountConvertedMin = -140737488355328; export declare const restorePaymentResponseAmountConvertedMax = 140737488355327; export declare const restorePaymentResponseTagMax = 100; export declare const restorePaymentResponseReferenceMax = 100; export declare const restorePaymentResponseNoteMax = 500; export declare const restorePaymentResponseEntityIdMax = 36; export declare const restorePaymentResponseInvoiceIdMaxOne = 36; export declare const restorePaymentResponseInvoiceNumberMax = 100; export declare const restorePaymentResponseCreditNoteIdMaxOne = 36; export declare const restorePaymentResponseCreditNoteNumberMax = 100; export declare const restorePaymentResponseAdvanceInvoiceIdMaxOne = 36; export declare const restorePaymentResponseAdvanceInvoiceNumberMax = 100; export declare const restorePaymentResponseIncomingPurchaseDocumentIdMaxOne = 36; export declare const restorePaymentResponseIncomingPurchaseDocumentSupplierDocumentNumberMax = 255; export declare const restorePaymentResponseIncomingPurchaseDocumentDateRegExp: RegExp; export declare const restorePaymentResponseIncomingPurchaseDocumentTotalWithTaxMin = -140737488355328; export declare const restorePaymentResponseIncomingPurchaseDocumentTotalWithTaxMax = 140737488355327; export declare const restorePaymentResponseAppliedToIncomingPurchaseDocumentIdMaxOne = 36; export declare const restorePaymentResponseAppliedToIncomingPurchaseDocumentSupplierDocumentNumberMax = 255; export declare const restorePaymentResponseAppliedToIncomingPurchaseDocumentDateRegExp: RegExp; export declare const restorePaymentResponseAppliedToIncomingPurchaseDocumentTotalWithTaxMin = -140737488355328; export declare const restorePaymentResponseAppliedToIncomingPurchaseDocumentTotalWithTaxMax = 140737488355327; export declare const RestorePaymentResponse: zod.ZodObject<{ id: zod.ZodString; invoice_id: zod.ZodOptional>; credit_note_id: zod.ZodOptional>; advance_invoice_id: zod.ZodOptional>; incoming_purchase_document_id: zod.ZodOptional>; applied_to_incoming_purchase_document_id: zod.ZodOptional>; amount: zod.ZodNumber; currency_code: zod.ZodString; amount_converted: zod.ZodNumber; type: zod.ZodEnum<{ advance: "advance"; other: "other"; credit_note: "credit_note"; cash: "cash"; card: "card"; bank_transfer: "bank_transfer"; paypal: "paypal"; coupon: "coupon"; check: "check"; }>; date: zod.z.ZodISODateTime; tag: zod.ZodOptional>; reference: zod.ZodOptional>; note: zod.ZodOptional>; entity_id: zod.ZodString; metadata: zod.ZodOptional>>; deleted_at: zod.ZodOptional>; created_at: zod.z.ZodISODateTime; updated_at: zod.z.ZodISODateTime; Invoice: zod.ZodOptional>>; CreditNote: zod.ZodOptional>>; AdvanceInvoice: zod.ZodOptional>>; IncomingPurchaseDocument: zod.ZodOptional; supplier_document_number: zod.ZodOptional>; date: zod.ZodOptional>; total_with_tax: zod.ZodOptional>; }, zod.z.core.$strip>>>; AppliedToIncomingPurchaseDocument: zod.ZodOptional; supplier_document_number: zod.ZodOptional>; date: zod.ZodOptional>; total_with_tax: zod.ZodOptional>; }, zod.z.core.$strip>>>; }, zod.z.core.$strip>; /** * Permanently delete a soft-deleted payment. Only payments in the trash can be permanently deleted. Document payment totals are automatically recalculated. * @summary Permanently delete a payment */ export declare const permanentDeletePaymentPathIdRegExp: RegExp; export declare const PermanentDeletePaymentParams: zod.ZodObject<{ id: zod.ZodCustomStringFormat<"resource-id">; }, zod.z.core.$strip>; export declare const PermanentDeletePaymentHeader: zod.ZodObject<{ "x-entity-id": zod.ZodOptional; }, zod.z.core.$strip>; //# sourceMappingURL=payments.d.ts.map