Quotation APIs

Quotation is created in sell module. You will be able to track the quotation process with the fulfillment feature. The fulfilment process comes with three status - “Fulfilled”, “Partial”, “Unfulfilled”. With this status, you will be able to make accurate business actions. Once the quotation is fulfilled, you will be able to convert it into an invoice, automatically recording it into your accounts receivable account.

Quotation Api helps you to create/draft new quotation, retrieve a particular quotation, update a particular quotation, update linked backorder/documents, or retrieve a list of all quotations.

API

Search Quotation/Estimate

Get quotations by filter criteria. More about search quotation

Description:

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

GET

Quotations

More about search quotation

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	Quotation's have been fetched successfully.	QuotationDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Create Quotation/Estimate

Create/Draft a new quotation. More about create quotation

Description:

Allows you to create/draft a new quotation.

POST

Quotations

More about create quotation

Parameters

Name	Located in	Description	Required	Schema
quotationDto	body	quotationDto	Yes	QuotationDto

Responses

Code	Description	Schema
200	OK	QuotationDto
201	Quotation has been created/drafted successfully.	QuotationDto
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Update Quotation/Estimate

Update quotation information. More about update quotation

Description:

Allows you to update a specific quotation information.

PUT

Quotations /{id}

More about update quotation

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotationDto	body	quotationDto	Yes	QuotationDto

Responses

Code	Description	Schema
200	Quotation has been updated successfully.	QuotationDto
201	Created
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

Retrieve Quotation/Estimate

Get quotation by code. More about retrieve quotation

Description:

Allows you to retrieve an existing quotation document information by it's code.

GET

Quotations /code/{code}

More about retrieve quotation

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Quotations documents have been fetched successfully.	[ SalesDocument ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Update Linked BackOrder

Update linked documents for PO backorder

Description:

Allows you to update linked documents for PO backorder.

POST

Quotations /update/linkedBackOrder

More about retrieve quotation

Parameters

Name	Located in	Description	Required	Schema
backOrderUpdateRequest	body	backOrderUpdateRequest	Yes	BackOrderUpdateRequest

Responses

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

Security

Security Schema	Scopes
Authorization	global

Update Linked Documents

Update linked documents for PO.

Description:

Allows you to update linked documents for PO.

POST

Quotations /update/linkedDocument

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

Quotations /ae

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

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	Quotation's have been fetched successfully.	QuotationDtoUAE
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters

Name	Located in	Description	Required	Schema
quotationDtoUAE	body	quotationDtoUAE	Yes	QuotationDtoUAE

Responses

Code	Description	Schema
200	OK	QuotationDtoUAE
201	Quotation has been created/drafted successfully.	QuotationDtoUAE
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /ae/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters

Name	Located in	Description	Required	Schema
isNewUi	query	isNewUi	No	boolean

Responses

Code	Description	Schema
200	Quotations brief information have been fetched successfully.	[ QuotationShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /ae/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Quotations documents have been fetched successfully.	[ QuotationDtoUAE ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /ae/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /ae/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses

Code	Description	Schema
200	Open quotations count has been fetched.	integer
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /ae/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
epoch	query	epoch	Yes	long
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Quotation overview report has been prepared.	QuotationOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /ae/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
attributeKeyValues	body	attributeKeyValues	Yes	object
quotationCode	query	quotationCode	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /ae/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotationDtoUAE	body	quotationDtoUAE	Yes	QuotationDtoUAE

Responses

Code	Description	Schema
200	Quotation has been updated successfully.	QuotationDtoUAE
201	Created
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Quotation has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotation	body	quotation	Yes	object

Responses

Code	Description	Schema
200	Quotation attributes has been updated successfully.	QuotationDtoUAE
204	No Content
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

Quotations /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

Quotations /au

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

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	Quotation's have been fetched successfully.	QuotationDtoAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters

Name	Located in	Description	Required	Schema
quotationDtoAustralia	body	quotationDtoAustralia	Yes	QuotationDtoAustralia

Responses

Code	Description	Schema
200	OK	QuotationDtoAustralia
201	Quotation has been created/drafted successfully.	QuotationDtoAustralia
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /au/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters

Name	Located in	Description	Required	Schema
isNewUi	query	isNewUi	No	boolean

Responses

Code	Description	Schema
200	Quotations brief information have been fetched successfully.	[ QuotationShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /au/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Quotations documents have been fetched successfully.	[ QuotationDtoAustralia ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /au/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /au/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses

Code	Description	Schema
200	Open quotations count has been fetched.	integer
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /au/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
epoch	query	epoch	Yes	long
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Quotation overview report has been prepared.	QuotationOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /au/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
attributeKeyValues	body	attributeKeyValues	Yes	object
quotationCode	query	quotationCode	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /au/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotationDtoAustralia	body	quotationDtoAustralia	Yes	QuotationDtoAustralia

Responses

Code	Description	Schema
200	Quotation has been updated successfully.	QuotationDtoAustralia
201	Created
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Quotation has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotation	body	quotation	Yes	object

Responses

Code	Description	Schema
200	Quotation attributes has been updated successfully.	QuotationDtoAustralia
204	No Content
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

Quotations /batch

PUT

Summary

Batch update quotation attributes.

Description

Batch API to update attributes of existing quotation by codes.

Parameters

Name	Located in	Description	Required	Schema
quotationUpdateRequests	body	quotationUpdateRequests	Yes	[ QuotationUpdateRequest ]

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /be

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

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	Quotation's have been fetched successfully.	QuotationDtoAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters

Name	Located in	Description	Required	Schema
quotationDtoAustralia	body	quotationDtoAustralia	Yes	QuotationDtoAustralia

Responses

Code	Description	Schema
200	OK	QuotationDtoAustralia
201	Quotation has been created/drafted successfully.	QuotationDtoAustralia
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /be/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters

Name	Located in	Description	Required	Schema
isNewUi	query	isNewUi	No	boolean

Responses

Code	Description	Schema
200	Quotations brief information have been fetched successfully.	[ QuotationShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /be/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Quotations documents have been fetched successfully.	[ QuotationDtoAustralia ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /be/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /be/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses

Code	Description	Schema
200	Open quotations count has been fetched.	integer
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /be/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
epoch	query	epoch	Yes	long
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Quotation overview report has been prepared.	QuotationOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /be/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
attributeKeyValues	body	attributeKeyValues	Yes	object
quotationCode	query	quotationCode	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /be/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotationDtoAustralia	body	quotationDtoAustralia	Yes	QuotationDtoAustralia

Responses

Code	Description	Schema
200	Quotation has been updated successfully.	QuotationDtoAustralia
201	Created
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Quotation has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotation	body	quotation	Yes	object

Responses

Code	Description	Schema
200	Quotation attributes has been updated successfully.	QuotationDtoAustralia
204	No Content
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

Quotations /brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
isNewUi	query	isNewUi	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	Quotations brief information have been fetched successfully.	[ QuotationShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /bulk-delete

DELETE

Summary

Bulk Delete quotation.

Description

API to bulk delete quotation.

Parameters

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

Responses

Code	Description	Schema
200	OK	[ QuotationBulkDeleteResponseDto ]
204	Quotation has been deleted successfully.	[ QuotationBulkDeleteResponseDto ]
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

Quotations /bulk-details

POST

Summary

Quotation details by codes

Description

Quotation details by codes

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /bulk-patch

PATCH

Summary

Bulk update quotation attributes.

Description

Bulk API to update attributes of existing quotations.

Parameters

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

Responses

Code	Description	Schema
200	Quotation attributes has been updated successfully.	BulkApiResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

Quotations /by-contact-ids

POST

Summary

Fetch Quotations

Description

API to fetch existing quotations.

Parameters

Name	Located in	Description	Required	Schema
contactIds	body	contactIds	Yes	[ long ]
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	Quotation's have been fetched successfully.	QuotationDto
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /ca

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

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	Quotation's have been fetched successfully.	QuotationDtoCanada
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters

Name	Located in	Description	Required	Schema
quotationDtoCanada	body	quotationDtoCanada	Yes	QuotationDtoCanada

Responses

Code	Description	Schema
200	OK	QuotationDtoCanada
201	Quotation has been created/drafted successfully.	QuotationDtoCanada
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /ca/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters

Name	Located in	Description	Required	Schema
isNewUi	query	isNewUi	No	boolean

Responses

Code	Description	Schema
200	Quotations brief information have been fetched successfully.	[ QuotationShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /ca/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Quotations documents have been fetched successfully.	[ QuotationDtoCanada ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /ca/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /ca/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses

Code	Description	Schema
200	Open quotations count has been fetched.	integer
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /ca/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
epoch	query	epoch	Yes	long
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Quotation overview report has been prepared.	QuotationOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /ca/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
attributeKeyValues	body	attributeKeyValues	Yes	object
quotationCode	query	quotationCode	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /ca/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotationDtoCanada	body	quotationDtoCanada	Yes	QuotationDtoCanada

Responses

Code	Description	Schema
200	Quotation has been updated successfully.	QuotationDtoCanada
201	Created
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Quotation has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotation	body	quotation	Yes	object

Responses

Code	Description	Schema
200	Quotation attributes has been updated successfully.	QuotationDtoCanada
204	No Content
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

Quotations /code/{code}/details

GET

Summary

Quotation details by codes

Description

Quotation details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /codes

POST

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters

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

Responses

Code	Description	Schema
200	Quotations documents have been fetched successfully.	[ SalesDocument ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /create-recurring

POST

Summary

Create a recurring quotation

Description

API to create a recurring quotation.

Parameters

Name	Located in	Description	Required	Schema
event	body	event	Yes	RecurringJobEvent

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /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

Quotations /de

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

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	Quotation's have been fetched successfully.	QuotationDtoDE
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters

Name	Located in	Description	Required	Schema
quotationDtoDE	body	quotationDtoDE	Yes	QuotationDtoDE

Responses

Code	Description	Schema
200	OK	QuotationDtoDE
201	Quotation has been created/drafted successfully.	QuotationDtoDE
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /de/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters

Name	Located in	Description	Required	Schema
isNewUi	query	isNewUi	No	boolean

Responses

Code	Description	Schema
200	Quotations brief information have been fetched successfully.	[ QuotationShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /de/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Quotations documents have been fetched successfully.	[ QuotationDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /de/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /de/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses

Code	Description	Schema
200	Open quotations count has been fetched.	integer
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /de/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
epoch	query	epoch	Yes	long
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Quotation overview report has been prepared.	QuotationOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /de/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
attributeKeyValues	body	attributeKeyValues	Yes	object
quotationCode	query	quotationCode	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /de/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotationDtoDE	body	quotationDtoDE	Yes	QuotationDtoDE

Responses

Code	Description	Schema
200	Quotation has been updated successfully.	QuotationDtoDE
201	Created
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Quotation has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotation	body	quotation	Yes	object

Responses

Code	Description	Schema
200	Quotation attributes has been updated successfully.	QuotationDtoDE
204	No Content
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

Quotations /demo/{tenantId}

POST

Summary

Create demo quotations.

Description

API to create demo quotations.

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

Quotations /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

Quotations /dropshipupdatequotation

PUT

Summary

Batch update quotation attributes.

Description

Batch API to update attributes of existing quotation by codes.

Parameters

Name	Located in	Description	Required	Schema
quotationUpdateRequests	body	quotationUpdateRequests	Yes	[ QuotationUpdateRequest ]

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /id

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

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	Quotation's have been fetched successfully.	QuotationDtoIndonesia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters

Name	Located in	Description	Required	Schema
quotationDtoIndonesia	body	quotationDtoIndonesia	Yes	QuotationDtoIndonesia

Responses

Code	Description	Schema
200	OK	QuotationDtoIndonesia
201	Quotation has been created/drafted successfully.	QuotationDtoIndonesia
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /id/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters

Name	Located in	Description	Required	Schema
isNewUi	query	isNewUi	No	boolean

Responses

Code	Description	Schema
200	Quotations brief information have been fetched successfully.	[ QuotationShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /id/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Quotations documents have been fetched successfully.	[ QuotationDtoIndonesia ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /id/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /id/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses

Code	Description	Schema
200	Open quotations count has been fetched.	integer
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /id/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
epoch	query	epoch	Yes	long
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Quotation overview report has been prepared.	QuotationOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /id/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
attributeKeyValues	body	attributeKeyValues	Yes	object
quotationCode	query	quotationCode	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /id/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotationDtoIndonesia	body	quotationDtoIndonesia	Yes	QuotationDtoIndonesia

Responses

Code	Description	Schema
200	Quotation has been updated successfully.	QuotationDtoIndonesia
201	Created
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Quotation has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotation	body	quotation	Yes	object

Responses

Code	Description	Schema
200	Quotation attributes has been updated successfully.	QuotationDtoIndonesia
204	No Content
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

Quotations /il

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

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	Quotation's have been fetched successfully.	QuotationIsraelDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters

Name	Located in	Description	Required	Schema
quotationIsraelDto	body	quotationIsraelDto	Yes	QuotationIsraelDto

Responses

Code	Description	Schema
200	OK	QuotationIsraelDto
201	Quotation has been created/drafted successfully.	QuotationIsraelDto
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /il/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters

Name	Located in	Description	Required	Schema
isNewUi	query	isNewUi	No	boolean

Responses

Code	Description	Schema
200	Quotations brief information have been fetched successfully.	[ QuotationShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /il/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Quotations documents have been fetched successfully.	[ QuotationIsraelDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /il/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /il/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses

Code	Description	Schema
200	Open quotations count has been fetched.	integer
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /il/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
epoch	query	epoch	Yes	long
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Quotation overview report has been prepared.	QuotationOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /il/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
attributeKeyValues	body	attributeKeyValues	Yes	object
quotationCode	query	quotationCode	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /il/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotationIsraelDto	body	quotationIsraelDto	Yes	QuotationIsraelDto

Responses

Code	Description	Schema
200	Quotation has been updated successfully.	QuotationIsraelDto
201	Created
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Quotation has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotation	body	quotation	Yes	object

Responses

Code	Description	Schema
200	Quotation attributes has been updated successfully.	QuotationIsraelDto
204	No Content
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

Quotations /import

POST

Summary

Create multiple quotations via import

Description

API to create quotations via import.

Parameters

Name	Located in	Description	Required	Schema
quotationRequests	body	quotationRequests	Yes	[ QuotationDto ]

Responses

Code	Description	Schema
200	OK	BulkApiResponse
201	Quotation has been created/drafted successfully.	BulkApiResponse
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /in

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

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	Quotation's have been fetched successfully.	QuotationIndiaDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters

Name	Located in	Description	Required	Schema
quotationIndiaDto	body	quotationIndiaDto	Yes	QuotationIndiaDto

Responses

Code	Description	Schema
200	OK	QuotationIndiaDto
201	Quotation has been created/drafted successfully.	QuotationIndiaDto
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /in/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters

Name	Located in	Description	Required	Schema
isNewUi	query	isNewUi	No	boolean

Responses

Code	Description	Schema
200	Quotations brief information have been fetched successfully.	[ QuotationShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /in/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Quotations documents have been fetched successfully.	[ QuotationIndiaDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /in/create

PUT

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters

Name	Located in	Description	Required	Schema
quotationIndiaDto	body	quotationIndiaDto	Yes	QuotationIndiaDto

Responses

Code	Description	Schema
200	OK	QuotationIndiaDto
201	Quotation has been created/drafted successfully.	QuotationIndiaDto
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /in/import

POST

Summary

Create multiple quotations via import

Description

API to create quotations via import.

Parameters

Name	Located in	Description	Required	Schema
quotationRequests	body	quotationRequests	Yes	[ QuotationIndiaDto ]

Responses

Code	Description	Schema
200	OK	BulkApiResponse
201	Quotation has been created/drafted successfully.	BulkApiResponse
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /in/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /in/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses

Code	Description	Schema
200	Open quotations count has been fetched.	integer
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /in/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
epoch	query	epoch	Yes	long
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Quotation overview report has been prepared.	QuotationOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /in/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
attributeKeyValues	body	attributeKeyValues	Yes	object
quotationCode	query	quotationCode	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /in/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotationIndiaDto	body	quotationIndiaDto	Yes	QuotationIndiaDto

Responses

Code	Description	Schema
200	Quotation has been updated successfully.	QuotationIndiaDto
201	Created
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Quotation has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotation	body	quotation	Yes	object

Responses

Code	Description	Schema
200	Quotation attributes has been updated successfully.	QuotationIndiaDto
204	No Content
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

Quotations /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

Quotations /my

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

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	Quotation's have been fetched successfully.	QuotationDtoMalaysia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters

Name	Located in	Description	Required	Schema
QuotationDtoMalaysia	body	QuotationDtoMalaysia	Yes	QuotationDtoMalaysia

Responses

Code	Description	Schema
200	OK	QuotationDtoMalaysia
201	Quotation has been created/drafted successfully.	QuotationDtoMalaysia
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /my/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters

Name	Located in	Description	Required	Schema
isNewUi	query	isNewUi	No	boolean

Responses

Code	Description	Schema
200	Quotations brief information have been fetched successfully.	[ QuotationShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /my/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Quotations documents have been fetched successfully.	[ QuotationDtoMalaysia ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /my/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /my/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses

Code	Description	Schema
200	Open quotations count has been fetched.	integer
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /my/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
epoch	query	epoch	Yes	long
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Quotation overview report has been prepared.	QuotationOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /my/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
attributeKeyValues	body	attributeKeyValues	Yes	object
quotationCode	query	quotationCode	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /my/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters

Name	Located in	Description	Required	Schema
QuotationDtoMalaysia	body	QuotationDtoMalaysia	Yes	QuotationDtoMalaysia
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Quotation has been updated successfully.	QuotationDtoMalaysia
201	Created
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Quotation has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotation	body	quotation	Yes	object

Responses

Code	Description	Schema
200	Quotation attributes has been updated successfully.	QuotationDtoMalaysia
204	No Content
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

Quotations /nl

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

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	Quotation's have been fetched successfully.	QuotationDtoAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters

Name	Located in	Description	Required	Schema
quotationDtoAustralia	body	quotationDtoAustralia	Yes	QuotationDtoAustralia

Responses

Code	Description	Schema
200	OK	QuotationDtoAustralia
201	Quotation has been created/drafted successfully.	QuotationDtoAustralia
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /nl/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters

Name	Located in	Description	Required	Schema
isNewUi	query	isNewUi	No	boolean

Responses

Code	Description	Schema
200	Quotations brief information have been fetched successfully.	[ QuotationShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /nl/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Quotations documents have been fetched successfully.	[ QuotationDtoAustralia ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /nl/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /nl/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses

Code	Description	Schema
200	Open quotations count has been fetched.	integer
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /nl/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
epoch	query	epoch	Yes	long
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Quotation overview report has been prepared.	QuotationOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /nl/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
attributeKeyValues	body	attributeKeyValues	Yes	object
quotationCode	query	quotationCode	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /nl/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotationDtoAustralia	body	quotationDtoAustralia	Yes	QuotationDtoAustralia

Responses

Code	Description	Schema
200	Quotation has been updated successfully.	QuotationDtoAustralia
201	Created
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Quotation has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotation	body	quotation	Yes	object

Responses

Code	Description	Schema
200	Quotation attributes has been updated successfully.	QuotationDtoAustralia
204	No Content
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

Quotations /nz

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

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	Quotation's have been fetched successfully.	QuotationDtoAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters

Name	Located in	Description	Required	Schema
quotationDtoAustralia	body	quotationDtoAustralia	Yes	QuotationDtoAustralia

Responses

Code	Description	Schema
200	OK	QuotationDtoAustralia
201	Quotation has been created/drafted successfully.	QuotationDtoAustralia
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /nz/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters

Name	Located in	Description	Required	Schema
isNewUi	query	isNewUi	No	boolean

Responses

Code	Description	Schema
200	Quotations brief information have been fetched successfully.	[ QuotationShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /nz/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Quotations documents have been fetched successfully.	[ QuotationDtoAustralia ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /nz/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /nz/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses

Code	Description	Schema
200	Open quotations count has been fetched.	integer
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /nz/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
epoch	query	epoch	Yes	long
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Quotation overview report has been prepared.	QuotationOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /nz/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
attributeKeyValues	body	attributeKeyValues	Yes	object
quotationCode	query	quotationCode	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /nz/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotationDtoAustralia	body	quotationDtoAustralia	Yes	QuotationDtoAustralia

Responses

Code	Description	Schema
200	Quotation has been updated successfully.	QuotationDtoAustralia
201	Created
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Quotation has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotation	body	quotation	Yes	object

Responses

Code	Description	Schema
200	Quotation attributes has been updated successfully.	QuotationDtoAustralia
204	No Content
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

Quotations /pendingqty

PUT

Summary

Batch update to pending qty in Quotation Item.

Description

Batch API to update pending qty for QuotationItem.

Parameters

Name	Located in	Description	Required	Schema
quotationItemPendingQtyUpdateMap	body	quotationItemPendingQtyUpdateMap	Yes	object

Responses

Code	Description
200	Pending qty updated successfully
201	Created
401	Unauthorized
403	Forbidden
404	Pending qty update failure

Security

Security Schema	Scopes
Authorization	global

Quotations /ph

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

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	Quotation's have been fetched successfully.	QuotationPhilippinesDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters

Name	Located in	Description	Required	Schema
quotationPhilippinesDto	body	quotationPhilippinesDto	Yes	QuotationPhilippinesDto

Responses

Code	Description	Schema
200	OK	QuotationPhilippinesDto
201	Quotation has been created/drafted successfully.	QuotationPhilippinesDto
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /ph/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters

Name	Located in	Description	Required	Schema
isNewUi	query	isNewUi	No	boolean

Responses

Code	Description	Schema
200	Quotations brief information have been fetched successfully.	[ QuotationShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /ph/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Quotations documents have been fetched successfully.	[ QuotationPhilippinesDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /ph/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /ph/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses

Code	Description	Schema
200	Open quotations count has been fetched.	integer
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /ph/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
epoch	query	epoch	Yes	long
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Quotation overview report has been prepared.	QuotationOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /ph/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
attributeKeyValues	body	attributeKeyValues	Yes	object
quotationCode	query	quotationCode	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /ph/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotationPhilippinesDto	body	quotationPhilippinesDto	Yes	QuotationPhilippinesDto

Responses

Code	Description	Schema
200	Quotation has been updated successfully.	QuotationPhilippinesDto
201	Created
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Quotation has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotation	body	quotation	Yes	object

Responses

Code	Description	Schema
200	Quotation attributes has been updated successfully.	QuotationPhilippinesDto
204	No Content
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

Quotations /product-codes

POST

Summary

Get List Of Quotations by product codes

Description

List of Quotations by product codes

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /product-in-out-qty

GET

Summary

Find quotation data for Product in out qty

Description

API to Find quotation 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

Quotations /productCode/{productCode}

GET

Summary

Check if a quotation exists for a given product

Description

Api to check if a quotation exists for a given product

Parameters

Name	Located in	Description	Required	Schema
productCode	path	productCode	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /quotationitemsstatus

POST

Summary

Get quotation items fulfillment status

Description

API to fetch quotation items fulfillment status

Parameters

Name	Located in	Description	Required	Schema
quotationItemToFulfilledMap	body	quotationItemToFulfilledMap	Yes	object

Responses

Code	Description	Schema
200	quotation items fulfillment status.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /quotationreserved

PUT

Summary

Update quotation reserved quantity

Description

API to Update quotation reserved quantity.

Parameters

Name	Located in	Description	Required	Schema
reservedQuantityData	body	reservedQuantityData	Yes	[ PPSReservedQuantityData ]

Responses

Code	Description
200	Quotation reserved quantity updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Error occured while updating quotation reserved quantity.

Security

Security Schema	Scopes
Authorization	global

Quotations /quotes-quantity

POST

Summary

Get quotation quantity

Description

API to get quotation quantity

Parameters

Name	Located in	Description	Required	Schema
request	body	request	Yes	StockQuantitiesRequest

Responses

Code	Description	Schema
200	Fetched quotation quantity successfully.	StockQuantitiesResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /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

Quotations /report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses

Code	Description	Schema
200	Open quotations count has been fetched.	integer
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
epoch	query	epoch	Yes	long
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Quotation overview report has been prepared.	QuotationOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /sa

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

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	Quotation's have been fetched successfully.	QuotationDtoSaudiArabia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters

Name	Located in	Description	Required	Schema
quotationDtoUAE	body	quotationDtoUAE	Yes	QuotationDtoSaudiArabia

Responses

Code	Description	Schema
200	OK	QuotationDtoSaudiArabia
201	Quotation has been created/drafted successfully.	QuotationDtoSaudiArabia
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /sa/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters

Name	Located in	Description	Required	Schema
isNewUi	query	isNewUi	No	boolean

Responses

Code	Description	Schema
200	Quotations brief information have been fetched successfully.	[ QuotationShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /sa/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Quotations documents have been fetched successfully.	[ QuotationDtoSaudiArabia ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /sa/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /sa/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses

Code	Description	Schema
200	Open quotations count has been fetched.	integer
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /sa/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
epoch	query	epoch	Yes	long
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Quotation overview report has been prepared.	QuotationOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /sa/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
attributeKeyValues	body	attributeKeyValues	Yes	object
quotationCode	query	quotationCode	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /sa/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotationDtoUAE	body	quotationDtoUAE	Yes	QuotationDtoSaudiArabia

Responses

Code	Description	Schema
200	Quotation has been updated successfully.	QuotationDtoSaudiArabia
201	Created
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Quotation has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotation	body	quotation	Yes	object

Responses

Code	Description	Schema
200	Quotation attributes has been updated successfully.	QuotationDtoSaudiArabia
204	No Content
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

Quotations /set-recurring

POST

Summary

Set an quotation to recurring

Description

API to set and quotation to recurring.

Parameters

Name	Located in	Description	Required	Schema
setRecurringDto	body	setRecurringDto	Yes	SetRecurringDto

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
attributeKeyValues	body	attributeKeyValues	Yes	object
quotationCode	query	quotationCode	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /status/{code}

PATCH

Summary

refreshQuoteStatus

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

Quotations /tax/count

POST

Summary

Get quotation count for tax

Description

API to fetch quotation count for tax

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /uk

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

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	Quotation's have been fetched successfully.	QuotationDtoUk
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters

Name	Located in	Description	Required	Schema
quotationDtoUk	body	quotationDtoUk	Yes	QuotationDtoUk

Responses

Code	Description	Schema
200	OK	QuotationDtoUk
201	Quotation has been created/drafted successfully.	QuotationDtoUk
400	Quotation creation/draft failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /uk/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters

Name	Located in	Description	Required	Schema
isNewUi	query	isNewUi	No	boolean

Responses

Code	Description	Schema
200	Quotations brief information have been fetched successfully.	[ QuotationShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /uk/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Quotations documents have been fetched successfully.	[ QuotationDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /uk/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /uk/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses

Code	Description	Schema
200	Open quotations count has been fetched.	integer
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /uk/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
epoch	query	epoch	Yes	long
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Quotation overview report has been prepared.	QuotationOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Quotations /uk/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
attributeKeyValues	body	attributeKeyValues	Yes	object
quotationCode	query	quotationCode	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /uk/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotationDtoUk	body	quotationDtoUk	Yes	QuotationDtoUk

Responses

Code	Description	Schema
200	Quotation has been updated successfully.	QuotationDtoUk
201	Created
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Quotation has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotation	body	quotation	Yes	object

Responses

Code	Description	Schema
200	Quotation attributes has been updated successfully.	QuotationDtoUk
204	No Content
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

Quotations /unreserve-quotations

POST

Summary

Api to Unreserve quantity in quotes only

Description

Api to Unreserve quantity in quotes only

Parameters

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

Responses

Code	Description
200	Api to Unreserve quantity in quotes only
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Update linked documents for PO backorder

Description

API to update linked documents for PO backorder

Parameters

Name	Located in	Description	Required	Schema
backOrderUpdateRequest	body	backOrderUpdateRequest	Yes	BackOrderUpdateRequest

Responses

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

Security

Security Schema	Scopes
Authorization	global

Quotations /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

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Quotation has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
quotation	body	quotation	Yes	object

Responses

Code	Description	Schema
200	Quotation attributes has been updated successfully.	QuotationDto
204	No Content
401	Unauthorized
403	Forbidden
404	Quotation with id not found.

Security

Security Schema	Scopes
Authorization	global

/v1/rel-txn

GET

Summary

Get Relation

Description

API to get relation between two documents.

Parameters

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

Responses

Code	Description	Schema
200	Related transactions fetched successfully.	RelatedTransactionResponse
400	Get related transactions failed due to bad data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Relation

Description

API to create relation between two documents.

Parameters

Name	Located in	Description	Required	Schema
relationDto	body	relationDto	Yes	RelatedTransactionDto

Responses

Code	Description
200	OK
201	Relation Created.
400	Relation creation failed due to bad data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete Relation

Description

API to delete relation between two documents.

Parameters

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

Responses

Code	Description
200	OK
204	Relation Deleted.
400	Relation deletion failed due to bad data.
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Models

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
includeInReport	boolean		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

AdvancedTrackingFulfilmentDto

Name	Type	Description	Required
binCode	string	bin code Example: `"BIN-00001"`	Yes
binName	string	Bin name Example: `"Bin1"`	No
qtyToFulfil	double	Batch qty to fulfill Example: `1`	No
rackCode	string	Rack code Example: `"RACK-00001"`	Yes
rackName	string	Rack name Example: `"Rack1"`	No
rowCode	string	Row code Example: `"ROW-00001"`	Yes
rowName	string	Row name Example: `"Row1"`	No
serialBatchNumber	string	Batch or serial number to be fulfilled Example: `"Batch-001"`	No
warehouseCode	string	Warehouse of selected Batch/Serial Example: `"WH-0000001"`	No
warehouseName	string	Warehouse name Example: `"Warehouse-1"`	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

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

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

BackOrderUpdateRequest

Name	Type	Description	Required
documentInfo	DocumentInfo		No
salesDocumentCode	string		No
salesDocumentType	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"`, `"PURCHASE_REQUEST"`, `"PURCHASE_REQUEST_FOR_QUOTES"`, `"SUPPLIER_QUOTES"`, `"E_WAY_BILL_SUMMARY"`, `"E_WAY_BILL_DETAIL"`, `"JOB_WORK_OUT_ORDER"`, `"JOB_WORK_OUT_TRANSFER"`, `"QC_DOCUMENT"`, `"WIP_PRODUCTION"`, `"STOCK_REQUEST"`, `"STOCK_ISSUE"`, `"FORECAST"`, `"ESTIMATE"`	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«QuotationDto»

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

BulkApiResponse«QuotationIndiaDto»

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

ContactDto

Name	Type	Description	Required
attentionTo	string	the contact name in govt agency Example: `"Peter Parker"`	No
autoCharge	boolean	Auto payment charge Example: `false`	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
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		No
name	string		No

ContactInformation

Name	Type	Description	Required
autoCharge	boolean	Auto payment charge Example: `false`	No
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
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"`, `"PURCHASE_REQUEST"`, `"PURCHASE_REQUEST_FOR_QUOTES"`, `"SUPPLIER_QUOTES"`, `"E_WAY_BILL_SUMMARY"`, `"E_WAY_BILL_DETAIL"`, `"JOB_WORK_OUT_ORDER"`, `"JOB_WORK_OUT_TRANSFER"`, `"QC_DOCUMENT"`, `"WIP_PRODUCTION"`, `"STOCK_REQUEST"`, `"STOCK_ISSUE"`, `"FORECAST"`, `"ESTIMATE"` Example: `"QUOTATION"`	No

DocumentItemDetails

Name	Type	Description	Required
documentSequenceCode	string	Product Document Sequence code Example: `"P-0000001"`	Yes
documentUom	long	UOM id Example: `111`	No
itemId	long	Document Item id Example: `154`	Yes
product	ProductResponse	Product Short Info Example: `"product"`	No
productCode	string	Product code Example: `"P00001"`	Yes
productDescription	string	Product description Example: `"Apple watch"`	No
productName	string	Product Name Example: `"iPhone"`	No
productQuantity	number	Product quantity Example: `2`	Yes
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxCode	string	Tax code Example: `"tax code"`	No
unitPrice	number	Product unit price Example: `0.7`	Yes

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

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

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

ItemQtyFulfilledByDoc

Name	Type	Description	Required
fulfillmentId	string		No
siAmount	number		No

LandedCostCategory

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

LinkedDocumentUpdateRequest

Name	Type	Description	Required
newLinkedDocument	DocumentInfo		No
oldLinkedDocument	DocumentInfo		No

LinkedDocumentsDto

Name	Type	Description	Required
code	string		No
used	boolean		No

LinkedSalesInvoiceResponse

Name	Type	Description	Required
documentSequenceCode	string	Sales invoice Sequence Code Example: `"0000001"`	No
dueAmount	number	Amount Due Example: `12.322`	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
fulfillmentStatus	string	fulfillment status Enum: `"UNFULFILLED"`, `"PARTIAL_FULFILLED"`, `"FULLY_FULFILLED"` Example: `"PARTIAL_FULFILLED"`	No
salesInvoiceCode	string	Sales invoice code Example: `"SI001"`	No
salesInvoiceDate	string	Sales Invoice date Example: `"25-10-2019"`	Yes
totalAmount	number	Total Amount Example: `1234.33`	No

LinkedSalesOrderResponse

Name	Type	Description	Required
documentSequenceCode	string	Sales order Sequence Code Example: `"0000001"`	No
dueAmount	number	Amount Due Example: `12.322`	No
exchangeRate	number	Exchange rate Example: `0.456345`	No
fulfillmentStatus	string	fulfillment status Enum: `"UNFULFILLED"`, `"PARTIAL_FULFILLED"`, `"FULLY_FULFILLED"` Example: `"PARTIAL_FULFILLED"`	No
salesOrderCode	string	Sales order code Example: `"SO-001"`	No
salesOrderDate	string	Sales Invoice date Example: `"25-10-2019"`	Yes

LinkedWareHouse

Name	Type	Description	Required
binCode	string	bin code Example: `"BIN-00001"`	Yes
quantity	number	Quantity from Warehouse. Example: `100`	No
rackCode	string	Rack code Example: `"RACK-00001"`	Yes
rowCode	string	Row code Example: `"ROW-00001"`	Yes
warehouseCode	string	Warehouse code to identify the Warehouse. Example: `"WH-0000001"`	No

PPSReservedQuantityData

Name	Type	Description	Required
itemId	long	Document Item id Example: `154`	Yes
reservedQuantitiesData	[ ReservedQuantityData ]	Reserved quantity data Example: `[]`	No

Pageable

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

Page«QuotationDtoAustralia»

Name	Type	Required
content	[ QuotationDtoAustralia ]	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«QuotationDtoCanada»

Name	Type	Required
content	[ QuotationDtoCanada ]	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«QuotationDtoDE»

Name	Type	Required
content	[ QuotationDtoDE ]	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«QuotationDtoIndonesia»

Name	Type	Required
content	[ QuotationDtoIndonesia ]	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«QuotationDtoMalaysia»

Name	Type	Required
content	[ QuotationDtoMalaysia ]	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«QuotationDtoSaudiArabia»

Name	Type	Required
content	[ QuotationDtoSaudiArabia ]	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«QuotationDtoUAE»

Name	Type	Required
content	[ QuotationDtoUAE ]	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«QuotationDtoUk»

Name	Type	Required
content	[ QuotationDtoUk ]	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«QuotationDto»

Name	Type	Required
content	[ QuotationDto ]	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«QuotationIndiaDto»

Name	Type	Required
content	[ QuotationIndiaDto ]	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«QuotationIsraelDto»

Name	Type	Required
content	[ QuotationIsraelDto ]	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«QuotationPhilippinesDto»

Name	Type	Required
content	[ QuotationPhilippinesDto ]	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

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"`, `"PURCHASE_REQUEST"`, `"PURCHASE_REQUEST_FOR_QUOTES"`, `"SUPPLIER_QUOTES"`, `"E_WAY_BILL_SUMMARY"`, `"E_WAY_BILL_DETAIL"`, `"JOB_WORK_OUT_ORDER"`, `"JOB_WORK_OUT_TRANSFER"`, `"QC_DOCUMENT"`, `"WIP_PRODUCTION"`, `"STOCK_REQUEST"`, `"STOCK_ISSUE"`, `"FORECAST"`, `"ESTIMATE"`	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
exciseRateIndo	number	Excise Rate Example: `5`	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
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
exciseRateIndo	number	Excise Rate Example: `5`	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
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

QuotationBulkDeleteResponseDto

Name	Type	Description	Required
documentSequenceCode	string	documentSequenceCode Example: `"QU-0000001"`	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

QuotationDto

Name	Type	Description	Required
additionalCharges	AdditionalCharges		No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachments	[ string ]	Attachments url's	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if backorder created Example: `true`	No
billTo	Address	Bill to Address.	No
contact	ContactInfo	Contact info Example: `"contact object"`	No
contactCode	string	Contact code Example: `"C-0001"`	Yes
contactDto	ContactDto	Contact Details	Yes
createdBy	long	UserId of creator Example: `123`	No
currency	string	Currency code Example: `"SGD"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
deleted	boolean	Quotation deleted Example: `false`	No
documentDate	dateTime	Document date Example: `"27-10-2019"`	No
documentSequenceCode	string	Quotation Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
errors	[ string ]	List of validation error messages	No
exchangeRate	double	Exchange rate Example: `0.01891562`	No
fulfillmentDate	dateTime	Fulfillment date Example: `"28-10-2019"`	No
fulfillmentOn	dateTime	Fulfillment On Example: `"28-10-2019"`	No
fulfillmentStatus	string	Fulfillment status Enum: `"UNFULFILLED"`, `"PARTIAL_FULFILLED"`, `"FULLY_FULFILLED"` Example: `"UNFULFILLED"`	No
fulfillmentType	string	Fulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP _Enum:`"NONE"`, `"DEFAULT"`, `"PICK_PACK_SHIP"`, `"DROP_SHIP"` Example: `"PICK_PACK_SHIP"`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedSalesInvoices	[ LinkedSalesInvoiceResponse ]		No
linkedSalesOrders	[ LinkedSalesOrderResponse ]		No
memo	string	Memo text Example: `"Sales quotation"`	No
processedInPPS	boolean		No
quotationItemDtoList	[ QuotationItemDto ]	Quotation items information	No
recurring	boolean	Is quotation set to recurring Example: `false`	No
recurringActivated	boolean	Is quotation recurring active Example: `false`	No
reservedStock	boolean	Reserved stock enabled Example: `true`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipByDate	dateTime	Ship by date Example: `"25-10-2019"`	No
shipFrom	Address	Ship from Address.	No
shipTo	Address	Ship to Address.	No
sourceAppName	string	Source App Name Example: `"BOOKS"`	No
status	string	Quotation status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"` Example: `"OPEN"`	No
tenantId	long	Tenant id Example: `123`	No
unitPriceGstInclusive	boolean	Unit Price is GST inclusive Example: `true`	No
validTillDate	dateTime	Valid till date Example: `"29-10-2019"`	No
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	No

QuotationDtoAustralia

Name	Type	Description	Required
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachments	[ string ]	Attachments url's	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if backorder created Example: `true`	No
billTo	Address	Bill to Address.	No
contact	ContactInfo	Contact info Example: `"contact object"`	No
contactCode	string	Contact code Example: `"C-0001"`	Yes
contactDto	ContactDto	Contact Details	Yes
createdBy	long	UserId of creator Example: `123`	No
currency	string	Currency code Example: `"SGD"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
deleted	boolean	Quotation deleted Example: `false`	No
documentDate	dateTime	Document date Example: `"27-10-2019"`	No
documentSequenceCode	string	Quotation Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
errors	[ string ]	List of validation error messages	No
exchangeRate	double	Exchange rate Example: `0.01891562`	No
fulfillmentDate	dateTime	Fulfillment date Example: `"28-10-2019"`	No
fulfillmentOn	dateTime	Fulfillment On Example: `"28-10-2019"`	No
fulfillmentStatus	string	Fulfillment status Enum: `"UNFULFILLED"`, `"PARTIAL_FULFILLED"`, `"FULLY_FULFILLED"` Example: `"UNFULFILLED"`	No
fulfillmentType	string	Fulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP _Enum:`"NONE"`, `"DEFAULT"`, `"PICK_PACK_SHIP"`, `"DROP_SHIP"` Example: `"PICK_PACK_SHIP"`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedSalesInvoices	[ LinkedSalesInvoiceResponse ]		No
linkedSalesOrders	[ LinkedSalesOrderResponse ]		No
memo	string	Memo text Example: `"Sales quotation"`	No
processedInPPS	boolean		No
quotationItemDtoList	[ QuotationItemDtoAustralia ]	Quotation items information	No
recurring	boolean	Is quotation set to recurring Example: `false`	No
recurringActivated	boolean	Is quotation recurring active Example: `false`	No
reservedStock	boolean	Reserved stock enabled Example: `true`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipByDate	dateTime	Ship by date Example: `"25-10-2019"`	No
shipFrom	Address	Ship from Address.	No
shipTo	Address	Ship to Address.	No
sourceAppName	string	Source App Name Example: `"BOOKS"`	No
status	string	Quotation status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"` Example: `"OPEN"`	No
tenantId	long	Tenant id Example: `123`	No
unitPriceGstInclusive	boolean	Unit Price is GST inclusive Example: `true`	No
validTillDate	dateTime	Valid till date Example: `"29-10-2019"`	No
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	No

QuotationDtoCanada

Name	Type	Description	Required
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachments	[ string ]	Attachments url's	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if backorder created Example: `true`	No
billTo	Address	Bill to Address.	No
contact	ContactInfo	Contact info Example: `"contact object"`	No
contactCode	string	Contact code Example: `"C-0001"`	Yes
contactDto	ContactDto	Contact Details	Yes
createdBy	long	UserId of creator Example: `123`	No
currency	string	Currency code Example: `"SGD"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
deleted	boolean	Quotation deleted Example: `false`	No
documentDate	dateTime	Document date Example: `"27-10-2019"`	No
documentSequenceCode	string	Quotation Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
errors	[ string ]	List of validation error messages	No
exchangeRate	double	Exchange rate Example: `0.01891562`	No
fulfillmentDate	dateTime	Fulfillment date Example: `"28-10-2019"`	No
fulfillmentOn	dateTime	Fulfillment On Example: `"28-10-2019"`	No
fulfillmentStatus	string	Fulfillment status Enum: `"UNFULFILLED"`, `"PARTIAL_FULFILLED"`, `"FULLY_FULFILLED"` Example: `"UNFULFILLED"`	No
fulfillmentType	string	Fulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP _Enum:`"NONE"`, `"DEFAULT"`, `"PICK_PACK_SHIP"`, `"DROP_SHIP"` Example: `"PICK_PACK_SHIP"`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedSalesInvoices	[ LinkedSalesInvoiceResponse ]		No
linkedSalesOrders	[ LinkedSalesOrderResponse ]		No
memo	string	Memo text Example: `"Sales quotation"`	No
processedInPPS	boolean		No
quotationItemDtoList	[ QuotationItemDtoCanada ]	Quotation items information	No
recurring	boolean	Is quotation set to recurring Example: `false`	No
recurringActivated	boolean	Is quotation recurring active Example: `false`	No
reservedStock	boolean	Reserved stock enabled Example: `true`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipByDate	dateTime	Ship by date Example: `"25-10-2019"`	No
shipFrom	Address	Ship from Address.	No
shipTo	Address	Ship to Address.	No
sourceAppName	string	Source App Name Example: `"BOOKS"`	No
status	string	Quotation status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"` Example: `"OPEN"`	No
tenantId	long	Tenant id Example: `123`	No
unitPriceGstInclusive	boolean	Unit Price is GST inclusive Example: `true`	No
validTillDate	dateTime	Valid till date Example: `"29-10-2019"`	No
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	No

QuotationDtoDE

Name	Type	Description	Required
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachments	[ string ]	Attachments url's	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if backorder created Example: `true`	No
billTo	Address	Bill to Address.	No
contact	ContactInfo	Contact info Example: `"contact object"`	No
contactCode	string	Contact code Example: `"C-0001"`	Yes
contactDto	ContactDto	Contact Details	Yes
createdBy	long	UserId of creator Example: `123`	No
currency	string	Currency code Example: `"SGD"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
deleted	boolean	Quotation deleted Example: `false`	No
documentDate	dateTime	Document date Example: `"27-10-2019"`	No
documentSequenceCode	string	Quotation Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
errors	[ string ]	List of validation error messages	No
exchangeRate	double	Exchange rate Example: `0.01891562`	No
fulfillmentDate	dateTime	Fulfillment date Example: `"28-10-2019"`	No
fulfillmentOn	dateTime	Fulfillment On Example: `"28-10-2019"`	No
fulfillmentStatus	string	Fulfillment status Enum: `"UNFULFILLED"`, `"PARTIAL_FULFILLED"`, `"FULLY_FULFILLED"` Example: `"UNFULFILLED"`	No
fulfillmentType	string	Fulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP _Enum:`"NONE"`, `"DEFAULT"`, `"PICK_PACK_SHIP"`, `"DROP_SHIP"` Example: `"PICK_PACK_SHIP"`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedSalesInvoices	[ LinkedSalesInvoiceResponse ]		No
linkedSalesOrders	[ LinkedSalesOrderResponse ]		No
memo	string	Memo text Example: `"Sales quotation"`	No
processedInPPS	boolean		No
quotationItemDtoList	[ QuotationItemDtoDE ]	Quotation items information	No
recurring	boolean	Is quotation set to recurring Example: `false`	No
recurringActivated	boolean	Is quotation recurring active Example: `false`	No
reservedStock	boolean	Reserved stock enabled Example: `true`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipByDate	dateTime	Ship by date Example: `"25-10-2019"`	No
shipFrom	Address	Ship from Address.	No
shipTo	Address	Ship to Address.	No
sourceAppName	string	Source App Name Example: `"BOOKS"`	No
status	string	Quotation status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"` Example: `"OPEN"`	No
tenantId	long	Tenant id Example: `123`	No
unitPriceGstInclusive	boolean	Unit Price is GST inclusive Example: `true`	No
validTillDate	dateTime	Valid till date Example: `"29-10-2019"`	No
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	No

QuotationDtoIndonesia

Name	Type	Description	Required
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachments	[ string ]	Attachments url's	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if backorder created Example: `true`	No
billTo	Address	Bill to Address.	No
contact	ContactInfo	Contact info Example: `"contact object"`	No
contactCode	string	Contact code Example: `"C-0001"`	Yes
contactDto	ContactDto	Contact Details	Yes
createdBy	long	UserId of creator Example: `123`	No
currency	string	Currency code Example: `"SGD"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
deleted	boolean	Quotation deleted Example: `false`	No
documentDate	dateTime	Document date Example: `"27-10-2019"`	No
documentSequenceCode	string	Quotation Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
errors	[ string ]	List of validation error messages	No
exchangeRate	double	Exchange rate Example: `0.01891562`	No
fulfillmentDate	dateTime	Fulfillment date Example: `"28-10-2019"`	No
fulfillmentOn	dateTime	Fulfillment On Example: `"28-10-2019"`	No
fulfillmentStatus	string	Fulfillment status Enum: `"UNFULFILLED"`, `"PARTIAL_FULFILLED"`, `"FULLY_FULFILLED"` Example: `"UNFULFILLED"`	No
fulfillmentType	string	Fulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP _Enum:`"NONE"`, `"DEFAULT"`, `"PICK_PACK_SHIP"`, `"DROP_SHIP"` Example: `"PICK_PACK_SHIP"`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedSalesInvoices	[ LinkedSalesInvoiceResponse ]		No
linkedSalesOrders	[ LinkedSalesOrderResponse ]		No
memo	string	Memo text Example: `"Sales quotation"`	No
processedInPPS	boolean		No
quotationItemDtoList	[ QuotationItemDtoIndonesia ]	Quotation items information	No
recurring	boolean	Is quotation set to recurring Example: `false`	No
recurringActivated	boolean	Is quotation recurring active Example: `false`	No
reservedStock	boolean	Reserved stock enabled Example: `true`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipByDate	dateTime	Ship by date Example: `"25-10-2019"`	No
shipFrom	Address	Ship from Address.	No
shipTo	Address	Ship to Address.	No
sourceAppName	string	Source App Name Example: `"BOOKS"`	No
status	string	Quotation status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"` Example: `"OPEN"`	No
tenantId	long	Tenant id Example: `123`	No
unitPriceGstInclusive	boolean	Unit Price is GST inclusive Example: `true`	No
validTillDate	dateTime	Valid till date Example: `"29-10-2019"`	No
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	No

QuotationDtoMalaysia

Name	Type	Description	Required
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachments	[ string ]	Attachments url's	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if backorder created Example: `true`	No
billTo	Address	Bill to Address.	No
contact	ContactInfo	Contact info Example: `"contact object"`	No
contactCode	string	Contact code Example: `"C-0001"`	Yes
contactDto	ContactDto	Contact Details	Yes
createdBy	long	UserId of creator Example: `123`	No
currency	string	Currency code Example: `"SGD"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
deleted	boolean	Quotation deleted Example: `false`	No
documentDate	dateTime	Document date Example: `"27-10-2019"`	No
documentSequenceCode	string	Quotation Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
errors	[ string ]	List of validation error messages	No
exchangeRate	double	Exchange rate Example: `0.01891562`	No
fulfillmentDate	dateTime	Fulfillment date Example: `"28-10-2019"`	No
fulfillmentOn	dateTime	Fulfillment On Example: `"28-10-2019"`	No
fulfillmentStatus	string	Fulfillment status Enum: `"UNFULFILLED"`, `"PARTIAL_FULFILLED"`, `"FULLY_FULFILLED"` Example: `"UNFULFILLED"`	No
fulfillmentType	string	Fulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP _Enum:`"NONE"`, `"DEFAULT"`, `"PICK_PACK_SHIP"`, `"DROP_SHIP"` Example: `"PICK_PACK_SHIP"`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedSalesInvoices	[ LinkedSalesInvoiceResponse ]		No
linkedSalesOrders	[ LinkedSalesOrderResponse ]		No
memo	string	Memo text Example: `"Sales quotation"`	No
processedInPPS	boolean		No
quotationItemDtoList	[ QuotationItemDtoMalaysia ]	Quotation items information	No
recurring	boolean	Is quotation set to recurring Example: `false`	No
recurringActivated	boolean	Is quotation recurring active Example: `false`	No
reservedStock	boolean	Reserved stock enabled Example: `true`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipByDate	dateTime	Ship by date Example: `"25-10-2019"`	No
shipFrom	Address	Ship from Address.	No
shipTo	Address	Ship to Address.	No
sourceAppName	string	Source App Name Example: `"BOOKS"`	No
status	string	Quotation status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"` Example: `"OPEN"`	No
tenantId	long	Tenant id Example: `123`	No
unitPriceGstInclusive	boolean	Unit Price is GST inclusive Example: `true`	No
validTillDate	dateTime	Valid till date Example: `"29-10-2019"`	No
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	No

QuotationDtoSaudiArabia

Name	Type	Description	Required
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachments	[ string ]	Attachments url's	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if backorder created Example: `true`	No
billTo	Address	Bill to Address.	No
contact	ContactInfo	Contact info Example: `"contact object"`	No
contactCode	string	Contact code Example: `"C-0001"`	Yes
contactDto	ContactDto	Contact Details	Yes
createdBy	long	UserId of creator Example: `123`	No
currency	string	Currency code Example: `"SGD"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
deleted	boolean	Quotation deleted Example: `false`	No
documentDate	dateTime	Document date Example: `"27-10-2019"`	No
documentSequenceCode	string	Quotation Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
errors	[ string ]	List of validation error messages	No
exchangeRate	double	Exchange rate Example: `0.01891562`	No
fulfillmentDate	dateTime	Fulfillment date Example: `"28-10-2019"`	No
fulfillmentOn	dateTime	Fulfillment On Example: `"28-10-2019"`	No
fulfillmentStatus	string	Fulfillment status Enum: `"UNFULFILLED"`, `"PARTIAL_FULFILLED"`, `"FULLY_FULFILLED"` Example: `"UNFULFILLED"`	No
fulfillmentType	string	Fulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP _Enum:`"NONE"`, `"DEFAULT"`, `"PICK_PACK_SHIP"`, `"DROP_SHIP"` Example: `"PICK_PACK_SHIP"`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedSalesInvoices	[ LinkedSalesInvoiceResponse ]		No
linkedSalesOrders	[ LinkedSalesOrderResponse ]		No
memo	string	Memo text Example: `"Sales quotation"`	No
processedInPPS	boolean		No
quotationItemDtoList	[ QuotationItemDtoSaudiArabia ]	Quotation items information	No
recurring	boolean	Is quotation set to recurring Example: `false`	No
recurringActivated	boolean	Is quotation recurring active Example: `false`	No
reservedStock	boolean	Reserved stock enabled Example: `true`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipByDate	dateTime	Ship by date Example: `"25-10-2019"`	No
shipFrom	Address	Ship from Address.	No
shipTo	Address	Ship to Address.	No
sourceAppName	string	Source App Name Example: `"BOOKS"`	No
status	string	Quotation status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"` Example: `"OPEN"`	No
tenantId	long	Tenant id Example: `123`	No
unitPriceGstInclusive	boolean	Unit Price is GST inclusive Example: `true`	No
validTillDate	dateTime	Valid till date Example: `"29-10-2019"`	No
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	No

QuotationDtoUAE

Name	Type	Description	Required
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachments	[ string ]	Attachments url's	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if backorder created Example: `true`	No
billTo	Address	Bill to Address.	No
contact	ContactInfo	Contact info Example: `"contact object"`	No
contactCode	string	Contact code Example: `"C-0001"`	Yes
contactDto	ContactDto	Contact Details	Yes
createdBy	long	UserId of creator Example: `123`	No
currency	string	Currency code Example: `"SGD"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
deleted	boolean	Quotation deleted Example: `false`	No
documentDate	dateTime	Document date Example: `"27-10-2019"`	No
documentSequenceCode	string	Quotation Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
errors	[ string ]	List of validation error messages	No
exchangeRate	double	Exchange rate Example: `0.01891562`	No
fulfillmentDate	dateTime	Fulfillment date Example: `"28-10-2019"`	No
fulfillmentOn	dateTime	Fulfillment On Example: `"28-10-2019"`	No
fulfillmentStatus	string	Fulfillment status Enum: `"UNFULFILLED"`, `"PARTIAL_FULFILLED"`, `"FULLY_FULFILLED"` Example: `"UNFULFILLED"`	No
fulfillmentType	string	Fulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP _Enum:`"NONE"`, `"DEFAULT"`, `"PICK_PACK_SHIP"`, `"DROP_SHIP"` Example: `"PICK_PACK_SHIP"`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedSalesInvoices	[ LinkedSalesInvoiceResponse ]		No
linkedSalesOrders	[ LinkedSalesOrderResponse ]		No
memo	string	Memo text Example: `"Sales quotation"`	No
processedInPPS	boolean		No
quotationItemDtoList	[ QuotationItemDtoUAE ]	Quotation items information	No
recurring	boolean	Is quotation set to recurring Example: `false`	No
recurringActivated	boolean	Is quotation recurring active Example: `false`	No
reservedStock	boolean	Reserved stock enabled Example: `true`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipByDate	dateTime	Ship by date Example: `"25-10-2019"`	No
shipFrom	Address	Ship from Address.	No
shipTo	Address	Ship to Address.	No
sourceAppName	string	Source App Name Example: `"BOOKS"`	No
status	string	Quotation status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"` Example: `"OPEN"`	No
tenantId	long	Tenant id Example: `123`	No
unitPriceGstInclusive	boolean	Unit Price is GST inclusive Example: `true`	No
validTillDate	dateTime	Valid till date Example: `"29-10-2019"`	No
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	No

QuotationDtoUk

Name	Type	Description	Required
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachments	[ string ]	Attachments url's	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if backorder created Example: `true`	No
billTo	Address	Bill to Address.	No
contact	ContactInfo	Contact info Example: `"contact object"`	No
contactCode	string	Contact code Example: `"C-0001"`	Yes
contactDto	ContactDto	Contact Details	Yes
createdBy	long	UserId of creator Example: `123`	No
currency	string	Currency code Example: `"SGD"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
deleted	boolean	Quotation deleted Example: `false`	No
documentDate	dateTime	Document date Example: `"27-10-2019"`	No
documentSequenceCode	string	Quotation Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
errors	[ string ]	List of validation error messages	No
exchangeRate	double	Exchange rate Example: `0.01891562`	No
fulfillmentDate	dateTime	Fulfillment date Example: `"28-10-2019"`	No
fulfillmentOn	dateTime	Fulfillment On Example: `"28-10-2019"`	No
fulfillmentStatus	string	Fulfillment status Enum: `"UNFULFILLED"`, `"PARTIAL_FULFILLED"`, `"FULLY_FULFILLED"` Example: `"UNFULFILLED"`	No
fulfillmentType	string	Fulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP _Enum:`"NONE"`, `"DEFAULT"`, `"PICK_PACK_SHIP"`, `"DROP_SHIP"` Example: `"PICK_PACK_SHIP"`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedSalesInvoices	[ LinkedSalesInvoiceResponse ]		No
linkedSalesOrders	[ LinkedSalesOrderResponse ]		No
memo	string	Memo text Example: `"Sales quotation"`	No
processedInPPS	boolean		No
quotationItemDtoList	[ QuotationItemDtoUk ]	Quotation items information	No
recurring	boolean	Is quotation set to recurring Example: `false`	No
recurringActivated	boolean	Is quotation recurring active Example: `false`	No
reservedStock	boolean	Reserved stock enabled Example: `true`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipByDate	dateTime	Ship by date Example: `"25-10-2019"`	No
shipFrom	Address	Ship from Address.	No
shipTo	Address	Ship to Address.	No
sourceAppName	string	Source App Name Example: `"BOOKS"`	No
status	string	Quotation status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"` Example: `"OPEN"`	No
tenantId	long	Tenant id Example: `123`	No
unitPriceGstInclusive	boolean	Unit Price is GST inclusive Example: `true`	No
validTillDate	dateTime	Valid till date Example: `"29-10-2019"`	No
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	No

QuotationIndiaDto

Name	Type	Description	Required
additionalCharges	AdditionalCharges		No
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachments	[ string ]	Attachments url's	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if backorder created Example: `true`	No
billTo	Address	Bill to Address.	No
contact	ContactInfo	Contact info Example: `"contact object"`	No
contactCode	string	Contact code Example: `"C-0001"`	Yes
contactDto	ContactDto	Contact Details	Yes
createdBy	long	UserId of creator Example: `123`	No
currency	string	Currency code Example: `"SGD"`	No
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
deleted	boolean	Quotation deleted Example: `false`	No
documentDate	dateTime	Document date Example: `"27-10-2019"`	No
documentSequenceCode	string	Quotation Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
errors	[ string ]	List of validation error messages	No
exchangeRate	double	Exchange rate Example: `0.01891562`	No
fulfillmentDate	dateTime	Fulfillment date Example: `"28-10-2019"`	No
fulfillmentOn	dateTime	Fulfillment On Example: `"28-10-2019"`	No
fulfillmentStatus	string	Fulfillment status Enum: `"UNFULFILLED"`, `"PARTIAL_FULFILLED"`, `"FULLY_FULFILLED"` Example: `"UNFULFILLED"`	No
fulfillmentType	string	Fulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP _Enum:`"NONE"`, `"DEFAULT"`, `"PICK_PACK_SHIP"`, `"DROP_SHIP"` Example: `"PICK_PACK_SHIP"`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	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: `"REGISTERED_BUSINESS_REGULAR"`	Yes
gstin	string	Indian state from where the good/service is shipped Example: `"22AAAAAA00000AA21"`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedSalesInvoices	[ LinkedSalesInvoiceResponse ]		No
linkedSalesOrders	[ LinkedSalesOrderResponse ]		No
memo	string	Memo text Example: `"Sales quotation"`	No
placeOfSupply	string	Indian state from where the good/service is shipped Example: `"Delhi"`	No
processedInPPS	boolean		No
quotationItemDtoList	[ QuotationItemIndiaDto ]	Quotation items information	No
recurring	boolean	Is quotation set to recurring Example: `false`	No
recurringActivated	boolean	Is quotation recurring active Example: `false`	No
reservedStock	boolean	Reserved stock enabled Example: `true`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipByDate	dateTime	Ship by date Example: `"25-10-2019"`	No
shipFrom	Address	Ship from Address.	No
shipTo	Address	Ship to Address.	No
sourceAppName	string	Source App Name Example: `"BOOKS"`	No
status	string	Quotation status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number		No
tcsAmountInBaseCurrency	number		No
tcsPercentage	number		No
tcsRateId	long		No
tenantId	long	Tenant id Example: `123`	No
unitPriceGstInclusive	boolean	Unit Price is GST inclusive Example: `true`	No
validTillDate	dateTime	Valid till date Example: `"29-10-2019"`	No
vendorType	string	Vendor Type Enum: `"IMPORT"`, `"NA"`, `"SEZ_W_PAY"`, `"SEZ_WO_PAY"` Example: `"NA"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	No

QuotationInformation

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase invoice additional charges details	No
attachments	[ string ]	Attachments url's	No
backOrder	boolean	Backorder flag to indicate if backorder created Example: `true`	No
billTo	Address	Bill to Address.	No
contact	ContactInfo	Contact info Example: `"contact object"`	No
contactCode	string	Contact code Example: `"C-0001"`	Yes
contactDto	ContactInformation	Contact Details	Yes
currency	string	Currency code Example: `"SGD"`	No
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
deleted	boolean	Quotation deleted Example: `false`	No
documentDate	string	Document date Example: `"27-10-2019"`	No
documentSequenceCode	string	Quotation Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
exchangeRate	double	Exchange rate Example: `0.01891562`	No
fulfillmentDate	string	Fulfillment date Example: `"28-10-2019"`	No
fulfillmentOn	string	Fulfillment On Example: `"28-10-2019"`	No
fulfillmentStatus	string	Fulfillment status Enum: `"UNFULFILLED"`, `"PARTIAL_FULFILLED"`, `"FULLY_FULFILLED"` Example: `"UNFULFILLED"`	No
fulfillmentType	string	Fulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP _Enum:`"NONE"`, `"DEFAULT"`, `"PICK_PACK_SHIP"`, `"DROP_SHIP"` Example: `"PICK_PACK_SHIP"`	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
hasPartialInvoice	boolean	Has Partial Invoice linked to quotation Example: `false`	Yes
hasPartialSalesOrder	boolean	Has Partial Sales Order linked to quotation Example: `false`	Yes
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedSalesInvoices	[ LinkedSalesInvoiceResponse ]	List of Linked Sales Invoices	No
linkedSalesOrders	[ LinkedSalesOrderResponse ]	List of Linked Sales Invoices	No
memo	string	Memo text Example: `"Sales quotation"`	No
placeOfSupply	string	Indian state from where the good/service is shipped Example: `"Delhi"`	No
processedInPPS	boolean		No
quotationItemDtoList	[ QuotationItemInformation ]	Quotation items information	No
recurring	boolean	Is quotation set to recurring Example: `false`	No
recurringActivated	boolean	Is quotation recurring active Example: `false`	No
reservedStock	boolean	Is quotation has reserved quantity Example: `false`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	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
status	string	Quotation status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"` Example: `"OPEN"`	No
tcsAmount	number		No
tcsAmountInBaseCurrency	number		No
tcsPercentage	number		No
tcsRateId	long		No
tenantId	long	Tenant id Example: `123`	No
unitPriceGstInclusive	boolean	Unit Price is GST inclusive Example: `true`	No
validTillDate	string	Valid till date Example: `"29-10-2019"`	No
vendorType	string	Vendor Type Enum: `"IMPORT"`, `"NA"`, `"SEZ_W_PAY"`, `"SEZ_WO_PAY"` Example: `"NA"`	Yes
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	No

QuotationIsraelDto

Name	Type	Description	Required
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachments	[ string ]	Attachments url's	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if backorder created Example: `true`	No
billTo	Address	Bill to Address.	No
contact	ContactInfo	Contact info Example: `"contact object"`	No
contactCode	string	Contact code Example: `"C-0001"`	Yes
contactDto	ContactDto	Contact Details	Yes
createdBy	long	UserId of creator Example: `123`	No
currency	string	Currency code Example: `"SGD"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
deleted	boolean	Quotation deleted Example: `false`	No
documentDate	dateTime	Document date Example: `"27-10-2019"`	No
documentSequenceCode	string	Quotation Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
errors	[ string ]	List of validation error messages	No
exchangeRate	double	Exchange rate Example: `0.01891562`	No
fulfillmentDate	dateTime	Fulfillment date Example: `"28-10-2019"`	No
fulfillmentOn	dateTime	Fulfillment On Example: `"28-10-2019"`	No
fulfillmentStatus	string	Fulfillment status Enum: `"UNFULFILLED"`, `"PARTIAL_FULFILLED"`, `"FULLY_FULFILLED"` Example: `"UNFULFILLED"`	No
fulfillmentType	string	Fulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP _Enum:`"NONE"`, `"DEFAULT"`, `"PICK_PACK_SHIP"`, `"DROP_SHIP"` Example: `"PICK_PACK_SHIP"`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedSalesInvoices	[ LinkedSalesInvoiceResponse ]		No
linkedSalesOrders	[ LinkedSalesOrderResponse ]		No
memo	string	Memo text Example: `"Sales quotation"`	No
processedInPPS	boolean		No
quotationItemDtoList	[ QuotationItemIsraelDto ]	Quotation items information	No
recurring	boolean	Is quotation set to recurring Example: `false`	No
recurringActivated	boolean	Is quotation recurring active Example: `false`	No
reservedStock	boolean	Reserved stock enabled Example: `true`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipByDate	dateTime	Ship by date Example: `"25-10-2019"`	No
shipFrom	Address	Ship from Address.	No
shipTo	Address	Ship to Address.	No
sourceAppName	string	Source App Name Example: `"BOOKS"`	No
status	string	Quotation status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"` Example: `"OPEN"`	No
tenantId	long	Tenant id Example: `123`	No
unitPriceGstInclusive	boolean	Unit Price is GST inclusive Example: `true`	No
validTillDate	dateTime	Valid till date Example: `"29-10-2019"`	No
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	No

QuotationItemDto

Name	Type	Description	Required
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
allocationType	string	Allocation Type Example: `"NORMAL"`	No
availableQuantity	number	Total available quantity Example: `3`	No
basePrice	number	Revenue Base price Example: `120`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Product 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
fulfilledQuantity	number	Total Fulfilled Quantity Example: `3`	No
fulfilledQuantityByFlowover	number	Total Fulfilled Quantity By Flowover Example: `3`	No
fulfilledQuantityByUser	number	Total Fulfilled Quantity By User Example: `3`	No
fulfilledQuantityInvoiced	number	Total Fulfilled Quantity Invoiced Example: `3`	No
fulfillmentByDoc	[ ItemQtyFulfilledByDoc ]	Item Qty fulfilled by Fulfillment Doc Example: `[]`	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: `3`	No
product	ProductResponse	Product Short Info Example: `"product"`	No
productCode	string	Product code Example: `"PC-001"`	Yes
productDescription	string	Product description Example: `"Red pen"`	No
productName	string	Product name Example: `"Ball pen"`	No
productOrder	integer	Product order Example: `1`	No
productQuantity	number	Product quantity Example: `2.5`	Yes
reservedQuantitiesData	[ ReservedQuantityData ]	Reserved quantity data Example: `[]`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.3`	No
taxCode	string	Tax code Example: `"TX-003"`	No
taxName	string	Tax name Example: `"GST(7%)"`	No
type	string	Product type Enum: `"TRACKED"`, `"NONTRACKED"` Example: `"TRACKED"`	Yes
unitPrice	number	Product price Example: `10`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

QuotationItemDtoAustralia

Name	Type	Description	Required
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
allocationType	string	Allocation Type Example: `"NORMAL"`	No
availableQuantity	number	Total available quantity Example: `3`	No
basePrice	number	Revenue Base price Example: `120`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Product 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
fulfilledQuantity	number	Total Fulfilled Quantity Example: `3`	No
fulfilledQuantityByFlowover	number	Total Fulfilled Quantity By Flowover Example: `3`	No
fulfilledQuantityByUser	number	Total Fulfilled Quantity By User Example: `3`	No
fulfilledQuantityInvoiced	number	Total Fulfilled Quantity Invoiced Example: `3`	No
fulfillmentByDoc	[ ItemQtyFulfilledByDoc ]	Item Qty fulfilled by Fulfillment Doc Example: `[]`	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: `3`	No
product	ProductResponse	Product Short Info Example: `"product"`	No
productCode	string	Product code Example: `"PC-001"`	Yes
productDescription	string	Product description Example: `"Red pen"`	No
productName	string	Product name Example: `"Ball pen"`	No
productOrder	integer	Product order Example: `1`	No
productQuantity	number	Product quantity Example: `2.5`	Yes
reservedQuantitiesData	[ ReservedQuantityData ]	Reserved quantity data Example: `[]`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.3`	No
taxCode	string	Tax code Example: `"TX-003"`	No
taxName	string	Tax name Example: `"GST(7%)"`	No
type	string	Product type Enum: `"TRACKED"`, `"NONTRACKED"` Example: `"TRACKED"`	Yes
unitPrice	number	Product price Example: `10`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

QuotationItemDtoCanada

Name	Type	Description	Required
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
allocationType	string	Allocation Type Example: `"NORMAL"`	No
availableQuantity	number	Total available quantity Example: `3`	No
basePrice	number	Revenue Base price Example: `120`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Product 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
fulfilledQuantity	number	Total Fulfilled Quantity Example: `3`	No
fulfilledQuantityByFlowover	number	Total Fulfilled Quantity By Flowover Example: `3`	No
fulfilledQuantityByUser	number	Total Fulfilled Quantity By User Example: `3`	No
fulfilledQuantityInvoiced	number	Total Fulfilled Quantity Invoiced Example: `3`	No
fulfillmentByDoc	[ ItemQtyFulfilledByDoc ]	Item Qty fulfilled by Fulfillment Doc Example: `[]`	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: `3`	No
product	ProductResponse	Product Short Info Example: `"product"`	No
productCode	string	Product code Example: `"PC-001"`	Yes
productDescription	string	Product description Example: `"Red pen"`	No
productName	string	Product name Example: `"Ball pen"`	No
productOrder	integer	Product order Example: `1`	No
productQuantity	number	Product quantity Example: `2.5`	Yes
reservedQuantitiesData	[ ReservedQuantityData ]	Reserved quantity data Example: `[]`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.3`	No
taxCode	string	Tax code Example: `"TX-003"`	No
taxName	string	Tax name Example: `"GST(7%)"`	No
type	string	Product type Enum: `"TRACKED"`, `"NONTRACKED"` Example: `"TRACKED"`	Yes
unitPrice	number	Product price Example: `10`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

QuotationItemDtoDE

Name	Type	Description	Required
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
allocationType	string	Allocation Type Example: `"NORMAL"`	No
availableQuantity	number	Total available quantity Example: `3`	No
basePrice	number	Revenue Base price Example: `120`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Product 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
fulfilledQuantity	number	Total Fulfilled Quantity Example: `3`	No
fulfilledQuantityByFlowover	number	Total Fulfilled Quantity By Flowover Example: `3`	No
fulfilledQuantityByUser	number	Total Fulfilled Quantity By User Example: `3`	No
fulfilledQuantityInvoiced	number	Total Fulfilled Quantity Invoiced Example: `3`	No
fulfillmentByDoc	[ ItemQtyFulfilledByDoc ]	Item Qty fulfilled by Fulfillment Doc Example: `[]`	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: `3`	No
product	ProductResponse	Product Short Info Example: `"product"`	No
productCode	string	Product code Example: `"PC-001"`	Yes
productDescription	string	Product description Example: `"Red pen"`	No
productName	string	Product name Example: `"Ball pen"`	No
productOrder	integer	Product order Example: `1`	No
productQuantity	number	Product quantity Example: `2.5`	Yes
reservedQuantitiesData	[ ReservedQuantityData ]	Reserved quantity data Example: `[]`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.3`	No
taxCode	string	Tax code Example: `"TX-003"`	No
taxName	string	Tax name Example: `"GST(7%)"`	No
type	string	Product type Enum: `"TRACKED"`, `"NONTRACKED"` Example: `"TRACKED"`	Yes
unitPrice	number	Product price Example: `10`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

QuotationItemDtoIndonesia

Name	Type	Description	Required
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
allocationType	string	Allocation Type Example: `"NORMAL"`	No
availableQuantity	number	Total available quantity Example: `3`	No
basePrice	number	Revenue Base price Example: `120`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Product 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
exciseAmount	number	Excise amount on product Example: `0.5`	No
exciseRate	number	Rate of Excise Example: `5`	No
exciseType	string	Excise type Enum: `"PERCENT"`, `"FLAT"` Example: `"FLAT"`	No
fulfilledQuantity	number	Total Fulfilled Quantity Example: `3`	No
fulfilledQuantityByFlowover	number	Total Fulfilled Quantity By Flowover Example: `3`	No
fulfilledQuantityByUser	number	Total Fulfilled Quantity By User Example: `3`	No
fulfilledQuantityInvoiced	number	Total Fulfilled Quantity Invoiced Example: `3`	No
fulfillmentByDoc	[ ItemQtyFulfilledByDoc ]	Item Qty fulfilled by Fulfillment Doc Example: `[]`	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: `3`	No
product	ProductResponse	Product Short Info Example: `"product"`	No
productCode	string	Product code Example: `"PC-001"`	Yes
productDescription	string	Product description Example: `"Red pen"`	No
productName	string	Product name Example: `"Ball pen"`	No
productOrder	integer	Product order Example: `1`	No
productQuantity	number	Product quantity Example: `2.5`	Yes
reservedQuantitiesData	[ ReservedQuantityData ]	Reserved quantity data Example: `[]`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.3`	No
taxCode	string	Tax code Example: `"TX-003"`	No
taxName	string	Tax name Example: `"GST(7%)"`	No
type	string	Product type Enum: `"TRACKED"`, `"NONTRACKED"` Example: `"TRACKED"`	Yes
unitPrice	number	Product price Example: `10`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

QuotationItemDtoMalaysia

Name	Type	Description	Required
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
allocationType	string	Allocation Type Example: `"NORMAL"`	No
availableQuantity	number	Total available quantity Example: `3`	No
basePrice	number	Revenue Base price Example: `120`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Product 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
fulfilledQuantity	number	Total Fulfilled Quantity Example: `3`	No
fulfilledQuantityByFlowover	number	Total Fulfilled Quantity By Flowover Example: `3`	No
fulfilledQuantityByUser	number	Total Fulfilled Quantity By User Example: `3`	No
fulfilledQuantityInvoiced	number	Total Fulfilled Quantity Invoiced Example: `3`	No
fulfillmentByDoc	[ ItemQtyFulfilledByDoc ]	Item Qty fulfilled by Fulfillment Doc Example: `[]`	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: `3`	No
product	ProductResponse	Product Short Info Example: `"product"`	No
productCode	string	Product code Example: `"PC-001"`	Yes
productDescription	string	Product description Example: `"Red pen"`	No
productName	string	Product name Example: `"Ball pen"`	No
productOrder	integer	Product order Example: `1`	No
productQuantity	number	Product quantity Example: `2.5`	Yes
reservedQuantitiesData	[ ReservedQuantityData ]	Reserved quantity data Example: `[]`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.3`	No
taxCode	string	Tax code Example: `"TX-003"`	No
taxName	string	Tax name Example: `"GST(7%)"`	No
type	string	Product type Enum: `"TRACKED"`, `"NONTRACKED"` Example: `"TRACKED"`	Yes
unitPrice	number	Product price Example: `10`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

QuotationItemDtoSaudiArabia

Name	Type	Description	Required
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
allocationType	string	Allocation Type Example: `"NORMAL"`	No
availableQuantity	number	Total available quantity Example: `3`	No
basePrice	number	Revenue Base price Example: `120`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Product 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
exciseAmount	number	Excise amount on product Example: `0.5`	No
exciseRate	number	Rate of Excise Example: `5`	No
exciseType	string	Excise type Enum: `"PERCENT"`, `"FLAT"` Example: `"FLAT"`	No
fulfilledQuantity	number	Total Fulfilled Quantity Example: `3`	No
fulfilledQuantityByFlowover	number	Total Fulfilled Quantity By Flowover Example: `3`	No
fulfilledQuantityByUser	number	Total Fulfilled Quantity By User Example: `3`	No
fulfilledQuantityInvoiced	number	Total Fulfilled Quantity Invoiced Example: `3`	No
fulfillmentByDoc	[ ItemQtyFulfilledByDoc ]	Item Qty fulfilled by Fulfillment Doc Example: `[]`	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: `3`	No
product	ProductResponse	Product Short Info Example: `"product"`	No
productCode	string	Product code Example: `"PC-001"`	Yes
productDescription	string	Product description Example: `"Red pen"`	No
productName	string	Product name Example: `"Ball pen"`	No
productOrder	integer	Product order Example: `1`	No
productQuantity	number	Product quantity Example: `2.5`	Yes
reservedQuantitiesData	[ ReservedQuantityData ]	Reserved quantity data Example: `[]`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.3`	No
taxCode	string	Tax code Example: `"TX-003"`	No
taxName	string	Tax name Example: `"GST(7%)"`	No
type	string	Product type Enum: `"TRACKED"`, `"NONTRACKED"` Example: `"TRACKED"`	Yes
unitPrice	number	Product price Example: `10`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

QuotationItemDtoUAE

Name	Type	Description	Required
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
allocationType	string	Allocation Type Example: `"NORMAL"`	No
availableQuantity	number	Total available quantity Example: `3`	No
basePrice	number	Revenue Base price Example: `120`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Product 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
exciseAmount	number	Excise amount on product Example: `0.5`	No
exciseRate	number	Rate of Excise Example: `5`	No
exciseType	string	Excise type Enum: `"PERCENT"`, `"FLAT"` Example: `"FLAT"`	No
fulfilledQuantity	number	Total Fulfilled Quantity Example: `3`	No
fulfilledQuantityByFlowover	number	Total Fulfilled Quantity By Flowover Example: `3`	No
fulfilledQuantityByUser	number	Total Fulfilled Quantity By User Example: `3`	No
fulfilledQuantityInvoiced	number	Total Fulfilled Quantity Invoiced Example: `3`	No
fulfillmentByDoc	[ ItemQtyFulfilledByDoc ]	Item Qty fulfilled by Fulfillment Doc Example: `[]`	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: `3`	No
product	ProductResponse	Product Short Info Example: `"product"`	No
productCode	string	Product code Example: `"PC-001"`	Yes
productDescription	string	Product description Example: `"Red pen"`	No
productName	string	Product name Example: `"Ball pen"`	No
productOrder	integer	Product order Example: `1`	No
productQuantity	number	Product quantity Example: `2.5`	Yes
reservedQuantitiesData	[ ReservedQuantityData ]	Reserved quantity data Example: `[]`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.3`	No
taxCode	string	Tax code Example: `"TX-003"`	No
taxName	string	Tax name Example: `"GST(7%)"`	No
type	string	Product type Enum: `"TRACKED"`, `"NONTRACKED"` Example: `"TRACKED"`	Yes
unitPrice	number	Product price Example: `10`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

QuotationItemDtoUk

Name	Type	Description	Required
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
allocationType	string	Allocation Type Example: `"NORMAL"`	No
availableQuantity	number	Total available quantity Example: `3`	No
basePrice	number	Revenue Base price Example: `120`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Product 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
fulfilledQuantity	number	Total Fulfilled Quantity Example: `3`	No
fulfilledQuantityByFlowover	number	Total Fulfilled Quantity By Flowover Example: `3`	No
fulfilledQuantityByUser	number	Total Fulfilled Quantity By User Example: `3`	No
fulfilledQuantityInvoiced	number	Total Fulfilled Quantity Invoiced Example: `3`	No
fulfillmentByDoc	[ ItemQtyFulfilledByDoc ]	Item Qty fulfilled by Fulfillment Doc Example: `[]`	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: `3`	No
product	ProductResponse	Product Short Info Example: `"product"`	No
productCode	string	Product code Example: `"PC-001"`	Yes
productDescription	string	Product description Example: `"Red pen"`	No
productName	string	Product name Example: `"Ball pen"`	No
productOrder	integer	Product order Example: `1`	No
productQuantity	number	Product quantity Example: `2.5`	Yes
reservedQuantitiesData	[ ReservedQuantityData ]	Reserved quantity data Example: `[]`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.3`	No
taxCode	string	Tax code Example: `"TX-003"`	No
taxName	string	Tax name Example: `"GST(7%)"`	No
type	string	Product type Enum: `"TRACKED"`, `"NONTRACKED"` Example: `"TRACKED"`	Yes
unitPrice	number	Product price Example: `10`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

QuotationItemIndiaDto

Name	Type	Description	Required
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
allocationType	string	Allocation Type Example: `"NORMAL"`	No
availableQuantity	number	Total available quantity Example: `3`	No
basePrice	number	Revenue Base price Example: `120`	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	Product 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
fulfilledQuantity	number	Total Fulfilled Quantity Example: `3`	No
fulfilledQuantityByFlowover	number	Total Fulfilled Quantity By Flowover Example: `3`	No
fulfilledQuantityByUser	number	Total Fulfilled Quantity By User Example: `3`	No
fulfilledQuantityInvoiced	number	Total Fulfilled Quantity Invoiced Example: `3`	No
fulfillmentByDoc	[ ItemQtyFulfilledByDoc ]	Item Qty fulfilled by Fulfillment Doc Example: `[]`	No
hsnOrSacCode	string	Hsn or Sac code Example: `110011`	No
igstAmount	number	India specific IGST tax amount on total amount Example: `5`	No
igstRate	number	India specific IGST rate Example: `5`	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: `3`	No
product	ProductResponse	Product Short Info Example: `"product"`	No
productCode	string	Product code Example: `"PC-001"`	Yes
productDescription	string	Product description Example: `"Red pen"`	No
productName	string	Product name Example: `"Ball pen"`	No
productOrder	integer	Product order Example: `1`	No
productQuantity	number	Product quantity Example: `2.5`	Yes
reservedQuantitiesData	[ ReservedQuantityData ]	Reserved quantity data Example: `[]`	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.3`	No
taxCode	string	Tax code Example: `"TX-003"`	No
taxExemptionReason	string	Tax Exemption reason if taxPreference is true Enum: `"EXEMPTED"`, `"NON_GST"` Example: `"EXEMPTED"`	No
taxName	string	Tax name Example: `"GST(7%)"`	No
taxPreference	boolean	Tax preference, whether Exempted or not Exempted Example: `false`	No
type	string	Product type Enum: `"TRACKED"`, `"NONTRACKED"` Example: `"TRACKED"`	Yes
unitPrice	number	Product price Example: `10`	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

QuotationItemInformation

Name	Type	Description	Required
allocationType	string	Allocation Type Example: `"NORMAL"`	No
availableQuantity	number	Total available quantity Example: `3`	No
basePrice	number	Revenue Base price Example: `120`	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	Product 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
exciseAmount	number	Excise amount on product Example: `0.5`	No
exciseRate	number	Rate of Excise Example: `5`	No
exciseType	string	Excise type Enum: `"PERCENT"`, `"FLAT"` Example: `"FLAT"`	No
fulfilledQuantity	number	Total Fulfilled Quantity Example: `3`	No
fulfilledQuantityByFlowover	number	Total Fulfilled Quantity By Flowover Example: `3`	No
fulfilledQuantityByUser	number	Total Fulfilled Quantity By User Example: `3`	No
fulfilledQuantityInvoiced	number	Total Fulfilled Quantity Invoiced Example: `3`	No
fulfillmentByDoc	[ ItemQtyFulfilledByDoc ]	Item Qty fulfilled by Fulfillment Doc Example: `[]`	No
hsnOrSacCode	string	Hsn or Sac code Example: `110011`	No
igstAmount	number	India specific IGST tax amount on total amount Example: `5`	No
igstRate	number	India specific IGST rate Example: `5`	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: `3`	No
product	ProductInformation	Product Short Info Example: `"product"`	No
productCode	string	Product code Example: `"PC-001"`	Yes
productDescription	string	Product description Example: `"Red pen"`	No
productName	string	Product name Example: `"Ball pen"`	No
productOrder	integer	Product order Example: `1`	No
productQuantity	number	Product quantity Example: `2.5`	Yes
reservedQuantitiesData	[ ReservedQuantityData ]	Reserved quantity data Example: `[]`	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.3`	No
taxCode	string	Tax code Example: `"TX-003"`	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
taxName	string	Tax name Example: `"GST(7%)"`	No
taxPreference	boolean	Tax preference, whether Exempted or not Exempted Example: `false`	No
type	string	Product type Enum: `"TRACKED"`, `"NONTRACKED"` Example: `"TRACKED"`	Yes
unitPrice	number	Product price Example: `10`	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

QuotationItemIsraelDto

Name	Type	Description	Required
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
allocationType	string	Allocation Type Example: `"NORMAL"`	No
availableQuantity	number	Total available quantity Example: `3`	No
basePrice	number	Revenue Base price Example: `120`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Product 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
fulfilledQuantity	number	Total Fulfilled Quantity Example: `3`	No
fulfilledQuantityByFlowover	number	Total Fulfilled Quantity By Flowover Example: `3`	No
fulfilledQuantityByUser	number	Total Fulfilled Quantity By User Example: `3`	No
fulfilledQuantityInvoiced	number	Total Fulfilled Quantity Invoiced Example: `3`	No
fulfillmentByDoc	[ ItemQtyFulfilledByDoc ]	Item Qty fulfilled by Fulfillment Doc Example: `[]`	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: `3`	No
product	ProductResponse	Product Short Info Example: `"product"`	No
productCode	string	Product code Example: `"PC-001"`	Yes
productDescription	string	Product description Example: `"Red pen"`	No
productName	string	Product name Example: `"Ball pen"`	No
productOrder	integer	Product order Example: `1`	No
productQuantity	number	Product quantity Example: `2.5`	Yes
reservedQuantitiesData	[ ReservedQuantityData ]	Reserved quantity data Example: `[]`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.3`	No
taxCode	string	Tax code Example: `"TX-003"`	No
taxName	string	Tax name Example: `"GST(7%)"`	No
type	string	Product type Enum: `"TRACKED"`, `"NONTRACKED"` Example: `"TRACKED"`	Yes
unitPrice	number	Product price Example: `10`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

QuotationItemPhilippinesDto

Name	Type	Description	Required
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
allocationType	string	Allocation Type Example: `"NORMAL"`	No
availableQuantity	number	Total available quantity Example: `3`	No
basePrice	number	Revenue Base price Example: `120`	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Product 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
fulfilledQuantity	number	Total Fulfilled Quantity Example: `3`	No
fulfilledQuantityByFlowover	number	Total Fulfilled Quantity By Flowover Example: `3`	No
fulfilledQuantityByUser	number	Total Fulfilled Quantity By User Example: `3`	No
fulfilledQuantityInvoiced	number	Total Fulfilled Quantity Invoiced Example: `3`	No
fulfillmentByDoc	[ ItemQtyFulfilledByDoc ]	Item Qty fulfilled by Fulfillment Doc Example: `[]`	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: `3`	No
product	ProductResponse	Product Short Info Example: `"product"`	No
productCode	string	Product code Example: `"PC-001"`	Yes
productDescription	string	Product description Example: `"Red pen"`	No
productName	string	Product name Example: `"Ball pen"`	No
productOrder	integer	Product order Example: `1`	No
productQuantity	number	Product quantity Example: `2.5`	Yes
reservedQuantitiesData	[ ReservedQuantityData ]	Reserved quantity data Example: `[]`	No
tax	TaxDto	Tax details Example: `"taxDto"`	No
taxAmount	number	Tax amount Example: `0.3`	No
taxCode	string	Tax code Example: `"TX-003"`	No
taxName	string	Tax name Example: `"GST(7%)"`	No
type	string	Product type Enum: `"TRACKED"`, `"NONTRACKED"` Example: `"TRACKED"`	Yes
unitPrice	number	Product price Example: `10`	No
uomQuantity	number	uom quantity Example: `2`	Yes
uomUnitPrice	number	UOM Unit price Example: `2.3`	Yes

QuotationOverview

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

QuotationOverviewReport

Name	Type	Required
drafts	QuotationOverview	No
expired	QuotationOverview	No
open	QuotationOverview	No
processed	QuotationOverview	No

QuotationPhilippinesDto

Name	Type	Description	Required
approvalStatus	string	Approval status Enum: `"APPROVED"`, `"PENDING_FOR_APPROVAL"`, `"REJECTED"`, `"NOT_REQUIRED"` Example: `"APPROVED"`	No
attachments	[ string ]	Attachments url's	No
attachmentsWithLink	[ AttachmentsResponse ]	Attachments Details	No
backOrder	boolean	Backorder flag to indicate if backorder created Example: `true`	No
billTo	Address	Bill to Address.	No
contact	ContactInfo	Contact info Example: `"contact object"`	No
contactCode	string	Contact code Example: `"C-0001"`	Yes
contactDto	ContactDto	Contact Details	Yes
createdBy	long	UserId of creator Example: `123`	No
currency	string	Currency code Example: `"SGD"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
deleted	boolean	Quotation deleted Example: `false`	No
documentDate	dateTime	Document date Example: `"27-10-2019"`	No
documentSequenceCode	string	Quotation Code Example: `"0000001"`	No
draft	boolean	True if want to save as draft. Example: `false`	No
errors	[ string ]	List of validation error messages	No
exchangeRate	double	Exchange rate Example: `0.01891562`	No
fulfillmentDate	dateTime	Fulfillment date Example: `"28-10-2019"`	No
fulfillmentOn	dateTime	Fulfillment On Example: `"28-10-2019"`	No
fulfillmentStatus	string	Fulfillment status Enum: `"UNFULFILLED"`, `"PARTIAL_FULFILLED"`, `"FULLY_FULFILLED"` Example: `"UNFULFILLED"`	No
fulfillmentType	string	Fulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP _Enum:`"NONE"`, `"DEFAULT"`, `"PICK_PACK_SHIP"`, `"DROP_SHIP"` Example: `"PICK_PACK_SHIP"`	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedSalesInvoices	[ LinkedSalesInvoiceResponse ]		No
linkedSalesOrders	[ LinkedSalesOrderResponse ]		No
memo	string	Memo text Example: `"Sales quotation"`	No
processedInPPS	boolean		No
quotationItemDtoList	[ QuotationItemPhilippinesDto ]	Quotation items information	No
recurring	boolean	Is quotation set to recurring Example: `false`	No
recurringActivated	boolean	Is quotation recurring active Example: `false`	No
reservedStock	boolean	Reserved stock enabled Example: `true`	No
roundOffAmountInDocumentCurrency	number	Round Off Amount in Document Currency Example: `0.3`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
shipByDate	dateTime	Ship by date Example: `"25-10-2019"`	No
shipFrom	Address	Ship from Address.	No
shipTo	Address	Ship to Address.	No
sourceAppName	string	Source App Name Example: `"BOOKS"`	No
status	string	Quotation status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"` Example: `"OPEN"`	No
tenantId	long	Tenant id Example: `123`	No
unitPriceGstInclusive	boolean	Unit Price is GST inclusive Example: `true`	No
validTillDate	dateTime	Valid till date Example: `"29-10-2019"`	No
warehouseCode	string	Warehouse Code Example: `"WH-000001"`	No

QuotationShortInfo

Name	Type	Required
baseCurrency	string	No
contactName	string	No
customField	[ CustomFieldItem ]	No
docCurrency	string	No
documentDate	string	No
fulfillmentStatus	string	No
seqNo	string	No
totalAmount	string	No
totalAmountInBaseCurrency	string	No
validTillDate	string	No

QuotationUpdateRequest

Name	Type	Description	Required
backOrder	boolean	Backorder flag to indicate if backorder created Example: `true`	No
closedDate	dateTime	Quotation closed on date Example: `"05-12-2019"`	No
fulfilledQtyByItem	object	Fulfilled Quantity by Quotation Item Example: `[]`	No
fulfillmentCode	string	Fulfillment Code Example: `"0000012"`	No
fulfillmentOn	dateTime	Fulfillment on date Example: `"05-12-2019"`	No
fulfillmentStatus	string	Fulfillment status Enum: `"UNFULFILLED"`, `"PARTIAL_FULFILLED"`, `"FULLY_FULFILLED"` Example: `"UNFULFILLED"`	No
fulfillmentType	string	Fulfillment type such as NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP _Enum:`"NONE"`, `"DEFAULT"`, `"PICK_PACK_SHIP"`, `"DROP_SHIP"` Example: `"NONE"`	No
isUpdateQuoteStatus	boolean	Whether to update quotation status Example: `false`	No
isUpdateSIItemFulfillmentQty	boolean	Whether to update Sales Invoice Item Fulfillment Qty Example: `false`	No
linkedDocuments	[ DocumentInfo ]	Linked Documents	No
operation	string	Partial Invoice Item added Example: `"add"`	No
partialInvoiceItemsQuantities	object	Partial Invoice Item quantities Example: `[]`	No
quotationCode	string	Quotation code. Example: `"000012"`	No
quotationId	long	Quotation ID Example: `123`	No
reservedQuantityFulfillmentItemDtoByItem	object	Reserved quantity fulfillment data Example: `[]`	No
status	string	Quotation status Enum: `"DRAFT"`, `"OPEN"`, `"CLOSED"`, `"ARCHIVED"`, `"PROCESSED"` Example: `"CLOSED"`	No

RecurringJobEvent

Name	Type	Description	Required
autoCharge	boolean		No
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"`, `"PURCHASE_REQUEST"`, `"PURCHASE_REQUEST_FOR_QUOTES"`, `"SUPPLIER_QUOTES"`, `"E_WAY_BILL_SUMMARY"`, `"E_WAY_BILL_DETAIL"`, `"JOB_WORK_OUT_ORDER"`, `"JOB_WORK_OUT_TRANSFER"`, `"QC_DOCUMENT"`, `"WIP_PRODUCTION"`, `"STOCK_REQUEST"`, `"STOCK_ISSUE"`, `"FORECAST"`, `"ESTIMATE"`	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

RelatedTransactionDto

Name	Type	Description	Required
documentCode	string	Code of child document. Example: `"SO-0000005"`	Yes
documentType	string	Document type being linked. Enum: `"QUOTATION"`, `"PURCHASE_ORDER"`, `"SALES_ORDER"`, `"PURCHASE_INVOICE"`, `"SALES_INVOICE"`, `"MAKE_PAYMENT"`, `"RECEIVE_PAYMENT"`, `"JOURNAL_ENTRY"` Example: `"SALES_ORDER"`	No
parentCode	string	Code of the parent document. Example: `"QO-0000001"`	No
parentType	string	Document type from which linking is created. Enum: `"QUOTATION"`, `"PURCHASE_ORDER"`, `"SALES_ORDER"`, `"PURCHASE_INVOICE"`, `"SALES_INVOICE"`, `"MAKE_PAYMENT"`, `"RECEIVE_PAYMENT"`, `"JOURNAL_ENTRY"` Example: `"QUOTATION"`	No

RelatedTransactionResponse

Name	Type	Description	Required
documentCode	string	Code of the document. Example: `"QO-0000001"`	No
documentType	string	Type of document. Enum: `"QUOTATION"`, `"PURCHASE_ORDER"`, `"SALES_ORDER"`, `"PURCHASE_INVOICE"`, `"SALES_INVOICE"`, `"MAKE_PAYMENT"`, `"RECEIVE_PAYMENT"`, `"JOURNAL_ENTRY"` Example: `"QUOTATION"`	No
jeCodes	[ string ]	Journal Entry codes attached to the document.	No
order	integer	Display order of the record. Example: `1`	No

ReservedQuantityData

Name	Type	Description	Required
advancedTrackingMetaDtos	[ AdvancedTrackingMetaDto ]	Advance tracking type Example: `"SERIAL"`	No
advancedTrackingType	string	Advance tracking type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"` Example: `"SERIAL"`	No
availableQuantity	double	Available quantity in warehouse Example: `100`	No
binCode	string	bin code Example: `"BIN-00001"`	Yes
documentCode	string	Document code Example: `"000005"`	No
documentItemCode	string	Document item code Example: `"000005"`	No
documentType	string	Document type Example: `"SALES_INVOICE"`	No
productCode	string	Product Code Example: `10`	No
rackCode	string	Rack code Example: `"RACK-00001"`	Yes
reservedDate	dateTime	reserved date Example: `"20-10-2022"`	No
reservedQuantity	double	Reserved quantity Example: `100`	No
rowCode	string	Row code Example: `"ROW-00001"`	Yes
warehouseCode	string	Warehouse Code Example: `100.4`	No
wipProcessType	string	Work Order WIP Process Type Enum: `"PRODUCTION"`, `"CONSUMPTION"`, `"WASTAGE"`, `"SCRAP"`, `"CO_PRODUCT"` Example: `"CONSUMPTION"`	No

ReservedQuantityFulfillmentItemDto

Name	Type	Description	Required
advancedTrackingFulfilmentDtos	[ AdvancedTrackingFulfilmentDto ]	Advanced tracking data for fulfilled reserved quantity Example: `[]`	No
fulfilledQtyByWarehouse	[ LinkedWareHouse ]	Fulfilled reserved quantity by warehouse Example: `[]`	No

ResponseEntity

Name	Type	Description	Required
body	object		No
statusCode	string	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"`	No
statusCodeValue	integer		No

SalesDocument

Name	Type	Description	Required
contactCode	string	Contact code Example: `"000012"`	No
contactDto	ContactDto	Contact Details	Yes
documentCode	string	Document Code. Example: `"QO-0000001"`	No
documentDate	dateTime	Document date Example: `"25-10-2019"`	No
documentItemDetails	[ DocumentItemDetails ]	Document item details.	No
documentSequenceCode	string	Document Sequence 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"`, `"PURCHASE_REQUEST"`, `"PURCHASE_REQUEST_FOR_QUOTES"`, `"SUPPLIER_QUOTES"`, `"E_WAY_BILL_SUMMARY"`, `"E_WAY_BILL_DETAIL"`, `"JOB_WORK_OUT_ORDER"`, `"JOB_WORK_OUT_TRANSFER"`, `"QC_DOCUMENT"`, `"WIP_PRODUCTION"`, `"STOCK_REQUEST"`, `"STOCK_ISSUE"`, `"FORECAST"`, `"ESTIMATE"` Example: `"QUOTATION"`	No
exchangeRate	double		No
linkedDocuments	[ DocumentInfo ]	Linked Documents	No
shipByDate	dateTime	Ship by date Example: `"25-10-2019"`	No
shipFrom	Address	Ship from address.	No
shipTo	Address	Ship To address.	No
warehouseCode	string	Warehouse Code Example: `"WH-0000001"`	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"`, `"PURCHASE_REQUEST"`, `"PURCHASE_REQUEST_FOR_QUOTES"`, `"SUPPLIER_QUOTES"`, `"E_WAY_BILL_SUMMARY"`, `"E_WAY_BILL_DETAIL"`, `"JOB_WORK_OUT_ORDER"`, `"JOB_WORK_OUT_TRANSFER"`, `"QC_DOCUMENT"`, `"WIP_PRODUCTION"`, `"STOCK_REQUEST"`, `"STOCK_ISSUE"`, `"FORECAST"`, `"ESTIMATE"`	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	Net Amount Before Section Example: `"Box 5,Box 6"`	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

TenureData

Name	Type	Description	Required
amount	number		No
count	integer		No
day	integer		No
month	string	Enum: `"JANUARY"`, `"FEBRUARY"`, `"MARCH"`, `"APRIL"`, `"MAY"`, `"JUNE"`, `"JULY"`, `"AUGUST"`, `"SEPTEMBER"`, `"OCTOBER"`, `"NOVEMBER"`, `"DECEMBER"`	No
year	Year		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

Year

Name	Type	Description	Required
leap	boolean		No
value	integer		No

API
Models

API​

Search Quotation/Estimate​

Description:​

GET​

Quotations​

Parameters​

Responses​

Security​

Create Quotation/Estimate​

Description:​

POST​

Quotations​

Parameters​

Responses​

Security​

Update Quotation/Estimate​

Description:​

PUT​

Quotations /{id}​

Parameters​

Responses​

Security​

Retrieve Quotation/Estimate​

Description:​

GET​

Quotations /code/{code}​

Parameters​

Responses​

Security​

Update Linked BackOrder​

Description:​

POST​

Quotations /update/linkedBackOrder​

Parameters​

Responses​

Security​

Update Linked Documents​

Description:​

POST​

Quotations /update/linkedDocument​

Parameters​

Responses​

Security​

Quotations /ae​

GET​

Summary​

Description​

Parameters​

Responses​

Security​

POST​

Summary​

Description​

Parameters​

Responses​

Security​

Quotations /ae/brief​

GET​

Summary​

Description​

Parameters​

Responses​

Security​

Quotations /ae/code/{code}​

GET​

Summary​

Description​

Parameters​

Responses​

Security​

Quotations /ae/report/count​

POST​

Summary​

Description​

Parameters​

Responses​

Security​

Quotations /ae/report/open-quotes​

GET​

Summary​

API

Search Quotation/Estimate

Description:

GET

Quotations

Parameters

Responses

Security

Create Quotation/Estimate

Description:

POST

Quotations

Parameters

Responses

Security

Update Quotation/Estimate

Description:

PUT

Quotations /{id}

Parameters

Responses

Security

Retrieve Quotation/Estimate

Description:

GET

Quotations /code/{code}

Parameters

Responses

Security

Update Linked BackOrder

Description:

POST

Quotations /update/linkedBackOrder

Parameters

Responses

Security

Update Linked Documents

Description:

POST

Quotations /update/linkedDocument

Parameters

Responses

Security

Quotations /ae

GET

Summary

Description

Parameters

Responses

Security

POST

Summary

Description

Parameters

Responses

Security

Quotations /ae/brief

GET

Summary

Description

Parameters

Responses

Security

Quotations /ae/code/{code}

GET

Summary

Description

Parameters

Responses

Security

Quotations /ae/report/count

POST

Summary

Description

Parameters

Responses

Security

Quotations /ae/report/open-quotes

GET

Summary