@simpleapps-com/augur-api 2026.10.31 → 2026.11.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (361) hide show
  1. package/README.md +84 -33
  2. package/SKILL.md +25 -24
  3. package/dist/client.d.ts +334 -0
  4. package/dist/client.d.ts.map +1 -0
  5. package/dist/core/base-client.d.ts +179 -0
  6. package/dist/core/base-client.d.ts.map +1 -0
  7. package/dist/core/call-rules.d.ts +73 -0
  8. package/dist/core/call-rules.d.ts.map +1 -0
  9. package/dist/core/call.d.ts +48 -0
  10. package/dist/core/call.d.ts.map +1 -0
  11. package/dist/core/client.d.ts +112 -0
  12. package/dist/core/client.d.ts.map +1 -0
  13. package/dist/core/common-schemas.d.ts +522 -0
  14. package/dist/core/common-schemas.d.ts.map +1 -0
  15. package/dist/core/config.d.ts +72 -0
  16. package/dist/core/config.d.ts.map +1 -0
  17. package/dist/core/encoded-segment.d.ts +23 -0
  18. package/dist/core/encoded-segment.d.ts.map +1 -0
  19. package/dist/core/errors.d.ts +91 -0
  20. package/dist/core/errors.d.ts.map +1 -0
  21. package/dist/core/http-rules.d.ts +64 -0
  22. package/dist/core/http-rules.d.ts.map +1 -0
  23. package/dist/core/path-validation.d.ts +28 -0
  24. package/dist/core/path-validation.d.ts.map +1 -0
  25. package/dist/core/proxy-rules.d.ts +21 -0
  26. package/dist/core/proxy-rules.d.ts.map +1 -0
  27. package/dist/core/registry-rules.d.ts +15 -0
  28. package/dist/core/registry-rules.d.ts.map +1 -0
  29. package/dist/core/registry-tables.d.ts +3 -0
  30. package/dist/core/registry-tables.d.ts.map +1 -0
  31. package/dist/core/registry.d.ts +54 -0
  32. package/dist/core/registry.d.ts.map +1 -0
  33. package/dist/core/response-rules.d.ts +19 -0
  34. package/dist/core/response-rules.d.ts.map +1 -0
  35. package/dist/core/schemas.d.ts +70 -0
  36. package/dist/core/schemas.d.ts.map +1 -0
  37. package/dist/core/service-proxy.d.ts +81 -0
  38. package/dist/core/service-proxy.d.ts.map +1 -0
  39. package/dist/core/site-id-check.d.ts +6 -0
  40. package/dist/core/site-id-check.d.ts.map +1 -0
  41. package/dist/core/site-id.d.ts +15 -0
  42. package/dist/core/site-id.d.ts.map +1 -0
  43. package/dist/index.d.ts +71 -236
  44. package/dist/index.d.ts.map +1 -0
  45. package/dist/index.js +19875 -18513
  46. package/dist/index.js.map +1 -1
  47. package/dist/index.mjs +19874 -18513
  48. package/dist/index.mjs.map +1 -1
  49. package/dist/services/agr-info/client.d.ts +71 -0
  50. package/dist/services/agr-info/client.d.ts.map +1 -0
  51. package/dist/services/agr-info/generated/endpoints.d.ts +41 -0
  52. package/dist/services/agr-info/generated/endpoints.d.ts.map +1 -0
  53. package/dist/services/agr-info/generated/schemas.d.ts +297 -0
  54. package/dist/services/agr-info/generated/schemas.d.ts.map +1 -0
  55. package/dist/services/agr-info/generated/types.d.ts +1093 -0
  56. package/dist/services/agr-info/generated/types.d.ts.map +1 -0
  57. package/dist/services/agr-info/index.d.ts +2 -0
  58. package/dist/services/agr-info/index.d.ts.map +1 -0
  59. package/dist/services/agr-int/client.d.ts +100 -0
  60. package/dist/services/agr-int/client.d.ts.map +1 -0
  61. package/dist/services/agr-int/generated/endpoints.d.ts +42 -0
  62. package/dist/services/agr-int/generated/endpoints.d.ts.map +1 -0
  63. package/dist/services/agr-int/generated/schemas.d.ts +595 -0
  64. package/dist/services/agr-int/generated/schemas.d.ts.map +1 -0
  65. package/dist/services/agr-int/generated/types.d.ts +1984 -0
  66. package/dist/services/agr-int/generated/types.d.ts.map +1 -0
  67. package/dist/services/agr-int/index.d.ts +2 -0
  68. package/dist/services/agr-int/index.d.ts.map +1 -0
  69. package/dist/services/agr-site/client.d.ts +112 -0
  70. package/dist/services/agr-site/client.d.ts.map +1 -0
  71. package/dist/services/agr-site/generated/endpoints.d.ts +42 -0
  72. package/dist/services/agr-site/generated/endpoints.d.ts.map +1 -0
  73. package/dist/services/agr-site/generated/schemas.d.ts +537 -0
  74. package/dist/services/agr-site/generated/schemas.d.ts.map +1 -0
  75. package/dist/services/agr-site/generated/types.d.ts +1732 -0
  76. package/dist/services/agr-site/generated/types.d.ts.map +1 -0
  77. package/dist/services/agr-site/index.d.ts +2 -0
  78. package/dist/services/agr-site/index.d.ts.map +1 -0
  79. package/dist/services/agr-work/client.d.ts +23 -0
  80. package/dist/services/agr-work/client.d.ts.map +1 -0
  81. package/dist/services/agr-work/generated/endpoints.d.ts +41 -0
  82. package/dist/services/agr-work/generated/endpoints.d.ts.map +1 -0
  83. package/dist/services/agr-work/generated/schemas.d.ts +21 -0
  84. package/dist/services/agr-work/generated/schemas.d.ts.map +1 -0
  85. package/dist/services/agr-work/generated/types.d.ts +19 -0
  86. package/dist/services/agr-work/generated/types.d.ts.map +1 -0
  87. package/dist/services/agr-work/index.d.ts +2 -0
  88. package/dist/services/agr-work/index.d.ts.map +1 -0
  89. package/dist/services/avalara/client.d.ts +33 -0
  90. package/dist/services/avalara/client.d.ts.map +1 -0
  91. package/dist/services/avalara/generated/endpoints.d.ts +41 -0
  92. package/dist/services/avalara/generated/endpoints.d.ts.map +1 -0
  93. package/dist/services/avalara/generated/schemas.d.ts +22 -0
  94. package/dist/services/avalara/generated/schemas.d.ts.map +1 -0
  95. package/dist/services/avalara/generated/types.d.ts +103 -0
  96. package/dist/services/avalara/generated/types.d.ts.map +1 -0
  97. package/dist/services/avalara/index.d.ts +2 -0
  98. package/dist/services/avalara/index.d.ts.map +1 -0
  99. package/dist/services/basecamp2/client.d.ts +92 -0
  100. package/dist/services/basecamp2/client.d.ts.map +1 -0
  101. package/dist/services/basecamp2/generated/endpoints.d.ts +42 -0
  102. package/dist/services/basecamp2/generated/endpoints.d.ts.map +1 -0
  103. package/dist/services/basecamp2/generated/schemas.d.ts +845 -0
  104. package/dist/services/basecamp2/generated/schemas.d.ts.map +1 -0
  105. package/dist/services/basecamp2/generated/types.d.ts +1587 -0
  106. package/dist/services/basecamp2/generated/types.d.ts.map +1 -0
  107. package/dist/services/basecamp2/index.d.ts +2 -0
  108. package/dist/services/basecamp2/index.d.ts.map +1 -0
  109. package/dist/services/brand-folder/client.d.ts +37 -0
  110. package/dist/services/brand-folder/client.d.ts.map +1 -0
  111. package/dist/services/brand-folder/generated/endpoints.d.ts +41 -0
  112. package/dist/services/brand-folder/generated/endpoints.d.ts.map +1 -0
  113. package/dist/services/brand-folder/generated/schemas.d.ts +81 -0
  114. package/dist/services/brand-folder/generated/schemas.d.ts.map +1 -0
  115. package/dist/services/brand-folder/generated/types.d.ts +195 -0
  116. package/dist/services/brand-folder/generated/types.d.ts.map +1 -0
  117. package/dist/services/brand-folder/index.d.ts +2 -0
  118. package/dist/services/brand-folder/index.d.ts.map +1 -0
  119. package/dist/services/commerce/client.d.ts +57 -0
  120. package/dist/services/commerce/client.d.ts.map +1 -0
  121. package/dist/services/commerce/generated/endpoints.d.ts +42 -0
  122. package/dist/services/commerce/generated/endpoints.d.ts.map +1 -0
  123. package/dist/services/commerce/generated/schemas.d.ts +319 -0
  124. package/dist/services/commerce/generated/schemas.d.ts.map +1 -0
  125. package/dist/services/commerce/generated/types.d.ts +1134 -0
  126. package/dist/services/commerce/generated/types.d.ts.map +1 -0
  127. package/dist/services/commerce/index.d.ts +2 -0
  128. package/dist/services/commerce/index.d.ts.map +1 -0
  129. package/dist/services/customers/client.d.ts +162 -0
  130. package/dist/services/customers/client.d.ts.map +1 -0
  131. package/dist/services/customers/generated/endpoints.d.ts +42 -0
  132. package/dist/services/customers/generated/endpoints.d.ts.map +1 -0
  133. package/dist/services/customers/generated/schemas.d.ts +1970 -0
  134. package/dist/services/customers/generated/schemas.d.ts.map +1 -0
  135. package/dist/services/customers/generated/types.d.ts +3849 -0
  136. package/dist/services/customers/generated/types.d.ts.map +1 -0
  137. package/dist/services/customers/index.d.ts +2 -0
  138. package/dist/services/customers/index.d.ts.map +1 -0
  139. package/dist/services/goog-mc/client.d.ts +44 -0
  140. package/dist/services/goog-mc/client.d.ts.map +1 -0
  141. package/dist/services/goog-mc/generated/endpoints.d.ts +42 -0
  142. package/dist/services/goog-mc/generated/endpoints.d.ts.map +1 -0
  143. package/dist/services/goog-mc/generated/schemas.d.ts +175 -0
  144. package/dist/services/goog-mc/generated/schemas.d.ts.map +1 -0
  145. package/dist/services/goog-mc/generated/types.d.ts +361 -0
  146. package/dist/services/goog-mc/generated/types.d.ts.map +1 -0
  147. package/dist/services/goog-mc/index.d.ts +2 -0
  148. package/dist/services/goog-mc/index.d.ts.map +1 -0
  149. package/dist/services/gregorovich/client.d.ts +34 -0
  150. package/dist/services/gregorovich/client.d.ts.map +1 -0
  151. package/dist/services/gregorovich/generated/endpoints.d.ts +42 -0
  152. package/dist/services/gregorovich/generated/endpoints.d.ts.map +1 -0
  153. package/dist/services/gregorovich/generated/schemas.d.ts +35 -0
  154. package/dist/services/gregorovich/generated/schemas.d.ts.map +1 -0
  155. package/dist/services/gregorovich/generated/types.d.ts +70 -0
  156. package/dist/services/gregorovich/generated/types.d.ts.map +1 -0
  157. package/dist/services/gregorovich/index.d.ts +2 -0
  158. package/dist/services/gregorovich/index.d.ts.map +1 -0
  159. package/dist/services/items/client.d.ts +453 -0
  160. package/dist/services/items/client.d.ts.map +1 -0
  161. package/dist/services/items/generated/endpoints.d.ts +42 -0
  162. package/dist/services/items/generated/endpoints.d.ts.map +1 -0
  163. package/dist/services/items/generated/schemas.d.ts +4636 -0
  164. package/dist/services/items/generated/schemas.d.ts.map +1 -0
  165. package/dist/services/items/generated/types.d.ts +10513 -0
  166. package/dist/services/items/generated/types.d.ts.map +1 -0
  167. package/dist/services/items/index.d.ts +2 -0
  168. package/dist/services/items/index.d.ts.map +1 -0
  169. package/dist/services/joomla/client.d.ts +74 -0
  170. package/dist/services/joomla/client.d.ts.map +1 -0
  171. package/dist/services/joomla/generated/endpoints.d.ts +41 -0
  172. package/dist/services/joomla/generated/endpoints.d.ts.map +1 -0
  173. package/dist/services/joomla/generated/schemas.d.ts +546 -0
  174. package/dist/services/joomla/generated/schemas.d.ts.map +1 -0
  175. package/dist/services/joomla/generated/types.d.ts +1489 -0
  176. package/dist/services/joomla/generated/types.d.ts.map +1 -0
  177. package/dist/services/joomla/index.d.ts +2 -0
  178. package/dist/services/joomla/index.d.ts.map +1 -0
  179. package/dist/services/legacy/client.d.ts +75 -0
  180. package/dist/services/legacy/client.d.ts.map +1 -0
  181. package/dist/services/legacy/generated/endpoints.d.ts +41 -0
  182. package/dist/services/legacy/generated/endpoints.d.ts.map +1 -0
  183. package/dist/services/legacy/generated/schemas.d.ts +567 -0
  184. package/dist/services/legacy/generated/schemas.d.ts.map +1 -0
  185. package/dist/services/legacy/generated/types.d.ts +1454 -0
  186. package/dist/services/legacy/generated/types.d.ts.map +1 -0
  187. package/dist/services/legacy/index.d.ts +2 -0
  188. package/dist/services/legacy/index.d.ts.map +1 -0
  189. package/dist/services/logistics/client.d.ts +64 -0
  190. package/dist/services/logistics/client.d.ts.map +1 -0
  191. package/dist/services/logistics/generated/endpoints.d.ts +41 -0
  192. package/dist/services/logistics/generated/endpoints.d.ts.map +1 -0
  193. package/dist/services/logistics/generated/schemas.d.ts +375 -0
  194. package/dist/services/logistics/generated/schemas.d.ts.map +1 -0
  195. package/dist/services/logistics/generated/types.d.ts +925 -0
  196. package/dist/services/logistics/generated/types.d.ts.map +1 -0
  197. package/dist/services/logistics/index.d.ts +2 -0
  198. package/dist/services/logistics/index.d.ts.map +1 -0
  199. package/dist/services/markets/client.d.ts +47 -0
  200. package/dist/services/markets/client.d.ts.map +1 -0
  201. package/dist/services/markets/generated/endpoints.d.ts +41 -0
  202. package/dist/services/markets/generated/endpoints.d.ts.map +1 -0
  203. package/dist/services/markets/generated/schemas.d.ts +180 -0
  204. package/dist/services/markets/generated/schemas.d.ts.map +1 -0
  205. package/dist/services/markets/generated/types.d.ts +405 -0
  206. package/dist/services/markets/generated/types.d.ts.map +1 -0
  207. package/dist/services/markets/index.d.ts +2 -0
  208. package/dist/services/markets/index.d.ts.map +1 -0
  209. package/dist/services/notifications/client.d.ts +58 -0
  210. package/dist/services/notifications/client.d.ts.map +1 -0
  211. package/dist/services/notifications/generated/endpoints.d.ts +41 -0
  212. package/dist/services/notifications/generated/endpoints.d.ts.map +1 -0
  213. package/dist/services/notifications/generated/schemas.d.ts +247 -0
  214. package/dist/services/notifications/generated/schemas.d.ts.map +1 -0
  215. package/dist/services/notifications/generated/types.d.ts +666 -0
  216. package/dist/services/notifications/generated/types.d.ts.map +1 -0
  217. package/dist/services/notifications/index.d.ts +2 -0
  218. package/dist/services/notifications/index.d.ts.map +1 -0
  219. package/dist/services/open-search/client.d.ts +69 -0
  220. package/dist/services/open-search/client.d.ts.map +1 -0
  221. package/dist/services/open-search/generated/endpoints.d.ts +42 -0
  222. package/dist/services/open-search/generated/endpoints.d.ts.map +1 -0
  223. package/dist/services/open-search/generated/schemas.d.ts +363 -0
  224. package/dist/services/open-search/generated/schemas.d.ts.map +1 -0
  225. package/dist/services/open-search/generated/types.d.ts +983 -0
  226. package/dist/services/open-search/generated/types.d.ts.map +1 -0
  227. package/dist/services/open-search/index.d.ts +2 -0
  228. package/dist/services/open-search/index.d.ts.map +1 -0
  229. package/dist/services/orders/client.d.ts +180 -0
  230. package/dist/services/orders/client.d.ts.map +1 -0
  231. package/dist/services/orders/generated/endpoints.d.ts +42 -0
  232. package/dist/services/orders/generated/endpoints.d.ts.map +1 -0
  233. package/dist/services/orders/generated/schemas.d.ts +2479 -0
  234. package/dist/services/orders/generated/schemas.d.ts.map +1 -0
  235. package/dist/services/orders/generated/types.d.ts +4717 -0
  236. package/dist/services/orders/generated/types.d.ts.map +1 -0
  237. package/dist/services/orders/index.d.ts +2 -0
  238. package/dist/services/orders/index.d.ts.map +1 -0
  239. package/dist/services/p21-apis/client.d.ts +59 -0
  240. package/dist/services/p21-apis/client.d.ts.map +1 -0
  241. package/dist/services/p21-apis/generated/endpoints.d.ts +41 -0
  242. package/dist/services/p21-apis/generated/endpoints.d.ts.map +1 -0
  243. package/dist/services/p21-apis/generated/schemas.d.ts +46 -0
  244. package/dist/services/p21-apis/generated/schemas.d.ts.map +1 -0
  245. package/dist/services/p21-apis/generated/types.d.ts +246 -0
  246. package/dist/services/p21-apis/generated/types.d.ts.map +1 -0
  247. package/dist/services/p21-apis/index.d.ts +2 -0
  248. package/dist/services/p21-apis/index.d.ts.map +1 -0
  249. package/dist/services/p21-core/client.d.ts +131 -0
  250. package/dist/services/p21-core/client.d.ts.map +1 -0
  251. package/dist/services/p21-core/generated/endpoints.d.ts +42 -0
  252. package/dist/services/p21-core/generated/endpoints.d.ts.map +1 -0
  253. package/dist/services/p21-core/generated/schemas.d.ts +1478 -0
  254. package/dist/services/p21-core/generated/schemas.d.ts.map +1 -0
  255. package/dist/services/p21-core/generated/types.d.ts +2718 -0
  256. package/dist/services/p21-core/generated/types.d.ts.map +1 -0
  257. package/dist/services/p21-core/index.d.ts +2 -0
  258. package/dist/services/p21-core/index.d.ts.map +1 -0
  259. package/dist/services/p21-pim/client.d.ts +75 -0
  260. package/dist/services/p21-pim/client.d.ts.map +1 -0
  261. package/dist/services/p21-pim/generated/endpoints.d.ts +41 -0
  262. package/dist/services/p21-pim/generated/endpoints.d.ts.map +1 -0
  263. package/dist/services/p21-pim/generated/schemas.d.ts +383 -0
  264. package/dist/services/p21-pim/generated/schemas.d.ts.map +1 -0
  265. package/dist/services/p21-pim/generated/types.d.ts +933 -0
  266. package/dist/services/p21-pim/generated/types.d.ts.map +1 -0
  267. package/dist/services/p21-pim/index.d.ts +2 -0
  268. package/dist/services/p21-pim/index.d.ts.map +1 -0
  269. package/dist/services/p21-sism/client.d.ts +432 -0
  270. package/dist/services/p21-sism/client.d.ts.map +1 -0
  271. package/dist/services/p21-sism/generated/endpoints.d.ts +42 -0
  272. package/dist/services/p21-sism/generated/endpoints.d.ts.map +1 -0
  273. package/dist/services/p21-sism/generated/schemas.d.ts +2844 -0
  274. package/dist/services/p21-sism/generated/schemas.d.ts.map +1 -0
  275. package/dist/services/p21-sism/generated/types.d.ts +6977 -0
  276. package/dist/services/p21-sism/generated/types.d.ts.map +1 -0
  277. package/dist/services/p21-sism/index.d.ts +37 -0
  278. package/dist/services/p21-sism/index.d.ts.map +1 -0
  279. package/dist/services/payments/client.d.ts +77 -0
  280. package/dist/services/payments/client.d.ts.map +1 -0
  281. package/dist/services/payments/generated/endpoints.d.ts +42 -0
  282. package/dist/services/payments/generated/endpoints.d.ts.map +1 -0
  283. package/dist/services/payments/generated/schemas.d.ts +1015 -0
  284. package/dist/services/payments/generated/schemas.d.ts.map +1 -0
  285. package/dist/services/payments/generated/types.d.ts +1432 -0
  286. package/dist/services/payments/generated/types.d.ts.map +1 -0
  287. package/dist/services/payments/index.d.ts +2 -0
  288. package/dist/services/payments/index.d.ts.map +1 -0
  289. package/dist/services/pricing/client.d.ts +216 -0
  290. package/dist/services/pricing/client.d.ts.map +1 -0
  291. package/dist/services/pricing/generated/endpoints.d.ts +42 -0
  292. package/dist/services/pricing/generated/endpoints.d.ts.map +1 -0
  293. package/dist/services/pricing/generated/schemas.d.ts +2048 -0
  294. package/dist/services/pricing/generated/schemas.d.ts.map +1 -0
  295. package/dist/services/pricing/generated/types.d.ts +4257 -0
  296. package/dist/services/pricing/generated/types.d.ts.map +1 -0
  297. package/dist/services/pricing/index.d.ts +2 -0
  298. package/dist/services/pricing/index.d.ts.map +1 -0
  299. package/dist/services/shipping/client.d.ts +33 -0
  300. package/dist/services/shipping/client.d.ts.map +1 -0
  301. package/dist/services/shipping/generated/endpoints.d.ts +41 -0
  302. package/dist/services/shipping/generated/endpoints.d.ts.map +1 -0
  303. package/dist/services/shipping/generated/schemas.d.ts +29 -0
  304. package/dist/services/shipping/generated/schemas.d.ts.map +1 -0
  305. package/dist/services/shipping/generated/types.d.ts +116 -0
  306. package/dist/services/shipping/generated/types.d.ts.map +1 -0
  307. package/dist/services/shipping/index.d.ts +2 -0
  308. package/dist/services/shipping/index.d.ts.map +1 -0
  309. package/dist/services/smarty-streets/client.d.ts +33 -0
  310. package/dist/services/smarty-streets/client.d.ts.map +1 -0
  311. package/dist/services/smarty-streets/generated/endpoints.d.ts +41 -0
  312. package/dist/services/smarty-streets/generated/endpoints.d.ts.map +1 -0
  313. package/dist/services/smarty-streets/generated/schemas.d.ts +72 -0
  314. package/dist/services/smarty-streets/generated/schemas.d.ts.map +1 -0
  315. package/dist/services/smarty-streets/generated/types.d.ts +145 -0
  316. package/dist/services/smarty-streets/generated/types.d.ts.map +1 -0
  317. package/dist/services/smarty-streets/index.d.ts +2 -0
  318. package/dist/services/smarty-streets/index.d.ts.map +1 -0
  319. package/dist/services/ups/client.d.ts +32 -0
  320. package/dist/services/ups/client.d.ts.map +1 -0
  321. package/dist/services/ups/generated/endpoints.d.ts +40 -0
  322. package/dist/services/ups/generated/endpoints.d.ts.map +1 -0
  323. package/dist/services/ups/generated/schemas.d.ts +51 -0
  324. package/dist/services/ups/generated/schemas.d.ts.map +1 -0
  325. package/dist/services/ups/generated/types.d.ts +98 -0
  326. package/dist/services/ups/generated/types.d.ts.map +1 -0
  327. package/dist/services/ups/index.d.ts +2 -0
  328. package/dist/services/ups/index.d.ts.map +1 -0
  329. package/dist/services/vendors/client.d.ts +38 -0
  330. package/dist/services/vendors/client.d.ts.map +1 -0
  331. package/dist/services/vendors/generated/endpoints.d.ts +41 -0
  332. package/dist/services/vendors/generated/endpoints.d.ts.map +1 -0
  333. package/dist/services/vendors/generated/schemas.d.ts +350 -0
  334. package/dist/services/vendors/generated/schemas.d.ts.map +1 -0
  335. package/dist/services/vendors/generated/types.d.ts +470 -0
  336. package/dist/services/vendors/generated/types.d.ts.map +1 -0
  337. package/dist/services/vendors/index.d.ts +2 -0
  338. package/dist/services/vendors/index.d.ts.map +1 -0
  339. package/dist/services/vmi/client.d.ts +129 -0
  340. package/dist/services/vmi/client.d.ts.map +1 -0
  341. package/dist/services/vmi/generated/endpoints.d.ts +41 -0
  342. package/dist/services/vmi/generated/endpoints.d.ts.map +1 -0
  343. package/dist/services/vmi/generated/schemas.d.ts +723 -0
  344. package/dist/services/vmi/generated/schemas.d.ts.map +1 -0
  345. package/dist/services/vmi/generated/types.d.ts +2620 -0
  346. package/dist/services/vmi/generated/types.d.ts.map +1 -0
  347. package/dist/services/vmi/index.d.ts +2 -0
  348. package/dist/services/vmi/index.d.ts.map +1 -0
  349. package/dist/testing.d.ts +9 -13
  350. package/dist/testing.d.ts.map +1 -0
  351. package/dist/testing.js +7 -17
  352. package/dist/testing.js.map +1 -1
  353. package/dist/testing.mjs +7 -17
  354. package/dist/testing.mjs.map +1 -1
  355. package/dist/utils/cross-site-auth.d.ts +88 -0
  356. package/dist/utils/cross-site-auth.d.ts.map +1 -0
  357. package/package.json +34 -47
  358. package/dist/client-TPJa269Y.d.mts +0 -58610
  359. package/dist/client-TPJa269Y.d.ts +0 -58610
  360. package/dist/index.d.mts +0 -236
  361. package/dist/testing.d.mts +0 -83
@@ -0,0 +1,4717 @@
1
+ /**
2
+ * Generated types for the orders service.
3
+ * Order lifecycle management for sales orders, invoices, payments, RMAs, and accounts receivable
4
+ * from P21
5
+ *
6
+ * Public specs (the source of truth for every shape below):
7
+ * https://orders.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path, path
8
+ * params and query params, each with type and required flag. Grep it for a path; for a GET
9
+ * that line is all you need. Bodies are not in it.
10
+ * https://orders.augur-api.com/openapi.json: the full contract: request and response bodies field
11
+ * by field, descriptions, formats and documented errors.
12
+ * https://orders.augur-api.com/llms.txt: the plain-text endpoint list and the other Augur
13
+ * services.
14
+ *
15
+ * Source: shared/specs/orders.json
16
+ *
17
+ * DO NOT EDIT — regenerate with: pnpm -C tools/augur-api-generator generate ts
18
+ */
19
+ import type { EdgeCacheParams } from "../../../core/common-schemas";
20
+ import type { BaseResponse } from "../../../core/schemas";
21
+ /** Params for GET /apinv-hdr */
22
+ export interface ApinvHdrListParams extends EdgeCacheParams {
23
+ /** Filter by customer_id (apinv_hdr.customer_id) */
24
+ customerId?: number;
25
+ /** Filter by invoice_no (apinv_hdr.invoice_no) */
26
+ invoiceNo?: string;
27
+ /** Maximum rows to return (Default: 10) */
28
+ limit?: number;
29
+ /** Starting offset results (Default: 0) */
30
+ offset?: number;
31
+ /** Order By (Default: voucher_no|ASC) */
32
+ orderBy?: string;
33
+ /** Filter by payable_source_uid (apinv_hdr.payable_source_uid) */
34
+ payableSourceUid?: number;
35
+ /** Filter by po_no (apinv_hdr.po_no) */
36
+ poNo?: string;
37
+ /** Filter by ship_to_id (apinv_hdr.ship_to_id) */
38
+ shipToId?: number;
39
+ /** Filter by vendor_id (apinv_hdr.vendor_id) */
40
+ vendorId?: number;
41
+ /** Filter by voucher_reason_code_uid (apinv_hdr.voucher_reason_code_uid) */
42
+ voucherReasonCodeUid?: number;
43
+ /** Filter by warranty_claim_payments_uid (apinv_hdr.warranty_claim_payments_uid) */
44
+ warrantyClaimPaymentsUid?: number;
45
+ }
46
+ /** Params for GET /apinv-hdr/{voucherNo} */
47
+ export type ApinvHdrGetParams = EdgeCacheParams;
48
+ /** Params for GET /ar-payment-details */
49
+ export interface ArPaymentDetailsListParams extends EdgeCacheParams {
50
+ /** Filter by currency_line_uid (ar_payment_details.currency_line_uid) */
51
+ currencyLineUid?: number;
52
+ /** P21 delete flag to filter by: Y or N (Default: every row) */
53
+ deleteFlag?: string;
54
+ /** Filter by ewing_coupon_uid (ar_payment_details.ewing_coupon_uid) */
55
+ ewingCouponUid?: number;
56
+ /** Maximum rows to return (Default: 10) */
57
+ limit?: number;
58
+ /** Starting offset results (Default: 0) */
59
+ offset?: number;
60
+ /** Order By (Default: payment_number|ASC) */
61
+ orderBy?: string;
62
+ /** Filter by web_cc_processor_uid (ar_payment_details.web_cc_processor_uid) */
63
+ webCcProcessorUid?: number;
64
+ }
65
+ /** Params for GET /ar-payment-details/{paymentNumber} */
66
+ export type ArPaymentDetailsGetParams = EdgeCacheParams;
67
+ /** Params for GET /ar-receipts */
68
+ export interface ArReceiptsListParams extends EdgeCacheParams {
69
+ /** Filter by company_id (ar_receipts.company_id) */
70
+ companyId?: string;
71
+ /** P21 delete flag to filter by: Y or N (Default: every row) */
72
+ deleteFlag?: string;
73
+ /** Maximum rows to return (Default: 10) */
74
+ limit?: number;
75
+ /** Starting offset results (Default: 0) */
76
+ offset?: number;
77
+ /** Order By (Default: receipt_number|ASC) */
78
+ orderBy?: string;
79
+ }
80
+ /** Params for GET /ar-receipts-detail */
81
+ export interface ArReceiptsDetailListParams extends EdgeCacheParams {
82
+ /** Filter by company_id (ar_receipts_detail.company_id) */
83
+ companyId?: string;
84
+ /** Filter by customer_id (ar_receipts_detail.customer_id) */
85
+ customerId?: number;
86
+ /** P21 delete flag to filter by: Y or N (Default: every row) */
87
+ deleteFlag?: string;
88
+ /** Filter by invoice_no (ar_receipts_detail.invoice_no) */
89
+ invoiceNo?: string;
90
+ /** Maximum rows to return (Default: 10) */
91
+ limit?: number;
92
+ /** Starting offset results (Default: 0) */
93
+ offset?: number;
94
+ /** Order By (Default: receipt_number|ASC) */
95
+ orderBy?: string;
96
+ /** Filter by receipt_number (ar_receipts_detail.receipt_number) */
97
+ receiptNumber?: number;
98
+ }
99
+ /** Params for GET /ar-receipts/{receiptNumber} */
100
+ export type ArReceiptsGetParams = EdgeCacheParams;
101
+ /** Params for GET /document-line-bin */
102
+ export interface DocumentLineBinListParams extends EdgeCacheParams {
103
+ /** Maximum rows to return (Default: 10) */
104
+ limit?: number;
105
+ /** Starting offset results (Default: 0) */
106
+ offset?: number;
107
+ /** Order By (Default: document_line_bin_uid|ASC) */
108
+ orderBy?: string;
109
+ /** Filter by source_dlb_uid (document_line_bin.source_dlb_uid) */
110
+ sourceDlbUid?: number;
111
+ /** Filter by work_order_uid (document_line_bin.work_order_uid) */
112
+ workOrderUid?: number;
113
+ }
114
+ /** Params for GET /document-line-bin/{documentLineBinUid} */
115
+ export type DocumentLineBinGetParams = EdgeCacheParams;
116
+ /** Params for GET /document-line-lot */
117
+ export interface DocumentLineLotListParams extends EdgeCacheParams {
118
+ /** Filter by currentbin_uid (document_line_lot.currentbin_uid) */
119
+ currentbinUid?: number;
120
+ /** Filter by item_revision_uid (document_line_lot.item_revision_uid) */
121
+ itemRevisionUid?: number;
122
+ /** Maximum rows to return (Default: 10) */
123
+ limit?: number;
124
+ /** Filter by lot_uid (document_line_lot.lot_uid) */
125
+ lotUid?: number;
126
+ /** Starting offset results (Default: 0) */
127
+ offset?: number;
128
+ /** Order By (Default: document_line_lot_uid|ASC) */
129
+ orderBy?: string;
130
+ }
131
+ /** Params for GET /document-line-lot/{documentLineLotUid} */
132
+ export type DocumentLineLotGetParams = EdgeCacheParams;
133
+ /** Params for GET /document-line-serial */
134
+ export interface DocumentLineSerialListParams extends EdgeCacheParams {
135
+ /** Filter by deposit_bin_uid (document_line_serial.deposit_bin_uid) */
136
+ depositBinUid?: number;
137
+ /** Maximum rows to return (Default: 10) */
138
+ limit?: number;
139
+ /** Filter by lot_uid (document_line_serial.lot_uid) */
140
+ lotUid?: number;
141
+ /** Starting offset results (Default: 0) */
142
+ offset?: number;
143
+ /** Order By (Default: document_line_serial_uid|ASC) */
144
+ orderBy?: string;
145
+ /** Filter by rf_bin_uid (document_line_serial.rf_bin_uid) */
146
+ rfBinUid?: number;
147
+ /** Filter by serial_number_uid (document_line_serial.serial_number_uid) */
148
+ serialNumberUid?: number;
149
+ }
150
+ /** Params for GET /document-line-serial/{documentLineSerialUid} */
151
+ export type DocumentLineSerialGetParams = EdgeCacheParams;
152
+ /** Params for GET /import-suspense-hdr */
153
+ export interface ImportSuspenseHdrListParams extends EdgeCacheParams {
154
+ /** Maximum rows to return (Default: 10) */
155
+ limit?: number;
156
+ /** Starting offset results (Default: 0) */
157
+ offset?: number;
158
+ /** Order By (Default: import_suspense_hdr_uid|ASC) */
159
+ orderBy?: string;
160
+ }
161
+ /** Params for GET /import-suspense-hdr/{importSuspenseHdrUid} */
162
+ export type ImportSuspenseHdrGetParams = EdgeCacheParams;
163
+ /** Params for GET /import-suspense-line */
164
+ export interface ImportSuspenseLineListParams extends EdgeCacheParams {
165
+ /** Filter by company_id (import_suspense_line.company_id) */
166
+ companyId?: string;
167
+ /** Filter by customer_id (import_suspense_line.customer_id) */
168
+ customerId?: number;
169
+ /** Filter by import_suspense_hdr_uid (import_suspense_line.import_suspense_hdr_uid) */
170
+ importSuspenseHdrUid?: number;
171
+ /** Maximum rows to return (Default: 10) */
172
+ limit?: number;
173
+ /** Filter by location_id (import_suspense_line.location_id) */
174
+ locationId?: number;
175
+ /** Starting offset results (Default: 0) */
176
+ offset?: number;
177
+ /** Order By (Default: import_suspense_line_uid|ASC) */
178
+ orderBy?: string;
179
+ /**
180
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
181
+ * (704,705); -1 for every status. Default: 704
182
+ */
183
+ rowStatusFlag?: number | number[];
184
+ }
185
+ /** Params for GET /import-suspense-line/{importSuspenseLineUid} */
186
+ export type ImportSuspenseLineGetParams = EdgeCacheParams;
187
+ /** Params for GET /invoice-hdr */
188
+ export interface InvoiceHdrListParams extends EdgeCacheParams {
189
+ /** Filter by currency_line_uid (invoice_hdr.currency_line_uid) */
190
+ currencyLineUid?: number;
191
+ /** Filter by customer_id (invoice_hdr.customer_id) */
192
+ customerId?: string;
193
+ /** Filter by freight_code_uid (invoice_hdr.freight_code_uid) */
194
+ freightCodeUid?: number;
195
+ /** Filter by invoice_batch_uid (invoice_hdr.invoice_batch_uid) */
196
+ invoiceBatchUid?: number;
197
+ /** Maximum rows to return (Default: 10) */
198
+ limit?: number;
199
+ /** Starting offset results (Default: 0) */
200
+ offset?: number;
201
+ /** Order By (Default: invoice_no|ASC) */
202
+ orderBy?: string;
203
+ /** Filter by order_no (invoice_hdr.order_no) */
204
+ orderNo?: string;
205
+ /** Filter by po_no (invoice_hdr.po_no) */
206
+ poNo?: string;
207
+ /** Filter by reason_credit_memo_code_uid (invoice_hdr.reason_credit_memo_code_uid) */
208
+ reasonCreditMemoCodeUid?: number;
209
+ /** Filter by rebill_invoice_reason_uid (invoice_hdr.rebill_invoice_reason_uid) */
210
+ rebillInvoiceReasonUid?: number;
211
+ /** Filter by sales_market_group_uid (invoice_hdr.sales_market_group_uid) */
212
+ salesMarketGroupUid?: number;
213
+ /** Filter by ship_to_id (invoice_hdr.ship_to_id) */
214
+ shipToId?: number;
215
+ /** Filter by shipping_route_uid (invoice_hdr.shipping_route_uid) */
216
+ shippingRouteUid?: number;
217
+ /** Filter by sold_to_ah_uid (invoice_hdr.sold_to_ah_uid) */
218
+ soldToAhUid?: number;
219
+ /** Filter by source_credit_memo_code_uid (invoice_hdr.source_credit_memo_code_uid) */
220
+ sourceCreditMemoCodeUid?: number;
221
+ }
222
+ /** Params for GET /invoice-hdr/{invoiceNo} */
223
+ export type InvoiceHdrGetParams = EdgeCacheParams;
224
+ /** Params for GET /invoice-hdr/{invoiceNo}/reprint */
225
+ export type InvoiceHdrReprintListParams = EdgeCacheParams;
226
+ /** Params for GET /invoice-line */
227
+ export interface InvoiceLineListParams extends EdgeCacheParams {
228
+ /** Filter by company_id (invoice_line.company_id) */
229
+ companyId?: string;
230
+ /** Filter by customer_contract_uid (invoice_line.customer_contract_uid) */
231
+ customerContractUid?: number;
232
+ /** Filter by inv_mast_uid (invoice_line.inv_mast_uid) */
233
+ invMastUid?: number;
234
+ /** Filter by invoice_no (invoice_line.invoice_no) */
235
+ invoiceNo?: string;
236
+ /** Filter by item_id (invoice_line.item_id) */
237
+ itemId?: string;
238
+ /** Filter by job_price_line_uid (invoice_line.job_price_line_uid) */
239
+ jobPriceLineUid?: number;
240
+ /** Maximum rows to return (Default: 10) */
241
+ limit?: number;
242
+ /** Starting offset results (Default: 0) */
243
+ offset?: number;
244
+ /** Order By (Default: invoice_line_uid|ASC) */
245
+ orderBy?: string;
246
+ /** Filter by order_no (invoice_line.order_no) */
247
+ orderNo?: string;
248
+ /**
249
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
250
+ * (704,705); -1 for every status. Default: 704
251
+ */
252
+ statusCd?: number | number[];
253
+ /** Filter by supplier_id (invoice_line.supplier_id) */
254
+ supplierId?: number;
255
+ }
256
+ /** Params for GET /invoice-line/{invoiceLineUid} */
257
+ export type InvoiceLineGetParams = EdgeCacheParams;
258
+ /** Params for GET /oe-hdr */
259
+ export interface OeHdrListParams extends EdgeCacheParams {
260
+ /** Filter by address_id (oe_hdr.address_id) */
261
+ addressId?: number;
262
+ /** Filter by cancel_flag: Y or N (Default: N) */
263
+ cancelFlag?: string;
264
+ /** Filter by contact_id (oe_hdr.contact_id) */
265
+ contactId?: string;
266
+ /** Filter by customer_id (oe_hdr.customer_id) */
267
+ customerId?: number;
268
+ /** P21 delete flag to filter by: Y or N (Default: N) */
269
+ deleteFlag?: string;
270
+ /** Maximum rows to return (Default: 10) */
271
+ limit?: number;
272
+ /** Starting offset results (Default: 0) */
273
+ offset?: number;
274
+ /** Order By (Default: order_no|ASC) */
275
+ orderBy?: string;
276
+ /** Filter by projected_order: Y or N (Default: N) */
277
+ projectedOrder?: string;
278
+ /**
279
+ * Search text matched against order_no, po_no, web_reference_no, ship2_name and
280
+ * ship2_email_address
281
+ */
282
+ q?: string;
283
+ /**
284
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
285
+ * (704,705); -1 for every status. Default: 704
286
+ */
287
+ statusCd?: number | number[];
288
+ }
289
+ /** Params for GET /oe-hdr-notepad */
290
+ export interface OeHdrNotepadListParams extends EdgeCacheParams {
291
+ /** P21 delete flag to filter by: Y or N (Default: every row) */
292
+ deleteFlag?: string;
293
+ /** Maximum rows to return (Default: 10) */
294
+ limit?: number;
295
+ /** Starting offset results (Default: 0) */
296
+ offset?: number;
297
+ /** Order By (Default: note_id|ASC) */
298
+ orderBy?: string;
299
+ /** Filter by order_no (oe_hdr_notepad.order_no) */
300
+ orderNo?: string;
301
+ }
302
+ /** Params for GET /oe-hdr-notepad/{noteId} */
303
+ export type OeHdrNotepadGetParams = EdgeCacheParams;
304
+ /** Params for GET /oe-hdr-rma */
305
+ export interface OeHdrRmaListParams extends EdgeCacheParams {
306
+ /** Maximum rows to return (Default: 10) */
307
+ limit?: number;
308
+ /** Filter by oe_hdr_uid (oe_hdr_rma.oe_hdr_uid) */
309
+ oeHdrUid?: number;
310
+ /** Starting offset results (Default: 0) */
311
+ offset?: number;
312
+ /** Order By (Default: oe_hdr_rma_uid|ASC) */
313
+ orderBy?: string;
314
+ }
315
+ /** Params for GET /oe-hdr-rma/{oeHdrRmaUid} */
316
+ export type OeHdrRmaGetParams = EdgeCacheParams;
317
+ /** Params for GET /oe-hdr-salesrep */
318
+ export interface OeHdrSalesrepListParams extends EdgeCacheParams {
319
+ /** P21 delete flag to filter by: Y or N (Default: every row) */
320
+ deleteFlag?: string;
321
+ /** Maximum rows to return (Default: 10) */
322
+ limit?: number;
323
+ /** Starting offset results (Default: 0) */
324
+ offset?: number;
325
+ /** Order By (Default: order_number|ASC) */
326
+ orderBy?: string;
327
+ /** Filter by order_number (oe_hdr_salesrep.order_number) */
328
+ orderNumber?: string;
329
+ /** Filter by salesrep_id (oe_hdr_salesrep.salesrep_id) */
330
+ salesrepId?: string;
331
+ }
332
+ /** Params for GET /oe-hdr-ud */
333
+ export interface OeHdrUdListParams extends EdgeCacheParams {
334
+ /** Maximum rows to return (Default: 10) */
335
+ limit?: number;
336
+ /** Starting offset results (Default: 0) */
337
+ offset?: number;
338
+ /** Order By (Default: oe_hdr_ud_uid|ASC) */
339
+ orderBy?: string;
340
+ /** Filter by order_no (oe_hdr_ud.order_no) */
341
+ orderNo?: string;
342
+ }
343
+ /** Params for GET /oe-hdr-ud/{oeHdrUdUid} */
344
+ export type OeHdrUdGetParams = EdgeCacheParams;
345
+ /** Params for GET /oe-hdr/lookup */
346
+ export interface OeHdrLookupGetParams extends EdgeCacheParams {
347
+ /** Only orders for this Prophet 21 customer address */
348
+ addressId?: number;
349
+ /** Only orders with this order class 1 */
350
+ class1Id?: string;
351
+ /** Y for completed orders, N for open orders; ORed with dateOrderCompleted when both are sent */
352
+ completed?: string;
353
+ /** Orders completed after this date; ORed with completed when both are sent */
354
+ dateOrderCompleted?: string;
355
+ /** Maximum orders to return (default 10) */
356
+ limit?: number;
357
+ /** Orders to skip before the first one returned */
358
+ offset?: number;
359
+ /** Sort as column|ASC or column|DESC on an oe_hdr column (default order_no|ASC) */
360
+ orderBy?: string;
361
+ /**
362
+ * Text matched anywhere in the order number, PO number, web reference number, ship-to name or
363
+ * ship-to email
364
+ */
365
+ q?: string;
366
+ /** Only orders assigned to this salesrep (their 100 most recent) */
367
+ salesrepId?: string;
368
+ /**
369
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
370
+ * (704,705); -1 for every status. Default: every status
371
+ */
372
+ statusCd?: number | number[];
373
+ /** Only orders entered by this user */
374
+ taker?: string;
375
+ }
376
+ /** Params for GET /oe-hdr/{orderNo}/doc */
377
+ export interface OeHdrDocListParams extends EdgeCacheParams {
378
+ /**
379
+ * Ship-to postal code (first 5 digits); when sent, the order is returned only if it matches, else
380
+ * 400
381
+ */
382
+ postalCode?: string;
383
+ }
384
+ /** Params for GET /oe-line */
385
+ export interface OeLineListParams extends EdgeCacheParams {
386
+ /** Filter by cost_price_page_uid (oe_line.cost_price_page_uid) */
387
+ costPricePageUid?: number;
388
+ /** P21 delete flag to filter by: Y or N (Default: every row) */
389
+ deleteFlag?: string;
390
+ /** Filter by inv_mast_uid (oe_line.inv_mast_uid) */
391
+ invMastUid?: number;
392
+ /** Filter by job_price_bin_uid (oe_line.job_price_bin_uid) */
393
+ jobPriceBinUid?: number;
394
+ /** Filter by job_price_hdr_uid (oe_line.job_price_hdr_uid) */
395
+ jobPriceHdrUid?: number;
396
+ /** Filter by job_price_line_uid (oe_line.job_price_line_uid) */
397
+ jobPriceLineUid?: number;
398
+ /** Maximum rows to return (Default: 10) */
399
+ limit?: number;
400
+ /** Filter by line_no (oe_line.line_no) */
401
+ lineNo?: number;
402
+ /** Filter by oe_hdr_uid (oe_line.oe_hdr_uid) */
403
+ oeHdrUid?: number;
404
+ /** Starting offset results (Default: 0) */
405
+ offset?: number;
406
+ /** Order By (Default: oe_line_uid|ASC) */
407
+ orderBy?: string;
408
+ /** Filter by order_no (oe_line.order_no) */
409
+ orderNo?: string;
410
+ /** Filter by parent_oe_line_uid (oe_line.parent_oe_line_uid) */
411
+ parentOeLineUid?: number;
412
+ /** Filter by price_family_uid (oe_line.price_family_uid) */
413
+ priceFamilyUid?: number;
414
+ /** Filter by price_page_uid (oe_line.price_page_uid) */
415
+ pricePageUid?: number;
416
+ /**
417
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
418
+ * (704,705); -1 for every status. Default: 704
419
+ */
420
+ statusCd?: number | number[];
421
+ /** Filter by strategic_price_page_uid (oe_line.strategic_price_page_uid) */
422
+ strategicPricePageUid?: number;
423
+ }
424
+ /** Params for GET /oe-line-rma */
425
+ export interface OeLineRmaListParams extends EdgeCacheParams {
426
+ /** Filter by invoice_line_uid (oe_line_rma.invoice_line_uid) */
427
+ invoiceLineUid?: number;
428
+ /** Maximum rows to return (Default: 10) */
429
+ limit?: number;
430
+ /** Filter by oe_line_uid (oe_line_rma.oe_line_uid) */
431
+ oeLineUid?: number;
432
+ /** Starting offset results (Default: 0) */
433
+ offset?: number;
434
+ /** Order By (Default: oe_line_rma_uid|ASC) */
435
+ orderBy?: string;
436
+ /** Filter by rma_linked_oe_line_uid (oe_line_rma.rma_linked_oe_line_uid) */
437
+ rmaLinkedOeLineUid?: number;
438
+ /**
439
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
440
+ * (704,705); -1 for every status. Default: 704
441
+ */
442
+ rowStatusFlag?: number | number[];
443
+ }
444
+ /** Params for GET /oe-line-rma/{oeLineRmaUid} */
445
+ export type OeLineRmaGetParams = EdgeCacheParams;
446
+ /** Params for GET /oe-line-ud */
447
+ export interface OeLineUdListParams extends EdgeCacheParams {
448
+ /** Maximum rows to return (Default: 10) */
449
+ limit?: number;
450
+ /** Starting offset results (Default: 0) */
451
+ offset?: number;
452
+ /** Order By (Default: oe_line_ud_uid|ASC) */
453
+ orderBy?: string;
454
+ /** Filter by order_no (oe_line_ud.order_no) */
455
+ orderNo?: string;
456
+ }
457
+ /** Params for GET /oe-line-ud/{oeLineUdUid} */
458
+ export type OeLineUdGetParams = EdgeCacheParams;
459
+ /** Params for GET /oe-line/{oeLineUid} */
460
+ export type OeLineGetParams = EdgeCacheParams;
461
+ /** Params for GET /payment-detail */
462
+ export interface PaymentDetailListParams extends EdgeCacheParams {
463
+ /** Filter by invoice_no (payment_detail.invoice_no) */
464
+ invoiceNo?: string;
465
+ /** Maximum rows to return (Default: 10) */
466
+ limit?: number;
467
+ /** Starting offset results (Default: 0) */
468
+ offset?: number;
469
+ /** Order By (Default: payment_detail_uid|ASC) */
470
+ orderBy?: string;
471
+ /** Filter by po_no (payment_detail.po_no) */
472
+ poNo?: string;
473
+ }
474
+ /** Params for GET /payment-detail/{paymentDetailUid} */
475
+ export type PaymentDetailGetParams = EdgeCacheParams;
476
+ /** Params for GET /payments */
477
+ export interface PaymentsListParams extends EdgeCacheParams {
478
+ /** Filter by bank_no (payments.bank_no) */
479
+ bankNo?: number;
480
+ /** Filter by check_no (payments.check_no) */
481
+ checkNo?: string;
482
+ /** Filter by company_no (payments.company_no) */
483
+ companyNo?: string;
484
+ /** Maximum rows to return (Default: 10) */
485
+ limit?: number;
486
+ /** Starting offset results (Default: 0) */
487
+ offset?: number;
488
+ /** Order By (Default: bank_no|ASC) */
489
+ orderBy?: string;
490
+ /** Filter by vendor_id (payments.vendor_id) */
491
+ vendorId?: number;
492
+ }
493
+ /** Params for GET /pending-payments */
494
+ export interface PendingPaymentsListParams extends EdgeCacheParams {
495
+ /** Filter by company_id (pending_payments.company_id) */
496
+ companyId?: string;
497
+ /** Maximum rows to return (Default: 10) */
498
+ limit?: number;
499
+ /** Starting offset results (Default: 0) */
500
+ offset?: number;
501
+ /** Order By (Default: pending_payment_uid|ASC) */
502
+ orderBy?: string;
503
+ }
504
+ /** Params for GET /pending-payments/{pendingPaymentUid} */
505
+ export type PendingPaymentsGetParams = EdgeCacheParams;
506
+ /** Params for GET /pick-tickets */
507
+ export interface PickTicketsListParams extends EdgeCacheParams {
508
+ /** Only pick tickets for this Prophet 21 company */
509
+ companyId?: string;
510
+ /** Y for deleted pick tickets, N for live ones */
511
+ deleteFlag?: string;
512
+ /** Limit number of results (Default: 10) */
513
+ limit?: number;
514
+ /** Only pick tickets shipping from this Prophet 21 location */
515
+ locationId?: number;
516
+ /** Starting offset results (Default: 0) */
517
+ offset?: number;
518
+ /** Order By (Default: pick_ticket_no|ASC) */
519
+ orderBy?: string;
520
+ /** Order Number */
521
+ orderNo?: string;
522
+ /** Y for printed pick tickets, N for unprinted ones */
523
+ printedFlag?: string;
524
+ /** Search Query */
525
+ q?: string;
526
+ }
527
+ /** Params for GET /pick-tickets/{pickTicketNo} */
528
+ export type PickTicketsGetParams = EdgeCacheParams;
529
+ /** Params for GET /pick-tickets/{pickTicketNo}/lines */
530
+ export interface PickTicketsLinesListParams extends EdgeCacheParams {
531
+ /** Limit number of results (Default: 10) */
532
+ limit?: number;
533
+ /** Starting offset results (Default: 0) */
534
+ offset?: number;
535
+ /** Order By (Default: line_number|ASC) */
536
+ orderBy?: string;
537
+ }
538
+ /** Params for GET /pick-tickets/{pickTicketNo}/lines/{lineNumber} */
539
+ export type PickTicketsLinesGetParams = EdgeCacheParams;
540
+ /** Params for GET /po-hdr */
541
+ export interface PoHdrListParams extends EdgeCacheParams {
542
+ /** Y for completed purchase orders, N for open ones */
543
+ complete?: string;
544
+ /** Maximum purchase orders to return (default 10) */
545
+ limit?: number;
546
+ /** Only purchase orders received into this Prophet 21 location */
547
+ locationId?: number;
548
+ /** Purchase orders to skip before the first one returned */
549
+ offset?: number;
550
+ /** Sort as column|ASC or column|DESC on a po_hdr column (default po_hdr_uid|ASC) */
551
+ orderBy?: string;
552
+ /** Text matched anywhere in the PO number, PO description or external PO number */
553
+ q?: string;
554
+ }
555
+ /** Params for GET /po-hdr/{poNo} */
556
+ export type PoHdrGetParams = EdgeCacheParams;
557
+ /** Params for GET /po-hdr/{poNo}/doc */
558
+ export type PoHdrDocListParams = EdgeCacheParams;
559
+ /** Params for GET /po-line */
560
+ export interface PoLineListParams extends EdgeCacheParams {
561
+ /** Complete flag [Y|N] */
562
+ complete?: string;
563
+ /** Filter by inv_mast_uid */
564
+ invMastUid?: number;
565
+ /** Limit number of results (Default: 10) */
566
+ limit?: number;
567
+ /** Starting offset results (Default: 0) */
568
+ offset?: number;
569
+ /** Order By (Default: po_line_uid|ASC) */
570
+ orderBy?: string;
571
+ /** Filter by PO number */
572
+ poNo?: number;
573
+ }
574
+ /** Params for GET /po-line/{poLineUid} */
575
+ export type PoLineGetParams = EdgeCacheParams;
576
+ /** Params for GET /quote-hdr */
577
+ export interface QuoteHdrListParams extends EdgeCacheParams {
578
+ /** Maximum rows to return (Default: 10) */
579
+ limit?: number;
580
+ /** Filter by oe_hdr_uid (quote_hdr.oe_hdr_uid) */
581
+ oeHdrUid?: number;
582
+ /** Starting offset results (Default: 0) */
583
+ offset?: number;
584
+ /** Order By (Default: quote_hdr_uid|ASC) */
585
+ orderBy?: string;
586
+ }
587
+ /** Params for GET /quote-hdr/{quoteHdrUid} */
588
+ export type QuoteHdrGetParams = EdgeCacheParams;
589
+ /** Params for GET /remittances */
590
+ export interface RemittancesListParams extends EdgeCacheParams {
591
+ /** Filter by company_id (remittances.company_id) */
592
+ companyId?: string;
593
+ /** P21 delete flag to filter by: Y or N (Default: every row) */
594
+ deleteFlag?: string;
595
+ /** Maximum rows to return (Default: 10) */
596
+ limit?: number;
597
+ /** Starting offset results (Default: 0) */
598
+ offset?: number;
599
+ /** Order By (Default: remittance_number|ASC) */
600
+ orderBy?: string;
601
+ /** Filter by order_no (remittances.order_no) */
602
+ orderNo?: string;
603
+ }
604
+ /** Params for GET /remittances-detail */
605
+ export interface RemittancesDetailListParams extends EdgeCacheParams {
606
+ /** P21 delete flag to filter by: Y or N (Default: every row) */
607
+ deleteFlag?: string;
608
+ /** Filter by invoice_no (remittances_detail.invoice_no) */
609
+ invoiceNo?: string;
610
+ /** Maximum rows to return (Default: 10) */
611
+ limit?: number;
612
+ /** Starting offset results (Default: 0) */
613
+ offset?: number;
614
+ /** Order By (Default: remittance_number|ASC) */
615
+ orderBy?: string;
616
+ /** Filter by remittance_number (remittances_detail.remittance_number) */
617
+ remittanceNumber?: number;
618
+ }
619
+ /** Params for GET /remittances/{remittanceNumber} */
620
+ export type RemittancesGetParams = EdgeCacheParams;
621
+ /** Params for GET /shipping-route */
622
+ export interface ShippingRouteListParams extends EdgeCacheParams {
623
+ /** Filter by delivery_zone_uid (shipping_route.delivery_zone_uid) */
624
+ deliveryZoneUid?: number;
625
+ /** Maximum rows to return (Default: 10) */
626
+ limit?: number;
627
+ /** Starting offset results (Default: 0) */
628
+ offset?: number;
629
+ /** Order By (Default: shipping_route_uid|ASC) */
630
+ orderBy?: string;
631
+ /**
632
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
633
+ * (704,705); -1 for every status. Default: 704
634
+ */
635
+ rowStatusFlag?: number | number[];
636
+ }
637
+ /** Params for GET /shipping-route/{shippingRouteUid} */
638
+ export type ShippingRouteGetParams = EdgeCacheParams;
639
+ /** Params for GET /wireless-trans-audit-hdr */
640
+ export interface WirelessTransAuditHdrListParams extends EdgeCacheParams {
641
+ /** Filter by company_id (wireless_trans_audit_hdr.company_id) */
642
+ companyId?: string;
643
+ /** Maximum rows to return (Default: 10) */
644
+ limit?: number;
645
+ /** Filter by location_id (wireless_trans_audit_hdr.location_id) */
646
+ locationId?: number;
647
+ /** Starting offset results (Default: 0) */
648
+ offset?: number;
649
+ /** Order By (Default: wireless_trans_audit_hdr_uid|ASC) */
650
+ orderBy?: string;
651
+ /**
652
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
653
+ * (704,705); -1 for every status. Default: 704
654
+ */
655
+ rowStatusFlag?: number | number[];
656
+ /** Filter by workbench_uid (wireless_trans_audit_hdr.workbench_uid) */
657
+ workbenchUid?: number;
658
+ }
659
+ /** Params for GET /wireless-trans-audit-hdr/{wirelessTransAuditHdrUid} */
660
+ export type WirelessTransAuditHdrGetParams = EdgeCacheParams;
661
+ /** Params for GET /wireless-trans-audit-line */
662
+ export interface WirelessTransAuditLineListParams extends EdgeCacheParams {
663
+ /** Filter by inv_mast_uid (wireless_trans_audit_line.inv_mast_uid) */
664
+ invMastUid?: number;
665
+ /** Maximum rows to return (Default: 10) */
666
+ limit?: number;
667
+ /** Starting offset results (Default: 0) */
668
+ offset?: number;
669
+ /** Order By (Default: wireless_trans_audit_line_uid|ASC) */
670
+ orderBy?: string;
671
+ /**
672
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
673
+ * (704,705); -1 for every status. Default: 704
674
+ */
675
+ rowStatusFlag?: number | number[];
676
+ /**
677
+ * Filter by wireless_trans_audit_hdr_uid (wireless_trans_audit_line.wireless_trans_audit_hdr_uid)
678
+ */
679
+ wirelessTransAuditHdrUid?: number;
680
+ }
681
+ /** Params for GET /wireless-trans-audit-line/{wirelessTransAuditLineUid} */
682
+ export type WirelessTransAuditLineGetParams = EdgeCacheParams;
683
+ /**
684
+ * List Apinv Hdr Rows
685
+ * Response data for GET /apinv-hdr — MINIMUM fields, extras pass through
686
+ *
687
+ * Returned by: api.orders.apinvHdr.list(params) (array items)
688
+ * Returned by: api.orders.apinvHdr.get(voucherNo)
689
+ */
690
+ export interface NvHdrListItem {
691
+ /** P21 company number (max 8 chars) */
692
+ companyNo: string;
693
+ /** P21 vendor ID (vendor.vendor_id) */
694
+ vendorId: number;
695
+ /** P21 invoice number (max 32 chars) */
696
+ invoiceNo: string;
697
+ /** P21 invoice date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
698
+ invoiceDate: string | null;
699
+ /** P21 invoice amount */
700
+ invoiceAmount: number;
701
+ /** P21 net due date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
702
+ netDueDate: string | null;
703
+ /** P21 terms due date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
704
+ termsDueDate: string | null;
705
+ /** P21 terms amount */
706
+ termsAmount: number;
707
+ /** P21 check number (max 255 chars) */
708
+ checkNo: string | null;
709
+ /** P21 check date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
710
+ checkDate: string | null;
711
+ /** P21 voucher number (max 10 chars) */
712
+ voucherNo: string;
713
+ /** P21 ap account number (max 32 chars) */
714
+ apAccountNo: string;
715
+ /** P21 cash account number (max 32 chars) */
716
+ cashAccountNo: string | null;
717
+ /** P21 description (max 30 chars) */
718
+ description: string | null;
719
+ /** P21 amount paid on the apinv hdr */
720
+ amountPaid: number;
721
+ /** P21 terms amount taken on the apinv hdr */
722
+ termsAmountTaken: number;
723
+ /** P21 paid in full on the apinv hdr (max 1 chars) */
724
+ paidInFull: string;
725
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
726
+ dateCreated: string;
727
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
728
+ dateLastModified: string;
729
+ /** P21 user who last changed the row (max 30 chars) */
730
+ lastMaintainedBy: string;
731
+ /** P21 purchase order number (max 50 chars) */
732
+ poNo: string | null;
733
+ /** P21 accounting period */
734
+ period: number | null;
735
+ /** P21 year for period on the apinv hdr */
736
+ yearForPeriod: number | null;
737
+ /** P21 currency ID (currency_hdr.currency_id) */
738
+ currencyId: number | null;
739
+ /** P21 home currency amount */
740
+ homeCurrencyAmt: number | null;
741
+ /** P21 reverse flag (max 1 chars) */
742
+ reverseFlag: string | null;
743
+ /** P21 voucher type on the apinv hdr (max 1 chars) */
744
+ voucherType: string | null;
745
+ /** P21 voucher description on the apinv hdr (max 255 chars) */
746
+ voucherDescription: string | null;
747
+ /** P21 memo amount */
748
+ memoAmount: number | null;
749
+ /** P21 voucher class on the apinv hdr (max 8 chars) */
750
+ voucherClass: string | null;
751
+ /** P21 voucher reference number on the apinv hdr (max 10 chars) */
752
+ voucherReferenceNumber: string | null;
753
+ /** P21 period fully paid on the apinv hdr */
754
+ periodFullyPaid: number | null;
755
+ /** P21 year fully paid on the apinv hdr */
756
+ yearFullyPaid: number | null;
757
+ /** P21 approved on the apinv hdr (max 1 chars) */
758
+ approved: string | null;
759
+ /** P21 branch ID (max 8 chars) */
760
+ branchId: string | null;
761
+ /** P21 terms taken account on the apinv hdr (max 32 chars) */
762
+ termsTakenAccount: string | null;
763
+ /** P21 invoice amount display value */
764
+ invoiceAmountDisplay: number | null;
765
+ /** P21 terms amount display value */
766
+ termsAmountDisplay: number | null;
767
+ /** P21 terms amount taken display value */
768
+ termsAmountTakenDisplay: number | null;
769
+ /** P21 amount paid display value */
770
+ amountPaidDisplay: number | null;
771
+ /** P21 memo amount display value */
772
+ memoAmountDisplay: number | null;
773
+ /** P21 payable source code */
774
+ payableSourceCd: number | null;
775
+ /** P21 terms ID (terms.terms_id) (max 2 chars) */
776
+ termsId: string | null;
777
+ /** P21 source type code */
778
+ sourceTypeCd: number | null;
779
+ /** P21 always take terms on the apinv hdr (max 1 chars) */
780
+ alwaysTakeTerms: string;
781
+ /** P21 voucher reversal reason on the apinv hdr (max 255 chars) */
782
+ voucherReversalReason: string | null;
783
+ /** P21 user who created the row (max 255 chars) */
784
+ createdBy: string | null;
785
+ /** P21 disputed flag (max 1 chars) */
786
+ disputedFlag: string;
787
+ /** P21 previously disputed flag (max 1 chars) */
788
+ previouslyDisputedFlag: string;
789
+ /** P21 job ID (max 32 chars) */
790
+ jobId: string | null;
791
+ /** P21 job id set by conversion flag (max 1 chars) */
792
+ jobIdSetByConversionFlag: string;
793
+ /** P21 vendor edited flag (max 1 chars) */
794
+ vendorEditedFlag: string | null;
795
+ /** P21 customer ID (customer.customer_id) */
796
+ customerId: number | null;
797
+ /** P21 ship-to ID (ship_to.ship_to_id) */
798
+ shipToId: number | null;
799
+ /** P21 handling fee on the apinv hdr */
800
+ handlingFee: number | null;
801
+ /** P21 voucher ref inv number (max 10 chars) */
802
+ voucherRefInvNo: string | null;
803
+ /** P21 exported flag (max 1 chars) */
804
+ exportedFlag: string | null;
805
+ /** P21 freight voucher flag (max 1 chars) */
806
+ freightVoucherFlag: string | null;
807
+ /** P21 freight amount */
808
+ freightAmount: number | null;
809
+ /** P21 freight amount display value */
810
+ freightAmountDisplay: number | null;
811
+ /** P21 exchange rate on the apinv hdr */
812
+ exchangeRate: number | null;
813
+ /** P21 freight dispute flag (max 1 chars) */
814
+ freightDisputeFlag: string | null;
815
+ /** P21 iva withheld amount */
816
+ ivaWithheldAmount: number;
817
+ /** P21 iva withheld amount display value */
818
+ ivaWithheldAmountDisplay: number;
819
+ /** P21 iva terms amount taken on the apinv hdr */
820
+ ivaTermsAmountTaken: number;
821
+ /** P21 iva terms amount taken display value */
822
+ ivaTermsAmountTakenDisplay: number;
823
+ /** P21 external claim ID (max 255 chars) */
824
+ externalClaimId: string | null;
825
+ /** P21 voucher reason code UID */
826
+ voucherReasonCodeUid: number | null;
827
+ /** P21 payable source UID */
828
+ payableSourceUid: number | null;
829
+ /** P21 payment approved flag (max 1 chars) */
830
+ paymentApprovedFlag: string | null;
831
+ /** P21 terms discount pct on the apinv hdr */
832
+ termsDiscountPct: number | null;
833
+ /** P21 notes */
834
+ notes: string | null;
835
+ /** P21 print notes on the apinv hdr (max 1 chars) */
836
+ printNotes: string | null;
837
+ /** P21 warranty claim payments UID */
838
+ warrantyClaimPaymentsUid: number | null;
839
+ /** P21 vat only memo flag (max 1 chars) */
840
+ vatOnlyMemoFlag: string;
841
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
842
+ updateCd: number;
843
+ /** Process code (704 = queued for processing, 1185 = complete) */
844
+ processCd: number;
845
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
846
+ statusCd: number;
847
+ [key: string]: unknown;
848
+ }
849
+ /**
850
+ * List Apinv Hdr Rows
851
+ * Response data for GET /apinv-hdr — MINIMUM fields, extras pass through
852
+ *
853
+ * Returned by: api.orders.apinvHdr.list(params) (array items)
854
+ */
855
+ export type ApinvHdrListItem = NvHdrListItem;
856
+ /** Returned by: api.orders.apinvHdr.list(params) */
857
+ export type ApinvHdrListData = ApinvHdrListItem[];
858
+ /**
859
+ * Get Apinv Hdr
860
+ * Response data for GET /apinv-hdr/{voucherNo} — MINIMUM fields, extras pass through
861
+ *
862
+ * Returned by: api.orders.apinvHdr.get(voucherNo)
863
+ */
864
+ export type ApinvHdrGetData = NvHdrListItem;
865
+ /**
866
+ * List Ar Payment Details Rows
867
+ * Response data for GET /ar-payment-details — MINIMUM fields, extras pass through
868
+ *
869
+ * Returned by: api.orders.arPaymentDetails.list(params) (array items)
870
+ * Returned by: api.orders.arPaymentDetails.get(paymentNumber)
871
+ */
872
+ export interface ArPaymentDetailsListItem {
873
+ /** P21 payment number on the ar payment details */
874
+ paymentNumber: number;
875
+ /** P21 payment type ID */
876
+ paymentTypeId: number;
877
+ /** P21 payment desc on the ar payment details (max 60 chars) */
878
+ paymentDesc: string;
879
+ /** P21 payment date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
880
+ paymentDate: string;
881
+ /** P21 payment amount */
882
+ paymentAmount: number;
883
+ /** P21 terms amount */
884
+ termsAmount: number | null;
885
+ /** P21 allowed amount */
886
+ allowedAmount: number | null;
887
+ /** P21 check number on the ar payment details (max 30 chars) */
888
+ checkNumber: string | null;
889
+ /** P21 cc name on the ar payment details (max 30 chars) */
890
+ ccName: string | null;
891
+ /** P21 cc number on the ar payment details (max 30 chars) */
892
+ ccNumber: string | null;
893
+ /** P21 cc expiration date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
894
+ ccExpirationDate: string | null;
895
+ /** P21 cc authorized date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
896
+ ccAuthorizedDate: string | null;
897
+ /** P21 cc authorized number on the ar payment details (max 30 chars) */
898
+ ccAuthorizedNumber: string | null;
899
+ /** P21 accounting period */
900
+ period: number | null;
901
+ /** P21 year for period on the ar payment details */
902
+ yearForPeriod: number | null;
903
+ /** P21 deposit number on the ar payment details (max 40 chars) */
904
+ depositNumber: string | null;
905
+ /** Y when P21 marks the row deleted (max 1 chars) */
906
+ deleteFlag: string;
907
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
908
+ dateCreated: string;
909
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
910
+ dateLastModified: string;
911
+ /** P21 user who last changed the row (max 30 chars) */
912
+ lastMaintainedBy: string;
913
+ /** P21 memo amount */
914
+ memoAmount: number;
915
+ /** P21 preprocessed payment amount */
916
+ preprocessedPaymentAmount: number | null;
917
+ /** P21 currency line UID */
918
+ currencyLineUid: number | null;
919
+ /** P21 currency variance amt home on the ar payment details */
920
+ currencyVarianceAmtHome: number;
921
+ /** P21 user who created the row (max 255 chars) */
922
+ createdBy: string | null;
923
+ /** P21 source type code */
924
+ sourceTypeCd: number | null;
925
+ /** P21 customer payment exch rate on the ar payment details */
926
+ customerPaymentExchRate: number | null;
927
+ /** P21 payment source code */
928
+ paymentSourceCd: number | null;
929
+ /** P21 store credit number on the ar payment details */
930
+ storeCreditNumber: number | null;
931
+ /** P21 change amount */
932
+ changeAmount: number | null;
933
+ /** P21 payment account ID (max 255 chars) */
934
+ paymentAccountId: string | null;
935
+ /** P21 web cc processor UID */
936
+ webCcProcessorUid: number | null;
937
+ /** P21 tax terms amount */
938
+ taxTermsAmount: number;
939
+ /** P21 tax amount paid on the ar payment details */
940
+ taxAmountPaid: number;
941
+ /** P21 pay amt only flag (max 1 chars) */
942
+ payAmtOnlyFlag: string | null;
943
+ /** P21 rounded amount */
944
+ roundedAmount: number | null;
945
+ /** P21 billtrust payment type code */
946
+ billtrustPaymentTypeCd: number | null;
947
+ /** P21 multi currency ID */
948
+ multiCurrencyId: number | null;
949
+ /** P21 multi currency payment amount */
950
+ multiCurrencyPaymentAmount: number | null;
951
+ /** P21 multi currency exchange rate on the ar payment details */
952
+ multiCurrencyExchangeRate: number | null;
953
+ /** P21 multi currency variance amount */
954
+ multiCurrencyVarianceAmount: number | null;
955
+ /** P21 exchange rate override date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
956
+ exchangeRateOverrideDate: string | null;
957
+ /** P21 cc return transaction ID (max 255 chars) */
958
+ ccReturnTransactionId: string | null;
959
+ /** P21 cc refund parent payment number */
960
+ ccRefundParentPaymentNo: number | null;
961
+ /** P21 ewing coupon UID */
962
+ ewingCouponUid: number | null;
963
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
964
+ updateCd: number;
965
+ /** Process code (704 = queued for processing, 1185 = complete) */
966
+ processCd: number;
967
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
968
+ statusCd: number;
969
+ [key: string]: unknown;
970
+ }
971
+ /** Returned by: api.orders.arPaymentDetails.list(params) */
972
+ export type ArPaymentDetailsListData = ArPaymentDetailsListItem[];
973
+ /**
974
+ * Get Ar Payment Details
975
+ * Response data for GET /ar-payment-details/{paymentNumber} — MINIMUM fields, extras pass through
976
+ *
977
+ * Returned by: api.orders.arPaymentDetails.get(paymentNumber)
978
+ */
979
+ export type ArPaymentDetailsGetData = ArPaymentDetailsListItem;
980
+ /**
981
+ * List Ar Receipts Rows
982
+ * Response data for GET /ar-receipts — MINIMUM fields, extras pass through
983
+ *
984
+ * Returned by: api.orders.arReceipts.list(params) (array items)
985
+ * Returned by: api.orders.arReceipts.get(receiptNumber)
986
+ */
987
+ export interface ArReceiptsListItem {
988
+ /** P21 receipt number on the ar receipts */
989
+ receiptNumber: number;
990
+ /** P21 payment number on the ar receipts */
991
+ paymentNumber: number;
992
+ /** P21 company ID (max 8 chars) */
993
+ companyId: string;
994
+ /** P21 remitter ID */
995
+ remitterId: number;
996
+ /** P21 date received on the ar receipts (mysql-datetime, e.g. 2025-07-30 15:50:49) */
997
+ dateReceived: string;
998
+ /** P21 bank number */
999
+ bankNo: number | null;
1000
+ /** P21 gl bank account number (max 32 chars) */
1001
+ glBankAccountNo: string | null;
1002
+ /** P21 ar account number (max 32 chars) */
1003
+ arAccountNo: string | null;
1004
+ /** P21 terms account number (max 32 chars) */
1005
+ termsAccountNo: string | null;
1006
+ /** P21 allowed account number (max 32 chars) */
1007
+ allowedAccountNo: string | null;
1008
+ /** P21 approved on the ar receipts (max 1 chars) */
1009
+ approved: string;
1010
+ /** Y when P21 marks the row deleted (max 1 chars) */
1011
+ deleteFlag: string;
1012
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1013
+ dateCreated: string;
1014
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1015
+ dateLastModified: string;
1016
+ /** P21 user who last changed the row (max 30 chars) */
1017
+ lastMaintainedBy: string;
1018
+ /** P21 user who created the row (max 255 chars) */
1019
+ createdBy: string | null;
1020
+ /** P21 reverse payment flag (max 1 chars) */
1021
+ reversePaymentFlag: string | null;
1022
+ /** P21 cleared bank on the ar receipts (max 1 chars) */
1023
+ clearedBank: string;
1024
+ /** P21 cleared period on the ar receipts */
1025
+ clearedPeriod: number | null;
1026
+ /** P21 cleared year on the ar receipts */
1027
+ clearedYear: number | null;
1028
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
1029
+ updateCd: number;
1030
+ /** Process code (704 = queued for processing, 1185 = complete) */
1031
+ processCd: number;
1032
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
1033
+ statusCd: number;
1034
+ [key: string]: unknown;
1035
+ }
1036
+ /** Returned by: api.orders.arReceipts.list(params) */
1037
+ export type ArReceiptsListData = ArReceiptsListItem[];
1038
+ /**
1039
+ * List Ar Receipts Detail Rows
1040
+ * Response data for GET /ar-receipts-detail — MINIMUM fields, extras pass through
1041
+ *
1042
+ * Returned by: api.orders.arReceiptsDetail.list(params) (array items)
1043
+ */
1044
+ export interface ArReceiptsDetailListItem {
1045
+ /** P21 receipt number on the ar receipts detail */
1046
+ receiptNumber: number;
1047
+ /** P21 customer ID (customer.customer_id) */
1048
+ customerId: number;
1049
+ /** P21 invoice number (max 10 chars) */
1050
+ invoiceNo: string;
1051
+ /** P21 company ID (max 8 chars) */
1052
+ companyId: string;
1053
+ /** P21 payment amount */
1054
+ paymentAmount: number;
1055
+ /** P21 terms amount */
1056
+ termsAmount: number;
1057
+ /** P21 allowed amount */
1058
+ allowedAmount: number;
1059
+ /** Y when P21 marks the row deleted (max 1 chars) */
1060
+ deleteFlag: string;
1061
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1062
+ dateCreated: string;
1063
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1064
+ dateLastModified: string;
1065
+ /** P21 user who last changed the row (max 30 chars) */
1066
+ lastMaintainedBy: string;
1067
+ /** P21 currency variance amt home on the ar receipts detail */
1068
+ currencyVarianceAmtHome: number;
1069
+ /** P21 user who created the row (max 255 chars) */
1070
+ createdBy: string | null;
1071
+ /** P21 tax terms taken amount */
1072
+ taxTermsTakenAmt: number | null;
1073
+ /** P21 other charge terms taken amount */
1074
+ otherChargeTermsTakenAmt: number | null;
1075
+ /** P21 tax amount paid on the ar receipts detail */
1076
+ taxAmountPaid: number;
1077
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
1078
+ updateCd: number;
1079
+ /** Process code (704 = queued for processing, 1185 = complete) */
1080
+ processCd: number;
1081
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
1082
+ statusCd: number;
1083
+ [key: string]: unknown;
1084
+ }
1085
+ /** Returned by: api.orders.arReceiptsDetail.list(params) */
1086
+ export type ArReceiptsDetailListData = ArReceiptsDetailListItem[];
1087
+ /**
1088
+ * Get Ar Receipts
1089
+ * Response data for GET /ar-receipts/{receiptNumber} — MINIMUM fields, extras pass through
1090
+ *
1091
+ * Returned by: api.orders.arReceipts.get(receiptNumber)
1092
+ */
1093
+ export type ArReceiptsGetData = ArReceiptsListItem;
1094
+ /**
1095
+ * List Document Line Bin Rows
1096
+ * Response data for GET /document-line-bin — MINIMUM fields, extras pass through
1097
+ *
1098
+ * Returned by: api.orders.documentLineBin.list(params) (array items)
1099
+ * Returned by: api.orders.documentLineBin.get(documentLineBinUid)
1100
+ */
1101
+ export interface DocumentLineBinListItem {
1102
+ /** P21 document number */
1103
+ documentNo: number;
1104
+ /** P21 line number */
1105
+ lineNo: number;
1106
+ /** P21 document type on the document line bin (max 2 chars) */
1107
+ documentType: string;
1108
+ /** P21 bin code (max 40 chars) */
1109
+ binCd: string;
1110
+ /** P21 qty applied on the document line bin */
1111
+ qtyApplied: number;
1112
+ /** P21 unit quantity */
1113
+ unitQuantity: number;
1114
+ /** P21 unit of measure (max 8 chars) */
1115
+ unitOfMeasure: string;
1116
+ /** P21 document code (max 10 chars) */
1117
+ documentCd: string | null;
1118
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1119
+ dateCreated: string;
1120
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1121
+ dateLastModified: string;
1122
+ /** P21 user who last changed the row (max 30 chars) */
1123
+ lastMaintainedBy: string;
1124
+ /** P21 document line bin UID (primary key) */
1125
+ documentLineBinUid: number;
1126
+ /** P21 unit size */
1127
+ unitSize: number;
1128
+ /** P21 qty to change on the document line bin */
1129
+ qtyToChange: number;
1130
+ /** P21 sub line number */
1131
+ subLineNo: number;
1132
+ /** P21 rf qty picked on the document line bin */
1133
+ rfQtyPicked: number;
1134
+ /** P21 qty from tags on the document line bin */
1135
+ qtyFromTags: number;
1136
+ /** P21 source dlb UID */
1137
+ sourceDlbUid: number | null;
1138
+ /** P21 user who created the row (max 255 chars) */
1139
+ createdBy: string;
1140
+ /** P21 printed flag (max 1 chars) */
1141
+ printedFlag: string | null;
1142
+ /** P21 work order UID (work_order_hdr.work_order_uid) */
1143
+ workOrderUid: number | null;
1144
+ /** P21 pick status on the document line bin (max 2 chars) */
1145
+ pickStatus: string | null;
1146
+ /** P21 assigned workstation ID (max 255 chars) */
1147
+ assignedWorkstationId: string | null;
1148
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
1149
+ updateCd: number;
1150
+ /** Process code (704 = queued for processing, 1185 = complete) */
1151
+ processCd: number;
1152
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
1153
+ statusCd: number;
1154
+ [key: string]: unknown;
1155
+ }
1156
+ /** Returned by: api.orders.documentLineBin.list(params) */
1157
+ export type DocumentLineBinListData = DocumentLineBinListItem[];
1158
+ /**
1159
+ * Get Document Line Bin
1160
+ * Response data for GET /document-line-bin/{documentLineBinUid} — MINIMUM fields, extras pass
1161
+ * through
1162
+ *
1163
+ * Returned by: api.orders.documentLineBin.get(documentLineBinUid)
1164
+ */
1165
+ export type DocumentLineBinGetData = DocumentLineBinListItem;
1166
+ /**
1167
+ * List Document Line Lot Rows
1168
+ * Response data for GET /document-line-lot — MINIMUM fields, extras pass through
1169
+ *
1170
+ * Returned by: api.orders.documentLineLot.list(params) (array items)
1171
+ * Returned by: api.orders.documentLineLot.get(documentLineLotUid)
1172
+ */
1173
+ export interface DocumentLineLotListItem {
1174
+ /** P21 document number */
1175
+ documentNo: number;
1176
+ /** P21 line number */
1177
+ lineNo: number;
1178
+ /** P21 document type on the document line lot (max 2 chars) */
1179
+ documentType: string;
1180
+ /** P21 lot code (max 40 chars) */
1181
+ lotCd: string;
1182
+ /** P21 qty to change on the document line lot */
1183
+ qtyToChange: number;
1184
+ /** P21 qty applied on the document line lot */
1185
+ qtyApplied: number;
1186
+ /** P21 unit quantity */
1187
+ unitQuantity: number;
1188
+ /** P21 unit of measure (max 8 chars) */
1189
+ unitOfMeasure: string;
1190
+ /** P21 document code (max 10 chars) */
1191
+ documentCd: string | null;
1192
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1193
+ dateCreated: string;
1194
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1195
+ dateLastModified: string;
1196
+ /** P21 user who last changed the row (max 30 chars) */
1197
+ lastMaintainedBy: string;
1198
+ /** P21 document line lot UID (primary key) */
1199
+ documentLineLotUid: number;
1200
+ /** P21 unit size */
1201
+ unitSize: number;
1202
+ /** P21 sub line number */
1203
+ subLineNo: number;
1204
+ /** P21 sequence number */
1205
+ sequenceNo: number;
1206
+ /** P21 lot UID (lot.lot_uid) */
1207
+ lotUid: number | null;
1208
+ /** P21 qty from tags on the document line lot */
1209
+ qtyFromTags: number;
1210
+ /** P21 item revision UID */
1211
+ itemRevisionUid: number | null;
1212
+ /** P21 currentbin UID */
1213
+ currentbinUid: number | null;
1214
+ /** P21 qa status on the document line lot (max 255 chars) */
1215
+ qaStatus: string | null;
1216
+ /** P21 sub invoice number (max 40 chars) */
1217
+ subInvoiceNo: string | null;
1218
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
1219
+ updateCd: number;
1220
+ /** Process code (704 = queued for processing, 1185 = complete) */
1221
+ processCd: number;
1222
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
1223
+ statusCd: number;
1224
+ [key: string]: unknown;
1225
+ }
1226
+ /** Returned by: api.orders.documentLineLot.list(params) */
1227
+ export type DocumentLineLotListData = DocumentLineLotListItem[];
1228
+ /**
1229
+ * Get Document Line Lot
1230
+ * Response data for GET /document-line-lot/{documentLineLotUid} — MINIMUM fields, extras pass
1231
+ * through
1232
+ *
1233
+ * Returned by: api.orders.documentLineLot.get(documentLineLotUid)
1234
+ */
1235
+ export type DocumentLineLotGetData = DocumentLineLotListItem;
1236
+ /**
1237
+ * List Document Line Serial Rows
1238
+ * Response data for GET /document-line-serial — MINIMUM fields, extras pass through
1239
+ *
1240
+ * Returned by: api.orders.documentLineSerial.list(params) (array items)
1241
+ * Returned by: api.orders.documentLineSerial.get(documentLineSerialUid)
1242
+ */
1243
+ export interface DocumentLineSerialListItem {
1244
+ /** P21 document number */
1245
+ documentNo: number;
1246
+ /** P21 line number */
1247
+ lineNo: number;
1248
+ /** P21 document type on the document line serial (max 2 chars) */
1249
+ documentType: string;
1250
+ /** P21 serial number (max 40 chars) */
1251
+ serialNumber: string;
1252
+ /** P21 document code (max 10 chars) */
1253
+ documentCd: string | null;
1254
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1255
+ dateCreated: string;
1256
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1257
+ dateLastModified: string;
1258
+ /** P21 user who last changed the row (max 30 chars) */
1259
+ lastMaintainedBy: string;
1260
+ /** P21 dimension tracking key on the document line serial */
1261
+ dimensionTrackingKey: number | null;
1262
+ /** P21 document line serial UID (primary key) */
1263
+ documentLineSerialUid: number;
1264
+ /** P21 row status on the document line serial */
1265
+ rowStatus: number;
1266
+ /** P21 sub line number */
1267
+ subLineNo: number;
1268
+ /** P21 sequence number */
1269
+ sequenceNo: number;
1270
+ /** P21 serial number UID */
1271
+ serialNumberUid: number | null;
1272
+ /** P21 qty from tags on the document line serial */
1273
+ qtyFromTags: number;
1274
+ /** P21 lot UID (lot.lot_uid) */
1275
+ lotUid: number | null;
1276
+ /** P21 rf bin UID */
1277
+ rfBinUid: number | null;
1278
+ /** P21 deposit bin UID */
1279
+ depositBinUid: number | null;
1280
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
1281
+ updateCd: number;
1282
+ /** Process code (704 = queued for processing, 1185 = complete) */
1283
+ processCd: number;
1284
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
1285
+ statusCd: number;
1286
+ [key: string]: unknown;
1287
+ }
1288
+ /** Returned by: api.orders.documentLineSerial.list(params) */
1289
+ export type DocumentLineSerialListData = DocumentLineSerialListItem[];
1290
+ /**
1291
+ * Get Document Line Serial
1292
+ * Response data for GET /document-line-serial/{documentLineSerialUid} — MINIMUM fields, extras pass
1293
+ * through
1294
+ *
1295
+ * Returned by: api.orders.documentLineSerial.get(documentLineSerialUid)
1296
+ */
1297
+ export type DocumentLineSerialGetData = DocumentLineSerialListItem;
1298
+ /**
1299
+ * List Import Suspense Hdr Rows
1300
+ * Response data for GET /import-suspense-hdr — MINIMUM fields, extras pass through
1301
+ *
1302
+ * Returned by: api.orders.importSuspenseHdr.list(params) (array items)
1303
+ * Returned by: api.orders.importSuspenseHdr.get(importSuspenseHdrUid)
1304
+ */
1305
+ export interface ImportSuspenseHdrListItem {
1306
+ /** P21 import suspense header UID (import_suspense_hdr.import_suspense_hdr_uid) */
1307
+ importSuspenseHdrUid: number;
1308
+ /** P21 impexp source ID (max 50 chars) */
1309
+ impexpSourceId: string;
1310
+ /** P21 transaction set ID (max 32 chars) */
1311
+ transactionSetId: string;
1312
+ /** P21 master file path on the import suspense hdr (max 255 chars) */
1313
+ masterFilePath: string;
1314
+ /** P21 master file name on the import suspense hdr (max 255 chars) */
1315
+ masterFileName: string;
1316
+ /** P21 required for import on the import suspense hdr (max 255 chars) */
1317
+ requiredForImport: string;
1318
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1319
+ dateCreated: string;
1320
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1321
+ dateLastModified: string;
1322
+ /** P21 user who last changed the row (max 30 chars) */
1323
+ lastMaintainedBy: string;
1324
+ /** P21 scheduled import on the import suspense hdr (max 1 chars) */
1325
+ scheduledImport: string;
1326
+ /** P21 impexp source desc on the import suspense hdr (max 255 chars) */
1327
+ impexpSourceDesc: string | null;
1328
+ /** P21 transaction set desc on the import suspense hdr (max 255 chars) */
1329
+ transactionSetDesc: string | null;
1330
+ /** P21 file format code */
1331
+ fileFormatCd: number | null;
1332
+ /** P21 transaction sus path on the import suspense hdr (max 200 chars) */
1333
+ transactionSusPath: string | null;
1334
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
1335
+ updateCd: number;
1336
+ /** Process code (704 = queued for processing, 1185 = complete) */
1337
+ processCd: number;
1338
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
1339
+ statusCd: number;
1340
+ [key: string]: unknown;
1341
+ }
1342
+ /** Returned by: api.orders.importSuspenseHdr.list(params) */
1343
+ export type ImportSuspenseHdrListData = ImportSuspenseHdrListItem[];
1344
+ /**
1345
+ * Get Import Suspense Hdr
1346
+ * Response data for GET /import-suspense-hdr/{importSuspenseHdrUid} — MINIMUM fields, extras pass
1347
+ * through
1348
+ *
1349
+ * Returned by: api.orders.importSuspenseHdr.get(importSuspenseHdrUid)
1350
+ */
1351
+ export type ImportSuspenseHdrGetData = ImportSuspenseHdrListItem;
1352
+ /**
1353
+ * List Import Suspense Line Rows
1354
+ * Response data for GET /import-suspense-line — MINIMUM fields, extras pass through
1355
+ *
1356
+ * Returned by: api.orders.importSuspenseLine.list(params) (array items)
1357
+ * Returned by: api.orders.importSuspenseLine.get(importSuspenseLineUid)
1358
+ */
1359
+ export interface ImportSuspenseLineListItem {
1360
+ /** P21 import suspense line UID (primary key) */
1361
+ importSuspenseLineUid: number;
1362
+ /** P21 import suspense header UID (import_suspense_hdr.import_suspense_hdr_uid) */
1363
+ importSuspenseHdrUid: number;
1364
+ /** P21 sequence number */
1365
+ sequenceNo: number;
1366
+ /** P21 import file path on the import suspense line (max 255 chars) */
1367
+ importFilePath: string;
1368
+ /** P21 import file name on the import suspense line (max 255 chars) */
1369
+ importFileName: string;
1370
+ /** P21 bo instancename on the import suspense line (max 255 chars) */
1371
+ boInstancename: string | null;
1372
+ /** P21 ds dataobject on the import suspense line (max 255 chars) */
1373
+ dsDataobject: string;
1374
+ /** P21 dw dataobject on the import suspense line (max 255 chars) */
1375
+ dwDataobject: string;
1376
+ /** P21 import set number (max 255 chars) */
1377
+ importSetNo: string;
1378
+ /** P21 company ID (max 8 chars) */
1379
+ companyId: string | null;
1380
+ /** P21 customer ID (customer.customer_id) */
1381
+ customerId: number | null;
1382
+ /** P21 location ID (location.location_id) */
1383
+ locationId: number | null;
1384
+ /** P21 key value on the import suspense line (max 255 chars) */
1385
+ keyValue: string | null;
1386
+ /** P21 key value table on the import suspense line (max 255 chars) */
1387
+ keyValueTable: string | null;
1388
+ /** P21 exported status on the import suspense line */
1389
+ exportedStatus: number;
1390
+ /** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
1391
+ rowStatusFlag: number;
1392
+ /** P21 display name on the import suspense line (max 255 chars) */
1393
+ displayName: string | null;
1394
+ /** P21 suspense data on the import suspense line */
1395
+ suspenseData: string;
1396
+ /** P21 error data on the import suspense line */
1397
+ errorData: string;
1398
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1399
+ dateCreated: string;
1400
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1401
+ dateLastModified: string;
1402
+ /** P21 user who last changed the row (max 30 chars) */
1403
+ lastMaintainedBy: string;
1404
+ /** P21 source ID (max 8 chars) */
1405
+ sourceId: string | null;
1406
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
1407
+ updateCd: number;
1408
+ /** Process code (704 = queued for processing, 1185 = complete) */
1409
+ processCd: number;
1410
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
1411
+ statusCd: number;
1412
+ [key: string]: unknown;
1413
+ }
1414
+ /** Returned by: api.orders.importSuspenseLine.list(params) */
1415
+ export type ImportSuspenseLineListData = ImportSuspenseLineListItem[];
1416
+ /**
1417
+ * Get Import Suspense Line
1418
+ * Response data for GET /import-suspense-line/{importSuspenseLineUid} — MINIMUM fields, extras pass
1419
+ * through
1420
+ *
1421
+ * Returned by: api.orders.importSuspenseLine.get(importSuspenseLineUid)
1422
+ */
1423
+ export type ImportSuspenseLineGetData = ImportSuspenseLineListItem;
1424
+ /**
1425
+ * List Invoice Hdr Rows
1426
+ * Response data for GET /invoice-hdr — MINIMUM fields, extras pass through
1427
+ *
1428
+ * Returned by: api.orders.invoiceHdr.list(params) (array items)
1429
+ * Returned by: api.orders.invoiceHdr.get(invoiceNo)
1430
+ */
1431
+ export interface InvoiceHdrListItem {
1432
+ /** P21 invoice number (max 10 chars) */
1433
+ invoiceNo: string;
1434
+ /** P21 order number (oe_hdr.order_no) (max 8 chars) */
1435
+ orderNo: string | null;
1436
+ /** P21 order date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1437
+ orderDate: string | null;
1438
+ /** P21 invoice date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1439
+ invoiceDate: string;
1440
+ /** P21 customer ID (customer.customer_id) (max 12 chars) */
1441
+ customerId: string;
1442
+ /** P21 bill2 name on the invoice hdr (max 50 chars) */
1443
+ bill2Name: string | null;
1444
+ /** P21 bill2 contact on the invoice hdr (max 30 chars) */
1445
+ bill2Contact: string | null;
1446
+ /** P21 bill2 address1 on the invoice hdr (max 50 chars) */
1447
+ bill2Address1: string | null;
1448
+ /** P21 bill2 address2 on the invoice hdr (max 50 chars) */
1449
+ bill2Address2: string | null;
1450
+ /** P21 bill2 city on the invoice hdr (max 50 chars) */
1451
+ bill2City: string | null;
1452
+ /** P21 bill2 state on the invoice hdr (max 50 chars) */
1453
+ bill2State: string | null;
1454
+ /** P21 bill2 postal code on the invoice hdr (max 10 chars) */
1455
+ bill2PostalCode: string | null;
1456
+ /** P21 ship2 name on the invoice hdr (max 50 chars) */
1457
+ ship2Name: string | null;
1458
+ /** P21 ship2 contact on the invoice hdr (max 30 chars) */
1459
+ ship2Contact: string | null;
1460
+ /** P21 ship2 address1 on the invoice hdr (max 50 chars) */
1461
+ ship2Address1: string | null;
1462
+ /** P21 ship2 address2 on the invoice hdr (max 50 chars) */
1463
+ ship2Address2: string | null;
1464
+ /** P21 ship2 city on the invoice hdr (max 50 chars) */
1465
+ ship2City: string | null;
1466
+ /** P21 ship2 state on the invoice hdr (max 50 chars) */
1467
+ ship2State: string | null;
1468
+ /** P21 ship2 postal code on the invoice hdr (max 10 chars) */
1469
+ ship2PostalCode: string | null;
1470
+ /** P21 carrier name on the invoice hdr (max 50 chars) */
1471
+ carrierName: string | null;
1472
+ /** P21 fob on the invoice hdr (max 20 chars) */
1473
+ fob: string | null;
1474
+ /** P21 terms desc on the invoice hdr (max 20 chars) */
1475
+ termsDesc: string | null;
1476
+ /** P21 purchase order number (max 255 chars) */
1477
+ poNo: string | null;
1478
+ /** P21 sales rep ID (salesrep.salesrep_id) (max 16 chars) */
1479
+ salesrepId: string | null;
1480
+ /** P21 salesrep name on the invoice hdr (max 40 chars) */
1481
+ salesrepName: string | null;
1482
+ /** P21 brokerage on the invoice hdr */
1483
+ brokerage: number | null;
1484
+ /** P21 freight amount */
1485
+ freight: number | null;
1486
+ /** P21 ar account number (max 32 chars) */
1487
+ arAccountNo: string | null;
1488
+ /** P21 gl freight account number (max 32 chars) */
1489
+ glFreightAccountNo: string | null;
1490
+ /** P21 gl brokerage account number (max 32 chars) */
1491
+ glBrokerageAccountNo: string | null;
1492
+ /** P21 brokerage amount */
1493
+ brokerageAmt: number | null;
1494
+ /** P21 accounting period */
1495
+ period: number | null;
1496
+ /** P21 year for period on the invoice hdr */
1497
+ yearForPeriod: number | null;
1498
+ /** P21 store number (max 5 chars) */
1499
+ storeNo: string | null;
1500
+ /** P21 invoice type on the invoice hdr (max 2 chars) */
1501
+ invoiceType: string | null;
1502
+ /** P21 ship-to ID (ship_to.ship_to_id) */
1503
+ shipToId: number | null;
1504
+ /** P21 ship date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1505
+ shipDate: string | null;
1506
+ /** P21 total amount */
1507
+ totalAmount: number;
1508
+ /** P21 amount paid on the invoice hdr */
1509
+ amountPaid: number;
1510
+ /** P21 terms taken on the invoice hdr */
1511
+ termsTaken: number;
1512
+ /** P21 allowed on the invoice hdr */
1513
+ allowed: number;
1514
+ /** P21 paid in full flag (max 1 chars) */
1515
+ paidInFullFlag: string | null;
1516
+ /** P21 paid by check number */
1517
+ paidByCheckNo: number | null;
1518
+ /** P21 date paid on the invoice hdr (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1519
+ datePaid: string | null;
1520
+ /** P21 print flag (max 1 chars) */
1521
+ printFlag: string | null;
1522
+ /** P21 print date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1523
+ printDate: string | null;
1524
+ /** P21 company number (max 8 chars) */
1525
+ companyNo: string;
1526
+ /** P21 customer id number on the invoice hdr */
1527
+ customerIdNumber: number;
1528
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1529
+ dateCreated: string;
1530
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1531
+ dateLastModified: string;
1532
+ /** P21 user who last changed the row (max 30 chars) */
1533
+ lastMaintainedBy: string;
1534
+ /** P21 printed on the invoice hdr (max 1 chars) */
1535
+ printed: string | null;
1536
+ /** P21 printed date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1537
+ printedDate: string | null;
1538
+ /** P21 corp address ID */
1539
+ corpAddressId: number | null;
1540
+ /** P21 shipping cost on the invoice hdr */
1541
+ shippingCost: number | null;
1542
+ /** P21 bill2 country on the invoice hdr (max 50 chars) */
1543
+ bill2Country: string | null;
1544
+ /** P21 ship2 country on the invoice hdr (max 50 chars) */
1545
+ ship2Country: string | null;
1546
+ /** P21 invoice reference number (max 10 chars) */
1547
+ invoiceReferenceNo: string;
1548
+ /** P21 invoice adjustment type on the invoice hdr (max 1 chars) */
1549
+ invoiceAdjustmentType: string | null;
1550
+ /** P21 invoice desc on the invoice hdr (max 255 chars) */
1551
+ invoiceDesc: string | null;
1552
+ /** P21 memo amount */
1553
+ memoAmount: number;
1554
+ /** P21 bad debt amount */
1555
+ badDebtAmount: number;
1556
+ /** P21 invoice class on the invoice hdr (max 8 chars) */
1557
+ invoiceClass: string | null;
1558
+ /** P21 period fully paid on the invoice hdr */
1559
+ periodFullyPaid: number | null;
1560
+ /** P21 year fully paid on the invoice hdr */
1561
+ yearFullyPaid: number | null;
1562
+ /** P21 approved on the invoice hdr (max 1 chars) */
1563
+ approved: string | null;
1564
+ /** P21 fc thru date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1565
+ fcThruDate: string | null;
1566
+ /** P21 cumulative fc on the invoice hdr */
1567
+ cumulativeFc: number | null;
1568
+ /** P21 net due date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1569
+ netDueDate: string | null;
1570
+ /** P21 terms due date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1571
+ termsDueDate: string | null;
1572
+ /** P21 terms ID (terms.terms_id) (max 2 chars) */
1573
+ termsId: string | null;
1574
+ /** P21 branch ID (max 8 chars) */
1575
+ branchId: string;
1576
+ /** P21 disputed flag (max 1 chars) */
1577
+ disputedFlag: string | null;
1578
+ /** P21 statement period on the invoice hdr */
1579
+ statementPeriod: number | null;
1580
+ /** P21 statement year on the invoice hdr */
1581
+ statementYear: number | null;
1582
+ /** P21 other charge amount */
1583
+ otherChargeAmount: number;
1584
+ /** P21 tax amount */
1585
+ taxAmount: number;
1586
+ /** P21 original document type on the invoice hdr (max 1 chars) */
1587
+ originalDocumentType: string;
1588
+ /** P21 consolidated on the invoice hdr (max 1 chars) */
1589
+ consolidated: string;
1590
+ /** P21 sold to ah UID */
1591
+ soldToAhUid: number;
1592
+ /** P21 sold to customer ID */
1593
+ soldToCustomerId: number;
1594
+ /** P21 ship to phone on the invoice hdr (max 20 chars) */
1595
+ shipToPhone: string | null;
1596
+ /** P21 invoice batch UID */
1597
+ invoiceBatchUid: number;
1598
+ /** P21 freight code UID (freight_code.freight_code_uid) */
1599
+ freightCodeUid: number | null;
1600
+ /** P21 shipping route UID (shipping_route.shipping_route_uid) */
1601
+ shippingRouteUid: number | null;
1602
+ /** P21 transmission method on the invoice hdr */
1603
+ transmissionMethod: number | null;
1604
+ /** P21 terms amount */
1605
+ termsAmount: number;
1606
+ /** P21 sales location ID */
1607
+ salesLocationId: number | null;
1608
+ /** P21 source type code */
1609
+ sourceTypeCd: number | null;
1610
+ /** P21 ship2 email address on the invoice hdr (max 255 chars) */
1611
+ ship2EmailAddress: string | null;
1612
+ /** P21 currency line UID */
1613
+ currencyLineUid: number | null;
1614
+ /** P21 user who created the row (max 255 chars) */
1615
+ createdBy: string | null;
1616
+ /** P21 tax terms taken on the invoice hdr */
1617
+ taxTermsTaken: number;
1618
+ /** P21 carrier insurance amount */
1619
+ carrierInsuranceAmt: number | null;
1620
+ /** P21 inv no display value (max 255 chars) */
1621
+ invNoDisplay: string | null;
1622
+ /** P21 iva exemption number on the invoice hdr (max 30 chars) */
1623
+ ivaExemptionNumber: string | null;
1624
+ /** P21 iva taxable flag (max 1 chars) */
1625
+ ivaTaxableFlag: string | null;
1626
+ /** P21 job ID (max 32 chars) */
1627
+ jobId: string | null;
1628
+ /** P21 invoice paid period on the invoice hdr */
1629
+ invoicePaidPeriod: number | null;
1630
+ /** P21 invoice period on the invoice hdr */
1631
+ invoicePeriod: number | null;
1632
+ /** P21 credit memo for terms flag (max 1 chars) */
1633
+ creditMemoForTermsFlag: string | null;
1634
+ /** P21 record type code */
1635
+ recordTypeCd: number | null;
1636
+ /** P21 commission cost on the invoice hdr */
1637
+ commissionCost: number | null;
1638
+ /** P21 carton count on the invoice hdr */
1639
+ cartonCount: number | null;
1640
+ /** P21 affiliated training center on the invoice hdr */
1641
+ affiliatedTrainingCenter: number | null;
1642
+ /** P21 external reference number (max 255 chars) */
1643
+ externalReferenceNo: string | null;
1644
+ /** P21 strategic freight in on the invoice hdr */
1645
+ strategicFreightIn: number | null;
1646
+ /** P21 strategic freight out on the invoice hdr */
1647
+ strategicFreightOut: number | null;
1648
+ /** P21 total freightcharge weight on the invoice hdr */
1649
+ totalFreightchargeWeight: number | null;
1650
+ /** P21 receiver name on the invoice hdr (max 255 chars) */
1651
+ receiverName: string | null;
1652
+ /** P21 cardlock cons invoice flag (max 1 chars) */
1653
+ cardlockConsInvoiceFlag: string | null;
1654
+ /** P21 remove from open def rev window on the invoice hdr (max 1 chars) */
1655
+ removeFromOpenDefRevWindow: string | null;
1656
+ /** P21 record type reference number (max 10 chars) */
1657
+ recordTypeReferenceNo: string | null;
1658
+ /** P21 rebill invoice reason UID */
1659
+ rebillInvoiceReasonUid: number | null;
1660
+ /** P21 edi order printed flag (max 1 chars) */
1661
+ ediOrderPrintedFlag: string | null;
1662
+ /** P21 downpayment applied on the invoice hdr */
1663
+ downpaymentApplied: number | null;
1664
+ /** P21 reverse redemption flag (max 1 chars) */
1665
+ reverseRedemptionFlag: string | null;
1666
+ /** P21 sent to carrier date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1667
+ sentToCarrierDate: string | null;
1668
+ /** P21 tax terms amount */
1669
+ taxTermsAmt: number;
1670
+ /** P21 tax amount paid on the invoice hdr */
1671
+ taxAmountPaid: number;
1672
+ /** P21 reason credit memo code UID */
1673
+ reasonCreditMemoCodeUid: number | null;
1674
+ /** P21 source credit memo code UID */
1675
+ sourceCreditMemoCodeUid: number | null;
1676
+ /** P21 external claim ID (max 255 chars) */
1677
+ externalClaimId: string | null;
1678
+ /** P21 bill2 address3 on the invoice hdr (max 50 chars) */
1679
+ bill2Address3: string | null;
1680
+ /** P21 ship2 address3 on the invoice hdr (max 50 chars) */
1681
+ ship2Address3: string | null;
1682
+ /** P21 eft exported date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1683
+ eftExportedDate: string | null;
1684
+ /** P21 courtesy invoice flag (max 1 chars) */
1685
+ courtesyInvoiceFlag: string | null;
1686
+ /** P21 iva withheld amount */
1687
+ ivaWithheldAmount: number;
1688
+ /** P21 carrier ID (carrier.carrier_id) */
1689
+ carrierId: number | null;
1690
+ /** P21 free out freight min met flag (max 1 chars) */
1691
+ freeOutFreightMinMetFlag: string | null;
1692
+ /** P21 reg num of packages on the invoice hdr (max 255 chars) */
1693
+ regNumOfPackages: string | null;
1694
+ /** P21 ship2 latitude on the invoice hdr (max 20 chars) */
1695
+ ship2Latitude: string | null;
1696
+ /** P21 ship2 longitude on the invoice hdr (max 20 chars) */
1697
+ ship2Longitude: string | null;
1698
+ /** P21 delivery number */
1699
+ deliveryNo: number | null;
1700
+ /** P21 allowed amt reason ID (max 255 chars) */
1701
+ allowedAmtReasonId: string | null;
1702
+ /** P21 total service amount redeemed on the invoice hdr */
1703
+ totalServiceAmountRedeemed: number | null;
1704
+ /** P21 customer claim number (max 255 chars) */
1705
+ customerClaimNo: string | null;
1706
+ /** P21 claim type on the invoice hdr (max 255 chars) */
1707
+ claimType: string | null;
1708
+ /** P21 claim coop flag (max 1 chars) */
1709
+ claimCoopFlag: string | null;
1710
+ /** P21 bill to supplier flag (max 1 chars) */
1711
+ billToSupplierFlag: string | null;
1712
+ /** P21 cust price prot var acct number (max 32 chars) */
1713
+ custPriceProtVarAcctNo: string | null;
1714
+ /** P21 consolidated type flag (max 1 chars) */
1715
+ consolidatedTypeFlag: string | null;
1716
+ /** P21 merchandise invoice flag (max 1 chars) */
1717
+ merchandiseInvoiceFlag: string | null;
1718
+ /** P21 sales market group UID */
1719
+ salesMarketGroupUid: number | null;
1720
+ /** P21 actual freight cost on the invoice hdr */
1721
+ actualFreightCost: number | null;
1722
+ /** P21 eco fee amount */
1723
+ ecoFeeAmt: number | null;
1724
+ /** P21 frght disc taken on the invoice hdr */
1725
+ frghtDiscTaken: number;
1726
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
1727
+ updateCd: number;
1728
+ /** Process code (704 = queued for processing, 1185 = complete) */
1729
+ processCd: number;
1730
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
1731
+ statusCd: number;
1732
+ [key: string]: unknown;
1733
+ }
1734
+ /** Returned by: api.orders.invoiceHdr.list(params) */
1735
+ export type InvoiceHdrListData = InvoiceHdrListItem[];
1736
+ /**
1737
+ * Get Invoice Hdr
1738
+ * Response data for GET /invoice-hdr/{invoiceNo} — MINIMUM fields, extras pass through
1739
+ *
1740
+ * Returned by: api.orders.invoiceHdr.get(invoiceNo)
1741
+ */
1742
+ export type InvoiceHdrGetData = InvoiceHdrListItem;
1743
+ /**
1744
+ * Reprint the invoice
1745
+ * Response data for GET /invoice-hdr/{invoiceNo}/reprint — MINIMUM fields, extras pass through
1746
+ *
1747
+ * Returned by: api.orders.invoiceHdr.reprint.list(invoiceNo)
1748
+ */
1749
+ export interface InvoiceHdrReprintListDataOption1 {
1750
+ /** Prophet 21 form the document was rendered from */
1751
+ documentId: string | null;
1752
+ /** File name of the rendered document */
1753
+ fileName: string | null;
1754
+ /** Document name */
1755
+ documentName: string | null;
1756
+ /** MIME type of documentData (e.g. application/pdf) */
1757
+ documentContentType: string | null;
1758
+ /** The rendered document, base64 encoded */
1759
+ documentData: string | null;
1760
+ [key: string]: unknown;
1761
+ }
1762
+ /**
1763
+ * Reprint the invoice
1764
+ * Response data for GET /invoice-hdr/{invoiceNo}/reprint — MINIMUM fields, extras pass through
1765
+ *
1766
+ * Returned by: api.orders.invoiceHdr.reprint.list(invoiceNo)
1767
+ */
1768
+ export type InvoiceHdrReprintListData = InvoiceHdrReprintListDataOption1;
1769
+ /**
1770
+ * List Invoice Line Rows
1771
+ * Response data for GET /invoice-line — MINIMUM fields, extras pass through
1772
+ *
1773
+ * Returned by: api.orders.invoiceLine.list(params) (array items)
1774
+ * Returned by: api.orders.invoiceLine.get(invoiceLineUid)
1775
+ */
1776
+ export interface InvoiceLineListItem {
1777
+ /** P21 invoice number (max 10 chars) */
1778
+ invoiceNo: string;
1779
+ /** P21 qty requested on the invoice line */
1780
+ qtyRequested: number;
1781
+ /** P21 quantity shipped */
1782
+ qtyShipped: number;
1783
+ /** P21 unit of measure (max 10 chars) */
1784
+ unitOfMeasure: string | null;
1785
+ /** P21 item ID (inv_mast.item_id) (max 40 chars) */
1786
+ itemId: string | null;
1787
+ /** P21 item description (max 40 chars) */
1788
+ itemDesc: string;
1789
+ /** P21 unit price */
1790
+ unitPrice: number;
1791
+ /** P21 extended price on the invoice line */
1792
+ extendedPrice: number;
1793
+ /** P21 gl revenue account number (max 32 chars) */
1794
+ glRevenueAccountNo: string | null;
1795
+ /** P21 gl salse tax account number (max 32 chars) */
1796
+ glSalseTaxAccountNo: string | null;
1797
+ /** P21 gl cogs on the invoice line (max 32 chars) */
1798
+ glCogs: string | null;
1799
+ /** P21 gl inventory on the invoice line (max 32 chars) */
1800
+ glInventory: string | null;
1801
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1802
+ dateCreated: string;
1803
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1804
+ dateLastModified: string;
1805
+ /** P21 user who last changed the row (max 30 chars) */
1806
+ lastMaintainedBy: string;
1807
+ /** P21 order number (oe_hdr.order_no) (max 8 chars) */
1808
+ orderNo: string | null;
1809
+ /** P21 cogs amount */
1810
+ cogsAmount: number;
1811
+ /** P21 job ID (max 32 chars) */
1812
+ jobId: string | null;
1813
+ /** P21 customer part number on the invoice line (max 40 chars) */
1814
+ customerPartNumber: string | null;
1815
+ /** P21 company ID (max 8 chars) */
1816
+ companyId: string | null;
1817
+ /** P21 tax item on the invoice line (max 1 chars) */
1818
+ taxItem: string | null;
1819
+ /** P21 pricing quantity on the invoice line */
1820
+ pricingQuantity: number | null;
1821
+ /** P21 net quantity on the invoice line */
1822
+ netQuantity: number | null;
1823
+ /** P21 line number */
1824
+ lineNo: number;
1825
+ /** P21 sales cost on the invoice line */
1826
+ salesCost: number;
1827
+ /** P21 commission cost on the invoice line */
1828
+ commissionCost: number;
1829
+ /** P21 other cost on the invoice line */
1830
+ otherCost: number;
1831
+ /** P21 oe line number on the invoice line */
1832
+ oeLineNumber: number | null;
1833
+ /** P21 other charge item on the invoice line (max 1 chars) */
1834
+ otherChargeItem: string | null;
1835
+ /** P21 exceptional sales on the invoice line (max 1 chars) */
1836
+ exceptionalSales: string;
1837
+ /** P21 pricing unit on the invoice line (max 8 chars) */
1838
+ pricingUnit: string | null;
1839
+ /** P21 invoice line UID (primary key) */
1840
+ invoiceLineUid: number;
1841
+ /** P21 parent invoice line UID (invoice_line.invoice_line_uid) */
1842
+ invoiceLineUidParent: number;
1843
+ /** P21 item UID (inv_mast.inv_mast_uid) */
1844
+ invMastUid: number | null;
1845
+ /** P21 invoice line type on the invoice line */
1846
+ invoiceLineType: number;
1847
+ /** P21 sales unit size on the invoice line */
1848
+ salesUnitSize: number | null;
1849
+ /** P21 pricing unit size on the invoice line */
1850
+ pricingUnitSize: number | null;
1851
+ /** P21 product group ID (max 8 chars) */
1852
+ productGroupId: string | null;
1853
+ /** P21 supplier ID (supplier.supplier_id) */
1854
+ supplierId: number | null;
1855
+ /** P21 user who created the row (max 255 chars) */
1856
+ createdBy: string | null;
1857
+ /** P21 job price line UID (job_price_line.job_price_line_uid) */
1858
+ jobPriceLineUid: number | null;
1859
+ /** P21 cost center on the invoice line (max 255 chars) */
1860
+ costCenter: string | null;
1861
+ /** P21 budget code (max 255 chars) */
1862
+ budgetCd: string | null;
1863
+ /** P21 customer contract UID */
1864
+ customerContractUid: number | null;
1865
+ /** P21 gl applied labor on the invoice line (max 32 chars) */
1866
+ glAppliedLabor: string | null;
1867
+ /** P21 labor amount */
1868
+ laborAmount: number | null;
1869
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
1870
+ updateCd: number;
1871
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
1872
+ statusCd: number;
1873
+ /** Process code (704 = queued for processing, 1185 = complete) */
1874
+ processCd: number;
1875
+ [key: string]: unknown;
1876
+ }
1877
+ /** Returned by: api.orders.invoiceLine.list(params) */
1878
+ export type InvoiceLineListData = InvoiceLineListItem[];
1879
+ /**
1880
+ * Get Invoice Line
1881
+ * Response data for GET /invoice-line/{invoiceLineUid} — MINIMUM fields, extras pass through
1882
+ *
1883
+ * Returned by: api.orders.invoiceLine.get(invoiceLineUid)
1884
+ */
1885
+ export type InvoiceLineGetData = InvoiceLineListItem;
1886
+ /**
1887
+ * List Oe Hdr Rows
1888
+ * Response data for GET /oe-hdr — MINIMUM fields, extras pass through
1889
+ *
1890
+ * Returned by: api.orders.oeHdr.list(params) (array items)
1891
+ */
1892
+ export interface OeHdrListItem {
1893
+ /** Prophet 21 order number (max 8 chars) */
1894
+ orderNo: string;
1895
+ /** Unique id of the order header */
1896
+ oeHdrUid: number;
1897
+ /** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1898
+ dateCreated: string;
1899
+ /** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1900
+ dateLastModified: string;
1901
+ /** Prophet 21 customer the order is for */
1902
+ customerId: number;
1903
+ /** When the order was placed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1904
+ orderDate: string | null;
1905
+ /** Customer purchase order number (max 50 chars) */
1906
+ poNo: string | null;
1907
+ /** Y when the order is complete (max 1 chars) */
1908
+ completed: string | null;
1909
+ /** Prophet 21 company (max 8 chars) */
1910
+ companyId: string | null;
1911
+ /** Prophet 21 address id of the carrier */
1912
+ carrierId: number | null;
1913
+ /**
1914
+ * When Augur last checked the order against Prophet 21 (mysql-datetime, e.g. 2025-07-30 15:50:49)
1915
+ */
1916
+ dateLastChecked: string;
1917
+ /** Update code (704 = queued for refresh from Prophet 21, 1185 = current) */
1918
+ updateCd: number;
1919
+ /** Web order reference number; null for orders not placed on the web (max 255 chars) */
1920
+ webReferenceNo: string | null;
1921
+ /** Ship-to name (max 50 chars) */
1922
+ ship2Name: string | null;
1923
+ /** Ship-to address line 1 (max 50 chars) */
1924
+ ship2Add1: string | null;
1925
+ /** Ship-to address line 2 (max 50 chars) */
1926
+ ship2Add2: string | null;
1927
+ /** Ship-to city (max 50 chars) */
1928
+ ship2City: string | null;
1929
+ /** Ship-to state or province (max 50 chars) */
1930
+ ship2State: string | null;
1931
+ /** Ship-to postal code (max 10 chars) */
1932
+ ship2Zip: string | null;
1933
+ /** Ship-to country (max 50 chars) */
1934
+ ship2Country: string | null;
1935
+ /** Ship-to email address (max 255 chars) */
1936
+ ship2EmailAddress: string | null;
1937
+ /** Ship-to address line 3 (max 50 chars) */
1938
+ ship2Add3: string | null;
1939
+ /** Ship-to phone number (max 20 chars) */
1940
+ shipToPhone: string | null;
1941
+ /** Prophet 21 location the order ships from */
1942
+ locationId: number | null;
1943
+ /** Delivery instructions for the carrier (max 255 chars) */
1944
+ deliveryInstructions: string | null;
1945
+ /** Y when the order is canceled (max 1 chars) */
1946
+ cancelFlag: string | null;
1947
+ /** Prophet 21 user who took the order (max 30 chars) */
1948
+ taker: string | null;
1949
+ /** Shipping route assigned to the order */
1950
+ shippingRouteUid: number | null;
1951
+ /** Prophet 21 payment terms (max 2 chars) */
1952
+ terms: string | null;
1953
+ /** Y when the order is approved (max 1 chars) */
1954
+ approved: string | null;
1955
+ /** Order class 1 (max 8 chars) */
1956
+ class1id: string | null;
1957
+ /** Order class 2 (max 8 chars) */
1958
+ class2id: string | null;
1959
+ /** Order class 3 (max 8 chars) */
1960
+ class3id: string | null;
1961
+ /** Order class 4 (max 8 chars) */
1962
+ class4id: string | null;
1963
+ /** Order class 5 (max 8 chars) */
1964
+ class5id: string | null;
1965
+ /** Prophet 21 contact who placed the order (max 16 chars) */
1966
+ contactId: string | null;
1967
+ /** Y when the order is projected (not yet firm) (max 1 chars) */
1968
+ projectedOrder: string | null;
1969
+ /** Prophet 21 source code of the order (706 = Order Entry) */
1970
+ sourceCodeNo: number;
1971
+ /** Order priority */
1972
+ orderPriorityUid: number | null;
1973
+ /** Outgoing freight charged on the order */
1974
+ freightOut: number;
1975
+ /** Y when the order is an RMA (max 1 chars) */
1976
+ rmaFlag: string | null;
1977
+ /** When the order was completed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1978
+ dateOrderCompleted: string | null;
1979
+ /** Job name (max 40 chars) */
1980
+ jobName: string | null;
1981
+ /** Date the customer requested the order (mysql-datetime, e.g. 2025-07-30 15:50:49) */
1982
+ requestedDate: string | null;
1983
+ /** Augur status code of the record */
1984
+ statusCd: number;
1985
+ /** Down payment requested on the order */
1986
+ requestedDownpayment: number | null;
1987
+ /** Y when the down payment has been invoiced (max 1 chars) */
1988
+ downpaymentInvoiced: string | null;
1989
+ /** Order validation status (max 8 chars) */
1990
+ validationStatus: string | null;
1991
+ /** Prophet 21 address of the order */
1992
+ addressId: number | null;
1993
+ /** Y when the order is deleted (max 1 chars) */
1994
+ deleteFlag: string;
1995
+ /** Process code (704 = queued for processing, 1185 = complete) */
1996
+ processCd: number;
1997
+ [key: string]: unknown;
1998
+ }
1999
+ /** Returned by: api.orders.oeHdr.list(params) */
2000
+ export type OeHdrListData = OeHdrListItem[];
2001
+ /**
2002
+ * List Oe Hdr Notepad Rows
2003
+ * Response data for GET /oe-hdr-notepad — MINIMUM fields, extras pass through
2004
+ *
2005
+ * Returned by: api.orders.oeHdrNotepad.list(params) (array items)
2006
+ * Returned by: api.orders.oeHdrNotepad.get(noteId)
2007
+ */
2008
+ export interface OeHdrNotepadListItem {
2009
+ /** P21 note ID */
2010
+ noteId: number;
2011
+ /** P21 order number (oe_hdr.order_no) (max 8 chars) */
2012
+ orderNo: string | null;
2013
+ /** P21 notepad class ID (max 8 chars) */
2014
+ notepadClassId: string | null;
2015
+ /** P21 note topic (max 30 chars) */
2016
+ topic: string;
2017
+ /** P21 note text */
2018
+ note: string | null;
2019
+ /** P21 activation date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2020
+ activationDate: string;
2021
+ /** P21 expiration date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2022
+ expirationDate: string;
2023
+ /** P21 entry date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2024
+ entryDate: string;
2025
+ /** P21 mandatory on the oe hdr notepad (max 1 chars) */
2026
+ mandatory: string;
2027
+ /** Y when P21 marks the row deleted (max 1 chars) */
2028
+ deleteFlag: string;
2029
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2030
+ dateCreated: string;
2031
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2032
+ dateLastModified: string;
2033
+ /** P21 user who last changed the row (max 30 chars) */
2034
+ lastMaintainedBy: string;
2035
+ /** P21 default in oe on the oe hdr notepad (max 1 chars) */
2036
+ defaultInOe: string;
2037
+ /** P21 general note on the oe hdr notepad (max 1 chars) */
2038
+ generalNote: string | null;
2039
+ /** P21 user who created the row (max 255 chars) */
2040
+ createdBy: string;
2041
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
2042
+ updateCd: number;
2043
+ /** Process code (704 = queued for processing, 1185 = complete) */
2044
+ processCd: number;
2045
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
2046
+ statusCd: number;
2047
+ [key: string]: unknown;
2048
+ }
2049
+ /** Returned by: api.orders.oeHdrNotepad.list(params) */
2050
+ export type OeHdrNotepadListData = OeHdrNotepadListItem[];
2051
+ /**
2052
+ * Get Oe Hdr Notepad
2053
+ * Response data for GET /oe-hdr-notepad/{noteId} — MINIMUM fields, extras pass through
2054
+ *
2055
+ * Returned by: api.orders.oeHdrNotepad.get(noteId)
2056
+ */
2057
+ export type OeHdrNotepadGetData = OeHdrNotepadListItem;
2058
+ /**
2059
+ * List Oe Hdr Rma Rows
2060
+ * Response data for GET /oe-hdr-rma — MINIMUM fields, extras pass through
2061
+ *
2062
+ * Returned by: api.orders.oeHdrRma.list(params) (array items)
2063
+ * Returned by: api.orders.oeHdrRma.get(oeHdrRmaUid)
2064
+ */
2065
+ export interface OeHdrRmaListItem {
2066
+ /** P21 oe hdr rma UID (primary key) */
2067
+ oeHdrRmaUid: number;
2068
+ /** P21 order header UID (oe_hdr.oe_hdr_uid) */
2069
+ oeHdrUid: number;
2070
+ /** P21 apply credit to invoice number (max 1 chars) */
2071
+ applyCreditToInvoiceNo: string;
2072
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2073
+ dateCreated: string;
2074
+ /** P21 user who created the row (max 255 chars) */
2075
+ createdBy: string;
2076
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2077
+ dateLastModified: string;
2078
+ /** P21 user who last changed the row (max 255 chars) */
2079
+ lastMaintainedBy: string;
2080
+ /** P21 retrieved by wms on the oe hdr rma (max 1 chars) */
2081
+ retrievedByWms: string;
2082
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
2083
+ updateCd: number;
2084
+ /** Process code (704 = queued for processing, 1185 = complete) */
2085
+ processCd: number;
2086
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
2087
+ statusCd: number;
2088
+ [key: string]: unknown;
2089
+ }
2090
+ /** Returned by: api.orders.oeHdrRma.list(params) */
2091
+ export type OeHdrRmaListData = OeHdrRmaListItem[];
2092
+ /**
2093
+ * Get Oe Hdr Rma
2094
+ * Response data for GET /oe-hdr-rma/{oeHdrRmaUid} — MINIMUM fields, extras pass through
2095
+ *
2096
+ * Returned by: api.orders.oeHdrRma.get(oeHdrRmaUid)
2097
+ */
2098
+ export type OeHdrRmaGetData = OeHdrRmaListItem;
2099
+ /**
2100
+ * List Oe Hdr Salesrep Rows
2101
+ * Response data for GET /oe-hdr-salesrep — MINIMUM fields, extras pass through
2102
+ *
2103
+ * Returned by: api.orders.oeHdrSalesrep.list(params) (array items)
2104
+ */
2105
+ export interface OeHdrSalesrepListItem {
2106
+ /** P21 order number on the oe hdr salesrep (max 8 chars) */
2107
+ orderNumber: string;
2108
+ /** P21 sales rep ID (salesrep.salesrep_id) (max 16 chars) */
2109
+ salesrepId: string;
2110
+ /** P21 commission split on the oe hdr salesrep */
2111
+ commissionSplit: number;
2112
+ /** Y when P21 marks the row deleted (max 1 chars) */
2113
+ deleteFlag: string;
2114
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2115
+ dateCreated: string;
2116
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2117
+ dateLastModified: string;
2118
+ /** P21 user who last changed the row (max 30 chars) */
2119
+ lastMaintainedBy: string;
2120
+ /** P21 date paid on the oe hdr salesrep (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2121
+ datePaid: string | null;
2122
+ /** P21 primary salesrep on the oe hdr salesrep (max 1 chars) */
2123
+ primarySalesrep: string | null;
2124
+ /** P21 exclude split validation flag (max 1 chars) */
2125
+ excludeSplitValidationFlag: string;
2126
+ /** P21 commission override percent on the oe hdr salesrep */
2127
+ commissionOverridePercent: number | null;
2128
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
2129
+ updateCd: number;
2130
+ /** Process code (704 = queued for processing, 1185 = complete) */
2131
+ processCd: number;
2132
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
2133
+ statusCd: number;
2134
+ [key: string]: unknown;
2135
+ }
2136
+ /** Returned by: api.orders.oeHdrSalesrep.list(params) */
2137
+ export type OeHdrSalesrepListData = OeHdrSalesrepListItem[];
2138
+ /**
2139
+ * List Oe Hdr Ud Rows
2140
+ * Response data for GET /oe-hdr-ud — MINIMUM fields, extras pass through
2141
+ *
2142
+ * Returned by: api.orders.oeHdrUd.list(params) (array items)
2143
+ * Returned by: api.orders.oeHdrUd.get(oeHdrUdUid)
2144
+ */
2145
+ export interface OeHdrUdListItem {
2146
+ /** P21 oe hdr ud UID (primary key) */
2147
+ oeHdrUdUid: number;
2148
+ /** P21 order number (oe_hdr.order_no) (max 8 chars) */
2149
+ orderNo: string;
2150
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2151
+ dateCreated: string;
2152
+ /** P21 user who created the row (max 255 chars) */
2153
+ createdBy: string;
2154
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2155
+ dateLastModified: string;
2156
+ /** P21 user who last changed the row (max 255 chars) */
2157
+ lastMaintainedBy: string;
2158
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
2159
+ updateCd: number;
2160
+ /** P21 user data on the oe hdr ud */
2161
+ userData: string | null;
2162
+ /** Process code (704 = queued for processing, 1185 = complete) */
2163
+ processCd: number;
2164
+ /** P21 date last processed on the oe hdr ud (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2165
+ dateLastProcessed: string;
2166
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
2167
+ statusCd: number;
2168
+ [key: string]: unknown;
2169
+ }
2170
+ /** Returned by: api.orders.oeHdrUd.list(params) */
2171
+ export type OeHdrUdListData = OeHdrUdListItem[];
2172
+ /**
2173
+ * Get Oe Hdr Ud
2174
+ * Response data for GET /oe-hdr-ud/{oeHdrUdUid} — MINIMUM fields, extras pass through
2175
+ *
2176
+ * Returned by: api.orders.oeHdrUd.get(oeHdrUdUid)
2177
+ */
2178
+ export type OeHdrUdGetData = OeHdrUdListItem;
2179
+ /**
2180
+ * Search order headers
2181
+ * Response data for GET /oe-hdr/lookup — MINIMUM fields, extras pass through
2182
+ *
2183
+ * Returned by: api.orders.oeHdr.lookup.get(params) (array items)
2184
+ */
2185
+ export interface OeHdrLookupGetItem {
2186
+ /** Order header ID */
2187
+ oeHdrUid: number;
2188
+ /** Prophet 21 order number (max 8 chars) */
2189
+ orderNo: string;
2190
+ /** Customer purchase order number (max 50 chars) */
2191
+ poNo: string | null;
2192
+ /** Prophet 21 customer the order belongs to */
2193
+ customerId: number;
2194
+ /** Ship-to name (max 50 chars) */
2195
+ ship2Name: string | null;
2196
+ /** Ship-to email address (max 255 chars) */
2197
+ ship2EmailAddress: string | null;
2198
+ /** Web order reference number from the storefront (max 255 chars) */
2199
+ webReferenceNo: string | null;
2200
+ /** Customer name */
2201
+ customerName: string | null;
2202
+ /** Y when the order is complete (fully shipped) (max 1 chars) */
2203
+ completed: string | null;
2204
+ /** Date the order was placed (Y-m-d); empty when unknown */
2205
+ orderDate: string;
2206
+ /** User who entered the order (max 30 chars) */
2207
+ taker: string | null;
2208
+ /** Order class 1 */
2209
+ class1Id: string | null;
2210
+ /** Job name entered on the order (max 40 chars) */
2211
+ jobName: string | null;
2212
+ /**
2213
+ * PENDING, SUBMITTED, IN PROCESS, ON HOLD or SHIPPED, derived from the completed, approved,
2214
+ * cancel and validation flags
2215
+ */
2216
+ orderStatus: string;
2217
+ [key: string]: unknown;
2218
+ }
2219
+ /** Returned by: api.orders.oeHdr.lookup.get(params) */
2220
+ export type OeHdrLookupGetData = OeHdrLookupGetItem[];
2221
+ /**
2222
+ * Shape of `lines` (MINIMUM fields; reused wherever the same shape appears)
2223
+ * Order lines, by line number
2224
+ *
2225
+ * Field `lines` of OeHdrDocListData
2226
+ */
2227
+ export interface OeHdrDocListDataLinesItem {
2228
+ /** Item (inv_mast) ordered on the line */
2229
+ invMastUid: number;
2230
+ /** Y when the line is canceled (max 1 chars) */
2231
+ cancelFlag: string | null;
2232
+ /** Y when the line is complete (max 1 chars) */
2233
+ complete: string | null;
2234
+ /** Y when the line is deleted in Prophet 21 (max 1 chars) */
2235
+ deleteFlag: string;
2236
+ /** Prophet 21 disposition code for unallocated quantity (e.g. B = backorder) (max 1 chars) */
2237
+ disposition: string | null;
2238
+ /** Item description */
2239
+ itemDesc: string | null;
2240
+ /** Item description shown on the storefront */
2241
+ displayDesc: string | null;
2242
+ /** Item ID */
2243
+ itemId: string;
2244
+ /** Item short code */
2245
+ shortCode: string | null;
2246
+ /** Line number on the order */
2247
+ lineNo: number;
2248
+ /** Order the line belongs to (max 8 chars) */
2249
+ orderNo: string;
2250
+ /** Quantity on the line when it was entered */
2251
+ originalQtyOrdered: number | null;
2252
+ /** Quantity allocated from stock */
2253
+ qtyAllocated: number | null;
2254
+ /** Quantity canceled */
2255
+ qtyCanceled: number | null;
2256
+ /** Quantity invoiced */
2257
+ qtyInvoiced: number | null;
2258
+ /** Quantity on open pick tickets */
2259
+ qtyOnPickTickets: number | null;
2260
+ /** Quantity ordered */
2261
+ qtyOrdered: number | null;
2262
+ /** Unit of measure the line was sold in (max 8 chars) */
2263
+ unitOfMeasure: string | null;
2264
+ /** Quantity in the line's unit of measure */
2265
+ unitQuantity: number;
2266
+ /** Base units per unit of measure */
2267
+ unitSize: number;
2268
+ /** Price per unit of measure */
2269
+ unitPrice: number | null;
2270
+ /** Line total */
2271
+ extendedPrice: number | null;
2272
+ /** Order line ID */
2273
+ oeLineUid: number;
2274
+ /** Parent line's oeLineUid for an assembly component; 0 for a top-level line */
2275
+ parentOeLineUid: number;
2276
+ /** Trinity private-label item ID (trinitysurfaces only) */
2277
+ trinityItemId: string | null;
2278
+ /** Trinity private-label item description (trinitysurfaces only) */
2279
+ trinityItemDesc: string | null;
2280
+ /** Agent private-label item ID (trinitysurfaces only) */
2281
+ agentItemId: string | null;
2282
+ /** Agent private-label item description (trinitysurfaces only) */
2283
+ agentItemDesc: string | null;
2284
+ [key: string]: unknown;
2285
+ }
2286
+ /**
2287
+ * Shape of `lines` (MINIMUM fields; reused wherever the same shape appears)
2288
+ * Lines on the pick ticket
2289
+ *
2290
+ * Field `lines` of OeHdrDocListDataPickTicketsItem
2291
+ */
2292
+ export interface OeHdrDocListDataPickTicketsItemLinesItem {
2293
+ /** Line number on the pick ticket */
2294
+ lineNumber: number;
2295
+ /** Quantity shipped */
2296
+ shipQuantity: number | null;
2297
+ /** Quantity requested for picking */
2298
+ qtyRequested: number | null;
2299
+ /** Item (inv_mast) on the line */
2300
+ invMastUid: number;
2301
+ /** Item ID */
2302
+ itemId: string;
2303
+ /** Item description */
2304
+ itemDesc: string | null;
2305
+ /** Item description shown on the storefront */
2306
+ displayDesc: string | null;
2307
+ /** Trinity private-label item ID (trinitysurfaces only) */
2308
+ trinityItemId: string | null;
2309
+ /** Trinity private-label item description (trinitysurfaces only) */
2310
+ trinityItemDesc: string | null;
2311
+ /** Agent private-label item ID (trinitysurfaces only) */
2312
+ agentItemId: string | null;
2313
+ /** Agent private-label item description (trinitysurfaces only) */
2314
+ agentItemDesc: string | null;
2315
+ [key: string]: unknown;
2316
+ }
2317
+ /**
2318
+ * Shape of `pickTickets` (MINIMUM fields; reused wherever the same shape appears)
2319
+ * Pick tickets issued for the order
2320
+ *
2321
+ * Field `pickTickets` of OeHdrDocListData
2322
+ */
2323
+ export interface OeHdrDocListDataPickTicketsItem {
2324
+ /** Pick ticket number */
2325
+ pickTicketNo: number;
2326
+ /** Carrier tracking number (max 40 chars) */
2327
+ trackingNo: string | null;
2328
+ /** Order the pick ticket belongs to (max 8 chars) */
2329
+ orderNo: string;
2330
+ /** Invoice raised for the pick ticket; null until invoiced */
2331
+ invoiceNo: number | null;
2332
+ /** Date the pick ticket shipped (Y-m-d) */
2333
+ shipDate: string | null;
2334
+ /** Y when the pick ticket has been printed (max 1 chars) */
2335
+ printedFlag: string | null;
2336
+ /** Date the pick ticket was printed (Y-m-d) */
2337
+ printDate: string | null;
2338
+ /** Picking or shipping instructions (max 255 chars) */
2339
+ instructions: string | null;
2340
+ /** Prophet 21 address id of the pick ticket's carrier */
2341
+ carrierId: number | null;
2342
+ /** Carrier name; empty when the pick ticket has no carrier */
2343
+ carrierName: string;
2344
+ /** Lines on the pick ticket */
2345
+ lines: OeHdrDocListDataPickTicketsItemLinesItem[];
2346
+ [key: string]: unknown;
2347
+ }
2348
+ /**
2349
+ * get the order document
2350
+ * Response data for GET /oe-hdr/{orderNo}/doc — MINIMUM fields, extras pass through
2351
+ *
2352
+ * Returned by: api.orders.oeHdr.doc.list(orderNo, params)
2353
+ */
2354
+ export interface OeHdrDocListData {
2355
+ /** Prophet 21 order number (max 8 chars) */
2356
+ orderNo: string;
2357
+ /** Prophet 21 customer the order belongs to */
2358
+ customerId: number;
2359
+ /** Customer name */
2360
+ customerName: string | null;
2361
+ /** Job name entered on the order (max 40 chars) */
2362
+ jobName: string | null;
2363
+ /** Date the order was placed (Y-m-d) */
2364
+ orderDate: string | null;
2365
+ /** Date the customer requested delivery (Y-m-d) */
2366
+ requestedDate: string | null;
2367
+ /** Y when the order is canceled (max 1 chars) */
2368
+ cancelFlag: string | null;
2369
+ /** Y when the order is complete (fully shipped) (max 1 chars) */
2370
+ completed: string | null;
2371
+ /** Y when the order is deleted in Prophet 21 (max 1 chars) */
2372
+ deleteFlag: string;
2373
+ /** Customer purchase order number (max 50 chars) */
2374
+ poNo: string | null;
2375
+ /** Ship-to name (max 50 chars) */
2376
+ ship2Name: string | null;
2377
+ /** Ship-to address line 1 (max 50 chars) */
2378
+ ship2Add1: string | null;
2379
+ /** Ship-to address line 2 (max 50 chars) */
2380
+ ship2Add2: string | null;
2381
+ /** Ship-to address line 3 (max 50 chars) */
2382
+ ship2Add3: string | null;
2383
+ /** Ship-to city (max 50 chars) */
2384
+ ship2City: string | null;
2385
+ /** Ship-to state or province (max 50 chars) */
2386
+ ship2State: string | null;
2387
+ /** Ship-to postal code (max 10 chars) */
2388
+ ship2Zip: string | null;
2389
+ /** Ship-to country (max 50 chars) */
2390
+ ship2Country: string | null;
2391
+ /** Ship-to email address (max 255 chars) */
2392
+ ship2EmailAddress: string | null;
2393
+ /** Ship-to phone number (max 20 chars) */
2394
+ shipToPhone: string | null;
2395
+ /** Delivery instructions for the carrier (max 255 chars) */
2396
+ deliveryInstructions: string | null;
2397
+ /** Order class 1 */
2398
+ class1Id: string | null;
2399
+ /** Order class 2 */
2400
+ class2Id: string | null;
2401
+ /** Order class 3 */
2402
+ class3Id: string | null;
2403
+ /** Order class 4 */
2404
+ class4Id: string | null;
2405
+ /** Order class 5 */
2406
+ class5Id: string | null;
2407
+ /** Prophet 21 contact who placed the order (max 16 chars) */
2408
+ contactId: string | null;
2409
+ /** Web order reference number from the storefront (max 255 chars) */
2410
+ webReferenceNo: string | null;
2411
+ /**
2412
+ * PENDING, SUBMITTED, IN PROCESS, ON HOLD or SHIPPED, derived from the completed, approved,
2413
+ * cancel and validation flags
2414
+ */
2415
+ orderStatus: string;
2416
+ /** User who entered the order (max 30 chars) */
2417
+ taker: string | null;
2418
+ /** First name of the ordering contact; null when the order has no contact */
2419
+ contactFirstName: string | null;
2420
+ /** Last name of the ordering contact; null when the order has no contact */
2421
+ contactLastName: string | null;
2422
+ /** Prophet 21 address id of the order's carrier */
2423
+ carrierId: number | null;
2424
+ /** Carrier name; empty when the order has no carrier */
2425
+ carrierName: string;
2426
+ /** Order lines, by line number */
2427
+ lines: OeHdrDocListDataLinesItem[];
2428
+ /** Pick tickets issued for the order */
2429
+ pickTickets: OeHdrDocListDataPickTicketsItem[];
2430
+ [key: string]: unknown;
2431
+ }
2432
+ /**
2433
+ * List Oe Line Rows
2434
+ * Response data for GET /oe-line — MINIMUM fields, extras pass through
2435
+ *
2436
+ * Returned by: api.orders.oeLine.list(params) (array items)
2437
+ * Returned by: api.orders.oeLine.get(oeLineUid)
2438
+ */
2439
+ export interface OeLineListItem {
2440
+ /** P21 order number (oe_hdr.order_no) (max 8 chars) */
2441
+ orderNo: string;
2442
+ /** P21 line number */
2443
+ lineNo: number;
2444
+ /** P21 company number (max 8 chars) */
2445
+ companyNo: string;
2446
+ /** Y when P21 marks the row deleted (max 1 chars) */
2447
+ deleteFlag: string;
2448
+ /** P21 item UID (inv_mast.inv_mast_uid) */
2449
+ invMastUid: number;
2450
+ /** P21 unit price */
2451
+ unitPrice: number | null;
2452
+ /** P21 quantity ordered */
2453
+ qtyOrdered: number | null;
2454
+ /** P21 manual price overide on the oe line (max 1 chars) */
2455
+ manualPriceOveride: string | null;
2456
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2457
+ dateCreated: string;
2458
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2459
+ dateLastModified: string;
2460
+ /** P21 extended price on the oe line */
2461
+ extendedPrice: number | null;
2462
+ /** P21 sales tax on the oe line */
2463
+ salesTax: number | null;
2464
+ /** P21 complete on the oe line (max 1 chars) */
2465
+ complete: string | null;
2466
+ /** P21 unit of measure (max 8 chars) */
2467
+ unitOfMeasure: string | null;
2468
+ /** P21 disposition on the oe line (max 1 chars) */
2469
+ disposition: string | null;
2470
+ /** P21 quantity allocated */
2471
+ qtyAllocated: number | null;
2472
+ /** P21 qty on pick tickets on the oe line */
2473
+ qtyOnPickTickets: number | null;
2474
+ /** P21 quantity invoiced */
2475
+ qtyInvoiced: number | null;
2476
+ /** P21 unit size */
2477
+ unitSize: number;
2478
+ /** P21 unit quantity */
2479
+ unitQuantity: number;
2480
+ /** P21 customer part number on the oe line (max 40 chars) */
2481
+ customerPartNumber: string;
2482
+ /** P21 sales cost on the oe line */
2483
+ salesCost: number | null;
2484
+ /** P21 commission cost on the oe line */
2485
+ commissionCost: number | null;
2486
+ /** P21 cancel flag (max 1 chars) */
2487
+ cancelFlag: string | null;
2488
+ /** P21 quantity canceled */
2489
+ qtyCanceled: number | null;
2490
+ /** P21 order header UID (oe_hdr.oe_hdr_uid) */
2491
+ oeHdrUid: number;
2492
+ /** P21 parent order line UID (oe_line.oe_line_uid) */
2493
+ parentOeLineUid: number;
2494
+ /** P21 order line UID (oe_line.oe_line_uid) */
2495
+ oeLineUid: number;
2496
+ /** P21 pick date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2497
+ pickDate: string | null;
2498
+ /** P21 original qty ordered on the oe line */
2499
+ originalQtyOrdered: number | null;
2500
+ /** P21 job price header UID (job_price_hdr.job_price_hdr_uid) */
2501
+ jobPriceHdrUid: number | null;
2502
+ /** P21 job price line UID (job_price_line.job_price_line_uid) */
2503
+ jobPriceLineUid: number | null;
2504
+ /** P21 cust po number (max 255 chars) */
2505
+ custPoNo: string | null;
2506
+ /** P21 job price bin UID (job_price_bin.job_price_bin_uid) */
2507
+ jobPriceBinUid: number | null;
2508
+ /** P21 carrier ID (carrier.carrier_id) */
2509
+ carrierId: number | null;
2510
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
2511
+ updateCd: number;
2512
+ /** P21 freight in on the oe line */
2513
+ freightIn: number;
2514
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
2515
+ statusCd: number;
2516
+ /** Process code (704 = queued for processing, 1185 = complete) */
2517
+ processCd: number;
2518
+ /** P21 price page UID (price_page.price_page_uid) */
2519
+ pricePageUid: number | null;
2520
+ /** P21 cost price page UID */
2521
+ costPricePageUid: number | null;
2522
+ /** P21 strategic price page UID */
2523
+ strategicPricePageUid: number | null;
2524
+ /** P21 price family UID (price_family.price_family_uid) */
2525
+ priceFamilyUid: number | null;
2526
+ [key: string]: unknown;
2527
+ }
2528
+ /** Returned by: api.orders.oeLine.list(params) */
2529
+ export type OeLineListData = OeLineListItem[];
2530
+ /**
2531
+ * List Oe Line Rma Rows
2532
+ * Response data for GET /oe-line-rma — MINIMUM fields, extras pass through
2533
+ *
2534
+ * Returned by: api.orders.oeLineRma.list(params) (array items)
2535
+ * Returned by: api.orders.oeLineRma.get(oeLineRmaUid)
2536
+ */
2537
+ export interface OeLineRmaListItem {
2538
+ /** P21 oe line rma UID (primary key) */
2539
+ oeLineRmaUid: number;
2540
+ /** P21 order line UID (oe_line.oe_line_uid) */
2541
+ oeLineUid: number;
2542
+ /** P21 rma linked oe line UID */
2543
+ rmaLinkedOeLineUid: number;
2544
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2545
+ dateCreated: string;
2546
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2547
+ dateLastModified: string;
2548
+ /** P21 user who last changed the row (max 30 chars) */
2549
+ lastMaintainedBy: string;
2550
+ /** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
2551
+ rowStatusFlag: number;
2552
+ /** P21 invoice line UID */
2553
+ invoiceLineUid: number | null;
2554
+ /** P21 retrieved by wms on the oe line rma (max 1 chars) */
2555
+ retrievedByWms: string | null;
2556
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
2557
+ updateCd: number;
2558
+ /** Process code (704 = queued for processing, 1185 = complete) */
2559
+ processCd: number;
2560
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
2561
+ statusCd: number;
2562
+ [key: string]: unknown;
2563
+ }
2564
+ /** Returned by: api.orders.oeLineRma.list(params) */
2565
+ export type OeLineRmaListData = OeLineRmaListItem[];
2566
+ /**
2567
+ * Get Oe Line Rma
2568
+ * Response data for GET /oe-line-rma/{oeLineRmaUid} — MINIMUM fields, extras pass through
2569
+ *
2570
+ * Returned by: api.orders.oeLineRma.get(oeLineRmaUid)
2571
+ */
2572
+ export type OeLineRmaGetData = OeLineRmaListItem;
2573
+ /**
2574
+ * List Oe Line Ud Rows
2575
+ * Response data for GET /oe-line-ud — MINIMUM fields, extras pass through
2576
+ *
2577
+ * Returned by: api.orders.oeLineUd.list(params) (array items)
2578
+ * Returned by: api.orders.oeLineUd.get(oeLineUdUid)
2579
+ */
2580
+ export interface OeLineUdListItem {
2581
+ /** P21 oe line ud UID (primary key) */
2582
+ oeLineUdUid: number;
2583
+ /** P21 order number (oe_hdr.order_no) (max 8 chars) */
2584
+ orderNo: string;
2585
+ /** P21 line number */
2586
+ lineNo: number;
2587
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2588
+ dateCreated: string;
2589
+ /** P21 user who created the row (max 255 chars) */
2590
+ createdBy: string;
2591
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2592
+ dateLastModified: string;
2593
+ /** P21 user who last changed the row (max 255 chars) */
2594
+ lastMaintainedBy: string;
2595
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
2596
+ updateCd: number;
2597
+ /** P21 user data on the oe line ud */
2598
+ userData: string | null;
2599
+ /** Process code (704 = queued for processing, 1185 = complete) */
2600
+ processCd: number;
2601
+ /** P21 date last processed on the oe line ud (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2602
+ dateLastProcessed: string;
2603
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
2604
+ statusCd: number;
2605
+ [key: string]: unknown;
2606
+ }
2607
+ /** Returned by: api.orders.oeLineUd.list(params) */
2608
+ export type OeLineUdListData = OeLineUdListItem[];
2609
+ /**
2610
+ * Get Oe Line Ud
2611
+ * Response data for GET /oe-line-ud/{oeLineUdUid} — MINIMUM fields, extras pass through
2612
+ *
2613
+ * Returned by: api.orders.oeLineUd.get(oeLineUdUid)
2614
+ */
2615
+ export type OeLineUdGetData = OeLineUdListItem;
2616
+ /**
2617
+ * Get Oe Line
2618
+ * Response data for GET /oe-line/{oeLineUid} — MINIMUM fields, extras pass through
2619
+ *
2620
+ * Returned by: api.orders.oeLine.get(oeLineUid)
2621
+ */
2622
+ export type OeLineGetData = OeLineListItem;
2623
+ /**
2624
+ * List Payment Detail Rows
2625
+ * Response data for GET /payment-detail — MINIMUM fields, extras pass through
2626
+ *
2627
+ * Returned by: api.orders.paymentDetail.list(params) (array items)
2628
+ * Returned by: api.orders.paymentDetail.get(paymentDetailUid)
2629
+ */
2630
+ export interface PaymentDetailListItem {
2631
+ /** P21 company number (max 8 chars) */
2632
+ companyNo: string;
2633
+ /** P21 bank number */
2634
+ bankNo: number;
2635
+ /** P21 check number (max 255 chars) */
2636
+ checkNo: string;
2637
+ /** P21 invoice number (max 32 chars) */
2638
+ invoiceNo: string;
2639
+ /** P21 purchase order number (max 50 chars) */
2640
+ poNo: string | null;
2641
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2642
+ dateCreated: string;
2643
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2644
+ dateLastModified: string;
2645
+ /** P21 user who last changed the row (max 30 chars) */
2646
+ lastMaintainedBy: string;
2647
+ /** P21 amount paid on the payment detail */
2648
+ amountPaid: number | null;
2649
+ /** P21 voucher number (max 10 chars) */
2650
+ voucherNo: string | null;
2651
+ /** P21 home amt paid on the payment detail */
2652
+ homeAmtPaid: number | null;
2653
+ /** P21 terms amount taken on the payment detail */
2654
+ termsAmountTaken: number | null;
2655
+ /** P21 amount paid display value */
2656
+ amountPaidDisplay: number | null;
2657
+ /** P21 terms amount taken display value */
2658
+ termsAmountTakenDisplay: number | null;
2659
+ /** P21 payment detail UID (primary key) */
2660
+ paymentDetailUid: number;
2661
+ /** P21 currency variance amount */
2662
+ currencyVarianceAmount: number;
2663
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
2664
+ updateCd: number;
2665
+ /** Process code (704 = queued for processing, 1185 = complete) */
2666
+ processCd: number;
2667
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
2668
+ statusCd: number;
2669
+ [key: string]: unknown;
2670
+ }
2671
+ /** Returned by: api.orders.paymentDetail.list(params) */
2672
+ export type PaymentDetailListData = PaymentDetailListItem[];
2673
+ /**
2674
+ * Get Payment Detail
2675
+ * Response data for GET /payment-detail/{paymentDetailUid} — MINIMUM fields, extras pass through
2676
+ *
2677
+ * Returned by: api.orders.paymentDetail.get(paymentDetailUid)
2678
+ */
2679
+ export type PaymentDetailGetData = PaymentDetailListItem;
2680
+ /**
2681
+ * List Payments Rows
2682
+ * Response data for GET /payments — MINIMUM fields, extras pass through
2683
+ *
2684
+ * Returned by: api.orders.payments.list(params) (array items)
2685
+ */
2686
+ export interface PaymentsListItem {
2687
+ /** P21 company number (max 8 chars) */
2688
+ companyNo: string;
2689
+ /** P21 bank number */
2690
+ bankNo: number;
2691
+ /** P21 check number (max 255 chars) */
2692
+ checkNo: string;
2693
+ /** P21 check date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2694
+ checkDate: string;
2695
+ /** P21 void on the payments (max 1 chars) */
2696
+ void: string;
2697
+ /** P21 check amount */
2698
+ checkAmount: number;
2699
+ /** P21 cleared bank on the payments (max 1 chars) */
2700
+ clearedBank: string;
2701
+ /** P21 terms taken amount */
2702
+ termsTakenAmount: number;
2703
+ /** P21 vendor ID (vendor.vendor_id) */
2704
+ vendorId: number;
2705
+ /** P21 ap account number (max 32 chars) */
2706
+ apAccountNo: string;
2707
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2708
+ dateCreated: string;
2709
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2710
+ dateLastModified: string;
2711
+ /** P21 user who last changed the row (max 30 chars) */
2712
+ lastMaintainedBy: string;
2713
+ /** P21 accounting period */
2714
+ period: number | null;
2715
+ /** P21 year for period on the payments */
2716
+ yearForPeriod: number | null;
2717
+ /** P21 currency ID (currency_hdr.currency_id) */
2718
+ currencyId: number | null;
2719
+ /** P21 home chk amount */
2720
+ homeChkAmount: number | null;
2721
+ /** P21 void period on the payments */
2722
+ voidPeriod: number | null;
2723
+ /** P21 void year on the payments */
2724
+ voidYear: number | null;
2725
+ /** P21 statement cleared date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2726
+ statementClearedDate: string | null;
2727
+ /** P21 terms taken amount display value */
2728
+ termsTakenAmountDisplay: number;
2729
+ /** P21 check amount display value */
2730
+ checkAmountDisplay: number;
2731
+ /** P21 currency variance amount */
2732
+ currencyVarianceAmount: number;
2733
+ /** P21 transmission method on the payments */
2734
+ transmissionMethod: number | null;
2735
+ /** P21 reason (max 255 chars) */
2736
+ reason: string | null;
2737
+ /** P21 cleared period on the payments */
2738
+ clearedPeriod: number | null;
2739
+ /** P21 cleared year on the payments */
2740
+ clearedYear: number | null;
2741
+ /** P21 check mailed date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2742
+ checkMailedDate: string | null;
2743
+ /** P21 home currency amount */
2744
+ homeCurrencyAmount: number | null;
2745
+ /** P21 calculated exchange rate on the payments */
2746
+ calculatedExchangeRate: number | null;
2747
+ /** P21 iva withheld amount */
2748
+ ivaWithheldAmount: number;
2749
+ /** P21 iva withheld amount display value */
2750
+ ivaWithheldAmountDisplay: number;
2751
+ /** P21 iva terms amount taken on the payments */
2752
+ ivaTermsAmountTaken: number;
2753
+ /** P21 iva terms amount taken display value */
2754
+ ivaTermsAmountTakenDisplay: number;
2755
+ /** P21 void date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2756
+ voidDate: string | null;
2757
+ /** P21 bank gl acct number (max 255 chars) */
2758
+ bankGlAcctNo: string | null;
2759
+ /** P21 exchange rate on the payments */
2760
+ exchangeRate: number | null;
2761
+ /** P21 source type code */
2762
+ sourceTypeCd: number | null;
2763
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
2764
+ updateCd: number;
2765
+ /** Process code (704 = queued for processing, 1185 = complete) */
2766
+ processCd: number;
2767
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
2768
+ statusCd: number;
2769
+ [key: string]: unknown;
2770
+ }
2771
+ /** Returned by: api.orders.payments.list(params) */
2772
+ export type PaymentsListData = PaymentsListItem[];
2773
+ /**
2774
+ * List Pending Payments Rows
2775
+ * Response data for GET /pending-payments — MINIMUM fields, extras pass through
2776
+ *
2777
+ * Returned by: api.orders.pendingPayments.list(params) (array items)
2778
+ * Returned by: api.orders.pendingPayments.get(pendingPaymentUid)
2779
+ */
2780
+ export interface PendingPaymentsListItem {
2781
+ /** P21 pending payment UID */
2782
+ pendingPaymentUid: number;
2783
+ /** P21 company ID (max 8 chars) */
2784
+ companyId: string;
2785
+ /** P21 voucher number (max 10 chars) */
2786
+ voucherNo: string;
2787
+ /** P21 pending amount */
2788
+ pendingAmount: number;
2789
+ /** P21 terms amount to pay on the pending payments */
2790
+ termsAmountToPay: number;
2791
+ /** P21 pay flag (max 1 chars) */
2792
+ payFlag: string;
2793
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2794
+ dateCreated: string;
2795
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2796
+ dateLastModified: string;
2797
+ /** P21 user who last changed the row (max 30 chars) */
2798
+ lastMaintainedBy: string;
2799
+ /** P21 iva terms amount to pay on the pending payments */
2800
+ ivaTermsAmountToPay: number;
2801
+ /** P21 iva withheld amount to pay on the pending payments */
2802
+ ivaWithheldAmountToPay: number;
2803
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
2804
+ updateCd: number;
2805
+ /** Process code (704 = queued for processing, 1185 = complete) */
2806
+ processCd: number;
2807
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
2808
+ statusCd: number;
2809
+ [key: string]: unknown;
2810
+ }
2811
+ /** Returned by: api.orders.pendingPayments.list(params) */
2812
+ export type PendingPaymentsListData = PendingPaymentsListItem[];
2813
+ /**
2814
+ * Get Pending Payments
2815
+ * Response data for GET /pending-payments/{pendingPaymentUid} — MINIMUM fields, extras pass through
2816
+ *
2817
+ * Returned by: api.orders.pendingPayments.get(pendingPaymentUid)
2818
+ */
2819
+ export type PendingPaymentsGetData = PendingPaymentsListItem;
2820
+ /**
2821
+ * List Pick Tickets
2822
+ * Response data for GET /pick-tickets — MINIMUM fields, extras pass through
2823
+ *
2824
+ * Returned by: api.orders.pickTickets.list(params) (array items)
2825
+ * Returned by: api.orders.pickTickets.get(pickTicketNo)
2826
+ */
2827
+ export interface PickTicketsListItem {
2828
+ /** Prophet 21 pick ticket number */
2829
+ pickTicketNo: number;
2830
+ /** Prophet 21 sales order number (max 8 chars) */
2831
+ orderNo: string;
2832
+ /** Prophet 21 company id (max 8 chars) */
2833
+ companyId: string;
2834
+ /** Prophet 21 carrier id for the shipment */
2835
+ carrierId: number | null;
2836
+ /** Shipment tracking number (max 40 chars) */
2837
+ trackingNo: string | null;
2838
+ /** Instructions on the pick ticket (max 255 chars) */
2839
+ instructions: string | null;
2840
+ /** Date the pick ticket shipped (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2841
+ shipDate: string | null;
2842
+ /** Prophet 21 invoice number for the shipment */
2843
+ invoiceNo: number | null;
2844
+ /** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2845
+ dateCreated: string;
2846
+ /** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2847
+ dateLastModified: string;
2848
+ /** Prophet 21 location the pick ticket ships from */
2849
+ locationId: number;
2850
+ /** Y when the pick ticket is deleted (max 1 chars) */
2851
+ deleteFlag: string;
2852
+ /** Update code (704 = queued for refresh from Prophet 21, 1185 = current) */
2853
+ updateCd: number;
2854
+ /** Y when the pick ticket has been printed (max 1 chars) */
2855
+ printedFlag: string | null;
2856
+ /** Confirmable row status flag */
2857
+ confirmableRowStatusFlag: number;
2858
+ /** Y when the pick ticket is a direct shipment (max 1 chars) */
2859
+ directShipment: string | null;
2860
+ /** Y when the pick ticket is auxiliary (max 1 chars) */
2861
+ auxiliary: string;
2862
+ /** When the pick ticket was printed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2863
+ printDate: string | null;
2864
+ /** Pick ticket type code */
2865
+ oePickTicketTypeCd: number | null;
2866
+ /** Process code (704 = queued for processing, 1185 = complete) */
2867
+ processCd: number;
2868
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
2869
+ statusCd: number;
2870
+ [key: string]: unknown;
2871
+ }
2872
+ /** Returned by: api.orders.pickTickets.list(params) */
2873
+ export type PickTicketsListData = PickTicketsListItem[];
2874
+ /**
2875
+ * Get Pick Ticket Details
2876
+ * Response data for GET /pick-tickets/{pickTicketNo} — MINIMUM fields, extras pass through
2877
+ *
2878
+ * Returned by: api.orders.pickTickets.get(pickTicketNo)
2879
+ */
2880
+ export type PickTicketsGetData = PickTicketsListItem;
2881
+ /**
2882
+ * List Pick Ticket Lines
2883
+ * Response data for GET /pick-tickets/{pickTicketNo}/lines — MINIMUM fields, extras pass through
2884
+ *
2885
+ * Returned by: api.orders.pickTickets.lines.list(pickTicketNo, params) (array items)
2886
+ * Returned by: api.orders.pickTickets.lines.get(pickTicketNo, lineNumber)
2887
+ */
2888
+ export interface PickTicketsLinesListItem {
2889
+ /** Pick ticket the line belongs to */
2890
+ pickTicketNo: number;
2891
+ /** Line number on the pick ticket */
2892
+ lineNumber: number;
2893
+ /** Prophet 21 company (max 8 chars) */
2894
+ companyId: string;
2895
+ /** Quantity printed on the pick ticket */
2896
+ printQuantity: number | null;
2897
+ /** Quantity shipped */
2898
+ shipQuantity: number | null;
2899
+ /** When the line was created (Y-m-d H:i:s) */
2900
+ dateCreated: string;
2901
+ /** When the line last changed (Y-m-d H:i:s) */
2902
+ dateLastModified: string;
2903
+ /** Unit of measure the line is picked in (max 8 chars) */
2904
+ unitOfMeasure: string;
2905
+ /** Base units per unit of measure */
2906
+ unitSize: number;
2907
+ /** Quantity in the line's unit of measure */
2908
+ unitQuantity: number;
2909
+ /** Order line number the pick ticket line fills */
2910
+ oeLineNo: number;
2911
+ /** Quantity requested for picking */
2912
+ qtyRequested: number | null;
2913
+ /** Quantity still to pick */
2914
+ qtyToPick: number | null;
2915
+ /** Item (inv_mast) on the line */
2916
+ invMastUid: number;
2917
+ /** Invoice line raised for the line; null until invoiced */
2918
+ invoiceLineUid: number | null;
2919
+ /** Quantity scanned while picking */
2920
+ qtyScanned: number | null;
2921
+ /** Box the line was packed in (max 255 chars) */
2922
+ boxNumber: string | null;
2923
+ /** Quantity to pick when the pick ticket was created */
2924
+ originalQtyToPick: number | null;
2925
+ /** Update code (704 = queued for refresh from Prophet 21, 1185 = current) */
2926
+ updateCd: number;
2927
+ /** Item ID; null when the line has no item */
2928
+ itemId: string | null;
2929
+ /** How the item is tracked: base, lot, serial or lot_serial; null when the line has no item */
2930
+ trackingPattern: string | null;
2931
+ [key: string]: unknown;
2932
+ }
2933
+ /** Returned by: api.orders.pickTickets.lines.list(pickTicketNo, params) */
2934
+ export type PickTicketsLinesListData = PickTicketsLinesListItem[];
2935
+ /**
2936
+ * Get Pick Ticket Line Detail
2937
+ * Response data for GET /pick-tickets/{pickTicketNo}/lines/{lineNumber} — MINIMUM fields, extras
2938
+ * pass through
2939
+ *
2940
+ * Returned by: api.orders.pickTickets.lines.get(pickTicketNo, lineNumber)
2941
+ */
2942
+ export type PickTicketsLinesGetData = PickTicketsLinesListItem;
2943
+ /**
2944
+ * Shape of `orderDate` (MINIMUM fields; reused wherever the same shape appears)
2945
+ * When the purchase order was placed
2946
+ *
2947
+ * Field `orderDate` of PoHdrListItem
2948
+ */
2949
+ export interface PoHdrListItemOrderDate {
2950
+ /** Date and time (Y-m-d H:i:s.u) */
2951
+ date: string;
2952
+ /** PHP timezone type (3 = named timezone) */
2953
+ timezone_type: number;
2954
+ /** Timezone name, e.g. UTC */
2955
+ timezone: string;
2956
+ [key: string]: unknown;
2957
+ }
2958
+ /**
2959
+ * Shape of `lines` (MINIMUM fields; reused wherever the same shape appears)
2960
+ * Purchase order lines
2961
+ *
2962
+ * Field `lines` of PoHdrListItem
2963
+ */
2964
+ export interface PoHdrListItemLinesItem {
2965
+ /** Line number on the purchase order */
2966
+ lineNo: number;
2967
+ /** Quantity ordered */
2968
+ qtyOrdered: number;
2969
+ /** Quantity received so far */
2970
+ qtyReceived: number;
2971
+ /** Quantity still to receive: qtyOrdered - qtyReceived */
2972
+ qtyOutstanding: number;
2973
+ /** Item (inv_mast) on the line */
2974
+ invMastUid: number;
2975
+ /** Item ID */
2976
+ itemId: string;
2977
+ /** Item description */
2978
+ itemDesc: string | null;
2979
+ /** Y when the item is serialized */
2980
+ serialized: string;
2981
+ /** Y when the receiving location tracks bins for the item */
2982
+ trackBins: string | null;
2983
+ /** Item's primary bin at the receiving location */
2984
+ primaryBin: string | null;
2985
+ /** Y when receiving the item requires a lot assignment, else N */
2986
+ lotAssignmentRequired: string;
2987
+ [key: string]: unknown;
2988
+ }
2989
+ /**
2990
+ * List purchase orders
2991
+ * Response data for GET /po-hdr — MINIMUM fields, extras pass through
2992
+ *
2993
+ * Returned by: api.orders.poHdr.list(params) (array items)
2994
+ * Returned by: api.orders.poHdr.get(poNo)
2995
+ * Returned by: api.orders.poHdr.doc.list(poNo)
2996
+ */
2997
+ export interface PoHdrListItem {
2998
+ /** Purchase order header ID */
2999
+ poHdrUid: number;
3000
+ /** Y when the purchase order is complete (max 1 chars) */
3001
+ complete: string | null;
3002
+ /** Prophet 21 purchase order number */
3003
+ poNo: number;
3004
+ /** Prophet 21 vendor the purchase order is placed with */
3005
+ vendorId: number;
3006
+ /** Vendor name; empty when the vendor cannot be read */
3007
+ vendorName: string | null;
3008
+ /** Prophet 21 supplier */
3009
+ supplierId: number | null;
3010
+ /** Supplier name; empty when there is no supplier */
3011
+ supplierName: string | null;
3012
+ /** Prophet 21 division */
3013
+ divisionId: number | null;
3014
+ /** When the purchase order was placed */
3015
+ orderDate: PoHdrListItemOrderDate | null;
3016
+ /** Prophet 21 company (max 8 chars) */
3017
+ companyNo: string;
3018
+ /** Ship-to name (max 50 chars) */
3019
+ ship2Name: string | null;
3020
+ /** Vendor packing slip number (max 50 chars) */
3021
+ packingSlipNumber: string | null;
3022
+ /** Ship-to address line 1 (max 50 chars) */
3023
+ ship2Add1: string | null;
3024
+ /** Ship-to address line 2 (max 50 chars) */
3025
+ ship2Add2: string | null;
3026
+ /** Prophet 21 location receiving the purchase order */
3027
+ locationId: number;
3028
+ /** Purchase order lines */
3029
+ lines: PoHdrListItemLinesItem[];
3030
+ [key: string]: unknown;
3031
+ }
3032
+ /** Returned by: api.orders.poHdr.list(params) */
3033
+ export type PoHdrListData = PoHdrListItem[];
3034
+ /**
3035
+ * get the purchase order details
3036
+ * Response data for GET /po-hdr/{poNo} — MINIMUM fields, extras pass through
3037
+ *
3038
+ * Returned by: api.orders.poHdr.get(poNo)
3039
+ */
3040
+ export type PoHdrGetData = PoHdrListItem;
3041
+ /**
3042
+ * get the purchase order document
3043
+ * Response data for GET /po-hdr/{poNo}/doc — MINIMUM fields, extras pass through
3044
+ *
3045
+ * Returned by: api.orders.poHdr.doc.list(poNo)
3046
+ */
3047
+ export type PoHdrDocListData = PoHdrListItem;
3048
+ /**
3049
+ * List purchase order lines
3050
+ * Response data for GET /po-line — MINIMUM fields, extras pass through
3051
+ *
3052
+ * Returned by: api.orders.poLine.list(params) (array items)
3053
+ * Returned by: api.orders.poLine.get(poLineUid)
3054
+ */
3055
+ export interface PoLineListItem {
3056
+ /** Prophet 21 purchase order number */
3057
+ poNo: number;
3058
+ /** Quantity ordered on the line */
3059
+ qtyOrdered: number;
3060
+ /** Quantity received so far */
3061
+ qtyReceived: number;
3062
+ /** When the line was received (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3063
+ receivedDate: string | null;
3064
+ /** Unit price on the line */
3065
+ unitPrice: number;
3066
+ /** Prophet 21 company number (max 8 chars) */
3067
+ companyNo: string;
3068
+ /** Manufacturer part number (max 20 chars) */
3069
+ mfgPartNo: string | null;
3070
+ /** Y when the line is deleted (max 1 chars) */
3071
+ deleteFlag: string;
3072
+ /** Date the line is due (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3073
+ dateDue: string | null;
3074
+ /** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3075
+ dateCreated: string;
3076
+ /** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3077
+ dateLastModified: string;
3078
+ /** Prophet 21 user who last changed the record (max 30 chars) */
3079
+ lastMaintainedBy: string;
3080
+ /** Cost of the next due-in purchase order quantity */
3081
+ nextDueInPoCost: number | null;
3082
+ /** Y when the line is complete (max 1 chars) */
3083
+ complete: string;
3084
+ /** Y when vouching is complete for the line (max 1 chars) */
3085
+ vouchCompleted: string;
3086
+ /** Y when the line is canceled (max 1 chars) */
3087
+ cancelFlag: string | null;
3088
+ /** Inbound currency id */
3089
+ inBoundCurryId: number | null;
3090
+ /** General ledger account number for the line (max 32 chars) */
3091
+ accountNo: string | null;
3092
+ /** Quantity still to vouch */
3093
+ qtyToVouch: number | null;
3094
+ /** Y when the line is closed (max 1 chars) */
3095
+ closedFlag: string | null;
3096
+ /** Item description on the line (max 40 chars) */
3097
+ itemDescription: string | null;
3098
+ /** Unit of measure for the line (max 8 chars) */
3099
+ unitOfMeasure: string | null;
3100
+ /** Unit size (base units per unit of measure) */
3101
+ unitSize: number;
3102
+ /** Quantity in the line's unit of measure */
3103
+ unitQuantity: number;
3104
+ /** Line number within the purchase order */
3105
+ lineNo: number;
3106
+ /** Pricing book id (max 8 chars) */
3107
+ pricingBookId: string | null;
3108
+ /** Item id in the pricing book (max 40 chars) */
3109
+ pricingBookItemId: string | null;
3110
+ /** Supplier id in the pricing book */
3111
+ pricingBookSupplierId: number | null;
3112
+ /** Discount group id in the pricing book (max 8 chars) */
3113
+ pricingBookDiscGrpId: string | null;
3114
+ /** Pricing book effective date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3115
+ pricingBookEffectiveDate: string | null;
3116
+ /** Y when the line can be combined (max 1 chars) */
3117
+ combinable: string | null;
3118
+ /** Price calculation type (max 10 chars) */
3119
+ calcType: string | null;
3120
+ /** Price calculation value */
3121
+ calcValue: number | null;
3122
+ /** Date the line is required (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3123
+ requiredDate: string | null;
3124
+ /** Quantity at the next price break */
3125
+ nextBreak: number | null;
3126
+ /** Unit price at the next price break */
3127
+ nextUtPrice: number | null;
3128
+ /** Base unit price */
3129
+ baseUtPrice: number;
3130
+ /** Y when the price was manually edited (max 1 chars) */
3131
+ priceEdit: string | null;
3132
+ /** Y when the line is for a new item (max 1 chars) */
3133
+ newItem: string | null;
3134
+ /** Y when the quantity was changed (max 1 chars) */
3135
+ quantityChanged: string | null;
3136
+ /** Pricing unit of measure (max 8 chars) */
3137
+ pricingUnit: string | null;
3138
+ /** Size of the pricing unit */
3139
+ pricingUnitSize: number | null;
3140
+ /** Extended item description (max 255 chars) */
3141
+ extendedDesc: string | null;
3142
+ /** Unit price as displayed */
3143
+ unitPriceDisplay: number;
3144
+ /** Item (inv_mast) on the line */
3145
+ invMastUid: number;
3146
+ /** Y when the line is excluded from lead time calculations (max 1 chars) */
3147
+ excludeFromLeadTime: string;
3148
+ /** Source type code of the line */
3149
+ sourceType: number | null;
3150
+ /** Expected date updates */
3151
+ expDateUpdates: number | null;
3152
+ /** Unique id of the purchase order line */
3153
+ poLineUid: number;
3154
+ /** EDI new status (max 1 chars) */
3155
+ ediNewStatus: string;
3156
+ /** Line type code (max 1 chars) */
3157
+ lineType: string | null;
3158
+ /** Contract number for the line (max 40 chars) */
3159
+ contractNumber: string | null;
3160
+ /** Prophet 21 user who created the record (max 255 chars) */
3161
+ createdBy: string | null;
3162
+ /** Parent purchase order line number */
3163
+ parentPoLineNo: number | null;
3164
+ /** Date the supplier ships the line (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3165
+ supplierShipDate: string | null;
3166
+ /** Item code as entered on the line (max 40 chars) */
3167
+ enteredAsCode: string | null;
3168
+ /** GPOR run that generated the line */
3169
+ gporRunUid: number | null;
3170
+ /** Purchase pricing page applied to the line */
3171
+ purchasePricingPageUid: number | null;
3172
+ /** Y when the line is flagged for expediting (max 1 chars) */
3173
+ expediteFlag: string | null;
3174
+ /** Original unit price as displayed */
3175
+ originalUnitPriceDisplay: number | null;
3176
+ /** Y when the line was retrieved by the warehouse management system (max 1 chars) */
3177
+ retrievedByWms: string | null;
3178
+ /** Expedite notes for the line (max 8000 chars) */
3179
+ expediteNotes: string | null;
3180
+ /** Y when the line is flagged for expedite follow-up (max 1 chars) */
3181
+ expediteFollowupFlag: string;
3182
+ /** Prophet 21 location where the line should be received */
3183
+ desiredReceiptLocationId: number | null;
3184
+ /** When the line was acknowledged (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3185
+ acknowledgedDate: string | null;
3186
+ /** Country of origin of the item (max 8 chars) */
3187
+ countryOfOrigin: string | null;
3188
+ /** B3 quantity */
3189
+ b3Qty: number;
3190
+ /** Quantity ready */
3191
+ qtyReady: number | null;
3192
+ /** Unit size of the ready quantity */
3193
+ qtyReadyUnitSize: number | null;
3194
+ /** Unit of measure of the ready quantity (max 8 chars) */
3195
+ qtyReadyUom: string | null;
3196
+ /** Ready quantity in units */
3197
+ unitQtyReady: number | null;
3198
+ /** Y when the line is a bulk buy (max 1 chars) */
3199
+ bulkBuyFlag: string | null;
3200
+ /** CAD purchase cost */
3201
+ cadPurchaseCost: number | null;
3202
+ /** List price multiplier */
3203
+ listPriceMultiplier: number | null;
3204
+ /** Carrier status of the shipment (max 20 chars) */
3205
+ carrierStatus: string | null;
3206
+ /** Expected ship date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3207
+ expectedShipDate: string | null;
3208
+ /** When the due date last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3209
+ dateDueLastModified: string | null;
3210
+ /** Y when the line was acknowledged (max 1 chars) */
3211
+ acknowledged: string | null;
3212
+ /** Update code (704 = queued for refresh from Prophet 21, 1185 = current) */
3213
+ updateCd: number;
3214
+ /** Process code (704 = queued for processing, 1185 = complete) */
3215
+ processCd: number;
3216
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
3217
+ statusCd: number;
3218
+ [key: string]: unknown;
3219
+ }
3220
+ /** Returned by: api.orders.poLine.list(params) */
3221
+ export type PoLineListData = PoLineListItem[];
3222
+ /**
3223
+ * Get a purchase order line
3224
+ * Response data for GET /po-line/{poLineUid} — MINIMUM fields, extras pass through
3225
+ *
3226
+ * Returned by: api.orders.poLine.get(poLineUid)
3227
+ */
3228
+ export type PoLineGetData = PoLineListItem;
3229
+ /**
3230
+ * List Quote Hdr Rows
3231
+ * Response data for GET /quote-hdr — MINIMUM fields, extras pass through
3232
+ *
3233
+ * Returned by: api.orders.quoteHdr.list(params) (array items)
3234
+ * Returned by: api.orders.quoteHdr.get(quoteHdrUid)
3235
+ */
3236
+ export interface QuoteHdrListItem {
3237
+ /** P21 quote hdr UID (primary key) */
3238
+ quoteHdrUid: number;
3239
+ /** P21 order header UID (oe_hdr.oe_hdr_uid) */
3240
+ oeHdrUid: number;
3241
+ /** P21 complete flag (max 1 chars) */
3242
+ completeFlag: string;
3243
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3244
+ dateCreated: string;
3245
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3246
+ dateLastModified: string;
3247
+ /** P21 user who last changed the row (max 30 chars) */
3248
+ lastMaintainedBy: string;
3249
+ /** P21 date 843 sent on the quote hdr (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3250
+ date843Sent: string | null;
3251
+ /** P21 expiration date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3252
+ expirationDate: string | null;
3253
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
3254
+ updateCd: number;
3255
+ /** Process code (704 = queued for processing, 1185 = complete) */
3256
+ processCd: number;
3257
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
3258
+ statusCd: number;
3259
+ [key: string]: unknown;
3260
+ }
3261
+ /** Returned by: api.orders.quoteHdr.list(params) */
3262
+ export type QuoteHdrListData = QuoteHdrListItem[];
3263
+ /**
3264
+ * Get Quote Hdr
3265
+ * Response data for GET /quote-hdr/{quoteHdrUid} — MINIMUM fields, extras pass through
3266
+ *
3267
+ * Returned by: api.orders.quoteHdr.get(quoteHdrUid)
3268
+ */
3269
+ export type QuoteHdrGetData = QuoteHdrListItem;
3270
+ /**
3271
+ * List Remittances Rows
3272
+ * Response data for GET /remittances — MINIMUM fields, extras pass through
3273
+ *
3274
+ * Returned by: api.orders.remittances.list(params) (array items)
3275
+ * Returned by: api.orders.remittances.get(remittanceNumber)
3276
+ */
3277
+ export interface RemittancesListItem {
3278
+ /** P21 remittance number on the remittances */
3279
+ remittanceNumber: number;
3280
+ /** P21 order number (oe_hdr.order_no) (max 8 chars) */
3281
+ orderNo: string;
3282
+ /** P21 cash drawer ID (max 8 chars) */
3283
+ cashDrawerId: string;
3284
+ /** P21 company ID (max 8 chars) */
3285
+ companyId: string;
3286
+ /** P21 payment number on the remittances */
3287
+ paymentNumber: number;
3288
+ /** Y when P21 marks the row deleted (max 1 chars) */
3289
+ deleteFlag: string;
3290
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3291
+ dateCreated: string;
3292
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3293
+ dateLastModified: string;
3294
+ /** P21 user who last changed the row (max 30 chars) */
3295
+ lastMaintainedBy: string;
3296
+ /** P21 in cash drawer on the remittances (max 1 chars) */
3297
+ inCashDrawer: string;
3298
+ /** P21 cash drawer seq number */
3299
+ cashDrawerSeqNo: number;
3300
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
3301
+ updateCd: number;
3302
+ /** Process code (704 = queued for processing, 1185 = complete) */
3303
+ processCd: number;
3304
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
3305
+ statusCd: number;
3306
+ [key: string]: unknown;
3307
+ }
3308
+ /** Returned by: api.orders.remittances.list(params) */
3309
+ export type RemittancesListData = RemittancesListItem[];
3310
+ /**
3311
+ * List Remittances Detail Rows
3312
+ * Response data for GET /remittances-detail — MINIMUM fields, extras pass through
3313
+ *
3314
+ * Returned by: api.orders.remittancesDetail.list(params) (array items)
3315
+ */
3316
+ export interface RemittancesDetailListItem {
3317
+ /** P21 remittance number on the remittances detail */
3318
+ remittanceNumber: number;
3319
+ /** P21 invoice number (max 10 chars) */
3320
+ invoiceNo: string;
3321
+ /** P21 payment amount */
3322
+ paymentAmount: number;
3323
+ /** P21 terms amount */
3324
+ termsAmount: number;
3325
+ /** P21 allowed amount */
3326
+ allowedAmount: number;
3327
+ /** Y when P21 marks the row deleted (max 1 chars) */
3328
+ deleteFlag: string;
3329
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3330
+ dateCreated: string;
3331
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3332
+ dateLastModified: string;
3333
+ /** P21 user who last changed the row (max 30 chars) */
3334
+ lastMaintainedBy: string;
3335
+ /** P21 currency variance amt home on the remittances detail */
3336
+ currencyVarianceAmtHome: number;
3337
+ /** P21 tax amount paid on the remittances detail */
3338
+ taxAmountPaid: number;
3339
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
3340
+ updateCd: number;
3341
+ /** Process code (704 = queued for processing, 1185 = complete) */
3342
+ processCd: number;
3343
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
3344
+ statusCd: number;
3345
+ [key: string]: unknown;
3346
+ }
3347
+ /** Returned by: api.orders.remittancesDetail.list(params) */
3348
+ export type RemittancesDetailListData = RemittancesDetailListItem[];
3349
+ /**
3350
+ * Get Remittances
3351
+ * Response data for GET /remittances/{remittanceNumber} — MINIMUM fields, extras pass through
3352
+ *
3353
+ * Returned by: api.orders.remittances.get(remittanceNumber)
3354
+ */
3355
+ export type RemittancesGetData = RemittancesListItem;
3356
+ /**
3357
+ * List Shipping Route Rows
3358
+ * Response data for GET /shipping-route — MINIMUM fields, extras pass through
3359
+ *
3360
+ * Returned by: api.orders.shippingRoute.list(params) (array items)
3361
+ * Returned by: api.orders.shippingRoute.get(shippingRouteUid)
3362
+ */
3363
+ export interface ShippingRouteListItem {
3364
+ /** P21 shipping route UID (shipping_route.shipping_route_uid) */
3365
+ shippingRouteUid: number;
3366
+ /** P21 route code on the shipping route (max 255 chars) */
3367
+ routeCode: string;
3368
+ /** P21 route description on the shipping route (max 255 chars) */
3369
+ routeDescription: string;
3370
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3371
+ dateCreated: string;
3372
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3373
+ dateLastModified: string;
3374
+ /** P21 user who last changed the row (max 30 chars) */
3375
+ lastMaintainedBy: string;
3376
+ /** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
3377
+ rowStatusFlag: number;
3378
+ /** P21 delivery zone UID */
3379
+ deliveryZoneUid: number | null;
3380
+ /** P21 dow route flag (max 1 chars) */
3381
+ dowRouteFlag: string | null;
3382
+ /** P21 tod route flag (max 1 chars) */
3383
+ todRouteFlag: string | null;
3384
+ /** P21 shipping program flag (max 1 chars) */
3385
+ shippingProgramFlag: string | null;
3386
+ /** P21 ship prog picking threshold on the shipping route */
3387
+ shipProgPickingThreshold: number | null;
3388
+ /** P21 ship prog threshold basis code */
3389
+ shipProgThresholdBasisCd: number | null;
3390
+ /** P21 ship prog picking days on the shipping route (max 10 chars) */
3391
+ shipProgPickingDays: string | null;
3392
+ /** P21 ship prog freight disc pct on the shipping route */
3393
+ shipProgFreightDiscPct: number | null;
3394
+ /** P21 deductible exempt flag (max 1 chars) */
3395
+ deductibleExemptFlag: string | null;
3396
+ /** P21 delivery days of week on the shipping route (max 255 chars) */
3397
+ deliveryDaysOfWeek: string | null;
3398
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
3399
+ updateCd: number;
3400
+ /** Process code (704 = queued for processing, 1185 = complete) */
3401
+ processCd: number;
3402
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
3403
+ statusCd: number;
3404
+ [key: string]: unknown;
3405
+ }
3406
+ /** Returned by: api.orders.shippingRoute.list(params) */
3407
+ export type ShippingRouteListData = ShippingRouteListItem[];
3408
+ /**
3409
+ * Get Shipping Route
3410
+ * Response data for GET /shipping-route/{shippingRouteUid} — MINIMUM fields, extras pass through
3411
+ *
3412
+ * Returned by: api.orders.shippingRoute.get(shippingRouteUid)
3413
+ */
3414
+ export type ShippingRouteGetData = ShippingRouteListItem;
3415
+ /**
3416
+ * List Wireless Trans Audit Hdr Rows
3417
+ * Response data for GET /wireless-trans-audit-hdr — MINIMUM fields, extras pass through
3418
+ *
3419
+ * Returned by: api.orders.wirelessTransAuditHdr.list(params) (array items)
3420
+ * Returned by: api.orders.wirelessTransAuditHdr.get(wirelessTransAuditHdrUid)
3421
+ */
3422
+ export interface WirelessTransAuditHdrListItem {
3423
+ /**
3424
+ * P21 wireless transaction audit header UID
3425
+ * (wireless_trans_audit_hdr.wireless_trans_audit_hdr_uid)
3426
+ */
3427
+ wirelessTransAuditHdrUid: number;
3428
+ /** P21 company ID (max 8 chars) */
3429
+ companyId: string;
3430
+ /** P21 location ID (location.location_id) */
3431
+ locationId: number;
3432
+ /** P21 wireless transaction type code */
3433
+ wirelessTransactionTypeCd: number;
3434
+ /** P21 wireless transaction number on the wireless trans audit hdr */
3435
+ wirelessTransactionNumber: number;
3436
+ /** P21 transaction start date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3437
+ transactionStartDate: string;
3438
+ /** P21 transaction end date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3439
+ transactionEndDate: string;
3440
+ /** P21 group pick flag (max 1 chars) */
3441
+ groupPickFlag: string;
3442
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3443
+ dateCreated: string;
3444
+ /** P21 user who created the row (max 255 chars) */
3445
+ createdBy: string;
3446
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3447
+ dateLastModified: string;
3448
+ /** P21 user who last changed the row (max 255 chars) */
3449
+ lastMaintainedBy: string;
3450
+ /** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
3451
+ rowStatusFlag: number;
3452
+ /** P21 workbench UID */
3453
+ workbenchUid: number | null;
3454
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
3455
+ updateCd: number;
3456
+ /** Process code (704 = queued for processing, 1185 = complete) */
3457
+ processCd: number;
3458
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
3459
+ statusCd: number;
3460
+ [key: string]: unknown;
3461
+ }
3462
+ /** Returned by: api.orders.wirelessTransAuditHdr.list(params) */
3463
+ export type WirelessTransAuditHdrListData = WirelessTransAuditHdrListItem[];
3464
+ /**
3465
+ * Get Wireless Trans Audit Hdr
3466
+ * Response data for GET /wireless-trans-audit-hdr/{wirelessTransAuditHdrUid} — MINIMUM fields,
3467
+ * extras pass through
3468
+ *
3469
+ * Returned by: api.orders.wirelessTransAuditHdr.get(wirelessTransAuditHdrUid)
3470
+ */
3471
+ export type WirelessTransAuditHdrGetData = WirelessTransAuditHdrListItem;
3472
+ /**
3473
+ * List Wireless Trans Audit Line Rows
3474
+ * Response data for GET /wireless-trans-audit-line — MINIMUM fields, extras pass through
3475
+ *
3476
+ * Returned by: api.orders.wirelessTransAuditLine.list(params) (array items)
3477
+ * Returned by: api.orders.wirelessTransAuditLine.get(wirelessTransAuditLineUid)
3478
+ */
3479
+ export interface WirelessTransAuditLineListItem {
3480
+ /** P21 wireless trans audit line UID (primary key) */
3481
+ wirelessTransAuditLineUid: number;
3482
+ /**
3483
+ * P21 wireless transaction audit header UID
3484
+ * (wireless_trans_audit_hdr.wireless_trans_audit_hdr_uid)
3485
+ */
3486
+ wirelessTransAuditHdrUid: number;
3487
+ /** P21 transaction line number on the wireless trans audit line */
3488
+ transactionLineNumber: number;
3489
+ /** P21 transaction line start date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3490
+ transactionLineStartDate: string;
3491
+ /** P21 transaction line end date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3492
+ transactionLineEndDate: string;
3493
+ /** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3494
+ dateCreated: string;
3495
+ /** P21 user who created the row (max 255 chars) */
3496
+ createdBy: string;
3497
+ /** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3498
+ dateLastModified: string;
3499
+ /** P21 user who last changed the row (max 255 chars) */
3500
+ lastMaintainedBy: string;
3501
+ /** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
3502
+ rowStatusFlag: number;
3503
+ /** P21 bin ID (max 10 chars) */
3504
+ binId: string | null;
3505
+ /** P21 item UID (inv_mast.inv_mast_uid) */
3506
+ invMastUid: number | null;
3507
+ /** P21 unit qty on the wireless trans audit line */
3508
+ unitQty: number | null;
3509
+ /** P21 unit of measure (max 8 chars) */
3510
+ uom: string | null;
3511
+ /** P21 unit size */
3512
+ unitSize: number | null;
3513
+ /** P21 action type code */
3514
+ actionTypeCd: number | null;
3515
+ /** P21 transaction line prompt date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
3516
+ transactionLinePromptDate: string | null;
3517
+ /** P21 sub hdr number */
3518
+ subHdrNo: number | null;
3519
+ /** Update code (704 = queued for P21 refresh, 1185 = in sync) */
3520
+ updateCd: number;
3521
+ /** Process code (704 = queued for processing, 1185 = complete) */
3522
+ processCd: number;
3523
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
3524
+ statusCd: number;
3525
+ [key: string]: unknown;
3526
+ }
3527
+ /** Returned by: api.orders.wirelessTransAuditLine.list(params) */
3528
+ export type WirelessTransAuditLineListData = WirelessTransAuditLineListItem[];
3529
+ /**
3530
+ * Get Wireless Trans Audit Line
3531
+ * Response data for GET /wireless-trans-audit-line/{wirelessTransAuditLineUid} — MINIMUM fields,
3532
+ * extras pass through
3533
+ *
3534
+ * Returned by: api.orders.wirelessTransAuditLine.get(wirelessTransAuditLineUid)
3535
+ */
3536
+ export type WirelessTransAuditLineGetData = WirelessTransAuditLineListItem;
3537
+ export interface OrdersClientSpec {
3538
+ apinvHdr: {
3539
+ /**
3540
+ * List Apinv Hdr Rows
3541
+ * Call: api.orders.apinvHdr.list(params)
3542
+ *
3543
+ * List apinv hdr rows as Augur holds them locally
3544
+ *
3545
+ * Errors:
3546
+ * 400: VendorId or customerId or shipToId or voucherReasonCodeUid or payableSourceUid or
3547
+ * warrantyClaimPaymentsUid is not a number, or orderBy is not one apinv_hdr column with
3548
+ * ASC or DESC.
3549
+ *
3550
+ * GET https://orders.augur-api.com/apinv-hdr
3551
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1apinv-hdr/get
3552
+ *
3553
+ * @param params ApinvHdrListParams (query string)
3554
+ * @returns BaseResponse whose `data` is ApinvHdrListData
3555
+ */
3556
+ list: (params?: ApinvHdrListParams) => Promise<BaseResponse<ApinvHdrListData>>;
3557
+ /**
3558
+ * Get Apinv Hdr
3559
+ * Call: api.orders.apinvHdr.get(voucherNo)
3560
+ *
3561
+ * Get one apinv hdr row as Augur holds it locally
3562
+ *
3563
+ * Errors:
3564
+ * 400: voucherNo is missing or invalid.
3565
+ * 404: No apinv hdr row with this voucherNo.
3566
+ *
3567
+ * GET https://orders.augur-api.com/apinv-hdr/{voucherNo}
3568
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1apinv-hdr~1{voucherNo}/get
3569
+ *
3570
+ * @param voucherNo Apinv hdr key (apinv_hdr.voucher_no)
3571
+ * @param params ApinvHdrGetParams (query string)
3572
+ * @returns BaseResponse whose `data` is ApinvHdrGetData
3573
+ */
3574
+ get: (voucherNo: string, params?: ApinvHdrGetParams) => Promise<BaseResponse<ApinvHdrGetData>>;
3575
+ };
3576
+ arPaymentDetails: {
3577
+ /**
3578
+ * List Ar Payment Details Rows
3579
+ * Call: api.orders.arPaymentDetails.list(params)
3580
+ *
3581
+ * List ar payment details rows as Augur holds them locally
3582
+ *
3583
+ * Errors:
3584
+ * 400: DeleteFlag is not Y or N, or currencyLineUid or webCcProcessorUid or ewingCouponUid is
3585
+ * not a number, or orderBy is not one ar_payment_details column with ASC or DESC.
3586
+ *
3587
+ * GET https://orders.augur-api.com/ar-payment-details
3588
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1ar-payment-details/get
3589
+ *
3590
+ * @param params ArPaymentDetailsListParams (query string)
3591
+ * @returns BaseResponse whose `data` is ArPaymentDetailsListData
3592
+ */
3593
+ list: (params?: ArPaymentDetailsListParams) => Promise<BaseResponse<ArPaymentDetailsListData>>;
3594
+ /**
3595
+ * Get Ar Payment Details
3596
+ * Call: api.orders.arPaymentDetails.get(paymentNumber)
3597
+ *
3598
+ * Get one ar payment details row as Augur holds it locally
3599
+ *
3600
+ * Errors:
3601
+ * 400: paymentNumber is missing or invalid.
3602
+ * 404: No ar payment details row with this paymentNumber.
3603
+ *
3604
+ * GET https://orders.augur-api.com/ar-payment-details/{paymentNumber}
3605
+ * Contract:
3606
+ * https://orders.augur-api.com/openapi.json#/paths/~1ar-payment-details~1{paymentNumber}/get
3607
+ *
3608
+ * @param paymentNumber Ar payment details key (ar_payment_details.payment_number)
3609
+ * @param params ArPaymentDetailsGetParams (query string)
3610
+ * @returns BaseResponse whose `data` is ArPaymentDetailsGetData
3611
+ */
3612
+ get: (paymentNumber: number, params?: ArPaymentDetailsGetParams) => Promise<BaseResponse<ArPaymentDetailsGetData>>;
3613
+ };
3614
+ arReceipts: {
3615
+ /**
3616
+ * List Ar Receipts Rows
3617
+ * Call: api.orders.arReceipts.list(params)
3618
+ *
3619
+ * List ar receipts rows as Augur holds them locally
3620
+ *
3621
+ * Errors:
3622
+ * 400: DeleteFlag is not Y or N, or orderBy is not one ar_receipts column with ASC or DESC.
3623
+ *
3624
+ * GET https://orders.augur-api.com/ar-receipts
3625
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1ar-receipts/get
3626
+ *
3627
+ * @param params ArReceiptsListParams (query string)
3628
+ * @returns BaseResponse whose `data` is ArReceiptsListData
3629
+ */
3630
+ list: (params?: ArReceiptsListParams) => Promise<BaseResponse<ArReceiptsListData>>;
3631
+ /**
3632
+ * Get Ar Receipts
3633
+ * Call: api.orders.arReceipts.get(receiptNumber)
3634
+ *
3635
+ * Get one ar receipts row as Augur holds it locally
3636
+ *
3637
+ * Errors:
3638
+ * 400: receiptNumber is missing or invalid.
3639
+ * 404: No ar receipts row with this receiptNumber.
3640
+ *
3641
+ * GET https://orders.augur-api.com/ar-receipts/{receiptNumber}
3642
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1ar-receipts~1{receiptNumber}/get
3643
+ *
3644
+ * @param receiptNumber Ar receipts key (ar_receipts.receipt_number)
3645
+ * @param params ArReceiptsGetParams (query string)
3646
+ * @returns BaseResponse whose `data` is ArReceiptsGetData
3647
+ */
3648
+ get: (receiptNumber: number, params?: ArReceiptsGetParams) => Promise<BaseResponse<ArReceiptsGetData>>;
3649
+ };
3650
+ arReceiptsDetail: {
3651
+ /**
3652
+ * List Ar Receipts Detail Rows
3653
+ * Call: api.orders.arReceiptsDetail.list(params)
3654
+ *
3655
+ * List ar receipts detail rows as Augur holds them locally
3656
+ *
3657
+ * Errors:
3658
+ * 400: DeleteFlag is not Y or N, or receiptNumber or customerId is not a number, or orderBy
3659
+ * is not one ar_receipts_detail column with ASC or DESC.
3660
+ *
3661
+ * GET https://orders.augur-api.com/ar-receipts-detail
3662
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1ar-receipts-detail/get
3663
+ *
3664
+ * @param params ArReceiptsDetailListParams (query string)
3665
+ * @returns BaseResponse whose `data` is ArReceiptsDetailListData
3666
+ */
3667
+ list: (params?: ArReceiptsDetailListParams) => Promise<BaseResponse<ArReceiptsDetailListData>>;
3668
+ };
3669
+ documentLineBin: {
3670
+ /**
3671
+ * List Document Line Bin Rows
3672
+ * Call: api.orders.documentLineBin.list(params)
3673
+ *
3674
+ * List document line bin rows as Augur holds them locally
3675
+ *
3676
+ * Errors:
3677
+ * 400: SourceDlbUid or workOrderUid is not a number, or orderBy is not one document_line_bin
3678
+ * column with ASC or DESC.
3679
+ *
3680
+ * GET https://orders.augur-api.com/document-line-bin
3681
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1document-line-bin/get
3682
+ *
3683
+ * @param params DocumentLineBinListParams (query string)
3684
+ * @returns BaseResponse whose `data` is DocumentLineBinListData
3685
+ */
3686
+ list: (params?: DocumentLineBinListParams) => Promise<BaseResponse<DocumentLineBinListData>>;
3687
+ /**
3688
+ * Get Document Line Bin
3689
+ * Call: api.orders.documentLineBin.get(documentLineBinUid)
3690
+ *
3691
+ * Get one document line bin row as Augur holds it locally
3692
+ *
3693
+ * Errors:
3694
+ * 404: No document line bin row with this documentLineBinUid.
3695
+ *
3696
+ * GET https://orders.augur-api.com/document-line-bin/{documentLineBinUid}
3697
+ * Contract:
3698
+ * https://orders.augur-api.com/openapi.json#/paths/~1document-line-bin~1{documentLineBinUid}/get
3699
+ *
3700
+ * @param documentLineBinUid Document line bin key (document_line_bin.document_line_bin_uid)
3701
+ * @param params DocumentLineBinGetParams (query string)
3702
+ * @returns BaseResponse whose `data` is DocumentLineBinGetData
3703
+ */
3704
+ get: (documentLineBinUid: number, params?: DocumentLineBinGetParams) => Promise<BaseResponse<DocumentLineBinGetData>>;
3705
+ };
3706
+ documentLineLot: {
3707
+ /**
3708
+ * List Document Line Lot Rows
3709
+ * Call: api.orders.documentLineLot.list(params)
3710
+ *
3711
+ * List document line lot rows as Augur holds them locally
3712
+ *
3713
+ * Errors:
3714
+ * 400: LotUid or itemRevisionUid or currentbinUid is not a number, or orderBy is not one
3715
+ * document_line_lot column with ASC or DESC.
3716
+ *
3717
+ * GET https://orders.augur-api.com/document-line-lot
3718
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1document-line-lot/get
3719
+ *
3720
+ * @param params DocumentLineLotListParams (query string)
3721
+ * @returns BaseResponse whose `data` is DocumentLineLotListData
3722
+ */
3723
+ list: (params?: DocumentLineLotListParams) => Promise<BaseResponse<DocumentLineLotListData>>;
3724
+ /**
3725
+ * Get Document Line Lot
3726
+ * Call: api.orders.documentLineLot.get(documentLineLotUid)
3727
+ *
3728
+ * Get one document line lot row as Augur holds it locally
3729
+ *
3730
+ * Errors:
3731
+ * 404: No document line lot row with this documentLineLotUid.
3732
+ *
3733
+ * GET https://orders.augur-api.com/document-line-lot/{documentLineLotUid}
3734
+ * Contract:
3735
+ * https://orders.augur-api.com/openapi.json#/paths/~1document-line-lot~1{documentLineLotUid}/get
3736
+ *
3737
+ * @param documentLineLotUid Document line lot key (document_line_lot.document_line_lot_uid)
3738
+ * @param params DocumentLineLotGetParams (query string)
3739
+ * @returns BaseResponse whose `data` is DocumentLineLotGetData
3740
+ */
3741
+ get: (documentLineLotUid: number, params?: DocumentLineLotGetParams) => Promise<BaseResponse<DocumentLineLotGetData>>;
3742
+ };
3743
+ documentLineSerial: {
3744
+ /**
3745
+ * List Document Line Serial Rows
3746
+ * Call: api.orders.documentLineSerial.list(params)
3747
+ *
3748
+ * List document line serial rows as Augur holds them locally
3749
+ *
3750
+ * Errors:
3751
+ * 400: SerialNumberUid or lotUid or rfBinUid or depositBinUid is not a number, or orderBy is
3752
+ * not one document_line_serial column with ASC or DESC.
3753
+ *
3754
+ * GET https://orders.augur-api.com/document-line-serial
3755
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1document-line-serial/get
3756
+ *
3757
+ * @param params DocumentLineSerialListParams (query string)
3758
+ * @returns BaseResponse whose `data` is DocumentLineSerialListData
3759
+ */
3760
+ list: (params?: DocumentLineSerialListParams) => Promise<BaseResponse<DocumentLineSerialListData>>;
3761
+ /**
3762
+ * Get Document Line Serial
3763
+ * Call: api.orders.documentLineSerial.get(documentLineSerialUid)
3764
+ *
3765
+ * Get one document line serial row as Augur holds it locally
3766
+ *
3767
+ * Errors:
3768
+ * 404: No document line serial row with this documentLineSerialUid.
3769
+ *
3770
+ * GET https://orders.augur-api.com/document-line-serial/{documentLineSerialUid}
3771
+ * Contract:
3772
+ * https://orders.augur-api.com/openapi.json#/paths/~1document-line-serial~1{documentLineSerialUid}/get
3773
+ *
3774
+ * @param documentLineSerialUid Document line serial key
3775
+ * (document_line_serial.document_line_serial_uid)
3776
+ * @param params DocumentLineSerialGetParams (query string)
3777
+ * @returns BaseResponse whose `data` is DocumentLineSerialGetData
3778
+ */
3779
+ get: (documentLineSerialUid: number, params?: DocumentLineSerialGetParams) => Promise<BaseResponse<DocumentLineSerialGetData>>;
3780
+ };
3781
+ importSuspenseHdr: {
3782
+ /**
3783
+ * List Import Suspense Hdr Rows
3784
+ * Call: api.orders.importSuspenseHdr.list(params)
3785
+ *
3786
+ * List import suspense hdr rows as Augur holds them locally
3787
+ *
3788
+ * Errors:
3789
+ * 400: OrderBy is not one import_suspense_hdr column with ASC or DESC.
3790
+ *
3791
+ * GET https://orders.augur-api.com/import-suspense-hdr
3792
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1import-suspense-hdr/get
3793
+ *
3794
+ * @param params ImportSuspenseHdrListParams (query string)
3795
+ * @returns BaseResponse whose `data` is ImportSuspenseHdrListData
3796
+ */
3797
+ list: (params?: ImportSuspenseHdrListParams) => Promise<BaseResponse<ImportSuspenseHdrListData>>;
3798
+ /**
3799
+ * Get Import Suspense Hdr
3800
+ * Call: api.orders.importSuspenseHdr.get(importSuspenseHdrUid)
3801
+ *
3802
+ * Get one import suspense hdr row as Augur holds it locally
3803
+ *
3804
+ * Errors:
3805
+ * 404: No import suspense hdr row with this importSuspenseHdrUid.
3806
+ *
3807
+ * GET https://orders.augur-api.com/import-suspense-hdr/{importSuspenseHdrUid}
3808
+ * Contract:
3809
+ * https://orders.augur-api.com/openapi.json#/paths/~1import-suspense-hdr~1{importSuspenseHdrUid}/get
3810
+ *
3811
+ * @param importSuspenseHdrUid Import suspense hdr key
3812
+ * (import_suspense_hdr.import_suspense_hdr_uid)
3813
+ * @param params ImportSuspenseHdrGetParams (query string)
3814
+ * @returns BaseResponse whose `data` is ImportSuspenseHdrGetData
3815
+ */
3816
+ get: (importSuspenseHdrUid: number, params?: ImportSuspenseHdrGetParams) => Promise<BaseResponse<ImportSuspenseHdrGetData>>;
3817
+ };
3818
+ importSuspenseLine: {
3819
+ /**
3820
+ * List Import Suspense Line Rows
3821
+ * Call: api.orders.importSuspenseLine.list(params)
3822
+ *
3823
+ * List import suspense line rows as Augur holds them locally
3824
+ *
3825
+ * Errors:
3826
+ * 400: ImportSuspenseHdrUid or customerId or locationId is not a number, or orderBy is not
3827
+ * one import_suspense_line column with ASC or DESC.
3828
+ *
3829
+ * GET https://orders.augur-api.com/import-suspense-line
3830
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1import-suspense-line/get
3831
+ *
3832
+ * @param params ImportSuspenseLineListParams (query string)
3833
+ * @returns BaseResponse whose `data` is ImportSuspenseLineListData
3834
+ */
3835
+ list: (params?: ImportSuspenseLineListParams) => Promise<BaseResponse<ImportSuspenseLineListData>>;
3836
+ /**
3837
+ * Get Import Suspense Line
3838
+ * Call: api.orders.importSuspenseLine.get(importSuspenseLineUid)
3839
+ *
3840
+ * Get one import suspense line row as Augur holds it locally
3841
+ *
3842
+ * Errors:
3843
+ * 404: No import suspense line row with this importSuspenseLineUid.
3844
+ *
3845
+ * GET https://orders.augur-api.com/import-suspense-line/{importSuspenseLineUid}
3846
+ * Contract:
3847
+ * https://orders.augur-api.com/openapi.json#/paths/~1import-suspense-line~1{importSuspenseLineUid}/get
3848
+ *
3849
+ * @param importSuspenseLineUid Import suspense line key
3850
+ * (import_suspense_line.import_suspense_line_uid)
3851
+ * @param params ImportSuspenseLineGetParams (query string)
3852
+ * @returns BaseResponse whose `data` is ImportSuspenseLineGetData
3853
+ */
3854
+ get: (importSuspenseLineUid: number, params?: ImportSuspenseLineGetParams) => Promise<BaseResponse<ImportSuspenseLineGetData>>;
3855
+ };
3856
+ invoiceHdr: {
3857
+ /**
3858
+ * List Invoice Hdr Rows
3859
+ * Call: api.orders.invoiceHdr.list(params)
3860
+ *
3861
+ * List invoice hdr rows as Augur holds them locally
3862
+ *
3863
+ * Errors:
3864
+ * 400: ShipToId or soldToAhUid or invoiceBatchUid or freightCodeUid or shippingRouteUid or
3865
+ * currencyLineUid or rebillInvoiceReasonUid or reasonCreditMemoCodeUid or
3866
+ * sourceCreditMemoCodeUid or salesMarketGroupUid is not a number, or orderBy is not one
3867
+ * invoice_hdr column with ASC or DESC.
3868
+ *
3869
+ * GET https://orders.augur-api.com/invoice-hdr
3870
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1invoice-hdr/get
3871
+ *
3872
+ * @param params InvoiceHdrListParams (query string)
3873
+ * @returns BaseResponse whose `data` is InvoiceHdrListData
3874
+ */
3875
+ list: (params?: InvoiceHdrListParams) => Promise<BaseResponse<InvoiceHdrListData>>;
3876
+ /**
3877
+ * Get Invoice Hdr
3878
+ * Call: api.orders.invoiceHdr.get(invoiceNo)
3879
+ *
3880
+ * Get one invoice hdr row as Augur holds it locally
3881
+ *
3882
+ * Errors:
3883
+ * 400: invoiceNo is missing or invalid.
3884
+ * 404: No invoice hdr row with this invoiceNo.
3885
+ *
3886
+ * GET https://orders.augur-api.com/invoice-hdr/{invoiceNo}
3887
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1invoice-hdr~1{invoiceNo}/get
3888
+ *
3889
+ * @param invoiceNo Invoice hdr key (invoice_hdr.invoice_no)
3890
+ * @param params InvoiceHdrGetParams (query string)
3891
+ * @returns BaseResponse whose `data` is InvoiceHdrGetData
3892
+ */
3893
+ get: (invoiceNo: string, params?: InvoiceHdrGetParams) => Promise<BaseResponse<InvoiceHdrGetData>>;
3894
+ reprint: {
3895
+ /**
3896
+ * Reprint the invoice
3897
+ * Call: api.orders.invoiceHdr.reprint.list(invoiceNo)
3898
+ *
3899
+ * Render the invoice as a PDF through Prophet 21's document service
3900
+ *
3901
+ * Response data: An invoice re-rendered by Prophet 21's document service
3902
+ *
3903
+ * Errors:
3904
+ * 404: No invoice with this number.
3905
+ * 502: Prophet 21 could not render the invoice; the message names the failed step. Not
3906
+ * cached, so the next request retries Prophet 21.
3907
+ *
3908
+ * GET https://orders.augur-api.com/invoice-hdr/{invoiceNo}/reprint
3909
+ * Contract:
3910
+ * https://orders.augur-api.com/openapi.json#/paths/~1invoice-hdr~1{invoiceNo}~1reprint/get
3911
+ *
3912
+ * @param invoiceNo Prophet 21 invoice number
3913
+ * @param params InvoiceHdrReprintListParams (query string)
3914
+ * @returns BaseResponse whose `data` is InvoiceHdrReprintListData
3915
+ */
3916
+ list: (invoiceNo: string, params?: InvoiceHdrReprintListParams) => Promise<BaseResponse<InvoiceHdrReprintListData>>;
3917
+ };
3918
+ };
3919
+ invoiceLine: {
3920
+ /**
3921
+ * List Invoice Line Rows
3922
+ * Call: api.orders.invoiceLine.list(params)
3923
+ *
3924
+ * List invoice line rows as Augur holds them locally
3925
+ *
3926
+ * Errors:
3927
+ * 400: InvMastUid or supplierId or jobPriceLineUid or customerContractUid is not a number, or
3928
+ * orderBy is not one invoice_line column with ASC or DESC.
3929
+ *
3930
+ * GET https://orders.augur-api.com/invoice-line
3931
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1invoice-line/get
3932
+ *
3933
+ * @param params InvoiceLineListParams (query string)
3934
+ * @returns BaseResponse whose `data` is InvoiceLineListData
3935
+ */
3936
+ list: (params?: InvoiceLineListParams) => Promise<BaseResponse<InvoiceLineListData>>;
3937
+ /**
3938
+ * Get Invoice Line
3939
+ * Call: api.orders.invoiceLine.get(invoiceLineUid)
3940
+ *
3941
+ * Get one invoice line row as Augur holds it locally
3942
+ *
3943
+ * Errors:
3944
+ * 404: No invoice line row with this invoiceLineUid.
3945
+ *
3946
+ * GET https://orders.augur-api.com/invoice-line/{invoiceLineUid}
3947
+ * Contract:
3948
+ * https://orders.augur-api.com/openapi.json#/paths/~1invoice-line~1{invoiceLineUid}/get
3949
+ *
3950
+ * @param invoiceLineUid Invoice line key (invoice_line.invoice_line_uid)
3951
+ * @param params InvoiceLineGetParams (query string)
3952
+ * @returns BaseResponse whose `data` is InvoiceLineGetData
3953
+ */
3954
+ get: (invoiceLineUid: number, params?: InvoiceLineGetParams) => Promise<BaseResponse<InvoiceLineGetData>>;
3955
+ };
3956
+ oeHdr: {
3957
+ /**
3958
+ * List Oe Hdr Rows
3959
+ * Call: api.orders.oeHdr.list(params)
3960
+ *
3961
+ * List oe hdr rows as Augur holds them locally
3962
+ *
3963
+ * Errors:
3964
+ * 400: DeleteFlag is not Y or N, or customerId or locationId or shippingRouteUid or
3965
+ * orderPriorityUid or addressId is not a number, or orderBy is not one oe_hdr column with
3966
+ * ASC or DESC.
3967
+ *
3968
+ * GET https://orders.augur-api.com/oe-hdr
3969
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1oe-hdr/get
3970
+ *
3971
+ * @param params OeHdrListParams (query string)
3972
+ * @returns BaseResponse whose `data` is OeHdrListData
3973
+ */
3974
+ list: (params?: OeHdrListParams) => Promise<BaseResponse<OeHdrListData>>;
3975
+ doc: {
3976
+ /**
3977
+ * get the order document
3978
+ * Call: api.orders.oeHdr.doc.list(orderNo, params)
3979
+ *
3980
+ * Response data: One order, quote or RMA document: the `oe_hdr` header with its lines and
3981
+ * pick tickets.
3982
+ *
3983
+ * Errors:
3984
+ * 400: postalCode is not five digits or does not match the order's ship-to postal code.
3985
+ * 404: No order with this number.
3986
+ *
3987
+ * GET https://orders.augur-api.com/oe-hdr/{orderNo}/doc
3988
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1oe-hdr~1{orderNo}~1doc/get
3989
+ *
3990
+ * @param orderNo Prophet 21 order number
3991
+ * @param params OeHdrDocListParams (query string)
3992
+ * @returns BaseResponse whose `data` is OeHdrDocListData
3993
+ */
3994
+ list: (orderNo: string, params?: OeHdrDocListParams) => Promise<BaseResponse<OeHdrDocListData>>;
3995
+ /**
3996
+ * Alias for `list`: GET /oe-hdr/{orderNo}/doc. Call:
3997
+ * api.orders.oeHdr.doc.get(orderNo, params)
3998
+ */
3999
+ get: (orderNo: string, params?: OeHdrDocListParams) => Promise<BaseResponse<OeHdrDocListData>>;
4000
+ };
4001
+ lookup: {
4002
+ /**
4003
+ * Search order headers
4004
+ * Call: api.orders.oeHdr.lookup.get(params)
4005
+ *
4006
+ * Search order headers (canceled orders excluded) by customer address, class, completion,
4007
+ * salesrep, taker or free text
4008
+ *
4009
+ * Response data, each item: One order header in an order lookup
4010
+ *
4011
+ * Errors:
4012
+ * 400: orderBy is not column|ASC or column|DESC on an oe_hdr column, or dateOrderCompleted
4013
+ * is not a date.
4014
+ *
4015
+ * GET https://orders.augur-api.com/oe-hdr/lookup
4016
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1oe-hdr~1lookup/get
4017
+ *
4018
+ * @param params OeHdrLookupGetParams (query string)
4019
+ * @returns BaseResponse whose `data` is OeHdrLookupGetData
4020
+ */
4021
+ get: (params?: OeHdrLookupGetParams) => Promise<BaseResponse<OeHdrLookupGetData>>;
4022
+ };
4023
+ };
4024
+ oeHdrNotepad: {
4025
+ /**
4026
+ * List Oe Hdr Notepad Rows
4027
+ * Call: api.orders.oeHdrNotepad.list(params)
4028
+ *
4029
+ * List oe hdr notepad rows as Augur holds them locally
4030
+ *
4031
+ * Errors:
4032
+ * 400: DeleteFlag is not Y or N, or orderBy is not one oe_hdr_notepad column with ASC or
4033
+ * DESC.
4034
+ *
4035
+ * GET https://orders.augur-api.com/oe-hdr-notepad
4036
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1oe-hdr-notepad/get
4037
+ *
4038
+ * @param params OeHdrNotepadListParams (query string)
4039
+ * @returns BaseResponse whose `data` is OeHdrNotepadListData
4040
+ */
4041
+ list: (params?: OeHdrNotepadListParams) => Promise<BaseResponse<OeHdrNotepadListData>>;
4042
+ /**
4043
+ * Get Oe Hdr Notepad
4044
+ * Call: api.orders.oeHdrNotepad.get(noteId)
4045
+ *
4046
+ * Get one oe hdr notepad row as Augur holds it locally
4047
+ *
4048
+ * Errors:
4049
+ * 400: noteId is missing or invalid.
4050
+ * 404: No oe hdr notepad row with this noteId.
4051
+ *
4052
+ * GET https://orders.augur-api.com/oe-hdr-notepad/{noteId}
4053
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1oe-hdr-notepad~1{noteId}/get
4054
+ *
4055
+ * @param noteId Oe hdr notepad key (oe_hdr_notepad.note_id)
4056
+ * @param params OeHdrNotepadGetParams (query string)
4057
+ * @returns BaseResponse whose `data` is OeHdrNotepadGetData
4058
+ */
4059
+ get: (noteId: number, params?: OeHdrNotepadGetParams) => Promise<BaseResponse<OeHdrNotepadGetData>>;
4060
+ };
4061
+ oeHdrRma: {
4062
+ /**
4063
+ * List Oe Hdr Rma Rows
4064
+ * Call: api.orders.oeHdrRma.list(params)
4065
+ *
4066
+ * List oe hdr rma rows as Augur holds them locally
4067
+ *
4068
+ * Errors:
4069
+ * 400: OeHdrUid is not a number, or orderBy is not one oe_hdr_rma column with ASC or DESC.
4070
+ *
4071
+ * GET https://orders.augur-api.com/oe-hdr-rma
4072
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1oe-hdr-rma/get
4073
+ *
4074
+ * @param params OeHdrRmaListParams (query string)
4075
+ * @returns BaseResponse whose `data` is OeHdrRmaListData
4076
+ */
4077
+ list: (params?: OeHdrRmaListParams) => Promise<BaseResponse<OeHdrRmaListData>>;
4078
+ /**
4079
+ * Get Oe Hdr Rma
4080
+ * Call: api.orders.oeHdrRma.get(oeHdrRmaUid)
4081
+ *
4082
+ * Get one oe hdr rma row as Augur holds it locally
4083
+ *
4084
+ * Errors:
4085
+ * 404: No oe hdr rma row with this oeHdrRmaUid.
4086
+ *
4087
+ * GET https://orders.augur-api.com/oe-hdr-rma/{oeHdrRmaUid}
4088
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1oe-hdr-rma~1{oeHdrRmaUid}/get
4089
+ *
4090
+ * @param oeHdrRmaUid Oe hdr rma key (oe_hdr_rma.oe_hdr_rma_uid)
4091
+ * @param params OeHdrRmaGetParams (query string)
4092
+ * @returns BaseResponse whose `data` is OeHdrRmaGetData
4093
+ */
4094
+ get: (oeHdrRmaUid: number, params?: OeHdrRmaGetParams) => Promise<BaseResponse<OeHdrRmaGetData>>;
4095
+ };
4096
+ oeHdrSalesrep: {
4097
+ /**
4098
+ * List Oe Hdr Salesrep Rows
4099
+ * Call: api.orders.oeHdrSalesrep.list(params)
4100
+ *
4101
+ * List oe hdr salesrep rows as Augur holds them locally
4102
+ *
4103
+ * Errors:
4104
+ * 400: DeleteFlag is not Y or N, or orderBy is not one oe_hdr_salesrep column with ASC or
4105
+ * DESC.
4106
+ *
4107
+ * GET https://orders.augur-api.com/oe-hdr-salesrep
4108
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1oe-hdr-salesrep/get
4109
+ *
4110
+ * @param params OeHdrSalesrepListParams (query string)
4111
+ * @returns BaseResponse whose `data` is OeHdrSalesrepListData
4112
+ */
4113
+ list: (params?: OeHdrSalesrepListParams) => Promise<BaseResponse<OeHdrSalesrepListData>>;
4114
+ };
4115
+ oeHdrUd: {
4116
+ /**
4117
+ * List Oe Hdr Ud Rows
4118
+ * Call: api.orders.oeHdrUd.list(params)
4119
+ *
4120
+ * List oe hdr ud rows as Augur holds them locally
4121
+ *
4122
+ * Errors:
4123
+ * 400: OrderBy is not one oe_hdr_ud column with ASC or DESC.
4124
+ *
4125
+ * GET https://orders.augur-api.com/oe-hdr-ud
4126
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1oe-hdr-ud/get
4127
+ *
4128
+ * @param params OeHdrUdListParams (query string)
4129
+ * @returns BaseResponse whose `data` is OeHdrUdListData
4130
+ */
4131
+ list: (params?: OeHdrUdListParams) => Promise<BaseResponse<OeHdrUdListData>>;
4132
+ /**
4133
+ * Get Oe Hdr Ud
4134
+ * Call: api.orders.oeHdrUd.get(oeHdrUdUid)
4135
+ *
4136
+ * Get one oe hdr ud row as Augur holds it locally
4137
+ *
4138
+ * Errors:
4139
+ * 404: No oe hdr ud row with this oeHdrUdUid.
4140
+ *
4141
+ * GET https://orders.augur-api.com/oe-hdr-ud/{oeHdrUdUid}
4142
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1oe-hdr-ud~1{oeHdrUdUid}/get
4143
+ *
4144
+ * @param oeHdrUdUid Oe hdr ud key (oe_hdr_ud.oe_hdr_ud_uid)
4145
+ * @param params OeHdrUdGetParams (query string)
4146
+ * @returns BaseResponse whose `data` is OeHdrUdGetData
4147
+ */
4148
+ get: (oeHdrUdUid: number, params?: OeHdrUdGetParams) => Promise<BaseResponse<OeHdrUdGetData>>;
4149
+ };
4150
+ oeLine: {
4151
+ /**
4152
+ * List Oe Line Rows
4153
+ * Call: api.orders.oeLine.list(params)
4154
+ *
4155
+ * List oe line rows as Augur holds them locally
4156
+ *
4157
+ * Errors:
4158
+ * 400: DeleteFlag is not Y or N, or lineNo or invMastUid or oeHdrUid or parentOeLineUid or
4159
+ * jobPriceHdrUid or jobPriceLineUid or jobPriceBinUid or pricePageUid or costPricePageUid
4160
+ * or strategicPricePageUid or priceFamilyUid is not a number, or orderBy is not one
4161
+ * oe_line column with ASC or DESC.
4162
+ *
4163
+ * GET https://orders.augur-api.com/oe-line
4164
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1oe-line/get
4165
+ *
4166
+ * @param params OeLineListParams (query string)
4167
+ * @returns BaseResponse whose `data` is OeLineListData
4168
+ */
4169
+ list: (params?: OeLineListParams) => Promise<BaseResponse<OeLineListData>>;
4170
+ /**
4171
+ * Get Oe Line
4172
+ * Call: api.orders.oeLine.get(oeLineUid)
4173
+ *
4174
+ * Get one oe line row as Augur holds it locally
4175
+ *
4176
+ * Errors:
4177
+ * 404: No oe line row with this oeLineUid.
4178
+ *
4179
+ * GET https://orders.augur-api.com/oe-line/{oeLineUid}
4180
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1oe-line~1{oeLineUid}/get
4181
+ *
4182
+ * @param oeLineUid Oe line key (oe_line.oe_line_uid)
4183
+ * @param params OeLineGetParams (query string)
4184
+ * @returns BaseResponse whose `data` is OeLineGetData
4185
+ */
4186
+ get: (oeLineUid: number, params?: OeLineGetParams) => Promise<BaseResponse<OeLineGetData>>;
4187
+ };
4188
+ oeLineRma: {
4189
+ /**
4190
+ * List Oe Line Rma Rows
4191
+ * Call: api.orders.oeLineRma.list(params)
4192
+ *
4193
+ * List oe line rma rows as Augur holds them locally
4194
+ *
4195
+ * Errors:
4196
+ * 400: OeLineUid or rmaLinkedOeLineUid or invoiceLineUid is not a number, or orderBy is not
4197
+ * one oe_line_rma column with ASC or DESC.
4198
+ *
4199
+ * GET https://orders.augur-api.com/oe-line-rma
4200
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1oe-line-rma/get
4201
+ *
4202
+ * @param params OeLineRmaListParams (query string)
4203
+ * @returns BaseResponse whose `data` is OeLineRmaListData
4204
+ */
4205
+ list: (params?: OeLineRmaListParams) => Promise<BaseResponse<OeLineRmaListData>>;
4206
+ /**
4207
+ * Get Oe Line Rma
4208
+ * Call: api.orders.oeLineRma.get(oeLineRmaUid)
4209
+ *
4210
+ * Get one oe line rma row as Augur holds it locally
4211
+ *
4212
+ * Errors:
4213
+ * 404: No oe line rma row with this oeLineRmaUid.
4214
+ *
4215
+ * GET https://orders.augur-api.com/oe-line-rma/{oeLineRmaUid}
4216
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1oe-line-rma~1{oeLineRmaUid}/get
4217
+ *
4218
+ * @param oeLineRmaUid Oe line rma key (oe_line_rma.oe_line_rma_uid)
4219
+ * @param params OeLineRmaGetParams (query string)
4220
+ * @returns BaseResponse whose `data` is OeLineRmaGetData
4221
+ */
4222
+ get: (oeLineRmaUid: number, params?: OeLineRmaGetParams) => Promise<BaseResponse<OeLineRmaGetData>>;
4223
+ };
4224
+ oeLineUd: {
4225
+ /**
4226
+ * List Oe Line Ud Rows
4227
+ * Call: api.orders.oeLineUd.list(params)
4228
+ *
4229
+ * List oe line ud rows as Augur holds them locally
4230
+ *
4231
+ * Errors:
4232
+ * 400: OrderBy is not one oe_line_ud column with ASC or DESC.
4233
+ *
4234
+ * GET https://orders.augur-api.com/oe-line-ud
4235
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1oe-line-ud/get
4236
+ *
4237
+ * @param params OeLineUdListParams (query string)
4238
+ * @returns BaseResponse whose `data` is OeLineUdListData
4239
+ */
4240
+ list: (params?: OeLineUdListParams) => Promise<BaseResponse<OeLineUdListData>>;
4241
+ /**
4242
+ * Get Oe Line Ud
4243
+ * Call: api.orders.oeLineUd.get(oeLineUdUid)
4244
+ *
4245
+ * Get one oe line ud row as Augur holds it locally
4246
+ *
4247
+ * Errors:
4248
+ * 404: No oe line ud row with this oeLineUdUid.
4249
+ *
4250
+ * GET https://orders.augur-api.com/oe-line-ud/{oeLineUdUid}
4251
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1oe-line-ud~1{oeLineUdUid}/get
4252
+ *
4253
+ * @param oeLineUdUid Oe line ud key (oe_line_ud.oe_line_ud_uid)
4254
+ * @param params OeLineUdGetParams (query string)
4255
+ * @returns BaseResponse whose `data` is OeLineUdGetData
4256
+ */
4257
+ get: (oeLineUdUid: number, params?: OeLineUdGetParams) => Promise<BaseResponse<OeLineUdGetData>>;
4258
+ };
4259
+ paymentDetail: {
4260
+ /**
4261
+ * List Payment Detail Rows
4262
+ * Call: api.orders.paymentDetail.list(params)
4263
+ *
4264
+ * List payment detail rows as Augur holds them locally
4265
+ *
4266
+ * Errors:
4267
+ * 400: OrderBy is not one payment_detail column with ASC or DESC.
4268
+ *
4269
+ * GET https://orders.augur-api.com/payment-detail
4270
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1payment-detail/get
4271
+ *
4272
+ * @param params PaymentDetailListParams (query string)
4273
+ * @returns BaseResponse whose `data` is PaymentDetailListData
4274
+ */
4275
+ list: (params?: PaymentDetailListParams) => Promise<BaseResponse<PaymentDetailListData>>;
4276
+ /**
4277
+ * Get Payment Detail
4278
+ * Call: api.orders.paymentDetail.get(paymentDetailUid)
4279
+ *
4280
+ * Get one payment detail row as Augur holds it locally
4281
+ *
4282
+ * Errors:
4283
+ * 404: No payment detail row with this paymentDetailUid.
4284
+ *
4285
+ * GET https://orders.augur-api.com/payment-detail/{paymentDetailUid}
4286
+ * Contract:
4287
+ * https://orders.augur-api.com/openapi.json#/paths/~1payment-detail~1{paymentDetailUid}/get
4288
+ *
4289
+ * @param paymentDetailUid Payment detail key (payment_detail.payment_detail_uid)
4290
+ * @param params PaymentDetailGetParams (query string)
4291
+ * @returns BaseResponse whose `data` is PaymentDetailGetData
4292
+ */
4293
+ get: (paymentDetailUid: number, params?: PaymentDetailGetParams) => Promise<BaseResponse<PaymentDetailGetData>>;
4294
+ };
4295
+ payments: {
4296
+ /**
4297
+ * List Payments Rows
4298
+ * Call: api.orders.payments.list(params)
4299
+ *
4300
+ * List payments rows as Augur holds them locally
4301
+ *
4302
+ * Errors:
4303
+ * 400: BankNo or vendorId is not a number, or orderBy is not one payments column with ASC or
4304
+ * DESC.
4305
+ *
4306
+ * GET https://orders.augur-api.com/payments
4307
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1payments/get
4308
+ *
4309
+ * @param params PaymentsListParams (query string)
4310
+ * @returns BaseResponse whose `data` is PaymentsListData
4311
+ */
4312
+ list: (params?: PaymentsListParams) => Promise<BaseResponse<PaymentsListData>>;
4313
+ };
4314
+ pendingPayments: {
4315
+ /**
4316
+ * List Pending Payments Rows
4317
+ * Call: api.orders.pendingPayments.list(params)
4318
+ *
4319
+ * List pending payments rows as Augur holds them locally
4320
+ *
4321
+ * Errors:
4322
+ * 400: OrderBy is not one pending_payments column with ASC or DESC.
4323
+ *
4324
+ * GET https://orders.augur-api.com/pending-payments
4325
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1pending-payments/get
4326
+ *
4327
+ * @param params PendingPaymentsListParams (query string)
4328
+ * @returns BaseResponse whose `data` is PendingPaymentsListData
4329
+ */
4330
+ list: (params?: PendingPaymentsListParams) => Promise<BaseResponse<PendingPaymentsListData>>;
4331
+ /**
4332
+ * Get Pending Payments
4333
+ * Call: api.orders.pendingPayments.get(pendingPaymentUid)
4334
+ *
4335
+ * Get one pending payments row as Augur holds it locally
4336
+ *
4337
+ * Errors:
4338
+ * 404: No pending payments row with this pendingPaymentUid.
4339
+ *
4340
+ * GET https://orders.augur-api.com/pending-payments/{pendingPaymentUid}
4341
+ * Contract:
4342
+ * https://orders.augur-api.com/openapi.json#/paths/~1pending-payments~1{pendingPaymentUid}/get
4343
+ *
4344
+ * @param pendingPaymentUid Pending payments key (pending_payments.pending_payment_uid)
4345
+ * @param params PendingPaymentsGetParams (query string)
4346
+ * @returns BaseResponse whose `data` is PendingPaymentsGetData
4347
+ */
4348
+ get: (pendingPaymentUid: number, params?: PendingPaymentsGetParams) => Promise<BaseResponse<PendingPaymentsGetData>>;
4349
+ };
4350
+ pickTickets: {
4351
+ /**
4352
+ * List Pick Tickets
4353
+ * Call: api.orders.pickTickets.list(params)
4354
+ *
4355
+ * Errors:
4356
+ * 400: orderBy is not column|ASC or column|DESC on an oe_pick_ticket column.
4357
+ *
4358
+ * GET https://orders.augur-api.com/pick-tickets
4359
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1pick-tickets/get
4360
+ *
4361
+ * @param params PickTicketsListParams (query string)
4362
+ * @returns BaseResponse whose `data` is PickTicketsListData
4363
+ */
4364
+ list: (params?: PickTicketsListParams) => Promise<BaseResponse<PickTicketsListData>>;
4365
+ /**
4366
+ * Get Pick Ticket Details
4367
+ * Call: api.orders.pickTickets.get(pickTicketNo)
4368
+ *
4369
+ * Errors:
4370
+ * 404: No pick ticket with this number.
4371
+ *
4372
+ * GET https://orders.augur-api.com/pick-tickets/{pickTicketNo}
4373
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1pick-tickets~1{pickTicketNo}/get
4374
+ *
4375
+ * @param pickTicketNo Prophet 21 pick ticket number
4376
+ * @param params PickTicketsGetParams (query string)
4377
+ * @returns BaseResponse whose `data` is PickTicketsGetData
4378
+ */
4379
+ get: (pickTicketNo: number, params?: PickTicketsGetParams) => Promise<BaseResponse<PickTicketsGetData>>;
4380
+ lines: {
4381
+ /**
4382
+ * List Pick Ticket Lines
4383
+ * Call: api.orders.pickTickets.lines.list(pickTicketNo, params)
4384
+ *
4385
+ * Response data, each item: One pick ticket line (`oe_pick_ticket_detail`) with its item ID
4386
+ * and tracking pattern
4387
+ *
4388
+ * Errors:
4389
+ * 400: orderBy is not column|ASC or column|DESC on an oe_pick_ticket_detail column.
4390
+ * 404: No pick ticket with this number.
4391
+ *
4392
+ * GET https://orders.augur-api.com/pick-tickets/{pickTicketNo}/lines
4393
+ * Contract:
4394
+ * https://orders.augur-api.com/openapi.json#/paths/~1pick-tickets~1{pickTicketNo}~1lines/get
4395
+ *
4396
+ * @param pickTicketNo Prophet 21 pick ticket number
4397
+ * @param params PickTicketsLinesListParams (query string)
4398
+ * @returns BaseResponse whose `data` is PickTicketsLinesListData
4399
+ */
4400
+ list: (pickTicketNo: number, params?: PickTicketsLinesListParams) => Promise<BaseResponse<PickTicketsLinesListData>>;
4401
+ /**
4402
+ * Get Pick Ticket Line Detail
4403
+ * Call: api.orders.pickTickets.lines.get(pickTicketNo, lineNumber)
4404
+ *
4405
+ * Response data: One pick ticket line (`oe_pick_ticket_detail`) with its item ID and tracking
4406
+ * pattern
4407
+ *
4408
+ * Errors:
4409
+ * 404: No line with this number on the pick ticket.
4410
+ *
4411
+ * GET https://orders.augur-api.com/pick-tickets/{pickTicketNo}/lines/{lineNumber}
4412
+ * Contract:
4413
+ * https://orders.augur-api.com/openapi.json#/paths/~1pick-tickets~1{pickTicketNo}~1lines~1{lineNumber}/get
4414
+ *
4415
+ * @param pickTicketNo Prophet 21 pick ticket number
4416
+ * @param lineNumber Line number on the pick ticket
4417
+ * @param params PickTicketsLinesGetParams (query string)
4418
+ * @returns BaseResponse whose `data` is PickTicketsLinesGetData
4419
+ */
4420
+ get: (pickTicketNo: number, lineNumber: number, params?: PickTicketsLinesGetParams) => Promise<BaseResponse<PickTicketsLinesGetData>>;
4421
+ };
4422
+ };
4423
+ poHdr: {
4424
+ /**
4425
+ * List purchase orders
4426
+ * Call: api.orders.poHdr.list(params)
4427
+ *
4428
+ * List purchase order documents, each with its lines
4429
+ *
4430
+ * Response data, each item: One purchase order with its vendor, supplier and lines
4431
+ *
4432
+ * Errors:
4433
+ * 400: orderBy is not column|ASC or column|DESC on a po_hdr column.
4434
+ *
4435
+ * GET https://orders.augur-api.com/po-hdr
4436
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1po-hdr/get
4437
+ *
4438
+ * @param params PoHdrListParams (query string)
4439
+ * @returns BaseResponse whose `data` is PoHdrListData
4440
+ */
4441
+ list: (params?: PoHdrListParams) => Promise<BaseResponse<PoHdrListData>>;
4442
+ /**
4443
+ * get the purchase order details
4444
+ * Call: api.orders.poHdr.get(poNo)
4445
+ *
4446
+ * Response data: One purchase order with its vendor, supplier and lines
4447
+ *
4448
+ * Errors:
4449
+ * 404: No purchase order with this number.
4450
+ *
4451
+ * GET https://orders.augur-api.com/po-hdr/{poNo}
4452
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1po-hdr~1{poNo}/get
4453
+ *
4454
+ * @param poNo Prophet 21 purchase order number
4455
+ * @param params PoHdrGetParams (query string)
4456
+ * @returns BaseResponse whose `data` is PoHdrGetData
4457
+ */
4458
+ get: (poNo: number, params?: PoHdrGetParams) => Promise<BaseResponse<PoHdrGetData>>;
4459
+ doc: {
4460
+ /**
4461
+ * get the purchase order document
4462
+ * Call: api.orders.poHdr.doc.list(poNo)
4463
+ *
4464
+ * Response data: One purchase order with its vendor, supplier and lines
4465
+ *
4466
+ * Errors:
4467
+ * 404: No purchase order with this number.
4468
+ *
4469
+ * GET https://orders.augur-api.com/po-hdr/{poNo}/doc
4470
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1po-hdr~1{poNo}~1doc/get
4471
+ *
4472
+ * @param poNo Prophet 21 purchase order number
4473
+ * @param params PoHdrDocListParams (query string)
4474
+ * @returns BaseResponse whose `data` is PoHdrDocListData
4475
+ */
4476
+ list: (poNo: number, params?: PoHdrDocListParams) => Promise<BaseResponse<PoHdrDocListData>>;
4477
+ /** Alias for `list`: GET /po-hdr/{poNo}/doc. Call: api.orders.poHdr.doc.get(poNo) */
4478
+ get: (poNo: number, params?: PoHdrDocListParams) => Promise<BaseResponse<PoHdrDocListData>>;
4479
+ };
4480
+ };
4481
+ poLine: {
4482
+ /**
4483
+ * List purchase order lines
4484
+ * Call: api.orders.poLine.list(params)
4485
+ *
4486
+ * Errors:
4487
+ * 400: orderBy is not column|ASC or column|DESC on a po_line column.
4488
+ *
4489
+ * GET https://orders.augur-api.com/po-line
4490
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1po-line/get
4491
+ *
4492
+ * @param params PoLineListParams (query string)
4493
+ * @returns BaseResponse whose `data` is PoLineListData
4494
+ */
4495
+ list: (params?: PoLineListParams) => Promise<BaseResponse<PoLineListData>>;
4496
+ /**
4497
+ * Get a purchase order line
4498
+ * Call: api.orders.poLine.get(poLineUid)
4499
+ *
4500
+ * Errors:
4501
+ * 404: No purchase order line with this ID.
4502
+ *
4503
+ * GET https://orders.augur-api.com/po-line/{poLineUid}
4504
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1po-line~1{poLineUid}/get
4505
+ *
4506
+ * @param poLineUid po_line.po_line_uid
4507
+ * @param params PoLineGetParams (query string)
4508
+ * @returns BaseResponse whose `data` is PoLineGetData
4509
+ */
4510
+ get: (poLineUid: number, params?: PoLineGetParams) => Promise<BaseResponse<PoLineGetData>>;
4511
+ };
4512
+ quoteHdr: {
4513
+ /**
4514
+ * List Quote Hdr Rows
4515
+ * Call: api.orders.quoteHdr.list(params)
4516
+ *
4517
+ * List quote hdr rows as Augur holds them locally
4518
+ *
4519
+ * Errors:
4520
+ * 400: OeHdrUid is not a number, or orderBy is not one quote_hdr column with ASC or DESC.
4521
+ *
4522
+ * GET https://orders.augur-api.com/quote-hdr
4523
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1quote-hdr/get
4524
+ *
4525
+ * @param params QuoteHdrListParams (query string)
4526
+ * @returns BaseResponse whose `data` is QuoteHdrListData
4527
+ */
4528
+ list: (params?: QuoteHdrListParams) => Promise<BaseResponse<QuoteHdrListData>>;
4529
+ /**
4530
+ * Get Quote Hdr
4531
+ * Call: api.orders.quoteHdr.get(quoteHdrUid)
4532
+ *
4533
+ * Get one quote hdr row as Augur holds it locally
4534
+ *
4535
+ * Errors:
4536
+ * 404: No quote hdr row with this quoteHdrUid.
4537
+ *
4538
+ * GET https://orders.augur-api.com/quote-hdr/{quoteHdrUid}
4539
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1quote-hdr~1{quoteHdrUid}/get
4540
+ *
4541
+ * @param quoteHdrUid Quote hdr key (quote_hdr.quote_hdr_uid)
4542
+ * @param params QuoteHdrGetParams (query string)
4543
+ * @returns BaseResponse whose `data` is QuoteHdrGetData
4544
+ */
4545
+ get: (quoteHdrUid: number, params?: QuoteHdrGetParams) => Promise<BaseResponse<QuoteHdrGetData>>;
4546
+ };
4547
+ remittances: {
4548
+ /**
4549
+ * List Remittances Rows
4550
+ * Call: api.orders.remittances.list(params)
4551
+ *
4552
+ * List remittances rows as Augur holds them locally
4553
+ *
4554
+ * Errors:
4555
+ * 400: DeleteFlag is not Y or N, or orderBy is not one remittances column with ASC or DESC.
4556
+ *
4557
+ * GET https://orders.augur-api.com/remittances
4558
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1remittances/get
4559
+ *
4560
+ * @param params RemittancesListParams (query string)
4561
+ * @returns BaseResponse whose `data` is RemittancesListData
4562
+ */
4563
+ list: (params?: RemittancesListParams) => Promise<BaseResponse<RemittancesListData>>;
4564
+ /**
4565
+ * Get Remittances
4566
+ * Call: api.orders.remittances.get(remittanceNumber)
4567
+ *
4568
+ * Get one remittances row as Augur holds it locally
4569
+ *
4570
+ * Errors:
4571
+ * 400: remittanceNumber is missing or invalid.
4572
+ * 404: No remittances row with this remittanceNumber.
4573
+ *
4574
+ * GET https://orders.augur-api.com/remittances/{remittanceNumber}
4575
+ * Contract:
4576
+ * https://orders.augur-api.com/openapi.json#/paths/~1remittances~1{remittanceNumber}/get
4577
+ *
4578
+ * @param remittanceNumber Remittances key (remittances.remittance_number)
4579
+ * @param params RemittancesGetParams (query string)
4580
+ * @returns BaseResponse whose `data` is RemittancesGetData
4581
+ */
4582
+ get: (remittanceNumber: number, params?: RemittancesGetParams) => Promise<BaseResponse<RemittancesGetData>>;
4583
+ };
4584
+ remittancesDetail: {
4585
+ /**
4586
+ * List Remittances Detail Rows
4587
+ * Call: api.orders.remittancesDetail.list(params)
4588
+ *
4589
+ * List remittances detail rows as Augur holds them locally
4590
+ *
4591
+ * Errors:
4592
+ * 400: DeleteFlag is not Y or N, or remittanceNumber is not a number, or orderBy is not one
4593
+ * remittances_detail column with ASC or DESC.
4594
+ *
4595
+ * GET https://orders.augur-api.com/remittances-detail
4596
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1remittances-detail/get
4597
+ *
4598
+ * @param params RemittancesDetailListParams (query string)
4599
+ * @returns BaseResponse whose `data` is RemittancesDetailListData
4600
+ */
4601
+ list: (params?: RemittancesDetailListParams) => Promise<BaseResponse<RemittancesDetailListData>>;
4602
+ };
4603
+ shippingRoute: {
4604
+ /**
4605
+ * List Shipping Route Rows
4606
+ * Call: api.orders.shippingRoute.list(params)
4607
+ *
4608
+ * List shipping route rows as Augur holds them locally
4609
+ *
4610
+ * Errors:
4611
+ * 400: DeliveryZoneUid is not a number, or orderBy is not one shipping_route column with ASC
4612
+ * or DESC.
4613
+ *
4614
+ * GET https://orders.augur-api.com/shipping-route
4615
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1shipping-route/get
4616
+ *
4617
+ * @param params ShippingRouteListParams (query string)
4618
+ * @returns BaseResponse whose `data` is ShippingRouteListData
4619
+ */
4620
+ list: (params?: ShippingRouteListParams) => Promise<BaseResponse<ShippingRouteListData>>;
4621
+ /**
4622
+ * Get Shipping Route
4623
+ * Call: api.orders.shippingRoute.get(shippingRouteUid)
4624
+ *
4625
+ * Get one shipping route row as Augur holds it locally
4626
+ *
4627
+ * Errors:
4628
+ * 404: No shipping route row with this shippingRouteUid.
4629
+ *
4630
+ * GET https://orders.augur-api.com/shipping-route/{shippingRouteUid}
4631
+ * Contract:
4632
+ * https://orders.augur-api.com/openapi.json#/paths/~1shipping-route~1{shippingRouteUid}/get
4633
+ *
4634
+ * @param shippingRouteUid Shipping route key (shipping_route.shipping_route_uid)
4635
+ * @param params ShippingRouteGetParams (query string)
4636
+ * @returns BaseResponse whose `data` is ShippingRouteGetData
4637
+ */
4638
+ get: (shippingRouteUid: number, params?: ShippingRouteGetParams) => Promise<BaseResponse<ShippingRouteGetData>>;
4639
+ };
4640
+ wirelessTransAuditHdr: {
4641
+ /**
4642
+ * List Wireless Trans Audit Hdr Rows
4643
+ * Call: api.orders.wirelessTransAuditHdr.list(params)
4644
+ *
4645
+ * List wireless trans audit hdr rows as Augur holds them locally
4646
+ *
4647
+ * Errors:
4648
+ * 400: LocationId or workbenchUid is not a number, or orderBy is not one
4649
+ * wireless_trans_audit_hdr column with ASC or DESC.
4650
+ *
4651
+ * GET https://orders.augur-api.com/wireless-trans-audit-hdr
4652
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1wireless-trans-audit-hdr/get
4653
+ *
4654
+ * @param params WirelessTransAuditHdrListParams (query string)
4655
+ * @returns BaseResponse whose `data` is WirelessTransAuditHdrListData
4656
+ */
4657
+ list: (params?: WirelessTransAuditHdrListParams) => Promise<BaseResponse<WirelessTransAuditHdrListData>>;
4658
+ /**
4659
+ * Get Wireless Trans Audit Hdr
4660
+ * Call: api.orders.wirelessTransAuditHdr.get(wirelessTransAuditHdrUid)
4661
+ *
4662
+ * Get one wireless trans audit hdr row as Augur holds it locally
4663
+ *
4664
+ * Errors:
4665
+ * 404: No wireless trans audit hdr row with this wirelessTransAuditHdrUid.
4666
+ *
4667
+ * GET https://orders.augur-api.com/wireless-trans-audit-hdr/{wirelessTransAuditHdrUid}
4668
+ * Contract:
4669
+ * https://orders.augur-api.com/openapi.json#/paths/~1wireless-trans-audit-hdr~1{wirelessTransAuditHdrUid}/get
4670
+ *
4671
+ * @param wirelessTransAuditHdrUid Wireless trans audit hdr key
4672
+ * (wireless_trans_audit_hdr.wireless_trans_audit_hdr_uid)
4673
+ * @param params WirelessTransAuditHdrGetParams (query string)
4674
+ * @returns BaseResponse whose `data` is WirelessTransAuditHdrGetData
4675
+ */
4676
+ get: (wirelessTransAuditHdrUid: number, params?: WirelessTransAuditHdrGetParams) => Promise<BaseResponse<WirelessTransAuditHdrGetData>>;
4677
+ };
4678
+ wirelessTransAuditLine: {
4679
+ /**
4680
+ * List Wireless Trans Audit Line Rows
4681
+ * Call: api.orders.wirelessTransAuditLine.list(params)
4682
+ *
4683
+ * List wireless trans audit line rows as Augur holds them locally
4684
+ *
4685
+ * Errors:
4686
+ * 400: WirelessTransAuditHdrUid or invMastUid is not a number, or orderBy is not one
4687
+ * wireless_trans_audit_line column with ASC or DESC.
4688
+ *
4689
+ * GET https://orders.augur-api.com/wireless-trans-audit-line
4690
+ * Contract: https://orders.augur-api.com/openapi.json#/paths/~1wireless-trans-audit-line/get
4691
+ *
4692
+ * @param params WirelessTransAuditLineListParams (query string)
4693
+ * @returns BaseResponse whose `data` is WirelessTransAuditLineListData
4694
+ */
4695
+ list: (params?: WirelessTransAuditLineListParams) => Promise<BaseResponse<WirelessTransAuditLineListData>>;
4696
+ /**
4697
+ * Get Wireless Trans Audit Line
4698
+ * Call: api.orders.wirelessTransAuditLine.get(wirelessTransAuditLineUid)
4699
+ *
4700
+ * Get one wireless trans audit line row as Augur holds it locally
4701
+ *
4702
+ * Errors:
4703
+ * 404: No wireless trans audit line row with this wirelessTransAuditLineUid.
4704
+ *
4705
+ * GET https://orders.augur-api.com/wireless-trans-audit-line/{wirelessTransAuditLineUid}
4706
+ * Contract:
4707
+ * https://orders.augur-api.com/openapi.json#/paths/~1wireless-trans-audit-line~1{wirelessTransAuditLineUid}/get
4708
+ *
4709
+ * @param wirelessTransAuditLineUid Wireless trans audit line key
4710
+ * (wireless_trans_audit_line.wireless_trans_audit_line_uid)
4711
+ * @param params WirelessTransAuditLineGetParams (query string)
4712
+ * @returns BaseResponse whose `data` is WirelessTransAuditLineGetData
4713
+ */
4714
+ get: (wirelessTransAuditLineUid: number, params?: WirelessTransAuditLineGetParams) => Promise<BaseResponse<WirelessTransAuditLineGetData>>;
4715
+ };
4716
+ }
4717
+ //# sourceMappingURL=types.d.ts.map