POST api/order/{guid}/creditNote/{id}/details
Create credit details from order
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| guid |
Order identifier |
globally unique identifier |
Required |
| id |
Credit note identifier |
globally unique identifier |
Required |
Body Parameters
Collection of options for adding order details
OrderCreditDetailsRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| CreditNoteIdentifier |
Credit note identifier of the credit note to add details to |
Collection of byte |
None. |
| CreditNoteGuid | globally unique identifier |
None. |
|
| OrderGuid |
The invoice identifier, of the invoice that the details are being added from |
Collection of byte |
None. |
| OrderIdentifier | globally unique identifier |
None. |
|
| Products |
The product identifiers of the lines to be transformed into credit details |
Collection of globally unique identifier |
None. |
| Reason |
The reason that the lines need a credit note |
CreditDetailReason |
None. |
Request Formats
application/json, text/json
Sample:
{
"creditNoteIdentifier": "4X+OHS+4IkCl7+tredOMRQ==",
"creditNoteGuid": "1d8e7fe1-b82f-4022-a5ef-eb6b79d38c45",
"orderGuid": "crPYpWiw70KcjZhYlgLGxA==",
"orderIdentifier": "a5d8b372-b068-42ef-9c8d-98589602c6c4",
"products": [
"98ec24d4-ae6c-4156-a849-c1af82922902",
"4ce1a47a-6610-4ae5-bbb2-baa1be7613b7"
],
"reason": 1
}
application/xml, text/xml
Sample:
<OrderCreditDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.CreditNotes">
<CreditNoteGuid>1d8e7fe1-b82f-4022-a5ef-eb6b79d38c45</CreditNoteGuid>
<CreditNoteIdentifier>4X+OHS+4IkCl7+tredOMRQ==</CreditNoteIdentifier>
<OrderGuid>crPYpWiw70KcjZhYlgLGxA==</OrderGuid>
<OrderIdentifier>a5d8b372-b068-42ef-9c8d-98589602c6c4</OrderIdentifier>
<Products xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>98ec24d4-ae6c-4156-a849-c1af82922902</d2p1:guid>
<d2p1:guid>4ce1a47a-6610-4ae5-bbb2-baa1be7613b7</d2p1:guid>
</Products>
<Reason>1</Reason>
</OrderCreditDetailsRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.