salesCreditMemoLine resource type

Important: Currently all requests to API v2.0 must append $schemaversion=2.0 to the request URL to work properly. This is to uptake the new improved $metadata model avaliable from Business Central 17. An update will be applied shortly to apply the schemaversion automatically to API v2.0. For all other APIs $schemaversion=1.0 will be the default, unless specified in the request URL with $schemaversion=2.0. A solution is being worked on, where the schemaversion will be defined in the extension.

Represents a sales credit memo line in Dynamics 365 Business Central.

Note

For information about enabling APIs for Dynamics NAV see Enabling the APIs for Dynamics 365 Business Central.

Methods

Method Return Type Description
GET salesCreditMemoLine salesCreditMemoLine Gets a sales credit memo line object.
DELETE salesCreditMemoLine none Deletes a sales credit memo line object.
POST salesCreditMemoLine salesCreditMemoLine Creates a sales credit memo line object.
PATCH salesCreditMemoLine salesCreditMemoLine Updates a sales credit memo line object.
Navigation Return Type Description
salesCreditMemo salesCreditMemo Gets the salescreditmemo of the salesCreditMemoLine.
item item Gets the item of the salesCreditMemoLine.
account account Gets the account of the salesCreditMemoLine.
unitOfMeasure unitOfMeasure Gets the unitofmeasure of the salesCreditMemoLine.
itemVariant itemVariant Gets the itemvariant of the salesCreditMemoLine.
dimensionSetLines dimensionSetLines Gets the dimensionsetlines of the salesCreditMemoLine.

Properties

Property Type Description
id GUID The unique ID of the sales credit memo line. Non-editable.
documentId GUID The ID of the parent sales credit memo line.
sequence integer The line sequence number.
itemId GUID The ID of the item in the sales credit memo line.
accountId GUID The id of the account that the sales credit memo line is related to.
lineType NAV.invoiceLineAggLineType The type of the sales credit memo line. It can be "Comment", "Account", "Item", "Resource" Value", "Fixed Asset" or "Charge".
lineObjectNumber string The number of the object (account or item) of the sales credit memo line.
description string Specifies the description of the sales credit memo line.
unitOfMeasureId GUID The ID of unit of measure for the sales credit memo line.
unitOfMeasureCode string The code of unit of measure for the sales credit memo line.
unitPrice decimal Specifies the price for one unit of the item in the specified sales credit memo line.
quantity decimal The quantity of the item in the sales credit memo line.
discountAmount decimal The sales credit memo line discount amount.
discountPercent decimal The line discount percent.
discountAppliedBeforeTax boolean Specifies whether the discount is applied before tax.
amountExcludingTax decimal The line amount excluding the tax. Read-Only.
taxCode string The tax code for the line.
taxPercent decimal The tax percent for the line. Read-Only.
totalTaxAmount decimal The total tax amount for the sales credit memo line. Read-Only.
amountIncludingTax decimal The total amount for the line including tax. Read-Only.
invoiceDiscountAllocation decimal The sales credit memo line discount allocation is the sales credit memo line discount distributed on the total amount. Read-Only.
netAmount decimal The net amount is the amount including all discounts (taken from the sales credit memo line). Read-Only.
netTaxAmount decimal The net tax amount is the tax amount calculated from net amount. Read-Only.
netAmountIncludingTax decimal The net amount including tax is the total net amount including tax. Read-Only.
shipmentDate date The date the item in the line is expected to ship.
itemVariantId GUID The ID of the item variant in the sales credit memo line.

JSON representation

Here is a JSON representation of the salesCreditMemoLine resource.

{
    "id": "GUID",
    "documentId": "GUID",
    "sequence": "integer",
    "itemId": "GUID",
    "accountId": "GUID",
    "lineType": "NAV.invoiceLineAggLineType",
    "lineObjectNumber": "string",
    "description": "string",
    "unitOfMeasureId": "GUID",
    "unitOfMeasureCode": "string",
    "unitPrice": "decimal",
    "quantity": "decimal",
    "discountAmount": "decimal",
    "discountPercent": "decimal",
    "discountAppliedBeforeTax": "boolean",
    "amountExcludingTax": "decimal",
    "taxCode": "string",
    "taxPercent": "decimal",
    "totalTaxAmount": "decimal",
    "amountIncludingTax": "decimal",
    "invoiceDiscountAllocation": "decimal",
    "netAmount": "decimal",
    "netTaxAmount": "decimal",
    "netAmountIncludingTax": "decimal",
    "shipmentDate": "date",
    "itemVariantId": "GUID"
}

See Also

GET salesCreditMemoLine DELETE salesCreditMemoLine POST salesCreditMemoLine PATCH salesCreditMemoLine