Returns APIs

More about Returns API

Deskera - Return Service

Contact com.deskera.erp.return.service APIs.

purchase-return-controller

Purchase Return Controller

Add Purchase return

POST

Summary

Create purchase return

More about Returns API

Description

API to create purchase return.

Parameters

Name	Located in	Description	Required	Schema
purchaseReturnDto	body	purchaseReturnDto	Yes	PurchaseReturnDto

Responses

Code	Description	Schema
200	OK	PurchaseReturnDto
201	Purchase return created successfully	PurchaseReturnDto
400	Failed to create purchase return
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase return

Description

API to delete purchase return.

Parameters

Name	Located in	Description	Required	Schema
purchaseReturnCode	query	purchaseReturnCode	Yes	string

Responses

Code	Description
200	OK
201	Purchase return deleted successfully
204	No Content
400	Failed to delete purchase return
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Get Purchase return details

GET

Summary

Get purchase returns for a document

Description

API to get purchase returns for a document

Parameters

Name	Located in	Description	Required	Schema
documentCode	query	documentCode	Yes	string
documentType	query	documentType	Yes	string
forRejectedGr	query	forRejectedGr	No	boolean

Responses

Code	Description	Schema
200	Purchase returns fetched successfully	[ PurchaseReturnDto ]
400	Failed to fetch purchase return
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Bulk Create Purchase Return

POST

Summary

Create purchase return

Description

API to bulk create purchase returns.

Parameters

Name	Located in	Description	Required	Schema
purchaseReturnDto	body	purchaseReturnDto	Yes	[ PurchaseReturnDto ]

Responses

Code	Description	Schema
201	Purchase return created successfully	PurchaseReturnBulkApiResponse
400	Failed to create purchase return
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Get Purchase Return Reasons

GET

Summary

Get Unique return reasons

Description

API to get unique purchase return reasons.

Responses

Code	Description	Schema
200	Purchase return reasons fetched successfully	[ string ]
400	Failed to fetch purchase return reasons
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

sales-return-controller

Sales Return Controller

Sales Return

GET

Summary

Search sales returns.

Description

API to search sales returns.

Parameters

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

Responses

Code	Description	Schema
200	Sales returns have been fetched successfully.	Page«SalesReturnDto»
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create sales return

Description

API to create sales return.

Parameters

Name	Located in	Description	Required	Schema
salesReturnDto	body	salesReturnDto	Yes	SalesReturnDto

Responses

Code	Description	Schema
200	OK	SalesReturnDto
201	Sales return created successfully	SalesReturnDto
400	Failed to create sales return
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete sales return

Description

API to delete sales return.

Parameters

Name	Located in	Description	Required	Schema
salesReturnCode	query	salesReturnCode	Yes	string

Responses

Code	Description
200	OK
201	Sales return deleted successfully
204	No Content
400	Failed to delete sales return
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Get Sales Return Details

GET

Summary

Get sales returns for a document

Description

API to get sales returns for a document

Parameters

Name	Located in	Description	Required	Schema
documentCode	query	documentCode	Yes	string
documentType	query	documentType	Yes	string
checkLinkedDocs	query	checkLinkedDocs	No	boolean

Responses

Code	Description	Schema
200	Sales returns fetched successfully	[ SalesReturnDto ]
400	Failed to fetch sales return
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Get Sales Return Reasons

GET

Summary

Get Unique return reasons

Description

API to get unique sales return reasons.

Responses

Code	Description	Schema
200	Sales return reasons fetched successfully	[ string ]
400	Failed to fetch sales return reasons
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Get Sales Return By Code

GET

Summary

Get sales return by code

Description

API to get sales return by code.

Parameters

Name	Located in	Description	Required	Schema
documentCode	path	documentCode	Yes	string

Responses

Code	Description	Schema
200	Sales return fetched successfully	SalesReturnDto
400	Failed to fetch sales return
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Models

AdvancedTrackingMetaDto

Name	Type	Description	Required
acquiredCost	number	Acquired cost of the entire serial or batch Example: 1	No
advancedTracking	string	Enum: "NONE", "BATCH", "SERIAL"	No
advancedTrackingReturned	AdvancedTrackingReturned		No
availableBatchSizeForGr	double	Available batch size for goods receipt Example: 1	No
batchSize	double	Serial Number or Batch size Example: 1	Yes
batchSizeAvailableForReturn	double	How much of the batch or serial is fulfilled Example: 1	Yes
batchSizeFulfilled	double	How much of the batch or serial is fulfilled Example: 1	Yes
batchSizeReturned	double	How much of the batch or serial is returned Example: 1	Yes
batchSizeReturnedPurchase	double	How much of the batch or serial is returned Example: 1	Yes
binCode	string	bin code Example: "BIN-00001"	Yes
binName	string	bin Name Example: "Bin 1"	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
expiryDate	dateTime	Expiry date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch Example: "01-01-2020"	No
id	long		No
isOpeningQtySerialBatchNumber	boolean	Has the value true if this is an opening quantity serial/batch number or false otherwise	No
localizedBatchSize	double	Localized batch size Example: 1	No
manufacturingDate	dateTime	Manufacturing date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch Example: "01-01-2020"	No
productVariantCode	string	Product code Example: "P-001"	Yes
rackCode	string	Rack code Example: "RACK-00001"	Yes
rackName	string	Rack Name Example: "Rack 1"	Yes
rawMaterialQtyToConsume	double	Raw material quantity to consume Example: 1	No
reservedQuantity	double	Reserved Serial Number or Batch size Example: 1	No
reservedQuantityFulfilled	double	Fulfilled reserved serial number or batch size Example: 1	Yes
reservedUomQuantity	double	Reserved quantity in the item's unit of measurement Example: 1	No
rowCode	string	Row code Example: "ROW-00001"	Yes
rowName	string	Row Name Example: "Row 1"	Yes
sequence	long	Sequence number Example: 1	No
serialBatchNumber	string	Serial Number or Batch Number Example: "BATCH-001"	Yes
subSequence	long	Subsequence number Example: 1	No
transactionRefCode	string	Transaction reference code	No
warehouseCode	string	Primary Warehouse Example: "WH-0000001"	No
warehouseName	string	Primary Warehouse Example: "warehouse name"	No

AdvancedTrackingReturned

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

AdvancedTrackingReturnedByDoc

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

BulkPaymentItem

Name	Type	Description	Required
amount	number		No
documentCode	string		No

ContactInfo

Name	Type	Description	Required
address	string		No
name	string		No

CustomFieldItem

Name	Type	Description	Required
code	string	Custom field code	No
fieldType	string	Type of the custom field	No
formulaId	long	Identifier of the formula linked to this custom field	No
id	long	Dimension Id Example: 11567	No
label	string	Custom Field Name Example: "Label"	Yes
module	string	Supported Modules	No
shortName	string	Short name of the custom field	No
value	object	Dimension Value Example: "XYZ"	No

DocumentInfo

Name	Type	Description	Required
documentCode	string	Document Code. Example: "QO-0000001"	No
documentCreatedDate	dateTime	Purchase creation date Example: "2023-01-01T00:00:00.000+0000"	No
documentReceiveByDate	dateTime	Date by which the document is to be received	No
documentSequenceCode	string	Purchase Order Code Example: "0000001"	No
documentType	string	Type of document. Enum: "QUOTATION", "PURCHASE_ORDER", "SALES_ORDER", "PURCHASE_INVOICE", "SALES_INVOICE", "MAKE_PAYMENT", "RECEIVE_PAYMENT", "JOURNAL_ENTRY", "BANK_TRANSFER", "CREDIT_NOTE", "DEBIT_NOTE", "EXPENSE", "EXPENSE_PREPAYMENT", "DEPOSIT", "DEPOSIT_ADVPAYMENT", "CONTRA_ADJUSTMENT", "GOODS_RECEIPT", "FULFILLMENT", "PICKLIST", "PACKLIST", "SHIPLIST", "PAYSLIP", "PAYROLL_CHECK", "CHEQUE", "SALES_RETURN", "PURCHASE_RETURN", "STOCK_ADJUSTMENT", "STOCK_TRANSFER", "WORK_ORDER", "FIXED_ASSET", "E_WAY_BILL_SUMMARY", "E_WAY_BILL_DETAIL", "PURCHASE_REQUEST", "JOB_WORK_OUT_ORDER", "JOB_WORK_OUT_TRANSFER", "QC_DOCUMENT", "WIP_PRODUCTION", "STOCK_REQUEST", "STOCK_ISSUE", "FORECAST" Example: "QUOTATION"	No
isConvertedFromWorkOrder	boolean	Has the value true if the document was converted from a work order or false otherwise	No
isGateEntryDetailsCopiedFromPO	boolean	Has the value true if gate entry details were copied from the purchase order or false otherwise	No
itemCodeQuantityMap	object	Map of item code to quantity	No
lineItemDetails	object	Map of line item details	No
productCodes	[ string ]	List of product codes on the document	No
refundAmount	number	Refund amount	No

DocumentUOMSchemaDefinition

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

KnockOffInfo

Name	Type	Description	Required
accountCodePayTo	string		No
amount	number		No
bulkData	[ BulkPaymentItem ]		No
contraDocumentCode	string		No
currency	string		No
documentCode	string		No
documentDate	dateTime		No
documentOrder	integer		No
documentType	string	Enum: "QUOTATION", "PURCHASE_ORDER", "SALES_ORDER", "PURCHASE_INVOICE", "SALES_INVOICE", "MAKE_PAYMENT", "RECEIVE_PAYMENT", "JOURNAL_ENTRY", "BANK_TRANSFER", "CREDIT_NOTE", "DEBIT_NOTE", "EXPENSE", "EXPENSE_PREPAYMENT", "DEPOSIT", "DEPOSIT_ADVPAYMENT", "CONTRA_ADJUSTMENT", "GOODS_RECEIPT", "FULFILLMENT", "PICKLIST", "PACKLIST", "SHIPLIST", "PAYSLIP", "PAYROLL_CHECK", "CHEQUE", "SALES_RETURN", "PURCHASE_RETURN", "STOCK_ADJUSTMENT", "STOCK_TRANSFER", "WORK_ORDER", "FIXED_ASSET", "E_WAY_BILL_SUMMARY", "E_WAY_BILL_DETAIL", "PURCHASE_REQUEST", "JOB_WORK_OUT_ORDER", "JOB_WORK_OUT_TRANSFER", "QC_DOCUMENT", "WIP_PRODUCTION", "STOCK_REQUEST", "STOCK_ISSUE", "FORECAST"	No
exchangeRate	number		No
linkedDocumentSequence	string		No
linkedWhileCreatingNote	boolean		No
uid	string (uuid)		No
whtAmount	number		No

Pageable

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

Page«SalesReturnDto»

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

PurchaseReturnBulkApiResponse

Name	Type	Description	Required
failure	[ PurchaseReturnDto ]		No
failureDetails	[ PurchaseReturnFailureDetails ]		No
success	[ PurchaseReturnDto ]		No

PurchaseReturnDto

Name	Type	Description	Required
attachments	[ string ]	Attachments	No
binCode	string	bin code Example: "BIN-00001"	Yes
closedDate	dateTime	Closed date Example: "25-10-2020"	No
contactCode	string	Contact code Example: "C-00001"	No
contactInfo	ContactInfo	Contact information	No
createdBy	long	Identifier of the user who created the purchase return	No
currency	string	Currency Example: "SGD"	No
customField	[ CustomFieldItem ]	List of custom fields	No
deleted	boolean	Purchase return deleted Example: false	No
documentSequenceCode	string	Document sequence code Example: "0000001"	No
exchangeRate	number	Exchange rate Example: 1	No
forRejectedGr	boolean	Has the value true if this return is for a rejected goods receipt or false otherwise	No
id	long	Unique identifier for the purchase return	No
knockoffInfo	[ KnockOffInfo ]	Knockoff information	No
linkedDocuments	[ DocumentInfo ]	Linked documents	No
memo	string	Memo Example: "Sample memo"	No
purchaseReturnCode	string	Purchase return code Example: "SL-00001"	No
purchaseReturnDate	dateTime	Purchase return date Example: "25-10-2020"	No
purchaseReturnItems	[ PurchaseReturnItemDto ]	Purchase Return items information	No
quantity	string	Quantity Enum: "FULL", "PARTIAL" Example: 1	No
rackCode	string	Rack code Example: "RACK-00001"	Yes
reasonToReturn	string	Reason to return Example: "Sample reason"	No
receiptStatus	string	Receipt status Enum: "OPEN", "CLOSED" Example: "OPEN"	No
receivedAmount	number	Received amount Example: 100	No
returnType	string	Return type Enum: "RETURN_ONLY", "RETURN_AND_REFUND", "REPLACEMENT" Example: "RETURN_ONLY"	No
rowCode	string	Row code Example: "ROW-00001"	Yes
sequenceFormat	string	Sequence format Example: "5e5789e7bfbb13a1976bb594"	No
tenantId	long	Tenant id to whom the purchase return is associated with	No
updatedBy	long	Identifier of the user who last updated the purchase return	No
warehouseCode	string	Warehouse code Example: "WH-00001"	No

PurchaseReturnFailureDetails

Name	Type	Description	Required
errorMsg	string		No
failedObject	PurchaseReturnDto		No

PurchaseReturnItemDto

Name	Type	Description	Required
advancedTrackingMetaData	[ AdvancedTrackingMetaDto ]		No
advancedTrackingType	string	Enum: "NONE", "BATCH", "SERIAL"	No
customField	[ CustomFieldItem ]	List of custom fields	No
documentSequenceCode	string	Document seqence code Example: "0000001"	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: 2	Yes
documentUom	long	Document UOM id Example: 2	Yes
id	long	Unique identifier for the purchase return item	No
itemSequenceCode	string	Item sequence code Example: "SRI-00001"	No
productCode	string	Product code Example: "P-00001"	No
productDescription	string	Product description Example: "Sample description"	No
productName	string		No
productOrder	integer	Product Order Example: 1	No
quantityReceived	number	Quantity received Example: 1	No
quantityToReturn	number	Quantity to return Example: 1	No
tenantId	long	Tenant id to whom the purchase return item is associated with	No
uomQuantityReceived	number	UOM Quantity received Example: 2	Yes
uomQuantityToReturn	number	UOM Quantity to return Example: 100	Yes
value	number	Return item value Example: 1	No
warehouseCode	string	Warehouse code Example: "WH-00001"	No

SalesReturnDto

Name	Type	Description	Required
attachments	[ string ]	Attachments	No
binCode	string	bin code Example: "BIN-00001"	Yes
closedDate	dateTime	Closed Date Example: "25-10-2020"	No
contactCode	string	Contact code Example: "C-00001"	No
contactInfo	ContactInfo	Contact Information	No
createdBy	long	Identifier of the user who created the sales return	No
currency	string	Currency Example: "SGD"	No
customField	[ CustomFieldItem ]	List of custom fields	No
deleted	boolean	Sales Return Deleted Example: false	No
documentSequenceCode	string	Document sequence code Example: "0000001"	No
exchangeRate	number	Exchange Rate Example: 1	No
fulfillmentType	string	Fulfillment type Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP" Example: "PICK_PACK_SHIP"	No
id	long	Unique identifier for the sales return	No
knockoffInfo	[ KnockOffInfo ]	Knockoff Information	No
linkedDocuments	[ DocumentInfo ]	Linked documents	No
memo	string	Memo Example: "Sample memo"	No
quantity	string	Quantity Enum: "FULL", "PARTIAL" Example: 1	No
rackCode	string	Rack code Example: "RACK-00001"	Yes
reasonToReturn	string	Reason to return Example: "Sample reason"	No
refundAmount	number	Refund amount Example: 100	No
returnStatus	string	Return status Enum: "OPEN", "CLOSED" Example: "OPEN"	No
returnType	string	Return Type Enum: "RETURN_ONLY", "RETURN_AND_REFUND", "REPLACEMENT" Example: "RETURN_ONLY"	No
rowCode	string	Row code Example: "ROW-00001"	Yes
salesReturnCode	string	Sales Return Code Example: "SL-00001"	No
salesReturnDate	dateTime	Sales Return Date Example: "25-10-2020"	No
salesReturnItems	[ SalesReturnItemDto ]	Sales Return items information	No
sequenceFormat	string	Sequence format Example: "5e5789e7bfbb13a1976bb594"	No
tenantId	long	Tenant id to whom the sales return is associated with	No
updatedBy	long	Identifier of the user who last updated the sales return	No
warehouseCode	string	Warehouse code Example: "WH-00001"	No
warehouseName	string	Warehouse name	No

SalesReturnItemDto

Name	Type	Description	Required
advancedTrackingMetaData	[ AdvancedTrackingMetaDto ]		No
advancedTrackingType	string	Enum: "NONE", "BATCH", "SERIAL"	No
customField	[ CustomFieldItem ]	List of custom fields	No
documentSequenceCode	string	Document seqence code Example: "0000001"	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: 2	Yes
documentUom	long	Document UOM id Example: 2	Yes
id	long	Unique identifier for the sales return item	No
itemSequenceCode	string	Item sequence code Example: "SRI-00001"	No
productCode	string	Product code Example: "P-00001"	No
productDescription	string	Product description Example: "Sample description"	No
productName	string		No
productOrder	integer	Product Order Example: 1	No
quantityFulfilled	number	Quantity fulfilled Example: 1	No
quantityToReturn	number	Quantity to return Example: 1	No
tenantId	long	Tenant id to whom the sales return item is associated with	No
uomQuantityFulfilled	number	UOM Quantity fulfilled Example: 2	Yes
uomQuantityToReturn	number	UOM Quantity to return Example: 100	Yes
value	number	Return item value Example: 1	No

Sort

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