PUT api/creditNote/{id}/detail/{guid}
Save a credit detail for a credit note
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Credit note identifier |
globally unique identifier |
Required |
| guid |
Credit detail identifier |
globally unique identifier |
Required |
Body Parameters
Credit detail
CreditDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| CreditNoteIdentifier | Collection of byte |
None. |
|
| CreditNoteGuid | 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. |
|
| InvoiceDetailIdentifier | Collection of byte |
None. |
|
| InvoiceDetailIdentifierGuid | globally unique identifier |
None. |
|
| Created | date |
None. |
|
| CreditReason | CreditDetailReason |
None. |
|
| InventoryReason | InventoryReasons |
None. |
|
| Notes | string |
None. |
|
| OrderByWeight | boolean |
None. |
|
| SoldByWeight | boolean |
None. |
|
| CartonQuantity | integer |
None. |
|
| Units | integer |
None. |
|
| Cartons | integer |
None. |
|
| Weight | integer |
None. |
|
| CostGstPercent | integer |
None. |
|
| Amount | integer |
None. |
|
| ExtendedAmount | integer |
None. |
|
| CostDecimals | integer |
None. |
|
| RequestedUnits | integer |
None. |
|
| RequestedCartons | integer |
None. |
|
| RequestedWeight | integer |
None. |
|
| MovementQty | integer |
None. |
|
| MovementQtyPacks | integer |
None. |
|
| UpdatedInventory | boolean |
None. |
|
| Deleted | boolean |
None. |
|
| Updated | date |
None. |
|
| ProductActive | boolean |
Relation. This field may not always be loaded or used for updates. |
|
| ProductDescription | string |
Relation. This field may not always be loaded or used for updates. |
|
| ProductBarcode | string |
Relation. This field may not always be loaded or used for updates. |
|
| InventoryReasonDescription | string |
Relation. This field may not always be loaded or used for updates. |
|
| OrderOrderedUnits | integer |
Relation. This field may not always be loaded or used for updates. |
|
| OrderOrderedCartons | integer |
Relation. This field may not always be loaded or used for updates. |
|
| OrderOrderedWeight | decimal number |
Relation. This field may not always be loaded or used for updates. |
|
| OrderReceivedUnits | integer |
Relation. This field may not always be loaded or used for updates. |
|
| OrderReceivedCartons | integer |
Relation. This field may not always be loaded or used for updates. |
|
| OrderReceivedWeight | decimal number |
Relation. This field may not always be loaded or used for updates. |
|
| InvoiceUnitsSupplied | integer |
Relation. This field may not always be loaded or used for updates. |
|
| InvoiceUnitsReceived | integer |
Relation. This field may not always be loaded or used for updates. |
|
| InvoiceWeightShipped | decimal number |
Relation. This field may not always be loaded or used for updates. |
|
| InvoiceWeightReceived | decimal number |
Relation. This field may not always be loaded or used for updates. |
|
| Images | boolean |
Relation. This field may not always be loaded or used for updates. |
|
| CalculateExtended |
When set to true, saving Credit Detail will calculate the ExtendedAmount |
boolean |
Relation. This field may not always be loaded or used for updates. |
| PopulateImages |
When set to true, copy credit detail receive images from source records |
boolean |
Relation. This field may not always be loaded or used for updates. |
Request Formats
application/json, text/json
{
"creditNoteIdentifier": "oPvkZYTuIUGLYBchuqKFOg==",
"creditNoteGuid": "65e4fba0-ee84-4121-8b60-1721baa2853a",
"creditDetailIdentifier": "w8wN0XQLt0eh7wEi6KHagw==",
"creditDetailIdentifierGuid": "d10dccc3-0b74-47b7-a1ef-0122e8a1da83",
"pluG_UID": "aHZwAFBIVUiLzy/OwnjiKQ==",
"pluGuid": "00707668-4850-4855-8bcf-2fcec278e229",
"invoiceDetailIdentifier": "A8vXjg5BiU6IU4+gdsMbEg==",
"invoiceDetailIdentifierGuid": "8ed7cb03-410e-4e89-8853-8fa076c31b12",
"created": "2025-06-14T07:15:39.4995545",
"creditReason": 2,
"inventoryReason": 1,
"notes": "sample string 3",
"orderByWeight": true,
"soldByWeight": true,
"cartonQuantity": 6,
"units": 7,
"cartons": 8,
"weight": 9,
"costGstPercent": 10,
"amount": 11,
"extendedAmount": 12,
"costDecimals": 13,
"requestedUnits": 14,
"requestedCartons": 15,
"requestedWeight": 16,
"movementQty": 17,
"movementQtyPacks": 18,
"updatedInventory": true,
"deleted": true,
"updated": "2025-06-14T07:15:39.4995545",
"productActive": true,
"productDescription": "sample string 22",
"productBarcode": "sample string 23",
"inventoryReasonDescription": "sample string 24",
"orderOrderedUnits": 1,
"orderOrderedCartons": 1,
"orderOrderedWeight": 1.1,
"orderReceivedUnits": 1,
"orderReceivedCartons": 1,
"orderReceivedWeight": 1.1,
"invoiceUnitsSupplied": 1,
"invoiceUnitsReceived": 1,
"invoiceWeightShipped": 1.1,
"invoiceWeightReceived": 1.1,
"images": true,
"calculateExtended": true,
"populateImages": true
}
application/xml, text/xml
<CreditDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.CreditNotes"> <Amount>11</Amount> <CalculateExtended>true</CalculateExtended> <CartonQuantity>6</CartonQuantity> <Cartons>8</Cartons> <CostDecimals>13</CostDecimals> <CostGstPercent>10</CostGstPercent> <Created>2025-06-14T07:15:39.4995545+00:00</Created> <CreditDetailIdentifier>w8wN0XQLt0eh7wEi6KHagw==</CreditDetailIdentifier> <CreditDetailIdentifierGuid>d10dccc3-0b74-47b7-a1ef-0122e8a1da83</CreditDetailIdentifierGuid> <CreditNoteGuid>65e4fba0-ee84-4121-8b60-1721baa2853a</CreditNoteGuid> <CreditNoteIdentifier>oPvkZYTuIUGLYBchuqKFOg==</CreditNoteIdentifier> <CreditReason>2</CreditReason> <Deleted>true</Deleted> <ExtendedAmount>12</ExtendedAmount> <Images>true</Images> <InventoryReason>1</InventoryReason> <InventoryReasonDescription>sample string 24</InventoryReasonDescription> <InvoiceDetailIdentifier>A8vXjg5BiU6IU4+gdsMbEg==</InvoiceDetailIdentifier> <InvoiceDetailIdentifierGuid>8ed7cb03-410e-4e89-8853-8fa076c31b12</InvoiceDetailIdentifierGuid> <InvoiceUnitsReceived>1</InvoiceUnitsReceived> <InvoiceUnitsSupplied>1</InvoiceUnitsSupplied> <InvoiceWeightReceived>1.1</InvoiceWeightReceived> <InvoiceWeightShipped>1.1</InvoiceWeightShipped> <MovementQty>17</MovementQty> <MovementQtyPacks>18</MovementQtyPacks> <Notes>sample string 3</Notes> <OrderByWeight>true</OrderByWeight> <OrderOrderedCartons>1</OrderOrderedCartons> <OrderOrderedUnits>1</OrderOrderedUnits> <OrderOrderedWeight>1.1</OrderOrderedWeight> <OrderReceivedCartons>1</OrderReceivedCartons> <OrderReceivedUnits>1</OrderReceivedUnits> <OrderReceivedWeight>1.1</OrderReceivedWeight> <PLUG_UID>aHZwAFBIVUiLzy/OwnjiKQ==</PLUG_UID> <PluGuid>00707668-4850-4855-8bcf-2fcec278e229</PluGuid> <PopulateImages>true</PopulateImages> <ProductActive>true</ProductActive> <ProductBarcode>sample string 23</ProductBarcode> <ProductDescription>sample string 22</ProductDescription> <RequestedCartons>15</RequestedCartons> <RequestedUnits>14</RequestedUnits> <RequestedWeight>16</RequestedWeight> <SoldByWeight>true</SoldByWeight> <Units>7</Units> <Updated>2025-06-14T07:15:39.4995545+00:00</Updated> <UpdatedInventory>true</UpdatedInventory> <Weight>9</Weight> </CreditDetail>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
None.