NAnavipartner
pos > possale

Create Sale Line Addon

Changed on

Creates an addon line for an existing sale line. The API consumer must provide a unique GUID for the addon line ID. Use this endpoint when you need to add addons after the parent line has been created. Returns the saleId and a refresh object with SystemIds of updated entities and totals.

post/{tenant}/{environment}/{company}/pos/sale/{saleId}/saleline/{addonLineId}/addon

Request

  • Base URL
    https://api.npretail.app
  • Auth
    API key in header x-np-api-key

Path parameters

tenantstring required

Your Entra Tenant ID. More details.

environmentstring required

Your Business Central Environment. More details.

companystring required

Your Business Central Company. More details.

saleIdstring uuid required

The id of a POS sale. This can be provided by the API consumer when creating a new sale.

addonLineIdstring uuid required

The id of a sale line within a POS sale.

The unique GUID for this new addon line

Headers

x-api-versionstring date

Used for API versioning. More details.

Request body

parentLineIdstring uuid required

The id of a sale line within a POS sale.

addonNostring required

The addon configuration number

addonLineNointeger required

The specific line within the addon configuration

quantitynumber double

Quantity of the addon (defaults to 1)

selectedOptionLineNointeger

For Select-type addons, the selected option line number

Response

Response with status 201

saleIdstring uuid required

The id of a POS sale. This can be provided by the API consumer when creating a new sale.

receiptNostring required
posUnitstring required
posStorestring required
datestring date required
startTimestring date-time required
customerNostring required
salespersonCodestring required
vatBusinessPostingGroupstring required
genBusinessPostingGroupstring required
deletedSaleLinesstring[] required

Array of SystemIds (UUIDs) for sale lines that were deleted

deletedPaymentLinesstring[] required

Array of SystemIds (UUIDs) for payment lines that were deleted

totalSalesAmountInclVatnumber double required

Total amount of all sale lines including VAT

totalPaymentAmountnumber double required

Total amount of all payment lines

Changes

  • 48cacf22ffcdRevision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter x-np-api-key

    • info

      the endpoint scheme security NPApiKeyAuthScheme was added to the API

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      for the path request parameter addonLineId, the type was generalized from no type to string, and format from no format to uuid

    • info

      for the path request parameter saleId, the type was generalized from no type to string, and format from no format to uuid

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 407697660280Revision changes
    • info

      api operation id create-sale-line-addon removed and replaced with pos_possale_createSaleLineAddon