Resume POS Sale

POST

https://api.npretail.app/:tenant/:environment/:company/pos/sale/:saleId/resume

POST

/:tenant/:environment/:company/pos/sale/:saleId/resume

curl -X POST https://api.npretail.app/tenant/environment/company/pos/sale/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/resume \
     -H "x-np-api-key: <NaviPartner API Key>"

201Created

{
  "saleId": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "receiptNo": "receiptNo",
  "posUnit": "posUnit",
  "posStore": "posStore",
  "date": "2023-01-15",
  "startTime": "2024-01-15T09:30:00Z",
  "customerNo": "customerNo",
  "salespersonCode": "salespersonCode",
  "vatBusinessPostingGroup": "vatBusinessPostingGroup",
  "genBusinessPostingGroup": "genBusinessPostingGroup",
  "saleLines": [
    {
      "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "sortKey": 1,
      "type": "Item",
      "code": "code",
      "variantCode": "variantCode",
      "description": "description",
      "quantity": 1.1,
      "unitPrice": 1.1,
      "discountPct": 1.1,
      "discountAmount": 1.1,
      "vatPercent": 1.1,
      "amountInclVat": 1.1,
      "amount": 1.1,
      "unitOfMeasure": "unitOfMeasure",
      "isAddon": true,
      "description2": "description2",
      "appliesToLine": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "deleted": true
    },
    {
      "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "sortKey": 1,
      "type": "Item",
      "code": "code",
      "variantCode": "variantCode",
      "description": "description",
      "quantity": 1.1,
      "unitPrice": 1.1,
      "discountPct": 1.1,
      "discountAmount": 1.1,
      "vatPercent": 1.1,
      "amountInclVat": 1.1,
      "amount": 1.1,
      "unitOfMeasure": "unitOfMeasure",
      "isAddon": true,
      "description2": "description2",
      "appliesToLine": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "deleted": true
    }
  ],
  "paymentLines": [
    {
      "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "sortKey": 1,
      "paymentMethodCode": "paymentMethodCode",
      "description": "description",
      "amountInclVat": 1.1,
      "deleted": true
    },
    {
      "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "sortKey": 1,
      "paymentMethodCode": "paymentMethodCode",
      "description": "description",
      "amountInclVat": 1.1,
      "deleted": true
    }
  ],
  "totalSalesAmountInclVat": 1.1,
  "totalPaymentAmount": 1.1
}

Restores a previously parked sale (Saved Sale Entry) to an active POS Sale on the POS unit assigned to the API user in User Setup. The Saved Sale Entry is deleted. Ticket identity is preserved across the park/resume round-trip. To resume the sale on a different unit, assign a different POS Unit to the API user in User Setup. Returns 404 if the parked sale does not exist. Returns 400 when: the API user has no User Setup record; the API user has no POS Unit assigned in User Setup; the resolved POS Unit is not open for sales; or loading the saved sale data fails (the active POS Sale is rolled back).

Authentication

x-np-api-keystring

API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

saleIdUUIDRequired

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

Response

This endpoint returns an object.

saleIdUUID

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

receiptNostring

posUnitstring

posStorestring

datedate

startTimedatetime

customerNostring

salespersonCodestring

vatBusinessPostingGroupstring

genBusinessPostingGroupstring

saleLineslist of objectsOptional

paymentLineslist of objectsOptional

totalSalesAmountInclVatdoubleOptional

Total amount of all sale lines including VAT (only present when withLines=true)

totalPaymentAmountdoubleOptional

Total amount of all payment lines (only present when withLines=true)

Authentication

Path parameters

Headers

Response