import {z} from 'zod' export type GetApiInvoicesInvoiceIdArgs = {invoiceId: number}; export type GetApiInvoicesInvoiceIdOptions = {baseUrl?: string | undefined, oauth2?: string | undefined, fetch?: typeof fetch | undefined}; export const serviceChannelServicesMessagingInvoicesApiVendorPayee = z.object({Id: z.number().int().optional(), VendorNumber: z.string().optional(), FullName: z.string().optional(), Address1: z.string().optional(), Address2: z.string().optional(), City: z.string().optional(), State: z.string().optional(), Zip: z.string().optional(), Country: z.string().optional()}); export const serviceChannelServicesMessagingApprovalCodesAdditionalApprovalCodeWithoutOptions = z.object({Header: z.string().optional(), Value: z.string().optional(), SetupId: z.number().int().optional(), LocationId: z.number().int().optional(), DefaultOptionId: z.number().int().optional(), ValueFormat: z.number().int().optional(), EditableAtLineItemLevel: z.number().int().optional(), IsDeleted: z.boolean().optional()}); export const serviceChannelApiModelWorkordersLabel = z.object({LabelText: z.string().optional(), InvoiceId: z.number().int().optional(), LabelId: z.number().int().optional(), IsActive: z.boolean().optional()}); export const serviceChannelApiModelInvoicesWeatherEventTypeForInvoice = z.object({Id: z.number().int().optional(), Name: z.string().optional(), Description: z.string().optional(), InvoiceId: z.number().int().optional()}); export const serviceChannelServicesMessagingInvoicesInvoicePaymentResponse = z.object({Id: z.number().int().optional(), PaymentDate: z.string().optional(), PaidBy: z.string().optional(), PaymentNumber: z.string().optional(), PaymentAmount: z.number().optional()}); export const serviceChannelServicesMessagingCurrenciesCurrency = z.object({Id: z.number().int().optional(), AlphabeticalCode: z.string().optional(), DecimalCount: z.number().int().optional(), Entity: z.string().optional(), CurrencyName: z.string().optional(), NumericCode: z.string().optional(), Rate: z.number().optional()}); export const serviceChannelServicesMessagingApprovalCodesAdditionalApprovalCodeOption = z.object({Id: z.number().int().optional(), Value: z.string().optional()}); export const serviceChannelServicesMessagingApprovalCodesEditableAdditionalApprovalCode = z.object({Header: z.string().optional(), Value: z.string().optional(), SetupId: z.number().int().optional(), LocationId: z.number().int().optional(), DefaultOptionId: z.number().int().optional(), ValueFormat: z.number().int().optional(), EditableAtLineItemLevel: z.number().int().optional(), Options: z.array(serviceChannelServicesMessagingApprovalCodesAdditionalApprovalCodeOption).optional(), DefaultValue: z.string().optional()}); export const serviceChannelServicesMessagingInvoicesInvoiceCategoryMessaging = z.object({Id: z.number().int().optional(), Name: z.string().optional()}); export const serviceChannelServicesMessagingInvoicesInvoiceAmountsDetails = z.object({LaborAmount: z.number().optional(), MaterialAmount: z.number().optional(), TravelAmount: z.number().optional(), FreightAmount: z.number().optional(), OtherAmount: z.number().optional(), OtherDescription: z.string().optional()}); export const serviceChannelServicesMessagingInvoicesInvoiceTaxesDetails = z.object({LaborTaxPercent: z.number().optional(), MaterialTaxPercent: z.number().optional(), TravelTaxPercent: z.number().optional(), FreightTaxPercent: z.number().optional(), OtherTaxPercent: z.number().optional(), LaborTax: z.number().optional(), MaterialTax: z.number().optional(), TravelTax: z.number().optional(), FreightTax: z.number().optional(), OtherTax: z.number().optional()}); export const serviceChannelServicesMessagingInvoicesTax2Details = z.object({Tax2Amount: z.number().optional(), Tax2Name: z.string().optional()}); export const serviceChannelServicesMessagingInvoicesInvoiceApprovalCodeChild = z.object({Amount: z.number().optional(), Id: z.number().int().optional(), InvoiceId: z.number().int().optional(), InvoiceChargeId: z.number().int().optional(), ApprovalCodeType: z.enum(["Labor", "Travel", "Material", "Freight", "Other", "Tax", "Tax2", "LineItem", "FreightGenerated"]).optional(), ApprovalCode: z.string().optional(), AdditionalApprovalCode: z.string().optional(), ParentId: z.number().int().optional(), InternalId: z.number().int().optional(), InternalParentId: z.number().int().optional(), IsDefault: z.boolean().optional()}); export const serviceChannelServicesMessagingInvoicesInvoiceApprovalCodeGroup = z.object({ApprovalCodeType: z.enum(["Labor", "Travel", "Material", "Freight", "Other", "Tax", "Tax2", "LineItem", "FreightGenerated"]).optional(), ApprovalCode: z.string().optional(), AdditionalApprovalCode: z.string().optional(), Amount: z.number().optional(), ApprovalCodes: z.array(serviceChannelServicesMessagingInvoicesInvoiceApprovalCodeChild).optional()}); export const serviceChannelServicesMessagingInvoicesInvoiceLabor = z.object({Id: z.number().int().optional(), InvoiceId: z.number().int().optional(), SkillLevel: z.string().optional(), LaborType: z.string().optional(), NumOfTech: z.string().optional(), HourlyRate: z.number().optional(), Hours: z.number().optional(), Amount: z.number().optional(), IsOffShore: z.boolean().optional(), ServiceType: z.string().optional(), CityPerformed: z.string().optional(), RateDiscrepancyReason: z.string().optional(), AgreedRate: z.number().optional(), ApprovalCodeGroup: serviceChannelServicesMessagingInvoicesInvoiceApprovalCodeGroup.optional(), IsRateDiscrepancy: z.boolean().optional(), isNontaxableVATEU: z.boolean().optional()}); export const serviceChannelServicesMessagingInvoicesInvoiceMaterial = z.object({Id: z.number().int().optional(), InvoiceId: z.number().int().optional(), Description: z.string().optional(), PartNum: z.string().optional(), UnitType: z.string().optional(), UnitPrice: z.number().optional(), PartName: z.string().optional(), MarkUpPercent: z.number().optional(), AgreedMarkUpPercent: z.number().optional(), MarkUpDiscrepancyReason: z.string().optional(), AgreedPartPrice: z.number().optional(), Quantity: z.number().optional(), Amount: z.number().optional(), ApprovalCodeGroup: serviceChannelServicesMessagingInvoicesInvoiceApprovalCodeGroup.optional(), IsMarkUpDiscrepancy: z.boolean().optional(), IsPartPriceDiscrepancy: z.boolean().optional(), PriceDiscrepancyReason: z.string().optional(), isNontaxableVATEU: z.boolean().optional()}); export const serviceChannelServicesMessagingInvoicesInvoiceTravel = z.object({Id: z.number().int().optional(), InvoiceId: z.number().int().optional(), Description: z.string().optional(), UnitType: z.string().optional(), UnitPrice: z.number().optional(), Quantity: z.number().optional(), Amount: z.number().optional(), IsOffShore: z.boolean().optional(), ApprovalCodeGroup: serviceChannelServicesMessagingInvoicesInvoiceApprovalCodeGroup.optional(), isNontaxableVATEU: z.boolean().optional()}); export const serviceChannelServicesMessagingInvoicesInvoiceOther = z.object({Id: z.number().int().optional(), InvoiceId: z.number().int().optional(), Description: z.string().optional(), Type: z.string().optional(), Amount: z.number().optional(), UnitType: z.string().optional(), UnitPrice: z.number().optional(), Quantity: z.number().optional(), AgreedUnitPrice: z.number().optional(), UnitPriceDiscrepancyReason: z.string().optional(), PriceListOtherChargeId: z.number().int().optional(), IsUnitPriceDiscrepancy: z.boolean().optional(), ApprovalCodeGroup: serviceChannelServicesMessagingInvoicesInvoiceApprovalCodeGroup.optional(), isNontaxableVATEU: z.boolean().optional()}); export const serviceChannelServicesMessagingInvoicesStatusHistoryShort = z.object({CreatedBy: z.string().optional(), CreatedById: z.number().int().optional(), Status: z.string().optional(), InvId: z.number().int().optional(), ActionDate: z.string().optional()}); export const serviceChannelServicesMessagingInvoicesInvoiceApprovalCode = z.object({Id: z.number().int().optional(), InvoiceId: z.number().int().optional(), InvoiceChargeId: z.number().int().optional(), ApprovalCodeType: z.enum(["Labor", "Travel", "Material", "Freight", "Other", "Tax", "Tax2", "LineItem", "FreightGenerated"]).optional(), ApprovalCode: z.string().optional(), AdditionalApprovalCode: z.string().optional(), ParentId: z.number().int().optional(), InternalId: z.number().int().optional(), InternalParentId: z.number().int().optional(), IsDefault: z.boolean().optional()}); export const serviceChannelServicesMessagingInvoicesApiGetInvoiceResponse = z.object({VendorPayee: serviceChannelServicesMessagingInvoicesApiVendorPayee.optional(), AdditionalApprovalCodes: z.array(serviceChannelServicesMessagingApprovalCodesAdditionalApprovalCodeWithoutOptions).optional(), ProviderId: z.number().int().optional(), SubscriberId: z.number().int().optional(), LocationId: z.number().int().optional(), InvoiceNumber: z.string().optional(), WithAutoApprovalCriteria: z.boolean().optional(), PostedDateStr: z.string().optional(), InvoiceDateStr: z.string().optional(), PaidDateStr: z.string().optional(), StarredDateStr: z.string().optional(), ApprovedDateStr: z.string().optional(), TransferredDateStr: z.string().optional(), LastActionDateStr: z.string().optional(), StatusChangeDateStr: z.string().optional(), ProviderName: z.string().optional(), PreviousUpdated: z.string().optional(), Discount: z.number().optional(), SubscriberFee: z.number().optional(), ProviderFee: z.number().optional(), InPaymentManager: z.boolean().optional(), DiscountPercent: z.number().optional(), Status: z.string().optional(), EarlyPayFeePercent: z.number().optional(), Labels: z.array(serviceChannelApiModelWorkordersLabel).optional(), WeatherEventTypeForInvoice: serviceChannelApiModelInvoicesWeatherEventTypeForInvoice.optional(), IsHideUsernameOnInvoice: z.boolean().optional(), IsInvoiceNegativeLineItemsEnabled: z.boolean().optional(), IsHolidayLaborRate: z.boolean().optional(), ProjectId: z.number().int().optional(), IsRestrictedForChanges: z.boolean().optional(), Payments: z.array(serviceChannelServicesMessagingInvoicesInvoicePaymentResponse).optional(), DisputeReason: z.string().optional(), RejectionReasonDescription: z.string().optional(), Id: z.number().int().optional(), Number: z.string().optional(), BatchNumber: z.string().optional(), InvoiceTax: z.number().optional(), PostedTaxRate: z.number().optional(), PostedTax2Rate: z.number().optional(), VendorPayeeId: z.number().int().optional(), InvoiceTotal: z.number().optional(), InvoiceBalance: z.number().optional(), Currency: serviceChannelServicesMessagingCurrenciesCurrency.optional(), ApprovedDate: z.string().optional(), ApprovalCode: z.string().optional(), EditableAdditionalApprovalCode: serviceChannelServicesMessagingApprovalCodesEditableAdditionalApprovalCode.optional(), PostedDate: z.string().optional(), PostedBy: z.string().optional(), Subtotal: z.number().optional(), Trade: z.string().optional(), TradeId: z.number().int().optional(), Category: serviceChannelServicesMessagingInvoicesInvoiceCategoryMessaging.optional(), InvoiceAmountsDetails: serviceChannelServicesMessagingInvoicesInvoiceAmountsDetails.optional(), InvoiceTaxesDetails: serviceChannelServicesMessagingInvoicesInvoiceTaxesDetails.optional(), Tax2Details: serviceChannelServicesMessagingInvoicesTax2Details.optional(), Labors: z.array(serviceChannelServicesMessagingInvoicesInvoiceLabor).optional(), Materials: z.array(serviceChannelServicesMessagingInvoicesInvoiceMaterial).optional(), Travels: z.array(serviceChannelServicesMessagingInvoicesInvoiceTravel).optional(), Others: z.array(serviceChannelServicesMessagingInvoicesInvoiceOther).optional(), TaxApprovalCodeGroups: z.array(serviceChannelServicesMessagingInvoicesInvoiceApprovalCodeGroup).optional(), Tax2ApprovalCodeGroups: z.array(serviceChannelServicesMessagingInvoicesInvoiceApprovalCodeGroup).optional(), FreightApprovalCodeGroups: z.array(serviceChannelServicesMessagingInvoicesInvoiceApprovalCodeGroup).optional(), WithMismatchedRates: z.boolean().optional(), IsOutsourced: z.boolean().optional(), StarredBy: z.string().optional(), IsStarred: z.boolean().optional(), IsTransferred: z.boolean().optional(), StarredDate: z.string().optional(), Description: z.string().optional(), InvoiceDate: z.string().optional(), LaborTaxIncluded: z.boolean().optional(), TravelTaxIncluded: z.boolean().optional(), MaterialsTaxIncluded: z.boolean().optional(), FreightTaxIncluded: z.boolean().optional(), OtherTaxIncluded: z.boolean().optional(), NonTaxableLabor: z.number().int().optional(), NonTaxableTravel: z.number().int().optional(), NonTaxableMaterial: z.number().int().optional(), NonTaxableFreight: z.number().int().optional(), NonTaxableOther: z.number().int().optional(), IsExists: z.boolean().optional(), StatusChangeDate: z.string().optional(), StatusChangeUser: z.string().optional(), StatusChangeUserid: z.string().optional(), IsDuplicate: z.boolean().optional(), WoTrackingNumber: z.number().int().optional(), Terms: z.string().optional(), Comments: z.string().optional(), PaidDate: z.string().optional(), TransferredDate: z.string().optional(), LastActionDate: z.string().optional(), UpdatedDate: z.string().optional(), StatusHistoryShort: z.array(serviceChannelServicesMessagingInvoicesStatusHistoryShort).optional(), WoAssignedTo: z.string().optional(), ApprovalCodes: z.array(serviceChannelServicesMessagingInvoicesInvoiceApprovalCode).optional(), IsChargesApprovalCodesDefault: z.boolean().optional(), StoredFeatures: z.array(z.string()).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 * * GET /invoices/{invoiceId} */ export const getApiInvoicesInvoiceId = async (args: GetApiInvoicesInvoiceIdArgs, options?: GetApiInvoicesInvoiceIdOptions) => { const {baseUrl = "https://sb2api.servicechannel.com/v3", fetch: fetchFn = fetch, oauth2} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (oauth2 !== undefined) headers.set('authorization', `Bearer ${oauth2}`) const url = `${baseUrl.replace(/\/+$/, '')}/invoices/${encodeURIComponent(String(args.invoiceId))}${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(serviceChannelServicesMessagingInvoicesApiGetInvoiceResponse, await res.json()) };