Get using Id | NaviPartner | NP Retail API Documentation

1 curl https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%20International%20Ltd./pos/globalentry/4ca28ccc-e84b-4788-973c-c8ce5a59383b \ 2 -H "Authorization: Bearer <apiKey>"

1 { 2 "id": "4ca28ccc-e84b-4788-973c-c8ce5a59383b", 3 "posStore": "0321", 4 "posUnit": "POS-031", 5 "documentNo": "12345678", 6 "entryTime": "2024-12-25T12:43:56Z", 7 "entryType": "Direct Sale", 8 "postingDate": "2024-12-25", 9 "fiscalNumber": "F0078865", 10 "salesAmount": 649.9, 11 "discountAmount": 80, 12 "totalAmountExclVAT": 519.92, 13 "totalAmountInclVAT": 649.9, 14 "totalVATAmount": 129.98, 15 "company": "Sales Company", 16 "customerNo": "D000188", 17 "salesperson": "CLARK", 18 "currencyCode": "", 19 "currencyFactor": 1, 20 "salesLines": [ 21 { 22 "lineNo": 1, 23 "type": "Item", 24 "code": "80005", 25 "quantity": 1, 26 "returnedQuantity": 0, 27 "baseQuantity": 1, 28 "unitPrice": 249.9, 29 "vatPct": 25, 30 "lineDiscountPct": 0, 31 "lineDiscountAmountExclVAT": 0, 32 "lineDiscountAmountInclVAT": 0, 33 "lineAmount": 249.9, 34 "amountExclVAT": 199.92, 35 "amountInclVAT": 249.9, 36 "lineDiscountAmountExclVATLCY": 0, 37 "lineDiscountAmountInclVATLCY": 0, 38 "amountExclVATLCY": 199.92, 39 "amountInclVATLCY": 249.9, 40 "variantCode": "025", 41 "referenceNumber": "9780201379624", 42 "bomItemCode": "66", 43 "locationCode": "LOC-01", 44 "description": "Hummel Hamar Leggings", 45 "description2": "Co:BLUE Sz:L", 46 "unitOfMeasureCode": "PCS", 47 "currencyCode": "", 48 "globalReference": "D6E88A5E52E542F0AAA96F08F40B6EC9", 49 "extensionFields": [ 50 { 51 "fieldId": 50100, 52 "fieldValue": "value to apply to the custom field on sales line" 53 } 54 ] 55 }, 56 { 57 "lineNo": 2, 58 "type": "Item", 59 "code": "80006", 60 "quantity": 2, 61 "returnedQuantity": 1, 62 "baseQuantity": 2, 63 "unitPrice": 250, 64 "vatPct": 25, 65 "lineDiscountPct": 20, 66 "lineDiscountAmountExclVAT": 80, 67 "lineDiscountAmountInclVAT": 100, 68 "lineAmount": 400, 69 "amountExclVAT": 320, 70 "amountInclVAT": 400, 71 "lineDiscountAmountExclVATLCY": 80, 72 "lineDiscountAmountInclVATLCY": 100, 73 "amountExclVATLCY": 320, 74 "amountInclVATLCY": 400, 75 "variantCode": "L", 76 "referenceNumber": "9780201379648", 77 "locationCode": "LOC-01", 78 "description": "Hummel Alta T-shirt", 79 "description2": "Co:RED Sz:L", 80 "unitOfMeasureCode": "PCS", 81 "currencyCode": "", 82 "globalReference": "84E18BA8D5494605B605CD6192068FC2" 83 }, 84 { 85 "lineNo": 3, 86 "type": "Rounding", 87 "code": "ROUNDINGS", 88 "quantity": 1, 89 "returnedQuantity": 0, 90 "baseQuantity": 1, 91 "unitPrice": 0.1, 92 "vatPct": 0, 93 "lineDiscountPct": 0, 94 "lineDiscountAmountExclVAT": 0, 95 "lineDiscountAmountInclVAT": 0, 96 "lineAmount": 0, 97 "amountExclVAT": 0.1, 98 "amountInclVAT": 0.1, 99 "lineDiscountAmountExclVATLCY": 0, 100 "lineDiscountAmountInclVATLCY": 0, 101 "amountExclVATLCY": 0.1, 102 "amountInclVATLCY": 0.1, 103 "locationCode": "LOC-01", 104 "description": "Rounding", 105 "unitOfMeasureCode": "", 106 "currencyCode": "" 107 } 108 ], 109 "paymentLines": [ 110 { 111 "lineNo": 1, 112 "paymentMethod": "CASH", 113 "amountLCY": 650, 114 "amount": 650, 115 "documentNo": "12345678", 116 "description": "Cash payment", 117 "currencyCode": "", 118 "extensionFields": [ 119 { 120 "fieldId": 50100, 121 "fieldValue": "value to apply to custom field on payment line" 122 } 123 ] 124 } 125 ], 126 "posInfos": [ 127 { 128 "lineNo": 4, 129 "saleLineNo": 1, 130 "infoCode": "AFK", 131 "code": "123-ABC", 132 "description": "description", 133 "quantity": 1, 134 "price": 249.9, 135 "netAmount": 199.92, 136 "grossAmount": 249.9, 137 "discountAmount": 0, 138 "extensionFields": [ 139 { 140 "fieldId": 50100, 141 "fieldValue": "value to apply to custom field on pos info" 142 } 143 ] 144 } 145 ], 146 "extensionFields": [ 147 { 148 "fieldId": 50100, 149 "fieldValue": "value to apply to the custom field on pos entry" 150 } 151 ] 152 }

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

idUUIDRequired

The id of a Global Entry.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-api-versiondateOptional

Used for API versioning. More details.

Response

This endpoint returns an object.

idUUID

The id of a Global Entry.

posStorestring

Identification of the store

posUnitstring

Identification of the POS unit

documentNostring

Sales ticket no.

entryTimedatetime

entryTypeenum

Allowed values:

postingDatedate

fiscalNumberstring

salesAmountdouble

discountAmountdouble

totalAmountExclVATdouble

totalAmountInclVATdouble

totalVATAmountdouble

companystring or null

customerNostring or null

salespersonstring or null

currencyCodestring or null

currencyFactordouble or null

salesLineslist of objects or null

List of sold items

paymentLineslist of objects or null

List of payments

posInfoslist of objects or null

List of Info entries

extensionFieldslist of objects or null

Additional data. Definition of fieldId and format of data in fieldValue have to be agreed with receiver of data