Purchase Order

Get Purchase Orders

GET https://api.zortout.com/api.aspx

Get list of purchase orders.

Query Parameters

Name
Type
Description

method*

String

“GETPURCHASEORDERS”

paymentbefore

String

Paid Date Before ..... (yyyy-MM-dd)

paymentafter

String

Paid Date After ..... (yyyy-MM-dd)

updatedbefore

String

Updated Date Before ..... (yyyy-MM-dd)

updatedafter

String

Updated Date After ..... (yyyy-MM-dd)

createdbefore

String

Created Date Before ..... (yyyy-MM-dd)

createdafter

String

Created Date After ..... (yyyy-MM-dd)

purchaseorderdatebefore

String

Purchase Order Date Before ..... (yyyy-MM-dd)

purchaseorderdateafter

String

Purchase Order Date After ..... (yyyy-MM-dd)

version*

String

3

format

String

json (Default), xml

toamount

Double

Maximum amount

fromamount

Double

Minimum amount

updatedatetimebefore

String

Updated Datetime Before ..... (yyyy-MM-dd HH:mm)

updatedatetimeafter

String

Updated Datetime After ..... (yyyy-MM-dd HH:mm)

createdatetimebefore

String

Created Datetime Before ..... (yyyy-MM-dd HH:mm)

createdatetimeafter

String

Created Datetime After ..... (yyyy-MM-dd HH:mm)

keyword

String

Keyword to search

expirylot

Int

Show expiry lot status 0 - No (Default) 1 - Yes

serialno

Int

Show serial no status 0 - No (Default) 1 - Yes

createusername

String

Created by (Username)

warehousecode

String

Warehouse Code

topaymentamount

Double

Maximum payment amount

frompaymentamount

Double

Minimum payment amount

limit

Int

Limit per page (Max = 2000)

page

Int

Page (Default = 1)

Headers

Name
Type
Description

storename*

String

Store Name

numberlist

String

List Of Purchase Order Number Ex. “PO-001,PO-002,PO-003”

purchaseorderidlist

String

List Of Purchase Order ID Ex. “123,124,125”

apisecret*

String

API Secret

apikey*

String

API Key

Get Purchase Order Detail

GET https://api.zortout.com/api.aspx

Get purchase order detail.

Query Parameters

Name
Type
Description

method*

String

“GETPURCHASEORDERDETAIL”

id*

Int

Purchase Order ID

version*

String

3

format

String

json (Default), xml

Headers

Name
Type
Description

storename*

String

Store Name

apikey*

String

API Key

apisecret*

String

API Secret

Get Movement Purchase Order Detail

GET https://api.zortout.com/api.aspx

Get movement list of products according to each purchase order.

Query Parameters

Name
Type
Description

method*

String

“GETMOVEMENTPURCHASEORDERDETAIL”

id*

Int

Purchase Order ID

version*

String

3

format

String

json (Default), xml

Headers

Name
Type
Description

storename*

String

Store Name

apikey*

String

API Key

apisecret*

String

API Secret

Get Movement Purchase Orders

GET https://api.zortout.com/api.aspx

Get movement list of products for purchase orders.

Query Parameters

Name
Type
Description

method*

String

“GETMOVEMENTPURCHASEORDERS”

limit

Int

Limit per page (Max = 2000)

page

Int

Page (Default = 1)

warehousecode

String

Warehouse Code

datebefore*

String

Date Before ..... (yyyy-MM-dd)

dateafter*

String

Date After ..... (yyyy-MM-dd)

version*

String

3

format

String

json (Default), xml

Headers

Name
Type
Description

storename*

String

Store Name

apikey*

String

API Key

apisecret*

String

API Secret

Get Expense Purchase Order Detail

GET https://api.zortout.com/api.aspx

Get list of expenses of purchase order.

Query Parameters

Name
Type
Description

method*

String

“GETEXPENSEPURCHASEORDERDETAIL”

id*

Int

Purchase Order ID

version*

String

3

format

String

json (Default), xml

Headers

Name
Type
Description

storename*

String

Store Name

apikey*

String

API Key

apisecret*

String

API Secret

Add Purchase Order

POST https://api.zortout.com/api.aspx

Add purchase order.

Query Parameters

Name
Type
Description

method*

String

“ADDPURCHASEORDER”

uniquenumber

String

Unique Number.

This value is unique and used to prevent duplicate transaction.

version*

String

3

format

String

json (Default), xml

Headers

Name
Type
Description

storename*

String

Store Name

apisecret*

String

API Secret

apikey*

String

API Key

Request Body

Name
Type
Description

number*

String

Purchase Order Number

status

String

Status (Pending,Success) Default – Pending

reference

String

Reference

customeraddress

String

Contact Address

customerphone

String

Contact Phone

customeremail

String

Contact Email

customeridnumber

String

Contact ID Number/Tax ID

customername

String

Contact Name

paymentamount

Double

Payment Amount

("paymentmethod" must be required.)

paymentmethod

String

Payment Method

purchaseorderdate

String

Purchase Order Date

Ex. “2021-09-15”

vatamount

Double

Vat Amount

amount*

Double

Net Amount

warehousecode

String

Warehouse Code

discount

String

Discount Ex.5.00, 10%

description

String

Description

∟ sku*

String

Product Sku

list

PurchaseOrderProduct (Array)

Product List

∟ totalprice*

Double

Total Price

∟ discount

String

Discount Per Unit

∟ pricepernumber*

Double

Product Price/Quantity

∟ number*

Double

Product Quantity

∟ name*

String

Product Name

tag

String (Array)

Tag List (Array)

vattype

Int

Vat Type 1 – No Vat 2 – Exclude Vat 3 – Include Vat If vattype is not defined, the system will use vatamount to calculate and define automatically. If vattype = 1, 2 or 3, the system will ignore vatamount and calculate vatamount value automatically.

customercode

String

Contact Code

customerbranchno

String

Contact Branch No

customerbranchname

String

Contact Branch Name

∟ value

String

Property Value

∟ name

String

Property Name Require if id = 0 or null

*Must have either id or name

∟ id

Int

Property ID

*Must have either id or name

properties

Property (Array)

Custom Properties List

shippingvat

Int

Shipping Vat Status 0 - No Shipping Vat (Default) 1 – Have Shipping Vat

shippingamount

Double

Shipping Amount

Update Purchase Order Status

POST https://api.zortout.com/api.aspx

Update status of purchase order.

Query Parameters

Name
Type
Description

method*

String

“UPDATEPURCHASEORDERSTATUS”

status

Int

1 = Success (Default) 3 = Waiting 6 = Shipping

warehousecode

String

Warehouse Code

number

String

Purchase Order Number Require if id = 0 or null

*Must have either id or number

id

Int

Purchase Order ID

*Must have either id or number

version*

String

3

format

String

json (Default), xml

Headers

Name
Type
Description

storename*

String

Store Name

apikey*

String

API Key

apisecret*

String

API Secret

Update Purchase Order Payment

POST https://api.zortout.com/api.aspx

Update payment of purchase order.

Query Parameters

Name
Type
Description

method*

String

“UPDATEPURCHASEORDERPAYMENT”

paymentdate

String

Payment Datetime Ex. “2021-09-15 21:05”

paymentamount*

Double

Payment Amount

paymentmethod*

String

Payment Method

number

String

Purchase Order Number Require if id = 0 or null

*Must have either id or number

id

Int

Purchase Order ID

*Must have either id or number

version*

String

3

format

String

json (Default), xml

Headers

Name
Type
Description

storename*

String

Store Name

apikey*

String

API Key

apisecret*

String

API Secret

Update Partial Purchase Order

POST https://api.zortout.com/api.aspx

Update partial product of purchase order.

Query Parameters

Name
Type
Description

method*

String

"UPDATEPARTIALPURCHASEORDER"

number

String

Purchase Order Number Require if id = 0 or null

*Must have either id or number

id

Int

Purchase Order ID

*Must have either id or number

version*

String

3

format

String

json (Default), xml

Headers

Name
Type
Description

storename*

String

Store Name

apikey*

String

API Key

apisecret*

String

API Secret

Request Body

Name
Type
Description

PurchaseOrderProduct (Array)

Product List

∟ productid

Int

Product ID

*Must have either productid or sku

∟ sku

String

Product Sku Require if productid = 0 or null

*Must have either productid or sku

∟ number*

Double

Product Quantity

Edit Purchase Order Info

POST https://api.zortout.com/api.aspx

Edit purchase order info.

Query Parameters

Name
Type
Description

method*

String

“EDITPURCHASEORDERINFO”

number

String

Purchase Order Number Require if id = 0 or null

*Must have either id or number

id

Int

Purchase Order ID

*Must have either id or number

version*

String

3

format

String

json (Default), xml

Headers

Name
Type
Description

storename*

String

Store Name

apikey*

String

API Key

apisecret*

String

API Secret

Request Body

Name
Type
Description

number

String

Purchase Order Number

purchaseorderdate

String

Purchase Order Date

Ex. “2021-09-15”

shippingdate

String

Shipping Date

Ex. “2021-09-15”

customeraddress

String

Contact Address

customerphone

String

Contact Phone

customeremail

String

Contact Email

customeridnumber

String

Contact ID Number/Tax ID

customername

String

Contact Name

tag

String (Array)

Tag List (Array)

description

String

Description

customercode

String

Contact Code

customerbranchname

String

Contact Branch Name

customerbranchno

String

Contact Branch No

reference

String

Reference

Edit Purchase Order

POST https://api.zortout.com/api.aspx

Edit purchase order.

Query Parameters

Name
Type
Description

method*

String

“EDITPURCHASEORDER”

number

String

Purchase Order Number Require if id = 0 or null

*Must have either id or number

id

Int

Purchase Order ID

*Must have either id or number

version*

String

3

format

String

json (Default), xml

Headers

Name
Type
Description

storename*

String

Store Name

apisecret*

String

API Secret

apikey*

String

API Key

Request Body

Name
Type
Description

number

String

Purchase Order Number

customerbranchname

String

Contact Branch Name

customeraddress

String

Contact Address

customerphone

String

Contact Phone

customeremail

String

Contact Email

customeridnumber

String

Contact ID Number/Tax ID

customername

String

Contact Name

customercode

String

Contact Code

vattype

Int

Vat Type 1 – No Vat 2 – Exclude Vat 3 – Include Vat If vattype is not defined, the system will use vatamount to calculate and define automatically. If vattype = 1, 2 or 3, the system will ignore vatamount and calculate vatamount value automatically.

vatamount

Double

Vat Amount

amount*

Double

Net Amount

tag

String (Array)

Tag List (Array)

description

String

Description

reference

String

Reference

purchaseorderdate

String

Purchase Order Date

Ex. “2021-09-15”

shippingdate

String

Shipping Date

Ex. “2021-09-15”

customerbranchno

String

Contact Branch No

∟ sku*

String

Product Sku

list

PurchaseOrderProduct (Array)

Product List

discount

String

Discount Ex.5.00, 10%

shippingvat

Int

Shipping Vat Status 0 - No Shipping Vat (Default) 1 – Have Shipping Vat

shippingamount

Double

Shipping Amount

∟ discount

String

Discount Per Unit

∟ pricepernumber*

Double

Product Price/Quantity

∟ number*

Double

Product Quantity

∟ name*

String

Product Name

∟ totalprice*

Double

Total Price

Void Purchase Order

POST https://api.zortout.com/api.aspx

Void purchase order.

Query Parameters

Name
Type
Description

method*

String

“VOIDPURCHASEORDER”

number

String

Purchase Order Number Require if id = 0 or null

*Must have either id or number

id

Int

Purchase Order ID

*Must have either id or number

version*

String

3

format

String

json (Default), xml

Headers

Name
Type
Description

storename*

String

Store Name

apikey*

String

API Key

apisecret*

String

API Secret

Void Purchase Order Payment

POST https://api.zortout.com/api.aspx

Delete payment in purchase order.

Query Parameters

Name
Type
Description

method*

String

“VOIDPURCHASEORDERPAYMENT”

paymentid*

Int

Payment ID

number

String

Purchase Order Number Require if id = 0 or null

*Must have either id or number

id

Int

Purchase Order ID

*Must have either id or number

version*

String

3

format

String

json (Default), xml

Headers

Name
Type
Description

storename*

String

Store Name

apikey*

String

API Key

apisecret*

String

API Secret

Update Purchase Order Serial No

POST https://api.zortout.com/api.aspx

Update serial number of purchase order.

Query Parameters

Name
Type
Description

method*

String

“UPDATEPURCHASEORDERSERIALNO”

serialno*

String

Serial Number

sku

String

Product Sku Require if productid = 0 or null

*Must have either productid or sku

productid

Int

Product ID

*Must have either productid or sku

number

String

Purchase Order Number Require if id = 0 or null

*Must have either id or number

id

Int

Purchase Order ID

*Must have either id or number

version*

String

3

format

String

json (Default), xml

Headers

Name
Type
Description

storename*

String

Store Name

apikey*

String

API Key

apisecret*

String

API Secret

Update Purchase Order Expiry/Lot

POST https://api.zortout.com/api.aspx

Update expiry/lot of purchase order.

Query Parameters

Name
Type
Description

method*

String

“UPDATEPURCHASEORDEREXPIRYLOT”

expiredate

String

Expired Date of Lot (yyyy-MM-dd)

lotnumber*

Double

Lot Number

lot*

String

Lot Name

sku

String

Product Sku Require if productid = 0 or null

*Must have either productid or sku

productid

String

Product ID

*Must have either productid or sku

number

String

Purchase Order Number Require if id = 0 or null

*Must have either id or number

id

Int

Purchase Order ID

*Must have either id or number

version*

String

3

format

String

json (Default), xml

Headers

Name
Type
Description

storename*

String

Store Name

apikey*

String

API Key

apisecret*

String

API Secret

Add Expense Purchase Order

POST https://api.zortout.com/api.aspx

Add expense to purchase order.

Query Parameters

Name
Type
Description

method*

String

“ADDEXPENSEWITHPURCHASEORDER”

id*

Int

Purchase Order ID

version*

String

3

format

String

json 3(Default), xml

Headers

Name
Type
Description

storename*

String

Store Name

apikey*

String

API Key

apisecret*

String

API Secret

Request Body

Name
Type
Description

name*

String

Expense Name

paymentname*

String

Payment Method

amount*

Double

Amount

isvat

Int

Vat Status 0 - No Vat (Default)

1 - Include Vat

Add Purchase Order Tag

POST https://api.zortout.com/api.aspx

Add tag to purchase order.

Query Parameters

Name
Type
Description

method*

String

“ADDPURCHASEORDERTAG”

tag*

String

Tag

number

String

Purchase Order Number Require if id = 0 or null

*Must have either id or number

version*

String

3

format

String

json (Default), xml

id

Int

Purchase Order ID

*Must have either id or number

Headers

Name
Type
Description

storename*

String

Store Name

apikey*

String

API Key

apisecret*

String

API Secret

Last updated