POST api/invoice/{guid}/creditNote/{id}/details
Create credit details from invoice
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
guid |
Invoice identifier |
globally unique identifier |
Required |
id |
Credit note identifier |
globally unique identifier |
Required |
Body Parameters
Collection of options for adding invoice details
InvoiceCreditDetailsRequestName | 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. |
|
InvoiceIdentifier |
The invoice identifier, of the invoice that the details are being added from |
Collection of byte |
None. |
InvoiceIdentifierGuid | globally unique identifier |
None. |
|
DetailIdentifiers |
The Invoice Detail 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 (affects some auto-filled fields) |
CreditDetailReason |
None. |
Request Formats
application/json, text/json
Sample:
{ "creditNoteIdentifier": "TtID9V7YIEeaau5jMETCmQ==", "creditNoteGuid": "f503d24e-d85e-4720-9a6a-ee633044c299", "invoiceIdentifier": "6j3Ojprh7kCh/cwJTis1Xg==", "invoiceIdentifierGuid": "8ece3dea-e19a-40ee-a1fd-cc094e2b355e", "detailIdentifiers": [ "45dbb0d2-8a23-4570-9edf-d2d29231ada2", "e6e1e711-de89-42ba-ba6a-2236bacff6e8" ], "reason": 1 }
application/xml, text/xml
Sample:
<InvoiceCreditDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.CreditNotes"> <CreditNoteGuid>f503d24e-d85e-4720-9a6a-ee633044c299</CreditNoteGuid> <CreditNoteIdentifier>TtID9V7YIEeaau5jMETCmQ==</CreditNoteIdentifier> <DetailIdentifiers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>45dbb0d2-8a23-4570-9edf-d2d29231ada2</d2p1:guid> <d2p1:guid>e6e1e711-de89-42ba-ba6a-2236bacff6e8</d2p1:guid> </DetailIdentifiers> <InvoiceIdentifier>6j3Ojprh7kCh/cwJTis1Xg==</InvoiceIdentifier> <InvoiceIdentifierGuid>8ece3dea-e19a-40ee-a1fd-cc094e2b355e</InvoiceIdentifierGuid> <Reason>1</Reason> </InvoiceCreditDetailsRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.