POST api/creditNote/{id}/detail/{guid}/receive

Save a credit detail receive record

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Credit note identifier

globally unique identifier

Required

guid

Credit detail identifier

globally unique identifier

Required

Body Parameters

Credit detail receive to be saved

CreditDetailReceive
NameDescriptionTypeAdditional information
ID

integer

None.

CreditNoteIdentifier

Collection of byte

None.

CreditNoteIdentifierGuid

globally unique identifier

None.

CreditDetailIdentifier

Collection of byte

None.

CreditDetailIdentifierGuid

globally unique identifier

None.

PLUG_UID

Collection of byte

None.

PluGuid

globally unique identifier

None.

Image

string

None.

Taken

date

None.

UploadNew

When true, if extension and picture are provided, will upload and save file

boolean

Relation. This field may not always be loaded or used for updates.

Extension

string

Relation. This field may not always be loaded or used for updates.

ImageEncodedString

Base64 Encoded image string

string

Relation. This field may not always be loaded or used for updates.

PictureStream

Only used for sending credit notes

Stream

Relation. This field may not always be loaded or used for updates.

Notes

Notes to add to the credit detail line

string

Relation. This field may not always be loaded or used for updates.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "creditNoteIdentifier": "xPx6PxRzD02Z3Rh75Q/ZbQ==",
  "creditNoteIdentifierGuid": "3f7afcc4-7314-4d0f-99dd-187be50fd96d",
  "creditDetailIdentifier": "7PWwwSMtAUyoaA7LRBRSaw==",
  "creditDetailIdentifierGuid": "c1b0f5ec-2d23-4c01-a868-0ecb4414526b",
  "pluG_UID": "0UOsSo5XLUO1L1V5QrAW3g==",
  "pluGuid": "4aac43d1-578e-432d-b52f-557942b016de",
  "image": "sample string 1",
  "taken": "2025-06-14T07:21:46.5939242",
  "uploadNew": true,
  "extension": "sample string 3",
  "imageEncodedString": "sample string 4",
  "notes": "sample string 5"
}

application/xml, text/xml

Sample:
<CreditDetailReceive xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.CreditNotes">
  <CreditDetailIdentifier>7PWwwSMtAUyoaA7LRBRSaw==</CreditDetailIdentifier>
  <CreditDetailIdentifierGuid>c1b0f5ec-2d23-4c01-a868-0ecb4414526b</CreditDetailIdentifierGuid>
  <CreditNoteIdentifier>xPx6PxRzD02Z3Rh75Q/ZbQ==</CreditNoteIdentifier>
  <CreditNoteIdentifierGuid>3f7afcc4-7314-4d0f-99dd-187be50fd96d</CreditNoteIdentifierGuid>
  <Extension>sample string 3</Extension>
  <ID>1</ID>
  <Image>sample string 1</Image>
  <ImageEncodedString>sample string 4</ImageEncodedString>
  <Notes>sample string 5</Notes>
  <PLUG_UID>0UOsSo5XLUO1L1V5QrAW3g==</PLUG_UID>
  <PictureStream xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
  <PluGuid>4aac43d1-578e-432d-b52f-557942b016de</PluGuid>
  <Taken>2025-06-14T07:21:46.5939242+00:00</Taken>
  <UploadNew>true</UploadNew>
</CreditDetailReceive>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.