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": "qLdLNGcb/EmVcsPtemg7xQ==", "creditNoteGuid": "344bb7a8-1b67-49fc-9572-c3ed7a683bc5", "orderGuid": "6dvZ7yG1m0mmvhNb3zXDig==", "orderIdentifier": "efd9dbe9-b521-499b-a6be-135bdf35c38a", "products": [ "eaef732d-058e-47c8-88dd-8807d6bd8b5e", "6a173b2d-3f7c-42b3-8908-1bf5e405c188" ], "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>344bb7a8-1b67-49fc-9572-c3ed7a683bc5</CreditNoteGuid> <CreditNoteIdentifier>qLdLNGcb/EmVcsPtemg7xQ==</CreditNoteIdentifier> <OrderGuid>6dvZ7yG1m0mmvhNb3zXDig==</OrderGuid> <OrderIdentifier>efd9dbe9-b521-499b-a6be-135bdf35c38a</OrderIdentifier> <Products xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>eaef732d-058e-47c8-88dd-8807d6bd8b5e</d2p1:guid> <d2p1:guid>6a173b2d-3f7c-42b3-8908-1bf5e405c188</d2p1:guid> </Products> <Reason>1</Reason> </OrderCreditDetailsRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.