/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import * as z from "zod";
import { remap as remap$ } from "../../lib/primitives.js";
import { safeParse } from "../../lib/schemas.js";
import { ClosedEnum } from "../../types/enums.js";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
import {
  Address,
  Address$inboundSchema,
  Address$Outbound,
  Address$outboundSchema,
} from "./address.js";
import {
  Allocation,
  Allocation$inboundSchema,
  Allocation$Outbound,
  Allocation$outboundSchema,
  AllocationInput,
  AllocationInput$inboundSchema,
  AllocationInput$Outbound,
  AllocationInput$outboundSchema,
} from "./allocation.js";
import {
  Currency,
  Currency$inboundSchema,
  Currency$outboundSchema,
} from "./currency.js";
import {
  CustomField,
  CustomField$inboundSchema,
  CustomField$Outbound,
  CustomField$outboundSchema,
} from "./customfield.js";
import {
  CustomMappings,
  CustomMappings$inboundSchema,
  CustomMappings$Outbound,
  CustomMappings$outboundSchema,
} from "./custommappings.js";
import {
  InvoiceLineItem,
  InvoiceLineItem$inboundSchema,
  InvoiceLineItem$Outbound,
  InvoiceLineItem$outboundSchema,
  InvoiceLineItemInput,
  InvoiceLineItemInput$inboundSchema,
  InvoiceLineItemInput$Outbound,
  InvoiceLineItemInput$outboundSchema,
} from "./invoicelineitem.js";
import {
  LinkedCustomer,
  LinkedCustomer$inboundSchema,
  LinkedCustomer$Outbound,
  LinkedCustomer$outboundSchema,
} from "./linkedcustomer.js";
import {
  LinkedCustomerInput,
  LinkedCustomerInput$inboundSchema,
  LinkedCustomerInput$Outbound,
  LinkedCustomerInput$outboundSchema,
} from "./linkedcustomerinput.js";
import {
  LinkedLedgerAccount,
  LinkedLedgerAccount$inboundSchema,
  LinkedLedgerAccount$Outbound,
  LinkedLedgerAccount$outboundSchema,
} from "./linkedledgeraccount.js";
import {
  LinkedLedgerAccountInput,
  LinkedLedgerAccountInput$inboundSchema,
  LinkedLedgerAccountInput$Outbound,
  LinkedLedgerAccountInput$outboundSchema,
} from "./linkedledgeraccountinput.js";
import {
  LinkedTrackingCategory,
  LinkedTrackingCategory$inboundSchema,
  LinkedTrackingCategory$Outbound,
  LinkedTrackingCategory$outboundSchema,
} from "./linkedtrackingcategory.js";
import {
  PassThroughBody,
  PassThroughBody$inboundSchema,
  PassThroughBody$Outbound,
  PassThroughBody$outboundSchema,
} from "./passthroughbody.js";

/**
 * Status of credit notes
 */
export const CreditNoteStatus = {
  Draft: "draft",
  Authorised: "authorised",
  Paid: "paid",
  Voided: "voided",
  Deleted: "deleted",
} as const;
/**
 * Status of credit notes
 */
export type CreditNoteStatus = ClosedEnum<typeof CreditNoteStatus>;

/**
 * Type of payment
 */
export const CreditNoteType = {
  AccountsReceivableCredit: "accounts_receivable_credit",
  AccountsPayableCredit: "accounts_payable_credit",
} as const;
/**
 * Type of payment
 */
export type CreditNoteType = ClosedEnum<typeof CreditNoteType>;

export type CreditNote = {
  /**
   * Unique identifier representing the entity
   */
  id: string;
  /**
   * Credit note number.
   */
  number?: string | null | undefined;
  /**
   * The customer this entity is linked to.
   */
  customer?: LinkedCustomer | null | undefined;
  /**
   * The company or subsidiary id the transaction belongs to
   */
  companyId?: string | null | undefined;
  /**
   * Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
   */
  currency?: Currency | null | undefined;
  /**
   * Currency Exchange Rate at the time entity was recorded/generated.
   */
  currencyRate?: number | null | undefined;
  /**
   * Amounts are including tax
   */
  taxInclusive?: boolean | null | undefined;
  /**
   * Sub-total amount, normally before tax.
   */
  subTotal?: number | null | undefined;
  /**
   * Amount of transaction
   */
  totalAmount: number;
  /**
   * Total tax amount applied to this invoice.
   */
  totalTax?: number | null | undefined;
  /**
   * Applicable tax id/code override if tax is not supplied on a line item basis.
   */
  taxCode?: string | null | undefined;
  /**
   * The balance reflecting any payments made against the transaction.
   */
  balance?: number | null | undefined;
  /**
   * Indicates the total credit amount still available to apply towards the payment.
   */
  remainingCredit?: number | null | undefined;
  /**
   * Status of credit notes
   */
  status?: CreditNoteStatus | undefined;
  /**
   * Optional reference message ie: Debit remittance detail.
   */
  reference?: string | null | undefined;
  /**
   * Date credit note issued - YYYY:MM::DDThh:mm:ss.sTZD
   */
  dateIssued?: Date | undefined;
  /**
   * Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD
   */
  datePaid?: Date | null | undefined;
  /**
   * Type of payment
   */
  type?: CreditNoteType | undefined;
  account?: LinkedLedgerAccount | null | undefined;
  lineItems?: Array<InvoiceLineItem> | undefined;
  allocations?: Array<Allocation> | undefined;
  /**
   * Optional note to be associated with the credit note.
   */
  note?: string | null | undefined;
  /**
   * Optional terms to be associated with the credit note.
   */
  terms?: string | null | undefined;
  billingAddress?: Address | undefined;
  shippingAddress?: Address | undefined;
  /**
   * A list of linked tracking categories.
   */
  trackingCategories?: Array<LinkedTrackingCategory> | null | undefined;
  /**
   * When custom mappings are configured on the resource, the result is included here.
   */
  customMappings?: CustomMappings | null | undefined;
  customFields?: Array<CustomField> | undefined;
  /**
   * A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
   */
  rowVersion?: string | null | undefined;
  /**
   * The user who last updated the object.
   */
  updatedBy?: string | null | undefined;
  /**
   * The user who created the object.
   */
  createdBy?: string | null | undefined;
  /**
   * The date and time when the object was last updated.
   */
  updatedAt?: Date | null | undefined;
  /**
   * The date and time when the object was created.
   */
  createdAt?: Date | null | undefined;
  /**
   * The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
   */
  passThrough?: Array<PassThroughBody> | undefined;
};

export type CreditNoteInput = {
  /**
   * Credit note number.
   */
  number?: string | null | undefined;
  /**
   * The customer this entity is linked to.
   */
  customer?: LinkedCustomerInput | null | undefined;
  /**
   * The company or subsidiary id the transaction belongs to
   */
  companyId?: string | null | undefined;
  /**
   * Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
   */
  currency?: Currency | null | undefined;
  /**
   * Currency Exchange Rate at the time entity was recorded/generated.
   */
  currencyRate?: number | null | undefined;
  /**
   * Amounts are including tax
   */
  taxInclusive?: boolean | null | undefined;
  /**
   * Sub-total amount, normally before tax.
   */
  subTotal?: number | null | undefined;
  /**
   * Amount of transaction
   */
  totalAmount: number;
  /**
   * Total tax amount applied to this invoice.
   */
  totalTax?: number | null | undefined;
  /**
   * Applicable tax id/code override if tax is not supplied on a line item basis.
   */
  taxCode?: string | null | undefined;
  /**
   * The balance reflecting any payments made against the transaction.
   */
  balance?: number | null | undefined;
  /**
   * Indicates the total credit amount still available to apply towards the payment.
   */
  remainingCredit?: number | null | undefined;
  /**
   * Status of credit notes
   */
  status?: CreditNoteStatus | undefined;
  /**
   * Optional reference message ie: Debit remittance detail.
   */
  reference?: string | null | undefined;
  /**
   * Date credit note issued - YYYY:MM::DDThh:mm:ss.sTZD
   */
  dateIssued?: Date | undefined;
  /**
   * Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD
   */
  datePaid?: Date | null | undefined;
  /**
   * Type of payment
   */
  type?: CreditNoteType | undefined;
  account?: LinkedLedgerAccountInput | null | undefined;
  lineItems?: Array<InvoiceLineItemInput> | undefined;
  allocations?: Array<AllocationInput> | undefined;
  /**
   * Optional note to be associated with the credit note.
   */
  note?: string | null | undefined;
  /**
   * Optional terms to be associated with the credit note.
   */
  terms?: string | null | undefined;
  billingAddress?: Address | undefined;
  shippingAddress?: Address | undefined;
  /**
   * A list of linked tracking categories.
   */
  trackingCategories?: Array<LinkedTrackingCategory> | null | undefined;
  customFields?: Array<CustomField> | undefined;
  /**
   * A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
   */
  rowVersion?: string | null | undefined;
  /**
   * The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
   */
  passThrough?: Array<PassThroughBody> | undefined;
};

/** @internal */
export const CreditNoteStatus$inboundSchema: z.ZodNativeEnum<
  typeof CreditNoteStatus
> = z.nativeEnum(CreditNoteStatus);

/** @internal */
export const CreditNoteStatus$outboundSchema: z.ZodNativeEnum<
  typeof CreditNoteStatus
> = CreditNoteStatus$inboundSchema;

/**
 * @internal
 * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
 */
export namespace CreditNoteStatus$ {
  /** @deprecated use `CreditNoteStatus$inboundSchema` instead. */
  export const inboundSchema = CreditNoteStatus$inboundSchema;
  /** @deprecated use `CreditNoteStatus$outboundSchema` instead. */
  export const outboundSchema = CreditNoteStatus$outboundSchema;
}

/** @internal */
export const CreditNoteType$inboundSchema: z.ZodNativeEnum<
  typeof CreditNoteType
> = z.nativeEnum(CreditNoteType);

/** @internal */
export const CreditNoteType$outboundSchema: z.ZodNativeEnum<
  typeof CreditNoteType
> = CreditNoteType$inboundSchema;

/**
 * @internal
 * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
 */
export namespace CreditNoteType$ {
  /** @deprecated use `CreditNoteType$inboundSchema` instead. */
  export const inboundSchema = CreditNoteType$inboundSchema;
  /** @deprecated use `CreditNoteType$outboundSchema` instead. */
  export const outboundSchema = CreditNoteType$outboundSchema;
}

/** @internal */
export const CreditNote$inboundSchema: z.ZodType<
  CreditNote,
  z.ZodTypeDef,
  unknown
> = z.object({
  id: z.string(),
  number: z.nullable(z.string()).optional(),
  customer: z.nullable(LinkedCustomer$inboundSchema).optional(),
  company_id: z.nullable(z.string()).optional(),
  currency: z.nullable(Currency$inboundSchema).optional(),
  currency_rate: z.nullable(z.number()).optional(),
  tax_inclusive: z.nullable(z.boolean()).optional(),
  sub_total: z.nullable(z.number()).optional(),
  total_amount: z.number(),
  total_tax: z.nullable(z.number()).optional(),
  tax_code: z.nullable(z.string()).optional(),
  balance: z.nullable(z.number()).optional(),
  remaining_credit: z.nullable(z.number()).optional(),
  status: CreditNoteStatus$inboundSchema.optional(),
  reference: z.nullable(z.string()).optional(),
  date_issued: z.string().datetime({ offset: true }).transform(v => new Date(v))
    .optional(),
  date_paid: z.nullable(
    z.string().datetime({ offset: true }).transform(v => new Date(v)),
  ).optional(),
  type: CreditNoteType$inboundSchema.optional(),
  account: z.nullable(LinkedLedgerAccount$inboundSchema).optional(),
  line_items: z.array(InvoiceLineItem$inboundSchema).optional(),
  allocations: z.array(Allocation$inboundSchema).optional(),
  note: z.nullable(z.string()).optional(),
  terms: z.nullable(z.string()).optional(),
  billing_address: Address$inboundSchema.optional(),
  shipping_address: Address$inboundSchema.optional(),
  tracking_categories: z.nullable(z.array(LinkedTrackingCategory$inboundSchema))
    .optional(),
  custom_mappings: z.nullable(CustomMappings$inboundSchema).optional(),
  custom_fields: z.array(CustomField$inboundSchema).optional(),
  row_version: z.nullable(z.string()).optional(),
  updated_by: z.nullable(z.string()).optional(),
  created_by: z.nullable(z.string()).optional(),
  updated_at: z.nullable(
    z.string().datetime({ offset: true }).transform(v => new Date(v)),
  ).optional(),
  created_at: z.nullable(
    z.string().datetime({ offset: true }).transform(v => new Date(v)),
  ).optional(),
  pass_through: z.array(PassThroughBody$inboundSchema).optional(),
}).transform((v) => {
  return remap$(v, {
    "company_id": "companyId",
    "currency_rate": "currencyRate",
    "tax_inclusive": "taxInclusive",
    "sub_total": "subTotal",
    "total_amount": "totalAmount",
    "total_tax": "totalTax",
    "tax_code": "taxCode",
    "remaining_credit": "remainingCredit",
    "date_issued": "dateIssued",
    "date_paid": "datePaid",
    "line_items": "lineItems",
    "billing_address": "billingAddress",
    "shipping_address": "shippingAddress",
    "tracking_categories": "trackingCategories",
    "custom_mappings": "customMappings",
    "custom_fields": "customFields",
    "row_version": "rowVersion",
    "updated_by": "updatedBy",
    "created_by": "createdBy",
    "updated_at": "updatedAt",
    "created_at": "createdAt",
    "pass_through": "passThrough",
  });
});

/** @internal */
export type CreditNote$Outbound = {
  id: string;
  number?: string | null | undefined;
  customer?: LinkedCustomer$Outbound | null | undefined;
  company_id?: string | null | undefined;
  currency?: string | null | undefined;
  currency_rate?: number | null | undefined;
  tax_inclusive?: boolean | null | undefined;
  sub_total?: number | null | undefined;
  total_amount: number;
  total_tax?: number | null | undefined;
  tax_code?: string | null | undefined;
  balance?: number | null | undefined;
  remaining_credit?: number | null | undefined;
  status?: string | undefined;
  reference?: string | null | undefined;
  date_issued?: string | undefined;
  date_paid?: string | null | undefined;
  type?: string | undefined;
  account?: LinkedLedgerAccount$Outbound | null | undefined;
  line_items?: Array<InvoiceLineItem$Outbound> | undefined;
  allocations?: Array<Allocation$Outbound> | undefined;
  note?: string | null | undefined;
  terms?: string | null | undefined;
  billing_address?: Address$Outbound | undefined;
  shipping_address?: Address$Outbound | undefined;
  tracking_categories?:
    | Array<LinkedTrackingCategory$Outbound>
    | null
    | undefined;
  custom_mappings?: CustomMappings$Outbound | null | undefined;
  custom_fields?: Array<CustomField$Outbound> | undefined;
  row_version?: string | null | undefined;
  updated_by?: string | null | undefined;
  created_by?: string | null | undefined;
  updated_at?: string | null | undefined;
  created_at?: string | null | undefined;
  pass_through?: Array<PassThroughBody$Outbound> | undefined;
};

/** @internal */
export const CreditNote$outboundSchema: z.ZodType<
  CreditNote$Outbound,
  z.ZodTypeDef,
  CreditNote
> = z.object({
  id: z.string(),
  number: z.nullable(z.string()).optional(),
  customer: z.nullable(LinkedCustomer$outboundSchema).optional(),
  companyId: z.nullable(z.string()).optional(),
  currency: z.nullable(Currency$outboundSchema).optional(),
  currencyRate: z.nullable(z.number()).optional(),
  taxInclusive: z.nullable(z.boolean()).optional(),
  subTotal: z.nullable(z.number()).optional(),
  totalAmount: z.number(),
  totalTax: z.nullable(z.number()).optional(),
  taxCode: z.nullable(z.string()).optional(),
  balance: z.nullable(z.number()).optional(),
  remainingCredit: z.nullable(z.number()).optional(),
  status: CreditNoteStatus$outboundSchema.optional(),
  reference: z.nullable(z.string()).optional(),
  dateIssued: z.date().transform(v => v.toISOString()).optional(),
  datePaid: z.nullable(z.date().transform(v => v.toISOString())).optional(),
  type: CreditNoteType$outboundSchema.optional(),
  account: z.nullable(LinkedLedgerAccount$outboundSchema).optional(),
  lineItems: z.array(InvoiceLineItem$outboundSchema).optional(),
  allocations: z.array(Allocation$outboundSchema).optional(),
  note: z.nullable(z.string()).optional(),
  terms: z.nullable(z.string()).optional(),
  billingAddress: Address$outboundSchema.optional(),
  shippingAddress: Address$outboundSchema.optional(),
  trackingCategories: z.nullable(z.array(LinkedTrackingCategory$outboundSchema))
    .optional(),
  customMappings: z.nullable(CustomMappings$outboundSchema).optional(),
  customFields: z.array(CustomField$outboundSchema).optional(),
  rowVersion: z.nullable(z.string()).optional(),
  updatedBy: z.nullable(z.string()).optional(),
  createdBy: z.nullable(z.string()).optional(),
  updatedAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
  createdAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
  passThrough: z.array(PassThroughBody$outboundSchema).optional(),
}).transform((v) => {
  return remap$(v, {
    companyId: "company_id",
    currencyRate: "currency_rate",
    taxInclusive: "tax_inclusive",
    subTotal: "sub_total",
    totalAmount: "total_amount",
    totalTax: "total_tax",
    taxCode: "tax_code",
    remainingCredit: "remaining_credit",
    dateIssued: "date_issued",
    datePaid: "date_paid",
    lineItems: "line_items",
    billingAddress: "billing_address",
    shippingAddress: "shipping_address",
    trackingCategories: "tracking_categories",
    customMappings: "custom_mappings",
    customFields: "custom_fields",
    rowVersion: "row_version",
    updatedBy: "updated_by",
    createdBy: "created_by",
    updatedAt: "updated_at",
    createdAt: "created_at",
    passThrough: "pass_through",
  });
});

/**
 * @internal
 * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
 */
export namespace CreditNote$ {
  /** @deprecated use `CreditNote$inboundSchema` instead. */
  export const inboundSchema = CreditNote$inboundSchema;
  /** @deprecated use `CreditNote$outboundSchema` instead. */
  export const outboundSchema = CreditNote$outboundSchema;
  /** @deprecated use `CreditNote$Outbound` instead. */
  export type Outbound = CreditNote$Outbound;
}

export function creditNoteToJSON(creditNote: CreditNote): string {
  return JSON.stringify(CreditNote$outboundSchema.parse(creditNote));
}

export function creditNoteFromJSON(
  jsonString: string,
): SafeParseResult<CreditNote, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => CreditNote$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'CreditNote' from JSON`,
  );
}

/** @internal */
export const CreditNoteInput$inboundSchema: z.ZodType<
  CreditNoteInput,
  z.ZodTypeDef,
  unknown
> = z.object({
  number: z.nullable(z.string()).optional(),
  customer: z.nullable(LinkedCustomerInput$inboundSchema).optional(),
  company_id: z.nullable(z.string()).optional(),
  currency: z.nullable(Currency$inboundSchema).optional(),
  currency_rate: z.nullable(z.number()).optional(),
  tax_inclusive: z.nullable(z.boolean()).optional(),
  sub_total: z.nullable(z.number()).optional(),
  total_amount: z.number(),
  total_tax: z.nullable(z.number()).optional(),
  tax_code: z.nullable(z.string()).optional(),
  balance: z.nullable(z.number()).optional(),
  remaining_credit: z.nullable(z.number()).optional(),
  status: CreditNoteStatus$inboundSchema.optional(),
  reference: z.nullable(z.string()).optional(),
  date_issued: z.string().datetime({ offset: true }).transform(v => new Date(v))
    .optional(),
  date_paid: z.nullable(
    z.string().datetime({ offset: true }).transform(v => new Date(v)),
  ).optional(),
  type: CreditNoteType$inboundSchema.optional(),
  account: z.nullable(LinkedLedgerAccountInput$inboundSchema).optional(),
  line_items: z.array(InvoiceLineItemInput$inboundSchema).optional(),
  allocations: z.array(AllocationInput$inboundSchema).optional(),
  note: z.nullable(z.string()).optional(),
  terms: z.nullable(z.string()).optional(),
  billing_address: Address$inboundSchema.optional(),
  shipping_address: Address$inboundSchema.optional(),
  tracking_categories: z.nullable(z.array(LinkedTrackingCategory$inboundSchema))
    .optional(),
  custom_fields: z.array(CustomField$inboundSchema).optional(),
  row_version: z.nullable(z.string()).optional(),
  pass_through: z.array(PassThroughBody$inboundSchema).optional(),
}).transform((v) => {
  return remap$(v, {
    "company_id": "companyId",
    "currency_rate": "currencyRate",
    "tax_inclusive": "taxInclusive",
    "sub_total": "subTotal",
    "total_amount": "totalAmount",
    "total_tax": "totalTax",
    "tax_code": "taxCode",
    "remaining_credit": "remainingCredit",
    "date_issued": "dateIssued",
    "date_paid": "datePaid",
    "line_items": "lineItems",
    "billing_address": "billingAddress",
    "shipping_address": "shippingAddress",
    "tracking_categories": "trackingCategories",
    "custom_fields": "customFields",
    "row_version": "rowVersion",
    "pass_through": "passThrough",
  });
});

/** @internal */
export type CreditNoteInput$Outbound = {
  number?: string | null | undefined;
  customer?: LinkedCustomerInput$Outbound | null | undefined;
  company_id?: string | null | undefined;
  currency?: string | null | undefined;
  currency_rate?: number | null | undefined;
  tax_inclusive?: boolean | null | undefined;
  sub_total?: number | null | undefined;
  total_amount: number;
  total_tax?: number | null | undefined;
  tax_code?: string | null | undefined;
  balance?: number | null | undefined;
  remaining_credit?: number | null | undefined;
  status?: string | undefined;
  reference?: string | null | undefined;
  date_issued?: string | undefined;
  date_paid?: string | null | undefined;
  type?: string | undefined;
  account?: LinkedLedgerAccountInput$Outbound | null | undefined;
  line_items?: Array<InvoiceLineItemInput$Outbound> | undefined;
  allocations?: Array<AllocationInput$Outbound> | undefined;
  note?: string | null | undefined;
  terms?: string | null | undefined;
  billing_address?: Address$Outbound | undefined;
  shipping_address?: Address$Outbound | undefined;
  tracking_categories?:
    | Array<LinkedTrackingCategory$Outbound>
    | null
    | undefined;
  custom_fields?: Array<CustomField$Outbound> | undefined;
  row_version?: string | null | undefined;
  pass_through?: Array<PassThroughBody$Outbound> | undefined;
};

/** @internal */
export const CreditNoteInput$outboundSchema: z.ZodType<
  CreditNoteInput$Outbound,
  z.ZodTypeDef,
  CreditNoteInput
> = z.object({
  number: z.nullable(z.string()).optional(),
  customer: z.nullable(LinkedCustomerInput$outboundSchema).optional(),
  companyId: z.nullable(z.string()).optional(),
  currency: z.nullable(Currency$outboundSchema).optional(),
  currencyRate: z.nullable(z.number()).optional(),
  taxInclusive: z.nullable(z.boolean()).optional(),
  subTotal: z.nullable(z.number()).optional(),
  totalAmount: z.number(),
  totalTax: z.nullable(z.number()).optional(),
  taxCode: z.nullable(z.string()).optional(),
  balance: z.nullable(z.number()).optional(),
  remainingCredit: z.nullable(z.number()).optional(),
  status: CreditNoteStatus$outboundSchema.optional(),
  reference: z.nullable(z.string()).optional(),
  dateIssued: z.date().transform(v => v.toISOString()).optional(),
  datePaid: z.nullable(z.date().transform(v => v.toISOString())).optional(),
  type: CreditNoteType$outboundSchema.optional(),
  account: z.nullable(LinkedLedgerAccountInput$outboundSchema).optional(),
  lineItems: z.array(InvoiceLineItemInput$outboundSchema).optional(),
  allocations: z.array(AllocationInput$outboundSchema).optional(),
  note: z.nullable(z.string()).optional(),
  terms: z.nullable(z.string()).optional(),
  billingAddress: Address$outboundSchema.optional(),
  shippingAddress: Address$outboundSchema.optional(),
  trackingCategories: z.nullable(z.array(LinkedTrackingCategory$outboundSchema))
    .optional(),
  customFields: z.array(CustomField$outboundSchema).optional(),
  rowVersion: z.nullable(z.string()).optional(),
  passThrough: z.array(PassThroughBody$outboundSchema).optional(),
}).transform((v) => {
  return remap$(v, {
    companyId: "company_id",
    currencyRate: "currency_rate",
    taxInclusive: "tax_inclusive",
    subTotal: "sub_total",
    totalAmount: "total_amount",
    totalTax: "total_tax",
    taxCode: "tax_code",
    remainingCredit: "remaining_credit",
    dateIssued: "date_issued",
    datePaid: "date_paid",
    lineItems: "line_items",
    billingAddress: "billing_address",
    shippingAddress: "shipping_address",
    trackingCategories: "tracking_categories",
    customFields: "custom_fields",
    rowVersion: "row_version",
    passThrough: "pass_through",
  });
});

/**
 * @internal
 * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
 */
export namespace CreditNoteInput$ {
  /** @deprecated use `CreditNoteInput$inboundSchema` instead. */
  export const inboundSchema = CreditNoteInput$inboundSchema;
  /** @deprecated use `CreditNoteInput$outboundSchema` instead. */
  export const outboundSchema = CreditNoteInput$outboundSchema;
  /** @deprecated use `CreditNoteInput$Outbound` instead. */
  export type Outbound = CreditNoteInput$Outbound;
}

export function creditNoteInputToJSON(
  creditNoteInput: CreditNoteInput,
): string {
  return JSON.stringify(CreditNoteInput$outboundSchema.parse(creditNoteInput));
}

export function creditNoteInputFromJSON(
  jsonString: string,
): SafeParseResult<CreditNoteInput, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => CreditNoteInput$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'CreditNoteInput' from JSON`,
  );
}