Class PurchaseOrderHandler

Index

Constructors

Methods

cancel create getByDateRange getById getBySupplier list update

Constructors

constructor

new PurchaseOrderHandler(client: KiotVietClient): PurchaseOrderHandler
Parameters
- client: KiotVietClient
Returns PurchaseOrderHandler
- Defined in src/resources/purchase-orders.ts:12

Methods

cancel

cancel(purchaseOrderId: number, reason?: string): Promise<PurchaseOrder>
Cancel a purchase order
Parameters
- purchaseOrderId: number
  The ID of the purchase order to cancel
- Optionalreason: string
  Optional cancellation reason
Returns Promise<PurchaseOrder>
- Defined in src/resources/purchase-orders.ts:59

create

create(purchaseOrderData: PurchaseOrderCreateParams): Promise<PurchaseOrder>
Create a new purchase order
Parameters
- purchaseOrderData: PurchaseOrderCreateParams
  The purchase order data to create
Returns Promise<PurchaseOrder>
- Defined in src/resources/purchase-orders.ts:36

getByDateRange

getByDateRange(
    fromDate: string,
    toDate: string,
    params?: Omit<
        PurchaseOrderListParams,
        "fromPurchaseDate"
        | "toPurchaseDate",
    >,
): Promise<PurchaseOrderListResponse>
Get purchase orders by date range
Parameters
- fromDate: string
  Start date (YYYY-MM-DD)
- toDate: string
  End date (YYYY-MM-DD)
- params: Omit<PurchaseOrderListParams, "fromPurchaseDate" | "toPurchaseDate"> = {}
  Additional filter parameters
Returns Promise<PurchaseOrderListResponse>
- Defined in src/resources/purchase-orders.ts:74

getById

getById(purchaseOrderId: number): Promise<PurchaseOrder>
Get a purchase order by its ID
Parameters
- purchaseOrderId: number
  The ID of the purchase order to retrieve
Returns Promise<PurchaseOrder>
- Defined in src/resources/purchase-orders.ts:27

getBySupplier

getBySupplier(
supplierCode: string,
params?: Omit<PurchaseOrderListParams, "supplierCode">,
): Promise<PurchaseOrderListResponse>
Get purchase orders by supplier code
Parameters
- supplierCode: string
  The supplier code to filter by
- params: Omit<PurchaseOrderListParams, "supplierCode"> = {}
  Additional filter parameters
Returns Promise<PurchaseOrderListResponse>
- Defined in src/resources/purchase-orders.ts:94

list

list(params?: PurchaseOrderListParams): Promise<PurchaseOrderListResponse>
List purchase orders with optional filtering
Parameters
- params: PurchaseOrderListParams = {}
  Filter parameters
Returns Promise<PurchaseOrderListResponse>
- Defined in src/resources/purchase-orders.ts:18

update

update(
purchaseOrderId: number,
purchaseOrderData: Partial<PurchaseOrderUpdateParams>,
): Promise<PurchaseOrder>
Update an existing purchase order
Parameters
- purchaseOrderId: number
  The ID of the purchase order to update
- purchaseOrderData: Partial<PurchaseOrderUpdateParams>
  The purchase order data to update
Returns Promise<PurchaseOrder>
- Defined in src/resources/purchase-orders.ts:46