import {z} from 'zod' export type GetApiApiInvoicesIdArgs = {id: string, omit?: string | undefined, fields?: string | undefined}; export type GetApiApiInvoicesIdOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const id = z.string(); export const link = z.string().nullable(); export const collectedAt = z.string(); export const createdAt = z.string(); export const enumInvoiceSatInvoiceType = z.enum(["Egreso", "Ingreso", "NĂ³mina", "Pago", "Traslado"]).nullable(); export const enumInvoiceType = z.enum(["OUTFLOW", "INFLOW", "null"]).nullable(); export const taxDetailsInvoicesSat = z.object({total_tax_retained: z.number().optional(), total_tax_transferred: z.number().optional(), retained_taxes: z.array(z.object({tax_type: z.string().nullable().optional(), tax: z.string().optional(), tax_percentage: z.number().nullable().optional(), pre_tax_amount: z.number().nullable().optional(), tax_amount: z.number().optional()})).optional(), transferred_taxes: z.array(z.object({tax_type: z.string().nullable().optional(), tax: z.string().optional(), tax_percentage: z.number().optional(), pre_tax_amount: z.number().optional(), tax_amount: z.number().optional()})).optional()}); export const enumInvoiceSatPaymentMethod = z.enum(["PUE", "PPD", "null"]).nullable(); export const invoiceDetailRetainedTaxSat = z.object({collected_at: collectedAt.optional(), tax_type: z.string().nullable().optional(), tax: z.string().nullable(), tax_percentage: z.number().nullable(), retained_tax_amount: z.number().nullable()}); export const invoiceDetailTransferredTaxSat = z.object({collected_at: collectedAt.optional(), tax_type: z.string().nullable().optional(), tax: z.string().nullable(), tax_percentage: z.number().nullable(), transferred_tax_amount: z.number().nullable()}); export const invoiceDetailSat = z.object({collected_at: collectedAt.optional(), description: z.string().nullable(), product_identification: z.string().nullable(), quantity: z.number().nullable(), unit_code: z.string().nullable(), unit_description: z.string().nullable(), unit_amount: z.number().nullable(), discount: z.number().nullable().optional(), tax_subject_code: z.string().nullable().optional(), identifier_number: z.string().nullable().optional(), pre_tax_amount: z.number().nullable(), tax_percentage: z.number().nullable(), tax_amount: z.number().nullable(), total_amount: z.number().nullable(), retained_taxes: z.array(invoiceDetailRetainedTaxSat).optional(), transferred_taxes: z.array(invoiceDetailTransferredTaxSat).optional()}); export const relatedInvoiceSat = z.object({relationship_type: z.string().nullable().optional(), related_invoice_identification: z.string().nullable().optional()}); export const invoicesPaymentsRelatedDocumentsSat = z.object({invoice_identification: z.string().nullable(), currency: z.string().nullable(), payment_method: z.string().nullable(), partiality_number: z.number().int().optional(), previous_balance: z.number().nullable(), amount_paid: z.number().nullable(), outstanding_balance: z.number().nullable()}); export const invoicesPaymentsSat = z.object({date: z.string().nullable(), payment_type: z.string().nullable(), currency: z.string().nullable(), exchange_rate: z.string().nullable(), amount: z.number().nullable(), operation_number: z.string().nullable(), beneficiary_rfc: z.string().nullable().optional(), beneficiary_account_number: z.string().nullable(), payer_rfc: z.string().nullable(), payer_account_number: z.string().nullable(), payer_bank_name: z.string().nullable(), related_documents: z.array(invoicesPaymentsRelatedDocumentsSat)}); export const enumInvoicePayrollPeriodicity = z.enum(["DAILY", "WEEKLY", "TENTH_DAY", "FOURTEENTH_DAY", "FIFTEENTH_DAY", "MONTHLY", "BIMONTHLY", "PER_TASK", "COMMISSION", "ONE_OFF", "OTHER_PERIODICITY", "null"]).nullable(); export const invoicePayrollEarningsBreakdown = z.object({type: z.string().nullable().optional(), taxable_amount: z.number().optional(), vat_free_amount: z.number().optional()}).nullable(); export const invoicePayrollTaxDeductions = z.object({type: z.string().nullable().optional(), amount: z.number().optional()}).nullable(); export const invoicePayrollOtherPayments = z.object({type: z.string().nullable().optional(), amount: z.number().optional()}).nullable(); export const invoicesPayrollSat = z.object({days: z.number().int().nullable(), type: z.string().nullable(), amount: z.number(), version: z.string(), date_from: z.string().nullable(), date_to: z.string().nullable(), collected_at: collectedAt.optional(), payment_date: z.string(), periodicity: enumInvoicePayrollPeriodicity.optional(), earnings_breakdown: z.array(invoicePayrollEarningsBreakdown).nullable().optional(), tax_deductions: z.array(invoicePayrollTaxDeductions).nullable().optional(), other_payments: z.array(invoicePayrollOtherPayments).nullable().optional()}).nullable(); export const invoiceWarningsSat = z.object({code: z.string().nullable(), message: z.string().nullable()}).nullable(); export const invoiceWithIdSat = z.object({id: id.optional(), link: link.optional(), collected_at: collectedAt, created_at: createdAt.optional(), invoice_identification: z.string().nullable(), invoice_date: z.string().nullable(), status: z.string().nullable(), invoice_type: enumInvoiceSatInvoiceType, type: enumInvoiceType, tax_details: taxDetailsInvoicesSat.optional(), sender_id: z.string().nullable(), sender_fiscal_regime: z.string().nullable().optional(), sender_name: z.string().nullable(), sender_tax_fraud_status: z.string().nullable().optional(), receiver_id: z.string().nullable(), receiver_postal_code: z.string().optional(), receiver_fiscal_regime: z.string().nullable().optional(), receiver_name: z.string().nullable(), receiver_tax_fraud_status: z.string().nullable().optional(), cancelation_status: z.string().nullable(), cancelation_update_date: z.string().nullable(), certification_date: z.string().nullable(), certification_authority: z.string().nullable(), payment_type: z.string().nullable(), payment_type_description: z.string().nullable(), payment_method: enumInvoiceSatPaymentMethod.optional(), payment_method_description: z.string().nullable().optional(), usage: z.string().nullable().optional(), version: z.string().nullable().optional(), place_of_issue: z.string().nullable().optional(), invoice_details: z.array(invoiceDetailSat), currency: z.string().nullable(), subtotal_amount: z.number().nullable(), exchange_rate: z.number().nullable(), tax_amount: z.number().nullable(), discount_amount: z.number().nullable(), total_amount: z.number().nullable(), related_invoices: z.array(relatedInvoiceSat).optional(), payments: z.array(invoicesPaymentsSat), payroll: invoicesPayrollSat, folio: z.string().nullable().optional(), series: z.string().nullable().optional(), export_type: z.string().nullable().optional(), xml: z.string().nullable().optional(), warnings: invoiceWarningsSat.optional(), sender_blacklist_status: z.string().nullable().optional(), receiver_blacklist_status: z.string().nullable().optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get an invoice's details * * GET /api/invoices/{id}/ */ export const getApiApiInvoicesId = async (args: GetApiApiInvoicesIdArgs, options?: GetApiApiInvoicesIdOptions) => { const {baseUrl = "https://sandbox.belvo.com", fetch: fetchFn = fetch, basicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.omit != null) query.append("omit", String(args.omit)) if (args.fields != null) query.append("fields", String(args.fields)) if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/invoices/${encodeURIComponent(String(args.id))}/${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(invoiceWithIdSat, await res.json()) };