POST api/invoice/{guid}/creditNote/{id}/details

Create credit details from invoice

Request Information

URI Parameters

NameDescriptionTypeAdditional 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

InvoiceCreditDetailsRequest
NameDescriptionTypeAdditional 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": "S8WwncvbQESq4wYO4+8nQg==",
  "creditNoteGuid": "9db0c54b-dbcb-4440-aae3-060ee3ef2742",
  "invoiceIdentifier": "BPXR+SBkNEyT02W1BFwuTg==",
  "invoiceIdentifierGuid": "f9d1f504-6420-4c34-93d3-65b5045c2e4e",
  "detailIdentifiers": [
    "e39a94ea-1a3e-47c3-bfdc-3f85880b5e48",
    "cd48a7e7-9727-407e-a71f-d152f77ab01b"
  ],
  "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>9db0c54b-dbcb-4440-aae3-060ee3ef2742</CreditNoteGuid>
  <CreditNoteIdentifier>S8WwncvbQESq4wYO4+8nQg==</CreditNoteIdentifier>
  <DetailIdentifiers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>e39a94ea-1a3e-47c3-bfdc-3f85880b5e48</d2p1:guid>
    <d2p1:guid>cd48a7e7-9727-407e-a71f-d152f77ab01b</d2p1:guid>
  </DetailIdentifiers>
  <InvoiceIdentifier>BPXR+SBkNEyT02W1BFwuTg==</InvoiceIdentifier>
  <InvoiceIdentifierGuid>f9d1f504-6420-4c34-93d3-65b5045c2e4e</InvoiceIdentifierGuid>
  <Reason>1</Reason>
</InvoiceCreditDetailsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.