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": "+2Z3uMrRs0CiZFM1G718LA==", "creditNoteGuid": "b87766fb-d1ca-40b3-a264-53351bbd7c2c", "orderGuid": "RNTgcjiwg0SJaUE2KyMEFA==", "orderIdentifier": "72e0d444-b038-4483-8969-41362b230414", "products": [ "c16bc1a1-75e3-4413-8d8c-27b6ad8eab96", "f121da59-981d-4b73-94b9-ed35f8cd16d6" ], "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>b87766fb-d1ca-40b3-a264-53351bbd7c2c</CreditNoteGuid> <CreditNoteIdentifier>+2Z3uMrRs0CiZFM1G718LA==</CreditNoteIdentifier> <OrderGuid>RNTgcjiwg0SJaUE2KyMEFA==</OrderGuid> <OrderIdentifier>72e0d444-b038-4483-8969-41362b230414</OrderIdentifier> <Products xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>c16bc1a1-75e3-4413-8d8c-27b6ad8eab96</d2p1:guid> <d2p1:guid>f121da59-981d-4b73-94b9-ed35f8cd16d6</d2p1:guid> </Products> <Reason>1</Reason> </OrderCreditDetailsRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.