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": "loKS359rGkiLPFtJnkR+xw==",
"creditNoteGuid": "df928296-6b9f-481a-8b3c-5b499e447ec7",
"orderGuid": "0jkDrq6mFkiKFq+6bDFuuQ==",
"orderIdentifier": "ae0339d2-a6ae-4816-8a16-afba6c316eb9",
"products": [
"8c7b40da-e235-4287-999c-a923444b41b2",
"0d9ae8f0-d31a-4d61-94c4-d29023ebe493"
],
"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>df928296-6b9f-481a-8b3c-5b499e447ec7</CreditNoteGuid>
<CreditNoteIdentifier>loKS359rGkiLPFtJnkR+xw==</CreditNoteIdentifier>
<OrderGuid>0jkDrq6mFkiKFq+6bDFuuQ==</OrderGuid>
<OrderIdentifier>ae0339d2-a6ae-4816-8a16-afba6c316eb9</OrderIdentifier>
<Products xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>8c7b40da-e235-4287-999c-a923444b41b2</d2p1:guid>
<d2p1:guid>0d9ae8f0-d31a-4d61-94c4-d29023ebe493</d2p1:guid>
</Products>
<Reason>1</Reason>
</OrderCreditDetailsRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.