Skip to main content

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.

More about Quotation API documentation

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
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Quotation's have been fetched successfully.QuotationDto
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

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
NameLocated inDescriptionRequiredSchema
quotationDtobodyquotationDtoYesQuotationDto
Responses
CodeDescriptionSchema
200OKQuotationDto
201Quotation has been created/drafted successfully.QuotationDto
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

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
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationDtobodyquotationDtoYesQuotationDto
Responses
CodeDescriptionSchema
200Quotation has been updated successfully.QuotationDto
201Created
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

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
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Quotations documents have been fetched successfully.[ SalesDocument ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

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
NameLocated inDescriptionRequiredSchema
backOrderUpdateRequestbodybackOrderUpdateRequestYesBackOrderUpdateRequest
Responses
CodeDescription
200Linked document for backorder has been successfully updated.
201Created
400Linked document for backorder update failed.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Update Linked Documents

Update linked documents for PO.

Description:
  • Allows you to update linked documents for PO.

POST

Quotations /update/linkedDocument

Parameters
NameLocated inDescriptionRequiredSchema
linkedDocumentUpdateRequestbodylinkedDocumentUpdateRequestYesLinkedDocumentUpdateRequest
Responses
CodeDescription
200Linked document has been successfully updated.
201Created
400Linked document update failed.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ae

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Quotation's have been fetched successfully.QuotationDtoUAE
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters
NameLocated inDescriptionRequiredSchema
quotationDtoUAEbodyquotationDtoUAEYesQuotationDtoUAE
Responses
CodeDescriptionSchema
200OKQuotationDtoUAE
201Quotation has been created/drafted successfully.QuotationDtoUAE
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ae/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters
NameLocated inDescriptionRequiredSchema
isNewUiqueryisNewUiNoboolean
Responses
CodeDescriptionSchema
200Quotations brief information have been fetched successfully.[ QuotationShortInfo ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ae/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Quotations documents have been fetched successfully.[ QuotationDtoUAE ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ae/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters
NameLocated inDescriptionRequiredSchema
contactCodesbodycontactCodesYes[ string ]
Responses
CodeDescriptionSchema
200Contact quotation count has been fetched.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ae/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses
CodeDescriptionSchema
200Open quotations count has been fetched.integer
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ae/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters
NameLocated inDescriptionRequiredSchema
contactCodequerycontactCodeNostring
epochqueryepochYeslong
intervalqueryintervalNostring
Responses
CodeDescriptionSchema
200Quotation overview report has been prepared.QuotationOverviewReport
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ae/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
attributeKeyValuesbodyattributeKeyValuesYesobject
quotationCodequeryquotationCodeYesstring
Responses
CodeDescription
200Quotation attributes has been updated successfully.
201Created
401Unauthorized
403Forbidden
404Quotation with given code not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /ae/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationDtoUAEbodyquotationDtoUAEYesQuotationDtoUAE
Responses
CodeDescriptionSchema
200Quotation has been updated successfully.QuotationDtoUAE
201Created
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Quotation has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationbodyquotationYesobject
Responses
CodeDescriptionSchema
200Quotation attributes has been updated successfully.QuotationDtoUAE
204No Content
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /approval-status

POST

Summary

Update approval status

Description

API to update approval status

Parameters
NameLocated inDescriptionRequiredSchema
approvalStatusRequestDtoListbodyapprovalStatusRequestDtoListYes[ ApprovalStatusRequestDto ]
Responses
CodeDescription
200Approval status for Sales documents have been updated successfully.
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /au

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Quotation's have been fetched successfully.QuotationDtoAustralia
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters
NameLocated inDescriptionRequiredSchema
quotationDtoAustraliabodyquotationDtoAustraliaYesQuotationDtoAustralia
Responses
CodeDescriptionSchema
200OKQuotationDtoAustralia
201Quotation has been created/drafted successfully.QuotationDtoAustralia
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /au/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters
NameLocated inDescriptionRequiredSchema
isNewUiqueryisNewUiNoboolean
Responses
CodeDescriptionSchema
200Quotations brief information have been fetched successfully.[ QuotationShortInfo ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /au/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Quotations documents have been fetched successfully.[ QuotationDtoAustralia ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /au/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters
NameLocated inDescriptionRequiredSchema
contactCodesbodycontactCodesYes[ string ]
Responses
CodeDescriptionSchema
200Contact quotation count has been fetched.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /au/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses
CodeDescriptionSchema
200Open quotations count has been fetched.integer
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /au/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters
NameLocated inDescriptionRequiredSchema
contactCodequerycontactCodeNostring
epochqueryepochYeslong
intervalqueryintervalNostring
Responses
CodeDescriptionSchema
200Quotation overview report has been prepared.QuotationOverviewReport
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /au/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
attributeKeyValuesbodyattributeKeyValuesYesobject
quotationCodequeryquotationCodeYesstring
Responses
CodeDescription
200Quotation attributes has been updated successfully.
201Created
401Unauthorized
403Forbidden
404Quotation with given code not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /au/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationDtoAustraliabodyquotationDtoAustraliaYesQuotationDtoAustralia
Responses
CodeDescriptionSchema
200Quotation has been updated successfully.QuotationDtoAustralia
201Created
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Quotation has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationbodyquotationYesobject
Responses
CodeDescriptionSchema
200Quotation attributes has been updated successfully.QuotationDtoAustralia
204No Content
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /batch

PUT

Summary

Batch update quotation attributes.

Description

Batch API to update attributes of existing quotation by codes.

Parameters
NameLocated inDescriptionRequiredSchema
quotationUpdateRequestsbodyquotationUpdateRequestsYes[ QuotationUpdateRequest ]
Responses
CodeDescription
200Quotation attributes has been updated successfully.
201Created
401Unauthorized
403Forbidden
404Quotation with given code not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /be

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Quotation's have been fetched successfully.QuotationDtoAustralia
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters
NameLocated inDescriptionRequiredSchema
quotationDtoAustraliabodyquotationDtoAustraliaYesQuotationDtoAustralia
Responses
CodeDescriptionSchema
200OKQuotationDtoAustralia
201Quotation has been created/drafted successfully.QuotationDtoAustralia
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /be/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters
NameLocated inDescriptionRequiredSchema
isNewUiqueryisNewUiNoboolean
Responses
CodeDescriptionSchema
200Quotations brief information have been fetched successfully.[ QuotationShortInfo ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /be/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Quotations documents have been fetched successfully.[ QuotationDtoAustralia ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /be/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters
NameLocated inDescriptionRequiredSchema
contactCodesbodycontactCodesYes[ string ]
Responses
CodeDescriptionSchema
200Contact quotation count has been fetched.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /be/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses
CodeDescriptionSchema
200Open quotations count has been fetched.integer
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /be/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters
NameLocated inDescriptionRequiredSchema
contactCodequerycontactCodeNostring
epochqueryepochYeslong
intervalqueryintervalNostring
Responses
CodeDescriptionSchema
200Quotation overview report has been prepared.QuotationOverviewReport
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /be/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
attributeKeyValuesbodyattributeKeyValuesYesobject
quotationCodequeryquotationCodeYesstring
Responses
CodeDescription
200Quotation attributes has been updated successfully.
201Created
401Unauthorized
403Forbidden
404Quotation with given code not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /be/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationDtoAustraliabodyquotationDtoAustraliaYesQuotationDtoAustralia
Responses
CodeDescriptionSchema
200Quotation has been updated successfully.QuotationDtoAustralia
201Created
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Quotation has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationbodyquotationYesobject
Responses
CodeDescriptionSchema
200Quotation attributes has been updated successfully.QuotationDtoAustralia
204No Content
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
isNewUiqueryisNewUiNoboolean
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Quotations brief information have been fetched successfully.[ QuotationShortInfo ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /bulk-delete

DELETE

Summary

Bulk Delete quotation.

Description

API to bulk delete quotation.

Parameters
NameLocated inDescriptionRequiredSchema
quotationIdsbodyquotationIdsYes[ long ]
Responses
CodeDescriptionSchema
200OK[ QuotationBulkDeleteResponseDto ]
204Quotation has been deleted successfully.[ QuotationBulkDeleteResponseDto ]
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /bulk-details

POST

Summary

Quotation details by codes

Description

Quotation details by codes

Parameters
NameLocated inDescriptionRequiredSchema
codesbodycodesYes[ string ]
Responses
CodeDescriptionSchema
200OK[ QuotationInformation ]
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /bulk-patch

PATCH

Summary

Bulk update quotation attributes.

Description

Bulk API to update attributes of existing quotations.

Parameters
NameLocated inDescriptionRequiredSchema
quotationsbodyquotationsYes[ Map«string,object» ]
Responses
CodeDescriptionSchema
200Quotation attributes has been updated successfully.BulkApiResponse
204No Content
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /by-contact-ids

POST

Summary

Fetch Quotations

Description

API to fetch existing quotations.

Parameters
NameLocated inDescriptionRequiredSchema
contactIdsbodycontactIdsYes[ long ]
customfieldquerycustomfieldNostring
fetchAttachmentDetailsqueryfetchAttachmentDetailsNoboolean
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Quotation's have been fetched successfully.QuotationDto
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ca

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Quotation's have been fetched successfully.QuotationDtoCanada
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters
NameLocated inDescriptionRequiredSchema
quotationDtoCanadabodyquotationDtoCanadaYesQuotationDtoCanada
Responses
CodeDescriptionSchema
200OKQuotationDtoCanada
201Quotation has been created/drafted successfully.QuotationDtoCanada
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ca/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters
NameLocated inDescriptionRequiredSchema
isNewUiqueryisNewUiNoboolean
Responses
CodeDescriptionSchema
200Quotations brief information have been fetched successfully.[ QuotationShortInfo ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ca/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Quotations documents have been fetched successfully.[ QuotationDtoCanada ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ca/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters
NameLocated inDescriptionRequiredSchema
contactCodesbodycontactCodesYes[ string ]
Responses
CodeDescriptionSchema
200Contact quotation count has been fetched.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ca/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses
CodeDescriptionSchema
200Open quotations count has been fetched.integer
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ca/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters
NameLocated inDescriptionRequiredSchema
contactCodequerycontactCodeNostring
epochqueryepochYeslong
intervalqueryintervalNostring
Responses
CodeDescriptionSchema
200Quotation overview report has been prepared.QuotationOverviewReport
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ca/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
attributeKeyValuesbodyattributeKeyValuesYesobject
quotationCodequeryquotationCodeYesstring
Responses
CodeDescription
200Quotation attributes has been updated successfully.
201Created
401Unauthorized
403Forbidden
404Quotation with given code not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /ca/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationDtoCanadabodyquotationDtoCanadaYesQuotationDtoCanada
Responses
CodeDescriptionSchema
200Quotation has been updated successfully.QuotationDtoCanada
201Created
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Quotation has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationbodyquotationYesobject
Responses
CodeDescriptionSchema
200Quotation attributes has been updated successfully.QuotationDtoCanada
204No Content
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /code/{code}/details

GET

Summary

Quotation details by codes

Description

Quotation details by codes

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200OKQuotationInformation
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /codes

POST

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters
NameLocated inDescriptionRequiredSchema
codesbodycodesYes[ string ]
Responses
CodeDescriptionSchema
200Quotations documents have been fetched successfully.[ SalesDocument ]
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /create-recurring

POST

Summary

Create a recurring quotation

Description

API to create a recurring quotation.

Parameters
NameLocated inDescriptionRequiredSchema
eventbodyeventYesRecurringJobEvent
Responses
CodeDescription
200OK
201Recurring quotation created successfully
400Error while creating recurring quotation
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters
NameLocated inDescriptionRequiredSchema
customCodequerycustomCodeYesstring
Responses
CodeDescriptionSchema
200Custom fields status fetched successfullyboolean
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /de

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Quotation's have been fetched successfully.QuotationDtoDE
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters
NameLocated inDescriptionRequiredSchema
quotationDtoDEbodyquotationDtoDEYesQuotationDtoDE
Responses
CodeDescriptionSchema
200OKQuotationDtoDE
201Quotation has been created/drafted successfully.QuotationDtoDE
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /de/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters
NameLocated inDescriptionRequiredSchema
isNewUiqueryisNewUiNoboolean
Responses
CodeDescriptionSchema
200Quotations brief information have been fetched successfully.[ QuotationShortInfo ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /de/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Quotations documents have been fetched successfully.[ QuotationDto ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /de/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters
NameLocated inDescriptionRequiredSchema
contactCodesbodycontactCodesYes[ string ]
Responses
CodeDescriptionSchema
200Contact quotation count has been fetched.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /de/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses
CodeDescriptionSchema
200Open quotations count has been fetched.integer
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /de/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters
NameLocated inDescriptionRequiredSchema
contactCodequerycontactCodeNostring
epochqueryepochYeslong
intervalqueryintervalNostring
Responses
CodeDescriptionSchema
200Quotation overview report has been prepared.QuotationOverviewReport
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /de/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
attributeKeyValuesbodyattributeKeyValuesYesobject
quotationCodequeryquotationCodeYesstring
Responses
CodeDescription
200Quotation attributes has been updated successfully.
201Created
401Unauthorized
403Forbidden
404Quotation with given code not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /de/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationDtoDEbodyquotationDtoDEYesQuotationDtoDE
Responses
CodeDescriptionSchema
200Quotation has been updated successfully.QuotationDtoDE
201Created
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Quotation has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationbodyquotationYesobject
Responses
CodeDescriptionSchema
200Quotation attributes has been updated successfully.QuotationDtoDE
204No Content
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /demo/{tenantId}

POST

Summary

Create demo quotations.

Description

API to create demo quotations.

Parameters
NameLocated inDescriptionRequiredSchema
countryquerycountryNostring
tenantIdpathtenantIdYeslong
Responses
CodeDescription
200OK
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /draft/trigger

POST

Summary

Create approval status trigger

Description

API to reate approval status trigger

Parameters
NameLocated inDescriptionRequiredSchema
triggerKafkaRequestDtobodytriggerKafkaRequestDtoYesTriggerKafkaRequestDto
Responses
CodeDescription
200Trigger created for approval status
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /dropshipupdatequotation

PUT

Summary

Batch update quotation attributes.

Description

Batch API to update attributes of existing quotation by codes.

Parameters
NameLocated inDescriptionRequiredSchema
quotationUpdateRequestsbodyquotationUpdateRequestsYes[ QuotationUpdateRequest ]
Responses
CodeDescription
200Quotation attributes has been updated successfully.
201Created
401Unauthorized
403Forbidden
404Quotation with given code not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /id

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Quotation's have been fetched successfully.QuotationDtoIndonesia
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters
NameLocated inDescriptionRequiredSchema
quotationDtoIndonesiabodyquotationDtoIndonesiaYesQuotationDtoIndonesia
Responses
CodeDescriptionSchema
200OKQuotationDtoIndonesia
201Quotation has been created/drafted successfully.QuotationDtoIndonesia
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /id/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters
NameLocated inDescriptionRequiredSchema
isNewUiqueryisNewUiNoboolean
Responses
CodeDescriptionSchema
200Quotations brief information have been fetched successfully.[ QuotationShortInfo ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /id/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Quotations documents have been fetched successfully.[ QuotationDtoIndonesia ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /id/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters
NameLocated inDescriptionRequiredSchema
contactCodesbodycontactCodesYes[ string ]
Responses
CodeDescriptionSchema
200Contact quotation count has been fetched.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /id/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses
CodeDescriptionSchema
200Open quotations count has been fetched.integer
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /id/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters
NameLocated inDescriptionRequiredSchema
contactCodequerycontactCodeNostring
epochqueryepochYeslong
intervalqueryintervalNostring
Responses
CodeDescriptionSchema
200Quotation overview report has been prepared.QuotationOverviewReport
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /id/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
attributeKeyValuesbodyattributeKeyValuesYesobject
quotationCodequeryquotationCodeYesstring
Responses
CodeDescription
200Quotation attributes has been updated successfully.
201Created
401Unauthorized
403Forbidden
404Quotation with given code not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /id/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationDtoIndonesiabodyquotationDtoIndonesiaYesQuotationDtoIndonesia
Responses
CodeDescriptionSchema
200Quotation has been updated successfully.QuotationDtoIndonesia
201Created
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Quotation has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationbodyquotationYesobject
Responses
CodeDescriptionSchema
200Quotation attributes has been updated successfully.QuotationDtoIndonesia
204No Content
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /il

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Quotation's have been fetched successfully.QuotationIsraelDto
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters
NameLocated inDescriptionRequiredSchema
quotationIsraelDtobodyquotationIsraelDtoYesQuotationIsraelDto
Responses
CodeDescriptionSchema
200OKQuotationIsraelDto
201Quotation has been created/drafted successfully.QuotationIsraelDto
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /il/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters
NameLocated inDescriptionRequiredSchema
isNewUiqueryisNewUiNoboolean
Responses
CodeDescriptionSchema
200Quotations brief information have been fetched successfully.[ QuotationShortInfo ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /il/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Quotations documents have been fetched successfully.[ QuotationIsraelDto ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /il/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters
NameLocated inDescriptionRequiredSchema
contactCodesbodycontactCodesYes[ string ]
Responses
CodeDescriptionSchema
200Contact quotation count has been fetched.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /il/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses
CodeDescriptionSchema
200Open quotations count has been fetched.integer
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /il/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters
NameLocated inDescriptionRequiredSchema
contactCodequerycontactCodeNostring
epochqueryepochYeslong
intervalqueryintervalNostring
Responses
CodeDescriptionSchema
200Quotation overview report has been prepared.QuotationOverviewReport
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /il/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
attributeKeyValuesbodyattributeKeyValuesYesobject
quotationCodequeryquotationCodeYesstring
Responses
CodeDescription
200Quotation attributes has been updated successfully.
201Created
401Unauthorized
403Forbidden
404Quotation with given code not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /il/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationIsraelDtobodyquotationIsraelDtoYesQuotationIsraelDto
Responses
CodeDescriptionSchema
200Quotation has been updated successfully.QuotationIsraelDto
201Created
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Quotation has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationbodyquotationYesobject
Responses
CodeDescriptionSchema
200Quotation attributes has been updated successfully.QuotationIsraelDto
204No Content
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /import

POST

Summary

Create multiple quotations via import

Description

API to create quotations via import.

Parameters
NameLocated inDescriptionRequiredSchema
quotationRequestsbodyquotationRequestsYes[ QuotationDto ]
Responses
CodeDescriptionSchema
200OKBulkApiResponse
201Quotation has been created/drafted successfully.BulkApiResponse
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /in

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
fetchAttachmentDetailsqueryfetchAttachmentDetailsNoboolean
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Quotation's have been fetched successfully.QuotationIndiaDto
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters
NameLocated inDescriptionRequiredSchema
quotationIndiaDtobodyquotationIndiaDtoYesQuotationIndiaDto
Responses
CodeDescriptionSchema
200OKQuotationIndiaDto
201Quotation has been created/drafted successfully.QuotationIndiaDto
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /in/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters
NameLocated inDescriptionRequiredSchema
isNewUiqueryisNewUiNoboolean
Responses
CodeDescriptionSchema
200Quotations brief information have been fetched successfully.[ QuotationShortInfo ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /in/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Quotations documents have been fetched successfully.[ QuotationIndiaDto ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /in/create

PUT

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters
NameLocated inDescriptionRequiredSchema
quotationIndiaDtobodyquotationIndiaDtoYesQuotationIndiaDto
Responses
CodeDescriptionSchema
200OKQuotationIndiaDto
201Quotation has been created/drafted successfully.QuotationIndiaDto
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /in/import

POST

Summary

Create multiple quotations via import

Description

API to create quotations via import.

Parameters
NameLocated inDescriptionRequiredSchema
quotationRequestsbodyquotationRequestsYes[ QuotationIndiaDto ]
Responses
CodeDescriptionSchema
200OKBulkApiResponse
201Quotation has been created/drafted successfully.BulkApiResponse
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /in/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters
NameLocated inDescriptionRequiredSchema
contactCodesbodycontactCodesYes[ string ]
Responses
CodeDescriptionSchema
200Contact quotation count has been fetched.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /in/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses
CodeDescriptionSchema
200Open quotations count has been fetched.integer
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /in/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters
NameLocated inDescriptionRequiredSchema
contactCodequerycontactCodeNostring
epochqueryepochYeslong
intervalqueryintervalNostring
Responses
CodeDescriptionSchema
200Quotation overview report has been prepared.QuotationOverviewReport
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /in/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
attributeKeyValuesbodyattributeKeyValuesYesobject
quotationCodequeryquotationCodeYesstring
Responses
CodeDescription
200Quotation attributes has been updated successfully.
201Created
401Unauthorized
403Forbidden
404Quotation with given code not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /in/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationIndiaDtobodyquotationIndiaDtoYesQuotationIndiaDto
Responses
CodeDescriptionSchema
200Quotation has been updated successfully.QuotationIndiaDto
201Created
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Quotation has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationbodyquotationYesobject
Responses
CodeDescriptionSchema
200Quotation attributes has been updated successfully.QuotationIndiaDto
204No Content
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /linked-docs/product-codes

POST

Summary

Get products by code

Description

API to Get products by code.

Parameters
NameLocated inDescriptionRequiredSchema
productCodesbodyproductCodesYes[ string ]
Responses
CodeDescriptionSchema
200Product information has been fetched successfully.string
201Created
401Unauthorized
403Forbidden
404Products not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /my

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Quotation's have been fetched successfully.QuotationDtoMalaysia
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters
NameLocated inDescriptionRequiredSchema
QuotationDtoMalaysiabodyQuotationDtoMalaysiaYesQuotationDtoMalaysia
Responses
CodeDescriptionSchema
200OKQuotationDtoMalaysia
201Quotation has been created/drafted successfully.QuotationDtoMalaysia
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /my/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters
NameLocated inDescriptionRequiredSchema
isNewUiqueryisNewUiNoboolean
Responses
CodeDescriptionSchema
200Quotations brief information have been fetched successfully.[ QuotationShortInfo ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /my/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Quotations documents have been fetched successfully.[ QuotationDtoMalaysia ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /my/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters
NameLocated inDescriptionRequiredSchema
contactCodesbodycontactCodesYes[ string ]
Responses
CodeDescriptionSchema
200Contact quotation count has been fetched.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /my/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses
CodeDescriptionSchema
200Open quotations count has been fetched.integer
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /my/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters
NameLocated inDescriptionRequiredSchema
contactCodequerycontactCodeNostring
epochqueryepochYeslong
intervalqueryintervalNostring
Responses
CodeDescriptionSchema
200Quotation overview report has been prepared.QuotationOverviewReport
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /my/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
attributeKeyValuesbodyattributeKeyValuesYesobject
quotationCodequeryquotationCodeYesstring
Responses
CodeDescription
200Quotation attributes has been updated successfully.
201Created
401Unauthorized
403Forbidden
404Quotation with given code not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /my/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
QuotationDtoMalaysiabodyQuotationDtoMalaysiaYesQuotationDtoMalaysia
idpathidYeslong
Responses
CodeDescriptionSchema
200Quotation has been updated successfully.QuotationDtoMalaysia
201Created
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Quotation has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationbodyquotationYesobject
Responses
CodeDescriptionSchema
200Quotation attributes has been updated successfully.QuotationDtoMalaysia
204No Content
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /nl

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Quotation's have been fetched successfully.QuotationDtoAustralia
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters
NameLocated inDescriptionRequiredSchema
quotationDtoAustraliabodyquotationDtoAustraliaYesQuotationDtoAustralia
Responses
CodeDescriptionSchema
200OKQuotationDtoAustralia
201Quotation has been created/drafted successfully.QuotationDtoAustralia
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /nl/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters
NameLocated inDescriptionRequiredSchema
isNewUiqueryisNewUiNoboolean
Responses
CodeDescriptionSchema
200Quotations brief information have been fetched successfully.[ QuotationShortInfo ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /nl/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Quotations documents have been fetched successfully.[ QuotationDtoAustralia ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /nl/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters
NameLocated inDescriptionRequiredSchema
contactCodesbodycontactCodesYes[ string ]
Responses
CodeDescriptionSchema
200Contact quotation count has been fetched.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /nl/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses
CodeDescriptionSchema
200Open quotations count has been fetched.integer
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /nl/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters
NameLocated inDescriptionRequiredSchema
contactCodequerycontactCodeNostring
epochqueryepochYeslong
intervalqueryintervalNostring
Responses
CodeDescriptionSchema
200Quotation overview report has been prepared.QuotationOverviewReport
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /nl/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
attributeKeyValuesbodyattributeKeyValuesYesobject
quotationCodequeryquotationCodeYesstring
Responses
CodeDescription
200Quotation attributes has been updated successfully.
201Created
401Unauthorized
403Forbidden
404Quotation with given code not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /nl/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationDtoAustraliabodyquotationDtoAustraliaYesQuotationDtoAustralia
Responses
CodeDescriptionSchema
200Quotation has been updated successfully.QuotationDtoAustralia
201Created
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Quotation has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationbodyquotationYesobject
Responses
CodeDescriptionSchema
200Quotation attributes has been updated successfully.QuotationDtoAustralia
204No Content
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /nz

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Quotation's have been fetched successfully.QuotationDtoAustralia
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters
NameLocated inDescriptionRequiredSchema
quotationDtoAustraliabodyquotationDtoAustraliaYesQuotationDtoAustralia
Responses
CodeDescriptionSchema
200OKQuotationDtoAustralia
201Quotation has been created/drafted successfully.QuotationDtoAustralia
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /nz/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters
NameLocated inDescriptionRequiredSchema
isNewUiqueryisNewUiNoboolean
Responses
CodeDescriptionSchema
200Quotations brief information have been fetched successfully.[ QuotationShortInfo ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /nz/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Quotations documents have been fetched successfully.[ QuotationDtoAustralia ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /nz/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters
NameLocated inDescriptionRequiredSchema
contactCodesbodycontactCodesYes[ string ]
Responses
CodeDescriptionSchema
200Contact quotation count has been fetched.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /nz/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses
CodeDescriptionSchema
200Open quotations count has been fetched.integer
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /nz/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters
NameLocated inDescriptionRequiredSchema
contactCodequerycontactCodeNostring
epochqueryepochYeslong
intervalqueryintervalNostring
Responses
CodeDescriptionSchema
200Quotation overview report has been prepared.QuotationOverviewReport
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /nz/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
attributeKeyValuesbodyattributeKeyValuesYesobject
quotationCodequeryquotationCodeYesstring
Responses
CodeDescription
200Quotation attributes has been updated successfully.
201Created
401Unauthorized
403Forbidden
404Quotation with given code not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /nz/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationDtoAustraliabodyquotationDtoAustraliaYesQuotationDtoAustralia
Responses
CodeDescriptionSchema
200Quotation has been updated successfully.QuotationDtoAustralia
201Created
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Quotation has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationbodyquotationYesobject
Responses
CodeDescriptionSchema
200Quotation attributes has been updated successfully.QuotationDtoAustralia
204No Content
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /pendingqty

PUT

Summary

Batch update to pending qty in Quotation Item.

Description

Batch API to update pending qty for QuotationItem.

Parameters
NameLocated inDescriptionRequiredSchema
quotationItemPendingQtyUpdateMapbodyquotationItemPendingQtyUpdateMapYesobject
Responses
CodeDescription
200Pending qty updated successfully
201Created
401Unauthorized
403Forbidden
404Pending qty update failure
Security
Security SchemaScopes
Authorizationglobal

Quotations /ph

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Quotation's have been fetched successfully.QuotationPhilippinesDto
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters
NameLocated inDescriptionRequiredSchema
quotationPhilippinesDtobodyquotationPhilippinesDtoYesQuotationPhilippinesDto
Responses
CodeDescriptionSchema
200OKQuotationPhilippinesDto
201Quotation has been created/drafted successfully.QuotationPhilippinesDto
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ph/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters
NameLocated inDescriptionRequiredSchema
isNewUiqueryisNewUiNoboolean
Responses
CodeDescriptionSchema
200Quotations brief information have been fetched successfully.[ QuotationShortInfo ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ph/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Quotations documents have been fetched successfully.[ QuotationPhilippinesDto ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ph/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters
NameLocated inDescriptionRequiredSchema
contactCodesbodycontactCodesYes[ string ]
Responses
CodeDescriptionSchema
200Contact quotation count has been fetched.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ph/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses
CodeDescriptionSchema
200Open quotations count has been fetched.integer
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ph/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters
NameLocated inDescriptionRequiredSchema
contactCodequerycontactCodeNostring
epochqueryepochYeslong
intervalqueryintervalNostring
Responses
CodeDescriptionSchema
200Quotation overview report has been prepared.QuotationOverviewReport
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /ph/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
attributeKeyValuesbodyattributeKeyValuesYesobject
quotationCodequeryquotationCodeYesstring
Responses
CodeDescription
200Quotation attributes has been updated successfully.
201Created
401Unauthorized
403Forbidden
404Quotation with given code not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /ph/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationPhilippinesDtobodyquotationPhilippinesDtoYesQuotationPhilippinesDto
Responses
CodeDescriptionSchema
200Quotation has been updated successfully.QuotationPhilippinesDto
201Created
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Quotation has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationbodyquotationYesobject
Responses
CodeDescriptionSchema
200Quotation attributes has been updated successfully.QuotationPhilippinesDto
204No Content
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /product-codes

POST

Summary

Get List Of Quotations by product codes

Description

List of Quotations by product codes

Parameters
NameLocated inDescriptionRequiredSchema
productCodesbodyproductCodesYes[ string ]
Responses
CodeDescriptionSchema
200OK[ QuotationDto ]
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

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
NameLocated inDescriptionRequiredSchema
productCodequeryproductCodeYesstring
Responses
CodeDescriptionSchema
200OKProductInOutQty
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

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
NameLocated inDescriptionRequiredSchema
productCodepathproductCodeYesstring
Responses
CodeDescriptionSchema
200OKboolean
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /quotationitemsstatus

POST

Summary

Get quotation items fulfillment status

Description

API to fetch quotation items fulfillment status

Parameters
NameLocated inDescriptionRequiredSchema
quotationItemToFulfilledMapbodyquotationItemToFulfilledMapYesobject
Responses
CodeDescriptionSchema
200quotation items fulfillment status.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /quotationreserved

PUT

Summary

Update quotation reserved quantity

Description

API to Update quotation reserved quantity.

Parameters
NameLocated inDescriptionRequiredSchema
reservedQuantityDatabodyreservedQuantityDataYes[ PPSReservedQuantityData ]
Responses
CodeDescription
200Quotation reserved quantity updated successfully.
201Created
401Unauthorized
403Forbidden
404Error occured while updating quotation reserved quantity.
Security
Security SchemaScopes
Authorizationglobal

Quotations /quotes-quantity

POST

Summary

Get quotation quantity

Description

API to get quotation quantity

Parameters
NameLocated inDescriptionRequiredSchema
requestbodyrequestYesStockQuantitiesRequest
Responses
CodeDescriptionSchema
200Fetched quotation quantity successfully.StockQuantitiesResponse
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /record-filter

POST

Summary

Create approval status trigger

Description

API to reate approval status trigger

Parameters
NameLocated inDescriptionRequiredSchema
filterRecordbodyfilterRecordYesFilterRecord
Responses
CodeDescriptionSchema
200Trigger created for approval statusboolean
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters
NameLocated inDescriptionRequiredSchema
contactCodesbodycontactCodesYes[ string ]
Responses
CodeDescriptionSchema
200Contact quotation count has been fetched.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses
CodeDescriptionSchema
200Open quotations count has been fetched.integer
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters
NameLocated inDescriptionRequiredSchema
contactCodequerycontactCodeNostring
epochqueryepochYeslong
intervalqueryintervalNostring
Responses
CodeDescriptionSchema
200Quotation overview report has been prepared.QuotationOverviewReport
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /sa

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Quotation's have been fetched successfully.QuotationDtoSaudiArabia
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters
NameLocated inDescriptionRequiredSchema
quotationDtoUAEbodyquotationDtoUAEYesQuotationDtoSaudiArabia
Responses
CodeDescriptionSchema
200OKQuotationDtoSaudiArabia
201Quotation has been created/drafted successfully.QuotationDtoSaudiArabia
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /sa/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters
NameLocated inDescriptionRequiredSchema
isNewUiqueryisNewUiNoboolean
Responses
CodeDescriptionSchema
200Quotations brief information have been fetched successfully.[ QuotationShortInfo ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /sa/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Quotations documents have been fetched successfully.[ QuotationDtoSaudiArabia ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /sa/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters
NameLocated inDescriptionRequiredSchema
contactCodesbodycontactCodesYes[ string ]
Responses
CodeDescriptionSchema
200Contact quotation count has been fetched.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /sa/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses
CodeDescriptionSchema
200Open quotations count has been fetched.integer
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /sa/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters
NameLocated inDescriptionRequiredSchema
contactCodequerycontactCodeNostring
epochqueryepochYeslong
intervalqueryintervalNostring
Responses
CodeDescriptionSchema
200Quotation overview report has been prepared.QuotationOverviewReport
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /sa/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
attributeKeyValuesbodyattributeKeyValuesYesobject
quotationCodequeryquotationCodeYesstring
Responses
CodeDescription
200Quotation attributes has been updated successfully.
201Created
401Unauthorized
403Forbidden
404Quotation with given code not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /sa/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationDtoUAEbodyquotationDtoUAEYesQuotationDtoSaudiArabia
Responses
CodeDescriptionSchema
200Quotation has been updated successfully.QuotationDtoSaudiArabia
201Created
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Quotation has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationbodyquotationYesobject
Responses
CodeDescriptionSchema
200Quotation attributes has been updated successfully.QuotationDtoSaudiArabia
204No Content
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /set-recurring

POST

Summary

Set an quotation to recurring

Description

API to set and quotation to recurring.

Parameters
NameLocated inDescriptionRequiredSchema
setRecurringDtobodysetRecurringDtoYesSetRecurringDto
Responses
CodeDescription
200Quotation set to recur successfully
201Created
400Error while setting quotation to recur
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
attributeKeyValuesbodyattributeKeyValuesYesobject
quotationCodequeryquotationCodeYesstring
Responses
CodeDescription
200Quotation attributes has been updated successfully.
201Created
401Unauthorized
403Forbidden
404Quotation with given code not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /status/{code}

PATCH

Summary

refreshQuoteStatus

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescription
200OK
204No Content
401Unauthorized
403Forbidden
Security
Security SchemaScopes
Authorizationglobal

Quotations /tax/count

POST

Summary

Get quotation count for tax

Description

API to fetch quotation count for tax

Parameters
NameLocated inDescriptionRequiredSchema
taxCodesbodytaxCodesYes[ string ]
Responses
CodeDescriptionSchema
200Tax quotation count has been fetched.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /uk

GET

Summary

Fetch Quotations

Description

API to fetch existing quotations.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Quotation's have been fetched successfully.QuotationDtoUk
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Create/Draft quotation.

Description

API to create/draft a new quotation.

Parameters
NameLocated inDescriptionRequiredSchema
quotationDtoUkbodyquotationDtoUkYesQuotationDtoUk
Responses
CodeDescriptionSchema
200OKQuotationDtoUk
201Quotation has been created/drafted successfully.QuotationDtoUk
400Quotation creation/draft failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /uk/brief

GET

Summary

Get quotation brief information

Description

API to get brief information of all the quotations

Parameters
NameLocated inDescriptionRequiredSchema
isNewUiqueryisNewUiNoboolean
Responses
CodeDescriptionSchema
200Quotations brief information have been fetched successfully.[ QuotationShortInfo ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /uk/code/{code}

GET

Summary

Get quotation information by codes.

Description

API to get quotation document information by codes.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Quotations documents have been fetched successfully.[ QuotationDto ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /uk/report/count

POST

Summary

Get quotation count for contacts

Description

API to fetch quotation count for contacts

Parameters
NameLocated inDescriptionRequiredSchema
contactCodesbodycontactCodesYes[ string ]
Responses
CodeDescriptionSchema
200Contact quotation count has been fetched.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /uk/report/open-quotes

GET

Summary

Current open quotations

Description

API to fetch current open quotations

Responses
CodeDescriptionSchema
200Open quotations count has been fetched.integer
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /uk/report/overview

GET

Summary

Quotation report overview.

Description

API to fetch quotation report overview.

Parameters
NameLocated inDescriptionRequiredSchema
contactCodequerycontactCodeNostring
epochqueryepochYeslong
intervalqueryintervalNostring
Responses
CodeDescriptionSchema
200Quotation overview report has been prepared.QuotationOverviewReport
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /uk/status

POST

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
attributeKeyValuesbodyattributeKeyValuesYesobject
quotationCodequeryquotationCodeYesstring
Responses
CodeDescription
200Quotation attributes has been updated successfully.
201Created
401Unauthorized
403Forbidden
404Quotation with given code not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /uk/{id}

PUT

Summary

Update quotation.

Description

API to update existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationDtoUkbodyquotationDtoUkYesQuotationDtoUk
Responses
CodeDescriptionSchema
200Quotation has been updated successfully.QuotationDtoUk
201Created
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Quotation has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationbodyquotationYesobject
Responses
CodeDescriptionSchema
200Quotation attributes has been updated successfully.QuotationDtoUk
204No Content
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

Quotations /unreserve-quotations

POST

Summary

Api to Unreserve quantity in quotes only

Description

Api to Unreserve quantity in quotes only

Parameters
NameLocated inDescriptionRequiredSchema
updatedQuoteCodesbodyupdatedQuoteCodesYes[ string ]
Responses
CodeDescription
200Api to Unreserve quantity in quotes only
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Update linked documents for PO backorder

Description

API to update linked documents for PO backorder

Parameters
NameLocated inDescriptionRequiredSchema
backOrderUpdateRequestbodybackOrderUpdateRequestYesBackOrderUpdateRequest
Responses
CodeDescription
200Linked document for backorder has been successfully updated.
201Created
400Linked document for backorder update failed.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Quotations /update/linkedDocument

POST

Summary

Update linked documents for PO.

Description

API to pdate linked documents for PO.

Parameters
NameLocated inDescriptionRequiredSchema
linkedDocumentUpdateRequestbodylinkedDocumentUpdateRequestYesLinkedDocumentUpdateRequest
Responses
CodeDescription
200Linked document has been successfully updated.
201Created
400Linked document update failed.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete quotation.

Description

API to delete quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Quotation has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update quotation attributes.

Description

API to update attributes of existing quotation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
quotationbodyquotationYesobject
Responses
CodeDescriptionSchema
200Quotation attributes has been updated successfully.QuotationDto
204No Content
401Unauthorized
403Forbidden
404Quotation with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/rel-txn

GET

Summary

Get Relation

Description

API to get relation between two documents.

Parameters
NameLocated inDescriptionRequiredSchema
documentCodequerydocumentCodeYesstring
documentTypequerydocumentTypeYesstring
Responses
CodeDescriptionSchema
200Related transactions fetched successfully.RelatedTransactionResponse
400Get related transactions failed due to bad data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Create Relation

Description

API to create relation between two documents.

Parameters
NameLocated inDescriptionRequiredSchema
relationDtobodyrelationDtoYesRelatedTransactionDto
Responses
CodeDescription
200OK
201Relation Created.
400Relation creation failed due to bad data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete Relation

Description

API to delete relation between two documents.

Parameters
NameLocated inDescriptionRequiredSchema
documentCodequerydocumentCodeYesstring
documentTypequerydocumentTypeYesstring
Responses
CodeDescription
200OK
204Relation Deleted.
400Relation deletion failed due to bad data.
401Unauthorized
403Forbidden
Security
Security SchemaScopes
Authorizationglobal

Models


AdditionalCharges

NameTypeDescriptionRequired
additionalChargeAmountnumberNo
additionalChargeTaxAmountnumberNo
additionalChargesDetails[ AdditionalChargesDetails ]No
globalDiscountGlobalDiscountDetailsNo
globalDiscounts[ GlobalDiscountDetails ]No

AdditionalChargesDetails

NameTypeDescriptionRequired
additionalChargestringNo
additionalChargeAccountCodestringNo
addtionalChargeTaxstringNo
addtionalChargeTaxCodestringNo
apportionFlagbooleanNo
apportionValuestringEnum: "APPORTION_MANUAL", "APPORTION_ON_QTY", "APPORTION_ON_VALUE"No
cgstnumberNo
chargeAmountnumberNo
igstnumberNo
includeInReportbooleanNo
isPercentbooleanNo
isPreChargebooleanNo
percentnumberNo
sgstnumberNo
taxAmountnumberNo

Address

NameTypeDescriptionRequired
address1stringAddress line 1
Example: "218, Robinson Road"
No
address2stringAddress line 2
Example: "Downtown"
No
citystringCity
Example: "C001"
No
contactNamestringcontact name for address
Example: "John Smith"
No
countrystringCountry
Example: "C001"
No
destinationOfSupplystringstate in India
Example: "Maharashtra"
No
placeOfSupplystringstate in India
Example: "Punjab"
No
postalCodestringPostal Code
Example: 123456
No
preferredbooleanIs this a default address?
Example: true
No
statestringState
Example: "CS001"
No

AdvancedTrackingFulfilmentDto

NameTypeDescriptionRequired
binCodestringbin code
Example: "BIN-00001"
Yes
binNamestringBin name
Example: "Bin1"
No
qtyToFulfildoubleBatch qty to fulfill
Example: 1
No
rackCodestringRack code
Example: "RACK-00001"
Yes
rackNamestringRack name
Example: "Rack1"
No
rowCodestringRow code
Example: "ROW-00001"
Yes
rowNamestringRow name
Example: "Row1"
No
serialBatchNumberstringBatch or serial number to be fulfilled
Example: "Batch-001"
No
warehouseCodestringWarehouse of selected Batch/Serial
Example: "WH-0000001"
No
warehouseNamestringWarehouse name
Example: "Warehouse-1"
No

AdvancedTrackingMetaDto

NameTypeDescriptionRequired
acquiredCostnumberAcquired cost of the entire serial or batch
Example: 1
No
advancedTrackingReturnedAdvancedTrackingReturnedNo
batchSizedoubleSerial Number or Batch size
Example: 1
Yes
batchSizeAvailableForReturndoubleHow much of the batch or serial is fulfilled
Example: 1
Yes
batchSizeFulfilleddoubleHow much of the batch or serial is fulfilled
Example: 1
Yes
batchSizeReturneddoubleHow much of the batch or serial is returned
Example: 1
Yes
batchSizeReturnedPurchasedoubleHow much of the batch or serial is returned
Example: 1
Yes
binCodestringbin code
Example: "BIN-00001"
Yes
binNamestringbin Name
Example: "Bin 1"
Yes
expiryDatedateTimeExpiry date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch
Example: "01-01-2020"
No
idlongNo
manufacturingDatedateTimeManufacturing date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch
Example: "01-01-2020"
No
productVariantCodestringProduct code
Example: "P-001"
Yes
rackCodestringRack code
Example: "RACK-00001"
Yes
rackNamestringRack Name
Example: "Rack 1"
Yes
reservedQuantitydoubleReserved Serial Number or Batch size
Example: 1
No
reservedQuantityFulfilleddoubleFulfilled reserved serial number or batch size
Example: 1
Yes
rowCodestringRow code
Example: "ROW-00001"
Yes
rowNamestringRow Name
Example: "Row 1"
Yes
sequencelongSequence number
Example: 1
No
serialBatchNumberstringSerial Number or Batch Number
Example: "BATCH-001"
Yes
subSequencelongSubsequence number
Example: 1
No
warehouseCodestringPrimary Warehouse
Example: "WH-0000001"
No
warehouseNamestringPrimary Warehouse
Example: "warehouse name"
No

AdvancedTrackingReturned

NameTypeDescriptionRequired
batchSizeReturneddoubleNo
batchSizeReturnedPurchasedoubleNo
returnsByDoc[ AdvancedTrackingReturnedByDoc ]No

AdvancedTrackingReturnedByDoc

NameTypeDescriptionRequired
documentCodestringNo
qtyReturneddoubleNo
returnTypestringEnum: "SALES_RETURN", "PURCHASE_RETURN"No
transactionRefCodestringNo

ApprovalHistoryItem

NameTypeDescriptionRequired
approvedBystringNo
approvedDatestringNo
levelintegerNo
remarksstringNo
statusstringEnum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"No

ApprovalStatusRequestDto

NameTypeDescriptionRequired
approvalStatusstringEnum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"No
documentCodesstringNo

AttachmentsResponse

NameTypeDescriptionRequired
attachmentDatedateTimeNo
attachmentFileNamestringNo
attachmentIdlongNo
attachmentSizestringNo

AttributeDetails

NameTypeDescriptionRequired
idlongAttribute ID
Example: "Id"
No
namestringAttribute Name
Example: "Colour"
No
values[ string ]Attribute valuesNo

BackOrderUpdateRequest

NameTypeDescriptionRequired
documentInfoDocumentInfoNo
salesDocumentCodestringNo
salesDocumentTypestringEnum: "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

NameTypeDescriptionRequired
barcodeFieldstringNo
hideBarcodeLabelbooleanNo

BomAdditionalCostDto

NameTypeDescriptionRequired
bomMetaDetailsIdlongid of bomMetaDetailsId
Example: 1234
No
bomMetaNamestringBOM Meta Name
Example: "DEFAULT"
No
labelstringName of manufacturing service
Example: "Labour charges"
No
pricenumberQuantity of product in bom
Example: 10.5
No

BomMetaDetailsDto

NameTypeDescriptionRequired
activebooleanbom meta details status
Example: true
No
bomAddCostConfiguration[ BomAdditionalCostDto ]Bom additional cost informationNo
bomOperationsConfiguration[ BomOperationDto ]Bom Operations informationNo
bomProductCostDetails[ BomProductCostDetails ]JSON object for custom fields
Example: {"field1":"value1","field2":"value2"}
No
bomProductsConfiguration[ BomMetaDto ]Bom Products informationNo
codestringbom meta details code
Example: "code"
No
deletedbooleanbom meta details delete status
Example: true
No
idlongid of bom meta details
Example: 1234
No
isDefaultbooleanbom default
Example: true
No
namestringbom meta details name
Example: "bom meta name"
No
productIdstringid of bom product
Example: 1234
No

BomMetaDto

NameTypeDescriptionRequired
bomMetaDetailsIdlongid of bomMetaDetailsId
Example: 1234
No
bomMetaNamestringBOM Meta Name
Example: "DEFAULT"
No
bomProductSubstitutesDetails[ ProductSubstitutesDetails ]No
costnumberCost of product in bom
Example: 10.5
No
itemIdlongid of item in bom
Example: 1234
No
itemNamestringProduct Name
Example: "Apple"
Yes
produceProductTypestringProduce Product type
Enum: "NONE", "SCRAP", "COPRODUCT"
Example: "SCRAP"
Yes
productCodestringNo
quantitynumberQuantity of product in bom
Example: 10.5
No
stockUomlongNo

BomOperationDto

NameTypeDescriptionRequired
bomMetaDetailsIdlongid of bomMetaDetailsId
Example: 1234
No
bomMetaNamestringBOM Meta Name
Example: "DEFAULT"
No
costPerHournumberCost of operation in bom
Example: 10.5
No
fixedRatenumberCost of operation in bom
Example: 10.5
No
operationIdlongid of operation in bom
Example: 1234
No
operationNamestringOperation Name
Example: "Apple"
Yes
totalCostnumberCost of operation in bom
Example: 10.5
No

BomProductCostDetails

NameTypeDescriptionRequired
operationCostnumberOperation Cost
Example: 15
No
rawMaterialCostnumberRaw material cost
Example: 20
No
totalCostnumberTotal cost
Example: 35
No

BulkApiResponse

NameTypeDescriptionRequired
failure[ object ]No
statusCodeintegerNo
success[ object ]No

BulkApiResponse«QuotationDto»

NameTypeDescriptionRequired
failure[ QuotationDto ]No
statusCodeintegerNo
success[ QuotationDto ]No

BulkApiResponse«QuotationIndiaDto»

NameTypeDescriptionRequired
failure[ QuotationIndiaDto ]No
statusCodeintegerNo
success[ QuotationIndiaDto ]No

ContactDto

NameTypeDescriptionRequired
attentionTostringthe contact name in govt agency
Example: "Peter Parker"
No
autoChargebooleanAuto payment charge
Example: false
No
billingAddress[ Address ]List of Billing Address.No
businessUnitstringindicates the contact is govt agency
Example: "CAA01 - Cvl Avtn Authrty of Singapore"
No
contactMasterIdstring (uuid)contact master id
Example: "2df7a5c1-3305-498d-8d01-aa92c42d19d2"
No
contactNumberstringContact number
Example: "+65999999999"
No
creditLimitnumberCredit Limit
Example: 100
No
creditLimitInBaseCurrencynumberCredit Limit In Org Currency
Example: 100
No
currencyCodestringCurrency 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
documentSequenceCodestringContact Sequence code
Example: "C-0000001"
No
emailIdstringcontact email address
Example: "myinfo@domain.com"
No
extCompanyNamestringthe company name from external app
Example: "QuickBook"
No
intercompanyTypestringContact Type either parent or subsidiary
Enum: "PARENT", "SUBSIDIARY"
Example: "PARENT/SUBSIDIARY"
No
invoiceCreditLimitTypestringInvoice Credit Limit Type
Enum: "IGNORE", "WARN", "BLOCK"
Example: "IGNORE"
No
invoicesobjectNo
isAccountNumberFlagbooleanindicates if user is sending account number or code
Example: true
No
isCreditLimitApplicablebooleanContact credit limit applicable
Example: true
No
isIncludeCurrentInvoicebooleanInclude Current Invoice
Example: true
No
isIncludeCurrentQuotationbooleanInclude Current Quotation
Example: true
No
isIncludeCurrentSalesOrderbooleanInclude Current Sales Order
Example: false
No
namestringContact name
Example: "Sam"
No
payableAccountCodestringPayable account code
Example: "AC002"
No
paymentTermCodestringPayment term code
Example: "Net 0"
No
peppolIdstringPeppol ID
Example: "u000:11::11293"
No
purchasePriceLists[ long ]Set of Purchase price lists
Example: [123,456]
No
quotationCreditLimitTypestringQuotation Credit Limit Type
Enum: "IGNORE", "WARN", "BLOCK"
Example: "IGNORE"
No
receivableAccountCodestringReceivable account code
Example: "AC001"
No
salesOrderCreditLimitTypestringSales Order Credit Limit Type
Enum: "IGNORE", "WARN", "BLOCK"
Example: "IGNORE"
No
salesPriceLists[ long ]Set of Sales price lists
Example: [123,456]
No
sequenceFormatstringSequence Format
Example: 1
No
shippingAddress[ Address ]List of Shipping Address.No
singaporeGovtbooleanindicates the contact is govt agency
Example: true
No
taxExemptedbooleanDenotes if customer is tax exempted
Example: true
No
taxExemptionNostringGenerated tax exemption number
Example: "234s-few3-2422"
No
taxExemptionReasonstringTax exemption reason
Example: "Resale, Federal Agency"
No
taxNumberstringTax number
Example: 123456
No
uenstringContact UEN
Example: "DHJEUK"
No

ContactIndiaTdsInfo

NameTypeDescriptionRequired
considerThresholdLimitbooleanConsider Exemption Limit can be a check box field
Example: true
No
deducteeCodestringDeductee Type
Example: "Artificial Juridicial Person"
No
deducteeTypestringDeductee Type
Example: "Artificial Juridicial Person"
No
deductionApplicablebooleanThis field can be visible only if PAN number is mentioned.
Example: true
No
dttaApplicablebooleanNo
dttaFromDatedateTimeNo
dttaToDatedateTimeNo
higherRateintegerPercentage value and can be visible only if PAN number is not mentioned.
Example: 5
No
noDeductionFromDatedateTimeStart date field visible only if deductionApplicable field is true
Example: "01-01-2020"
No
noDeductionReasonstringChoose reason only if deductionApplicable field is true.
Example: "TDS not to be made till the Basic Exemption is reached"
No
noDeductionRefNostringAlphanumeric field and visible only if deductionApplicable field is true.
Example: "AAAAABBBB1100"
No
noDeductionTdsRateintegerSpecial rate override with TDS Rate setting and will be visible only if deductionApplicable field is true
Example: 5
No
noDeductionToDatedateTimeEnd date field visible only if deductionApplicable field is true
Example: "31-12-2020"
No
nonDeductionApplicablebooleanThis field can be visible only if PAN number is mentioned.
Example: true
No
specialRateintegerNo
tanstringContact TAN
Example: "AAAA99999A"
No

ContactInfo

NameTypeDescriptionRequired
addressstringNo
namestringNo

ContactInformation

NameTypeDescriptionRequired
autoChargebooleanAuto payment charge
Example: false
No
beVatIdentificationNostringVAT Identification No
Example: 123456789012345
No
billingAddress[ Address ]List of Billing Address.No
birClassPhilippinesstringBIR class determines the type of business
Example: "Services"
No
businessRegNostringContact Business Registration No
Example: "W10-0108-000000021"
No
contactMasterIdstring (uuid)contact master id
Example: "2df7a5c1-3305-498d-8d01-aa92c42d19d2"
No
contactNumberstringContact number
Example: "+65999999999"
No
creditLimitnumberCredit Limit
Example: 100
No
creditLimitInBaseCurrencynumberCredit Limit In Org Currency
Example: 100
No
currencyCodestringCurrency 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
customerTypestringCustomer Type
Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"
Example: "NA"
No
customerTypeMalaysiastringCustomer 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
customerTypePhilippinesstringCustomer 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
deVatIdentificationNostringVAT Identification No
Example: 123456789012345
No
documentSequenceCodestringContact Sequence code
Example: "C-0000001"
No
emailIdstringcontact email address
Example: "myinfo@domain.com"
No
exemptionCertificateMalaysiabooleanExemption certificate
Example: true
No
exemptionCriterialMalaysiastringExemption criteria
Enum: "NONE", "ZERO_RATED", "EXEMPTED_ZERO"
Example: "NONE(None)"
No
gstTreatmentstringGST 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
gstinstringContact GSTIN
Example: "21AONPM8088Q211"
No
intercompanyTypestringContact Type either parent or subsidiary
Enum: "PARENT", "SUBSIDIARY"
Example: "PARENT/SUBSIDIARY"
No
invoiceCreditLimitTypestringInvoice Credit Limit Type
Enum: "IGNORE", "WARN", "BLOCK"
Example: "IGNORE"
No
invoicesobjectNo
isAccountNumberFlagbooleanindicates if user is sending account number or code
Example: true
No
isCreditLimitApplicablebooleanContact credit limit applicable
Example: true
No
isIncludeCurrentInvoicebooleanInclude Current Invoice
Example: true
No
isIncludeCurrentQuotationbooleanInclude Current Quotation
Example: true
No
isIncludeCurrentSalesOrderbooleanInclude Current Sales Order
Example: false
No
namestringContact name
Example: "Sam"
No
nikNumberlongNIK No
Example: 123456789012345
No
nlVatIdentificationNostringVAT Identification No
Example: 123456789012345
No
npwpNumberlongNPWP No
Example: 123456789012345
No
panstringContact PAN
Example: "AONPM8088Q"
No
payableAccountCodestringPayable account code
Example: "AC002"
No
paymentTermCodestringPayment term code
Example: "Net 0"
No
purchasePriceLists[ long ]Set of Purchase price lists
Example: [123,456]
No
quotationCreditLimitTypestringQuotation Credit Limit Type
Enum: "IGNORE", "WARN", "BLOCK"
Example: "IGNORE"
No
receivableAccountCodestringReceivable account code
Example: "AC001"
No
residentbooleanIs resident?
Example: true
No
residentStatusIndonesiabooleanResident Status
Example: true
No
saArabicDetailsContactSAArabicDtoContact details in Arabic for Saudi ArabiaNo
salesOrderCreditLimitTypestringSales Order Credit Limit Type
Enum: "IGNORE", "WARN", "BLOCK"
Example: "IGNORE"
No
salesPriceLists[ long ]Set of Sales price lists
Example: [123,456]
No
salesTaxRegNostringContact Sales Tax Registration No
Example: "W10-0108-000000021"
No
sequenceFormatstringSequence Format
Example: 1
No
serviceTaxRegNostringContact Service Tax Registration No
Example: "W10-0108-000000021"
No
shippingAddress[ Address ]List of Shipping Address.No
taxExemptedbooleanNo
taxExemptionNostringNo
taxExemptionReasonstringNo
taxTreatmentstringTax 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
taxTypeCustomerstringTax 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
taxTypeVendorstringTax 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
tdsApplicableIndiabooleanNo
tdsInfoIndiaContactIndiaTdsInfoNo
tdsSectionToTdsRateIdlongContact TDS Section to Tds Rate Id
Example: 1213454
No
vatExemptionReasonPhilippinesstringPhilippines specific Contact VAT Exemption Reason
Example: "Reason"
No
vatNoPhilippinesstringPhilippines specific Contact VAT No.
Example: "012-345-678-910"
No
vatRegistrationNostringVAT Registration No
Example: 123456789012345
No
vatStatusPhilippinesstringPhilippines specific Contact VAT Status
Example: "Input VAT"
No
vendorTypestringVendor Type
Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"
Example: "NA"
No
vendorTypeMalaysiastringVendor Type
Enum: "NONE", "SALES_TAX_EXEMPTION", "MANUFACTURED_EXEMPTION", "PERFORMED_EXEMPTION"
Example: "NONE(None)"
No
vendorTypePhilippinesstringVendor 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
whtApplicablePhilippinesbooleanMake Contact as WHT applicable
Example: true
No
whtBusinessPhilippinesstringBIR class determines the type of business
Example: "Individual"
No

ContactSAArabicDto

NameTypeDescriptionRequired
billingAddress[ Address ]Billing addresses in Arabic languageNo
saArabicNamestringExample: "Name in Saudi Arabic Language"No
shippingAddress[ Address ]Shipping addresses in Arabic languageNo

CustomFieldItem

NameTypeDescriptionRequired
idlongDimension Id
Example: 11567
No
labelstringCustom Field Name
Example: "Label"
Yes
modulestringSupported ModulesNo
valueobjectDimension Value
Example: "XYZ"
No

DocumentInfo

NameTypeDescriptionRequired
documentCodestringDocument Code.
Example: "QO-0000001"
No
documentCreatedDatedateTimePurchase creation date
Example: "2023-01-01T00:00:00.000+0000"
No
documentSequenceCodestringPurchase Order Code
Example: "0000001"
No
documentTypestringType 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

NameTypeDescriptionRequired
documentSequenceCodestringProduct Document Sequence code
Example: "P-0000001"
Yes
documentUomlongUOM id
Example: 111
No
itemIdlongDocument Item id
Example: 154
Yes
productProductResponseProduct Short Info
Example: "product"
No
productCodestringProduct code
Example: "P00001"
Yes
productDescriptionstringProduct description
Example: "Apple watch"
No
productNamestringProduct Name
Example: "iPhone"
No
productQuantitynumberProduct quantity
Example: 2
Yes
taxTaxDtoTax details
Example: "taxDto"
No
taxCodestringTax code
Example: "tax code"
No
unitPricenumberProduct unit price
Example: 0.7
Yes

DocumentItemTaxMappingDto

NameTypeDescriptionRequired
additionalTaxInbooleantrue/false
Example: true
No
taxAmountnumberTax amount
Example: 10
No
taxApplyTostringTax Apply To (Pre/AFTER)
Example: "Pre"
No
taxCodestringTax Code
Example: "GST (10%)"
No
taxNamestringTax Name
Example: "GST (10%)"
No
taxRatenumberTax rate
Example: 10
No
taxSeqCodestringTax Sequence Code
Example: "0000001"
No
taxableAmountnumberTaxable Amount
Example: 100
No

DocumentUOMSchemaDefinition

NameTypeDescriptionRequired
namestringUOM Schema Name
Example: "UNIT"
No
schemaIdlongUOM Schema Id
Example: 1
No
sinkConversionFactornumber10
Example: 10
No
sinkUOMlong2
Example: 2
No
sourceConversionFactornumber1
Example: 1
No
sourceUOMlong4
Example: 4
No
uidstringUOM Schema Definition Id
Example: 1
No

FilterCondition

NameTypeDescriptionRequired
colIdstringNo
oprstringNo
valuestringNo

FilterRecord

NameTypeDescriptionRequired
filterConditions[ FilterCondition ]No
logicalOperatorstringNo
uniqueIdlongNo

GlobalDiscountDetails

NameTypeDescriptionRequired
accountCodestringNo
amountnumberNo
isPercentbooleanNo
isSubTotalOnlybooleanNo
namestringNo
percentnumberNo

InventoryDto

NameTypeDescriptionRequired
availableQuantitydoubleAvailable quantity
Example: 100
No
binCodestringbin code
Example: "BIN-00001"
Yes
binNamestringbin name
Example: "BIN-NAME"
No
costOfGoodsSoldAccountCodestringCost of goods sold account code
Example: "A-10231"
Yes
inventoryAccountCodestringInventory account code
Example: "A-10232"
Yes
inventoryAccountNamestringInventory account name
Example: "Inventory Account"
Yes
landedCostWeightnumberLanded cost weight value
Example: 10.5
No
openingQuantitydoubleOpening quantity
Example: 10
No
openingValuationdoubleOpening valuation
Example: 100.4
No
rackCodestringRack code
Example: "RACK-00001"
Yes
rackNamestringRack name
Example: "RACK-NAME"
No
reservedQuantitydoubleReserved quantity
Example: 100
No
rowCodestringRow code
Example: "ROW-00001"
Yes
rowNamestringRow name
Example: "ROW-NAME"
No
stockAdjustmentAccountCodestringStock adjustment account code
Example: "A-10234"
Yes
warehouseCodestringWarehouse code
Example: "WH-00001"
Yes
wipInventoryAccountCodestringWIP Inventory account code
Example: "A-10233"
Yes

InventoryWarehouseDetails

NameTypeDescriptionRequired
availableQuantitynumberAvailable quantity
Example: 100
No
openingQuantitynumberOpening quantity
Example: 10
No
openingValuationnumberOpening Valuation
Example: 1000
No
warehouseCodestringWarehouse code
Example: "WH-00001"
Yes

InvoiceResponseInfo

NameTypeDescriptionRequired
currencystringNo
documentCodestringdocument code
Example: "SI-0000041"
No
documentSequenceCodestringDocument Sequence Code
Example: "00000001"
No
dueAmountnumberdue amount
Example: 46
No
exchangeRatenumberNo
idlongID
Example: 43
No
invoiceDatedateTimeinvoice date
Example: "2018-10-01"
No
invoiceDueDatedateTimeinvoice due date
Example: "2018-10-01"
No
memostringmemo
Example: "test"
No
purchaseOrderRefNostringContact PO reference number
Example: "CPO001"
No
statusstringEnum: "OPEN", "DRAFT", "CLOSED"No
supplierInvoiceNostringContact supplier invoice number
Example: "CSI001"
No
taxAmountnumberTotal Amount
Example: 1
No
totalAmountnumbertotal amount
Example: 46
No
totalAmountInBaseCurrencynumbertotal amount in base currency
Example: 46
No
typestringsale invoice or purchase invoice
Example: "sale_invoice"
No

ItemQtyFulfilledByDoc

NameTypeDescriptionRequired
fulfillmentIdstringNo
siAmountnumberNo

LandedCostCategory

NameTypeDescriptionRequired
allocationTypestringEnum: "QUANTITY", "VALUE", "WEIGHT", "MANUAL", "CUSTOM_DUTY"No
namestringNo

LinkedDocumentUpdateRequest

NameTypeDescriptionRequired
newLinkedDocumentDocumentInfoNo
oldLinkedDocumentDocumentInfoNo

LinkedDocumentsDto

NameTypeDescriptionRequired
codestringNo
usedbooleanNo

LinkedSalesInvoiceResponse

NameTypeDescriptionRequired
documentSequenceCodestringSales invoice Sequence Code
Example: "0000001"
No
dueAmountnumberAmount Due
Example: 12.322
No
exchangeRatenumberExchange rate
Example: 0.456345
No
fulfillmentStatusstringfulfillment status
Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"
Example: "PARTIAL_FULFILLED"
No
salesInvoiceCodestringSales invoice code
Example: "SI001"
No
salesInvoiceDatestringSales Invoice date
Example: "25-10-2019"
Yes
totalAmountnumberTotal Amount
Example: 1234.33
No

LinkedSalesOrderResponse

NameTypeDescriptionRequired
documentSequenceCodestringSales order Sequence Code
Example: "0000001"
No
dueAmountnumberAmount Due
Example: 12.322
No
exchangeRatenumberExchange rate
Example: 0.456345
No
fulfillmentStatusstringfulfillment status
Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"
Example: "PARTIAL_FULFILLED"
No
salesOrderCodestringSales order code
Example: "SO-001"
No
salesOrderDatestringSales Invoice date
Example: "25-10-2019"
Yes

LinkedWareHouse

NameTypeDescriptionRequired
binCodestringbin code
Example: "BIN-00001"
Yes
quantitynumberQuantity from Warehouse.
Example: 100
No
rackCodestringRack code
Example: "RACK-00001"
Yes
rowCodestringRow code
Example: "ROW-00001"
Yes
warehouseCodestringWarehouse code to identify the Warehouse.
Example: "WH-0000001"
No

PPSReservedQuantityData

NameTypeDescriptionRequired
itemIdlongDocument Item id
Example: 154
Yes
reservedQuantitiesData[ ReservedQuantityData ]Reserved quantity data
Example: []
No

Pageable

NameTypeDescriptionRequired
offsetlongNo
pageNumberintegerNo
pageSizeintegerNo
pagedbooleanNo
sortSortNo
unpagedbooleanNo

Page«QuotationDtoAustralia»

NameTypeDescriptionRequired
content[ QuotationDtoAustralia ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«QuotationDtoCanada»

NameTypeDescriptionRequired
content[ QuotationDtoCanada ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«QuotationDtoDE»

NameTypeDescriptionRequired
content[ QuotationDtoDE ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«QuotationDtoIndonesia»

NameTypeDescriptionRequired
content[ QuotationDtoIndonesia ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«QuotationDtoMalaysia»

NameTypeDescriptionRequired
content[ QuotationDtoMalaysia ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«QuotationDtoSaudiArabia»

NameTypeDescriptionRequired
content[ QuotationDtoSaudiArabia ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«QuotationDtoUAE»

NameTypeDescriptionRequired
content[ QuotationDtoUAE ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«QuotationDtoUk»

NameTypeDescriptionRequired
content[ QuotationDtoUk ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«QuotationDto»

NameTypeDescriptionRequired
content[ QuotationDto ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«QuotationIndiaDto»

NameTypeDescriptionRequired
content[ QuotationIndiaDto ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«QuotationIsraelDto»

NameTypeDescriptionRequired
content[ QuotationIsraelDto ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«QuotationPhilippinesDto»

NameTypeDescriptionRequired
content[ QuotationPhilippinesDto ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

ProductInOutQty

NameTypeDescriptionRequired
documentTypestringEnum: "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
productCodestringNo
quantitynumberNo

ProductInformation

NameTypeDescriptionRequired
activebooleanProduct status
Example: true
No
advancedTrackingstringAdvanced Tracking Type
Enum: "NONE", "BATCH", "SERIAL"
Example: "NONE"
No
advancedTrackingMetaData[ AdvancedTrackingMetaDto ]Advanced Tracking Meta data
Example: {"field1":"value1","field2":"value2"}
No
amortizationPeriodintegerAmortization template period
Example: 36
No
amortizationTemplateCodestringAmortization template code
Example: "0000001"
No
attributes[ AttributeDetails ]Attribute DetailsNo
autoFulfillmentEnabledbooleanIs Auto-Fulfillment enable?
Example: false
No
availableQuantitynumberAvailable Quantity
Example: 2
No
barcodestringProduct barcode
Example: 2365234
No
barcodeDetailsBarcodeDetailsbarcode details
Example: {"barcodeField":"Samsung"}
No
basePricedoubleRevenue Base price
Example: 120
No
bomAddCostConfiguration[ BomAdditionalCostDto ]Bom additional cost informationNo
bomMetaDetailsList[ BomMetaDetailsDto ]multiple bom configuration
Example: "Bom Configuration"
No
bomOperationsConfiguration[ BomOperationDto ]Bom Operations informationNo
bomProductCostDetails[ BomProductCostDetails ]JSON object for custom fields
Example: {"field1":"value1","field2":"value2"}
No
bomProductsConfiguration[ BomMetaDto ]Bom Products informationNo
categoryCodestringCategory code
Example: "AB0001"
No
categoryDescstringCategory description
Example: "Medical Equipment"
No
cessRulestringCess rule expression
Example: "Math.max(21*amount/100,4170*quantity/1000)"
No
cessRuleDescriptionstringCess rule description
Example: "21% or Rs. 4170 per thousand, whichever is higher"
No
costOfGoodsSoldAccountCodestringNo
customField[ CustomFieldItem ]JSON object for custom fields
Example: {"field1":"value1","field2":"value2"}
No
deferredExpenseAccountCodestringDeferred Expense account code
Example: "A-0015"
No
deferredRevenueAccountCodestringDeferred Revenue account code
Example: "A-0015"
No
deletedbooleanProduct delete status
Example: true
No
descriptionstringProduct description
Example: "Description"
No
documentSequenceCodestringProduct Sequence code
Example: "P-0000001"
No
exciseApplicablebooleanExample: trueNo
exciseRatedoubleExcise rate based on Excise Type
Example: 10
No
exciseRateIndonumberExcise Rate
Example: 5
No
exciseTypestringExcise type to apply
Enum: "PERCENT", "FLAT"
Example: "PERCENT"
No
exemptedMalaysiabooleanWhether Product is Tax Exempted
Example: true
No
glAccountCodestringGL account code
Example: "A-0017"
No
hasBuildAssemblybooleanHas Build Assembly
Example: true
No
hasVariantsbooleanProduct has variants
Example: false
No
hsnOrSacCodestringHSN or SAC code of product
Example: 1234
No
idlongProduct ID
Example: 1234
No
images[ string ]Product image url'sNo
incomingQtynumberProduct incoming QtyNo
inventoryInventoryDtoInventory information required for Tracked Products.No
inventoryAccountCodestringNo
inventoryWarehouseDetails[ InventoryWarehouseDetails ]Inventory warehouse details
Example: {"warehouseCode":"WH-00001","availableQuantity":"100","openingQuantity":"100"}
No
isAccountNumberFlagbooleanindicates if user is sending account number or code
Example: true
No
isFinishedProductbooleanIs finished product?
Example: false
No
isUiProductUpdatebooleanProduct is update by UI.
Example: false
No
isVariantbooleanIs a variant
Example: false
No
itcAdjustmentstringITC adjustment
Enum: "NA", "ITC_IS_BLOCKED", "ITC_IS_REVERSED"
Example: "ITC_IS_BLOCKED"
No
landedCostCategory[ LandedCostCategory ]Landed cost category detailsNo
manufacturingCostAccountCodestringManufacturing Cost Account Code
Example: "AC-0000012"
No
masterProductCodestringMaster Product Code
Example: "P-0000001"
No
multipleUomSchemabooleanIs multiple Uom Schema?
Example: true
No
namestringProduct Name
Example: "Apple"
Yes
nameInArabicSAstringNo
offeringTypestringOffering type
Enum: "GOODS", "SERVICES"
Example: "GOODS"
No
outgoingQtynumberProduct outgoing QtyNo
productIdstringProduct ID
Example: "P000011"
No
productSubstitutesDetails[ ProductSubstitutesDetails ]No
productTransactionTypestringProduct Transaction Type
Enum: "BOTH", "PURCHASE", "SALES"
Example: "BOTH"
Yes
purchaseAccountCodestringPurchase account code
Example: "A-0012"
Yes
purchasePricedoublePurchase price
Example: 123.33
Yes
purchasePriceTaxInclusivebooleanIs purchase price tax inclusive?
Example: true
No
purchaseReturnAccountCodestringPurchase return account code
Example: "A-0014"
No
purchaseTaxCodestringPurchase tax code
Example: "T-001"
No
recommendedUomlongRecommended product uomNo
reorderEnabledbooleanFlag to enable reorder level
Example: true
No
reorderLevellongReorder level of the Products.
Example: 100
No
reorderLevelReachedbooleanHas Reorder level reachedNo
reorderQuantitylongQuantity to be reordered
Example: 50
No
reorderVendorCodestringVendor code for reorder
Example: "C-000001"
No
reorderVendorNamestringReorder Vendor NameNo
reservedQuantitynumberReserved Quantity
Example: 2
No
revenueRecognitionInfoProductRevenueRecognitionInfoProduct Revenue Recognition Information ObjectNo
salesAccountCodestringSales account code
Example: "A-0013"
Yes
salesPricedoubleSales price
Example: 120
Yes
salesPriceTaxInclusivebooleanIs sales price tax inclusive?
Example: false
No
salesReturnAccountCodestringSales return account code
Example: "A-0015"
No
salesTaxCodestringSales tax code
Example: "T-002"
No
sequenceFormatstringSequence Format
Example: 1
No
sourcestringIdentify this is ecom sync product
Example: "SHOPIFY"
No
stockAdjustmentAccountCodestringNo
stockUomlongStock UOM
Example: 2
Yes
tariffOrServiceCodeMalaysiastringTariff or Service code of product
Example: 1234
No
taxExemptionReasonstringTax Exempted reason to be filled, if taxPreference is true
Enum: "EXEMPTED", "NON_GST"
Example: "EXEMPTED"
No
taxExemptionReasonMalaysiastringTax Exempted reason to be filled, if taxPreference is true
Enum: "EXEMPTED", "NON_SST", "LIVE_ANIMALS", "UNPROCESSED_FOOD", "VEGETABLES", "MEDICINES", "MACHINERY", "CHEMICALS"
Example: "EXEMPTED"
No
taxPreferencebooleanWhether Product is Tax Exempted
Example: true
No
taxablebooleanIs taxable?
Example: true
No
tdsApplicableIndiabooleanNo
tdsNatureOfPaymentIndiastringNo
typestringProduct type
Enum: "TRACKED", "NONTRACKED", "BILL_OF_MATERIALS"
Example: "TRACKED"
Yes
uomSchemalongReorder level of the Products.
Example: 100
No
uomSchemaDtoUOMSchemaDtoProduct uom schema informationNo
valuationMethodstringValuation Method
Enum: "FIFO", "AVERAGE"
Example: "FIFO"
Yes
variantAttributesobjectAttribute Details specific to a variantNo
variantCountintegerVariant CountNo
whtApplicablebooleanExample: trueNo
whtSectionToWhtRateIdlongProduct WHT - Nature Of Payment to WHT Rate Id
Example: 1213454
No
wipInventoryAccountCodestringNo

ProductResponse

NameTypeDescriptionRequired
activebooleanProduct status
Example: true
No
advancedTrackingstringAdvanced Tracking Type
Enum: "NONE", "BATCH", "SERIAL"
Example: "NONE"
No
advancedTrackingMetaData[ AdvancedTrackingMetaDto ]Advanced Tracking Meta data
Example: {"field1":"value1","field2":"value2"}
No
amortizationPeriodintegerAmortization template period
Example: 36
No
amortizationTemplateCodestringAmortization template code
Example: "0000001"
No
attributes[ AttributeDetails ]Attribute DetailsNo
autoFulfillmentEnabledbooleanIs Auto-Fulfillment enable?
Example: false
No
barcodestringProduct barcode
Example: 2365234
No
barcodeDetailsBarcodeDetailsbarcode details
Example: {"barcodeField":"Samsung"}
No
basePricedoubleRevenue Base price
Example: 120
No
bomAddCostConfiguration[ BomAdditionalCostDto ]Bom additional cost informationNo
bomMetaDetailsList[ BomMetaDetailsDto ]multiple bom configuration
Example: "Bom Configuration"
No
bomOperationsConfiguration[ BomOperationDto ]Bom Operations informationNo
bomProductCostDetails[ BomProductCostDetails ]JSON object for custom fields
Example: {"field1":"value1","field2":"value2"}
No
bomProductsConfiguration[ BomMetaDto ]Bom Products informationNo
categoryCodestringCategory code
Example: "AB0001"
No
categoryDescstringCategory description
Example: "Medical Equipment"
No
customField[ CustomFieldItem ]JSON object for custom fields
Example: {"field1":"value1","field2":"value2"}
No
deferredExpenseAccountCodestringDeferred Expense account code
Example: "A-0015"
No
deferredRevenueAccountCodestringDeferred Revenue account code
Example: "A-0015"
No
deletedbooleanProduct delete status
Example: true
No
descriptionstringProduct description
Example: "Description"
No
documentSequenceCodestringProduct Sequence code
Example: "P-0000001"
No
exciseRateIndonumberExcise Rate
Example: 5
No
hasBuildAssemblybooleanHas Build Assembly
Example: true
No
hasVariantsbooleanProduct has variants
Example: false
No
idlongProduct ID
Example: 1234
No
images[ string ]Product image url'sNo
incomingQtynumberProduct incoming QtyNo
inventoryInventoryDtoInventory information required for Tracked Products.No
inventoryWarehouseDetails[ InventoryWarehouseDetails ]Inventory warehouse details
Example: {"warehouseCode":"WH-00001","availableQuantity":"100","openingQuantity":"100"}
No
isAccountNumberFlagbooleanindicates if user is sending account number or code
Example: true
No
isFinishedProductbooleanIs finished product?
Example: false
No
isUiProductUpdatebooleanProduct is update by UI.
Example: false
No
isVariantbooleanIs a variant
Example: false
No
landedCostCategory[ LandedCostCategory ]Landed cost category detailsNo
manufacturingCostAccountCodestringManufacturing Cost Account Code
Example: "AC-0000012"
No
masterProductCodestringMaster Product Code
Example: "P-0000001"
No
multipleUomSchemabooleanIs multiple Uom Schema?
Example: true
No
namestringProduct Name
Example: "Apple"
Yes
outgoingQtynumberProduct outgoing QtyNo
productIdstringProduct ID
Example: "P000011"
No
productSubstitutesDetails[ ProductSubstitutesDetails ]No
productTransactionTypestringProduct Transaction Type
Enum: "BOTH", "PURCHASE", "SALES"
Example: "BOTH"
Yes
purchaseAccountCodestringPurchase account code
Example: "A-0012"
Yes
purchasePricedoublePurchase price
Example: 123.33
Yes
purchasePriceTaxInclusivebooleanIs purchase price tax inclusive?
Example: true
No
purchaseReturnAccountCodestringPurchase return account code
Example: "A-0014"
No
purchaseTaxCodestringPurchase tax code
Example: "T-001"
No
recommendedUomlongRecommended product uomNo
reorderEnabledbooleanFlag to enable reorder level
Example: true
No
reorderLevellongReorder level of the Products.
Example: 100
No
reorderLevelReachedbooleanHas Reorder level reachedNo
reorderQuantitylongQuantity to be reordered
Example: 50
No
reorderVendorCodestringVendor code for reorder
Example: "C-000001"
No
reorderVendorNamestringReorder Vendor NameNo
revenueRecognitionInfoProductRevenueRecognitionInfoProduct Revenue Recognition Information ObjectNo
salesAccountCodestringSales account code
Example: "A-0013"
Yes
salesPricedoubleSales price
Example: 120
Yes
salesPriceTaxInclusivebooleanIs sales price tax inclusive?
Example: false
No
salesReturnAccountCodestringSales return account code
Example: "A-0015"
No
salesTaxCodestringSales tax code
Example: "T-002"
No
sequenceFormatstringSequence Format
Example: 1
No
sourcestringIdentify this is ecom sync product
Example: "SHOPIFY"
No
stockUomlongStock UOM
Example: 2
Yes
taxablebooleanIs taxable?
Example: true
No
typestringProduct type
Enum: "TRACKED", "NONTRACKED", "BILL_OF_MATERIALS"
Example: "TRACKED"
Yes
uomSchemalongReorder level of the Products.
Example: 100
No
uomSchemaDtoUOMSchemaDtoProduct uom schema informationNo
valuationMethodstringValuation Method
Enum: "FIFO", "AVERAGE"
Example: "FIFO"
Yes
variantAttributesobjectAttribute Details specific to a variantNo
variantCountintegerVariant CountNo

ProductRevenueRecognitionInfo

NameTypeDescriptionRequired
allocationTypestringAllocation Type
Example: "Normal/Exclude"
No
createRevenuePlanOnstringCreate Revenue Plan On
Example: "Fulfillment"
No
isDirectRevenuePositingbooleanDirect Revenue Positing
Example: true
No
itemRevenueCategorystringItem Revenue Category
Example: "Licence"
No
revRecForecastRulestringRevenue Recognition Forecast Rule
Example: "Rule Forecast 1"
No
revRecRulestringRevenue Recognition Rule
Example: "Rule 1"
No

ProductStockInfo

NameTypeDescriptionRequired
fulfilledQuantitynumberNo
pendingQuantitynumberNo
productCodestringNo
receiptQuantitynumberNo
statusstringNo
warehouseCodestringNo

ProductSubstitutesDetails

NameTypeDescriptionRequired
advancedTrackingstringAdvanced Tracking Type
Enum: "NONE", "BATCH", "SERIAL"
Example: "NONE"
No
availableQuantitynumberQuantity of product available
Example: 10
No
productDocumentSeqCodestringDoc seq code of Product
Example: "P-00001"
No
productIdstringProduct Id
Example: "P-00001"
No
productNamestringName of Product
Example: "Test Product"
No
stockUomlongStock UOM
Example: 2
Yes
typestringProduct type
Enum: "TRACKED", "NONTRACKED", "BILL_OF_MATERIALS"
Example: "TRACKED"
Yes

QuotationBulkDeleteResponseDto

NameTypeDescriptionRequired
documentSequenceCodestringdocumentSequenceCode
Example: "QU-0000001"
No
httpStatusstringHTTP 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
reasonstringExample: "NOT FOUND"No

QuotationDto

NameTypeDescriptionRequired
additionalChargesAdditionalChargesNo
approvalStatusstringApproval status
Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"
Example: "APPROVED"
No
attachments[ string ]Attachments url'sNo
attachmentsWithLink[ AttachmentsResponse ]Attachments DetailsNo
backOrderbooleanBackorder flag to indicate if backorder created
Example: true
No
billToAddressBill to Address.No
contactContactInfoContact info
Example: "contact object"
No
contactCodestringContact code
Example: "C-0001"
Yes
contactDtoContactDtoContact DetailsYes
createdBylongUserId of creator
Example: 123
No
currencystringCurrency code
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
deletedbooleanQuotation deleted
Example: false
No
documentDatedateTimeDocument date
Example: "27-10-2019"
No
documentSequenceCodestringQuotation Code
Example: "0000001"
No
draftbooleanTrue if want to save as draft.
Example: false
No
errors[ string ]List of validation error messagesNo
exchangeRatedoubleExchange rate
Example: 0.01891562
No
fulfillmentDatedateTimeFulfillment date
Example: "28-10-2019"
No
fulfillmentOndateTimeFulfillment On
Example: "28-10-2019"
No
fulfillmentStatusstringFulfillment status
Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"
Example: "UNFULFILLED"
No
fulfillmentTypestringFulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP
_Enum:
"NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"
Example: "PICK_PACK_SHIP"
No
gstExchangeRatenumberGST 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
memostringMemo text
Example: "Sales quotation"
No
processedInPPSbooleanNo
quotationItemDtoList[ QuotationItemDto ]Quotation items informationNo
recurringbooleanIs quotation set to recurring
Example: false
No
recurringActivatedbooleanIs quotation recurring active
Example: false
No
reservedStockbooleanReserved stock enabled
Example: true
No
roundOffAmountInDocumentCurrencynumberRound Off Amount in Document Currency
Example: 0.3
No
sequenceFormatstringSequence Format Id
Example: 1
No
shipByDatedateTimeShip by date
Example: "25-10-2019"
No
shipFromAddressShip from Address.No
shipToAddressShip to Address.No
sourceAppNamestringSource App Name
Example: "BOOKS"
No
statusstringQuotation status
Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"
Example: "OPEN"
No
tenantIdlongTenant id
Example: 123
No
unitPriceGstInclusivebooleanUnit Price is GST inclusive
Example: true
No
validTillDatedateTimeValid till date
Example: "29-10-2019"
No
warehouseCodestringWarehouse Code
Example: "WH-000001"
No

QuotationDtoAustralia

NameTypeDescriptionRequired
approvalStatusstringApproval status
Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"
Example: "APPROVED"
No
attachments[ string ]Attachments url'sNo
attachmentsWithLink[ AttachmentsResponse ]Attachments DetailsNo
backOrderbooleanBackorder flag to indicate if backorder created
Example: true
No
billToAddressBill to Address.No
contactContactInfoContact info
Example: "contact object"
No
contactCodestringContact code
Example: "C-0001"
Yes
contactDtoContactDtoContact DetailsYes
createdBylongUserId of creator
Example: 123
No
currencystringCurrency code
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
deletedbooleanQuotation deleted
Example: false
No
documentDatedateTimeDocument date
Example: "27-10-2019"
No
documentSequenceCodestringQuotation Code
Example: "0000001"
No
draftbooleanTrue if want to save as draft.
Example: false
No
errors[ string ]List of validation error messagesNo
exchangeRatedoubleExchange rate
Example: 0.01891562
No
fulfillmentDatedateTimeFulfillment date
Example: "28-10-2019"
No
fulfillmentOndateTimeFulfillment On
Example: "28-10-2019"
No
fulfillmentStatusstringFulfillment status
Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"
Example: "UNFULFILLED"
No
fulfillmentTypestringFulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP
_Enum:
"NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"
Example: "PICK_PACK_SHIP"
No
gstExchangeRatenumberGST 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
memostringMemo text
Example: "Sales quotation"
No
processedInPPSbooleanNo
quotationItemDtoList[ QuotationItemDtoAustralia ]Quotation items informationNo
recurringbooleanIs quotation set to recurring
Example: false
No
recurringActivatedbooleanIs quotation recurring active
Example: false
No
reservedStockbooleanReserved stock enabled
Example: true
No
roundOffAmountInDocumentCurrencynumberRound Off Amount in Document Currency
Example: 0.3
No
sequenceFormatstringSequence Format Id
Example: 1
No
shipByDatedateTimeShip by date
Example: "25-10-2019"
No
shipFromAddressShip from Address.No
shipToAddressShip to Address.No
sourceAppNamestringSource App Name
Example: "BOOKS"
No
statusstringQuotation status
Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"
Example: "OPEN"
No
tenantIdlongTenant id
Example: 123
No
unitPriceGstInclusivebooleanUnit Price is GST inclusive
Example: true
No
validTillDatedateTimeValid till date
Example: "29-10-2019"
No
warehouseCodestringWarehouse Code
Example: "WH-000001"
No

QuotationDtoCanada

NameTypeDescriptionRequired
approvalStatusstringApproval status
Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"
Example: "APPROVED"
No
attachments[ string ]Attachments url'sNo
attachmentsWithLink[ AttachmentsResponse ]Attachments DetailsNo
backOrderbooleanBackorder flag to indicate if backorder created
Example: true
No
billToAddressBill to Address.No
contactContactInfoContact info
Example: "contact object"
No
contactCodestringContact code
Example: "C-0001"
Yes
contactDtoContactDtoContact DetailsYes
createdBylongUserId of creator
Example: 123
No
currencystringCurrency code
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
deletedbooleanQuotation deleted
Example: false
No
documentDatedateTimeDocument date
Example: "27-10-2019"
No
documentSequenceCodestringQuotation Code
Example: "0000001"
No
draftbooleanTrue if want to save as draft.
Example: false
No
errors[ string ]List of validation error messagesNo
exchangeRatedoubleExchange rate
Example: 0.01891562
No
fulfillmentDatedateTimeFulfillment date
Example: "28-10-2019"
No
fulfillmentOndateTimeFulfillment On
Example: "28-10-2019"
No
fulfillmentStatusstringFulfillment status
Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"
Example: "UNFULFILLED"
No
fulfillmentTypestringFulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP
_Enum:
"NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"
Example: "PICK_PACK_SHIP"
No
gstExchangeRatenumberGST 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
memostringMemo text
Example: "Sales quotation"
No
processedInPPSbooleanNo
quotationItemDtoList[ QuotationItemDtoCanada ]Quotation items informationNo
recurringbooleanIs quotation set to recurring
Example: false
No
recurringActivatedbooleanIs quotation recurring active
Example: false
No
reservedStockbooleanReserved stock enabled
Example: true
No
roundOffAmountInDocumentCurrencynumberRound Off Amount in Document Currency
Example: 0.3
No
sequenceFormatstringSequence Format Id
Example: 1
No
shipByDatedateTimeShip by date
Example: "25-10-2019"
No
shipFromAddressShip from Address.No
shipToAddressShip to Address.No
sourceAppNamestringSource App Name
Example: "BOOKS"
No
statusstringQuotation status
Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"
Example: "OPEN"
No
tenantIdlongTenant id
Example: 123
No
unitPriceGstInclusivebooleanUnit Price is GST inclusive
Example: true
No
validTillDatedateTimeValid till date
Example: "29-10-2019"
No
warehouseCodestringWarehouse Code
Example: "WH-000001"
No

QuotationDtoDE

NameTypeDescriptionRequired
approvalStatusstringApproval status
Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"
Example: "APPROVED"
No
attachments[ string ]Attachments url'sNo
attachmentsWithLink[ AttachmentsResponse ]Attachments DetailsNo
backOrderbooleanBackorder flag to indicate if backorder created
Example: true
No
billToAddressBill to Address.No
contactContactInfoContact info
Example: "contact object"
No
contactCodestringContact code
Example: "C-0001"
Yes
contactDtoContactDtoContact DetailsYes
createdBylongUserId of creator
Example: 123
No
currencystringCurrency code
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
deletedbooleanQuotation deleted
Example: false
No
documentDatedateTimeDocument date
Example: "27-10-2019"
No
documentSequenceCodestringQuotation Code
Example: "0000001"
No
draftbooleanTrue if want to save as draft.
Example: false
No
errors[ string ]List of validation error messagesNo
exchangeRatedoubleExchange rate
Example: 0.01891562
No
fulfillmentDatedateTimeFulfillment date
Example: "28-10-2019"
No
fulfillmentOndateTimeFulfillment On
Example: "28-10-2019"
No
fulfillmentStatusstringFulfillment status
Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"
Example: "UNFULFILLED"
No
fulfillmentTypestringFulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP
_Enum:
"NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"
Example: "PICK_PACK_SHIP"
No
gstExchangeRatenumberGST 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
memostringMemo text
Example: "Sales quotation"
No
processedInPPSbooleanNo
quotationItemDtoList[ QuotationItemDtoDE ]Quotation items informationNo
recurringbooleanIs quotation set to recurring
Example: false
No
recurringActivatedbooleanIs quotation recurring active
Example: false
No
reservedStockbooleanReserved stock enabled
Example: true
No
roundOffAmountInDocumentCurrencynumberRound Off Amount in Document Currency
Example: 0.3
No
sequenceFormatstringSequence Format Id
Example: 1
No
shipByDatedateTimeShip by date
Example: "25-10-2019"
No
shipFromAddressShip from Address.No
shipToAddressShip to Address.No
sourceAppNamestringSource App Name
Example: "BOOKS"
No
statusstringQuotation status
Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"
Example: "OPEN"
No
tenantIdlongTenant id
Example: 123
No
unitPriceGstInclusivebooleanUnit Price is GST inclusive
Example: true
No
validTillDatedateTimeValid till date
Example: "29-10-2019"
No
warehouseCodestringWarehouse Code
Example: "WH-000001"
No

QuotationDtoIndonesia

NameTypeDescriptionRequired
approvalStatusstringApproval status
Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"
Example: "APPROVED"
No
attachments[ string ]Attachments url'sNo
attachmentsWithLink[ AttachmentsResponse ]Attachments DetailsNo
backOrderbooleanBackorder flag to indicate if backorder created
Example: true
No
billToAddressBill to Address.No
contactContactInfoContact info
Example: "contact object"
No
contactCodestringContact code
Example: "C-0001"
Yes
contactDtoContactDtoContact DetailsYes
createdBylongUserId of creator
Example: 123
No
currencystringCurrency code
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
deletedbooleanQuotation deleted
Example: false
No
documentDatedateTimeDocument date
Example: "27-10-2019"
No
documentSequenceCodestringQuotation Code
Example: "0000001"
No
draftbooleanTrue if want to save as draft.
Example: false
No
errors[ string ]List of validation error messagesNo
exchangeRatedoubleExchange rate
Example: 0.01891562
No
fulfillmentDatedateTimeFulfillment date
Example: "28-10-2019"
No
fulfillmentOndateTimeFulfillment On
Example: "28-10-2019"
No
fulfillmentStatusstringFulfillment status
Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"
Example: "UNFULFILLED"
No
fulfillmentTypestringFulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP
_Enum:
"NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"
Example: "PICK_PACK_SHIP"
No
gstExchangeRatenumberGST 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
memostringMemo text
Example: "Sales quotation"
No
processedInPPSbooleanNo
quotationItemDtoList[ QuotationItemDtoIndonesia ]Quotation items informationNo
recurringbooleanIs quotation set to recurring
Example: false
No
recurringActivatedbooleanIs quotation recurring active
Example: false
No
reservedStockbooleanReserved stock enabled
Example: true
No
roundOffAmountInDocumentCurrencynumberRound Off Amount in Document Currency
Example: 0.3
No
sequenceFormatstringSequence Format Id
Example: 1
No
shipByDatedateTimeShip by date
Example: "25-10-2019"
No
shipFromAddressShip from Address.No
shipToAddressShip to Address.No
sourceAppNamestringSource App Name
Example: "BOOKS"
No
statusstringQuotation status
Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"
Example: "OPEN"
No
tenantIdlongTenant id
Example: 123
No
unitPriceGstInclusivebooleanUnit Price is GST inclusive
Example: true
No
validTillDatedateTimeValid till date
Example: "29-10-2019"
No
warehouseCodestringWarehouse Code
Example: "WH-000001"
No

QuotationDtoMalaysia

NameTypeDescriptionRequired
approvalStatusstringApproval status
Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"
Example: "APPROVED"
No
attachments[ string ]Attachments url'sNo
attachmentsWithLink[ AttachmentsResponse ]Attachments DetailsNo
backOrderbooleanBackorder flag to indicate if backorder created
Example: true
No
billToAddressBill to Address.No
contactContactInfoContact info
Example: "contact object"
No
contactCodestringContact code
Example: "C-0001"
Yes
contactDtoContactDtoContact DetailsYes
createdBylongUserId of creator
Example: 123
No
currencystringCurrency code
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
deletedbooleanQuotation deleted
Example: false
No
documentDatedateTimeDocument date
Example: "27-10-2019"
No
documentSequenceCodestringQuotation Code
Example: "0000001"
No
draftbooleanTrue if want to save as draft.
Example: false
No
errors[ string ]List of validation error messagesNo
exchangeRatedoubleExchange rate
Example: 0.01891562
No
fulfillmentDatedateTimeFulfillment date
Example: "28-10-2019"
No
fulfillmentOndateTimeFulfillment On
Example: "28-10-2019"
No
fulfillmentStatusstringFulfillment status
Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"
Example: "UNFULFILLED"
No
fulfillmentTypestringFulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP
_Enum:
"NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"
Example: "PICK_PACK_SHIP"
No
gstExchangeRatenumberGST 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
memostringMemo text
Example: "Sales quotation"
No
processedInPPSbooleanNo
quotationItemDtoList[ QuotationItemDtoMalaysia ]Quotation items informationNo
recurringbooleanIs quotation set to recurring
Example: false
No
recurringActivatedbooleanIs quotation recurring active
Example: false
No
reservedStockbooleanReserved stock enabled
Example: true
No
roundOffAmountInDocumentCurrencynumberRound Off Amount in Document Currency
Example: 0.3
No
sequenceFormatstringSequence Format Id
Example: 1
No
shipByDatedateTimeShip by date
Example: "25-10-2019"
No
shipFromAddressShip from Address.No
shipToAddressShip to Address.No
sourceAppNamestringSource App Name
Example: "BOOKS"
No
statusstringQuotation status
Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"
Example: "OPEN"
No
tenantIdlongTenant id
Example: 123
No
unitPriceGstInclusivebooleanUnit Price is GST inclusive
Example: true
No
validTillDatedateTimeValid till date
Example: "29-10-2019"
No
warehouseCodestringWarehouse Code
Example: "WH-000001"
No

QuotationDtoSaudiArabia

NameTypeDescriptionRequired
approvalStatusstringApproval status
Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"
Example: "APPROVED"
No
attachments[ string ]Attachments url'sNo
attachmentsWithLink[ AttachmentsResponse ]Attachments DetailsNo
backOrderbooleanBackorder flag to indicate if backorder created
Example: true
No
billToAddressBill to Address.No
contactContactInfoContact info
Example: "contact object"
No
contactCodestringContact code
Example: "C-0001"
Yes
contactDtoContactDtoContact DetailsYes
createdBylongUserId of creator
Example: 123
No
currencystringCurrency code
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
deletedbooleanQuotation deleted
Example: false
No
documentDatedateTimeDocument date
Example: "27-10-2019"
No
documentSequenceCodestringQuotation Code
Example: "0000001"
No
draftbooleanTrue if want to save as draft.
Example: false
No
errors[ string ]List of validation error messagesNo
exchangeRatedoubleExchange rate
Example: 0.01891562
No
fulfillmentDatedateTimeFulfillment date
Example: "28-10-2019"
No
fulfillmentOndateTimeFulfillment On
Example: "28-10-2019"
No
fulfillmentStatusstringFulfillment status
Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"
Example: "UNFULFILLED"
No
fulfillmentTypestringFulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP
_Enum:
"NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"
Example: "PICK_PACK_SHIP"
No
gstExchangeRatenumberGST 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
memostringMemo text
Example: "Sales quotation"
No
processedInPPSbooleanNo
quotationItemDtoList[ QuotationItemDtoSaudiArabia ]Quotation items informationNo
recurringbooleanIs quotation set to recurring
Example: false
No
recurringActivatedbooleanIs quotation recurring active
Example: false
No
reservedStockbooleanReserved stock enabled
Example: true
No
roundOffAmountInDocumentCurrencynumberRound Off Amount in Document Currency
Example: 0.3
No
sequenceFormatstringSequence Format Id
Example: 1
No
shipByDatedateTimeShip by date
Example: "25-10-2019"
No
shipFromAddressShip from Address.No
shipToAddressShip to Address.No
sourceAppNamestringSource App Name
Example: "BOOKS"
No
statusstringQuotation status
Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"
Example: "OPEN"
No
tenantIdlongTenant id
Example: 123
No
unitPriceGstInclusivebooleanUnit Price is GST inclusive
Example: true
No
validTillDatedateTimeValid till date
Example: "29-10-2019"
No
warehouseCodestringWarehouse Code
Example: "WH-000001"
No

QuotationDtoUAE

NameTypeDescriptionRequired
approvalStatusstringApproval status
Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"
Example: "APPROVED"
No
attachments[ string ]Attachments url'sNo
attachmentsWithLink[ AttachmentsResponse ]Attachments DetailsNo
backOrderbooleanBackorder flag to indicate if backorder created
Example: true
No
billToAddressBill to Address.No
contactContactInfoContact info
Example: "contact object"
No
contactCodestringContact code
Example: "C-0001"
Yes
contactDtoContactDtoContact DetailsYes
createdBylongUserId of creator
Example: 123
No
currencystringCurrency code
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
deletedbooleanQuotation deleted
Example: false
No
documentDatedateTimeDocument date
Example: "27-10-2019"
No
documentSequenceCodestringQuotation Code
Example: "0000001"
No
draftbooleanTrue if want to save as draft.
Example: false
No
errors[ string ]List of validation error messagesNo
exchangeRatedoubleExchange rate
Example: 0.01891562
No
fulfillmentDatedateTimeFulfillment date
Example: "28-10-2019"
No
fulfillmentOndateTimeFulfillment On
Example: "28-10-2019"
No
fulfillmentStatusstringFulfillment status
Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"
Example: "UNFULFILLED"
No
fulfillmentTypestringFulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP
_Enum:
"NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"
Example: "PICK_PACK_SHIP"
No
gstExchangeRatenumberGST 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
memostringMemo text
Example: "Sales quotation"
No
processedInPPSbooleanNo
quotationItemDtoList[ QuotationItemDtoUAE ]Quotation items informationNo
recurringbooleanIs quotation set to recurring
Example: false
No
recurringActivatedbooleanIs quotation recurring active
Example: false
No
reservedStockbooleanReserved stock enabled
Example: true
No
roundOffAmountInDocumentCurrencynumberRound Off Amount in Document Currency
Example: 0.3
No
sequenceFormatstringSequence Format Id
Example: 1
No
shipByDatedateTimeShip by date
Example: "25-10-2019"
No
shipFromAddressShip from Address.No
shipToAddressShip to Address.No
sourceAppNamestringSource App Name
Example: "BOOKS"
No
statusstringQuotation status
Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"
Example: "OPEN"
No
tenantIdlongTenant id
Example: 123
No
unitPriceGstInclusivebooleanUnit Price is GST inclusive
Example: true
No
validTillDatedateTimeValid till date
Example: "29-10-2019"
No
warehouseCodestringWarehouse Code
Example: "WH-000001"
No

QuotationDtoUk

NameTypeDescriptionRequired
approvalStatusstringApproval status
Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"
Example: "APPROVED"
No
attachments[ string ]Attachments url'sNo
attachmentsWithLink[ AttachmentsResponse ]Attachments DetailsNo
backOrderbooleanBackorder flag to indicate if backorder created
Example: true
No
billToAddressBill to Address.No
contactContactInfoContact info
Example: "contact object"
No
contactCodestringContact code
Example: "C-0001"
Yes
contactDtoContactDtoContact DetailsYes
createdBylongUserId of creator
Example: 123
No
currencystringCurrency code
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
deletedbooleanQuotation deleted
Example: false
No
documentDatedateTimeDocument date
Example: "27-10-2019"
No
documentSequenceCodestringQuotation Code
Example: "0000001"
No
draftbooleanTrue if want to save as draft.
Example: false
No
errors[ string ]List of validation error messagesNo
exchangeRatedoubleExchange rate
Example: 0.01891562
No
fulfillmentDatedateTimeFulfillment date
Example: "28-10-2019"
No
fulfillmentOndateTimeFulfillment On
Example: "28-10-2019"
No
fulfillmentStatusstringFulfillment status
Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"
Example: "UNFULFILLED"
No
fulfillmentTypestringFulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP
_Enum:
"NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"
Example: "PICK_PACK_SHIP"
No
gstExchangeRatenumberGST 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
memostringMemo text
Example: "Sales quotation"
No
processedInPPSbooleanNo
quotationItemDtoList[ QuotationItemDtoUk ]Quotation items informationNo
recurringbooleanIs quotation set to recurring
Example: false
No
recurringActivatedbooleanIs quotation recurring active
Example: false
No
reservedStockbooleanReserved stock enabled
Example: true
No
roundOffAmountInDocumentCurrencynumberRound Off Amount in Document Currency
Example: 0.3
No
sequenceFormatstringSequence Format Id
Example: 1
No
shipByDatedateTimeShip by date
Example: "25-10-2019"
No
shipFromAddressShip from Address.No
shipToAddressShip to Address.No
sourceAppNamestringSource App Name
Example: "BOOKS"
No
statusstringQuotation status
Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"
Example: "OPEN"
No
tenantIdlongTenant id
Example: 123
No
unitPriceGstInclusivebooleanUnit Price is GST inclusive
Example: true
No
validTillDatedateTimeValid till date
Example: "29-10-2019"
No
warehouseCodestringWarehouse Code
Example: "WH-000001"
No

QuotationIndiaDto

NameTypeDescriptionRequired
additionalChargesAdditionalChargesNo
approvalStatusstringApproval status
Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"
Example: "APPROVED"
No
attachments[ string ]Attachments url'sNo
attachmentsWithLink[ AttachmentsResponse ]Attachments DetailsNo
backOrderbooleanBackorder flag to indicate if backorder created
Example: true
No
billToAddressBill to Address.No
contactContactInfoContact info
Example: "contact object"
No
contactCodestringContact code
Example: "C-0001"
Yes
contactDtoContactDtoContact DetailsYes
createdBylongUserId of creator
Example: 123
No
currencystringCurrency code
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
customerTypestringCustomer Type
Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"
Example: "NA"
Yes
deletedbooleanQuotation deleted
Example: false
No
documentDatedateTimeDocument date
Example: "27-10-2019"
No
documentSequenceCodestringQuotation Code
Example: "0000001"
No
draftbooleanTrue if want to save as draft.
Example: false
No
errors[ string ]List of validation error messagesNo
exchangeRatedoubleExchange rate
Example: 0.01891562
No
fulfillmentDatedateTimeFulfillment date
Example: "28-10-2019"
No
fulfillmentOndateTimeFulfillment On
Example: "28-10-2019"
No
fulfillmentStatusstringFulfillment status
Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"
Example: "UNFULFILLED"
No
fulfillmentTypestringFulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP
_Enum:
"NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"
Example: "PICK_PACK_SHIP"
No
gstExchangeRatenumberGST Exchange rate if tax residency currency is different than base currency
Example: 1
No
gstTreatmentstringGST 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
gstinstringIndian state from where the good/service is shipped
Example: "22AAAAAA00000AA21"
No
linkedDocuments[ DocumentInfo ]Linked document information.No
linkedSalesInvoices[ LinkedSalesInvoiceResponse ]No
linkedSalesOrders[ LinkedSalesOrderResponse ]No
memostringMemo text
Example: "Sales quotation"
No
placeOfSupplystringIndian state from where the good/service is shipped
Example: "Delhi"
No
processedInPPSbooleanNo
quotationItemDtoList[ QuotationItemIndiaDto ]Quotation items informationNo
recurringbooleanIs quotation set to recurring
Example: false
No
recurringActivatedbooleanIs quotation recurring active
Example: false
No
reservedStockbooleanReserved stock enabled
Example: true
No
roundOffAmountInDocumentCurrencynumberRound Off Amount in Document Currency
Example: 0.3
No
sequenceFormatstringSequence Format Id
Example: 1
No
shipByDatedateTimeShip by date
Example: "25-10-2019"
No
shipFromAddressShip from Address.No
shipToAddressShip to Address.No
sourceAppNamestringSource App Name
Example: "BOOKS"
No
statusstringQuotation status
Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"
Example: "OPEN"
No
tcsAmountnumberNo
tcsAmountInBaseCurrencynumberNo
tcsPercentagenumberNo
tcsRateIdlongNo
tenantIdlongTenant id
Example: 123
No
unitPriceGstInclusivebooleanUnit Price is GST inclusive
Example: true
No
validTillDatedateTimeValid till date
Example: "29-10-2019"
No
vendorTypestringVendor Type
Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"
Example: "NA"
Yes
warehouseCodestringWarehouse Code
Example: "WH-000001"
No

QuotationInformation

NameTypeDescriptionRequired
additionalChargesAdditionalChargesPurchase invoice additional charges detailsNo
attachments[ string ]Attachments url'sNo
backOrderbooleanBackorder flag to indicate if backorder created
Example: true
No
billToAddressBill to Address.No
contactContactInfoContact info
Example: "contact object"
No
contactCodestringContact code
Example: "C-0001"
Yes
contactDtoContactInformationContact DetailsYes
currencystringCurrency code
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
customerTypestringCustomer Type
Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"
Example: "NA"
Yes
deletedbooleanQuotation deleted
Example: false
No
documentDatestringDocument date
Example: "27-10-2019"
No
documentSequenceCodestringQuotation Code
Example: "0000001"
No
draftbooleanTrue if want to save as draft.
Example: false
No
exchangeRatedoubleExchange rate
Example: 0.01891562
No
fulfillmentDatestringFulfillment date
Example: "28-10-2019"
No
fulfillmentOnstringFulfillment On
Example: "28-10-2019"
No
fulfillmentStatusstringFulfillment status
Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"
Example: "UNFULFILLED"
No
fulfillmentTypestringFulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP
_Enum:
"NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"
Example: "PICK_PACK_SHIP"
No
gstExchangeRatenumberGST Exchange rate if tax residency currency is different than base currency
Example: 1
No
gstinstringIndian state from where the good/service is shipped
Example: "22AAAAAA00000AA21"
No
hasPartialInvoicebooleanHas Partial Invoice linked to quotation
Example: false
Yes
hasPartialSalesOrderbooleanHas Partial Sales Order linked to quotation
Example: false
Yes
linkedDocuments[ DocumentInfo ]Linked document information.No
linkedSalesInvoices[ LinkedSalesInvoiceResponse ]List of Linked Sales InvoicesNo
linkedSalesOrders[ LinkedSalesOrderResponse ]List of Linked Sales InvoicesNo
memostringMemo text
Example: "Sales quotation"
No
placeOfSupplystringIndian state from where the good/service is shipped
Example: "Delhi"
No
processedInPPSbooleanNo
quotationItemDtoList[ QuotationItemInformation ]Quotation items informationNo
recurringbooleanIs quotation set to recurring
Example: false
No
recurringActivatedbooleanIs quotation recurring active
Example: false
No
reservedStockbooleanIs quotation has reserved quantity
Example: false
No
roundOffAmountInDocumentCurrencynumberRound Off Amount in Document Currency
Example: 0.3
No
sequenceFormatstringSequence Format Id
Example: 1
No
shipByDatestringShip by date
Example: "25-10-2019"
No
shipFromAddressShip from Address.No
shipToAddressShip to Address.No
statusstringQuotation status
Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"
Example: "OPEN"
No
tcsAmountnumberNo
tcsAmountInBaseCurrencynumberNo
tcsPercentagenumberNo
tcsRateIdlongNo
tenantIdlongTenant id
Example: 123
No
unitPriceGstInclusivebooleanUnit Price is GST inclusive
Example: true
No
validTillDatestringValid till date
Example: "29-10-2019"
No
vendorTypestringVendor Type
Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"
Example: "NA"
Yes
warehouseCodestringWarehouse Code
Example: "WH-000001"
No

QuotationIsraelDto

NameTypeDescriptionRequired
approvalStatusstringApproval status
Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"
Example: "APPROVED"
No
attachments[ string ]Attachments url'sNo
attachmentsWithLink[ AttachmentsResponse ]Attachments DetailsNo
backOrderbooleanBackorder flag to indicate if backorder created
Example: true
No
billToAddressBill to Address.No
contactContactInfoContact info
Example: "contact object"
No
contactCodestringContact code
Example: "C-0001"
Yes
contactDtoContactDtoContact DetailsYes
createdBylongUserId of creator
Example: 123
No
currencystringCurrency code
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
deletedbooleanQuotation deleted
Example: false
No
documentDatedateTimeDocument date
Example: "27-10-2019"
No
documentSequenceCodestringQuotation Code
Example: "0000001"
No
draftbooleanTrue if want to save as draft.
Example: false
No
errors[ string ]List of validation error messagesNo
exchangeRatedoubleExchange rate
Example: 0.01891562
No
fulfillmentDatedateTimeFulfillment date
Example: "28-10-2019"
No
fulfillmentOndateTimeFulfillment On
Example: "28-10-2019"
No
fulfillmentStatusstringFulfillment status
Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"
Example: "UNFULFILLED"
No
fulfillmentTypestringFulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP
_Enum:
"NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"
Example: "PICK_PACK_SHIP"
No
gstExchangeRatenumberGST 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
memostringMemo text
Example: "Sales quotation"
No
processedInPPSbooleanNo
quotationItemDtoList[ QuotationItemIsraelDto ]Quotation items informationNo
recurringbooleanIs quotation set to recurring
Example: false
No
recurringActivatedbooleanIs quotation recurring active
Example: false
No
reservedStockbooleanReserved stock enabled
Example: true
No
roundOffAmountInDocumentCurrencynumberRound Off Amount in Document Currency
Example: 0.3
No
sequenceFormatstringSequence Format Id
Example: 1
No
shipByDatedateTimeShip by date
Example: "25-10-2019"
No
shipFromAddressShip from Address.No
shipToAddressShip to Address.No
sourceAppNamestringSource App Name
Example: "BOOKS"
No
statusstringQuotation status
Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"
Example: "OPEN"
No
tenantIdlongTenant id
Example: 123
No
unitPriceGstInclusivebooleanUnit Price is GST inclusive
Example: true
No
validTillDatedateTimeValid till date
Example: "29-10-2019"
No
warehouseCodestringWarehouse Code
Example: "WH-000001"
No

QuotationItemDto

NameTypeDescriptionRequired
advancedTrackingTypestringAdvanced Tracking Type
Enum: "NONE", "BATCH", "SERIAL"
No
allocationTypestringAllocation Type
Example: "NORMAL"
No
availableQuantitynumberTotal available quantity
Example: 3
No
basePricenumberRevenue Base price
Example: 120
No
customField[ CustomFieldItem ]List of custom fieldsNo
discountnumberProduct discount
Example: 2
No
discountInPercentbooleanDiscount in percentage
Example: true
No
documentSequenceCodestringProduct Document Sequence Code
Example: "P-0000001"
Yes
documentUOMSchemaDefinitionDocumentUOMSchemaDefinitionDocument UOM Schema Definition
Example: 2
Yes
documentUomlongDocument UOM id
Example: 2
Yes
fulfilledQuantitynumberTotal Fulfilled Quantity
Example: 3
No
fulfilledQuantityByFlowovernumberTotal Fulfilled Quantity By Flowover
Example: 3
No
fulfilledQuantityByUsernumberTotal Fulfilled Quantity By User
Example: 3
No
fulfilledQuantityInvoicednumberTotal Fulfilled Quantity Invoiced
Example: 3
No
fulfillmentByDoc[ ItemQtyFulfilledByDoc ]Item Qty fulfilled by Fulfillment Doc
Example: []
No
lineNumberintegerLine Number
Example: 1
No
otherRatenumberTax Rate
Example: 5
No
otherTaxAmountnumberOther Tax Amount
Example: 10
No
pendingQuantitynumberPending Quantity
Example: 3
No
productProductResponseProduct Short Info
Example: "product"
No
productCodestringProduct code
Example: "PC-001"
Yes
productDescriptionstringProduct description
Example: "Red pen"
No
productNamestringProduct name
Example: "Ball pen"
No
productOrderintegerProduct order
Example: 1
No
productQuantitynumberProduct quantity
Example: 2.5
Yes
reservedQuantitiesData[ ReservedQuantityData ]Reserved quantity data
Example: []
No
taxTaxDtoTax details
Example: "taxDto"
No
taxAmountnumberTax amount
Example: 0.3
No
taxCodestringTax code
Example: "TX-003"
No
taxNamestringTax name
Example: "GST(7%)"
No
typestringProduct type
Enum: "TRACKED", "NONTRACKED"
Example: "TRACKED"
Yes
unitPricenumberProduct price
Example: 10
No
uomQuantitynumberuom quantity
Example: 2
Yes
uomUnitPricenumberUOM Unit price
Example: 2.3
Yes

QuotationItemDtoAustralia

NameTypeDescriptionRequired
advancedTrackingTypestringAdvanced Tracking Type
Enum: "NONE", "BATCH", "SERIAL"
No
allocationTypestringAllocation Type
Example: "NORMAL"
No
availableQuantitynumberTotal available quantity
Example: 3
No
basePricenumberRevenue Base price
Example: 120
No
customField[ CustomFieldItem ]List of custom fieldsNo
discountnumberProduct discount
Example: 2
No
discountInPercentbooleanDiscount in percentage
Example: true
No
documentSequenceCodestringProduct Document Sequence Code
Example: "P-0000001"
Yes
documentUOMSchemaDefinitionDocumentUOMSchemaDefinitionDocument UOM Schema Definition
Example: 2
Yes
documentUomlongDocument UOM id
Example: 2
Yes
fulfilledQuantitynumberTotal Fulfilled Quantity
Example: 3
No
fulfilledQuantityByFlowovernumberTotal Fulfilled Quantity By Flowover
Example: 3
No
fulfilledQuantityByUsernumberTotal Fulfilled Quantity By User
Example: 3
No
fulfilledQuantityInvoicednumberTotal Fulfilled Quantity Invoiced
Example: 3
No
fulfillmentByDoc[ ItemQtyFulfilledByDoc ]Item Qty fulfilled by Fulfillment Doc
Example: []
No
lineNumberintegerLine Number
Example: 1
No
otherRatenumberTax Rate
Example: 5
No
otherTaxAmountnumberOther Tax Amount
Example: 10
No
pendingQuantitynumberPending Quantity
Example: 3
No
productProductResponseProduct Short Info
Example: "product"
No
productCodestringProduct code
Example: "PC-001"
Yes
productDescriptionstringProduct description
Example: "Red pen"
No
productNamestringProduct name
Example: "Ball pen"
No
productOrderintegerProduct order
Example: 1
No
productQuantitynumberProduct quantity
Example: 2.5
Yes
reservedQuantitiesData[ ReservedQuantityData ]Reserved quantity data
Example: []
No
taxTaxDtoTax details
Example: "taxDto"
No
taxAmountnumberTax amount
Example: 0.3
No
taxCodestringTax code
Example: "TX-003"
No
taxNamestringTax name
Example: "GST(7%)"
No
typestringProduct type
Enum: "TRACKED", "NONTRACKED"
Example: "TRACKED"
Yes
unitPricenumberProduct price
Example: 10
No
uomQuantitynumberuom quantity
Example: 2
Yes
uomUnitPricenumberUOM Unit price
Example: 2.3
Yes

QuotationItemDtoCanada

NameTypeDescriptionRequired
advancedTrackingTypestringAdvanced Tracking Type
Enum: "NONE", "BATCH", "SERIAL"
No
allocationTypestringAllocation Type
Example: "NORMAL"
No
availableQuantitynumberTotal available quantity
Example: 3
No
basePricenumberRevenue Base price
Example: 120
No
customField[ CustomFieldItem ]List of custom fieldsNo
discountnumberProduct discount
Example: 2
No
discountInPercentbooleanDiscount in percentage
Example: true
No
documentSequenceCodestringProduct Document Sequence Code
Example: "P-0000001"
Yes
documentUOMSchemaDefinitionDocumentUOMSchemaDefinitionDocument UOM Schema Definition
Example: 2
Yes
documentUomlongDocument UOM id
Example: 2
Yes
fulfilledQuantitynumberTotal Fulfilled Quantity
Example: 3
No
fulfilledQuantityByFlowovernumberTotal Fulfilled Quantity By Flowover
Example: 3
No
fulfilledQuantityByUsernumberTotal Fulfilled Quantity By User
Example: 3
No
fulfilledQuantityInvoicednumberTotal Fulfilled Quantity Invoiced
Example: 3
No
fulfillmentByDoc[ ItemQtyFulfilledByDoc ]Item Qty fulfilled by Fulfillment Doc
Example: []
No
lineNumberintegerLine Number
Example: 1
No
otherRatenumberTax Rate
Example: 5
No
otherTaxAmountnumberOther Tax Amount
Example: 10
No
pendingQuantitynumberPending Quantity
Example: 3
No
productProductResponseProduct Short Info
Example: "product"
No
productCodestringProduct code
Example: "PC-001"
Yes
productDescriptionstringProduct description
Example: "Red pen"
No
productNamestringProduct name
Example: "Ball pen"
No
productOrderintegerProduct order
Example: 1
No
productQuantitynumberProduct quantity
Example: 2.5
Yes
reservedQuantitiesData[ ReservedQuantityData ]Reserved quantity data
Example: []
No
taxTaxDtoTax details
Example: "taxDto"
No
taxAmountnumberTax amount
Example: 0.3
No
taxCodestringTax code
Example: "TX-003"
No
taxNamestringTax name
Example: "GST(7%)"
No
typestringProduct type
Enum: "TRACKED", "NONTRACKED"
Example: "TRACKED"
Yes
unitPricenumberProduct price
Example: 10
No
uomQuantitynumberuom quantity
Example: 2
Yes
uomUnitPricenumberUOM Unit price
Example: 2.3
Yes

QuotationItemDtoDE

NameTypeDescriptionRequired
advancedTrackingTypestringAdvanced Tracking Type
Enum: "NONE", "BATCH", "SERIAL"
No
allocationTypestringAllocation Type
Example: "NORMAL"
No
availableQuantitynumberTotal available quantity
Example: 3
No
basePricenumberRevenue Base price
Example: 120
No
customField[ CustomFieldItem ]List of custom fieldsNo
discountnumberProduct discount
Example: 2
No
discountInPercentbooleanDiscount in percentage
Example: true
No
documentSequenceCodestringProduct Document Sequence Code
Example: "P-0000001"
Yes
documentUOMSchemaDefinitionDocumentUOMSchemaDefinitionDocument UOM Schema Definition
Example: 2
Yes
documentUomlongDocument UOM id
Example: 2
Yes
fulfilledQuantitynumberTotal Fulfilled Quantity
Example: 3
No
fulfilledQuantityByFlowovernumberTotal Fulfilled Quantity By Flowover
Example: 3
No
fulfilledQuantityByUsernumberTotal Fulfilled Quantity By User
Example: 3
No
fulfilledQuantityInvoicednumberTotal Fulfilled Quantity Invoiced
Example: 3
No
fulfillmentByDoc[ ItemQtyFulfilledByDoc ]Item Qty fulfilled by Fulfillment Doc
Example: []
No
lineNumberintegerLine Number
Example: 1
No
otherRatenumberTax Rate
Example: 5
No
otherTaxAmountnumberOther Tax Amount
Example: 10
No
pendingQuantitynumberPending Quantity
Example: 3
No
productProductResponseProduct Short Info
Example: "product"
No
productCodestringProduct code
Example: "PC-001"
Yes
productDescriptionstringProduct description
Example: "Red pen"
No
productNamestringProduct name
Example: "Ball pen"
No
productOrderintegerProduct order
Example: 1
No
productQuantitynumberProduct quantity
Example: 2.5
Yes
reservedQuantitiesData[ ReservedQuantityData ]Reserved quantity data
Example: []
No
taxTaxDtoTax details
Example: "taxDto"
No
taxAmountnumberTax amount
Example: 0.3
No
taxCodestringTax code
Example: "TX-003"
No
taxNamestringTax name
Example: "GST(7%)"
No
typestringProduct type
Enum: "TRACKED", "NONTRACKED"
Example: "TRACKED"
Yes
unitPricenumberProduct price
Example: 10
No
uomQuantitynumberuom quantity
Example: 2
Yes
uomUnitPricenumberUOM Unit price
Example: 2.3
Yes

QuotationItemDtoIndonesia

NameTypeDescriptionRequired
advancedTrackingTypestringAdvanced Tracking Type
Enum: "NONE", "BATCH", "SERIAL"
No
allocationTypestringAllocation Type
Example: "NORMAL"
No
availableQuantitynumberTotal available quantity
Example: 3
No
basePricenumberRevenue Base price
Example: 120
No
customField[ CustomFieldItem ]List of custom fieldsNo
discountnumberProduct discount
Example: 2
No
discountInPercentbooleanDiscount in percentage
Example: true
No
documentSequenceCodestringProduct Document Sequence Code
Example: "P-0000001"
Yes
documentUOMSchemaDefinitionDocumentUOMSchemaDefinitionDocument UOM Schema Definition
Example: 2
Yes
documentUomlongDocument UOM id
Example: 2
Yes
exciseAmountnumberExcise amount on product
Example: 0.5
No
exciseRatenumberRate of Excise
Example: 5
No
exciseTypestringExcise type
Enum: "PERCENT", "FLAT"
Example: "FLAT"
No
fulfilledQuantitynumberTotal Fulfilled Quantity
Example: 3
No
fulfilledQuantityByFlowovernumberTotal Fulfilled Quantity By Flowover
Example: 3
No
fulfilledQuantityByUsernumberTotal Fulfilled Quantity By User
Example: 3
No
fulfilledQuantityInvoicednumberTotal Fulfilled Quantity Invoiced
Example: 3
No
fulfillmentByDoc[ ItemQtyFulfilledByDoc ]Item Qty fulfilled by Fulfillment Doc
Example: []
No
lineNumberintegerLine Number
Example: 1
No
otherRatenumberTax Rate
Example: 5
No
otherTaxAmountnumberOther Tax Amount
Example: 10
No
pendingQuantitynumberPending Quantity
Example: 3
No
productProductResponseProduct Short Info
Example: "product"
No
productCodestringProduct code
Example: "PC-001"
Yes
productDescriptionstringProduct description
Example: "Red pen"
No
productNamestringProduct name
Example: "Ball pen"
No
productOrderintegerProduct order
Example: 1
No
productQuantitynumberProduct quantity
Example: 2.5
Yes
reservedQuantitiesData[ ReservedQuantityData ]Reserved quantity data
Example: []
No
taxTaxDtoTax details
Example: "taxDto"
No
taxAmountnumberTax amount
Example: 0.3
No
taxCodestringTax code
Example: "TX-003"
No
taxNamestringTax name
Example: "GST(7%)"
No
typestringProduct type
Enum: "TRACKED", "NONTRACKED"
Example: "TRACKED"
Yes
unitPricenumberProduct price
Example: 10
No
uomQuantitynumberuom quantity
Example: 2
Yes
uomUnitPricenumberUOM Unit price
Example: 2.3
Yes

QuotationItemDtoMalaysia

NameTypeDescriptionRequired
advancedTrackingTypestringAdvanced Tracking Type
Enum: "NONE", "BATCH", "SERIAL"
No
allocationTypestringAllocation Type
Example: "NORMAL"
No
availableQuantitynumberTotal available quantity
Example: 3
No
basePricenumberRevenue Base price
Example: 120
No
customField[ CustomFieldItem ]List of custom fieldsNo
discountnumberProduct discount
Example: 2
No
discountInPercentbooleanDiscount in percentage
Example: true
No
documentSequenceCodestringProduct Document Sequence Code
Example: "P-0000001"
Yes
documentUOMSchemaDefinitionDocumentUOMSchemaDefinitionDocument UOM Schema Definition
Example: 2
Yes
documentUomlongDocument UOM id
Example: 2
Yes
fulfilledQuantitynumberTotal Fulfilled Quantity
Example: 3
No
fulfilledQuantityByFlowovernumberTotal Fulfilled Quantity By Flowover
Example: 3
No
fulfilledQuantityByUsernumberTotal Fulfilled Quantity By User
Example: 3
No
fulfilledQuantityInvoicednumberTotal Fulfilled Quantity Invoiced
Example: 3
No
fulfillmentByDoc[ ItemQtyFulfilledByDoc ]Item Qty fulfilled by Fulfillment Doc
Example: []
No
lineNumberintegerLine Number
Example: 1
No
otherRatenumberTax Rate
Example: 5
No
otherTaxAmountnumberOther Tax Amount
Example: 10
No
pendingQuantitynumberPending Quantity
Example: 3
No
productProductResponseProduct Short Info
Example: "product"
No
productCodestringProduct code
Example: "PC-001"
Yes
productDescriptionstringProduct description
Example: "Red pen"
No
productNamestringProduct name
Example: "Ball pen"
No
productOrderintegerProduct order
Example: 1
No
productQuantitynumberProduct quantity
Example: 2.5
Yes
reservedQuantitiesData[ ReservedQuantityData ]Reserved quantity data
Example: []
No
taxTaxDtoTax details
Example: "taxDto"
No
taxAmountnumberTax amount
Example: 0.3
No
taxCodestringTax code
Example: "TX-003"
No
taxNamestringTax name
Example: "GST(7%)"
No
typestringProduct type
Enum: "TRACKED", "NONTRACKED"
Example: "TRACKED"
Yes
unitPricenumberProduct price
Example: 10
No
uomQuantitynumberuom quantity
Example: 2
Yes
uomUnitPricenumberUOM Unit price
Example: 2.3
Yes

QuotationItemDtoSaudiArabia

NameTypeDescriptionRequired
advancedTrackingTypestringAdvanced Tracking Type
Enum: "NONE", "BATCH", "SERIAL"
No
allocationTypestringAllocation Type
Example: "NORMAL"
No
availableQuantitynumberTotal available quantity
Example: 3
No
basePricenumberRevenue Base price
Example: 120
No
customField[ CustomFieldItem ]List of custom fieldsNo
discountnumberProduct discount
Example: 2
No
discountInPercentbooleanDiscount in percentage
Example: true
No
documentSequenceCodestringProduct Document Sequence Code
Example: "P-0000001"
Yes
documentUOMSchemaDefinitionDocumentUOMSchemaDefinitionDocument UOM Schema Definition
Example: 2
Yes
documentUomlongDocument UOM id
Example: 2
Yes
exciseAmountnumberExcise amount on product
Example: 0.5
No
exciseRatenumberRate of Excise
Example: 5
No
exciseTypestringExcise type
Enum: "PERCENT", "FLAT"
Example: "FLAT"
No
fulfilledQuantitynumberTotal Fulfilled Quantity
Example: 3
No
fulfilledQuantityByFlowovernumberTotal Fulfilled Quantity By Flowover
Example: 3
No
fulfilledQuantityByUsernumberTotal Fulfilled Quantity By User
Example: 3
No
fulfilledQuantityInvoicednumberTotal Fulfilled Quantity Invoiced
Example: 3
No
fulfillmentByDoc[ ItemQtyFulfilledByDoc ]Item Qty fulfilled by Fulfillment Doc
Example: []
No
lineNumberintegerLine Number
Example: 1
No
otherRatenumberTax Rate
Example: 5
No
otherTaxAmountnumberOther Tax Amount
Example: 10
No
pendingQuantitynumberPending Quantity
Example: 3
No
productProductResponseProduct Short Info
Example: "product"
No
productCodestringProduct code
Example: "PC-001"
Yes
productDescriptionstringProduct description
Example: "Red pen"
No
productNamestringProduct name
Example: "Ball pen"
No
productOrderintegerProduct order
Example: 1
No
productQuantitynumberProduct quantity
Example: 2.5
Yes
reservedQuantitiesData[ ReservedQuantityData ]Reserved quantity data
Example: []
No
taxTaxDtoTax details
Example: "taxDto"
No
taxAmountnumberTax amount
Example: 0.3
No
taxCodestringTax code
Example: "TX-003"
No
taxNamestringTax name
Example: "GST(7%)"
No
typestringProduct type
Enum: "TRACKED", "NONTRACKED"
Example: "TRACKED"
Yes
unitPricenumberProduct price
Example: 10
No
uomQuantitynumberuom quantity
Example: 2
Yes
uomUnitPricenumberUOM Unit price
Example: 2.3
Yes

QuotationItemDtoUAE

NameTypeDescriptionRequired
advancedTrackingTypestringAdvanced Tracking Type
Enum: "NONE", "BATCH", "SERIAL"
No
allocationTypestringAllocation Type
Example: "NORMAL"
No
availableQuantitynumberTotal available quantity
Example: 3
No
basePricenumberRevenue Base price
Example: 120
No
customField[ CustomFieldItem ]List of custom fieldsNo
discountnumberProduct discount
Example: 2
No
discountInPercentbooleanDiscount in percentage
Example: true
No
documentSequenceCodestringProduct Document Sequence Code
Example: "P-0000001"
Yes
documentUOMSchemaDefinitionDocumentUOMSchemaDefinitionDocument UOM Schema Definition
Example: 2
Yes
documentUomlongDocument UOM id
Example: 2
Yes
exciseAmountnumberExcise amount on product
Example: 0.5
No
exciseRatenumberRate of Excise
Example: 5
No
exciseTypestringExcise type
Enum: "PERCENT", "FLAT"
Example: "FLAT"
No
fulfilledQuantitynumberTotal Fulfilled Quantity
Example: 3
No
fulfilledQuantityByFlowovernumberTotal Fulfilled Quantity By Flowover
Example: 3
No
fulfilledQuantityByUsernumberTotal Fulfilled Quantity By User
Example: 3
No
fulfilledQuantityInvoicednumberTotal Fulfilled Quantity Invoiced
Example: 3
No
fulfillmentByDoc[ ItemQtyFulfilledByDoc ]Item Qty fulfilled by Fulfillment Doc
Example: []
No
lineNumberintegerLine Number
Example: 1
No
otherRatenumberTax Rate
Example: 5
No
otherTaxAmountnumberOther Tax Amount
Example: 10
No
pendingQuantitynumberPending Quantity
Example: 3
No
productProductResponseProduct Short Info
Example: "product"
No
productCodestringProduct code
Example: "PC-001"
Yes
productDescriptionstringProduct description
Example: "Red pen"
No
productNamestringProduct name
Example: "Ball pen"
No
productOrderintegerProduct order
Example: 1
No
productQuantitynumberProduct quantity
Example: 2.5
Yes
reservedQuantitiesData[ ReservedQuantityData ]Reserved quantity data
Example: []
No
taxTaxDtoTax details
Example: "taxDto"
No
taxAmountnumberTax amount
Example: 0.3
No
taxCodestringTax code
Example: "TX-003"
No
taxNamestringTax name
Example: "GST(7%)"
No
typestringProduct type
Enum: "TRACKED", "NONTRACKED"
Example: "TRACKED"
Yes
unitPricenumberProduct price
Example: 10
No
uomQuantitynumberuom quantity
Example: 2
Yes
uomUnitPricenumberUOM Unit price
Example: 2.3
Yes

QuotationItemDtoUk

NameTypeDescriptionRequired
advancedTrackingTypestringAdvanced Tracking Type
Enum: "NONE", "BATCH", "SERIAL"
No
allocationTypestringAllocation Type
Example: "NORMAL"
No
availableQuantitynumberTotal available quantity
Example: 3
No
basePricenumberRevenue Base price
Example: 120
No
customField[ CustomFieldItem ]List of custom fieldsNo
discountnumberProduct discount
Example: 2
No
discountInPercentbooleanDiscount in percentage
Example: true
No
documentSequenceCodestringProduct Document Sequence Code
Example: "P-0000001"
Yes
documentUOMSchemaDefinitionDocumentUOMSchemaDefinitionDocument UOM Schema Definition
Example: 2
Yes
documentUomlongDocument UOM id
Example: 2
Yes
fulfilledQuantitynumberTotal Fulfilled Quantity
Example: 3
No
fulfilledQuantityByFlowovernumberTotal Fulfilled Quantity By Flowover
Example: 3
No
fulfilledQuantityByUsernumberTotal Fulfilled Quantity By User
Example: 3
No
fulfilledQuantityInvoicednumberTotal Fulfilled Quantity Invoiced
Example: 3
No
fulfillmentByDoc[ ItemQtyFulfilledByDoc ]Item Qty fulfilled by Fulfillment Doc
Example: []
No
lineNumberintegerLine Number
Example: 1
No
otherRatenumberTax Rate
Example: 5
No
otherTaxAmountnumberOther Tax Amount
Example: 10
No
pendingQuantitynumberPending Quantity
Example: 3
No
productProductResponseProduct Short Info
Example: "product"
No
productCodestringProduct code
Example: "PC-001"
Yes
productDescriptionstringProduct description
Example: "Red pen"
No
productNamestringProduct name
Example: "Ball pen"
No
productOrderintegerProduct order
Example: 1
No
productQuantitynumberProduct quantity
Example: 2.5
Yes
reservedQuantitiesData[ ReservedQuantityData ]Reserved quantity data
Example: []
No
taxTaxDtoTax details
Example: "taxDto"
No
taxAmountnumberTax amount
Example: 0.3
No
taxCodestringTax code
Example: "TX-003"
No
taxNamestringTax name
Example: "GST(7%)"
No
typestringProduct type
Enum: "TRACKED", "NONTRACKED"
Example: "TRACKED"
Yes
unitPricenumberProduct price
Example: 10
No
uomQuantitynumberuom quantity
Example: 2
Yes
uomUnitPricenumberUOM Unit price
Example: 2.3
Yes

QuotationItemIndiaDto

NameTypeDescriptionRequired
advancedTrackingTypestringAdvanced Tracking Type
Enum: "NONE", "BATCH", "SERIAL"
No
allocationTypestringAllocation Type
Example: "NORMAL"
No
availableQuantitynumberTotal available quantity
Example: 3
No
basePricenumberRevenue Base price
Example: 120
No
cessAmountnumberIndia specific CESS amount on total amount
Example: 0
No
cessPercentagenumberCess Percentage
Example: 2.322
No
cessRulestringCess Rule if it applies to the item
Example: "Math.max(21*amount/100,4170*quantity/100)"
No
cgstAmountnumberIndia specific CGST tax amount on total amount
Example: 5
No
cgstRatenumberIndia specific CGST rate
Example: 5
No
customField[ CustomFieldItem ]List of custom fieldsNo
discountnumberProduct discount
Example: 2
No
discountInPercentbooleanDiscount in percentage
Example: true
No
documentSequenceCodestringProduct Document Sequence Code
Example: "P-0000001"
Yes
documentUOMSchemaDefinitionDocumentUOMSchemaDefinitionDocument UOM Schema Definition
Example: 2
Yes
documentUomlongDocument UOM id
Example: 2
Yes
fulfilledQuantitynumberTotal Fulfilled Quantity
Example: 3
No
fulfilledQuantityByFlowovernumberTotal Fulfilled Quantity By Flowover
Example: 3
No
fulfilledQuantityByUsernumberTotal Fulfilled Quantity By User
Example: 3
No
fulfilledQuantityInvoicednumberTotal Fulfilled Quantity Invoiced
Example: 3
No
fulfillmentByDoc[ ItemQtyFulfilledByDoc ]Item Qty fulfilled by Fulfillment Doc
Example: []
No
hsnOrSacCodestringHsn or Sac code
Example: 110011
No
igstAmountnumberIndia specific IGST tax amount on total amount
Example: 5
No
igstRatenumberIndia specific IGST rate
Example: 5
No
lineNumberintegerLine Number
Example: 1
No
otherRatenumberTax Rate
Example: 5
No
otherTaxAmountnumberOther Tax Amount
Example: 10
No
pendingQuantitynumberPending Quantity
Example: 3
No
productProductResponseProduct Short Info
Example: "product"
No
productCodestringProduct code
Example: "PC-001"
Yes
productDescriptionstringProduct description
Example: "Red pen"
No
productNamestringProduct name
Example: "Ball pen"
No
productOrderintegerProduct order
Example: 1
No
productQuantitynumberProduct quantity
Example: 2.5
Yes
reservedQuantitiesData[ ReservedQuantityData ]Reserved quantity data
Example: []
No
sgstAmountnumberIndia specific SGST tax amount on total amount
Example: 5
No
sgstRatenumberIndia specific SGST rate
Example: 5
No
taxTaxDtoTax details
Example: "taxDto"
No
taxAmountnumberTax amount
Example: 0.3
No
taxCodestringTax code
Example: "TX-003"
No
taxExemptionReasonstringTax Exemption reason if taxPreference is true
Enum: "EXEMPTED", "NON_GST"
Example: "EXEMPTED"
No
taxNamestringTax name
Example: "GST(7%)"
No
taxPreferencebooleanTax preference, whether Exempted or not Exempted
Example: false
No
typestringProduct type
Enum: "TRACKED", "NONTRACKED"
Example: "TRACKED"
Yes
unitPricenumberProduct price
Example: 10
No
uomQuantitynumberuom quantity
Example: 2
Yes
uomUnitPricenumberUOM Unit price
Example: 2.3
Yes
userSetTaxesbooleanFlag to check whether tax is user edited
Example: false
No

QuotationItemInformation

NameTypeDescriptionRequired
allocationTypestringAllocation Type
Example: "NORMAL"
No
availableQuantitynumberTotal available quantity
Example: 3
No
basePricenumberRevenue Base price
Example: 120
No
cessAmountnumberIndia specific CESS amount on total amount
Example: 0
No
cessPercentagenumberCess Percentage
Example: 2.322
No
cessRulestringCess Rule if it applies to the item
Example: "Math.max(21*amount/100,4170*quantity/100)"
No
cgstAmountnumberIndia specific CGST tax amount on total amount
Example: 5
No
cgstRatenumberIndia specific CGST rate
Example: 5
No
customField[ CustomFieldItem ]List of custom fieldsNo
discountnumberProduct discount
Example: 2
No
discountInPercentbooleanDiscount in percentage
Example: true
No
documentSequenceCodestringProduct Document Sequence Code
Example: "P-0000001"
Yes
documentUOMSchemaDefinitionDocumentUOMSchemaDefinitionDocument UOM Schema Definition
Example: 2
Yes
documentUomlongDocument UOM id
Example: 2
Yes
exciseAmountnumberExcise amount on product
Example: 0.5
No
exciseRatenumberRate of Excise
Example: 5
No
exciseTypestringExcise type
Enum: "PERCENT", "FLAT"
Example: "FLAT"
No
fulfilledQuantitynumberTotal Fulfilled Quantity
Example: 3
No
fulfilledQuantityByFlowovernumberTotal Fulfilled Quantity By Flowover
Example: 3
No
fulfilledQuantityByUsernumberTotal Fulfilled Quantity By User
Example: 3
No
fulfilledQuantityInvoicednumberTotal Fulfilled Quantity Invoiced
Example: 3
No
fulfillmentByDoc[ ItemQtyFulfilledByDoc ]Item Qty fulfilled by Fulfillment Doc
Example: []
No
hsnOrSacCodestringHsn or Sac code
Example: 110011
No
igstAmountnumberIndia specific IGST tax amount on total amount
Example: 5
No
igstRatenumberIndia specific IGST rate
Example: 5
No
lineNumberintegerLine Number
Example: 1
No
otherRatenumberTax Rate
Example: 5
No
otherTaxAmountnumberOther Tax Amount
Example: 10
No
pendingAmountnumberPending amount
Example: 100
No
pendingQuantitynumberPending Quantity
Example: 3
No
productProductInformationProduct Short Info
Example: "product"
No
productCodestringProduct code
Example: "PC-001"
Yes
productDescriptionstringProduct description
Example: "Red pen"
No
productNamestringProduct name
Example: "Ball pen"
No
productOrderintegerProduct order
Example: 1
No
productQuantitynumberProduct quantity
Example: 2.5
Yes
reservedQuantitiesData[ ReservedQuantityData ]Reserved quantity data
Example: []
No
sgstAmountnumberIndia specific SGST tax amount on total amount
Example: 5
No
sgstRatenumberIndia specific SGST rate
Example: 5
No
taxTaxDtoTax details
Example: "taxDto"
No
taxAmountnumberTax amount
Example: 0.3
No
taxCodestringTax code
Example: "TX-003"
No
taxDetails[ DocumentItemTaxMappingDto ]Tax Details for Tax GroupNo
taxExemptionReasonstringTax Exemption reason if taxPreference is true
Enum: "EXEMPTED", "NON_GST"
Example: "EXEMPTED"
No
taxNamestringTax name
Example: "GST(7%)"
No
taxPreferencebooleanTax preference, whether Exempted or not Exempted
Example: false
No
typestringProduct type
Enum: "TRACKED", "NONTRACKED"
Example: "TRACKED"
Yes
unitPricenumberProduct price
Example: 10
No
uomQuantitynumberuom quantity
Example: 2
Yes
uomUnitPricenumberUOM Unit price
Example: 2.3
Yes
userSetTaxesbooleanFlag to check whether tax is user edited
Example: false
No

QuotationItemIsraelDto

NameTypeDescriptionRequired
advancedTrackingTypestringAdvanced Tracking Type
Enum: "NONE", "BATCH", "SERIAL"
No
allocationTypestringAllocation Type
Example: "NORMAL"
No
availableQuantitynumberTotal available quantity
Example: 3
No
basePricenumberRevenue Base price
Example: 120
No
customField[ CustomFieldItem ]List of custom fieldsNo
discountnumberProduct discount
Example: 2
No
discountInPercentbooleanDiscount in percentage
Example: true
No
documentSequenceCodestringProduct Document Sequence Code
Example: "P-0000001"
Yes
documentUOMSchemaDefinitionDocumentUOMSchemaDefinitionDocument UOM Schema Definition
Example: 2
Yes
documentUomlongDocument UOM id
Example: 2
Yes
fulfilledQuantitynumberTotal Fulfilled Quantity
Example: 3
No
fulfilledQuantityByFlowovernumberTotal Fulfilled Quantity By Flowover
Example: 3
No
fulfilledQuantityByUsernumberTotal Fulfilled Quantity By User
Example: 3
No
fulfilledQuantityInvoicednumberTotal Fulfilled Quantity Invoiced
Example: 3
No
fulfillmentByDoc[ ItemQtyFulfilledByDoc ]Item Qty fulfilled by Fulfillment Doc
Example: []
No
lineNumberintegerLine Number
Example: 1
No
otherRatenumberTax Rate
Example: 5
No
otherTaxAmountnumberOther Tax Amount
Example: 10
No
pendingQuantitynumberPending Quantity
Example: 3
No
productProductResponseProduct Short Info
Example: "product"
No
productCodestringProduct code
Example: "PC-001"
Yes
productDescriptionstringProduct description
Example: "Red pen"
No
productNamestringProduct name
Example: "Ball pen"
No
productOrderintegerProduct order
Example: 1
No
productQuantitynumberProduct quantity
Example: 2.5
Yes
reservedQuantitiesData[ ReservedQuantityData ]Reserved quantity data
Example: []
No
taxTaxDtoTax details
Example: "taxDto"
No
taxAmountnumberTax amount
Example: 0.3
No
taxCodestringTax code
Example: "TX-003"
No
taxNamestringTax name
Example: "GST(7%)"
No
typestringProduct type
Enum: "TRACKED", "NONTRACKED"
Example: "TRACKED"
Yes
unitPricenumberProduct price
Example: 10
No
uomQuantitynumberuom quantity
Example: 2
Yes
uomUnitPricenumberUOM Unit price
Example: 2.3
Yes

QuotationItemPhilippinesDto

NameTypeDescriptionRequired
advancedTrackingTypestringAdvanced Tracking Type
Enum: "NONE", "BATCH", "SERIAL"
No
allocationTypestringAllocation Type
Example: "NORMAL"
No
availableQuantitynumberTotal available quantity
Example: 3
No
basePricenumberRevenue Base price
Example: 120
No
customField[ CustomFieldItem ]List of custom fieldsNo
discountnumberProduct discount
Example: 2
No
discountInPercentbooleanDiscount in percentage
Example: true
No
documentSequenceCodestringProduct Document Sequence Code
Example: "P-0000001"
Yes
documentUOMSchemaDefinitionDocumentUOMSchemaDefinitionDocument UOM Schema Definition
Example: 2
Yes
documentUomlongDocument UOM id
Example: 2
Yes
fulfilledQuantitynumberTotal Fulfilled Quantity
Example: 3
No
fulfilledQuantityByFlowovernumberTotal Fulfilled Quantity By Flowover
Example: 3
No
fulfilledQuantityByUsernumberTotal Fulfilled Quantity By User
Example: 3
No
fulfilledQuantityInvoicednumberTotal Fulfilled Quantity Invoiced
Example: 3
No
fulfillmentByDoc[ ItemQtyFulfilledByDoc ]Item Qty fulfilled by Fulfillment Doc
Example: []
No
lineNumberintegerLine Number
Example: 1
No
otherRatenumberTax Rate
Example: 5
No
otherTaxAmountnumberOther Tax Amount
Example: 10
No
pendingQuantitynumberPending Quantity
Example: 3
No
productProductResponseProduct Short Info
Example: "product"
No
productCodestringProduct code
Example: "PC-001"
Yes
productDescriptionstringProduct description
Example: "Red pen"
No
productNamestringProduct name
Example: "Ball pen"
No
productOrderintegerProduct order
Example: 1
No
productQuantitynumberProduct quantity
Example: 2.5
Yes
reservedQuantitiesData[ ReservedQuantityData ]Reserved quantity data
Example: []
No
taxTaxDtoTax details
Example: "taxDto"
No
taxAmountnumberTax amount
Example: 0.3
No
taxCodestringTax code
Example: "TX-003"
No
taxNamestringTax name
Example: "GST(7%)"
No
typestringProduct type
Enum: "TRACKED", "NONTRACKED"
Example: "TRACKED"
Yes
unitPricenumberProduct price
Example: 10
No
uomQuantitynumberuom quantity
Example: 2
Yes
uomUnitPricenumberUOM Unit price
Example: 2.3
Yes

QuotationOverview

NameTypeDescriptionRequired
countintegerNo
data[ TenureData ]No
totalAmountnumberNo

QuotationOverviewReport

NameTypeDescriptionRequired
draftsQuotationOverviewNo
expiredQuotationOverviewNo
openQuotationOverviewNo
processedQuotationOverviewNo

QuotationPhilippinesDto

NameTypeDescriptionRequired
approvalStatusstringApproval status
Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"
Example: "APPROVED"
No
attachments[ string ]Attachments url'sNo
attachmentsWithLink[ AttachmentsResponse ]Attachments DetailsNo
backOrderbooleanBackorder flag to indicate if backorder created
Example: true
No
billToAddressBill to Address.No
contactContactInfoContact info
Example: "contact object"
No
contactCodestringContact code
Example: "C-0001"
Yes
contactDtoContactDtoContact DetailsYes
createdBylongUserId of creator
Example: 123
No
currencystringCurrency code
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
deletedbooleanQuotation deleted
Example: false
No
documentDatedateTimeDocument date
Example: "27-10-2019"
No
documentSequenceCodestringQuotation Code
Example: "0000001"
No
draftbooleanTrue if want to save as draft.
Example: false
No
errors[ string ]List of validation error messagesNo
exchangeRatedoubleExchange rate
Example: 0.01891562
No
fulfillmentDatedateTimeFulfillment date
Example: "28-10-2019"
No
fulfillmentOndateTimeFulfillment On
Example: "28-10-2019"
No
fulfillmentStatusstringFulfillment status
Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"
Example: "UNFULFILLED"
No
fulfillmentTypestringFulfillment type: NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP
_Enum:
"NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"
Example: "PICK_PACK_SHIP"
No
gstExchangeRatenumberGST 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
memostringMemo text
Example: "Sales quotation"
No
processedInPPSbooleanNo
quotationItemDtoList[ QuotationItemPhilippinesDto ]Quotation items informationNo
recurringbooleanIs quotation set to recurring
Example: false
No
recurringActivatedbooleanIs quotation recurring active
Example: false
No
reservedStockbooleanReserved stock enabled
Example: true
No
roundOffAmountInDocumentCurrencynumberRound Off Amount in Document Currency
Example: 0.3
No
sequenceFormatstringSequence Format Id
Example: 1
No
shipByDatedateTimeShip by date
Example: "25-10-2019"
No
shipFromAddressShip from Address.No
shipToAddressShip to Address.No
sourceAppNamestringSource App Name
Example: "BOOKS"
No
statusstringQuotation status
Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"
Example: "OPEN"
No
tenantIdlongTenant id
Example: 123
No
unitPriceGstInclusivebooleanUnit Price is GST inclusive
Example: true
No
validTillDatedateTimeValid till date
Example: "29-10-2019"
No
warehouseCodestringWarehouse Code
Example: "WH-000001"
No

QuotationShortInfo

NameTypeDescriptionRequired
baseCurrencystringNo
contactNamestringNo
customField[ CustomFieldItem ]No
docCurrencystringNo
documentDatestringNo
fulfillmentStatusstringNo
seqNostringNo
totalAmountstringNo
totalAmountInBaseCurrencystringNo
validTillDatestringNo

QuotationUpdateRequest

NameTypeDescriptionRequired
backOrderbooleanBackorder flag to indicate if backorder created
Example: true
No
closedDatedateTimeQuotation closed on date
Example: "05-12-2019"
No
fulfilledQtyByItemobjectFulfilled Quantity by Quotation Item
Example: []
No
fulfillmentCodestringFulfillment Code
Example: "0000012"
No
fulfillmentOndateTimeFulfillment on date
Example: "05-12-2019"
No
fulfillmentStatusstringFulfillment status
Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"
Example: "UNFULFILLED"
No
fulfillmentTypestringFulfillment type such as NONE, DEFAULT, PICKPACK_SHIP, DROP_SHIP
_Enum:
"NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"
Example: "NONE"
No
isUpdateQuoteStatusbooleanWhether to update quotation status
Example: false
No
isUpdateSIItemFulfillmentQtybooleanWhether to update Sales Invoice Item Fulfillment Qty
Example: false
No
linkedDocuments[ DocumentInfo ]Linked DocumentsNo
operationstringPartial Invoice Item added
Example: "add"
No
partialInvoiceItemsQuantitiesobjectPartial Invoice Item quantities
Example: []
No
quotationCodestringQuotation code.
Example: "000012"
No
quotationIdlongQuotation ID
Example: 123
No
reservedQuantityFulfillmentItemDtoByItemobjectReserved quantity fulfillment data
Example: []
No
statusstringQuotation status
Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"
Example: "CLOSED"
No

RecurringJobEvent

NameTypeDescriptionRequired
autoChargebooleanNo
customTemplatebooleanNo
documentDatedateTimeNo
documentTypestringEnum: "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
emailBodystringNo
emailReplyTostringNo
emailSenderNamestringNo
emailSubjectstringNo
emailTemplateIdlongNo
emailTostringNo
iamUserIdlongNo
insertPaymentLinkFlagbooleanNo
jobIdlongNo
parentDocumentCodestringNo
sendEmailNotificationFlagbooleanNo
tenantIdlongNo
userIdlongNo

RelatedTransactionDto

NameTypeDescriptionRequired
documentCodestringCode of child document.
Example: "SO-0000005"
Yes
documentTypestringDocument type being linked.
Enum: "QUOTATION", "PURCHASE_ORDER", "SALES_ORDER", "PURCHASE_INVOICE", "SALES_INVOICE", "MAKE_PAYMENT", "RECEIVE_PAYMENT", "JOURNAL_ENTRY"
Example: "SALES_ORDER"
No
parentCodestringCode of the parent document.
Example: "QO-0000001"
No
parentTypestringDocument 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

NameTypeDescriptionRequired
documentCodestringCode of the document.
Example: "QO-0000001"
No
documentTypestringType 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
orderintegerDisplay order of the record.
Example: 1
No

ReservedQuantityData

NameTypeDescriptionRequired
advancedTrackingMetaDtos[ AdvancedTrackingMetaDto ]Advance tracking type
Example: "SERIAL"
No
advancedTrackingTypestringAdvance tracking type
Enum: "NONE", "BATCH", "SERIAL"
Example: "SERIAL"
No
availableQuantitydoubleAvailable quantity in warehouse
Example: 100
No
binCodestringbin code
Example: "BIN-00001"
Yes
documentCodestringDocument code
Example: "000005"
No
documentItemCodestringDocument item code
Example: "000005"
No
documentTypestringDocument type
Example: "SALES_INVOICE"
No
productCodestringProduct Code
Example: 10
No
rackCodestringRack code
Example: "RACK-00001"
Yes
reservedDatedateTimereserved date
Example: "20-10-2022"
No
reservedQuantitydoubleReserved quantity
Example: 100
No
rowCodestringRow code
Example: "ROW-00001"
Yes
warehouseCodestringWarehouse Code
Example: 100.4
No
wipProcessTypestringWork Order WIP Process Type
Enum: "PRODUCTION", "CONSUMPTION", "WASTAGE", "SCRAP", "CO_PRODUCT"
Example: "CONSUMPTION"
No

ReservedQuantityFulfillmentItemDto

NameTypeDescriptionRequired
advancedTrackingFulfilmentDtos[ AdvancedTrackingFulfilmentDto ]Advanced tracking data for fulfilled reserved quantity
Example: []
No
fulfilledQtyByWarehouse[ LinkedWareHouse ]Fulfilled reserved quantity by warehouse
Example: []
No

ResponseEntity

NameTypeDescriptionRequired
bodyobjectNo
statusCodestringEnum: "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
statusCodeValueintegerNo

SalesDocument

NameTypeDescriptionRequired
contactCodestringContact code
Example: "000012"
No
contactDtoContactDtoContact DetailsYes
documentCodestringDocument Code.
Example: "QO-0000001"
No
documentDatedateTimeDocument date
Example: "25-10-2019"
No
documentItemDetails[ DocumentItemDetails ]Document item details.No
documentSequenceCodestringDocument Sequence Code.
Example: "0000001"
No
documentTypestringType 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
exchangeRatedoubleNo
linkedDocuments[ DocumentInfo ]Linked DocumentsNo
shipByDatedateTimeShip by date
Example: "25-10-2019"
No
shipFromAddressShip from address.No
shipToAddressShip To address.No
warehouseCodestringWarehouse Code
Example: "WH-0000001"
No

SetRecurringDto

NameTypeDescriptionRequired
documentCodestringNo
documentTypestringEnum: "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
recurringbooleanNo
recurringActivatedbooleanNo

Sort

NameTypeDescriptionRequired
emptybooleanNo
sortedbooleanNo
unsortedbooleanNo

StockQuantitiesRequest

NameTypeDescriptionRequired
productVariantCodes[ string ]No
status[ string ]No
warehouseCodestringNo

StockQuantitiesResponse

NameTypeDescriptionRequired
productStockInfo[ ProductStockInfo ]No

TaxDto

NameTypeDescriptionRequired
accountCodestringAccount code
Example: "AC-001"
No
additionalTaxInbooleanTRUE/FALSE
Example: false
No
basReportingstringReporting Method
Example: "BOTH"
No
codestringTax code
Example: "TC-001"
No
defaultMemoBEstringDefault memo
Example: "Memo"
No
defaultMemoDestringDefault Memo Germany
Example: "memo"
No
defaultMemoNLstringDefault memo
Example: "Momo"
No
defaultMemoUkstringDefault Memo UK
Example: "memo"
No
deletedbooleanTax deleted
Example: false
No
descriptionstringDescription
Example: "sales Tax for SG"
No
effectiveEndDatedateTimeEffective end date of the tax
Example: "2023-12-31"
No
effectiveStartDatedateTimeEffective start date of the tax
Example: "2023-01-01"
No
flatRateSchemeUkbooleanFlat Rate Scheme UK
Example: false
No
isDefaultbooleanIs Default Tax
Example: false
No
isTaxGroupbooleanIs Tax Group
Example: false
No
namestringTax Name
Example: "SGST"
No
netAmountBeforestringNet Amount Before Section
Example: "Box 5,Box 6"
No
netAmountBeforeBEstringNet Amount Before Section
Example: "Box 00,Box 01"
No
netAmountBeforeNLstringNet Amount Before Section
Example: "Box 5,Box 6"
No
netAmountDestringNet Amount Before Section
Example: "Box 5,Box 6"
No
netAmountUkstringNet Amount Before Section
Example: "Box 5,Box 6"
No
percentnumberTax percentage
Example: 7
No
showInReportsIDbooleanFlag to consider in reports
Example: true
No
statusstringTax status
Example: "active"
No
taxAccountCodestringAccount Code
Example: "ACC-0000001"
No
taxAgencyCanstringExample: "British Columbia"No
taxAmountDestringTax Amount In Section
Example: "Box 5,Box 6"
No
taxAmountInstringTax Amount In Section
Example: "Box 5,Box 6"
No
taxAmountInBEstringTax Amount In Section
Example: "Box 54,Box 55"
No
taxAmountInNLstringTax Amount In Section
Example: "Box 5,Box 6"
No
taxAmountUkstringTax Amount In Section
Example: "Box 5,Box 6"
No
taxCodestringTax code
Example: "TC-001"
No
taxGroupDetails[ TaxGroupDetails ]Tax DetailsNo
taxSectionAusstringTax 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
taxSectionSARstringTax Section Name
Example: "Standard rates sales, Standard rated domestic purchase"
No
typestringSALES
Enum: "SALES", "PURCHASE", "BOTH"
Example: "SALES"
No

TaxGroupDetails

NameTypeDescriptionRequired
additionalTaxInbooleanNo
applyTostringNo
codestringNo
idlongNo
namestringNo
percentagenumberNo
typestringNo

TenureData

NameTypeDescriptionRequired
amountnumberNo
countintegerNo
dayintegerNo
monthstringEnum: "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"No
yearYearNo

TriggerKafkaRequestDto

NameTypeDescriptionRequired
approvalHistory[ ApprovalHistoryItem ]No
approverMapobjectNo
contactCodestringNo
currencystringNo
currentLevelintegerNo
totalAmountstringNo
userNamestringNo

UOMDto

NameTypeDescriptionRequired
activebooleanIs active or not
Example: true
No
deletedbooleanIs deleted or not
Example: false
No
descriptionstringUOM description
Example: "UOM to measure weight"
No
idlongUOM Id
Example: 1
No
isSystemGeneratedbooleanFlag to specify if the UOM is system or user generated
Example: false
No
namestringUOM name
Example: "LB"
No
tenantIdlongTenant Id
Example: 1233
No

UOMSchemaDefinitionDto

NameTypeDescriptionRequired
sinkConversionFactornumber10
Example: 10
No
sinkUOMlong2
Example: 2
No
sourceConversionFactornumber1
Example: 1
No
sourceUOMlong4
Example: 4
No
uidstring (uuid)UOM Schema Definition Id
Example: 1
No

UOMSchemaDto

NameTypeDescriptionRequired
activebooleanIs active or not
Example: true
No
baseUOMUOMDtoBase UOM
Example: "LB"
No
idlongUOM Id
Example: 1
No
namestringUOM name
Example: "LB"
No
uomSchemaDefinitions[ UOMSchemaDefinitionDto ]UOM schema definitionsNo

Year

NameTypeDescriptionRequired
leapbooleanNo
valueintegerNo