Order APIs

An order allows you to buy/sell products or services. Once the order is completed, you will be able to convert it into bills upon confirmation or track the receipts directly.

OrderDto helps to create order, update a particular order, retrieve order by filter criteria, or get a list of all orders.

API

Search Order

Get orders by filter criteria. More about search order

Description:

Allows you to retrieve a list of all orders.
Allows you to retrieve specific order based on it's filter criteria.

GET

Orders purchase

More about search order

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Purchase orders have been fetched successfully.	PurchaseOrderResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Create Purchase Order

Create a new order. More about create order

Description:

Allows you to create new order.

POST

Orders purchase

More about create order

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderRequest	body	purchaseOrderRequest	Yes	PurchaseOrderRequest

Responses

Code	Description	Schema
200	OK	PurchaseOrderResponse
201	Purchase order has been created successfully.	PurchaseOrderResponse
400	Purchase order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Update Order

Update order information. More about update order

Description:

Allows you to update a specific order information.

PUT

Orders purchase/{id}

More about update order

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseOrderRequest	body	purchaseOrderRequest	Yes	PurchaseOrderRequest

Responses

Code	Description	Schema
200	Purchase Order has been updated successfully.	PurchaseOrderResponse
201	Created
400	Purchase order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

Retrieve Order

Get order by code. More about retrieve order

Description:

Allows you to retrieve an existing order details by it's code.

GET

Orders purchase/code/{code}

More about retrieve order

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Delete Purchase Order

DELETE

Orders purchase

Summary

Delete multiple purchase orders

Description

API to delete multiple purchase orders

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Purchase order deletion successful	BulkResponse
401	Unauthorized
403	Forbidden
404	No purchase order with provided id's found

Security

Security Schema	Scopes
Authorization	global

job-work-out-order-controller

Job Work Out Order APIs

Orders jobworkout

GET

Summary

Search Job Work Out orders.

Description

API to search Job Work Out orders.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
fetchAttachmentDetails	query	fetchAttachmentDetails	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Job Work Out orders have been fetched successfully.	JobWorkOutOrderResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Job Work Out order

Description

API to create Job Work Out order.

Parameters

Name	Located in	Description	Required	Schema
jobWorkOutOrderRequest	body	jobWorkOutOrderRequest	Yes	JobWorkOutOrderRequest

Responses

Code	Description	Schema
200	OK	JobWorkOutOrderResponse
201	Job Work Out order has been created successfully.	JobWorkOutOrderResponse
400	Job Work Out order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update Job Work Out order billed status

Description

API to update Job Work Out order billed status

Parameters

Name	Located in	Description	Required	Schema
orderCode	query	orderCode	Yes	string
purchaseOrderFields	body	purchaseOrderFields	Yes	object

Responses

Code	Description	Schema
200	Billed status for Job Work Out order updated successfully.	PurchaseOrderResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Job Work Out Order with id not found.

Security

Security Schema	Scopes
Authorization	global

Orders jobworkout/bulk-details

POST

Summary

Get Job Work Out order by list of codes

Description

Get Job Work Out order by list of codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ JobWorkOutOrderResponse ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders jobworkout/code/{code}/details

GET

Summary

Job Work Out order details by codes

Description

Job Work Out order details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	JobWorkOutOrderInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders jobworkout/code/{code}/detailsbyworkorder

GET

Summary

Job Work Out order details by Work order codes

Description

Job Work Out order details by Work order codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	[ JobWorkOutOrderInformation ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders jobworkout/linked-docs/product-codes

POST

Summary

Get products by code

Description

API to Get products by code.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product information has been fetched successfully.	string
201	Created
401	Unauthorized
403	Forbidden
404	Products not found.

Security

Security Schema	Scopes
Authorization	global

Orders jobworkout/product-used-bom-codes

POST

Summary

Get used bom meta code for product

Description

API to Get used bom meta code for product.

Parameters

Name	Located in	Description	Required	Schema
productCode	query	productCode	Yes	string

Responses

Code	Description	Schema
200	Bom meta code information has been fetched successfully.	string
201	Created
401	Unauthorized
403	Forbidden
404	Products not found.

Security

Security Schema	Scopes
Authorization	global

Orders jobworkout/status/{code}

PATCH

Summary

refreshOrderStatus

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description
200	OK
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Orders jobworkout/{code}

GET

Summary

Get Job Work Out order by id.

Description

API to fetch Job Work Out order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Job Work Out order information has been fetched successfully.	JobWorkOutOrderResponse
401	Unauthorized
403	Forbidden
404	Job Work Out order not found.

Security

Security Schema	Scopes
Authorization	global

Orders jobworkout/{id}

PUT

Summary

Update Job Work Out order.

Description

API to update existing Job Work Out order.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
jobWorkOutOrderRequest	body	jobWorkOutOrderRequest	Yes	JobWorkOutOrderRequest

Responses

Code	Description	Schema
200	Job Work Out Order has been updated successfully.	JobWorkOutOrderResponse
201	Created
400	Purchase order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Job Work Out Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete Job Work Out order by id.

Description

API to delete Job Work Out order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Job Work Out order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Job Work Out order not found.

Security

Security Schema	Scopes
Authorization	global

job-work-out-order-india-controller

Job work out Order India APIs

Orders jobworkout/in

GET

Summary

Search Job Work Out orders.

Description

API to search Job Work Out orders.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
fetchAttachmentDetails	query	fetchAttachmentDetails	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Job Work Out orders have been fetched successfully.	JobWorkOutOrderIndiaResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Job Work Out order

Description

API to create Job Work Out order.

Parameters

Name	Located in	Description	Required	Schema
jobWorkOutOrderIndiaRequest	body	jobWorkOutOrderIndiaRequest	Yes	JobWorkOutOrderIndiaRequest

Responses

Code	Description	Schema
200	OK	JobWorkOutOrderIndiaResponse
201	Job Work Out order has been created successfully.	JobWorkOutOrderIndiaResponse
400	Job Work Out order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders jobworkout/in/{code}

GET

Summary

Get Job Work Out order by id.

Description

API to fetch Job Work Out order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Job Work Out order information has been fetched successfully.	JobWorkOutOrderIndiaResponse
401	Unauthorized
403	Forbidden
404	Job Work Out order not found.

Security

Security Schema	Scopes
Authorization	global

Orders jobworkout/in/{id}

PUT

Summary

Update Job Work Out order.

Description

API to update existing Job Work Out order.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
jobWorkOutOrderIndiaRequest	body	jobWorkOutOrderIndiaRequest	Yes	JobWorkOutOrderIndiaRequest

Responses

Code	Description	Schema
200	Job Work Out Order has been updated successfully.	JobWorkOutOrderIndiaResponse
201	Created
400	Purchase order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Job Work Out Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete Job Work Out order by id.

Description

API to delete Job Work Out order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Job Work Out order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Job Work Out order not found.

Security

Security Schema	Scopes
Authorization	global

purchase-order-controller

Purchase Order APIs

PATCH

Orders purchase

Summary

Update purchase order billed status

Description

API to update purchase order billed status

Parameters

Name	Located in	Description	Required	Schema
orderCode	query	orderCode	Yes	string
purchaseOrderFields	body	purchaseOrderFields	Yes	object

Responses

Code	Description	Schema
200	Billed status for purchase order updated successfully.	PurchaseOrderResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Order with id not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/approval-status

POST

Summary

Update approval status

Description

API to update approval status

Parameters

Name	Located in	Description	Required	Schema
approvalStatusRequestDtoList	body	approvalStatusRequestDtoList	Yes	[ ApprovalStatusRequestDto ]

Responses

Code	Description
200	Approval status for Sales documents have been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/asset-group-count/{id}

GET

Summary

Get asset group used count.

Description

Api to get asset group used count.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Asset group used count fetched successfully.	integer
401	Unauthorized
403	Forbidden
404	Asset group used count not found.

Security

Security Schema	Scopes
Authorization	global

Delete Purchase Order in Bulk

DELETE

Orders purchase/bulk-delete

Summary

Bulk Delete orders.

Description

API to Bulk Delete order.

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	[ BulkDeleteOrderResponse ]
204	Order has been deleted successfully.	[ BulkDeleteOrderResponse ]
401	Unauthorized
403	Forbidden
404	Order not found.

Security

Security Schema	Scopes
Authorization	global

Get Purchase Order Details in Bulk

POST

Orders purchase/bulk-details

Summary

Purchase order details by list of codes

Description

Purchase order details by list of codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ PurchaseOrderInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/bulk-details-by-seq

POST

Summary

Purchase order details by sequence codes

Description

Purchase order details by sequence codes

Parameters

Name	Located in	Description	Required	Schema
seqCodes	body	seqCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ PurchaseOrderInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/bulk-email

POST

Summary

Send order/bill email.

Description

Send order/bill as email.

Parameters

Name	Located in	Description	Required	Schema
sendOrderEmails	body	sendOrderEmails	Yes	[ SendOrderEmailDto ]

Responses

Code	Description
200	Emails sent successfully.
201	Created
400	Unable to send emails.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/bulk-update

PATCH

Summary

Bulk Update Order Attribute

Description

API to Bulk Update Order Attribute

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderFields	body	purchaseOrderFields	Yes	[ Map«string,string» ]

Responses

Code	Description	Schema
200	Success	[ BulkUpdateOrderResponse ]
204	No Content
401	Unauthorized
403	Forbidden
404	Not found

Security

Security Schema	Scopes
Authorization	global

Retrieve Order

GET

Summary

Purchase order details by codes

Description

Purchase order details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseOrderInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/create-recurring

POST

Summary

Create a recurring purchase order

Description

API to create a recurring purchase order.

Parameters

Name	Located in	Description	Required	Schema
event	body	event	Yes	RecurringJobEvent

Responses

Code	Description
200	OK
201	Recurring purchase order created successfully
400	Error while creating recurring purchase order
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/demo/{tenantId}

POST

Summary

Create demo orders.

Description

API to create demo orders.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/draft/trigger

POST

Summary

Create approval status trigger

Description

API to reate approval status trigger

Parameters

Name	Located in	Description	Required	Schema
triggerKafkaRequestDto	body	triggerKafkaRequestDto	Yes	TriggerKafkaRequestDto

Responses

Code	Description
200	Trigger created for approval status
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/drop-ship

PUT

Summary

Update goods receipt status for order.

Description

API to update goods receipt status for order.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
eventType	query	eventType	No	string
isDropShip	query	isDropShip	No	boolean

Responses

Code	Description	Schema
200	Order attributes has been updated successfully.	PurchaseOrderInformation
201	Created
401	Unauthorized
403	Forbidden
404	Order with given code not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/email

POST

Summary

Send order as email

Description

API to send order as email

Parameters

Name	Located in	Description	Required	Schema
sendOrderEmail	body	sendOrderEmail	Yes	SendOrderEmailDto

Responses

Code	Description
200	Email sent successfully.
201	Created
400	Unable to send email.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/export

GET

Summary

Get purchase orders

Description

Get Purchase orders

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	OK	[ OrderReportInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/import

POST

Summary

Create multiple purchase orders via import

Description

API to create purchase orders via import.

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderRequests	body	purchaseOrderRequests	Yes	[ PurchaseOrderRequest ]

Responses

Code	Description	Schema
200	OK	BulkApiResponse
201	Sales invoice has been created successfully.	BulkApiResponse
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/incomingStockQuantities

POST

Summary

Fetch incoming stock quantities for orders and partially-fulfilled purchase invoices

Description

API to fetch incoming stock quantities for orders and partially-fulfilled purchase invoices.

Parameters

Name	Located in	Description	Required	Schema
request	body	request	Yes	StockQuantitiesRequest

Responses

Code	Description	Schema
200	Fetched incoming stock quantities for given list of product-codes successfully.	StockQuantitiesResponse
201	Created
400	Fetching incoming stock quantities for given list of product-codes failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/linked-docs/product-codes

POST

Summary

Get products by code

Description

API to Get products by code.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product information has been fetched successfully.	string
201	Created
401	Unauthorized
403	Forbidden
404	Products not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/product-in-out-qty

GET

Summary

Find order data for Product in out qty

Description

API to find order data for Product in out qty

Parameters

Name	Located in	Description	Required	Schema
productCode	query	productCode	Yes	string

Responses

Code	Description	Schema
200	OK	ProductInOutQty
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/receipt

GET

Summary

Fetch Goods receipts for documents

Description

API to Fetch Goods receipts for documents

Parameters

Name	Located in	Description	Required	Schema
documentCode	query	documentCode	Yes	string
documentType	query	documentType	Yes	string

Responses

Code	Description	Schema
200	Goods receipts for documents fetched successfully.	[ object ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/record-filter

POST

Summary

Create approval status trigger

Description

API to reate approval status trigger

Parameters

Name	Located in	Description	Required	Schema
filterRecord	body	filterRecord	Yes	FilterRecord

Responses

Code	Description	Schema
200	Trigger created for approval status	boolean
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/report/count

POST

Summary

Get purchase order count for contacts

Description

API to fetch purchase order count for contacts

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/report/overview

GET

Summary

Purchase report overview.

Description

API to fetch purchase report overview

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase orders overview report has been prepared.	OrderOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/sequence

GET

Summary

Order Document Code

Description

API to get Order Document Code.

Responses

Code	Description	Schema
200	Order Document Code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Order Document Code not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/set-recurring

POST

Summary

Set an purchase order to recurring

Description

API to set and purchase order to recurring.

Parameters

Name	Located in	Description	Required	Schema
setRecurringDto	body	setRecurringDto	Yes	SetRecurringDto

Responses

Code	Description
200	purchase order set to recur successfully
201	Created
400	Error while setting purchase order to recur
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/short-info/{code}

GET

Summary

Get purchase order Item details by codes

Description

API to fetch purchase order Item details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/status/{code}

PATCH

Summary

refreshOrderStatus

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description
200	OK
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Orders purchase/tax/count

POST

Summary

Get purchase order count for tax

Description

API to fetch purchase order count for tax

Parameters

Name	Located in	Description	Required	Schema
taxCodes	body	taxCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Tax purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/unreceived-seq-codes

GET

Summary

Get Unfulfilled purchase order codes

Description

Get Unfulfilled purchase order codes

Responses

Code	Description	Schema
200	Unfulfilled purchase order codes have been fetched successfully.	[ object ]
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/update/linkedDocument

POST

Summary

Update linked documents for PO.

Description

API to pdate linked documents for PO.

Parameters

Name	Located in	Description	Required	Schema
linkedDocumentUpdateRequest	body	linkedDocumentUpdateRequest	Yes	LinkedDocumentUpdateRequest

Responses

Code	Description
200	Linked document has been successfully updated.
201	Created
400	Linked document update failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/{id}

DELETE

Summary

Delete purchase order by id.

Description

API to delete purchase order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

purchase-order-uae-controller

Purchase Order UAE APIs

Orders purchase/ae

GET

Summary

Search purchase orders.

Description

API to search purchase orders.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Purchase orders have been fetched successfully.	PurchaseOrderUaeResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Purchase order

Description

API to create Purchase order

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderUaeRequest	body	purchaseOrderUaeRequest	Yes	PurchaseOrderUaeRequest

Responses

Code	Description	Schema
200	OK	PurchaseOrderUaeResponse
201	Purchase order has been created successfully.	PurchaseOrderUaeResponse
400	Purchase order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete multiple purchase orders

Description

API to delete multiple purchase orders

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Purchase order deletion successful	BulkResponse
401	Unauthorized
403	Forbidden
404	No purchase order with provided id's found

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase order billed status

Description

API to update purchase order billed status

Parameters

Name	Located in	Description	Required	Schema
orderCode	query	orderCode	Yes	string
purchaseOrderFields	body	purchaseOrderFields	Yes	object

Responses

Code	Description	Schema
200	Billed status for purchase order updated successfully.	PurchaseOrderUaeResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Order with id not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ae/code/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Get purchase order by id.	PurchaseOrderUaeResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ae/report/count

POST

Summary

Get purchase order count for contacts

Description

API to fetch purchase order count for contacts

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ae/report/overview

GET

Summary

Purchase report overview.

Description

API to fetch purchase report overview

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase orders overview report has been prepared.	OrderOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ae/sequence

GET

Summary

Order Document Code

Description

API to get Order Document Code.

Responses

Code	Description	Schema
200	Order Document Code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Order Document Code not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ae/short-info/{code}

GET

Summary

Get purchase order Item details by codes

Description

API to fetch purchase order Item details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderUaeResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ae/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderUaeResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ae/{id}

PUT

Summary

Update purchase order.

Description

API to update existing purchase order.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseOrderUaeRequest	body	purchaseOrderUaeRequest	Yes	PurchaseOrderUaeRequest

Responses

Code	Description	Schema
200	Purchase Order has been updated successfully.	PurchaseOrderUaeResponse
201	Created
400	Purchase order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase order by id.

Description

API to delete purchase order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

purchase-order-australia-controller

Purchase Order Australia APIs

Orders purchase/au

GET

Summary

Search purchase orders.

Description

API to search purchase orders.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Purchase orders have been fetched successfully.	PurchaseOrderAustraliaResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Purchase order

Description

API to create Purchase order.

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderRequest	body	purchaseOrderRequest	Yes	PurchaseOrderAustraliaRequest

Responses

Code	Description	Schema
200	OK	PurchaseOrderAustraliaResponse
201	Purchase order has been created successfully.	PurchaseOrderAustraliaResponse
400	Purchase order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete multiple purchase orders

Description

API to delete multiple purchase orders

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Purchase order deletion successful	BulkResponse
401	Unauthorized
403	Forbidden
404	No purchase order with provided id's found

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase order billed status

Description

API to update purchase order billed status

Parameters

Name	Located in	Description	Required	Schema
orderCode	query	orderCode	Yes	string
purchaseOrderFields	body	purchaseOrderFields	Yes	object

Responses

Code	Description	Schema
200	Billed status for purchase order updated successfully.	PurchaseOrderAustraliaResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Order with id not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/au/code/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Get purchase order by id.	PurchaseOrderAustraliaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/au/code/{code}/details

GET

Summary

Purchase order details by codes

Description

Purchase order details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseOrderInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/au/create-recurring

POST

Summary

Create a recurring purchase order

Description

API to create a recurring purchase order.

Parameters

Name	Located in	Description	Required	Schema
event	body	event	Yes	RecurringJobEvent

Responses

Code	Description
200	OK
201	Recurring purchase order created successfully
400	Error while creating recurring purchase order
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/au/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/au/demo/{tenantId}

POST

Summary

Create demo orders.

Description

API to create demo orders.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/au/export

GET

Summary

Get purchase orders

Description

Get Purchase orders

Responses

Code	Description	Schema
200	OK	[ OrderReportInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/au/report/count

POST

Summary

Get purchase order count for contacts

Description

API to fetch purchase order count for contacts

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/au/report/overview

GET

Summary

Purchase report overview.

Description

API to fetch purchase report overview

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase orders overview report has been prepared.	OrderOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/au/sequence

GET

Summary

Order Document Code

Description

API to get Order Document Code.

Responses

Code	Description	Schema
200	Order Document Code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Order Document Code not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/au/set-recurring

POST

Summary

Set an purchase order to recurring

Description

API to set and purchase order to recurring.

Parameters

Name	Located in	Description	Required	Schema
setRecurringDto	body	setRecurringDto	Yes	SetRecurringDto

Responses

Code	Description
200	purchase order set to recur successfully
201	Created
400	Error while setting purchase order to recur
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/au/short-info/{code}

GET

Summary

Get purchase order Item details by codes

Description

API to fetch purchase order Item details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderAustraliaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/au/tax/count

POST

Summary

Get purchase order count for tax

Description

API to fetch purchase order count for tax

Parameters

Name	Located in	Description	Required	Schema
taxCodes	body	taxCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Tax purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/au/update/linkedDocument

POST

Summary

Update linked documents for PO.

Description

API to pdate linked documents for PO.

Parameters

Name	Located in	Description	Required	Schema
linkedDocumentUpdateRequest	body	linkedDocumentUpdateRequest	Yes	LinkedDocumentUpdateRequest

Responses

Code	Description
200	Linked document has been successfully updated.
201	Created
400	Linked document update failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/au/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderAustraliaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/au/{id}

PUT

Summary

Update purchase order.

Description

API to update existing purchase order.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseOrderRequest	body	purchaseOrderRequest	Yes	PurchaseOrderAustraliaRequest

Responses

Code	Description	Schema
200	Purchase Order has been updated successfully.	PurchaseOrderAustraliaResponse
201	Created
400	Purchase order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase order by id.

Description

API to delete purchase order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

purchase-order-belgium-controller

Purchase Order APIs for Belgium

Orders purchase/be

GET

Summary

Search purchase orders.

Description

API to search purchase orders.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Purchase orders have been fetched successfully.	PurchaseOrderAustraliaResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Purchase order

Description

API to create Purchase order.

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderRequest	body	purchaseOrderRequest	Yes	PurchaseOrderAustraliaRequest

Responses

Code	Description	Schema
200	OK	PurchaseOrderAustraliaResponse
201	Purchase order has been created successfully.	PurchaseOrderAustraliaResponse
400	Purchase order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete multiple purchase orders

Description

API to delete multiple purchase orders

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Purchase order deletion successful	BulkResponse
401	Unauthorized
403	Forbidden
404	No purchase order with provided id's found

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase order billed status

Description

API to update purchase order billed status

Parameters

Name	Located in	Description	Required	Schema
orderCode	query	orderCode	Yes	string
purchaseOrderFields	body	purchaseOrderFields	Yes	object

Responses

Code	Description	Schema
200	Billed status for purchase order updated successfully.	PurchaseOrderAustraliaResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Order with id not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/be/code/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Get purchase order by id.	PurchaseOrderAustraliaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/be/code/{code}/details

GET

Summary

Purchase order details by codes

Description

Purchase order details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseOrderInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/be/create-recurring

POST

Summary

Create a recurring purchase order

Description

API to create a recurring purchase order.

Parameters

Name	Located in	Description	Required	Schema
event	body	event	Yes	RecurringJobEvent

Responses

Code	Description
200	OK
201	Recurring purchase order created successfully
400	Error while creating recurring purchase order
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/be/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/be/demo/{tenantId}

POST

Summary

Create demo orders.

Description

API to create demo orders.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/be/export

GET

Summary

Get purchase orders

Description

Get Purchase orders

Responses

Code	Description	Schema
200	OK	[ OrderReportInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/be/report/count

POST

Summary

Get purchase order count for contacts

Description

API to fetch purchase order count for contacts

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/be/report/overview

GET

Summary

Purchase report overview.

Description

API to fetch purchase report overview

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase orders overview report has been prepared.	OrderOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/be/sequence

GET

Summary

Order Document Code

Description

API to get Order Document Code.

Responses

Code	Description	Schema
200	Order Document Code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Order Document Code not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/be/set-recurring

POST

Summary

Set an purchase order to recurring

Description

API to set and purchase order to recurring.

Parameters

Name	Located in	Description	Required	Schema
setRecurringDto	body	setRecurringDto	Yes	SetRecurringDto

Responses

Code	Description
200	purchase order set to recur successfully
201	Created
400	Error while setting purchase order to recur
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/be/short-info/{code}

GET

Summary

Get purchase order Item details by codes

Description

API to fetch purchase order Item details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderAustraliaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/be/tax/count

POST

Summary

Get purchase order count for tax

Description

API to fetch purchase order count for tax

Parameters

Name	Located in	Description	Required	Schema
taxCodes	body	taxCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Tax purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/be/update/linkedDocument

POST

Summary

Update linked documents for PO.

Description

API to pdate linked documents for PO.

Parameters

Name	Located in	Description	Required	Schema
linkedDocumentUpdateRequest	body	linkedDocumentUpdateRequest	Yes	LinkedDocumentUpdateRequest

Responses

Code	Description
200	Linked document has been successfully updated.
201	Created
400	Linked document update failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/be/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderAustraliaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/be/{id}

PUT

Summary

Update purchase order.

Description

API to update existing purchase order.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseOrderRequest	body	purchaseOrderRequest	Yes	PurchaseOrderAustraliaRequest

Responses

Code	Description	Schema
200	Purchase Order has been updated successfully.	PurchaseOrderAustraliaResponse
201	Created
400	Purchase order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase order by id.

Description

API to delete purchase order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

purchase-order-canada-controller

Purchase Order Canada APIs

Orders purchase/ca

GET

Summary

Search purchase orders.

Description

API to search purchase orders.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Purchase orders have been fetched successfully.	PurchaseOrderCanadaResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Purchase order

Description

API to create Purchase order.

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderRequest	body	purchaseOrderRequest	Yes	PurchaseOrderCanadaRequest

Responses

Code	Description	Schema
200	OK	PurchaseOrderCanadaResponse
201	Purchase order has been created successfully.	PurchaseOrderCanadaResponse
400	Purchase order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete multiple purchase orders

Description

API to delete multiple purchase orders

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Purchase order deletion successful	BulkResponse
401	Unauthorized
403	Forbidden
404	No purchase order with provided id's found

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase order billed status

Description

API to update purchase order billed status

Parameters

Name	Located in	Description	Required	Schema
orderCode	query	orderCode	Yes	string
purchaseOrderFields	body	purchaseOrderFields	Yes	object

Responses

Code	Description	Schema
200	Billed status for purchase order updated successfully.	PurchaseOrderCanadaResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Order with id not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ca/code/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Get purchase order by id.	PurchaseOrderCanadaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ca/code/{code}/details

GET

Summary

Purchase order details by codes

Description

Purchase order details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseOrderInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ca/create-recurring

POST

Summary

Create a recurring purchase order

Description

API to create a recurring purchase order.

Parameters

Name	Located in	Description	Required	Schema
event	body	event	Yes	RecurringJobEvent

Responses

Code	Description
200	OK
201	Recurring purchase order created successfully
400	Error while creating recurring purchase order
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ca/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ca/demo/{tenantId}

POST

Summary

Create demo orders.

Description

API to create demo orders.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ca/export

GET

Summary

Get purchase orders

Description

Get Purchase orders

Responses

Code	Description	Schema
200	OK	[ OrderReportInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ca/report/count

POST

Summary

Get purchase order count for contacts

Description

API to fetch purchase order count for contacts

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ca/report/overview

GET

Summary

Purchase report overview.

Description

API to fetch purchase report overview

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase orders overview report has been prepared.	OrderOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ca/sequence

GET

Summary

Order Document Code

Description

API to get Order Document Code.

Responses

Code	Description	Schema
200	Order Document Code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Order Document Code not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ca/set-recurring

POST

Summary

Set an purchase order to recurring

Description

API to set and purchase order to recurring.

Parameters

Name	Located in	Description	Required	Schema
setRecurringDto	body	setRecurringDto	Yes	SetRecurringDto

Responses

Code	Description
200	purchase order set to recur successfully
201	Created
400	Error while setting purchase order to recur
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ca/short-info/{code}

GET

Summary

Get purchase order Item details by codes

Description

API to fetch purchase order Item details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderCanadaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ca/tax/count

POST

Summary

Get purchase order count for tax

Description

API to fetch purchase order count for tax

Parameters

Name	Located in	Description	Required	Schema
taxCodes	body	taxCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Tax purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ca/update/linkedDocument

POST

Summary

Update linked documents for PO.

Description

API to pdate linked documents for PO.

Parameters

Name	Located in	Description	Required	Schema
linkedDocumentUpdateRequest	body	linkedDocumentUpdateRequest	Yes	LinkedDocumentUpdateRequest

Responses

Code	Description
200	Linked document has been successfully updated.
201	Created
400	Linked document update failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ca/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderCanadaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ca/{id}

PUT

Summary

Update purchase order.

Description

API to update existing purchase order.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseOrderRequest	body	purchaseOrderRequest	Yes	PurchaseOrderCanadaRequest

Responses

Code	Description	Schema
200	Purchase Order has been updated successfully.	PurchaseOrderCanadaResponse
201	Created
400	Purchase order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase order by id.

Description

API to delete purchase order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

purchase-order-germany-controller

Purchase Order Germany APIs

Orders purchase/de

GET

Summary

Search purchase orders.

Description

API to search purchase orders.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Purchase orders have been fetched successfully.	PurchaseOrderDEResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Purchase order

Description

API to create Purchase order.

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderRequest	body	purchaseOrderRequest	Yes	PurchaseOrderDERequest

Responses

Code	Description	Schema
200	OK	PurchaseOrderDEResponse
201	Purchase order has been created successfully.	PurchaseOrderDEResponse
400	Purchase order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete multiple purchase orders

Description

API to delete multiple purchase orders

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Purchase order deletion successful	BulkResponse
401	Unauthorized
403	Forbidden
404	No purchase order with provided id's found

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase order billed status

Description

API to update purchase order billed status

Parameters

Name	Located in	Description	Required	Schema
orderCode	query	orderCode	Yes	string
purchaseOrderFields	body	purchaseOrderFields	Yes	object

Responses

Code	Description	Schema
200	Billed status for purchase order updated successfully.	PurchaseOrderDEResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Order with id not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/de/code/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Get purchase order by id.	PurchaseOrderDEResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/de/code/{code}/details

GET

Summary

Purchase order details by codes

Description

Purchase order details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseOrderInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/de/create-recurring

POST

Summary

Create a recurring purchase order

Description

API to create a recurring purchase order.

Parameters

Name	Located in	Description	Required	Schema
event	body	event	Yes	RecurringJobEvent

Responses

Code	Description
200	OK
201	Recurring purchase order created successfully
400	Error while creating recurring purchase order
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/de/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/de/demo/{tenantId}

POST

Summary

Create demo orders.

Description

API to create demo orders.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/de/export

GET

Summary

Get purchase orders

Description

Get Purchase orders

Responses

Code	Description	Schema
200	OK	[ OrderReportInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/de/report/count

POST

Summary

Get purchase order count for contacts

Description

API to fetch purchase order count for contacts

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/de/report/overview

GET

Summary

Purchase report overview.

Description

API to fetch purchase report overview

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase orders overview report has been prepared.	OrderOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/de/sequence

GET

Summary

Order Document Code

Description

API to get Order Document Code.

Responses

Code	Description	Schema
200	Order Document Code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Order Document Code not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/de/set-recurring

POST

Summary

Set an purchase order to recurring

Description

API to set and purchase order to recurring.

Parameters

Name	Located in	Description	Required	Schema
setRecurringDto	body	setRecurringDto	Yes	SetRecurringDto

Responses

Code	Description
200	purchase order set to recur successfully
201	Created
400	Error while setting purchase order to recur
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/de/short-info/{code}

GET

Summary

Get purchase order Item details by codes

Description

API to fetch purchase order Item details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderDEResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/de/tax/count

POST

Summary

Get purchase order count for tax

Description

API to fetch purchase order count for tax

Parameters

Name	Located in	Description	Required	Schema
taxCodes	body	taxCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Tax purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/de/update/linkedDocument

POST

Summary

Update linked documents for PO.

Description

API to pdate linked documents for PO.

Parameters

Name	Located in	Description	Required	Schema
linkedDocumentUpdateRequest	body	linkedDocumentUpdateRequest	Yes	LinkedDocumentUpdateRequest

Responses

Code	Description
200	Linked document has been successfully updated.
201	Created
400	Linked document update failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/de/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderDEResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/de/{id}

PUT

Summary

Update purchase order.

Description

API to update existing purchase order.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseOrderRequest	body	purchaseOrderRequest	Yes	PurchaseOrderDERequest

Responses

Code	Description	Schema
200	Purchase Order has been updated successfully.	PurchaseOrderDEResponse
201	Created
400	Purchase order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase order by id.

Description

API to delete purchase order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

purchase-order-indonesia-controller

Purchase Order Indonesia APIs

Orders purchase/id

GET

Summary

Search purchase orders.

Description

API to search purchase orders.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Purchase orders have been fetched successfully.	PurchaseOrderIndonesiaResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Purchase order

Description

API to create Purchase order

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderIndonesiaRequest	body	purchaseOrderIndonesiaRequest	Yes	PurchaseOrderIndonesiaRequest

Responses

Code	Description	Schema
200	OK	PurchaseOrderIndonesiaResponse
201	Purchase order has been created successfully.	PurchaseOrderIndonesiaResponse
400	Purchase order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete multiple purchase orders

Description

API to delete multiple purchase orders

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Purchase order deletion successful	BulkResponse
401	Unauthorized
403	Forbidden
404	No purchase order with provided id's found

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase order billed status

Description

API to update purchase order billed status

Parameters

Name	Located in	Description	Required	Schema
orderCode	query	orderCode	Yes	string
purchaseOrderFields	body	purchaseOrderFields	Yes	object

Responses

Code	Description	Schema
200	Billed status for purchase order updated successfully.	PurchaseOrderIndonesiaResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Order with id not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/id/code/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Get purchase order by id.	PurchaseOrderIndonesiaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/id/report/count

POST

Summary

Get purchase order count for contacts

Description

API to fetch purchase order count for contacts

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/id/report/overview

GET

Summary

Purchase report overview.

Description

API to fetch purchase report overview

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase orders overview report has been prepared.	OrderOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/id/sequence

GET

Summary

Order Document Code

Description

API to get Order Document Code.

Responses

Code	Description	Schema
200	Order Document Code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Order Document Code not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/id/short-info/{code}

GET

Summary

Get purchase order Item details by codes

Description

API to fetch purchase order Item details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderIndonesiaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/id/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderIndonesiaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/id/{id}

PUT

Summary

Update purchase order.

Description

API to update existing purchase order.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseOrderIndonesiaRequest	body	purchaseOrderIndonesiaRequest	Yes	PurchaseOrderIndonesiaRequest

Responses

Code	Description	Schema
200	Purchase Order has been updated successfully.	PurchaseOrderIndonesiaResponse
201	Created
400	Purchase order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase order by id.

Description

API to delete purchase order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

purchase-order-israel-controller

Purchase Order Israel APIs

Orders purchase/il

GET

Summary

Search purchase orders.

Description

API to search purchase orders.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Purchase orders have been fetched successfully.	PurchaseOrderIsraelResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Purchase order

Description

API to create Purchase order.

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderIsraelRequest	body	purchaseOrderIsraelRequest	Yes	PurchaseOrderIsraelRequest

Responses

Code	Description	Schema
200	OK	PurchaseOrderIsraelResponse
201	Purchase order has been created successfully.	PurchaseOrderIsraelResponse
400	Purchase order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete multiple purchase orders

Description

API to delete multiple purchase orders

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Purchase order deletion successful	BulkResponse
401	Unauthorized
403	Forbidden
404	No purchase order with provided id's found

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase order billed status

Description

API to update purchase order billed status

Parameters

Name	Located in	Description	Required	Schema
orderCode	query	orderCode	Yes	string
purchaseOrderFields	body	purchaseOrderFields	Yes	object

Responses

Code	Description	Schema
200	Billed status for purchase order updated successfully.	PurchaseOrderIsraelResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Order with id not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/il/code/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Get purchase order by id.	PurchaseOrderIsraelResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/il/report/count

POST

Summary

Get purchase order count for contacts

Description

API to fetch purchase order count for contacts

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/il/report/overview

GET

Summary

Purchase report overview.

Description

API to fetch purchase report overview

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase orders overview report has been prepared.	OrderOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/il/sequence

GET

Summary

Order Document Code

Description

API to get Order Document Code.

Responses

Code	Description	Schema
200	Order Document Code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Order Document Code not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/il/short-info/{code}

GET

Summary

Get purchase order Item details by codes

Description

API to fetch purchase order Item details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderIsraelResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/il/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderIsraelResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/il/{id}

PUT

Summary

Update purchase order.

Description

API to update existing purchase order.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseOrderIsraelRequest	body	purchaseOrderIsraelRequest	Yes	PurchaseOrderIsraelRequest

Responses

Code	Description	Schema
200	Purchase Order has been updated successfully.	PurchaseOrderIsraelResponse
201	Created
400	Purchase order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase order by id.

Description

API to delete purchase order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

purchase-order-india-controller

Purchase Order India APIs

Orders purchase/in

GET

Summary

Search purchase orders.

Description

API to search purchase orders.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
fetchAttachmentDetails	query	fetchAttachmentDetails	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Purchase orders have been fetched successfully.	PurchaseOrderIndiaResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Purchase order

Description

API to create Purchase order.

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderIndiaRequest	body	purchaseOrderIndiaRequest	Yes	PurchaseOrderIndiaRequest

Responses

Code	Description	Schema
200	OK	PurchaseOrderIndiaResponse
201	Purchase order has been created successfully.	PurchaseOrderIndiaResponse
400	Purchase order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete multiple purchase orders

Description

API to delete multiple purchase orders

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Purchase order deletion successful	BulkResponse
401	Unauthorized
403	Forbidden
404	No purchase order with provided id's found

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase order billed status

Description

API to update purchase order billed status

Parameters

Name	Located in	Description	Required	Schema
orderCode	query	orderCode	Yes	string
purchaseOrderFields	body	purchaseOrderFields	Yes	object

Responses

Code	Description	Schema
200	Billed status for purchase order updated successfully.	PurchaseOrderIndiaResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Order with id not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/in/code/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Get purchase order by id.	PurchaseOrderIndiaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/in/import

POST

Summary

Create multiple purchase orders via import

Description

API to create purchase orders via import.

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderRequests	body	purchaseOrderRequests	Yes	[ PurchaseOrderIndiaRequest ]

Responses

Code	Description	Schema
200	OK	BulkApiResponse
201	Sales invoice has been created successfully.	BulkApiResponse
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/in/report/count

POST

Summary

Get purchase order count for contacts

Description

API to fetch purchase order count for contacts

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/in/report/overview

GET

Summary

Purchase report overview.

Description

API to fetch purchase report overview

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase orders overview report has been prepared.	OrderOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/in/sequence

GET

Summary

Order Document Code

Description

API to get Order Document Code.

Responses

Code	Description	Schema
200	Order Document Code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Order Document Code not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/in/short-info/{code}

GET

Summary

Get purchase order Item details by codes

Description

API to fetch purchase order Item details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderIndiaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/in/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderIndiaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/in/{id}

PUT

Summary

Update purchase order.

Description

API to update existing purchase order.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseOrderIndiaRequest	body	purchaseOrderIndiaRequest	Yes	PurchaseOrderIndiaRequest

Responses

Code	Description	Schema
200	Purchase Order has been updated successfully.	PurchaseOrderIndiaResponse
201	Created
400	Purchase order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase order by id.

Description

API to delete purchase order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

purchase-order-malaysia-controller

Purchase Order Malaysia APIs

Orders purchase/my

GET

Summary

Search purchase orders.

Description

API to search purchase orders.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Purchase orders have been fetched successfully.	PurchaseOrderMalaysiaResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Purchase order

Description

API to create Purchase order.

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderMalaysiaRequest	body	purchaseOrderMalaysiaRequest	Yes	PurchaseOrderMalaysiaRequest

Responses

Code	Description	Schema
200	OK	PurchaseOrderMalaysiaResponse
201	Purchase order has been created successfully.	PurchaseOrderMalaysiaResponse
400	Purchase order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete multiple purchase orders

Description

API to delete multiple purchase orders

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Purchase order deletion successful	BulkResponse
401	Unauthorized
403	Forbidden
404	No purchase order with provided id's found

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase order billed status

Description

API to update purchase order billed status

Parameters

Name	Located in	Description	Required	Schema
orderCode	query	orderCode	Yes	string
purchaseOrderFields	body	purchaseOrderFields	Yes	object

Responses

Code	Description	Schema
200	Billed status for purchase order updated successfully.	PurchaseOrderMalaysiaResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Order with id not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/my/code/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Get purchase order by id.	PurchaseOrderMalaysiaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/my/report/count

POST

Summary

Get purchase order count for contacts

Description

API to fetch purchase order count for contacts

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/my/report/overview

GET

Summary

Purchase report overview.

Description

API to fetch purchase report overview

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase orders overview report has been prepared.	OrderOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/my/sequence

GET

Summary

Order Document Code

Description

API to get Order Document Code.

Responses

Code	Description	Schema
200	Order Document Code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Order Document Code not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/my/short-info/{code}

GET

Summary

Get purchase order Item details by codes

Description

API to fetch purchase order Item details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderMalaysiaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/my/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderMalaysiaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/my/{id}

PUT

Summary

Update purchase order.

Description

API to update existing purchase order.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseOrderMalaysiaRequest	body	purchaseOrderMalaysiaRequest	Yes	PurchaseOrderMalaysiaRequest

Responses

Code	Description	Schema
200	Purchase Order has been updated successfully.	PurchaseOrderMalaysiaResponse
201	Created
400	Purchase order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase order by id.

Description

API to delete purchase order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

purchase-order-nl-controller

Purchase Order APIs for Netherland

Orders purchase/nl

GET

Summary

Search purchase orders.

Description

API to search purchase orders.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Purchase orders have been fetched successfully.	PurchaseOrderAustraliaResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Purchase order

Description

API to create Purchase order.

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderRequest	body	purchaseOrderRequest	Yes	PurchaseOrderAustraliaRequest

Responses

Code	Description	Schema
200	OK	PurchaseOrderAustraliaResponse
201	Purchase order has been created successfully.	PurchaseOrderAustraliaResponse
400	Purchase order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete multiple purchase orders

Description

API to delete multiple purchase orders

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Purchase order deletion successful	BulkResponse
401	Unauthorized
403	Forbidden
404	No purchase order with provided id's found

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase order billed status

Description

API to update purchase order billed status

Parameters

Name	Located in	Description	Required	Schema
orderCode	query	orderCode	Yes	string
purchaseOrderFields	body	purchaseOrderFields	Yes	object

Responses

Code	Description	Schema
200	Billed status for purchase order updated successfully.	PurchaseOrderAustraliaResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Order with id not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nl/code/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Get purchase order by id.	PurchaseOrderAustraliaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nl/code/{code}/details

GET

Summary

Purchase order details by codes

Description

Purchase order details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseOrderInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nl/create-recurring

POST

Summary

Create a recurring purchase order

Description

API to create a recurring purchase order.

Parameters

Name	Located in	Description	Required	Schema
event	body	event	Yes	RecurringJobEvent

Responses

Code	Description
200	OK
201	Recurring purchase order created successfully
400	Error while creating recurring purchase order
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nl/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nl/demo/{tenantId}

POST

Summary

Create demo orders.

Description

API to create demo orders.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nl/export

GET

Summary

Get purchase orders

Description

Get Purchase orders

Responses

Code	Description	Schema
200	OK	[ OrderReportInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nl/report/count

POST

Summary

Get purchase order count for contacts

Description

API to fetch purchase order count for contacts

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nl/report/overview

GET

Summary

Purchase report overview.

Description

API to fetch purchase report overview

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase orders overview report has been prepared.	OrderOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nl/sequence

GET

Summary

Order Document Code

Description

API to get Order Document Code.

Responses

Code	Description	Schema
200	Order Document Code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Order Document Code not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nl/set-recurring

POST

Summary

Set an purchase order to recurring

Description

API to set and purchase order to recurring.

Parameters

Name	Located in	Description	Required	Schema
setRecurringDto	body	setRecurringDto	Yes	SetRecurringDto

Responses

Code	Description
200	purchase order set to recur successfully
201	Created
400	Error while setting purchase order to recur
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nl/short-info/{code}

GET

Summary

Get purchase order Item details by codes

Description

API to fetch purchase order Item details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderAustraliaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nl/tax/count

POST

Summary

Get purchase order count for tax

Description

API to fetch purchase order count for tax

Parameters

Name	Located in	Description	Required	Schema
taxCodes	body	taxCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Tax purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nl/update/linkedDocument

POST

Summary

Update linked documents for PO.

Description

API to pdate linked documents for PO.

Parameters

Name	Located in	Description	Required	Schema
linkedDocumentUpdateRequest	body	linkedDocumentUpdateRequest	Yes	LinkedDocumentUpdateRequest

Responses

Code	Description
200	Linked document has been successfully updated.
201	Created
400	Linked document update failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nl/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderAustraliaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nl/{id}

PUT

Summary

Update purchase order.

Description

API to update existing purchase order.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseOrderRequest	body	purchaseOrderRequest	Yes	PurchaseOrderAustraliaRequest

Responses

Code	Description	Schema
200	Purchase Order has been updated successfully.	PurchaseOrderAustraliaResponse
201	Created
400	Purchase order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase order by id.

Description

API to delete purchase order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

purchase-order-nz-controller

Purchase Order APIs for NewZealand

Orders purchase/nz

GET

Summary

Search purchase orders.

Description

API to search purchase orders.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Purchase orders have been fetched successfully.	PurchaseOrderAustraliaResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Purchase order

Description

API to create Purchase order.

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderRequest	body	purchaseOrderRequest	Yes	PurchaseOrderAustraliaRequest

Responses

Code	Description	Schema
200	OK	PurchaseOrderAustraliaResponse
201	Purchase order has been created successfully.	PurchaseOrderAustraliaResponse
400	Purchase order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete multiple purchase orders

Description

API to delete multiple purchase orders

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Purchase order deletion successful	BulkResponse
401	Unauthorized
403	Forbidden
404	No purchase order with provided id's found

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase order billed status

Description

API to update purchase order billed status

Parameters

Name	Located in	Description	Required	Schema
orderCode	query	orderCode	Yes	string
purchaseOrderFields	body	purchaseOrderFields	Yes	object

Responses

Code	Description	Schema
200	Billed status for purchase order updated successfully.	PurchaseOrderAustraliaResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Order with id not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nz/code/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Get purchase order by id.	PurchaseOrderAustraliaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nz/code/{code}/details

GET

Summary

Purchase order details by codes

Description

Purchase order details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseOrderInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nz/create-recurring

POST

Summary

Create a recurring purchase order

Description

API to create a recurring purchase order.

Parameters

Name	Located in	Description	Required	Schema
event	body	event	Yes	RecurringJobEvent

Responses

Code	Description
200	OK
201	Recurring purchase order created successfully
400	Error while creating recurring purchase order
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nz/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nz/demo/{tenantId}

POST

Summary

Create demo orders.

Description

API to create demo orders.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nz/export

GET

Summary

Get purchase orders

Description

Get Purchase orders

Responses

Code	Description	Schema
200	OK	[ OrderReportInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nz/report/count

POST

Summary

Get purchase order count for contacts

Description

API to fetch purchase order count for contacts

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nz/report/overview

GET

Summary

Purchase report overview.

Description

API to fetch purchase report overview

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase orders overview report has been prepared.	OrderOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nz/sequence

GET

Summary

Order Document Code

Description

API to get Order Document Code.

Responses

Code	Description	Schema
200	Order Document Code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Order Document Code not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nz/set-recurring

POST

Summary

Set an purchase order to recurring

Description

API to set and purchase order to recurring.

Parameters

Name	Located in	Description	Required	Schema
setRecurringDto	body	setRecurringDto	Yes	SetRecurringDto

Responses

Code	Description
200	purchase order set to recur successfully
201	Created
400	Error while setting purchase order to recur
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nz/short-info/{code}

GET

Summary

Get purchase order Item details by codes

Description

API to fetch purchase order Item details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderAustraliaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nz/tax/count

POST

Summary

Get purchase order count for tax

Description

API to fetch purchase order count for tax

Parameters

Name	Located in	Description	Required	Schema
taxCodes	body	taxCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Tax purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nz/update/linkedDocument

POST

Summary

Update linked documents for PO.

Description

API to pdate linked documents for PO.

Parameters

Name	Located in	Description	Required	Schema
linkedDocumentUpdateRequest	body	linkedDocumentUpdateRequest	Yes	LinkedDocumentUpdateRequest

Responses

Code	Description
200	Linked document has been successfully updated.
201	Created
400	Linked document update failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nz/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderAustraliaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/nz/{id}

PUT

Summary

Update purchase order.

Description

API to update existing purchase order.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseOrderRequest	body	purchaseOrderRequest	Yes	PurchaseOrderAustraliaRequest

Responses

Code	Description	Schema
200	Purchase Order has been updated successfully.	PurchaseOrderAustraliaResponse
201	Created
400	Purchase order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase order by id.

Description

API to delete purchase order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

purchase-order-philippines-controller

Purchase Order Philippines APIs

Orders purchase/ph

GET

Summary

Search purchase orders.

Description

API to search purchase orders.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Purchase orders have been fetched successfully.	PurchaseOrderPhilippinesResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Purchase order

Description

API to create Purchase order.

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderPhilippinesRequest	body	purchaseOrderPhilippinesRequest	Yes	PurchaseOrderPhilippinesRequest

Responses

Code	Description	Schema
200	OK	PurchaseOrderPhilippinesResponse
201	Purchase order has been created successfully.	PurchaseOrderPhilippinesResponse
400	Purchase order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete multiple purchase orders

Description

API to delete multiple purchase orders

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Purchase order deletion successful	BulkResponse
401	Unauthorized
403	Forbidden
404	No purchase order with provided id's found

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase order billed status

Description

API to update purchase order billed status

Parameters

Name	Located in	Description	Required	Schema
orderCode	query	orderCode	Yes	string
purchaseOrderFields	body	purchaseOrderFields	Yes	object

Responses

Code	Description	Schema
200	Billed status for purchase order updated successfully.	PurchaseOrderPhilippinesResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Order with id not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ph/code/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Get purchase order by id.	PurchaseOrderPhilippinesResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ph/report/count

POST

Summary

Get purchase order count for contacts

Description

API to fetch purchase order count for contacts

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ph/report/overview

GET

Summary

Purchase report overview.

Description

API to fetch purchase report overview

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase orders overview report has been prepared.	OrderOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ph/sequence

GET

Summary

Order Document Code

Description

API to get Order Document Code.

Responses

Code	Description	Schema
200	Order Document Code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Order Document Code not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ph/short-info/{code}

GET

Summary

Get purchase order Item details by codes

Description

API to fetch purchase order Item details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderPhilippinesResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ph/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderPhilippinesResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/ph/{id}

PUT

Summary

Update purchase order.

Description

API to update existing purchase order.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseOrderPhilippinesRequest	body	purchaseOrderPhilippinesRequest	Yes	PurchaseOrderPhilippinesRequest

Responses

Code	Description	Schema
200	Purchase Order has been updated successfully.	PurchaseOrderPhilippinesResponse
201	Created
400	Purchase order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase order by id.

Description

API to delete purchase order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

purchase-order-saudi-arabia-controller

Purchase Order Saudi Arabia APIs

Orders purchase/sa

GET

Summary

Search purchase orders.

Description

API to search purchase orders.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Purchase orders have been fetched successfully.	PurchaseOrderSaudiArabiaResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Purchase order

Description

API to create Purchase order

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderSaudiArabiaRequest	body	purchaseOrderSaudiArabiaRequest	Yes	PurchaseOrderSaudiArabiaRequest

Responses

Code	Description	Schema
200	OK	PurchaseOrderSaudiArabiaResponse
201	Purchase order has been created successfully.	PurchaseOrderSaudiArabiaResponse
400	Purchase order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete multiple purchase orders

Description

API to delete multiple purchase orders

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Purchase order deletion successful	BulkResponse
401	Unauthorized
403	Forbidden
404	No purchase order with provided id's found

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase order billed status

Description

API to update purchase order billed status

Parameters

Name	Located in	Description	Required	Schema
orderCode	query	orderCode	Yes	string
purchaseOrderFields	body	purchaseOrderFields	Yes	object

Responses

Code	Description	Schema
200	Billed status for purchase order updated successfully.	PurchaseOrderSaudiArabiaResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Order with id not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/sa/code/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Get purchase order by id.	PurchaseOrderSaudiArabiaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/sa/report/count

POST

Summary

Get purchase order count for contacts

Description

API to fetch purchase order count for contacts

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/sa/report/overview

GET

Summary

Purchase report overview.

Description

API to fetch purchase report overview

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase orders overview report has been prepared.	OrderOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/sa/sequence

GET

Summary

Order Document Code

Description

API to get Order Document Code.

Responses

Code	Description	Schema
200	Order Document Code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Order Document Code not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/sa/short-info/{code}

GET

Summary

Get purchase order Item details by codes

Description

API to fetch purchase order Item details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderSaudiArabiaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/sa/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderSaudiArabiaResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/sa/{id}

PUT

Summary

Update purchase order.

Description

API to update existing purchase order.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseOrderSaudiArabiaRequest	body	purchaseOrderSaudiArabiaRequest	Yes	PurchaseOrderSaudiArabiaRequest

Responses

Code	Description	Schema
200	Purchase Order has been updated successfully.	PurchaseOrderSaudiArabiaResponse
201	Created
400	Purchase order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase order by id.

Description

API to delete purchase order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

purchase-order-uk-controller

Purchase Order UK APIs

Orders purchase/uk

GET

Summary

Search purchase orders.

Description

API to search purchase orders.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Purchase orders have been fetched successfully.	PurchaseOrderUKResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Purchase order

Description

API to create Purchase order.

Parameters

Name	Located in	Description	Required	Schema
purchaseOrderRequest	body	purchaseOrderRequest	Yes	PurchaseOrderUKRequest

Responses

Code	Description	Schema
200	OK	PurchaseOrderUKResponse
201	Purchase order has been created successfully.	PurchaseOrderUKResponse
400	Purchase order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete multiple purchase orders

Description

API to delete multiple purchase orders

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Purchase order deletion successful	BulkResponse
401	Unauthorized
403	Forbidden
404	No purchase order with provided id's found

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase order billed status

Description

API to update purchase order billed status

Parameters

Name	Located in	Description	Required	Schema
orderCode	query	orderCode	Yes	string
purchaseOrderFields	body	purchaseOrderFields	Yes	object

Responses

Code	Description	Schema
200	Billed status for purchase order updated successfully.	PurchaseOrderUKResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Order with id not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/uk/code/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Get purchase order by id.	PurchaseOrderUKResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/uk/code/{code}/details

GET

Summary

Purchase order details by codes

Description

Purchase order details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseOrderInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/uk/create-recurring

POST

Summary

Create a recurring purchase order

Description

API to create a recurring purchase order.

Parameters

Name	Located in	Description	Required	Schema
event	body	event	Yes	RecurringJobEvent

Responses

Code	Description
200	OK
201	Recurring purchase order created successfully
400	Error while creating recurring purchase order
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/uk/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/uk/demo/{tenantId}

POST

Summary

Create demo orders.

Description

API to create demo orders.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/uk/export

GET

Summary

Get purchase orders

Description

Get Purchase orders

Responses

Code	Description	Schema
200	OK	[ OrderReportInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/uk/report/count

POST

Summary

Get purchase order count for contacts

Description

API to fetch purchase order count for contacts

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/uk/report/overview

GET

Summary

Purchase report overview.

Description

API to fetch purchase report overview

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase orders overview report has been prepared.	OrderOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/uk/sequence

GET

Summary

Order Document Code

Description

API to get Order Document Code.

Responses

Code	Description	Schema
200	Order Document Code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Order Document Code not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/uk/set-recurring

POST

Summary

Set an purchase order to recurring

Description

API to set and purchase order to recurring.

Parameters

Name	Located in	Description	Required	Schema
setRecurringDto	body	setRecurringDto	Yes	SetRecurringDto

Responses

Code	Description
200	purchase order set to recur successfully
201	Created
400	Error while setting purchase order to recur
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/uk/short-info/{code}

GET

Summary

Get purchase order Item details by codes

Description

API to fetch purchase order Item details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderUKResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/uk/tax/count

POST

Summary

Get purchase order count for tax

Description

API to fetch purchase order count for tax

Parameters

Name	Located in	Description	Required	Schema
taxCodes	body	taxCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Tax purchase order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/uk/update/linkedDocument

POST

Summary

Update linked documents for PO.

Description

API to pdate linked documents for PO.

Parameters

Name	Located in	Description	Required	Schema
linkedDocumentUpdateRequest	body	linkedDocumentUpdateRequest	Yes	LinkedDocumentUpdateRequest

Responses

Code	Description
200	Linked document has been successfully updated.
201	Created
400	Linked document update failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchase/uk/{code}

GET

Summary

Get purchase order by id.

Description

API to fetch purchase order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase order information has been fetched successfully.	PurchaseOrderUKResponse
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchase/uk/{id}

PUT

Summary

Update purchase order.

Description

API to update existing purchase order.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseOrderRequest	body	purchaseOrderRequest	Yes	PurchaseOrderUKRequest

Responses

Code	Description	Schema
200	Purchase Order has been updated successfully.	PurchaseOrderUKResponse
201	Created
400	Purchase order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase order by id.

Description

API to delete purchase order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order not found.

Security

Security Schema	Scopes
Authorization	global

purchase-request-controller

Purchase Request APIs

Search purchase requests

GET

Orders purchaserequest

Summary

Search purchase requests

Description

API to search purchase requests.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
fetchAttachmentDetails	query	fetchAttachmentDetails	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Purchase requests have been fetched successfully.	PurchaseRequestResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create purchase request

Description

API to create purchase request.

Parameters

Name	Located in	Description	Required	Schema
purchaseRequestRequest	body	purchaseRequestRequest	Yes	PurchaseRequestRequest

Responses

Code	Description	Schema
200	OK	PurchaseRequestResponse
201	Purchase Request has been created	PurchaseRequestResponse
400	Unable to create purchase request
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchaserequest/draft/trigger

POST

Summary

Create approval status trigger

Description

API to reate approval status trigger

Parameters

Name	Located in	Description	Required	Schema
triggerKafkaRequestDto	body	triggerKafkaRequestDto	Yes	TriggerKafkaRequestDto

Responses

Code	Description
200	Trigger created for approval status
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders purchaserequest/linked-docs/product-codes

POST

Summary

Get products by code

Description

API to Get products by code.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product information has been fetched successfully.	string
201	Created
401	Unauthorized
403	Forbidden
404	Products not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchaserequest/{code}

GET

Summary

Get purchase request by id.

Description

API to fetch purchase request details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase request information has been fetched successfully.	PurchaseRequestResponse
401	Unauthorized
403	Forbidden
404	Purchase request not found.

Security

Security Schema	Scopes
Authorization	global

Orders purchaserequest/{id}

PUT

Summary

Update purchase request

Description

API to update purchase request

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseRequestRequest	body	purchaseRequestRequest	Yes	PurchaseRequestRequest

Responses

Code	Description	Schema
200	Purchase request updated succesfully	PurchaseRequestResponse
201	Created
400	Purchase request draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase request with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete Purchase Request by ID

Description

API to delete purchase request

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase request ahs been deleted
401	Unauthorized
403	Forbidden
404	Purchase request to delete not found

Security

Security Schema	Scopes
Authorization	global

sales-order-controller

Sales Order APIs

Orders sales

GET

Summary

Search sales orders.

Description

API to search sales orders.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Sales orders have been fetched successfully.	SalesOrderResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create sales order

Description

API to create sales order.

Parameters

Name	Located in	Description	Required	Schema
salesOrderRequest	body	salesOrderRequest	Yes	SalesOrderRequest

Responses

Code	Description	Schema
200	OK	SalesOrderResponse
201	Sales order has been created successfully.	SalesOrderResponse
400	Sales order could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete multiple sales orders

Description

API to delete multiple sales orders

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Sales order deletion successful	BulkResponse
401	Unauthorized
403	Forbidden
404	No sales order with provided id's found

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update sales order billed status

Description

API to update sales order billed status

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
salesOrderFields	body	salesOrderFields	Yes	object

Responses

Code	Description	Schema
200	Billed status for sales order updated successfully.	SalesOrderResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Sales Order with id not found.

Security

Security Schema	Scopes
Authorization	global

Orders sales/linked-quotation/{code}

GET

Summary

Get sales orders linked to a quotation by code.

Description

API to fetch sales orders linked to a quotation by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales orders has been fetched successfully.	SalesOrderResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders sales/report

GET

Summary

Dashboard sales report.

Description

API to fetch sales report for dashboard

Responses

Code	Description	Schema
200	Sales orders have been fetched successfully.	SalesOrderDashboardReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders sales/report/count

POST

Summary

Get sales order count for contacts

Description

API to fetch sales order count for contacts

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact sales order count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders sales/report/overview

GET

Summary

Sales report overview.

Description

API to fetch sales report overview

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Sales orders overview report has been prepared.	OrderOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Orders sales/{code}

GET

Summary

Get sales order by id.

Description

API to fetch sales order details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales order information has been fetched successfully.	SalesOrderResponse
401	Unauthorized
403	Forbidden
404	Sales order not found.

Security

Security Schema	Scopes
Authorization	global

Orders sales/{id}

PUT

Summary

Update sales order.

Description

API to update existing sales order.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
salesOrderRequest	body	salesOrderRequest	Yes	SalesOrderRequest

Responses

Code	Description	Schema
200	Sales Order has been updated successfully.	SalesOrderResponse
201	Created
400	Sales order draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Sales Order with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete sales order by id.

Description

API to delete sales order details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Sales order has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Sales order not found.

Security

Security Schema	Scopes
Authorization	global

Models

AbstractJobWorkOutOrderItemDetails

Name	Type	Description	Required
accountCode	string	Account Example: `"AC001"`	No
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
bomMetaCode	string	bom meta code Example: `"00001"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
id	long	ID Example: `2`	No
jobWorkOutOrderItemCode	string	Job Work Out Item Code Example: `"POI-00001"`	No
lineNumber	integer	Line Number Example: `1`	No
otherRate	number	Tax Rate Example: `5`	No
otherTaxAmount	number	Other Tax Amount Example: `10`	No
pendingQuantity	number	Pending quantity Example: `2`	No
product	ProductResponse	Product Details Example: `"product"`	No
productCode	string	Product Example: `"P002"`	No
productDescription	string	Description Example: `"Description"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	No
receivedQuantityInBills	number	Received quantity through bill Example: `2`	No
receivedQuantityInOrder	number	Received quantity through order Example: `2`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Unit price / Amount Example: `2`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

AbstractPurchaseRequestItemDetails

Name	Type	Description	Required
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentSequenceCode	string	Product Document Sequence Code Example: `"P-0000001"`	Yes
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
lineNumber	integer	Line Number Example: `1`	No
linkedPoCode	[ string ]	Linked Purchase Order Code Example: `["O-0000093","0-000098"]`	No
product	ProductInformation	Product Details Example: `"product"`	No
productCode	string	Product code Example: `"P00001"`	Yes
productConvertedQuantity	number	Product converted quantity Example: `2`	Yes
productDescription	string	Product description Example: `"Apple watch"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	Yes
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Product unit price Example: `0.7`	Yes
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

AccountDto

Name	Type	Description	Required
accountCode	string	Account code Example: `"SA"`	No
accountGroup	string	Account group	No
accountGroupId	string	Account group	No
accountNature	string	Account Nature Example: `"ASSET"`	No
accountSubGroup	string	Account group	No
accountSubGroupName	string	Account group	No
balance	number	Balance Amount Example: `999.99`	No
balanceInAccountCurrency	number	Balance Amount in Account Currency Example: `999.99`	No
code	string	Account code	No
currency	string	Account Currency	No
customField	[ CustomFieldItem ]	List of custom fields	No
description	string	Account Description Example: `"Savings account"`	No
exchangeRate	number	Base to Foreign Exchange Rate Example: `1`	No
id	long	Account ID. Example: `1`	No
isCreditCard	boolean	Is account is credit card account or not Example: `false`	No
isSubAccount	boolean	Flag to confirm Subaccount Example: `false`	No
isTdsApplicable	boolean	Is TDS applicable or not Example: `false`	No
isUndepositedFundAccount	boolean	Account is Undeposited fund account or not Example: `true`	No
name	string	Account Name Example: `"Savings account"`	No
natureOfIncomePayment	string	Nature of income payment Example: `"Interest on Securities"`	No
openingBalance	number	Opening Balance Amount in Base currency Example: `999.99`	No
openingBalanceCdType	string	Opening balance Credit/Debit Type Example: `"DEBIT"`	No
openingBalanceEditable	boolean	Account Opening Balance editable or not Example: `true`	No
openingBalanceInAccountCurrency	number	Opening Balance Amount in Account currency Example: `999.99`	No
parent	long	Parent AccountId Example: `2431252`	No
parentName	string	Parent Name Example: `2431252`	No
status	string	Account Status Example: `"ACTIVE"`	No
taxCode	string	Account Tax	No
totalBalance	number	Summation of Opening Balance and Balance Example: `999.99`	No
totalBalanceInAccountCurrency	number	Summation of Opening Balance and Balance in Account Currency Example: `999.99`	No
totalCOABalance	number	Summation of Opening Balance and Balance with Nature Example: `999.99`	No
totalCOABalanceInAccountCurrency	number	Summation of Opening Balance and Balance with Nature in Account Currency Example: `999.99`	No
usedChequeNumbers	string	Used Cheque Series Example: `"301,302"`	No

AdditionalCharges

Name	Type	Required
additionalChargeAmount	number	No
additionalChargeTaxAmount	number	No
additionalChargesDetails	[ AdditionalChargesDetails ]	No
globalDiscount	GlobalDiscountDetails	No
globalDiscounts	[ GlobalDiscountDetails ]	No

AdditionalChargesDetails

Name	Type	Description	Required
additionalCharge	string		No
additionalChargeAccountCode	string		No
addtionalChargeTax	string		No
addtionalChargeTaxCode	string		No
apportionFlag	boolean		No
apportionValue	string	Enum: `"APPORTION_MANUAL"`, `"APPORTION_ON_QTY"`, `"APPORTION_ON_VALUE"`	No
cgst	number		No
chargeAmount	number		No
igst	number		No
isPercent	boolean		No
isPreCharge	boolean		No
percent	number		No
sgst	number		No
taxAmount	number		No

Address

Name	Type	Description	Required
address1	string	Address line 1 Example: `"218, Robinson Road"`	No
address2	string	Address line 2 Example: `"Downtown"`	No
city	string	City Example: `"C001"`	No
contactName	string	contact name for address Example: `"John Smith"`	No
country	string	Country Example: `"C001"`	No
destinationOfSupply	string	state in India Example: `"Maharashtra"`	No
placeOfSupply	string	state in India Example: `"Punjab"`	No
postalCode	string	Postal Code Example: `123456`	No
preferred	boolean	Is this a default address? Example: `true`	No
state	string	State Example: `"CS001"`	No

AdvancedTrackingBOMDto

Name	Type	Description	Required
costPerUnit	number		No
expiryDate	dateTime	Expiry date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch Example: `"01-01-2020"`	No
manufacturingDate	dateTime	Manufacturing date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch Example: `"01-01-2020"`	No
qtyToFulfil	double	Batch qty to fulfill Example: `1`	No
remainingQuantity	number		No
serialBatchNumber	string	Batch or serial number to be fulfilled Example: `"Batch-001"`	No

AdvancedTrackingMetaDto

Name	Type	Description	Required
acquiredCost	number	Acquired cost of the entire serial or batch Example: `1`	No
advancedTrackingReturned	AdvancedTrackingReturned		No
batchSize	double	Serial Number or Batch size Example: `1`	Yes
batchSizeAvailableForReturn	double	How much of the batch or serial is fulfilled Example: `1`	Yes
batchSizeFulfilled	double	How much of the batch or serial is fulfilled Example: `1`	Yes
batchSizeReturned	double	How much of the batch or serial is returned Example: `1`	Yes
batchSizeReturnedPurchase	double	How much of the batch or serial is returned Example: `1`	Yes
binCode	string	bin code Example: `"BIN-00001"`	Yes
binName	string	bin Name Example: `"Bin 1"`	Yes
expiryDate	dateTime	Expiry date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch Example: `"01-01-2020"`	No
id	long		No
manufacturingDate	dateTime	Manufacturing date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch Example: `"01-01-2020"`	No
productVariantCode	string	Product code Example: `"P-001"`	Yes
rackCode	string	Rack code Example: `"RACK-00001"`	Yes
rackName	string	Rack Name Example: `"Rack 1"`	Yes
reservedQuantity	double	Reserved Serial Number or Batch size Example: `1`	No
reservedQuantityFulfilled	double	Fulfilled reserved serial number or batch size Example: `1`	Yes
rowCode	string	Row code Example: `"ROW-00001"`	Yes
rowName	string	Row Name Example: `"Row 1"`	Yes
sequence	long	Sequence number Example: `1`	No
serialBatchNumber	string	Serial Number or Batch Number Example: `"BATCH-001"`	Yes
subSequence	long	Subsequence number Example: `1`	No
warehouseCode	string	Primary Warehouse Example: `"WH-0000001"`	No
warehouseName	string	Primary Warehouse Example: `"warehouse name"`	No

AdvancedTrackingReturned

Name	Type	Required
batchSizeReturned	double	No
batchSizeReturnedPurchase	double	No
returnsByDoc	[ AdvancedTrackingReturnedByDoc ]	No

AdvancedTrackingReturnedByDoc

Name	Type	Description	Required
documentCode	string		No
qtyReturned	double		No
returnType	string	Enum: `"SALES_RETURN"`, `"PURCHASE_RETURN"`	No
transactionRefCode	string		No

AmortizationDocumentItemDetails

Name	Type	Required
deferralAccountCode	string	No
endDate	dateTime	No
startDate	dateTime	No
templateCode	string	No

ApprovalHistoryItem

Name	Type	Description	Required
approvedBy	string		No
approvedDate	string		No
level	integer		No
remarks	string		No
status	string	Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"`	No

ApprovalStatusRequestDto

Name	Type	Description	Required
approvalStatus	string	Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"`	No
documentCodes	string		No

AssetGroupResponse

Name	Type	Description	Required
active	boolean	Is Asset Group active? Example: `true`	No
assetAccountCode	string	Asset Account Code Example: `"AC-0000001"`	No
assetAccountDisplayCode	string	Asset Account Display Code Example: `"Acc00001"`	No
assetAccountName	string	Asset Account Name Example: `"Computer Equipment Asset Account"`	No
assetAccumulatedAccountCode	string	Asset Accumulated Account Code Example: `"AC-0000002"`	No
assetAccumulatedAccountDisplayCode	string	Asset Accumulated Account Display Code Example: `"Acc00002"`	No
assetAccumulatedAccountName	string	Asset Accumulated Account Name Example: `"Computer Equipment Accumulated Account"`	No
decliningFactor	number	Declining Factor Example: `1`	No
depreciationConvention	string	Depreciation Convention Enum: `"FULL_MONTH"`, `"ACTUAL_DATE"` Example: `"FULL_MONTH"`	No
depreciationExpenseAccountCode	string	Depreciation Expense Account Code Example: `"AC-0000003"`	No
depreciationExpenseAccountDisplayCode	string	Depreciation Expense Account Display Code Example: `"Acc00003"`	No
depreciationExpenseAccountName	string	Depreciation Expense Account Name Example: `"Computer Equipment Depreciation Account"`	No
depreciationMethod	string	Depreciation Method Enum: `"NO_DEPRECIATION"`, `"STRAIGHT_LINE"`, `"DECLINING_BALANCE"`, `"INSTANT_ASSET_WRITE_OFF"` Example: `"STRAIGHT_LINE"`	No
depreciationRate	number	Depreciation Rate Example: `1`	No
effectiveLife	number	Effective Life Example: `2`	No
hsnOrSacCode	string	HSN or SAC Code Example: `"011"`	No
id	long	Id Example: `1`	No
name	string	Asset Group Name Example: `"IT Hardware"`	No
purchaseTaxCode	string	GST Tax Code Example: `"TX-0000003"`	No
uqcIndia	string	UQC Example: `"BAGS"`	No
viewOnly	boolean	Is Asset Group view-only? Example: `true`	No
writeOffAccountCode	string	Write off Account Code Example: `"AC-0000002"`	No

AssetRequest

Name	Type	Description	Required
assetGroupId	long	Asset Group Id Example: `1`	No
currency	string	Currency Example: `"USD"`	No
decliningFactor	number	Declining Factor Example: `2.5`	No
depreciationConvention	string	Depreciation Convention Enum: `"FULL_MONTH"`, `"ACTUAL_DATE"` Example: `"FULL_MONTH"`	No
depreciationMethod	string	Depreciation Method Enum: `"NO_DEPRECIATION"`, `"STRAIGHT_LINE"`, `"DECLINING_BALANCE"`, `"INSTANT_ASSET_WRITE_OFF"` Example: `"STRAIGHT_LINE"`	No
depreciationRate	number	Depreciation Rate Example: `66.66`	No
depreciationStartDate	dateTime	Depreciation Start Date Example: `"20-06-2019"`	No
depreciationThreshold	number	Depreciation Threshold Example: `8765.43`	No
description	string	Asset Description Example: `"Computer for developers"`	No
discount	number		No
discountInPercent	boolean		No
documentCode	string		No
documentItemCode	string		No
documentSequenceCode	string	Document Sequence Code Example: `"FA-0000001"`	No
documentType	string		No
effectiveLife	number	Effective Life Example: `1.5`	No
errors	[ string ]		No
expenseBillCode	string	Expense Bill Code Example: `"BUY-0000001"`	No
id	long	Id Example: `1`	No
installationDate	dateTime	Installation Date Example: `"20-06-2019"`	No
name	string	Asset Name Example: `"Computer"`	No
openingAccumulatedDepreciation	number	Opening Accumulated Depreciation Example: `1234.56`	No
openingAsset	boolean	Is this an Opening Asset Example: `false`	No
profitLossAccountCode	string	Profit/Loss Account Code Example: `"AC-0000001"`	No
purchaseDate	dateTime	Purchase Date Example: `"20-06-2019"`	No
purchaseInvoiceId	long		No
purchaseInvoiceRequest	PurchaseInvoiceRequest		No
purchasePrice	number	Purchase Price Example: `9999.99`	No
residualValue	number	Residual Value Example: `1234.56`	No
salesIncomeAccountCode	string	Sales/Income Account Code Example: `"AC-0000001"`	No
sequenceFormat	string	Document Sequence Format Example: `"FA-0000000"`	No
serialNumber	string	Serial Number Example: `"ABCD123456"`	No
taxAmount	number		No
taxCode	string		No
totalAmount	number		No
warehouse	string	Warehouse Code Example: `"WH-0000001"`	No
warrantyEndDate	string	Warranty End Date Example: `"01-11-2024"`	No
warrantyStartDate	string	Warranty Start Date Example: `"01-11-2023"`	No

AttachmentsResponse

Name	Type	Required
attachmentDate	dateTime	No
attachmentFileName	string	No
attachmentId	long	No
attachmentSize	string	No

AttributeDetails

Name	Type	Description	Required
id	long	Attribute ID Example: `"Id"`	No
name	string	Attribute Name Example: `"Colour"`	No
values	[ string ]	Attribute values	No

BarcodeDetails

Name	Type	Description	Required
barcodeField	string		No
hideBarcodeLabel	boolean		No

BomAdditionalCostDto

Name	Type	Description	Required
bomMetaDetailsId	long	id of bomMetaDetailsId Example: `1234`	No
bomMetaName	string	BOM Meta Name Example: `"DEFAULT"`	No
label	string	Name of manufacturing service Example: `"Labour charges"`	No
price	number	Quantity of product in bom Example: `10.5`	No

BomMetaDetailsDto

Name	Type	Description	Required
active	boolean	bom meta details status Example: `true`	No
bomAddCostConfiguration	[ BomAdditionalCostDto ]	Bom additional cost information	No
bomOperationsConfiguration	[ BomOperationDto ]	Bom Operations information	No
bomProductCostDetails	[ BomProductCostDetails ]	JSON object for custom fields Example: `{"field1":"value1","field2":"value2"}`	No
bomProductsConfiguration	[ BomMetaDto ]	Bom Products information	No
code	string	bom meta details code Example: `"code"`	No
deleted	boolean	bom meta details delete status Example: `true`	No
id	long	id of bom meta details Example: `1234`	No
isDefault	boolean	bom default Example: `true`	No
name	string	bom meta details name Example: `"bom meta name"`	No
productId	string	id of bom product Example: `1234`	No

BomMetaDto

Name	Type	Description	Required
bomMetaDetailsId	long	id of bomMetaDetailsId Example: `1234`	No
bomMetaName	string	BOM Meta Name Example: `"DEFAULT"`	No
bomProductSubstitutesDetails	[ ProductSubstitutesDetails ]		No
cost	number	Cost of product in bom Example: `10.5`	No
itemId	long	id of item in bom Example: `1234`	No
itemName	string	Product Name Example: `"Apple"`	Yes
produceProductType	string	Produce Product type Enum: `"NONE"`, `"SCRAP"`, `"COPRODUCT"` Example: `"SCRAP"`	Yes
productCode	string		No
quantity	number	Quantity of product in bom Example: `10.5`	No
stockUom	long		No

BomOperationDto

Name	Type	Description	Required
bomMetaDetailsId	long	id of bomMetaDetailsId Example: `1234`	No
bomMetaName	string	BOM Meta Name Example: `"DEFAULT"`	No
costPerHour	number	Cost of operation in bom Example: `10.5`	No
fixedRate	number	Cost of operation in bom Example: `10.5`	No
operationId	long	id of operation in bom Example: `1234`	No
operationName	string	Operation Name Example: `"Apple"`	Yes
totalCost	number	Cost of operation in bom Example: `10.5`	No

BomProductCostDetails

Name	Type	Description	Required
operationCost	number	Operation Cost Example: `15`	No
rawMaterialCost	number	Raw material cost Example: `20`	No
totalCost	number	Total cost Example: `35`	No

BulkApiResponse

Name	Type	Required
failure	[ object ]	No
statusCode	integer	No
success	[ object ]	No

BulkApiResponse«PurchaseOrderIndiaResponse»

Name	Type	Required
failure	[ PurchaseOrderIndiaResponse ]	No
statusCode	integer	No
success	[ PurchaseOrderIndiaResponse ]	No

BulkApiResponse«PurchaseOrderResponse»

Name	Type	Required
failure	[ PurchaseOrderResponse ]	No
statusCode	integer	No
success	[ PurchaseOrderResponse ]	No

BulkDeleteOrderResponse

Name	Type	Description	Required
documentSequenceCode	string	Document Sequence Code Example: `"PO-0000011"`	No
httpStatus	string	HTTP Status Enum: `"100 CONTINUE"`, `"101 SWITCHING_PROTOCOLS"`, `"102 PROCESSING"`, `"103 CHECKPOINT"`, `"200 OK"`, `"201 CREATED"`, `"202 ACCEPTED"`, `"203 NON_AUTHORITATIVE_INFORMATION"`, `"204 NO_CONTENT"`, `"205 RESET_CONTENT"`, `"206 PARTIAL_CONTENT"`, `"207 MULTI_STATUS"`, `"208 ALREADY_REPORTED"`, `"226 IM_USED"`, `"300 MULTIPLE_CHOICES"`, `"301 MOVED_PERMANENTLY"`, `"302 FOUND"`, `"302 MOVED_TEMPORARILY"`, `"303 SEE_OTHER"`, `"304 NOT_MODIFIED"`, `"305 USE_PROXY"`, `"307 TEMPORARY_REDIRECT"`, `"308 PERMANENT_REDIRECT"`, `"400 BAD_REQUEST"`, `"401 UNAUTHORIZED"`, `"402 PAYMENT_REQUIRED"`, `"403 FORBIDDEN"`, `"404 NOT_FOUND"`, `"405 METHOD_NOT_ALLOWED"`, `"406 NOT_ACCEPTABLE"`, `"407 PROXY_AUTHENTICATION_REQUIRED"`, `"408 REQUEST_TIMEOUT"`, `"409 CONFLICT"`, `"410 GONE"`, `"411 LENGTH_REQUIRED"`, `"412 PRECONDITION_FAILED"`, `"413 PAYLOAD_TOO_LARGE"`, `"413 REQUEST_ENTITY_TOO_LARGE"`, `"414 URI_TOO_LONG"`, `"414 REQUEST_URI_TOO_LONG"`, `"415 UNSUPPORTED_MEDIA_TYPE"`, `"416 REQUESTED_RANGE_NOT_SATISFIABLE"`, `"417 EXPECTATION_FAILED"`, `"418 I_AM_A_TEAPOT"`, `"419 INSUFFICIENT_SPACE_ON_RESOURCE"`, `"420 METHOD_FAILURE"`, `"421 DESTINATION_LOCKED"`, `"422 UNPROCESSABLE_ENTITY"`, `"423 LOCKED"`, `"424 FAILED_DEPENDENCY"`, `"426 UPGRADE_REQUIRED"`, `"428 PRECONDITION_REQUIRED"`, `"429 TOO_MANY_REQUESTS"`, `"431 REQUEST_HEADER_FIELDS_TOO_LARGE"`, `"451 UNAVAILABLE_FOR_LEGAL_REASONS"`, `"500 INTERNAL_SERVER_ERROR"`, `"501 NOT_IMPLEMENTED"`, `"502 BAD_GATEWAY"`, `"503 SERVICE_UNAVAILABLE"`, `"504 GATEWAY_TIMEOUT"`, `"505 HTTP_VERSION_NOT_SUPPORTED"`, `"506 VARIANT_ALSO_NEGOTIATES"`, `"507 INSUFFICIENT_STORAGE"`, `"508 LOOP_DETECTED"`, `"509 BANDWIDTH_LIMIT_EXCEEDED"`, `"510 NOT_EXTENDED"`, `"511 NETWORK_AUTHENTICATION_REQUIRED"` Example: `"404 NOT_FOUND"`	No
reason	string	Example: `"NOT FOUND"`	No

BulkResponse

Name	Type	Description	Required
httpStatus	string	HTTP Status Enum: `"100 CONTINUE"`, `"101 SWITCHING_PROTOCOLS"`, `"102 PROCESSING"`, `"103 CHECKPOINT"`, `"200 OK"`, `"201 CREATED"`, `"202 ACCEPTED"`, `"203 NON_AUTHORITATIVE_INFORMATION"`, `"204 NO_CONTENT"`, `"205 RESET_CONTENT"`, `"206 PARTIAL_CONTENT"`, `"207 MULTI_STATUS"`, `"208 ALREADY_REPORTED"`, `"226 IM_USED"`, `"300 MULTIPLE_CHOICES"`, `"301 MOVED_PERMANENTLY"`, `"302 FOUND"`, `"302 MOVED_TEMPORARILY"`, `"303 SEE_OTHER"`, `"304 NOT_MODIFIED"`, `"305 USE_PROXY"`, `"307 TEMPORARY_REDIRECT"`, `"308 PERMANENT_REDIRECT"`, `"400 BAD_REQUEST"`, `"401 UNAUTHORIZED"`, `"402 PAYMENT_REQUIRED"`, `"403 FORBIDDEN"`, `"404 NOT_FOUND"`, `"405 METHOD_NOT_ALLOWED"`, `"406 NOT_ACCEPTABLE"`, `"407 PROXY_AUTHENTICATION_REQUIRED"`, `"408 REQUEST_TIMEOUT"`, `"409 CONFLICT"`, `"410 GONE"`, `"411 LENGTH_REQUIRED"`, `"412 PRECONDITION_FAILED"`, `"413 PAYLOAD_TOO_LARGE"`, `"413 REQUEST_ENTITY_TOO_LARGE"`, `"414 URI_TOO_LONG"`, `"414 REQUEST_URI_TOO_LONG"`, `"415 UNSUPPORTED_MEDIA_TYPE"`, `"416 REQUESTED_RANGE_NOT_SATISFIABLE"`, `"417 EXPECTATION_FAILED"`, `"418 I_AM_A_TEAPOT"`, `"419 INSUFFICIENT_SPACE_ON_RESOURCE"`, `"420 METHOD_FAILURE"`, `"421 DESTINATION_LOCKED"`, `"422 UNPROCESSABLE_ENTITY"`, `"423 LOCKED"`, `"424 FAILED_DEPENDENCY"`, `"426 UPGRADE_REQUIRED"`, `"428 PRECONDITION_REQUIRED"`, `"429 TOO_MANY_REQUESTS"`, `"431 REQUEST_HEADER_FIELDS_TOO_LARGE"`, `"451 UNAVAILABLE_FOR_LEGAL_REASONS"`, `"500 INTERNAL_SERVER_ERROR"`, `"501 NOT_IMPLEMENTED"`, `"502 BAD_GATEWAY"`, `"503 SERVICE_UNAVAILABLE"`, `"504 GATEWAY_TIMEOUT"`, `"505 HTTP_VERSION_NOT_SUPPORTED"`, `"506 VARIANT_ALSO_NEGOTIATES"`, `"507 INSUFFICIENT_STORAGE"`, `"508 LOOP_DETECTED"`, `"509 BANDWIDTH_LIMIT_EXCEEDED"`, `"510 NOT_EXTENDED"`, `"511 NETWORK_AUTHENTICATION_REQUIRED"` Example: `"404 NOT_FOUND"`	No
id	long	ID Example: `2`	No

BulkUpdateOrderResponse

Name	Type	Description	Required
httpStatus	string	HTTP Status Enum: `"100 CONTINUE"`, `"101 SWITCHING_PROTOCOLS"`, `"102 PROCESSING"`, `"103 CHECKPOINT"`, `"200 OK"`, `"201 CREATED"`, `"202 ACCEPTED"`, `"203 NON_AUTHORITATIVE_INFORMATION"`, `"204 NO_CONTENT"`, `"205 RESET_CONTENT"`, `"206 PARTIAL_CONTENT"`, `"207 MULTI_STATUS"`, `"208 ALREADY_REPORTED"`, `"226 IM_USED"`, `"300 MULTIPLE_CHOICES"`, `"301 MOVED_PERMANENTLY"`, `"302 FOUND"`, `"302 MOVED_TEMPORARILY"`, `"303 SEE_OTHER"`, `"304 NOT_MODIFIED"`, `"305 USE_PROXY"`, `"307 TEMPORARY_REDIRECT"`, `"308 PERMANENT_REDIRECT"`, `"400 BAD_REQUEST"`, `"401 UNAUTHORIZED"`, `"402 PAYMENT_REQUIRED"`, `"403 FORBIDDEN"`, `"404 NOT_FOUND"`, `"405 METHOD_NOT_ALLOWED"`, `"406 NOT_ACCEPTABLE"`, `"407 PROXY_AUTHENTICATION_REQUIRED"`, `"408 REQUEST_TIMEOUT"`, `"409 CONFLICT"`, `"410 GONE"`, `"411 LENGTH_REQUIRED"`, `"412 PRECONDITION_FAILED"`, `"413 PAYLOAD_TOO_LARGE"`, `"413 REQUEST_ENTITY_TOO_LARGE"`, `"414 URI_TOO_LONG"`, `"414 REQUEST_URI_TOO_LONG"`, `"415 UNSUPPORTED_MEDIA_TYPE"`, `"416 REQUESTED_RANGE_NOT_SATISFIABLE"`, `"417 EXPECTATION_FAILED"`, `"418 I_AM_A_TEAPOT"`, `"419 INSUFFICIENT_SPACE_ON_RESOURCE"`, `"420 METHOD_FAILURE"`, `"421 DESTINATION_LOCKED"`, `"422 UNPROCESSABLE_ENTITY"`, `"423 LOCKED"`, `"424 FAILED_DEPENDENCY"`, `"426 UPGRADE_REQUIRED"`, `"428 PRECONDITION_REQUIRED"`, `"429 TOO_MANY_REQUESTS"`, `"431 REQUEST_HEADER_FIELDS_TOO_LARGE"`, `"451 UNAVAILABLE_FOR_LEGAL_REASONS"`, `"500 INTERNAL_SERVER_ERROR"`, `"501 NOT_IMPLEMENTED"`, `"502 BAD_GATEWAY"`, `"503 SERVICE_UNAVAILABLE"`, `"504 GATEWAY_TIMEOUT"`, `"505 HTTP_VERSION_NOT_SUPPORTED"`, `"506 VARIANT_ALSO_NEGOTIATES"`, `"507 INSUFFICIENT_STORAGE"`, `"508 LOOP_DETECTED"`, `"509 BANDWIDTH_LIMIT_EXCEEDED"`, `"510 NOT_EXTENDED"`, `"511 NETWORK_AUTHENTICATION_REQUIRED"` Example: `"404 NOT_FOUND"`	No
id	long	ID Example: `2`	No
reason	string	Example: `"NOT FOUND"`	No

ContactDto

Name	Type	Description	Required
attentionTo	string	the contact name in govt agency Example: `"Peter Parker"`	No
billingAddress	[ Address ]	List of Billing Address.	No
businessUnit	string	indicates the contact is govt agency Example: `"CAA01 - Cvl Avtn Authrty of Singapore"`	No
contactMasterId	string (uuid)	contact master id Example: `"2df7a5c1-3305-498d-8d01-aa92c42d19d2"`	No
contactNumber	string	Contact number Example: `"+65999999999"`	No
creditLimit	number	Credit Limit Example: `100`	No
creditLimitInBaseCurrency	number	Credit Limit In Org Currency Example: `100`	No
currencyCode	string	Currency code Enum: `"AFN"`, `"ALL"`, `"DZD"`, `"AOA"`, `"ARS"`, `"AMD"`, `"AWG"`, `"AZN"`, `"BSD"`, `"BHD"`, `"BDT"`, `"BBD"`, `"BYN"`, `"BZD"`, `"BMD"`, `"BTN"`, `"BOB"`, `"BAM"`, `"BRL"`, `"BND"`, `"BGN"`, `"BIF"`, `"KHR"`, `"CAD"`, `"CVE"`, `"KYD"`, `"CLP"`, `"CNY"`, `"COP"`, `"KMF"`, `"CDF"`, `"CRC"`, `"CZK"`, `"HRK"`, `"CUC"`, `"DJF"`, `"DOP"`, `"EGP"`, `"ERN"`, `"ETB"`, `"FKP"`, `"FJD"`, `"XAF"`, `"GMD"`, `"GEL"`, `"GHS"`, `"GIP"`, `"DKK"`, `"GTQ"`, `"GNF"`, `"GYD"`, `"HTG"`, `"HNL"`, `"HKD"`, `"HUF"`, `"ISK"`, `"INR"`, `"IDR"`, `"IRR"`, `"IQD"`, `"JMD"`, `"JPY"`, `"JOD"`, `"KZT"`, `"KES"`, `"KWD"`, `"KGS"`, `"LAK"`, `"LBP"`, `"LSL"`, `"LRD"`, `"LYD"`, `"MOP"`, `"MKD"`, `"MGA"`, `"MWK"`, `"MYR"`, `"MVR"`, `"MRO"`, `"MUR"`, `"MXN"`, `"MDL"`, `"MNT"`, `"MZN"`, `"MMK"`, `"NAD"`, `"NPR"`, `"NIO"`, `"NGN"`, `"KPW"`, `"OMR"`, `"PKR"`, `"ILS"`, `"PAB"`, `"PGK"`, `"PYG"`, `"PEN"`, `"PHP"`, `"PLN"`, `"QAR"`, `"RON"`, `"RUB"`, `"RWF"`, `"SHP"`, `"XCD"`, `"WST"`, `"STD"`, `"SAR"`, `"RSD"`, `"SCR"`, `"SLL"`, `"SGD"`, `"ANG"`, `"SBD"`, `"SOS"`, `"ZAR"`, `"KRW"`, `"SSP"`, `"EUR"`, `"LKR"`, `"SDG"`, `"SRD"`, `"NOK"`, `"SZL"`, `"SEK"`, `"CHF"`, `"SYP"`, `"TWD"`, `"TJS"`, `"TZS"`, `"THB"`, `"XOF"`, `"NZD"`, `"TOP"`, `"TTD"`, `"TND"`, `"TRY"`, `"TMT"`, `"AUD"`, `"UGX"`, `"UAH"`, `"AED"`, `"GBP"`, `"USD"`, `"UYU"`, `"UZS"`, `"VUV"`, `"VEF"`, `"VND"`, `"XPF"`, `"MAD"`, `"YER"`, `"ZMW"`, `"BWP"`, `"CNH"` Example: `"SGD"`	No
customField	[ CustomFieldItem ]	JSON object for custom fields Example: `{"field1":"value1","field2":"value2"}`	No
documentSequenceCode	string	Contact Sequence code Example: `"C-0000001"`	No
emailId	string	contact email address Example: `"myinfo@domain.com"`	No
extCompanyName	string	the company name from external app Example: `"QuickBook"`	No
intercompanyType	string	Contact Type either parent or subsidiary Enum: `"PARENT"`, `"SUBSIDIARY"` Example: `"PARENT/SUBSIDIARY"`	No
invoiceCreditLimitType	string	Invoice Credit Limit Type Enum: `"IGNORE"`, `"WARN"`, `"BLOCK"` Example: `"IGNORE"`	No
invoices	object		No
isAccountNumberFlag	boolean	indicates if user is sending account number or code Example: `true`	No
isCreditLimitApplicable	boolean	Contact credit limit applicable Example: `true`	No
isIncludeCurrentInvoice	boolean	Include Current Invoice Example: `true`	No
isIncludeCurrentQuotation	boolean	Include Current Quotation Example: `true`	No
isIncludeCurrentSalesOrder	boolean	Include Current Sales Order Example: `false`	No
isParentCompany	boolean	Is Parent company Example: `false`	No
isSubsidiaryCompany	boolean	Is Subsidiary company Example: `false`	No
name	string	Contact name Example: `"Sam"`	No
payableAccountCode	string	Payable account code Example: `"AC002"`	No
paymentTermCode	string	Payment term code Example: `"Net 0"`	No
peppolId	string	Peppol ID Example: `"u000:11::11293"`	No
purchasePriceLists	[ long ]	Set of Purchase price lists Example: `[123,456]`	No
quotationCreditLimitType	string	Quotation Credit Limit Type Enum: `"IGNORE"`, `"WARN"`, `"BLOCK"` Example: `"IGNORE"`	No
receivableAccountCode	string	Receivable account code Example: `"AC001"`	No
salesOrderCreditLimitType	string	Sales Order Credit Limit Type Enum: `"IGNORE"`, `"WARN"`, `"BLOCK"` Example: `"IGNORE"`	No
salesPriceLists	[ long ]	Set of Sales price lists Example: `[123,456]`	No
sequenceFormat	string	Sequence Format Example: `1`	No
shippingAddress	[ Address ]	List of Shipping Address.	No
singaporeGovt	boolean	indicates the contact is govt agency Example: `true`	No
taxExempted	boolean	Denotes if customer is tax exempted Example: `true`	No
taxExemptionNo	string	Generated tax exemption number Example: `"234s-few3-2422"`	No
taxExemptionReason	string	Tax exemption reason Example: `"Resale, Federal Agency"`	No
taxNumber	string	Tax number Example: `123456`	No
uen	string	Contact UEN Example: `"DHJEUK"`	No

ContactIndiaTdsInfo

Name	Type	Description	Required
considerThresholdLimit	boolean	Consider Exemption Limit can be a check box field Example: `true`	No
deducteeCode	string	Deductee Type Example: `"Artificial Juridicial Person"`	No
deducteeType	string	Deductee Type Example: `"Artificial Juridicial Person"`	No
deductionApplicable	boolean	This field can be visible only if PAN number is mentioned. Example: `true`	No
dttaApplicable	boolean		No
dttaFromDate	dateTime		No
dttaToDate	dateTime		No
higherRate	integer	Percentage value and can be visible only if PAN number is not mentioned. Example: `5`	No
noDeductionFromDate	dateTime	Start date field visible only if deductionApplicable field is true Example: `"01-01-2020"`	No
noDeductionReason	string	Choose reason only if deductionApplicable field is true. Example: `"TDS not to be made till the Basic Exemption is reached"`	No
noDeductionRefNo	string	Alphanumeric field and visible only if deductionApplicable field is true. Example: `"AAAAABBBB1100"`	No
noDeductionTdsRate	integer	Special rate override with TDS Rate setting and will be visible only if deductionApplicable field is true Example: `5`	No
noDeductionToDate	dateTime	End date field visible only if deductionApplicable field is true Example: `"31-12-2020"`	No
nonDeductionApplicable	boolean	This field can be visible only if PAN number is mentioned. Example: `true`	No
specialRate	integer		No
tan	string	Contact TAN Example: `"AAAA99999A"`	No

ContactInfo

Name	Type	Description	Required
address	string	Address Example: `"Raffles Place 1"`	Yes
name	string	Contact name Example: `"ABC Pte Ltd"`	Yes

ContactInformation

Name	Type	Description	Required
beVatIdentificationNo	string	VAT Identification No Example: `123456789012345`	No
billingAddress	[ Address ]	List of Billing Address.	No
birClassPhilippines	string	BIR class determines the type of business Example: `"Services"`	No
businessRegNo	string	Contact Business Registration No Example: `"W10-0108-000000021"`	No
contactMasterId	string (uuid)	contact master id Example: `"2df7a5c1-3305-498d-8d01-aa92c42d19d2"`	No
contactNumber	string	Contact number Example: `"+65999999999"`	No
creditLimit	number	Credit Limit Example: `100`	No
creditLimitInBaseCurrency	number	Credit Limit In Org Currency Example: `100`	No
currencyCode	string	Currency code Enum: `"AFN"`, `"ALL"`, `"DZD"`, `"AOA"`, `"ARS"`, `"AMD"`, `"AWG"`, `"AZN"`, `"BSD"`, `"BHD"`, `"BDT"`, `"BBD"`, `"BYN"`, `"BZD"`, `"BMD"`, `"BTN"`, `"BOB"`, `"BAM"`, `"BRL"`, `"BND"`, `"BGN"`, `"BIF"`, `"KHR"`, `"CAD"`, `"CVE"`, `"KYD"`, `"CLP"`, `"CNY"`, `"COP"`, `"KMF"`, `"CDF"`, `"CRC"`, `"CZK"`, `"HRK"`, `"CUC"`, `"DJF"`, `"DOP"`, `"EGP"`, `"ERN"`, `"ETB"`, `"FKP"`, `"FJD"`, `"XAF"`, `"GMD"`, `"GEL"`, `"GHS"`, `"GIP"`, `"DKK"`, `"GTQ"`, `"GNF"`, `"GYD"`, `"HTG"`, `"HNL"`, `"HKD"`, `"HUF"`, `"ISK"`, `"INR"`, `"IDR"`, `"IRR"`, `"IQD"`, `"JMD"`, `"JPY"`, `"JOD"`, `"KZT"`, `"KES"`, `"KWD"`, `"KGS"`, `"LAK"`, `"LBP"`, `"LSL"`, `"LRD"`, `"LYD"`, `"MOP"`, `"MKD"`, `"MGA"`, `"MWK"`, `"MYR"`, `"MVR"`, `"MRO"`, `"MUR"`, `"MXN"`, `"MDL"`, `"MNT"`, `"MZN"`, `"MMK"`, `"NAD"`, `"NPR"`, `"NIO"`, `"NGN"`, `"KPW"`, `"OMR"`, `"PKR"`, `"ILS"`, `"PAB"`, `"PGK"`, `"PYG"`, `"PEN"`, `"PHP"`, `"PLN"`, `"QAR"`, `"RON"`, `"RUB"`, `"RWF"`, `"SHP"`, `"XCD"`, `"WST"`, `"STD"`, `"SAR"`, `"RSD"`, `"SCR"`, `"SLL"`, `"SGD"`, `"ANG"`, `"SBD"`, `"SOS"`, `"ZAR"`, `"KRW"`, `"SSP"`, `"EUR"`, `"LKR"`, `"SDG"`, `"SRD"`, `"NOK"`, `"SZL"`, `"SEK"`, `"CHF"`, `"SYP"`, `"TWD"`, `"TJS"`, `"TZS"`, `"THB"`, `"XOF"`, `"NZD"`, `"TOP"`, `"TTD"`, `"TND"`, `"TRY"`, `"TMT"`, `"AUD"`, `"UGX"`, `"UAH"`, `"AED"`, `"GBP"`, `"USD"`, `"UYU"`, `"UZS"`, `"VUV"`, `"VEF"`, `"VND"`, `"XPF"`, `"MAD"`, `"YER"`, `"ZMW"`, `"BWP"`, `"CNH"` Example: `"SGD"`	No
customField	[ CustomFieldItem ]	JSON object for custom fields Example: `{"field1":"value1","field2":"value2"}`	No
customerType	string	Customer Type Enum: `"EXPORT_WO_PAY"`, `"EXPORT_W_PAY"`, `"NA"`, `"SEZ_WO_PAY"`, `"SEZ_W_PAY"` Example: `"NA"`	No
customerTypeMalaysia	string	Customer Type Enum: `"NONE"`, `"EXPORT"`, `"SPECIAL_AREA"`, `"DESIGNATED_AREA"`, `"EXEMPTED_UNDER_SCHEDULE_A"`, `"EXEMPTED_UNDER_SCHEDULE_B"`, `"EXEMPTED_UNDER_SCHEDULE_C1_C2"`, `"EXEMPTED_UNDER_SCHEDULE_C3_C4"`, `"EXEMPTED_UNDER_SCHEDULE_C5"` Example: `"NONE(None)"`	No
customerTypePhilippines	string	Customer Type Enum: `"NORMAL_CORPORATE=Normal(Corporate)"`, `"NORMAL_INDIVIDUAL=Normal(Individual)"`, `"ZERO_RATED_CORPORATE=Zero rated(Corporate)"`, `"ZERO_RATED_INDIVIDUAL=Zero Rated (Individual)"`, `"NORMAL=Normal"`, `"GOVERNMENT=Government"` Example: `"Normal(Corporate)"`	No
deVatIdentificationNo	string	VAT Identification No Example: `123456789012345`	No
documentSequenceCode	string	Contact Sequence code Example: `"C-0000001"`	No
emailId	string	contact email address Example: `"myinfo@domain.com"`	No
exemptionCertificateMalaysia	boolean	Exemption certificate Example: `true`	No
exemptionCriterialMalaysia	string	Exemption criteria Enum: `"NONE"`, `"ZERO_RATED"`, `"EXEMPTED_ZERO"` Example: `"NONE(None)"`	No
gstTreatment	string	GST treatment Enum: `"REGISTERED_BUSINESS_REGULAR=Registered Business - Regular"`, `"REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition"`, `"UNREGISTERED_BUSINESS=Unregistered Business"`, `"CUSTOMER=Consumer"`, `"OVERSEAS=Overseas"`, `"SPECIAL_ECONOMIC_ZONE=Special Economic Zone"`, `"DEEMED_EXPORT=Deemed Export"` Example: `"UnregisteredBusiness"`	No
gstin	string	Contact GSTIN Example: `"21AONPM8088Q211"`	No
intercompanyType	string	Contact Type either parent or subsidiary Enum: `"PARENT"`, `"SUBSIDIARY"` Example: `"PARENT/SUBSIDIARY"`	No
invoiceCreditLimitType	string	Invoice Credit Limit Type Enum: `"IGNORE"`, `"WARN"`, `"BLOCK"` Example: `"IGNORE"`	No
invoices	object		No
isAccountNumberFlag	boolean	indicates if user is sending account number or code Example: `true`	No
isCreditLimitApplicable	boolean	Contact credit limit applicable Example: `true`	No
isIncludeCurrentInvoice	boolean	Include Current Invoice Example: `true`	No
isIncludeCurrentQuotation	boolean	Include Current Quotation Example: `true`	No
isIncludeCurrentSalesOrder	boolean	Include Current Sales Order Example: `false`	No
isParentCompany	boolean	Is Parent company Example: `false`	No
isSubsidiaryCompany	boolean	Is Subsidiary company Example: `false`	No
name	string	Contact name Example: `"Sam"`	No
nikNumber	long	NIK No Example: `123456789012345`	No
nlVatIdentificationNo	string	VAT Identification No Example: `123456789012345`	No
npwpNumber	long	NPWP No Example: `123456789012345`	No
pan	string	Contact PAN Example: `"AONPM8088Q"`	No
payableAccountCode	string	Payable account code Example: `"AC002"`	No
paymentTermCode	string	Payment term code Example: `"Net 0"`	No
purchasePriceLists	[ long ]	Set of Purchase price lists Example: `[123,456]`	No
quotationCreditLimitType	string	Quotation Credit Limit Type Enum: `"IGNORE"`, `"WARN"`, `"BLOCK"` Example: `"IGNORE"`	No
receivableAccountCode	string	Receivable account code Example: `"AC001"`	No
resident	boolean	Is resident? Example: `true`	No
residentStatusIndonesia	boolean	Resident Status Example: `true`	No
saArabicDetails	ContactSAArabicDto	Contact details in Arabic for Saudi Arabia	No
salesOrderCreditLimitType	string	Sales Order Credit Limit Type Enum: `"IGNORE"`, `"WARN"`, `"BLOCK"` Example: `"IGNORE"`	No
salesPriceLists	[ long ]	Set of Sales price lists Example: `[123,456]`	No
salesTaxRegNo	string	Contact Sales Tax Registration No Example: `"W10-0108-000000021"`	No
sequenceFormat	string	Sequence Format Example: `1`	No
serviceTaxRegNo	string	Contact Service Tax Registration No Example: `"W10-0108-000000021"`	No
shippingAddress	[ Address ]	List of Shipping Address.	No
taxExempted	boolean		No
taxExemptionNo	string		No
taxExemptionReason	string		No
taxTreatment	string	Tax Treatment Enum: `"VAT_Registered"`, `"Non_VAT_Registered"`, `"GCC_VAT_Registered"`, `"GCC_Non_VAT_Registered"`, `"Non_GCC"`, `"VAT_Registered_Designated_Zone"`, `"Non_VAT_Registered_Designated_Zone"` Example: `"VAT_Registered"`	No
taxTypeCustomer	string	Tax Types Customer Enum: `"TAX_CODE_CUSTOMER_01"`, `"TAX_CODE_CUSTOMER_02"`, `"TAX_CODE_CUSTOMER_03"`, `"TAX_CODE_CUSTOMER_04"`, `"TAX_CODE_CUSTOMER_05"`, `"TAX_CODE_CUSTOMER_06"`, `"TAX_CODE_CUSTOMER_07"`, `"TAX_CODE_CUSTOMER_08"` Example: `"TAX_CODE_CUSTOMER_01"`	No
taxTypeVendor	string	Tax Types Vendor Enum: `"TAX_CODE_VENDOR_01"`, `"TAX_CODE_VENDOR_02"`, `"TAX_CODE_VENDOR_03"`, `"TAX_CODE_VENDOR_04"`, `"TAX_CODE_VENDOR_05"`, `"TAX_CODE_VENDOR_06"`, `"TAX_CODE_VENDOR_07"`, `"TAX_CODE_VENDOR_08"` Example: `"TAX_CODE_VENDOR_01"`	No
tdsApplicableIndia	boolean		No
tdsInfoIndia	ContactIndiaTdsInfo		No
tdsSectionToTdsRateId	long	Contact TDS Section to Tds Rate Id Example: `1213454`	No
vatExemptionReasonPhilippines	string	Philippines specific Contact VAT Exemption Reason Example: `"Reason"`	No
vatNoPhilippines	string	Philippines specific Contact VAT No. Example: `"012-345-678-910"`	No
vatRegistrationNo	string	VAT Registration No Example: `123456789012345`	No
vatStatusPhilippines	string	Philippines specific Contact VAT Status Example: `"Input VAT"`	No
vendorType	string	Vendor Type Enum: `"IMPORT"`, `"NA"`, `"SEZ_W_PAY"`, `"SEZ_WO_PAY"` Example: `"NA"`	No
vendorTypeMalaysia	string	Vendor Type Enum: `"NONE"`, `"SALES_TAX_EXEMPTION"`, `"MANUFACTURED_EXEMPTION"`, `"PERFORMED_EXEMPTION"` Example: `"NONE(None)"`	No
vendorTypePhilippines	string	Vendor Type Enum: `"NORMAL_CORPORATE=Normal(Corporate)"`, `"NORMAL_INDIVIDUAL=Normal(Individual)"`, `"ZERO_RATED_CORPORATE=Zero rated(Corporate)"`, `"ZERO_RATED_INDIVIDUAL=Zero Rated (Individual)"`, `"GOVERNMENT=Government"`, `"NORMAL=Normal"`, `"IMPORT=Import"` Example: `"Normal(Corporate)"`	No
whtApplicablePhilippines	boolean	Make Contact as WHT applicable Example: `true`	No
whtBusinessPhilippines	string	BIR class determines the type of business Example: `"Individual"`	No

ContactSAArabicDto

Name	Type	Description	Required
billingAddress	[ Address ]	Billing addresses in Arabic language	No
saArabicName	string	Example: `"Name in Saudi Arabic Language"`	No
shippingAddress	[ Address ]	Shipping addresses in Arabic language	No

CustomFieldItem

Name	Type	Description	Required
id	long	Dimension Id Example: `11567`	No
label	string	Custom Field Name Example: `"Label"`	Yes
module	string	Supported Modules	No
value	object	Dimension Value Example: `"XYZ"`	No

DocumentInfo

Name	Type	Description	Required
documentCode	string	Document Code. Example: `"QO-0000001"`	No
documentCreatedDate	dateTime	Purchase creation date Example: `"2023-01-01T00:00:00.000+0000"`	No
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
documentType	string	Type of document. Enum: `"QUOTATION"`, `"PURCHASE_ORDER"`, `"SALES_ORDER"`, `"PURCHASE_INVOICE"`, `"SALES_INVOICE"`, `"MAKE_PAYMENT"`, `"RECEIVE_PAYMENT"`, `"JOURNAL_ENTRY"`, `"BANK_TRANSFER"`, `"CREDIT_NOTE"`, `"DEBIT_NOTE"`, `"EXPENSE"`, `"EXPENSE_PREPAYMENT"`, `"DEPOSIT"`, `"DEPOSIT_ADVPAYMENT"`, `"CONTRA_ADJUSTMENT"`, `"GOODS_RECEIPT"`, `"FULFILLMENT"`, `"PICKLIST"`, `"PACKLIST"`, `"SHIPLIST"`, `"PAYSLIP"`, `"PAYROLL_CHECK"`, `"CHEQUE"`, `"SALES_RETURN"`, `"PURCHASE_RETURN"`, `"STOCK_ADJUSTMENT"`, `"STOCK_TRANSFER"`, `"WORK_ORDER"`, `"FIXED_ASSET"`, `"E_WAY_BILL_SUMMARY"`, `"E_WAY_BILL_DETAIL"`, `"PURCHASE_REQUEST"`, `"JOB_WORK_OUT_ORDER"`, `"JOB_WORK_OUT_TRANSFER"`, `"QC_DOCUMENT"`, `"WIP_PRODUCTION"`, `"STOCK_REQUEST"`, `"STOCK_ISSUE"`, `"FORECAST"` Example: `"QUOTATION"`	No

DocumentItemTaxMappingDto

Name	Type	Description	Required
additionalTaxIn	boolean	true/false Example: `true`	No
taxAmount	number	Tax amount Example: `10`	No
taxApplyTo	string	Tax Apply To (Pre/AFTER) Example: `"Pre"`	No
taxCode	string	Tax Code Example: `"GST (10%)"`	No
taxName	string	Tax Name Example: `"GST (10%)"`	No
taxRate	number	Tax rate Example: `10`	No
taxSeqCode	string	Tax Sequence Code Example: `"0000001"`	No
taxableAmount	number	Taxable Amount Example: `100`	No

DocumentUOMSchemaDefinition

Name	Type	Description	Required
name	string	UOM Schema Name Example: `"UNIT"`	No
schemaId	long	UOM Schema Id Example: `1`	No
sinkConversionFactor	number	10 Example: `10`	No
sinkUOM	long	2 Example: `2`	No
sourceConversionFactor	number	1 Example: `1`	No
sourceUOM	long	4 Example: `4`	No
uid	string	UOM Schema Definition Id Example: `1`	No

ExportDocumentRequest

Name	Type	Description	Required
categoryName	string	QUOTE,INVOICE etc Example: `"QUOTE"`	Yes
customTemplate	boolean	Invoice Custom Template flag Example: `false`	No
documentCode	string	Document system number , could be invoice number, quotation number etc. Example: `"00001"`	No
documentNumber	string	Document number , could be invoice number, quotation number etc. Example: `"00001"`	No
documentType	string	Enum: `"QUOTATION"`, `"PURCHASE_ORDER"`, `"SALES_ORDER"`, `"PURCHASE_INVOICE"`, `"SALES_INVOICE"`, `"MAKE_PAYMENT"`, `"RECEIVE_PAYMENT"`, `"JOURNAL_ENTRY"`, `"BANK_TRANSFER"`, `"CREDIT_NOTE"`, `"DEBIT_NOTE"`, `"EXPENSE"`, `"EXPENSE_PREPAYMENT"`, `"DEPOSIT"`, `"DEPOSIT_ADVPAYMENT"`, `"CONTRA_ADJUSTMENT"`, `"GOODS_RECEIPT"`, `"FULFILLMENT"`, `"PICKLIST"`, `"PACKLIST"`, `"SHIPLIST"`, `"PAYSLIP"`, `"PAYROLL_CHECK"`, `"CHEQUE"`, `"SALES_RETURN"`, `"PURCHASE_RETURN"`, `"STOCK_ADJUSTMENT"`, `"STOCK_TRANSFER"`, `"WORK_ORDER"`, `"FIXED_ASSET"`, `"E_WAY_BILL_SUMMARY"`, `"E_WAY_BILL_DETAIL"`, `"PURCHASE_REQUEST"`, `"JOB_WORK_OUT_ORDER"`, `"JOB_WORK_OUT_TRANSFER"`, `"QC_DOCUMENT"`, `"WIP_PRODUCTION"`, `"STOCK_REQUEST"`, `"STOCK_ISSUE"`, `"FORECAST"`	No
fileName	string	File name of the template Example: `"QUOTE.DOCX"`	No
headers	[ Map«string,object» ]		No
moduleName	string	ERP,CRM,HRMS Example: `"ERP"`	Yes
skipDocumentTemplateMapping	boolean	Skip document template mapping Example: `false`	No
templateId	long	Template id Example: `12`	No

FilterCondition

Name	Type	Required
colId	string	No
opr	string	No
value	string	No

FilterRecord

Name	Type	Required
filterConditions	[ FilterCondition ]	No
logicalOperator	string	No
uniqueId	long	No

GlobalDiscountDetails

Name	Type	Required
accountCode	string	No
amount	number	No
isPercent	boolean	No
isSubTotalOnly	boolean	No
name	string	No
percent	number	No

GoodsReceiptItemDto

Name	Type	Description	Required
advancedTrackingMetaData	[ AdvancedTrackingMetaDto ]		No
advancedTrackingType	string	Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
documentItemCode	string	Document order code, It will be Purchase Order/Purchase Invoice item code. Possible value - POI-00001 or PII-00001 Example: `"POI-00001"`	Yes
documentSequenceCode	string	document sequence code Example: `"IN-0000001"`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
goods_receipt_item_code	string	goods receipt item specific unique code Example: `"GRI-000001"`	No
id	long		No
pendingQuantity	number		No
productCode	string	Product code Example: `"P-0000001"`	Yes
productDescription	string		No
productName	string		No
quantityRequired	number	Purchase Ordered Quantity Example: `100`	Yes
receiptDate	string	Receipt date Example: `"01-10-2019"`	No
receiptQuantity	number	Goods Receipt quantity Example: `20`	Yes
uomName	string	UOM name	No
uomPendingQuantity	number	uom pending quantity Example: `2`	Yes
uomQuantityRequired	number	Purchase Ordered uom Quantity Example: `100`	Yes
uomReceiptQuantity	number	uom receipt quantity Example: `2`	Yes
warehouseCode	string		No
warehouseInventoryData	[ WarehouseInventoryData ]	warehouse Inventory List Example: `[]`	No

GoodsReceiptResponse

Name	Type	Description	Required
attachmentIds	[ integer ]	list of attachment id's for this gr	No
attachments	[ string ]	Attachments url's	No
autoReceipt	boolean	Flag will pass as true for auto receipt flow. Possible value - TRUE \| FALSE Example: `false`	No
bulkItemCount	integer	count of bulk goods receipt Example: `0`	No
customField	[ CustomFieldItem ]	List of custom fields	No
documentCode	string	Document code Example: `"00001"`	Yes
documentSequenceCode	string	Document code Example: `"00001"`	Yes
documentType	string	Document Type, Stage from where goods receive is requested. Value will PURCHASE_ORDER or PURCHASE_INVOICE Example: `"PURCHASE_ORDER"`	Yes
goods_receipt_code	string	goods receipt specific unique code Example: `"GR-0000001"`	No
id	long		No
isBulkGR	boolean	true if the GR created is for bulk goods receipt Example: `true`	No
isGoodsReceiptOfLinkedDoc	boolean	Flag will denote if GR is of a linked doc Example: `true`	No
items	[ GoodsReceiptItemDto ]	Goods Receipt item details	No
linkedDocuments	[ DocumentInfo ]	Linked Documents	No
parentDocumentSeqCode	string	Document Sequence code of PO or Bill Example: `"00001"`	No
parentGrCode	string	goods receipt specific unique code for bulk gr Example: `"GR-0000001"`	No
receiptDate	string	Date on which all goods receipt successfully. Example: `"01-10-2019"`	No
sequence	integer	Goods receipt sequence Example: `1`	No
status	string	fulfillment status, possible value : UNRECEIVED \| PARTIAL_RECEIVED \| FULLY_RECEIVED Example: `"PARTIAL_FULFILLED"`	No
transactionLinkId	long	transaction link id for the goods received Example: `1`	No
warehouseCode	string	warehouse code Example: `"WH-0000001"`	No

InventoryDto

Name	Type	Description	Required
availableQuantity	double	Available quantity Example: `100`	No
binCode	string	bin code Example: `"BIN-00001"`	Yes
binName	string	bin name Example: `"BIN-NAME"`	No
costOfGoodsSoldAccountCode	string	Cost of goods sold account code Example: `"A-10231"`	Yes
inventoryAccountCode	string	Inventory account code Example: `"A-10232"`	Yes
inventoryAccountName	string	Inventory account name Example: `"Inventory Account"`	Yes
landedCostWeight	number	Landed cost weight value Example: `10.5`	No
openingQuantity	double	Opening quantity Example: `10`	No
openingValuation	double	Opening valuation Example: `100.4`	No
rackCode	string	Rack code Example: `"RACK-00001"`	Yes
rackName	string	Rack name Example: `"RACK-NAME"`	No
reservedQuantity	double	Reserved quantity Example: `100`	No
rowCode	string	Row code Example: `"ROW-00001"`	Yes
rowName	string	Row name Example: `"ROW-NAME"`	No
stockAdjustmentAccountCode	string	Stock adjustment account code Example: `"A-10234"`	Yes
warehouseCode	string	Warehouse code Example: `"WH-00001"`	Yes
wipInventoryAccountCode	string	WIP Inventory account code Example: `"A-10233"`	Yes

InventoryWarehouseDetails

Name	Type	Description	Required
availableQuantity	number	Available quantity Example: `100`	No
openingQuantity	number	Opening quantity Example: `10`	No
openingValuation	number	Opening Valuation Example: `1000`	No
warehouseCode	string	Warehouse code Example: `"WH-00001"`	Yes

InvoiceResponseInfo

Name	Type	Description	Required
currency	string		No
documentCode	string	document code Example: `"SI-0000041"`	No
documentSequenceCode	string	Document Sequence Code Example: `"00000001"`	No
dueAmount	number	due amount Example: `46`	No
exchangeRate	number		No
id	long	ID Example: `43`	No
invoiceDate	dateTime	invoice date Example: `"2018-10-01"`	No
invoiceDueDate	dateTime	invoice due date Example: `"2018-10-01"`	No
memo	string	memo Example: `"test"`	No
purchaseOrderRefNo	string	Contact PO reference number Example: `"CPO001"`	No
status	string	Enum: `"OPEN"`, `"DRAFT"`, `"CLOSED"`	No
supplierInvoiceNo	string	Contact supplier invoice number Example: `"CSI001"`	No
taxAmount	number	Total Amount Example: `1`	No
totalAmount	number	total amount Example: `46`	No
totalAmountInBaseCurrency	number	total amount in base currency Example: `46`	No
type	string	sale invoice or purchase invoice Example: `"sale_invoice"`	No

JobWorkOutOrderIndiaRequest

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Job Work Out order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if job work out order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
contact	ContactInfo	Contact info details	Yes
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
customerType	string	Customer Type Enum: `"EXPORT_WO_PAY"`, `"EXPORT_W_PAY"`, `"NA"`, `"SEZ_WO_PAY"`, `"SEZ_W_PAY"` Example: `"NA"`	Yes
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Job Work Out Order Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if job work out order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
gstTreatment	string	GST Treatment Example: `"REGISTERED_BUSINESS_REGULAR"`	No
gstin	string	Indian state from where the good/service is shipped Example: `"22AAAAAA00000AA21"`	No
jobWorkOutOrderItems	[ JobWorkOutOrderItemIndiaDetails ]	Job Work out order item details	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
placeOfSupply	string	Indian state from where the good/service is shipped Example: `"Delhi"`	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
vendorType	string	Vendor Type Enum: `"IMPORT"`, `"NA"`, `"SEZ_W_PAY"`, `"SEZ_WO_PAY"` Example: `"NA"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

JobWorkOutOrderIndiaResponse

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Additional Charges	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if job work out order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
billedStatus	string	job work out order billed Enum: `"PENDING"`, `"PARTIAL"`, `"BILLED"` Example: `false`	No
contact	ContactInfo	Contact info details	Yes
contactDto	ContactDto	Contact Details	No
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
customerType	string	Customer Type Enum: `"EXPORT_WO_PAY"`, `"EXPORT_W_PAY"`, `"NA"`, `"SEZ_WO_PAY"`, `"SEZ_W_PAY"` Example: `"NA"`	Yes
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
dispatchStatus	string	Received status for the Goods Enum: `"PENDING_DISPATCH"`, `"PARTIALLY_DISPATCHED"`, `"DISPATCHED"` Example: `"FULLY_RECEIVED"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	job work out Order Code Example: `"0000001"`	No
draft	boolean	job work out order drafted Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if job work out order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
gstTreatment	string	GST Treatment Example: `"REGISTERED_BUSINESS_REGULAR"`	No
gstin	string	Indian state from where the good/service is shipped Example: `"22AAAAAA00000AA21"`	No
id	long	job work out order id Example: `1`	No
jobWorkOutOrderItems	[ JobWorkOutOrderItemIndiaDetails ]	Job Work out order item details	No
jwoCode	string	job work out Order Code Example: `"0000001"`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedPurchaseInvoices	[ LinkedPurchaseInvoiceResponse ]		No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
pendingReceipt	boolean	job work out order pending receipt Example: `false`	No
placeOfSupply	string	Indian state from where the good/service is shipped Example: `"Delhi"`	No
poCode	string	job work out order code Example: `"PO0001"`	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
recurring	boolean	True if Order is recurring. Example: `true`	No
recurringActivated	boolean	True if Order recurrence is active. Example: `false`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
vendorType	string	Vendor Type Enum: `"IMPORT"`, `"NA"`, `"SEZ_W_PAY"`, `"SEZ_WO_PAY"` Example: `"NA"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

JobWorkOutOrderInformation

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase invoice additional charges details	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if JobWorkOut order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
billedStatus	string	JobWorkOut order billed Enum: `"PENDING"`, `"PARTIAL"`, `"BILLED"` Example: `"BILLED"`	No
contact	ContactInfo	Contact info details	Yes
contactDto	ContactInformation	Contact Details	No
creditable	boolean	True if JobWorkOut Order is creditable Example: `true`	No
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
customerType	string	Customer Type Enum: `"EXPORT_WO_PAY"`, `"EXPORT_W_PAY"`, `"NA"`, `"SEZ_WO_PAY"`, `"SEZ_W_PAY"` Example: `"NA"`	Yes
dispatchStatus	string	Received status for the Goods Enum: `"PENDING_DISPATCH"`, `"PARTIALLY_DISPATCHED"`, `"DISPATCHED"` Example: `"FULLY_RECEIVED"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	JobWorkOut Order Code Example: `"0000001"`	No
draft	boolean	JobWorkOut order drafted Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if JobWorkOut order is created for drop ship Example: `true`	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
gstin	string	Indian state from where the good/service is shipped Example: `"22AAAAAA00000AA21"`	No
id	long	JobWorkOut order id Example: `1`	No
jobWorkOutOrderItems	[ JobWorkOutOrderItemInformation ]	JobWorkOut order item details	No
jwoCode	string	JobWorkOut order code Example: `"PO0001"`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedPurchaseInvoices	[ LinkedPurchaseInvoiceResponse ]		No
memo	string	Memo Example: `"Memo details"`	No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
pendingReceipt	boolean	JobWorkOut order pending receipt Example: `false`	No
placeOfSupply	string	Indian state from where the good/service is shipped Example: `"Delhi"`	No
rcmApplicable	boolean	True if RCM applicable Example: `true`	No
receiptDate	string	Receipt date Example: `"01-10-2019"`	Yes
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number		No
tcsAmountInBaseCurrency	number		No
tcsPercentage	number		No
tcsRateId	long		No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
vendorType	string	Vendor Type Enum: `"IMPORT"`, `"NA"`, `"SEZ_W_PAY"`, `"SEZ_WO_PAY"` Example: `"NA"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

JobWorkOutOrderItemDetails

Name	Type	Description	Required
accountCode	string	Account Example: `"AC001"`	No
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
bomMetaCode	string	bom meta code Example: `"00001"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
id	long	ID Example: `2`	No
jobWorkOutOrderItemCode	string	Job Work Out Item Code Example: `"POI-00001"`	No
lineNumber	integer	Line Number Example: `1`	No
otherRate	number	Tax Rate Example: `5`	No
otherTaxAmount	number	Other Tax Amount Example: `10`	No
pendingQuantity	number	Pending quantity Example: `2`	No
product	ProductResponse	Product Details Example: `"product"`	No
productCode	string	Product Example: `"P002"`	No
productDescription	string	Description Example: `"Description"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	No
receivedQuantityInBills	number	Received quantity through bill Example: `2`	No
receivedQuantityInOrder	number	Received quantity through order Example: `2`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Unit price / Amount Example: `2`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

JobWorkOutOrderItemIndiaDetails

Name	Type	Description	Required
accountCode	string	Account Example: `"AC001"`	No
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
bomMetaCode	string	bom meta code Example: `"00001"`	No
cessAmount	number	India specific CESS amount on total amount Example: `0`	No
cessPercentage	number	Cess Percentage Example: `2.322`	No
cessRule	string	Cess Rule if it applies to the item Example: `"Math.max(21amount/100,4170quantity/100)"`	No
cgstAmount	number	India specific CGST tax amount on total amount Example: `5`	No
cgstRate	number	India specific CGST rate Example: `5`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
hsnOrSacCode	string	Hsn or Sac code Example: `110011`	No
id	long	ID Example: `2`	No
igstAmount	number	India specific IGST tax amount on total amount Example: `5`	No
igstRate	number	India specific IGST rate Example: `5`	No
itcIneligibleType	string	Ineligible - as per Section 17(5) Enum: `"ITC_INELIGIBLE_SECTION_17"`, `"ITC_INELIGIBLE_OTHERS"` Example: `"ITC_INELIGIBLE_SECTION_17"`	No
jobWorkOutOrderItemCode	string	Job Work Out Item Code Example: `"POI-00001"`	No
lineNumber	integer	Line Number Example: `1`	No
otherRate	number	Tax Rate Example: `5`	No
otherTaxAmount	number	Other Tax Amount Example: `10`	No
pendingQuantity	number	Pending quantity Example: `2`	No
product	ProductResponse	Product Details Example: `"product"`	No
productCode	string	Product Example: `"P002"`	No
productDescription	string	Description Example: `"Description"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	No
receivedQuantityInBills	number	Received quantity through bill Example: `2`	No
receivedQuantityInOrder	number	Received quantity through order Example: `2`	No
sgstAmount	number	India specific SGST tax amount on total amount Example: `5`	No
sgstRate	number	India specific SGST rate Example: `5`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
taxExemptionReason	string	Tax Exemption reason if taxPreference is true Enum: `"EXEMPTED"`, `"NON_GST"` Example: `"EXEMPTED"`	No
taxPreference	boolean	Tax preference, whether Exempted or not Exempted Example: `false`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Unit price / Amount Example: `2`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes
userSetTaxes	boolean	Flag to check whether tax is user edited Example: `false`	No

JobWorkOutOrderItemInformation

Name	Type	Description	Required
accountCode	string	Account Example: `"AC001"`	No
bomMetaCode	string	bom meta code Example: `"00001"`	No
cessAmount	number	India specific CESS amount on total amount Example: `0`	No
cessPercentage	number	Cess Percentage Example: `2.322`	No
cessRule	string	Cess Rule if it applies to the item Example: `"Math.max(21amount/100,4170quantity/100)"`	No
cgstAmount	number	India specific CGST tax amount on total amount Example: `5`	No
cgstRate	number	India specific CGST rate Example: `5`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
exciseAmount	number	Excise amount Example: `0.5`	No
exciseRate	double	Rate of Excise Example: `5`	No
exciseType	string	Excise type Enum: `"PERCENT"`, `"FLAT"` Example: `"FLAT"`	No
hsnOrSacCode	string	Hsn or Sac code Example: `110011`	No
id	long	ID Example: `2`	No
igstAmount	number	India specific IGST tax amount on total amount Example: `5`	No
igstRate	number	India specific IGST rate Example: `5`	No
itcIneligibleType	string	Ineligible - as per Section 17(5) Enum: `"ITC_INELIGIBLE_SECTION_17"`, `"ITC_INELIGIBLE_OTHERS"` Example: `"ITC_INELIGIBLE_SECTION_17"`	No
jobWorkOutOrderItemCode	string	JobWorkOut Item Code Example: `"POI-00001"`	No
lineNumber	integer	Line Number Example: `1`	No
otherRate	number	Tax Rate Example: `5`	No
otherTaxAmount	number	Other Tax Amount Example: `10`	No
pendingAmount	number	Pending amount Example: `100`	No
pendingQuantity	number	Pending quantity Example: `2`	No
product	ProductInformation	Product Details Example: `"product"`	No
productCode	string	Product Example: `"P002"`	No
productDescription	string	Description Example: `"Description"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	No
receivedQuantityInBills	number	Received quantity through bill Example: `2`	No
receivedQuantityInOrder	number	Received quantity through order Example: `2`	No
sgstAmount	number	India specific SGST tax amount on total amount Example: `5`	No
sgstRate	number	India specific SGST rate Example: `5`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
taxDetails	[ DocumentItemTaxMappingDto ]	Tax Details for Tax Group	No
taxExemptionReason	string	Tax Exemption reason if taxPreference is true Enum: `"EXEMPTED"`, `"NON_GST"` Example: `"EXEMPTED"`	No
taxPreference	boolean	Tax preference, whether Exempted or not Exempted Example: `false`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Unit price / Amount Example: `2`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes
userSetTaxes	boolean	Flag to check whether tax is user edited Example: `false`	No

JobWorkOutOrderRequest

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Job Work Out order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if job work out order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
contact	ContactInfo	Contact info details	Yes
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Job Work Out Order Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if job work out order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
jobWorkOutOrderItems	[ JobWorkOutOrderItemDetails ]	Job Work out order item details	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

JobWorkOutOrderResponse

Name	Type	Description	Required
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if job work out order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
billedStatus	string	job work out order billed Enum: `"PENDING"`, `"PARTIAL"`, `"BILLED"` Example: `false`	No
contact	ContactInfo	Contact info details	Yes
contactDto	ContactDto	Contact Details	No
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
dispatchStatus	string	Received status for the Goods Enum: `"PENDING_DISPATCH"`, `"PARTIALLY_DISPATCHED"`, `"DISPATCHED"` Example: `"FULLY_RECEIVED"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	job work out Order Code Example: `"0000001"`	No
draft	boolean	job work out order drafted Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if job work out order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
id	long	job work out order id Example: `1`	No
jobWorkOutOrderItems	[ AbstractJobWorkOutOrderItemDetails ]	Job Work out order item details	No
jwoCode	string	job work out Order Code Example: `"0000001"`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedPurchaseInvoices	[ LinkedPurchaseInvoiceResponse ]		No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
pendingReceipt	boolean	job work out order pending receipt Example: `false`	No
poCode	string	job work out order code Example: `"PO0001"`	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
recurring	boolean	True if Order is recurring. Example: `true`	No
recurringActivated	boolean	True if Order recurrence is active. Example: `false`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

LandedCostCategory

Name	Type	Description	Required
allocationType	string	Enum: `"QUANTITY"`, `"VALUE"`, `"WEIGHT"`, `"MANUAL"`, `"CUSTOM_DUTY"`	No
name	string		No

LandedCostDetails

Name	Type	Description	Required
allocationType	string	Enum: `"QUANTITY"`, `"VALUE"`, `"WEIGHT"`, `"MANUAL"`, `"CUSTOM_DUTY"`	No
categoryName	string		No
landedCostCategory	string		No
productDetails	[ LandedCostProductDetails ]		No

LandedCostProductDetails

Name	Type	Required
allocatedCost	number	No
customDutyAndOtherCharges	number	No
gstRate	string	No
hsncode	string	No
igst	number	No
product	string	No
productId	string	No
quantity	number	No
taxableValueForCustomDuty	number	No
taxableValueForIGST	number	No
totalAmount	number	No
unitPrice	number	No

LinkedDocumentResponse

Name	Type	Description	Required
documentDate	dateTime	Purchase Invoice date Example: `"25-10-2019"`	Yes
documentSequenceCode	string	Purchase invoice Sequence Code Example: `"0000001"`	No
dueAmount	number	Amount Due Example: `12.322`	No
totalAmount	number	Total Invoice amount Example: `12.322`	No

LinkedDocumentUpdateRequest

Name	Type	Description	Required
newLinkedDocument	DocumentInfo		No
oldLinkedDocument	DocumentInfo		No

LinkedDocumentsDto

Name	Type	Description	Required
code	string		No
used	boolean		No

LinkedPurchaseInvoiceResponse

Name	Type	Description	Required
documentSequenceCode	string	Purchase invoice Sequence Code Example: `"0000001"`	No
dueAmount	number	Amount Due Example: `12.322`	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
isPartialInvoice	boolean	is Partial Invoice Example: `true`	No
purchaseInvoiceCode	string	Purchase invoice code Example: `"SI001"`	No
purchaseInvoiceDate	string	Purchase Invoice date Example: `"25-10-2019"`	Yes
totalAmount	number	Total Invoice amount Example: `12.322`	No

LinkedPurchaseOrderResponse

Name	Type	Description	Required
documentSequenceCode	string	Purchase order Sequence Code Example: `"0000001"`	No
isPartialOrder	boolean	is Partial Order Example: `true`	No
purchaseOrderCode	string	Purchase order code Example: `"PO001"`	No
totalAmount	number	Total Order amount Example: `12.322`	No

Map«string,object»

Name	Type	Description	Required
Map«string,object»	object

Map«string,string»

Name	Type	Description	Required
Map«string,string»	object

MonthData

Name	Type	Description	Required
amount	number		No
count	integer		No
month	string	Enum: `"JANUARY"`, `"FEBRUARY"`, `"MARCH"`, `"APRIL"`, `"MAY"`, `"JUNE"`, `"JULY"`, `"AUGUST"`, `"SEPTEMBER"`, `"OCTOBER"`, `"NOVEMBER"`, `"DECEMBER"`	No
year	Year		No

OrderOverview

Name	Type	Required
count	integer	No
data	[ MonthData ]	No
totalAmount	number	No

OrderOverviewReport

Name	Type	Required
billedNotFulfilled	OrderOverview	No
billedNotReceived	OrderOverview	No
closed	OrderOverview	No
drafts	OrderOverview	No
fulfilled	OrderOverview	No
fulfilledNotBilled	OrderOverview	No
open	OrderOverview	No
pending	OrderOverview	No
received	OrderOverview	No
receivedNotBilled	OrderOverview	No
total	OrderOverview	No
unbilled	OrderOverview	No
unfulfilled	OrderOverview	No

OrderReportInfo

Name	Type	Required
contactName	string	No
customField	[ CustomFieldItem ]	No
docCurrency	string	No
documentCode	string	No
orderDateFormat	string	No
orderDueDateFormat	string	No
receiptStatus	string	No
totalAmount	string	No

OrderRequestDto

Name	Type	Description	Required
addProcessingFee	boolean	flag to add processing fee Example: `true`	No
amount	number	Order amount Example: `3546.23`	No
currency	string	Currency Example: `"USD"`	No
customerEmail	string	Customer email Example: `"john@doe.com"`	No
customerName	string	Customer Name Example: `"John"`	No
daysUntilDue	integer	due date Example: `30`	No
description	string	Description Example: `"Order for inventory"`	No
platformDetails	PlatformDetailsDto	Platform details dto Example: `"platformDetailsDto"`	No

Pageable

Name	Type	Required
offset	long	No
pageNumber	integer	No
pageSize	integer	No
paged	boolean	No
sort	Sort	No
unpaged	boolean	No

Page«JobWorkOutOrderIndiaResponse»

Name	Type	Required
content	[ JobWorkOutOrderIndiaResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer	No

Page«JobWorkOutOrderResponse»

Name	Type	Required
content	[ JobWorkOutOrderResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer	No

Page«PurchaseOrderAustraliaResponse»

Name	Type	Required
content	[ PurchaseOrderAustraliaResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer	No

Page«PurchaseOrderCanadaResponse»

Name	Type	Required
content	[ PurchaseOrderCanadaResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer	No

Page«PurchaseOrderDEResponse»

Name	Type	Required
content	[ PurchaseOrderDEResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer	No

Page«PurchaseOrderIndiaResponse»

Name	Type	Required
content	[ PurchaseOrderIndiaResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer	No

Page«PurchaseOrderIndonesiaResponse»

Name	Type	Required
content	[ PurchaseOrderIndonesiaResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer	No

Page«PurchaseOrderIsraelResponse»

Name	Type	Required
content	[ PurchaseOrderIsraelResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer	No

Page«PurchaseOrderMalaysiaResponse»

Name	Type	Required
content	[ PurchaseOrderMalaysiaResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer	No

Page«PurchaseOrderPhilippinesResponse»

Name	Type	Required
content	[ PurchaseOrderPhilippinesResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer	No

Page«PurchaseOrderResponse»

Name	Type	Required
content	[ PurchaseOrderResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer	No

Page«PurchaseOrderSaudiArabiaResponse»

Name	Type	Required
content	[ PurchaseOrderSaudiArabiaResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer	No

Page«PurchaseOrderUKResponse»

Name	Type	Required
content	[ PurchaseOrderUKResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer	No

Page«PurchaseOrderUaeResponse»

Name	Type	Required
content	[ PurchaseOrderUaeResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer	No

Page«PurchaseRequestResponse»

Name	Type	Required
content	[ PurchaseRequestResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer	No

Page«SalesOrderResponse»

Name	Type	Required
content	[ SalesOrderResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer	No

PaymentMilestoneDetailsResponse

Name	Type	Description	Required
amount	number	Amount Example: `100`	Yes
amountInPercent	number		No
amountInPercentFlag	boolean		No
contactCode	string	Contact Code Example: `"C-000001"`	Yes
documentCode	string	Document Code Example: `"000001"`	Yes
documentType	string	Document Type Enum: `"QUOTATION"`, `"PURCHASE_ORDER"`, `"SALES_ORDER"`, `"PURCHASE_INVOICE"`, `"SALES_INVOICE"`, `"MAKE_PAYMENT"`, `"RECEIVE_PAYMENT"`, `"JOURNAL_ENTRY"`, `"BANK_TRANSFER"`, `"CREDIT_NOTE"`, `"DEBIT_NOTE"`, `"EXPENSE"`, `"EXPENSE_PREPAYMENT"`, `"DEPOSIT"`, `"DEPOSIT_ADVPAYMENT"`, `"CONTRA_ADJUSTMENT"`, `"GOODS_RECEIPT"`, `"FULFILLMENT"`, `"PICKLIST"`, `"PACKLIST"`, `"SHIPLIST"`, `"PAYSLIP"`, `"PAYROLL_CHECK"`, `"CHEQUE"`, `"SALES_RETURN"`, `"PURCHASE_RETURN"`, `"STOCK_ADJUSTMENT"`, `"STOCK_TRANSFER"`, `"WORK_ORDER"`, `"FIXED_ASSET"`, `"E_WAY_BILL_SUMMARY"`, `"E_WAY_BILL_DETAIL"`, `"PURCHASE_REQUEST"`, `"JOB_WORK_OUT_ORDER"`, `"JOB_WORK_OUT_TRANSFER"`, `"QC_DOCUMENT"`, `"WIP_PRODUCTION"`, `"STOCK_REQUEST"`, `"STOCK_ISSUE"`, `"FORECAST"` Example: `"SALES_INVOICE"`	Yes
dueAmount	number	Payment Due Amount Example: `0`	Yes
id	long		No
linkedDocument	LinkedDocumentResponse	linkedDocument Example: `{}`	Yes
milestoneDate	string	Milestone Date Example: `"25-10-2019"`	Yes
milestoneNo	integer	Milestone Number Example: `1`	Yes
receivedAmount	number	Payment Received Amount Example: `100`	Yes
status	string	Status Enum: `"PAYMENT_DUE"`, `"PAYMENT_ON_TIME"`, `"DELAYED"` Example: `"DELAYED"`	Yes

PlatformDetailsDto

Name	Type	Description	Required
accountCode	string	Account ID Example: `"ACC001"`	No
contactCode	string	Contact ID Example: `"C001"`	No
documentCode	string	Document Code Example: `"DOC001"`	No
documentDate	string	Document Date Example: `"2020-10-10"`	No
documentType	string	Document Type Example: `"INVOICE"`	No
invoiceId	string	Invoice ID Example: `"INV001"`	No
memo	string	Memo Description Example: `"Invoice sent for payment"`	No
paymentCode	string	Payment Code Example: `124552`	No
userId	string	User ID Example: `1142`	No

ProductInOutQty

Name	Type	Description	Required
documentType	string	Enum: `"QUOTATION"`, `"PURCHASE_ORDER"`, `"SALES_ORDER"`, `"PURCHASE_INVOICE"`, `"SALES_INVOICE"`, `"MAKE_PAYMENT"`, `"RECEIVE_PAYMENT"`, `"JOURNAL_ENTRY"`, `"BANK_TRANSFER"`, `"CREDIT_NOTE"`, `"DEBIT_NOTE"`, `"EXPENSE"`, `"EXPENSE_PREPAYMENT"`, `"DEPOSIT"`, `"DEPOSIT_ADVPAYMENT"`, `"CONTRA_ADJUSTMENT"`, `"GOODS_RECEIPT"`, `"FULFILLMENT"`, `"PICKLIST"`, `"PACKLIST"`, `"SHIPLIST"`, `"PAYSLIP"`, `"PAYROLL_CHECK"`, `"CHEQUE"`, `"SALES_RETURN"`, `"PURCHASE_RETURN"`, `"STOCK_ADJUSTMENT"`, `"STOCK_TRANSFER"`, `"WORK_ORDER"`, `"FIXED_ASSET"`, `"E_WAY_BILL_SUMMARY"`, `"E_WAY_BILL_DETAIL"`, `"PURCHASE_REQUEST"`, `"JOB_WORK_OUT_ORDER"`, `"JOB_WORK_OUT_TRANSFER"`, `"QC_DOCUMENT"`, `"WIP_PRODUCTION"`, `"STOCK_REQUEST"`, `"STOCK_ISSUE"`, `"FORECAST"`	No
productCode	string		No
quantity	number		No

ProductInformation

Name	Type	Description	Required
active	boolean	Product status Example: `true`	No
advancedTracking	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"` Example: `"NONE"`	No
advancedTrackingMetaData	[ AdvancedTrackingMetaDto ]	Advanced Tracking Meta data Example: `{"field1":"value1","field2":"value2"}`	No
amortizationPeriod	integer	Amortization template period Example: `36`	No
amortizationTemplateCode	string	Amortization template code Example: `"0000001"`	No
attributes	[ AttributeDetails ]	Attribute Details	No
autoFulfillmentEnabled	boolean	Is Auto-Fulfillment enable? Example: `false`	No
availableQuantity	number	Available Quantity Example: `2`	No
barcode	string	Product barcode Example: `2365234`	No
barcodeDetails	BarcodeDetails	barcode details Example: `{"barcodeField":"Samsung"}`	No
basePrice	double	Revenue Base price Example: `120`	No
bomAddCostConfiguration	[ BomAdditionalCostDto ]	Bom additional cost information	No
bomMetaDetailsList	[ BomMetaDetailsDto ]	multiple bom configuration Example: `"Bom Configuration"`	No
bomOperationsConfiguration	[ BomOperationDto ]	Bom Operations information	No
bomProductCostDetails	[ BomProductCostDetails ]	JSON object for custom fields Example: `{"field1":"value1","field2":"value2"}`	No
bomProductsConfiguration	[ BomMetaDto ]	Bom Products information	No
categoryCode	string	Category code Example: `"AB0001"`	No
categoryDesc	string	Category description Example: `"Medical Equipment"`	No
cessRule	string	Cess rule expression Example: `"Math.max(21amount/100,4170quantity/1000)"`	No
cessRuleDescription	string	Cess rule description Example: `"21% or Rs. 4170 per thousand, whichever is higher"`	No
costOfGoodsSoldAccountCode	string		No
customField	[ CustomFieldItem ]	JSON object for custom fields Example: `{"field1":"value1","field2":"value2"}`	No
deferredExpenseAccountCode	string	Deferred Expense account code Example: `"A-0015"`	No
deferredRevenueAccountCode	string	Deferred Revenue account code Example: `"A-0015"`	No
deleted	boolean	Product delete status Example: `true`	No
description	string	Product description Example: `"Description"`	No
documentSequenceCode	string	Product Sequence code Example: `"P-0000001"`	No
exciseApplicable	boolean	Example: `true`	No
exciseRate	double	Excise rate based on Excise Type Example: `10`	No
exciseType	string	Excise type to apply Enum: `"PERCENT"`, `"FLAT"` Example: `"PERCENT"`	No
exemptedMalaysia	boolean	Whether Product is Tax Exempted Example: `true`	No
glAccountCode	string	GL account code Example: `"A-0017"`	No
hasBuildAssembly	boolean	Has Build Assembly Example: `true`	No
hasVariants	boolean	Product has variants Example: `false`	No
hsnOrSacCode	string	HSN or SAC code of product Example: `1234`	No
id	long	Product ID Example: `1234`	No
images	[ string ]	Product image url's	No
incomingQty	number	Product incoming Qty	No
inventory	InventoryDto	Inventory information required for Tracked Products.	No
inventoryAccountCode	string		No
inventoryWarehouseDetails	[ InventoryWarehouseDetails ]	Inventory warehouse details Example: `{"warehouseCode":"WH-00001","availableQuantity":"100","openingQuantity":"100"}`	No
isAccountNumberFlag	boolean	indicates if user is sending account number or code Example: `true`	No
isFinishedProduct	boolean	Is finished product? Example: `false`	No
isUiProductUpdate	boolean	Product is update by UI. Example: `false`	No
isVariant	boolean	Is a variant Example: `false`	No
itcAdjustment	string	ITC adjustment Enum: `"NA"`, `"ITC_IS_BLOCKED"`, `"ITC_IS_REVERSED"` Example: `"ITC_IS_BLOCKED"`	No
landedCostCategory	[ LandedCostCategory ]	Landed cost category details	No
manufacturingCostAccountCode	string	Manufacturing Cost Account Code Example: `"AC-0000012"`	No
masterProductCode	string	Master Product Code Example: `"P-0000001"`	No
multipleUomSchema	boolean	Is multiple Uom Schema? Example: `true`	No
name	string	Product Name Example: `"Apple"`	Yes
nameInArabicSA	string		No
offeringType	string	Offering type Enum: `"GOODS"`, `"SERVICES"` Example: `"GOODS"`	No
outgoingQty	number	Product outgoing Qty	No
productId	string	Product ID Example: `"P000011"`	No
productSubstitutesDetails	[ ProductSubstitutesDetails ]		No
productTransactionType	string	Product Transaction Type Enum: `"BOTH"`, `"PURCHASE"`, `"SALES"` Example: `"BOTH"`	Yes
purchaseAccountCode	string	Purchase account code Example: `"A-0012"`	Yes
purchasePrice	double	Purchase price Example: `123.33`	Yes
purchasePriceTaxInclusive	boolean	Is purchase price tax inclusive? Example: `true`	No
purchaseReturnAccountCode	string	Purchase return account code Example: `"A-0014"`	No
purchaseTaxCode	string	Purchase tax code Example: `"T-001"`	No
recommendedUom	long	Recommended product uom	No
reorderEnabled	boolean	Flag to enable reorder level Example: `true`	No
reorderLevel	long	Reorder level of the Products. Example: `100`	No
reorderLevelReached	boolean	Has Reorder level reached	No
reorderQuantity	long	Quantity to be reordered Example: `50`	No
reorderVendorCode	string	Vendor code for reorder Example: `"C-000001"`	No
reorderVendorName	string	Reorder Vendor Name	No
reservedQuantity	number	Reserved Quantity Example: `2`	No
revenueRecognitionInfo	ProductRevenueRecognitionInfo	Product Revenue Recognition Information Object	No
rowRackBinData	RowRackBinData	Row Rack Bin information required for Tracked Products.	No
salesAccountCode	string	Sales account code Example: `"A-0013"`	Yes
salesPrice	double	Sales price Example: `120`	Yes
salesPriceTaxInclusive	boolean	Is sales price tax inclusive? Example: `false`	No
salesReturnAccountCode	string	Sales return account code Example: `"A-0015"`	No
salesTaxCode	string	Sales tax code Example: `"T-002"`	No
sequenceFormat	string	Sequence Format Example: `1`	No
source	string	Identify this is ecom sync product Example: `"SHOPIFY"`	No
stockAdjustmentAccountCode	string		No
stockUom	long	Stock UOM Example: `2`	Yes
tariffOrServiceCodeMalaysia	string	Tariff or Service code of product Example: `1234`	No
taxExemptionReason	string	Tax Exempted reason to be filled, if taxPreference is true Enum: `"EXEMPTED"`, `"NON_GST"` Example: `"EXEMPTED"`	No
taxExemptionReasonMalaysia	string	Tax Exempted reason to be filled, if taxPreference is true Enum: `"EXEMPTED"`, `"NON_SST"`, `"LIVE_ANIMALS"`, `"UNPROCESSED_FOOD"`, `"VEGETABLES"`, `"MEDICINES"`, `"MACHINERY"`, `"CHEMICALS"` Example: `"EXEMPTED"`	No
taxPreference	boolean	Whether Product is Tax Exempted Example: `true`	No
taxable	boolean	Is taxable? Example: `true`	No
tdsApplicableIndia	boolean		No
tdsNatureOfPaymentIndia	string		No
type	string	Product type Enum: `"TRACKED"`, `"NONTRACKED"`, `"BILL_OF_MATERIALS"` Example: `"TRACKED"`	Yes
uomSchema	long	Reorder level of the Products. Example: `100`	No
uomSchemaDto	UOMSchemaDto	Product uom schema information	No
valuationMethod	string	Valuation Method Enum: `"FIFO"`, `"AVERAGE"` Example: `"FIFO"`	Yes
variantAttributes	object	Attribute Details specific to a variant	No
variantCount	integer	Variant Count	No
whtApplicable	boolean	Example: `true`	No
whtSectionToWhtRateId	long	Product WHT - Nature Of Payment to WHT Rate Id Example: `1213454`	No
wipInventoryAccountCode	string		No

ProductResponse

Name	Type	Description	Required
active	boolean	Product status Example: `true`	No
advancedTracking	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"` Example: `"NONE"`	No
advancedTrackingMetaData	[ AdvancedTrackingMetaDto ]	Advanced Tracking Meta data Example: `{"field1":"value1","field2":"value2"}`	No
amortizationPeriod	integer	Amortization template period Example: `36`	No
amortizationTemplateCode	string	Amortization template code Example: `"0000001"`	No
attributes	[ AttributeDetails ]	Attribute Details	No
autoFulfillmentEnabled	boolean	Is Auto-Fulfillment enable? Example: `false`	No
barcode	string	Product barcode Example: `2365234`	No
barcodeDetails	BarcodeDetails	barcode details Example: `{"barcodeField":"Samsung"}`	No
basePrice	double	Revenue Base price Example: `120`	No
bomAddCostConfiguration	[ BomAdditionalCostDto ]	Bom additional cost information	No
bomMetaDetailsList	[ BomMetaDetailsDto ]	multiple bom configuration Example: `"Bom Configuration"`	No
bomOperationsConfiguration	[ BomOperationDto ]	Bom Operations information	No
bomProductCostDetails	[ BomProductCostDetails ]	JSON object for custom fields Example: `{"field1":"value1","field2":"value2"}`	No
bomProductsConfiguration	[ BomMetaDto ]	Bom Products information	No
categoryCode	string	Category code Example: `"AB0001"`	No
categoryDesc	string	Category description Example: `"Medical Equipment"`	No
customField	[ CustomFieldItem ]	JSON object for custom fields Example: `{"field1":"value1","field2":"value2"}`	No
deferredExpenseAccountCode	string	Deferred Expense account code Example: `"A-0015"`	No
deferredRevenueAccountCode	string	Deferred Revenue account code Example: `"A-0015"`	No
deleted	boolean	Product delete status Example: `true`	No
description	string	Product description Example: `"Description"`	No
documentSequenceCode	string	Product Sequence code Example: `"P-0000001"`	No
hasBuildAssembly	boolean	Has Build Assembly Example: `true`	No
hasVariants	boolean	Product has variants Example: `false`	No
id	long	Product ID Example: `1234`	No
images	[ string ]	Product image url's	No
incomingQty	number	Product incoming Qty	No
inventory	InventoryDto	Inventory information required for Tracked Products.	No
inventoryWarehouseDetails	[ InventoryWarehouseDetails ]	Inventory warehouse details Example: `{"warehouseCode":"WH-00001","availableQuantity":"100","openingQuantity":"100"}`	No
isAccountNumberFlag	boolean	indicates if user is sending account number or code Example: `true`	No
isFinishedProduct	boolean	Is finished product? Example: `false`	No
isUiProductUpdate	boolean	Product is update by UI. Example: `false`	No
isVariant	boolean	Is a variant Example: `false`	No
landedCostCategory	[ LandedCostCategory ]	Landed cost category details	No
manufacturingCostAccountCode	string	Manufacturing Cost Account Code Example: `"AC-0000012"`	No
masterProductCode	string	Master Product Code Example: `"P-0000001"`	No
multipleUomSchema	boolean	Is multiple Uom Schema? Example: `true`	No
name	string	Product Name Example: `"Apple"`	Yes
outgoingQty	number	Product outgoing Qty	No
productId	string	Product ID Example: `"P000011"`	No
productSubstitutesDetails	[ ProductSubstitutesDetails ]		No
productTransactionType	string	Product Transaction Type Enum: `"BOTH"`, `"PURCHASE"`, `"SALES"` Example: `"BOTH"`	Yes
purchaseAccountCode	string	Purchase account code Example: `"A-0012"`	Yes
purchasePrice	double	Purchase price Example: `123.33`	Yes
purchasePriceTaxInclusive	boolean	Is purchase price tax inclusive? Example: `true`	No
purchaseReturnAccountCode	string	Purchase return account code Example: `"A-0014"`	No
purchaseTaxCode	string	Purchase tax code Example: `"T-001"`	No
recommendedUom	long	Recommended product uom	No
reorderEnabled	boolean	Flag to enable reorder level Example: `true`	No
reorderLevel	long	Reorder level of the Products. Example: `100`	No
reorderLevelReached	boolean	Has Reorder level reached	No
reorderQuantity	long	Quantity to be reordered Example: `50`	No
reorderVendorCode	string	Vendor code for reorder Example: `"C-000001"`	No
reorderVendorName	string	Reorder Vendor Name	No
revenueRecognitionInfo	ProductRevenueRecognitionInfo	Product Revenue Recognition Information Object	No
rowRackBinData	RowRackBinData	Row Rack Bin information required for Tracked Products.	No
salesAccountCode	string	Sales account code Example: `"A-0013"`	Yes
salesPrice	double	Sales price Example: `120`	Yes
salesPriceTaxInclusive	boolean	Is sales price tax inclusive? Example: `false`	No
salesReturnAccountCode	string	Sales return account code Example: `"A-0015"`	No
salesTaxCode	string	Sales tax code Example: `"T-002"`	No
sequenceFormat	string	Sequence Format Example: `1`	No
source	string	Identify this is ecom sync product Example: `"SHOPIFY"`	No
stockUom	long	Stock UOM Example: `2`	Yes
taxable	boolean	Is taxable? Example: `true`	No
type	string	Product type Enum: `"TRACKED"`, `"NONTRACKED"`, `"BILL_OF_MATERIALS"` Example: `"TRACKED"`	Yes
uomSchema	long	Reorder level of the Products. Example: `100`	No
uomSchemaDto	UOMSchemaDto	Product uom schema information	No
valuationMethod	string	Valuation Method Enum: `"FIFO"`, `"AVERAGE"` Example: `"FIFO"`	Yes
variantAttributes	object	Attribute Details specific to a variant	No
variantCount	integer	Variant Count	No

ProductRevenueRecognitionInfo

Name	Type	Description	Required
allocationType	string	Allocation Type Example: `"Normal/Exclude"`	No
createRevenuePlanOn	string	Create Revenue Plan On Example: `"Fulfillment"`	No
isDirectRevenuePositing	boolean	Direct Revenue Positing Example: `true`	No
itemRevenueCategory	string	Item Revenue Category Example: `"Licence"`	No
revRecForecastRule	string	Revenue Recognition Forecast Rule Example: `"Rule Forecast 1"`	No
revRecRule	string	Revenue Recognition Rule Example: `"Rule 1"`	No

ProductStockInfo

Name	Type	Required
fulfilledQuantity	number	No
pendingQuantity	number	No
productCode	string	No
receiptQuantity	number	No
status	string	No
warehouseCode	string	No

ProductSubstitutesDetails

Name	Type	Description	Required
advancedTracking	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"` Example: `"NONE"`	No
availableQuantity	number	Quantity of product available Example: `10`	No
productDocumentSeqCode	string	Doc seq code of Product Example: `"P-00001"`	No
productId	string	Product Id Example: `"P-00001"`	No
productName	string	Name of Product Example: `"Test Product"`	No
stockUom	long	Stock UOM Example: `2`	Yes
type	string	Product type Enum: `"TRACKED"`, `"NONTRACKED"`, `"BILL_OF_MATERIALS"` Example: `"TRACKED"`	Yes

PurchaseInvoiceAccountDetails

Name	Type	Description	Required
account	AccountDto	Account Response Example: `"product"`	No
accountCode	string	Product code Example: `"P00001"`	Yes
accountDescription	string	Product description Example: `"Apple watch"`	No
accountOrder	integer	Product view order Example: `1`	No
amount	number	Amount Example: `2`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
id	long	ID Example: `2`	No
isTdsApplicableAccount	boolean		No
isTdsApplicableContact	boolean		No
isTdsApplicableProduct	boolean		No
lineNumber	integer	Line Number Example: `1`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
tdsAccount	string	Tds Account Code Example: `"AC-0000011"`	No
tdsAmount	number	TDS Amount Example: `100`	No
tdsInfoIndia	TdsInfoIndia	Purchase invoice TDS details	No
tdsRate	number	TDS Rate Example: `10.1`	No
totalAmount	number	Total amount Example: `2.3`	Yes

PurchaseInvoiceAssetGroupDetails

Name	Type	Description	Required
additionalChargeAmount	number		No
additionalChargeTaxamount	number		No
additionalCharges	AdditionalCharges		No
amount	number	Amount Example: `2`	Yes
assetDetails	[ AssetRequest ]		No
assetGroupId	long		No
assetGroupName	string	Product code Example: `"P00001"`	Yes
assetGroupResponse	AssetGroupResponse	Account Response Example: `"product"`	No
assetOrder	integer	Product view order Example: `1`	No
customField	[ CustomFieldItem ]	List of custom fields	No
description	string	Product description Example: `"Apple watch"`	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
id	long	ID Example: `2`	No
invoiceItemCode	string		No
isPartialInvoice	boolean	Whether the Purchase Invoice is a partial invoice Example: `false`	No
lineNumber	integer	Line Number Example: `1`	No
linkedOrderItem	long	Order Item linked to invoice item Example: `123`	No
quantity	number		No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number		No

PurchaseInvoiceProductDetails

Name	Type	Description	Required
additionalChargeAmount	number	Example: `123`	No
additionalChargeAmountCalculated	number		No
additionalChargeTaxamount	number	Example: `123`	No
additionalChargeTaxamountCalculated	number		No
additionalCharges	AdditionalCharges	Purchase invoice item additional charges details	No
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
amortizationDocumentItemDetails	AmortizationDocumentItemDetails		No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
id	long	ID Example: `2`	No
invoiceLineNumber	string	Invoice Line Number Example: `"ABSCDDSD1212"`	No
isPartialInvoice	boolean	Whether the Purchase Invoice is a partial invoice Example: `false`	No
landedCostDetails	LandedCostDetails	Details for landed cost	No
lineNumber	integer	Line Number Example: `1`	No
linkedOrderItem	long	Order Item linked to invoice item Example: `123`	No
product	ProductResponse	Product Response Example: `"product"`	No
productCode	string	Product code Example: `"P00001"`	Yes
productDescription	string	Product description Example: `"Apple watch"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	Yes
purchaseInvoiceItemCode	string	Purchase Invoice Item Code Example: `"PII-000001"`	No
rcmRateSA	number	tax rate of rcm Example: `5`	No
rcmTaxAmountSA	number	tax rate of rcm Example: `5`	No
receivedQuantityInBills	number	Example: `123`	No
receivedQuantityInOrder	number	Example: `123`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
tdsAccount	string	Tds Account Code Example: `"AC-0000011"`	No
tdsAmount	number	TDS Amount Example: `100`	No
tdsId	integer	TDS Id Example: `1`	No
tdsRate	number	TDS Rate Example: `10.1`	No
totalAmount	number	Total amount Example: `2.3`	Yes
uaeRcmRate	number	tax rate of rcm Example: `5`	No
unitPrice	number	Product unit price Example: `0.7`	Yes
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes
vatCustomRateSA	number	tax rate of rcm Example: `5`	No
vatTaxAmountSA	number	tax rate of rcm Example: `5`	No

PurchaseInvoiceRecurringDetails

Name	Type	Description	Required
id	long	ID Example: `2`	No
invoiceRecurringCount	integer	Number of Invoices to be created Example: `1`	Yes
recurrenceEndDate	string	Recurrence End date Example: `"25-10-2019"`	Yes
recurrenceFrequency	string	Days, Weeks or Months Enum: `"DAYS"`, `"WEEK"`, `"MONTH"` Example: `"WEEK"`	Yes
recurrenceType	integer	Every x Days/Weeks/Months Example: `1`	Yes

PurchaseInvoiceRequest

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase invoice additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]		No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if purchase invoice is backorder Example: `true`	No
billTo	Address	Bill to Address	No
contact	ContactInfo	Contact details	Yes
contactCode	string	Contact Code Example: `"C0001"`	Yes
currency	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
documentSequenceCode	string	Bill Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
draftReferenceId	string	Draft reference id	No
dropShip	boolean	Drop Ship flag to indicate if purchase invoice is created for drop ship Example: `true`	No
dueAmount	number	Amount Due Example: `12.322`	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
isPartialInvoice	boolean	True if is partial invoice Example: `false`	No
journalEntryCode	string	Journal Entry Code Example: `"JE0001"`	No
landedCost	boolean	To mark landed cost bill Example: `true`	No
linkedDocuments	[ DocumentInfo ]	Linked Documents	No
memo	string	Memo Example: `"Memo details"`	No
openingDocumentNumber	string	Customer opening document number Example: `"DC-0001"`	No
openingInvoice	boolean	True if opening invoice Example: `false`	No
payableAccountCode	string	Code of Account Example: `"AC-000001"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
paymentStatus	string	Payment status Enum: `"PENDING"`, `"PARTIAL"`, `"RECEIVED"` Example: `"PENDING"`	No
purchaseInvoiceAccounts	[ PurchaseInvoiceAccountDetails ]	Purchase invoice Account item details	No
purchaseInvoiceAssets	[ PurchaseInvoiceAssetGroupDetails ]		No
purchaseInvoiceDate	string	Purchase Invoice date Example: `"25-10-2019"`	Yes
purchaseInvoiceDueDate	string	Purchase Invoice due date Example: `"25-10-2019"`	Yes
purchaseInvoiceProducts	[ PurchaseInvoiceProductDetails ]	Purchase invoice Product item details	No
purchaseInvoiceRecurring	PurchaseInvoiceRecurringDetails	Purchase invoice item details	No
purchaseInvoiceType	string	Purchase invoice type. Enum: `"INVENTORY"`, `"EXPENSE"`, `"ASSET"` Example: `"INVENTORY"`	Yes
purchaseOrderRefNo	string	Contact PO reference number Example: `"CPO001"`	No
receiptDate	dateTime	Receipt date Example: `"25-10-2019"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
receiveGoodsStatus	string	receipt goods status Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receivedComplete	boolean	True if auto received is required. Example: `false`	No
recurring	boolean	True if Invoice is recurring. Example: `true`	No
recurringActivated	boolean	True if Invoice recurrence is active. Example: `false`	No
roundOffAmountInBaseCurrency	number	Round Off Amount In Base Currency Example: `12.322`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount In Document Currency Example: `12.322`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Invoice status Enum: `"OPEN"`, `"DRAFT"`, `"CLOSED"` Example: `"OPEN"`	No
supplierInvoiceNo	string		No
taxAmount	number	Tax amount Example: `2.322`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `12.322`	No
totalAmountInBaseCurrency	number	Total amount in base currency Example: `12.322`	No
totalTdsAmount	number	Total Tds Amount Example: `12.32`	No
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	No

PurchaseOrderAssetGroupDetails

Name	Type	Description	Required
amount	number	Amount Example: `2`	Yes
assetDetails	[ AssetRequest ]		No
assetGroupId	long		No
assetGroupName	string	Product code Example: `"P00001"`	Yes
assetGroupResponse	AssetGroupResponse	Account Response Example: `"product"`	No
assetOrder	integer	Product view order Example: `1`	No
customField	[ CustomFieldItem ]	List of custom fields	No
description	string	Product description Example: `"Apple watch"`	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
id	long	ID Example: `2`	No
lineNumber	integer	Line Number Example: `1`	No
purchaseOrderItemCode	string		No
quantity	number		No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number		No

PurchaseOrderAustraliaRequest

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
contact	ContactInfo	Contact info details	Yes
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemAustraliaDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderAustraliaResponse

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
billed	boolean	Purchase order billed Example: `false`	No
contact	ContactInfo	Contact info details	Yes
contactDto	ContactDto	Contact Details	No
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	Purchase order drafted Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
id	long	Purchase order id Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedPurchaseInvoices	[ LinkedPurchaseInvoiceResponse ]		No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
pendingReceipt	boolean	Purchase order pending receipt Example: `false`	No
poCode	string	Purchase order code Example: `"PO0001"`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemAustraliaDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
recurring	boolean	True if Order is recurring. Example: `true`	No
recurringActivated	boolean	True if Order recurrence is active. Example: `false`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderCanadaRequest

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
contact	ContactInfo	Contact info details	Yes
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemCanadaDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderCanadaResponse

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
billed	boolean	Purchase order billed Example: `false`	No
contact	ContactInfo	Contact info details	Yes
contactDto	ContactDto	Contact Details	No
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	Purchase order drafted Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
id	long	Purchase order id Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedPurchaseInvoices	[ LinkedPurchaseInvoiceResponse ]		No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
pendingReceipt	boolean	Purchase order pending receipt Example: `false`	No
poCode	string	Purchase order code Example: `"PO0001"`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemCanadaDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
recurring	boolean	True if Order is recurring. Example: `true`	No
recurringActivated	boolean	True if Order recurrence is active. Example: `false`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderDERequest

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
contact	ContactInfo	Contact info details	Yes
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemDEDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderDEResponse

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
billed	boolean	Purchase order billed Example: `false`	No
contact	ContactInfo	Contact info details	Yes
contactDto	ContactDto	Contact Details	No
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	Purchase order drafted Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
id	long	Purchase order id Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedPurchaseInvoices	[ LinkedPurchaseInvoiceResponse ]		No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
pendingReceipt	boolean	Purchase order pending receipt Example: `false`	No
poCode	string	Purchase order code Example: `"PO0001"`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemDEDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
recurring	boolean	True if Order is recurring. Example: `true`	No
recurringActivated	boolean	True if Order recurrence is active. Example: `false`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderIndiaRequest

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
contact	ContactInfo	Contact info details	Yes
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
customerType	string	Customer Type Enum: `"EXPORT_WO_PAY"`, `"EXPORT_W_PAY"`, `"NA"`, `"SEZ_WO_PAY"`, `"SEZ_W_PAY"` Example: `"NA"`	Yes
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
gstTreatment	string	GST Treatment Example: `"REGISTERED_BUSINESS_REGULAR"`	No
gstin	string	Indian state from where the good/service is shipped Example: `"22AAAAAA00000AA21"`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
placeOfSupply	string	Indian state from where the good/service is shipped Example: `"Delhi"`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemIndiaDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
vendorType	string	Vendor Type Enum: `"IMPORT"`, `"NA"`, `"SEZ_W_PAY"`, `"SEZ_WO_PAY"` Example: `"NA"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderIndiaResponse

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Additional Charges	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
billed	boolean	Purchase order billed Example: `false`	No
contact	ContactInfo	Contact info details	Yes
contactDto	ContactDto	Contact Details	No
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
customerType	string	Customer Type Enum: `"EXPORT_WO_PAY"`, `"EXPORT_W_PAY"`, `"NA"`, `"SEZ_WO_PAY"`, `"SEZ_W_PAY"` Example: `"NA"`	Yes
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	Purchase order drafted Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
gstTreatment	string	GST Treatment Example: `"REGISTERED_BUSINESS_REGULAR"`	No
gstin	string	Indian state from where the good/service is shipped Example: `"22AAAAAA00000AA21"`	No
id	long	Purchase order id Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedPurchaseInvoices	[ LinkedPurchaseInvoiceResponse ]		No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
pendingReceipt	boolean	Purchase order pending receipt Example: `false`	No
placeOfSupply	string	Indian state from where the good/service is shipped Example: `"Delhi"`	No
poCode	string	Purchase order code Example: `"PO0001"`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemIndiaDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
recurring	boolean	True if Order is recurring. Example: `true`	No
recurringActivated	boolean	True if Order recurrence is active. Example: `false`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
vendorType	string	Vendor Type Enum: `"IMPORT"`, `"NA"`, `"SEZ_W_PAY"`, `"SEZ_WO_PAY"` Example: `"NA"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderIndonesiaRequest

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
contact	ContactInfo	Contact info details	Yes
creditable	string	True if Purchase Order is creditable Example: `true`	No
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemIndonesiaDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderIndonesiaResponse

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
billed	boolean	Purchase order billed Example: `false`	No
contact	ContactInfo	Contact info details	Yes
contactDto	ContactDto	Contact Details	No
creditable	string	True if Purchase Order is creditable Example: `true`	No
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	Purchase order drafted Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
id	long	Purchase order id Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedPurchaseInvoices	[ LinkedPurchaseInvoiceResponse ]		No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
pendingReceipt	boolean	Purchase order pending receipt Example: `false`	No
poCode	string	Purchase order code Example: `"PO0001"`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemIndonesiaDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
recurring	boolean	True if Order is recurring. Example: `true`	No
recurringActivated	boolean	True if Order recurrence is active. Example: `false`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderInformation

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase invoice additional charges details	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
billed	boolean	Purchase order billed Example: `false`	No
closedDate	string	Closed date Example: `"01-10-2019"`	Yes
contact	ContactInfo	Contact info details	Yes
contactDto	ContactInformation	Contact Details	No
creditable	boolean	True if Purchase Order is creditable Example: `true`	No
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
customerType	string	Customer Type Enum: `"EXPORT_WO_PAY"`, `"EXPORT_W_PAY"`, `"NA"`, `"SEZ_WO_PAY"`, `"SEZ_W_PAY"` Example: `"NA"`	Yes
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	Purchase order drafted Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Due date Example: `"01-10-2019"`	Yes
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
gstin	string	Indian state from where the good/service is shipped Example: `"22AAAAAA00000AA21"`	No
id	long	Purchase order id Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedPurchaseInvoices	[ LinkedPurchaseInvoiceResponse ]		No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneDetails	[ PaymentMilestoneDetailsResponse ]	Payment milestone details	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
pendingReceipt	boolean	Purchase order pending receipt Example: `false`	No
placeOfSupply	string	Indian state from where the good/service is shipped Example: `"Delhi"`	No
poCode	string	Purchase order code Example: `"PO0001"`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemInformation ]	Purchase order item details	No
rcmApplicable	boolean	True if RCM applicable Example: `true`	No
receiptDate	string	Receipt date Example: `"01-10-2019"`	Yes
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
recurring	boolean	True if Order is recurring. Example: `true`	No
recurringActivated	boolean	True if Order recurrence is active. Example: `false`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number		No
tcsAmountInBaseCurrency	number		No
tcsPercentage	number		No
tcsRateId	long		No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
vendorType	string	Vendor Type Enum: `"IMPORT"`, `"NA"`, `"SEZ_W_PAY"`, `"SEZ_WO_PAY"` Example: `"NA"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderIsraelRequest

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
contact	ContactInfo	Contact info details	Yes
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemIsraelDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderIsraelResponse

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
billed	boolean	Purchase order billed Example: `false`	No
contact	ContactInfo	Contact info details	Yes
contactDto	ContactDto	Contact Details	No
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	Purchase order drafted Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
id	long	Purchase order id Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedPurchaseInvoices	[ LinkedPurchaseInvoiceResponse ]		No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
pendingReceipt	boolean	Purchase order pending receipt Example: `false`	No
poCode	string	Purchase order code Example: `"PO0001"`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemIsraelDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
recurring	boolean	True if Order is recurring. Example: `true`	No
recurringActivated	boolean	True if Order recurrence is active. Example: `false`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderItemAustraliaDetails

Name	Type	Description	Required
accountCode	string	Account Example: `"AC001"`	No
additionalChargeAmount	number	Example: `123`	No
additionalChargeTaxamount	number	Example: `123`	No
additionalCharges	AdditionalCharges	Purchase order item additional charges details	No
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
id	long	ID Example: `2`	No
lineNumber	integer	Line Number Example: `1`	No
otherRate	number	Tax Rate Example: `5`	No
otherTaxAmount	number	Other Tax Amount Example: `10`	No
pendingQuantity	number	Pending quantity Example: `2`	No
product	ProductResponse	Product Details Example: `"product"`	No
productCode	string	Product Example: `"P002"`	No
productDescription	string	Description Example: `"Description"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	No
purchaseOrderItemCode	string	Purchase Item Code Example: `"POI-00001"`	No
receivedQuantityInBills	number	Received quantity through bill Example: `2`	No
receivedQuantityInOrder	number	Received quantity through order Example: `2`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Unit price / Amount Example: `2`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

PurchaseOrderItemCanadaDetails

Name	Type	Description	Required
accountCode	string	Account Example: `"AC001"`	No
additionalChargeAmount	number	Example: `123`	No
additionalChargeTaxamount	number	Example: `123`	No
additionalCharges	AdditionalCharges	Purchase order item additional charges details	No
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
id	long	ID Example: `2`	No
lineNumber	integer	Line Number Example: `1`	No
otherRate	number	Tax Rate Example: `5`	No
otherTaxAmount	number	Other Tax Amount Example: `10`	No
pendingQuantity	number	Pending quantity Example: `2`	No
product	ProductResponse	Product Details Example: `"product"`	No
productCode	string	Product Example: `"P002"`	No
productDescription	string	Description Example: `"Description"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	No
purchaseOrderItemCode	string	Purchase Item Code Example: `"POI-00001"`	No
receivedQuantityInBills	number	Received quantity through bill Example: `2`	No
receivedQuantityInOrder	number	Received quantity through order Example: `2`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Unit price / Amount Example: `2`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

PurchaseOrderItemDEDetails

Name	Type	Description	Required
accountCode	string	Account Example: `"AC001"`	No
additionalChargeAmount	number	Example: `123`	No
additionalChargeTaxamount	number	Example: `123`	No
additionalCharges	AdditionalCharges	Purchase order item additional charges details	No
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
id	long	ID Example: `2`	No
lineNumber	integer	Line Number Example: `1`	No
otherRate	number	Tax Rate Example: `5`	No
otherTaxAmount	number	Other Tax Amount Example: `10`	No
pendingQuantity	number	Pending quantity Example: `2`	No
product	ProductResponse	Product Details Example: `"product"`	No
productCode	string	Product Example: `"P002"`	No
productDescription	string	Description Example: `"Description"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	No
purchaseOrderItemCode	string	Purchase Item Code Example: `"POI-00001"`	No
receivedQuantityInBills	number	Received quantity through bill Example: `2`	No
receivedQuantityInOrder	number	Received quantity through order Example: `2`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Unit price / Amount Example: `2`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

PurchaseOrderItemDetails

Name	Type	Description	Required
accountCode	string	Account Example: `"AC001"`	No
additionalChargeAmount	number	Example: `123`	No
additionalChargeTaxamount	number	Example: `123`	No
additionalCharges	AdditionalCharges	Purchase order item additional charges details	No
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
id	long	ID Example: `2`	No
lineNumber	integer	Line Number Example: `1`	No
otherRate	number	Tax Rate Example: `5`	No
otherTaxAmount	number	Other Tax Amount Example: `10`	No
pendingQuantity	number	Pending quantity Example: `2`	No
product	ProductResponse	Product Details Example: `"product"`	No
productCode	string	Product Example: `"P002"`	No
productDescription	string	Description Example: `"Description"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	No
purchaseOrderItemCode	string	Purchase Item Code Example: `"POI-00001"`	No
receivedQuantityInBills	number	Received quantity through bill Example: `2`	No
receivedQuantityInOrder	number	Received quantity through order Example: `2`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Unit price / Amount Example: `2`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

PurchaseOrderItemIndiaDetails

Name	Type	Description	Required
accountCode	string	Account Example: `"AC001"`	No
additionalChargeAmount	number	Example: `123`	No
additionalChargeTaxamount	number	Example: `123`	No
additionalCharges	AdditionalCharges	Purchase order item additional charges details	No
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
cessAmount	number	India specific CESS amount on total amount Example: `0`	No
cessPercentage	number	Cess Percentage Example: `2.322`	No
cessRule	string	Cess Rule if it applies to the item Example: `"Math.max(21amount/100,4170quantity/100)"`	No
cgstAmount	number	India specific CGST tax amount on total amount Example: `5`	No
cgstRate	number	India specific CGST rate Example: `5`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
hsnOrSacCode	string	Hsn or Sac code Example: `110011`	No
id	long	ID Example: `2`	No
igstAmount	number	India specific IGST tax amount on total amount Example: `5`	No
igstRate	number	India specific IGST rate Example: `5`	No
itcIneligibleType	string	Ineligible - as per Section 17(5) Enum: `"ITC_INELIGIBLE_SECTION_17"`, `"ITC_INELIGIBLE_OTHERS"` Example: `"ITC_INELIGIBLE_SECTION_17"`	No
lineNumber	integer	Line Number Example: `1`	No
otherRate	number	Tax Rate Example: `5`	No
otherTaxAmount	number	Other Tax Amount Example: `10`	No
pendingQuantity	number	Pending quantity Example: `2`	No
product	ProductResponse	Product Details Example: `"product"`	No
productCode	string	Product Example: `"P002"`	No
productDescription	string	Description Example: `"Description"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	No
purchaseOrderItemCode	string	Purchase Item Code Example: `"POI-00001"`	No
receivedQuantityInBills	number	Received quantity through bill Example: `2`	No
receivedQuantityInOrder	number	Received quantity through order Example: `2`	No
sgstAmount	number	India specific SGST tax amount on total amount Example: `5`	No
sgstRate	number	India specific SGST rate Example: `5`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
taxExemptionReason	string	Tax Exemption reason if taxPreference is true Enum: `"EXEMPTED"`, `"NON_GST"` Example: `"EXEMPTED"`	No
taxPreference	boolean	Tax preference, whether Exempted or not Exempted Example: `false`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Unit price / Amount Example: `2`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes
userSetTaxes	boolean	Flag to check whether tax is user edited Example: `false`	No

PurchaseOrderItemIndonesiaDetails

Name	Type	Description	Required
accountCode	string	Account Example: `"AC001"`	No
additionalChargeAmount	number	Example: `123`	No
additionalChargeTaxamount	number	Example: `123`	No
additionalCharges	AdditionalCharges	Purchase order item additional charges details	No
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
exciseAmount	number	Excise amount Example: `0.5`	No
exciseRate	double	Rate of Excise Example: `5`	No
exciseType	string	Excise type Enum: `"PERCENT"`, `"FLAT"` Example: `"FLAT"`	No
id	long	ID Example: `2`	No
lineNumber	integer	Line Number Example: `1`	No
otherRate	number	Tax Rate Example: `5`	No
otherTaxAmount	number	Other Tax Amount Example: `10`	No
pendingQuantity	number	Pending quantity Example: `2`	No
product	ProductResponse	Product Details Example: `"product"`	No
productCode	string	Product Example: `"P002"`	No
productDescription	string	Description Example: `"Description"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	No
purchaseOrderItemCode	string	Purchase Item Code Example: `"POI-00001"`	No
receivedQuantityInBills	number	Received quantity through bill Example: `2`	No
receivedQuantityInOrder	number	Received quantity through order Example: `2`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Unit price / Amount Example: `2`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

PurchaseOrderItemInfo

Name	Type	Description	Required
additionalCharges	AdditionalCharges		No
discount	number	Total Discount Example: `20`	No
discountInPercent	boolean		No
documentItemCode	string		No
productCode	string	Product Example: `"P-000002"`	No
quantity	number	Quantity Example: `2`	No
taxAmount	number		No
unitPrice	number	Unit price / Amount Example: `100`	No

PurchaseOrderItemInformation

Name	Type	Description	Required
accountCode	string	Account Example: `"AC001"`	No
additionalCharges	AdditionalCharges	Purchase order item additional charges details	No
cessAmount	number	India specific CESS amount on total amount Example: `0`	No
cessPercentage	number	Cess Percentage Example: `2.322`	No
cessRule	string	Cess Rule if it applies to the item Example: `"Math.max(21amount/100,4170quantity/100)"`	No
cgstAmount	number	India specific CGST tax amount on total amount Example: `5`	No
cgstRate	number	India specific CGST rate Example: `5`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
exciseAmount	number	Excise amount Example: `0.5`	No
exciseRate	double	Rate of Excise Example: `5`	No
exciseType	string	Excise type Enum: `"PERCENT"`, `"FLAT"` Example: `"FLAT"`	No
hsnOrSacCode	string	Hsn or Sac code Example: `110011`	No
id	long	ID Example: `2`	No
igstAmount	number	India specific IGST tax amount on total amount Example: `5`	No
igstRate	number	India specific IGST rate Example: `5`	No
itcIneligibleType	string	Ineligible - as per Section 17(5) Enum: `"ITC_INELIGIBLE_SECTION_17"`, `"ITC_INELIGIBLE_OTHERS"` Example: `"ITC_INELIGIBLE_SECTION_17"`	No
lineNumber	integer	Line Number Example: `1`	No
otherRate	number	Tax Rate Example: `5`	No
otherTaxAmount	number	Other Tax Amount Example: `10`	No
pendingAmount	number	Pending amount Example: `100`	No
pendingQuantity	number	Pending quantity Example: `2`	No
product	ProductInformation	Product Details Example: `"product"`	No
productCode	string	Product Example: `"P002"`	No
productDescription	string	Description Example: `"Description"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	No
purchaseOrderItemCode	string	Purchase Item Code Example: `"POI-00001"`	No
receivedQuantityInBills	number	Received quantity through bill Example: `2`	No
receivedQuantityInOrder	number	Received quantity through order Example: `2`	No
sgstAmount	number	India specific SGST tax amount on total amount Example: `5`	No
sgstRate	number	India specific SGST rate Example: `5`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
taxDetails	[ DocumentItemTaxMappingDto ]	Tax Details for Tax Group	No
taxExemptionReason	string	Tax Exemption reason if taxPreference is true Enum: `"EXEMPTED"`, `"NON_GST"` Example: `"EXEMPTED"`	No
taxPreference	boolean	Tax preference, whether Exempted or not Exempted Example: `false`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Unit price / Amount Example: `2`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes
userSetTaxes	boolean	Flag to check whether tax is user edited Example: `false`	No

PurchaseOrderItemIsraelDetails

Name	Type	Description	Required
accountCode	string	Account Example: `"AC001"`	No
additionalChargeAmount	number	Example: `123`	No
additionalChargeTaxamount	number	Example: `123`	No
additionalCharges	AdditionalCharges	Purchase order item additional charges details	No
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
id	long	ID Example: `2`	No
lineNumber	integer	Line Number Example: `1`	No
otherRate	number	Tax Rate Example: `5`	No
otherTaxAmount	number	Other Tax Amount Example: `10`	No
pendingQuantity	number	Pending quantity Example: `2`	No
product	ProductResponse	Product Details Example: `"product"`	No
productCode	string	Product Example: `"P002"`	No
productDescription	string	Description Example: `"Description"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	No
purchaseOrderItemCode	string	Purchase Item Code Example: `"POI-00001"`	No
receivedQuantityInBills	number	Received quantity through bill Example: `2`	No
receivedQuantityInOrder	number	Received quantity through order Example: `2`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Unit price / Amount Example: `2`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

PurchaseOrderItemMalaysiaDetails

Name	Type	Description	Required
accountCode	string	Account Example: `"AC001"`	No
additionalChargeAmount	number	Example: `123`	No
additionalChargeTaxamount	number	Example: `123`	No
additionalCharges	AdditionalCharges	Purchase order item additional charges details	No
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
id	long	ID Example: `2`	No
lineNumber	integer	Line Number Example: `1`	No
otherRate	number	Tax Rate Example: `5`	No
otherTaxAmount	number	Other Tax Amount Example: `10`	No
pendingQuantity	number	Pending quantity Example: `2`	No
product	ProductResponse	Product Details Example: `"product"`	No
productCode	string	Product Example: `"P002"`	No
productDescription	string	Description Example: `"Description"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	No
purchaseOrderItemCode	string	Purchase Item Code Example: `"POI-00001"`	No
receivedQuantityInBills	number	Received quantity through bill Example: `2`	No
receivedQuantityInOrder	number	Received quantity through order Example: `2`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Unit price / Amount Example: `2`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

PurchaseOrderItemPhilippinesDetails

Name	Type	Description	Required
accountCode	string	Account Example: `"AC001"`	No
additionalChargeAmount	number	Example: `123`	No
additionalChargeTaxamount	number	Example: `123`	No
additionalCharges	AdditionalCharges	Purchase order item additional charges details	No
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
id	long	ID Example: `2`	No
lineNumber	integer	Line Number Example: `1`	No
otherRate	number	Tax Rate Example: `5`	No
otherTaxAmount	number	Other Tax Amount Example: `10`	No
pendingQuantity	number	Pending quantity Example: `2`	No
product	ProductResponse	Product Details Example: `"product"`	No
productCode	string	Product Example: `"P002"`	No
productDescription	string	Description Example: `"Description"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	No
purchaseOrderItemCode	string	Purchase Item Code Example: `"POI-00001"`	No
receivedQuantityInBills	number	Received quantity through bill Example: `2`	No
receivedQuantityInOrder	number	Received quantity through order Example: `2`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Unit price / Amount Example: `2`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

PurchaseOrderItemSaudiArabiaDetails

Name	Type	Description	Required
accountCode	string	Account Example: `"AC001"`	No
additionalChargeAmount	number	Example: `123`	No
additionalChargeTaxamount	number	Example: `123`	No
additionalCharges	AdditionalCharges	Purchase order item additional charges details	No
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
customRateSA	number	Custom tax rate for Saudi Example: `5`	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
id	long	ID Example: `2`	No
lineNumber	integer	Line Number Example: `1`	No
otherRate	number	Tax Rate Example: `5`	No
otherTaxAmount	number	Other Tax Amount Example: `10`	No
pendingQuantity	number	Pending quantity Example: `2`	No
product	ProductResponse	Product Details Example: `"product"`	No
productCode	string	Product Example: `"P002"`	No
productDescription	string	Description Example: `"Description"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	No
purchaseOrderItemCode	string	Purchase Item Code Example: `"POI-00001"`	No
rcmRateSA	number	RCM tax rate for Saudi Example: `5`	No
receivedQuantityInBills	number	Received quantity through bill Example: `2`	No
receivedQuantityInOrder	number	Received quantity through order Example: `2`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Unit price / Amount Example: `2`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

PurchaseOrderItemUKDetails

Name	Type	Description	Required
accountCode	string	Account Example: `"AC001"`	No
additionalChargeAmount	number	Example: `123`	No
additionalChargeTaxamount	number	Example: `123`	No
additionalCharges	AdditionalCharges	Purchase order item additional charges details	No
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
id	long	ID Example: `2`	No
lineNumber	integer	Line Number Example: `1`	No
otherRate	number	Tax Rate Example: `5`	No
otherTaxAmount	number	Other Tax Amount Example: `10`	No
pendingQuantity	number	Pending quantity Example: `2`	No
product	ProductResponse	Product Details Example: `"product"`	No
productCode	string	Product Example: `"P002"`	No
productDescription	string	Description Example: `"Description"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	No
purchaseOrderItemCode	string	Purchase Item Code Example: `"POI-00001"`	No
receivedQuantityInBills	number	Received quantity through bill Example: `2`	No
receivedQuantityInOrder	number	Received quantity through order Example: `2`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Unit price / Amount Example: `2`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

PurchaseOrderItemUaeDetails

Name	Type	Description	Required
accountCode	string	Account Example: `"AC001"`	No
additionalChargeAmount	number	Example: `123`	No
additionalChargeTaxamount	number	Example: `123`	No
additionalCharges	AdditionalCharges	Purchase order item additional charges details	No
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
id	long	ID Example: `2`	No
lineNumber	integer	Line Number Example: `1`	No
otherRate	number	Tax Rate Example: `5`	No
otherTaxAmount	number	Other Tax Amount Example: `10`	No
pendingQuantity	number	Pending quantity Example: `2`	No
product	ProductResponse	Product Details Example: `"product"`	No
productCode	string	Product Example: `"P002"`	No
productDescription	string	Description Example: `"Description"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	No
purchaseOrderItemCode	string	Purchase Item Code Example: `"POI-00001"`	No
receivedQuantityInBills	number	Received quantity through bill Example: `2`	No
receivedQuantityInOrder	number	Received quantity through order Example: `2`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Unit price / Amount Example: `2`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

PurchaseOrderMalaysiaRequest

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
contact	ContactInfo	Contact info details	Yes
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemMalaysiaDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderMalaysiaResponse

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
billed	boolean	Purchase order billed Example: `false`	No
contact	ContactInfo	Contact info details	Yes
contactDto	ContactDto	Contact Details	No
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	Purchase order drafted Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
id	long	Purchase order id Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedPurchaseInvoices	[ LinkedPurchaseInvoiceResponse ]		No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
pendingReceipt	boolean	Purchase order pending receipt Example: `false`	No
poCode	string	Purchase order code Example: `"PO0001"`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemMalaysiaDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
recurring	boolean	True if Order is recurring. Example: `true`	No
recurringActivated	boolean	True if Order recurrence is active. Example: `false`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderPhilippinesRequest

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
contact	ContactInfo	Contact info details	Yes
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemPhilippinesDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderPhilippinesResponse

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
billed	boolean	Purchase order billed Example: `false`	No
contact	ContactInfo	Contact info details	Yes
contactDto	ContactDto	Contact Details	No
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	Purchase order drafted Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
id	long	Purchase order id Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedPurchaseInvoices	[ LinkedPurchaseInvoiceResponse ]		No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
pendingReceipt	boolean	Purchase order pending receipt Example: `false`	No
poCode	string	Purchase order code Example: `"PO0001"`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemPhilippinesDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
recurring	boolean	True if Order is recurring. Example: `true`	No
recurringActivated	boolean	True if Order recurrence is active. Example: `false`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderRequest

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
contact	ContactInfo	Contact info details	Yes
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderResponse

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
billed	boolean	Purchase order billed Example: `false`	No
contact	ContactInfo	Contact info details	Yes
contactDto	ContactDto	Contact Details	No
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	Purchase order drafted Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
id	long	Purchase order id Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedPurchaseInvoices	[ LinkedPurchaseInvoiceResponse ]		No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
pendingReceipt	boolean	Purchase order pending receipt Example: `false`	No
poCode	string	Purchase order code Example: `"PO0001"`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
recurring	boolean	True if Order is recurring. Example: `true`	No
recurringActivated	boolean	True if Order recurrence is active. Example: `false`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderSaudiArabiaRequest

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
contact	ContactInfo	Contact info details	Yes
currencyCode	string	Currency Example: `"C001"`	Yes
customApplicableSA	boolean	True if RCM applicable Example: `true`	No
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemSaudiArabiaDetails ]	Purchase order item details	No
rcmApplicableSA	boolean	True if RCM applicable Example: `true`	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderSaudiArabiaResponse

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
billed	boolean	Purchase order billed Example: `false`	No
contact	ContactInfo	Contact info details	Yes
contactDto	ContactDto	Contact Details	No
currencyCode	string	Currency Example: `"C001"`	Yes
customApplicableSA	boolean	True if custom applicable Example: `true`	No
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	Purchase order drafted Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
id	long	Purchase order id Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedPurchaseInvoices	[ LinkedPurchaseInvoiceResponse ]		No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
pendingReceipt	boolean	Purchase order pending receipt Example: `false`	No
poCode	string	Purchase order code Example: `"PO0001"`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemSaudiArabiaDetails ]	Purchase order item details	No
rcmApplicableSA	boolean	True if RCM applicable Example: `true`	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
recurring	boolean	True if Order is recurring. Example: `true`	No
recurringActivated	boolean	True if Order recurrence is active. Example: `false`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderShortResponse

Name	Type	Description	Required
additionalCharges	AdditionalCharges		No
documentSequenceCode	string	Purchase Order Document Sequence Code Example: `"00O0001"`	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
poCode	string	Purchase order code Example: `"PO0001"`	No
purchaseOrderItemInfos	[ PurchaseOrderItemInfo ]		No
unitPriceGstInclusive	boolean		No

PurchaseOrderUKRequest

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
contact	ContactInfo	Contact info details	Yes
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemUKDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderUKResponse

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
billed	boolean	Purchase order billed Example: `false`	No
contact	ContactInfo	Contact info details	Yes
contactDto	ContactDto	Contact Details	No
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	Purchase order drafted Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
id	long	Purchase order id Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedPurchaseInvoices	[ LinkedPurchaseInvoiceResponse ]		No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
pendingReceipt	boolean	Purchase order pending receipt Example: `false`	No
poCode	string	Purchase order code Example: `"PO0001"`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemUKDetails ]	Purchase order item details	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
recurring	boolean	True if Order is recurring. Example: `true`	No
recurringActivated	boolean	True if Order recurrence is active. Example: `false`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderUaeRequest

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
contact	ContactInfo	Contact info details	Yes
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemUaeDetails ]	Purchase order item details	No
rcmApplicable	boolean	True if RCM applicable Example: `true`	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseOrderUaeResponse

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase order additional charges details	No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
attachments	[ string ]	File attachments	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if purchase order is backorder Example: `true`	No
billTo	Address	Bill to Address	No
billed	boolean	Purchase order billed Example: `false`	No
contact	ContactInfo	Contact info details	Yes
contactDto	ContactDto	Contact Details	No
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
deliveryDate	string	Delivery date Example: `"01-10-2019"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
draft	boolean	Purchase order drafted Example: `false`	No
dropShip	boolean	Drop Ship flag to indicate if purchase order is created for drop ship Example: `true`	No
dueDate	string	Document date Example: `"01-10-2019"`	Yes
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
id	long	Purchase order id Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedPurchaseInvoices	[ LinkedPurchaseInvoiceResponse ]		No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
orderType	string	Order Type Enum: `"INVENTORY"`, `"EXPENSE"` Example: `"Inventory"`	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: `true`	No
pendingReceipt	boolean	Purchase order pending receipt Example: `false`	No
poCode	string	Purchase order code Example: `"PO0001"`	No
purchaseOrderAssets	[ PurchaseOrderAssetGroupDetails ]		No
purchaseOrderItems	[ PurchaseOrderItemUaeDetails ]	Purchase order item details	No
rcmApplicable	boolean	True if RCM applicable Example: `true`	No
receiptStatus	string	Received status for the Goods Enum: `"UNRECEIVED"`, `"PARTIAL_RECEIVED"`, `"FULLY_RECEIVED"`, `"NOT_APPLICABLE"` Example: `"FULLY_RECEIVED"`	No
receiveByDate	dateTime	Receive by date Example: `"25-10-2019"`	No
recurring	boolean	True if Order is recurring. Example: `true`	No
recurringActivated	boolean	True if Order recurrence is active. Example: `false`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Order status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"`, `"PARTIAL_PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number	TCS amount Example: `2.322`	No
tcsPercentage	number	TCS percentage Example: `2`	No
tcsRateId	long	TCS Rate Id Example: `1`	No
totalAmount	number	Total amount Example: `123.33`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No
vendorCode	string	Vendor Example: `"V001"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	Yes

PurchaseRequestRequest

Name	Type	Description	Required
approvalStatus	string	Approve Status Example: `"PENDING"`	No
attachmentIds	[ integer ]		No
attachments	[ string ]	File attachments	No
billTo	Address	Bill to address	No
currency	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
documentSequenceCode	string	Sales Order Code Example: `"0000001"`	No
draftReferenceId	string	Draft reference id	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
memo	string	Memo Example: `"Note this"`	No
purchaseRequestDate	string	Purchase Request date Example: `"25-10-2019"`	Yes
purchaseRequestItems	[ AbstractPurchaseRequestItemDetails ]	Purchase Request item details	No
receiveByDate	string	Receive by date Example: `"25-10-2019"`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipByDate	string	Ship by date Example: `"25-10-2019"`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
taxAmount	number	Tax amount Example: `2.322`	No
taxAmountInBaseCurrency	number	Tax amount in base currency Example: `2.322`	No
totalAmount	number	Total amount Example: `12.322`	No
totalAmountInBaseCurrency	number	Total amount in base currency Example: `12.322`	No
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No

PurchaseRequestResponse

Name	Type	Description	Required
approvalStatus	string	Approve Status Example: `"PENDING"`	No
attachmentIds	[ integer ]		No
attachments	[ string ]	File attachments	No
billTo	Address	Bill to address	No
contact	ContactInfo	Contact details	Yes
contactCode	string	Contact Code Example: `"C0001"`	Yes
createdBy	long	ID of the user who created Example: `1`	No
currency	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
documentSequenceCode	string	Sales Order Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
draftReferenceId	string	Draft reference id	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
id	long	Purchase Request id Example: `1`	No
linkedPurchaseOrders	[ LinkedPurchaseOrderResponse ]	Linked Purchase Order details	No
memo	string	Sample memo Example: `"Sample memo"`	No
purchaseRequestCode	string	Purchase Request code Example: `"PRQ001"`	No
purchaseRequestDate	string	Purchase Request date Example: `"25-10-2019"`	Yes
purchaseRequestItems	[ AbstractPurchaseRequestItemDetails ]	Purchase Request item details	No
receiveByDate	string	Receive by date Example: `"25-10-2019"`	No
shipByDate	string	Ship by date Example: `"25-10-2019"`	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
taxAmount	number	Tax amount Example: `2.322`	No
taxAmountInBaseCurrency	number	Tax amount in base currency Example: `2.322`	No
totalAmount	number	Total amount Example: `12.322`	No
totalAmountInBaseCurrency	number	Total amount in base currency Example: `12.322`	No
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No

RecurringJobEvent

Name	Type	Description	Required
customTemplate	boolean		No
documentDate	dateTime		No
documentType	string	Enum: `"QUOTATION"`, `"PURCHASE_ORDER"`, `"SALES_ORDER"`, `"PURCHASE_INVOICE"`, `"SALES_INVOICE"`, `"MAKE_PAYMENT"`, `"RECEIVE_PAYMENT"`, `"JOURNAL_ENTRY"`, `"BANK_TRANSFER"`, `"CREDIT_NOTE"`, `"DEBIT_NOTE"`, `"EXPENSE"`, `"EXPENSE_PREPAYMENT"`, `"DEPOSIT"`, `"DEPOSIT_ADVPAYMENT"`, `"CONTRA_ADJUSTMENT"`, `"GOODS_RECEIPT"`, `"FULFILLMENT"`, `"PICKLIST"`, `"PACKLIST"`, `"SHIPLIST"`, `"PAYSLIP"`, `"PAYROLL_CHECK"`, `"CHEQUE"`, `"SALES_RETURN"`, `"PURCHASE_RETURN"`, `"STOCK_ADJUSTMENT"`, `"STOCK_TRANSFER"`, `"WORK_ORDER"`, `"FIXED_ASSET"`, `"E_WAY_BILL_SUMMARY"`, `"E_WAY_BILL_DETAIL"`, `"PURCHASE_REQUEST"`, `"JOB_WORK_OUT_ORDER"`, `"JOB_WORK_OUT_TRANSFER"`, `"QC_DOCUMENT"`, `"WIP_PRODUCTION"`, `"STOCK_REQUEST"`, `"STOCK_ISSUE"`, `"FORECAST"`	No
emailBody	string		No
emailReplyTo	string		No
emailSenderName	string		No
emailSubject	string		No
emailTemplateId	long		No
emailTo	string		No
iamUserId	long		No
insertPaymentLinkFlag	boolean		No
jobId	long		No
parentDocumentCode	string		No
sendEmailNotificationFlag	boolean		No
tenantId	long		No
userId	long		No

RowRackBinData

Name	Type	Description	Required
binId	long	Row Id Example: `1`	Yes
binName	string	Row Name Example: `"Row1"`	Yes
rackId	long	Row Id Example: `1`	Yes
rackName	string	Row Name Example: `"Row1"`	Yes
rowId	long	Row Id Example: `1`	Yes
rowName	string	Row Name Example: `"Row1"`	Yes

SalesOrderDashboardReport

Name	Type	Required
data	[ MonthData ]	No
noOfOpenQuotations	integer	No
noOfSalesOrdersCurrentMonth	integer	No
noOfSoUnfulfilledCurrentMonth	integer	No
salesInCurrentMonth	number	No

SalesOrderItemDetails

Name	Type	Description	Required
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: `2`	No
discountInPercent	boolean	Discount in percentage Example: `true`	No
id	long	ID Example: `2`	No
productCode	string	Product code Example: `"P001"`	Yes
productDescription	string	Product description Example: `"Apple watch"`	No
productOrder	integer	Product view order Example: `1`	No
productQuantity	number	Product quantity Example: `2`	Yes
taxAmount	number	Tax amount Example: `0.5`	No
taxCode	string	Tax code Example: `"GST7"`	No
totalAmount	number	Total amount Example: `2.3`	Yes
unitPrice	number	Product unit price Example: `0.7`	Yes

SalesOrderRequest

Name	Type	Description	Required
attachments	[ string ]	File attachments	No
contact	ContactInfo	Contact info details	Yes
contactCode	string	Contact code Example: `"C002"`	Yes
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
customerPoRefNo	string	Customer PO reference number Example: `"CPO001"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
draft	boolean	True if want to save as draft. Example: `false`	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
fulfillmentDate	string	Fulfillment date Example: `"25-10-2019"`	Yes
linkedDocuments	[ DocumentInfo ]	Linked document number	No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
salesOrderItems	[ SalesOrderItemDetails ]	Sales order item details	No
totalAmount	number	Total amount Example: `12.322`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No

SalesOrderResponse

Name	Type	Description	Required
attachments	[ string ]	File attachments	No
billed	boolean	Sales order billed Example: `false`	No
contact	ContactInfo	Contact info details	Yes
contactCode	string	Contact code Example: `"C002"`	Yes
currencyCode	string	Currency Example: `"C001"`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
customerPoRefNo	string	Customer PO reference number Example: `"CPO001"`	No
documentDate	string	Document date Example: `"01-10-2019"`	Yes
draft	boolean	Sales order drafted Example: `false`	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
fulfilled	boolean	Sales order fulfilled Example: `false`	No
fulfillmentDate	string	Fulfillment date Example: `"25-10-2019"`	Yes
id	long	Sales order id Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document number	No
memo	string	Memo Example: `"Memo details"`	No
openingOrder	boolean		No
salesOrderItems	[ SalesOrderItemDetails ]	Sales order item details	No
soCode	string	Sales order code Example: `"SO001"`	No
totalAmount	number	Total amount Example: `12.322`	Yes
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: `false`	No

SendEmailRequest

Name	Type	Description	Required
application	string	Application name Example: `"ERP"`	No
bcc	string	bcc email addresses Example: `"john1@doe.com,john2@doe.com"`	No
body	string	email body Example: `"This is a invite email"`	No
category	string	Module Name Example: `"ORDER"`	No
cc	string	cc email addresses Example: `"john1@doe.com,john2@doe.com"`	No
exportDocumentRequest	ExportDocumentRequest	Application name Example: `"ERP"`	No
isEncoded	boolean	Is email body encoded Example: `false`	No
replyTo	string	Reply to email address Example: `"john@doe.com"`	No
senderName	string	Sender's name Example: `"Sender Name"`	No
subject	string	subject line Example: `"Order Email"`	No
to	string	to email address Example: `"john@doe.com"`	No

SendOrderEmailDto

Name	Type	Description	Required
contactCode	string		No
isSendPaymentLink	boolean	Send stripe payment link Example: `true`	No
orderRequest	OrderRequestDto	config for stripe payment link Example: `"Get Payment Link Config"`	No
saveContact	boolean		No
sendEmailRequest	SendEmailRequest	Send email config Example: `"Send email config"`	No

SetRecurringDto

Name	Type	Description	Required
documentCode	string		No
documentType	string	Enum: `"QUOTATION"`, `"PURCHASE_ORDER"`, `"SALES_ORDER"`, `"PURCHASE_INVOICE"`, `"SALES_INVOICE"`, `"MAKE_PAYMENT"`, `"RECEIVE_PAYMENT"`, `"JOURNAL_ENTRY"`, `"BANK_TRANSFER"`, `"CREDIT_NOTE"`, `"DEBIT_NOTE"`, `"EXPENSE"`, `"EXPENSE_PREPAYMENT"`, `"DEPOSIT"`, `"DEPOSIT_ADVPAYMENT"`, `"CONTRA_ADJUSTMENT"`, `"GOODS_RECEIPT"`, `"FULFILLMENT"`, `"PICKLIST"`, `"PACKLIST"`, `"SHIPLIST"`, `"PAYSLIP"`, `"PAYROLL_CHECK"`, `"CHEQUE"`, `"SALES_RETURN"`, `"PURCHASE_RETURN"`, `"STOCK_ADJUSTMENT"`, `"STOCK_TRANSFER"`, `"WORK_ORDER"`, `"FIXED_ASSET"`, `"E_WAY_BILL_SUMMARY"`, `"E_WAY_BILL_DETAIL"`, `"PURCHASE_REQUEST"`, `"JOB_WORK_OUT_ORDER"`, `"JOB_WORK_OUT_TRANSFER"`, `"QC_DOCUMENT"`, `"WIP_PRODUCTION"`, `"STOCK_REQUEST"`, `"STOCK_ISSUE"`, `"FORECAST"`	No
recurring	boolean		No
recurringActivated	boolean		No

Sort

Name	Type	Required
empty	boolean	No
sorted	boolean	No
unsorted	boolean	No

StockQuantitiesRequest

Name	Type	Required
productVariantCodes	[ string ]	No
status	[ string ]	No
warehouseCode	string	No

StockQuantitiesResponse

Name	Type	Description	Required
productStockInfo	[ ProductStockInfo ]		No

TaxDto

Name	Type	Description	Required
accountCode	string	Account code Example: `"AC-001"`	No
additionalTaxIn	boolean	TRUE/FALSE Example: `false`	No
basReporting	string	Reporting Method Example: `"BOTH"`	No
code	string	Tax code Example: `"TC-001"`	No
defaultMemoBE	string	Default memo Example: `"Memo"`	No
defaultMemoDe	string	Default Memo Germany Example: `"memo"`	No
defaultMemoNL	string	Default memo Example: `"Momo"`	No
defaultMemoUk	string	Default Memo UK Example: `"memo"`	No
deleted	boolean	Tax deleted Example: `false`	No
description	string	Description Example: `"sales Tax for SG"`	No
effectiveEndDate	dateTime	Effective end date of the tax Example: `"2023-12-31"`	No
effectiveStartDate	dateTime	Effective start date of the tax Example: `"2023-01-01"`	No
flatRateSchemeUk	boolean	Flat Rate Scheme UK Example: `false`	No
isDefault	boolean	Is Default Tax Example: `false`	No
isTaxGroup	boolean	Is Tax Group Example: `false`	No
name	string	Tax Name Example: `"SGST"`	No
netAmountBefore	string	Net Amount Before Section Example: `"Box 5,Box 6"`	No
netAmountBeforeBE	string	Net Amount Before Section Example: `"Box 00,Box 01"`	No
netAmountBeforeNL	string	Net Amount Before Section Example: `"Box 5,Box 6"`	No
netAmountDe	string		No
netAmountUk	string	Net Amount Before Section Example: `"Box 5,Box 6"`	No
percent	number	Tax percentage Example: `7`	No
showInReportsID	boolean	Flag to consider in reports Example: `true`	No
status	string	Tax status Example: `"active"`	No
taxAccountCode	string	Account Code Example: `"ACC-0000001"`	No
taxAgencyCan	string	Example: `"British Columbia"`	No
taxAmountDe	string	Tax Amount In Section Example: `"Box 5,Box 6"`	No
taxAmountIn	string	Tax Amount In Section Example: `"Box 5,Box 6"`	No
taxAmountInBE	string	Tax Amount In Section Example: `"Box 54,Box 55"`	No
taxAmountInNL	string	Tax Amount In Section Example: `"Box 5,Box 6"`	No
taxAmountUk	string	Tax Amount In Section Example: `"Box 5,Box 6"`	No
taxCode	string	Tax code Example: `"TC-001"`	No
taxGroupDetails	[ TaxGroupDetails ]	Tax Details	No
taxSectionAus	string	Tax Section Enum: `"DEFAULT_GST=Default GST"`, `"EXPORT_SALES=Export Sales"`, `"OTHER_GST=Other GST-free sales"`, `"INPUT_TAX_SALES=Input Taxed Sales"`, `"CAPITAL_PURCHASES=Capital purchases"`, `"NONCAPITAL_PURCHASES=Non-capital purchases"`, `"INPUT_TAX_PURCHASES=Input Tax Purchases"`, `"EXCLUDED_FROM_BAS=Excluded from BAS"` Example: `"DEFAULT_GST"`	No
taxSectionSAR	string	Tax Section Name Example: `"Standard rates sales, Standard rated domestic purchase"`	No
type	string	SALES Enum: `"SALES"`, `"PURCHASE"`, `"BOTH"` Example: `"SALES"`	No

TaxGroupDetails

Name	Type	Required
additionalTaxIn	boolean	No
applyTo	string	No
code	string	No
id	long	No
name	string	No
percentage	number	No
type	string	No

TdsInfoIndia

Name	Type	Required
assessableAmount	number	No
deducteeType	string	No
incomePayment	string	No
lineAmount	number	No
payableAccount	string	No
remark	string	No
tdsAmount	number	No
tdsRate	number	No

TriggerKafkaRequestDto

Name	Type	Required
approvalHistory	[ ApprovalHistoryItem ]	No
approverMap	object	No
contactCode	string	No
currency	string	No
currentLevel	integer	No
totalAmount	string	No
userName	string	No

UOMDto

Name	Type	Description	Required
active	boolean	Is active or not Example: `true`	No
deleted	boolean	Is deleted or not Example: `false`	No
description	string	UOM description Example: `"UOM to measure weight"`	No
id	long	UOM Id Example: `1`	No
isSystemGenerated	boolean	Flag to specify if the UOM is system or user generated Example: `false`	No
name	string	UOM name Example: `"LB"`	No
tenantId	long	Tenant Id Example: `1233`	No

UOMSchemaDefinitionDto

Name	Type	Description	Required
sinkConversionFactor	number	10 Example: `10`	No
sinkUOM	long	2 Example: `2`	No
sourceConversionFactor	number	1 Example: `1`	No
sourceUOM	long	4 Example: `4`	No
uid	string (uuid)	UOM Schema Definition Id Example: `1`	No

UOMSchemaDto

Name	Type	Description	Required
active	boolean	Is active or not Example: `true`	No
baseUOM	UOMDto	Base UOM Example: `"LB"`	No
id	long	UOM Id Example: `1`	No
name	string	UOM name Example: `"LB"`	No
uomSchemaDefinitions	[ UOMSchemaDefinitionDto ]	UOM schema definitions	No

WarehouseInventoryData

Name	Type	Description	Required
advancedTrackingData	[ AdvancedTrackingBOMDto ]	Advanced tracking to fulfil list	No
binCode	string	bin code Example: `"BIN-00001"`	Yes
binName	string	bin name Example: `"BIN-00001"`	No
id	long	Id Example: `1`	No
quantity	number	Warehouse Code Example: `1`	No
rackCode	string	Rack code Example: `"RACK-00001"`	Yes
rackName	string	Rack name Example: `"RACK-00001"`	No
rowCode	string	Row code Example: `"ROW-00001"`	Yes
rowName	string	Row Nane Example: `"ROW-00001"`	No
warehouseCode	string	Warehouse Code Example: `"WH-0000001"`	No
warehouseName	string	Warehouse Name Example: `"Warehouse name"`	No

Year

Name	Type	Description	Required
leap	boolean		No
value	integer		No

API
- Search Order
- Create Purchase Order
- Update Order
- Retrieve Order
- Delete Purchase Order
job-work-out-order-controller
- Orders jobworkout
- Orders jobworkout/bulk-details
- Orders jobworkout/code/{code}/details
- Orders jobworkout/code/{code}/detailsbyworkorder
- Orders jobworkout/linked-docs/product-codes
- Orders jobworkout/product-used-bom-codes
- Orders jobworkout/status/{code}
- Orders jobworkout/{code}
- Orders jobworkout/{id}
job-work-out-order-india-controller
- Orders jobworkout/in
- Orders jobworkout/in/{code}
- Orders jobworkout/in/{id}
purchase-order-controller
- Orders purchase/approval-status
- Orders purchase/asset-group-count/{id}
- Delete Purchase Order in Bulk
- Get Purchase Order Details in Bulk
- Orders purchase/bulk-details-by-seq
- Orders purchase/bulk-email
- Orders purchase/bulk-update
- Retrieve Order
- Orders purchase/create-recurring
- Orders purchase/custom-fields
- Orders purchase/demo/{tenantId}
- Orders purchase/draft/trigger
- Orders purchase/drop-ship
- Orders purchase/email
- Orders purchase/export
- Orders purchase/import
- Orders purchase/incomingStockQuantities
- Orders purchase/linked-docs/product-codes
- Orders purchase/product-in-out-qty
- Orders purchase/receipt
- Orders purchase/record-filter
- Orders purchase/report/count
- Orders purchase/report/overview
- Orders purchase/sequence
- Orders purchase/set-recurring
- Orders purchase/short-info/{code}
- Orders purchase/status/{code}
- Orders purchase/tax/count
- Orders purchase/unreceived-seq-codes
- Orders purchase/update/linkedDocument
- Orders purchase/{code}
- Orders purchase/{id}
purchase-order-uae-controller
- Orders purchase/ae
- Orders purchase/ae/code/{code}
- Orders purchase/ae/report/count
- Orders purchase/ae/report/overview
- Orders purchase/ae/sequence
- Orders purchase/ae/short-info/{code}
- Orders purchase/ae/{code}
- Orders purchase/ae/{id}
purchase-order-australia-controller
- Orders purchase/au
- Orders purchase/au/code/{code}
- Orders purchase/au/code/{code}/details
- Orders purchase/au/create-recurring
- Orders purchase/au/custom-fields
- Orders purchase/au/demo/{tenantId}
- Orders purchase/au/export
- Orders purchase/au/report/count
- Orders purchase/au/report/overview
- Orders purchase/au/sequence
- Orders purchase/au/set-recurring
- Orders purchase/au/short-info/{code}
- Orders purchase/au/tax/count
- Orders purchase/au/update/linkedDocument
- Orders purchase/au/{code}
- Orders purchase/au/{id}
purchase-order-belgium-controller
- Orders purchase/be
- Orders purchase/be/code/{code}
- Orders purchase/be/code/{code}/details
- Orders purchase/be/create-recurring
- Orders purchase/be/custom-fields
- Orders purchase/be/demo/{tenantId}
- Orders purchase/be/export
- Orders purchase/be/report/count
- Orders purchase/be/report/overview
- Orders purchase/be/sequence
- Orders purchase/be/set-recurring
- Orders purchase/be/short-info/{code}
- Orders purchase/be/tax/count
- Orders purchase/be/update/linkedDocument
- Orders purchase/be/{code}
- Orders purchase/be/{id}
purchase-order-canada-controller
- Orders purchase/ca
- Orders purchase/ca/code/{code}
- Orders purchase/ca/code/{code}/details
- Orders purchase/ca/create-recurring
- Orders purchase/ca/custom-fields
- Orders purchase/ca/demo/{tenantId}
- Orders purchase/ca/export
- Orders purchase/ca/report/count
- Orders purchase/ca/report/overview
- Orders purchase/ca/sequence
- Orders purchase/ca/set-recurring
- Orders purchase/ca/short-info/{code}
- Orders purchase/ca/tax/count
- Orders purchase/ca/update/linkedDocument
- Orders purchase/ca/{code}
- Orders purchase/ca/{id}
purchase-order-germany-controller
- Orders purchase/de
- Orders purchase/de/code/{code}
- Orders purchase/de/code/{code}/details
- Orders purchase/de/create-recurring
- Orders purchase/de/custom-fields
- Orders purchase/de/demo/{tenantId}
- Orders purchase/de/export
- Orders purchase/de/report/count
- Orders purchase/de/report/overview
- Orders purchase/de/sequence
- Orders purchase/de/set-recurring
- Orders purchase/de/short-info/{code}
- Orders purchase/de/tax/count
- Orders purchase/de/update/linkedDocument
- Orders purchase/de/{code}
- Orders purchase/de/{id}
purchase-order-indonesia-controller
- Orders purchase/id
- Orders purchase/id/code/{code}
- Orders purchase/id/report/count
- Orders purchase/id/report/overview
- Orders purchase/id/sequence
- Orders purchase/id/short-info/{code}
- Orders purchase/id/{code}
- Orders purchase/id/{id}
purchase-order-israel-controller
- Orders purchase/il
- Orders purchase/il/code/{code}
- Orders purchase/il/report/count
- Orders purchase/il/report/overview
- Orders purchase/il/sequence
- Orders purchase/il/short-info/{code}
- Orders purchase/il/{code}
- Orders purchase/il/{id}
purchase-order-india-controller
- Orders purchase/in
- Orders purchase/in/code/{code}
- Orders purchase/in/import
- Orders purchase/in/report/count
- Orders purchase/in/report/overview
- Orders purchase/in/sequence
- Orders purchase/in/short-info/{code}
- Orders purchase/in/{code}
- Orders purchase/in/{id}
purchase-order-malaysia-controller
- Orders purchase/my
- Orders purchase/my/code/{code}
- Orders purchase/my/report/count
- Orders purchase/my/report/overview
- Orders purchase/my/sequence
- Orders purchase/my/short-info/{code}
- Orders purchase/my/{code}
- Orders purchase/my/{id}
purchase-order-nl-controller
- Orders purchase/nl
- Orders purchase/nl/code/{code}
- Orders purchase/nl/code/{code}/details
- Orders purchase/nl/create-recurring
- Orders purchase/nl/custom-fields
- Orders purchase/nl/demo/{tenantId}
- Orders purchase/nl/export
- Orders purchase/nl/report/count
- Orders purchase/nl/report/overview
- Orders purchase/nl/sequence
- Orders purchase/nl/set-recurring
- Orders purchase/nl/short-info/{code}
- Orders purchase/nl/tax/count
- Orders purchase/nl/update/linkedDocument
- Orders purchase/nl/{code}
- Orders purchase/nl/{id}
purchase-order-nz-controller
- Orders purchase/nz
- Orders purchase/nz/code/{code}
- Orders purchase/nz/code/{code}/details
- Orders purchase/nz/create-recurring
- Orders purchase/nz/custom-fields
- Orders purchase/nz/demo/{tenantId}
- Orders purchase/nz/export
- Orders purchase/nz/report/count
- Orders purchase/nz/report/overview
- Orders purchase/nz/sequence
- Orders purchase/nz/set-recurring
- Orders purchase/nz/short-info/{code}
- Orders purchase/nz/tax/count
- Orders purchase/nz/update/linkedDocument
- Orders purchase/nz/{code}
- Orders purchase/nz/{id}
purchase-order-philippines-controller
- Orders purchase/ph
- Orders purchase/ph/code/{code}
- Orders purchase/ph/report/count
- Orders purchase/ph/report/overview
- Orders purchase/ph/sequence
- Orders purchase/ph/short-info/{code}
- Orders purchase/ph/{code}
- Orders purchase/ph/{id}
purchase-order-saudi-arabia-controller
- Orders purchase/sa
- Orders purchase/sa/code/{code}
- Orders purchase/sa/report/count
- Orders purchase/sa/report/overview
- Orders purchase/sa/sequence
- Orders purchase/sa/short-info/{code}
- Orders purchase/sa/{code}
- Orders purchase/sa/{id}
purchase-order-uk-controller
- Orders purchase/uk
- Orders purchase/uk/code/{code}
- Orders purchase/uk/code/{code}/details
- Orders purchase/uk/create-recurring
- Orders purchase/uk/custom-fields
- Orders purchase/uk/demo/{tenantId}
- Orders purchase/uk/export
- Orders purchase/uk/report/count
- Orders purchase/uk/report/overview
- Orders purchase/uk/sequence
- Orders purchase/uk/set-recurring
- Orders purchase/uk/short-info/{code}
- Orders purchase/uk/tax/count
- Orders purchase/uk/update/linkedDocument
- Orders purchase/uk/{code}
- Orders purchase/uk/{id}
purchase-request-controller
- Search purchase requests
- Orders purchaserequest/draft/trigger
- Orders purchaserequest/linked-docs/product-codes
- Orders purchaserequest/{code}
- Orders purchaserequest/{id}
sales-order-controller
- Orders sales
- Orders sales/linked-quotation/{code}
- Orders sales/report
- Orders sales/report/count
- Orders sales/report/overview
- Orders sales/{code}
- Orders sales/{id}
Models
- AbstractJobWorkOutOrderItemDetails
- AbstractPurchaseRequestItemDetails
- AccountDto
- AdditionalCharges
- AdditionalChargesDetails
- Address
- AdvancedTrackingBOMDto
- AdvancedTrackingMetaDto
- AdvancedTrackingReturned
- AdvancedTrackingReturnedByDoc
- AmortizationDocumentItemDetails
- ApprovalHistoryItem
- ApprovalStatusRequestDto
- AssetGroupResponse
- AssetRequest
- AttachmentsResponse
- AttributeDetails
- BarcodeDetails
- BomAdditionalCostDto
- BomMetaDetailsDto
- BomMetaDto
- BomOperationDto
- BomProductCostDetails
- BulkApiResponse
- BulkApiResponse«PurchaseOrderIndiaResponse»
- BulkApiResponse«PurchaseOrderResponse»
- BulkDeleteOrderResponse
- BulkResponse
- BulkUpdateOrderResponse
- ContactDto
- ContactIndiaTdsInfo
- ContactInfo
- ContactInformation
- ContactSAArabicDto
- CustomFieldItem
- DocumentInfo
- DocumentItemTaxMappingDto
- DocumentUOMSchemaDefinition
- ExportDocumentRequest
- FilterCondition
- FilterRecord
- GlobalDiscountDetails
- GoodsReceiptItemDto
- GoodsReceiptResponse
- InventoryDto
- InventoryWarehouseDetails
- InvoiceResponseInfo
- JobWorkOutOrderIndiaRequest
- JobWorkOutOrderIndiaResponse
- JobWorkOutOrderInformation
- JobWorkOutOrderItemDetails
- JobWorkOutOrderItemIndiaDetails
- JobWorkOutOrderItemInformation
- JobWorkOutOrderRequest
- JobWorkOutOrderResponse
- LandedCostCategory
- LandedCostDetails
- LandedCostProductDetails
- LinkedDocumentResponse
- LinkedDocumentUpdateRequest
- LinkedDocumentsDto
- LinkedPurchaseInvoiceResponse
- LinkedPurchaseOrderResponse
- Map«string,object»
- Map«string,string»
- MonthData
- OrderOverview
- OrderOverviewReport
- OrderReportInfo
- OrderRequestDto
- Pageable
- Page«JobWorkOutOrderIndiaResponse»
- Page«JobWorkOutOrderResponse»
- Page«PurchaseOrderAustraliaResponse»
- Page«PurchaseOrderCanadaResponse»
- Page«PurchaseOrderDEResponse»
- Page«PurchaseOrderIndiaResponse»
- Page«PurchaseOrderIndonesiaResponse»
- Page«PurchaseOrderIsraelResponse»
- Page«PurchaseOrderMalaysiaResponse»
- Page«PurchaseOrderPhilippinesResponse»
- Page«PurchaseOrderResponse»
- Page«PurchaseOrderSaudiArabiaResponse»
- Page«PurchaseOrderUKResponse»
- Page«PurchaseOrderUaeResponse»
- Page«PurchaseRequestResponse»
- Page«SalesOrderResponse»
- PaymentMilestoneDetailsResponse
- PlatformDetailsDto
- ProductInOutQty
- ProductInformation
- ProductResponse
- ProductRevenueRecognitionInfo
- ProductStockInfo
- ProductSubstitutesDetails
- PurchaseInvoiceAccountDetails
- PurchaseInvoiceAssetGroupDetails
- PurchaseInvoiceProductDetails
- PurchaseInvoiceRecurringDetails
- PurchaseInvoiceRequest
- PurchaseOrderAssetGroupDetails
- PurchaseOrderAustraliaRequest
- PurchaseOrderAustraliaResponse
- PurchaseOrderCanadaRequest
- PurchaseOrderCanadaResponse
- PurchaseOrderDERequest
- PurchaseOrderDEResponse
- PurchaseOrderIndiaRequest
- PurchaseOrderIndiaResponse
- PurchaseOrderIndonesiaRequest
- PurchaseOrderIndonesiaResponse
- PurchaseOrderInformation
- PurchaseOrderIsraelRequest
- PurchaseOrderIsraelResponse
- PurchaseOrderItemAustraliaDetails
- PurchaseOrderItemCanadaDetails
- PurchaseOrderItemDEDetails
- PurchaseOrderItemDetails
- PurchaseOrderItemIndiaDetails
- PurchaseOrderItemIndonesiaDetails
- PurchaseOrderItemInfo
- PurchaseOrderItemInformation
- PurchaseOrderItemIsraelDetails
- PurchaseOrderItemMalaysiaDetails
- PurchaseOrderItemPhilippinesDetails
- PurchaseOrderItemSaudiArabiaDetails
- PurchaseOrderItemUKDetails
- PurchaseOrderItemUaeDetails
- PurchaseOrderMalaysiaRequest
- PurchaseOrderMalaysiaResponse
- PurchaseOrderPhilippinesRequest
- PurchaseOrderPhilippinesResponse
- PurchaseOrderRequest
- PurchaseOrderResponse
- PurchaseOrderSaudiArabiaRequest
- PurchaseOrderSaudiArabiaResponse
- PurchaseOrderShortResponse
- PurchaseOrderUKRequest
- PurchaseOrderUKResponse
- PurchaseOrderUaeRequest
- PurchaseOrderUaeResponse
- PurchaseRequestRequest
- PurchaseRequestResponse
- RecurringJobEvent
- RowRackBinData
- SalesOrderDashboardReport
- SalesOrderItemDetails
- SalesOrderRequest
- SalesOrderResponse
- SendEmailRequest
- SendOrderEmailDto
- SetRecurringDto
- Sort
- StockQuantitiesRequest
- StockQuantitiesResponse
- TaxDto
- TaxGroupDetails
- TdsInfoIndia
- TriggerKafkaRequestDto
- UOMDto
- UOMSchemaDefinitionDto
- UOMSchemaDto
- WarehouseInventoryData
- Year

API​

Search Order​

Description:​

GET​

Orders purchase​

Parameters​

Responses​

Security​

Create Purchase Order​

Description:​

POST​

Orders purchase​

Parameters​

Responses​

Security​

Update Order​

Description:​

PUT​

Orders purchase/{id}​

Parameters​

Responses​

Security​

Retrieve Order​

Description:​

GET​

Orders purchase/code/{code}​

Parameters​

Responses​

Security​

Delete Purchase Order​

DELETE​

Orders purchase​

Summary​

Description​

Parameters​

Responses​

Security​

job-work-out-order-controller​

Orders jobworkout​

GET​

Summary​

Description​

Parameters​

Responses​

Security​

POST​

Summary​

Description​

Parameters​

Responses​

Security​

PATCH​

Summary​

Description​

Parameters​

Responses​

Security​

Orders jobworkout/bulk-details​

POST​

Summary​

Description​

Parameters​

Responses​

Security​

Orders jobworkout/code/{code}/details​

GET​

Summary​

Description​

Parameters​

Responses​

Security​

Orders jobworkout/code/{code}/detailsbyworkorder​

GET​

Summary​

Description​

Parameters​

Responses​

Security​

Orders jobworkout/linked-docs/product-codes​

POST​

API

Search Order

Description:

GET

Orders purchase

Parameters

Responses

Security

Create Purchase Order

Description:

POST

Orders purchase

Parameters

Responses

Security

Update Order

Description:

PUT

Orders purchase/{id}

Parameters

Responses

Security

Retrieve Order

Description:

GET

Orders purchase/code/{code}

Parameters

Responses

Security

Delete Purchase Order

DELETE

Orders purchase

Summary

Description

Parameters

Responses

Security

job-work-out-order-controller

Orders jobworkout

GET

Summary

Description

Parameters

Responses

Security

POST

Summary

Description

Parameters

Responses

Security

PATCH

Summary

Description

Parameters

Responses

Security

Orders jobworkout/bulk-details

POST

Summary

Description

Parameters

Responses

Security

Orders jobworkout/code/{code}/details

GET

Summary

Description

Parameters

Responses

Security

Orders jobworkout/code/{code}/detailsbyworkorder

GET

Summary

Description

Parameters

Responses

Security

Orders jobworkout/linked-docs/product-codes

POST