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
OrderCreditDetailsRequestName | 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": "FGqi9kIDZ0yq6OAg3INEoQ==", "creditNoteGuid": "f6a26a14-0342-4c67-aae8-e020dc8344a1", "orderGuid": "I6YcSnuIUUiQX92LTDXNRg==", "orderIdentifier": "4a1ca623-887b-4851-905f-dd8b4c35cd46", "products": [ "8d2630a8-6bfa-497d-920f-5d248cc09919", "50948efe-4dec-44d2-8284-8d75641d406d" ], "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>f6a26a14-0342-4c67-aae8-e020dc8344a1</CreditNoteGuid> <CreditNoteIdentifier>FGqi9kIDZ0yq6OAg3INEoQ==</CreditNoteIdentifier> <OrderGuid>I6YcSnuIUUiQX92LTDXNRg==</OrderGuid> <OrderIdentifier>4a1ca623-887b-4851-905f-dd8b4c35cd46</OrderIdentifier> <Products xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>8d2630a8-6bfa-497d-920f-5d248cc09919</d2p1:guid> <d2p1:guid>50948efe-4dec-44d2-8284-8d75641d406d</d2p1:guid> </Products> <Reason>1</Reason> </OrderCreditDetailsRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.