mollie-api-typescript 0.9.5 → 0.9.6

package/src/models/listentityinvoice.ts

@@ -0,0 +1,492 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  Amount,
+  Amount$inboundSchema,
+  Amount$Outbound,
+  Amount$outboundSchema,
+} from "./amount.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  Url,
+  Url$inboundSchema,
+  Url$Outbound,
+  Url$outboundSchema,
+} from "./url.js";
+
+/**
+ * Status of the invoice.
+ */
+export const ListEntityInvoiceStatus = {
+  Open: "open",
+  Paid: "paid",
+  Overdue: "overdue",
+} as const;
+/**
+ * Status of the invoice.
+ */
+export type ListEntityInvoiceStatus = OpenEnum<typeof ListEntityInvoiceStatus>;
+
+/**
+ * Total amount of the invoice, excluding VAT.
+ */
+export type ListEntityInvoiceNetAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+/**
+ * VAT amount of the invoice. Only applicable to merchants registered in the Netherlands. For EU merchants, VAT will
+ *
+ * @remarks
+ * be shifted to the recipient (as per article 44 and 196 in the EU VAT Directive 2006/112). For merchants outside
+ * the EU, no VAT will be charged.
+ */
+export type ListEntityInvoiceVatAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+/**
+ * Total amount of the invoice, including VAT.
+ */
+export type ListEntityInvoiceGrossAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+export type ListEntityInvoiceLine = {
+  /**
+   * The administrative period in `YYYY-MM` on which the line should be booked.
+   */
+  period: string;
+  /**
+   * Description of the product.
+   */
+  description: string;
+  /**
+   * Number of products invoiced. For example, the number of payments.
+   */
+  count: number;
+  /**
+   * VAT percentage rate that applies to this product.
+   */
+  vatPercentage: number;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount: Amount;
+};
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type ListEntityInvoiceLinks = {
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  self?: Url | undefined;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  pdf?: Url | undefined;
+};
+
+export type ListEntityInvoice = {
+  /**
+   * Indicates that the response contains an invoice object.
+   *
+   * @remarks
+   * Will always contain the string `invoice` for this endpoint.
+   */
+  resource: string;
+  id: string;
+  /**
+   * The reference number of the invoice. An example value would be: `2024.10000`.
+   */
+  reference: string;
+  /**
+   * The VAT number to which the invoice was issued to, if applicable.
+   */
+  vatNumber: string | null;
+  status: ListEntityInvoiceStatus;
+  /**
+   * Total amount of the invoice, excluding VAT.
+   */
+  netAmount: ListEntityInvoiceNetAmount;
+  /**
+   * VAT amount of the invoice. Only applicable to merchants registered in the Netherlands. For EU merchants, VAT will
+   *
+   * @remarks
+   * be shifted to the recipient (as per article 44 and 196 in the EU VAT Directive 2006/112). For merchants outside
+   * the EU, no VAT will be charged.
+   */
+  vatAmount: ListEntityInvoiceVatAmount;
+  /**
+   * Total amount of the invoice, including VAT.
+   */
+  grossAmount: ListEntityInvoiceGrossAmount;
+  /**
+   * The collection of products which make up the invoice.
+   */
+  lines: Array<ListEntityInvoiceLine>;
+  /**
+   * The invoice date in `YYYY-MM-DD` format.
+   */
+  issuedAt: string;
+  /**
+   * The date on which the invoice was paid, if applicable, in `YYYY-MM-DD` format.
+   */
+  paidAt?: string | null | undefined;
+  /**
+   * The date on which the invoice is due, if applicable, in `YYYY-MM-DD` format.
+   */
+  dueAt?: string | null | undefined;
+  /**
+   * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+   */
+  links: ListEntityInvoiceLinks;
+};
+
+/** @internal */
+export const ListEntityInvoiceStatus$inboundSchema: z.ZodType<
+  ListEntityInvoiceStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListEntityInvoiceStatus);
+/** @internal */
+export const ListEntityInvoiceStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ListEntityInvoiceStatus
+> = openEnums.outboundSchema(ListEntityInvoiceStatus);
+
+/** @internal */
+export const ListEntityInvoiceNetAmount$inboundSchema: z.ZodType<
+  ListEntityInvoiceNetAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type ListEntityInvoiceNetAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const ListEntityInvoiceNetAmount$outboundSchema: z.ZodType<
+  ListEntityInvoiceNetAmount$Outbound,
+  z.ZodTypeDef,
+  ListEntityInvoiceNetAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function listEntityInvoiceNetAmountToJSON(
+  listEntityInvoiceNetAmount: ListEntityInvoiceNetAmount,
+): string {
+  return JSON.stringify(
+    ListEntityInvoiceNetAmount$outboundSchema.parse(listEntityInvoiceNetAmount),
+  );
+}
+export function listEntityInvoiceNetAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityInvoiceNetAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityInvoiceNetAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityInvoiceNetAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityInvoiceVatAmount$inboundSchema: z.ZodType<
+  ListEntityInvoiceVatAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type ListEntityInvoiceVatAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const ListEntityInvoiceVatAmount$outboundSchema: z.ZodType<
+  ListEntityInvoiceVatAmount$Outbound,
+  z.ZodTypeDef,
+  ListEntityInvoiceVatAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function listEntityInvoiceVatAmountToJSON(
+  listEntityInvoiceVatAmount: ListEntityInvoiceVatAmount,
+): string {
+  return JSON.stringify(
+    ListEntityInvoiceVatAmount$outboundSchema.parse(listEntityInvoiceVatAmount),
+  );
+}
+export function listEntityInvoiceVatAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityInvoiceVatAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityInvoiceVatAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityInvoiceVatAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityInvoiceGrossAmount$inboundSchema: z.ZodType<
+  ListEntityInvoiceGrossAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type ListEntityInvoiceGrossAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const ListEntityInvoiceGrossAmount$outboundSchema: z.ZodType<
+  ListEntityInvoiceGrossAmount$Outbound,
+  z.ZodTypeDef,
+  ListEntityInvoiceGrossAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function listEntityInvoiceGrossAmountToJSON(
+  listEntityInvoiceGrossAmount: ListEntityInvoiceGrossAmount,
+): string {
+  return JSON.stringify(
+    ListEntityInvoiceGrossAmount$outboundSchema.parse(
+      listEntityInvoiceGrossAmount,
+    ),
+  );
+}
+export function listEntityInvoiceGrossAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityInvoiceGrossAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityInvoiceGrossAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityInvoiceGrossAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityInvoiceLine$inboundSchema: z.ZodType<
+  ListEntityInvoiceLine,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  period: z.string(),
+  description: z.string(),
+  count: z.number().int(),
+  vatPercentage: z.number().int(),
+  amount: Amount$inboundSchema,
+});
+/** @internal */
+export type ListEntityInvoiceLine$Outbound = {
+  period: string;
+  description: string;
+  count: number;
+  vatPercentage: number;
+  amount: Amount$Outbound;
+};
+
+/** @internal */
+export const ListEntityInvoiceLine$outboundSchema: z.ZodType<
+  ListEntityInvoiceLine$Outbound,
+  z.ZodTypeDef,
+  ListEntityInvoiceLine
+> = z.object({
+  period: z.string(),
+  description: z.string(),
+  count: z.number().int(),
+  vatPercentage: z.number().int(),
+  amount: Amount$outboundSchema,
+});
+
+export function listEntityInvoiceLineToJSON(
+  listEntityInvoiceLine: ListEntityInvoiceLine,
+): string {
+  return JSON.stringify(
+    ListEntityInvoiceLine$outboundSchema.parse(listEntityInvoiceLine),
+  );
+}
+export function listEntityInvoiceLineFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityInvoiceLine, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityInvoiceLine$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityInvoiceLine' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityInvoiceLinks$inboundSchema: z.ZodType<
+  ListEntityInvoiceLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema.optional(),
+  pdf: Url$inboundSchema.optional(),
+});
+/** @internal */
+export type ListEntityInvoiceLinks$Outbound = {
+  self?: Url$Outbound | undefined;
+  pdf?: Url$Outbound | undefined;
+};
+
+/** @internal */
+export const ListEntityInvoiceLinks$outboundSchema: z.ZodType<
+  ListEntityInvoiceLinks$Outbound,
+  z.ZodTypeDef,
+  ListEntityInvoiceLinks
+> = z.object({
+  self: Url$outboundSchema.optional(),
+  pdf: Url$outboundSchema.optional(),
+});
+
+export function listEntityInvoiceLinksToJSON(
+  listEntityInvoiceLinks: ListEntityInvoiceLinks,
+): string {
+  return JSON.stringify(
+    ListEntityInvoiceLinks$outboundSchema.parse(listEntityInvoiceLinks),
+  );
+}
+export function listEntityInvoiceLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityInvoiceLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityInvoiceLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityInvoiceLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityInvoice$inboundSchema: z.ZodType<
+  ListEntityInvoice,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  reference: z.string(),
+  vatNumber: z.nullable(z.string()),
+  status: ListEntityInvoiceStatus$inboundSchema,
+  netAmount: z.lazy(() => ListEntityInvoiceNetAmount$inboundSchema),
+  vatAmount: z.lazy(() => ListEntityInvoiceVatAmount$inboundSchema),
+  grossAmount: z.lazy(() => ListEntityInvoiceGrossAmount$inboundSchema),
+  lines: z.array(z.lazy(() => ListEntityInvoiceLine$inboundSchema)),
+  issuedAt: z.string(),
+  paidAt: z.nullable(z.string()).optional(),
+  dueAt: z.nullable(z.string()).optional(),
+  _links: z.lazy(() => ListEntityInvoiceLinks$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+/** @internal */
+export type ListEntityInvoice$Outbound = {
+  resource: string;
+  id: string;
+  reference: string;
+  vatNumber: string | null;
+  status: string;
+  netAmount: ListEntityInvoiceNetAmount$Outbound;
+  vatAmount: ListEntityInvoiceVatAmount$Outbound;
+  grossAmount: ListEntityInvoiceGrossAmount$Outbound;
+  lines: Array<ListEntityInvoiceLine$Outbound>;
+  issuedAt: string;
+  paidAt?: string | null | undefined;
+  dueAt?: string | null | undefined;
+  _links: ListEntityInvoiceLinks$Outbound;
+};
+
+/** @internal */
+export const ListEntityInvoice$outboundSchema: z.ZodType<
+  ListEntityInvoice$Outbound,
+  z.ZodTypeDef,
+  ListEntityInvoice
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  reference: z.string(),
+  vatNumber: z.nullable(z.string()),
+  status: ListEntityInvoiceStatus$outboundSchema,
+  netAmount: z.lazy(() => ListEntityInvoiceNetAmount$outboundSchema),
+  vatAmount: z.lazy(() => ListEntityInvoiceVatAmount$outboundSchema),
+  grossAmount: z.lazy(() => ListEntityInvoiceGrossAmount$outboundSchema),
+  lines: z.array(z.lazy(() => ListEntityInvoiceLine$outboundSchema)),
+  issuedAt: z.string(),
+  paidAt: z.nullable(z.string()).optional(),
+  dueAt: z.nullable(z.string()).optional(),
+  links: z.lazy(() => ListEntityInvoiceLinks$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    links: "_links",
+  });
+});
+
+export function listEntityInvoiceToJSON(
+  listEntityInvoice: ListEntityInvoice,
+): string {
+  return JSON.stringify(
+    ListEntityInvoice$outboundSchema.parse(listEntityInvoice),
+  );
+}
+export function listEntityInvoiceFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityInvoice, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityInvoice$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityInvoice' from JSON`,
+  );
+}