import {z} from 'zod' export type GetApiQuickbooksDesktopChecksArgs = {'Conductor-End-User-Id': string, ids?: Array | undefined, refNumbers?: Array | undefined, limit?: number | undefined, cursor?: string | undefined, updatedAfter?: string | undefined, updatedBefore?: string | undefined, transactionDateFrom?: string | undefined, transactionDateTo?: string | undefined, payeeIds?: Array | undefined, accountIds?: Array | undefined, refNumberContains?: string | undefined, refNumberStartsWith?: string | undefined, refNumberEndsWith?: string | undefined, refNumberFrom?: string | undefined, refNumberTo?: string | undefined, currencyIds?: Array | undefined, includeLineItems?: boolean | undefined, includeLinkedTransactions?: boolean | undefined}; export type GetApiQuickbooksDesktopChecksOptions = {baseUrl?: string | undefined, BearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const qbdAddress = z.object({line1: z.string().nullable(), line2: z.string().nullable(), line3: z.string().nullable(), line4: z.string().nullable(), line5: z.string().nullable(), city: z.string().nullable(), state: z.string().nullable(), postalCode: z.string().nullable(), country: z.string().nullable(), note: z.string().nullable()}); export const qbdLinkedTransaction = z.object({id: z.string(), objectType: z.literal("qbd_linked_transaction"), transactionType: z.enum(["ar_refund_credit_card", "bill", "bill_payment_check", "bill_payment_credit_card", "build_assembly", "charge", "check", "credit_card_charge", "credit_card_credit", "credit_memo", "deposit", "estimate", "inventory_adjustment", "invoice", "item_receipt", "journal_entry", "liability_adjustment", "paycheck", "payroll_liability_check", "purchase_order", "receive_payment", "sales_order", "sales_receipt", "sales_tax_payment_check", "transfer", "vendor_credit", "ytd_adjustment", "transfer_inventory", "unknown"]), transactionDate: z.string(), refNumber: z.string().nullable(), linkType: z.enum(["amount", "quantity"]).nullable(), amount: z.string().nullable()}); export const qbdCustomField = z.object({ownerId: z.string(), name: z.string(), type: z.enum(["amount_type", "date_time_type", "integer_type", "percent_type", "price_type", "quantity_type", "string_1024_type", "string_255_type"]), value: z.string()}); export const qbdExpenseLine = z.object({id: z.string().nullable(), objectType: z.literal("qbd_expense_line"), account: z.object({id: z.string().nullable(), fullName: z.string().nullable()}).nullable(), amount: z.string().nullable(), memo: z.string().nullable(), payee: z.object({id: z.string().nullable(), fullName: z.string().nullable()}).nullable(), class: z.object({id: z.string().nullable(), fullName: z.string().nullable()}).nullable(), salesTaxCode: z.object({id: z.string().nullable(), fullName: z.string().nullable()}).nullable(), billingStatus: z.enum(["billable", "has_been_billed", "not_billable"]).nullable(), salesRepresentative: z.object({id: z.string().nullable(), fullName: z.string().nullable()}).nullable(), customFields: z.array(qbdCustomField)}); export const qbdItemLine = z.object({id: z.string(), objectType: z.literal("qbd_item_line"), item: z.object({id: z.string().nullable(), fullName: z.string().nullable()}).nullable(), inventorySite: z.object({id: z.string().nullable(), fullName: z.string().nullable()}).nullable(), inventorySiteLocation: z.object({id: z.string().nullable(), fullName: z.string().nullable()}).nullable(), serialNumber: z.string().nullable(), lotNumber: z.string().nullable(), expirationDate: z.string().nullable(), description: z.string().nullable(), quantity: z.number().nullable(), unitOfMeasure: z.string().nullable(), overrideUnitOfMeasureSet: z.object({id: z.string().nullable(), fullName: z.string().nullable()}).nullable(), cost: z.string().nullable(), amount: z.string().nullable(), customer: z.object({id: z.string().nullable(), fullName: z.string().nullable()}).nullable(), class: z.object({id: z.string().nullable(), fullName: z.string().nullable()}).nullable(), salesTaxCode: z.object({id: z.string().nullable(), fullName: z.string().nullable()}).nullable(), billingStatus: z.enum(["billable", "has_been_billed", "not_billable"]).nullable(), salesRepresentative: z.object({id: z.string().nullable(), fullName: z.string().nullable()}).nullable(), customFields: z.array(qbdCustomField)}); export const qbdItemGroupLineItem = z.object({id: z.string(), objectType: z.literal("qbd_item_group_line"), itemGroup: z.object({id: z.string().nullable(), fullName: z.string().nullable()}), description: z.string().nullable(), quantity: z.number().nullable(), unitOfMeasure: z.string().nullable(), overrideUnitOfMeasureSet: z.object({id: z.string().nullable(), fullName: z.string().nullable()}).nullable(), totalAmount: z.string(), itemLines: z.array(qbdItemLine), customFields: z.array(qbdCustomField)}); export const qbdCheck = z.object({id: z.string(), objectType: z.literal("qbd_check"), createdAt: z.string(), updatedAt: z.string(), revisionNumber: z.string(), bankAccount: z.object({id: z.string().nullable(), fullName: z.string().nullable()}), payee: z.object({id: z.string().nullable(), fullName: z.string().nullable()}).nullable(), refNumber: z.string().nullable(), transactionDate: z.string(), amount: z.string(), currency: z.object({id: z.string().nullable(), fullName: z.string().nullable()}).nullable(), exchangeRate: z.number().nullable(), amountInHomeCurrency: z.string().nullable(), memo: z.string().nullable(), address: qbdAddress.nullable(), isPending: z.boolean().nullable(), isQueuedForPrint: z.boolean().nullable(), salesTaxCode: z.object({id: z.string().nullable(), fullName: z.string().nullable()}).nullable(), externalId: z.string().nullable(), linkedTransactions: z.array(qbdLinkedTransaction), expenseLines: z.array(qbdExpenseLine), itemLines: z.array(qbdItemLine), itemGroupLines: z.array(qbdItemGroupLineItem), customFields: z.array(qbdCustomField)}); export const getApiQuickbooksDesktopChecksResponse = z.object({objectType: z.literal("list"), url: z.string(), data: z.array(qbdCheck), nextCursor: z.string().nullable(), remainingCount: z.number().nullable(), hasMore: z.boolean()}); 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 }; /** * List all checks * * GET /quickbooks-desktop/checks */ export const getApiQuickbooksDesktopChecks = async (args: GetApiQuickbooksDesktopChecksArgs, options?: GetApiQuickbooksDesktopChecksOptions) => { const {baseUrl = "https://api.conductor.is/v1", fetch: fetchFn = fetch, BearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['Conductor-End-User-Id'] != null) headers.set("Conductor-End-User-Id", String(args['Conductor-End-User-Id'])) for (const item of args.ids ?? []) query.append("ids", String(item)) for (const item of args.refNumbers ?? []) query.append("refNumbers", String(item)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.cursor != null) query.append("cursor", String(args.cursor)) if (args.updatedAfter != null) query.append("updatedAfter", String(args.updatedAfter)) if (args.updatedBefore != null) query.append("updatedBefore", String(args.updatedBefore)) if (args.transactionDateFrom != null) query.append("transactionDateFrom", String(args.transactionDateFrom)) if (args.transactionDateTo != null) query.append("transactionDateTo", String(args.transactionDateTo)) for (const item of args.payeeIds ?? []) query.append("payeeIds", String(item)) for (const item of args.accountIds ?? []) query.append("accountIds", String(item)) if (args.refNumberContains != null) query.append("refNumberContains", String(args.refNumberContains)) if (args.refNumberStartsWith != null) query.append("refNumberStartsWith", String(args.refNumberStartsWith)) if (args.refNumberEndsWith != null) query.append("refNumberEndsWith", String(args.refNumberEndsWith)) if (args.refNumberFrom != null) query.append("refNumberFrom", String(args.refNumberFrom)) if (args.refNumberTo != null) query.append("refNumberTo", String(args.refNumberTo)) for (const item of args.currencyIds ?? []) query.append("currencyIds", String(item)) if (args.includeLineItems != null) query.append("includeLineItems", String(args.includeLineItems)) if (args.includeLinkedTransactions != null) query.append("includeLinkedTransactions", String(args.includeLinkedTransactions)) if (BearerAuth !== undefined) headers.set('authorization', `Bearer ${BearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/quickbooks-desktop/checks${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(getApiQuickbooksDesktopChecksResponse, await res.json()) };