@simpleapps-com/augur-api 2026.10.31 → 2026.11.2
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.
- package/README.md +85 -34
- package/SKILL.md +25 -24
- package/dist/client.d.ts +336 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/core/base-client.d.ts +159 -0
- package/dist/core/base-client.d.ts.map +1 -0
- package/dist/core/call-rules.d.ts +73 -0
- package/dist/core/call-rules.d.ts.map +1 -0
- package/dist/core/call.d.ts +48 -0
- package/dist/core/call.d.ts.map +1 -0
- package/dist/core/client.d.ts +112 -0
- package/dist/core/client.d.ts.map +1 -0
- package/dist/core/common-schemas.d.ts +522 -0
- package/dist/core/common-schemas.d.ts.map +1 -0
- package/dist/core/config.d.ts +72 -0
- package/dist/core/config.d.ts.map +1 -0
- package/dist/core/encoded-segment.d.ts +23 -0
- package/dist/core/encoded-segment.d.ts.map +1 -0
- package/dist/core/errors.d.ts +91 -0
- package/dist/core/errors.d.ts.map +1 -0
- package/dist/core/http-rules.d.ts +64 -0
- package/dist/core/http-rules.d.ts.map +1 -0
- package/dist/core/path-validation.d.ts +28 -0
- package/dist/core/path-validation.d.ts.map +1 -0
- package/dist/core/proxy-rules.d.ts +21 -0
- package/dist/core/proxy-rules.d.ts.map +1 -0
- package/dist/core/registry-rules.d.ts +15 -0
- package/dist/core/registry-rules.d.ts.map +1 -0
- package/dist/core/registry-tables.d.ts +3 -0
- package/dist/core/registry-tables.d.ts.map +1 -0
- package/dist/core/registry.d.ts +54 -0
- package/dist/core/registry.d.ts.map +1 -0
- package/dist/core/response-rules.d.ts +26 -0
- package/dist/core/response-rules.d.ts.map +1 -0
- package/dist/core/schemas.d.ts +71 -0
- package/dist/core/schemas.d.ts.map +1 -0
- package/dist/core/service-proxy.d.ts +81 -0
- package/dist/core/service-proxy.d.ts.map +1 -0
- package/dist/core/site-id-check.d.ts +6 -0
- package/dist/core/site-id-check.d.ts.map +1 -0
- package/dist/core/site-id.d.ts +15 -0
- package/dist/core/site-id.d.ts.map +1 -0
- package/dist/index.d.ts +71 -236
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +19565 -18212
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +19564 -18212
- package/dist/index.mjs.map +1 -1
- package/dist/services/agr-info/client.d.ts +71 -0
- package/dist/services/agr-info/client.d.ts.map +1 -0
- package/dist/services/agr-info/generated/endpoints.d.ts +41 -0
- package/dist/services/agr-info/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-info/generated/schemas.d.ts +299 -0
- package/dist/services/agr-info/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-info/generated/types.d.ts +1111 -0
- package/dist/services/agr-info/generated/types.d.ts.map +1 -0
- package/dist/services/agr-info/index.d.ts +2 -0
- package/dist/services/agr-info/index.d.ts.map +1 -0
- package/dist/services/agr-int/client.d.ts +100 -0
- package/dist/services/agr-int/client.d.ts.map +1 -0
- package/dist/services/agr-int/generated/endpoints.d.ts +42 -0
- package/dist/services/agr-int/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-int/generated/schemas.d.ts +595 -0
- package/dist/services/agr-int/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-int/generated/types.d.ts +1984 -0
- package/dist/services/agr-int/generated/types.d.ts.map +1 -0
- package/dist/services/agr-int/index.d.ts +2 -0
- package/dist/services/agr-int/index.d.ts.map +1 -0
- package/dist/services/agr-site/client.d.ts +112 -0
- package/dist/services/agr-site/client.d.ts.map +1 -0
- package/dist/services/agr-site/generated/endpoints.d.ts +42 -0
- package/dist/services/agr-site/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-site/generated/schemas.d.ts +537 -0
- package/dist/services/agr-site/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-site/generated/types.d.ts +1732 -0
- package/dist/services/agr-site/generated/types.d.ts.map +1 -0
- package/dist/services/agr-site/index.d.ts +2 -0
- package/dist/services/agr-site/index.d.ts.map +1 -0
- package/dist/services/agr-work/client.d.ts +23 -0
- package/dist/services/agr-work/client.d.ts.map +1 -0
- package/dist/services/agr-work/generated/endpoints.d.ts +41 -0
- package/dist/services/agr-work/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-work/generated/schemas.d.ts +21 -0
- package/dist/services/agr-work/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-work/generated/types.d.ts +19 -0
- package/dist/services/agr-work/generated/types.d.ts.map +1 -0
- package/dist/services/agr-work/index.d.ts +2 -0
- package/dist/services/agr-work/index.d.ts.map +1 -0
- package/dist/services/avalara/client.d.ts +33 -0
- package/dist/services/avalara/client.d.ts.map +1 -0
- package/dist/services/avalara/generated/endpoints.d.ts +41 -0
- package/dist/services/avalara/generated/endpoints.d.ts.map +1 -0
- package/dist/services/avalara/generated/schemas.d.ts +22 -0
- package/dist/services/avalara/generated/schemas.d.ts.map +1 -0
- package/dist/services/avalara/generated/types.d.ts +103 -0
- package/dist/services/avalara/generated/types.d.ts.map +1 -0
- package/dist/services/avalara/index.d.ts +2 -0
- package/dist/services/avalara/index.d.ts.map +1 -0
- package/dist/services/basecamp2/client.d.ts +92 -0
- package/dist/services/basecamp2/client.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/endpoints.d.ts +42 -0
- package/dist/services/basecamp2/generated/endpoints.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/schemas.d.ts +845 -0
- package/dist/services/basecamp2/generated/schemas.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/types.d.ts +1587 -0
- package/dist/services/basecamp2/generated/types.d.ts.map +1 -0
- package/dist/services/basecamp2/index.d.ts +2 -0
- package/dist/services/basecamp2/index.d.ts.map +1 -0
- package/dist/services/brand-folder/client.d.ts +37 -0
- package/dist/services/brand-folder/client.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/endpoints.d.ts +41 -0
- package/dist/services/brand-folder/generated/endpoints.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/schemas.d.ts +81 -0
- package/dist/services/brand-folder/generated/schemas.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/types.d.ts +195 -0
- package/dist/services/brand-folder/generated/types.d.ts.map +1 -0
- package/dist/services/brand-folder/index.d.ts +2 -0
- package/dist/services/brand-folder/index.d.ts.map +1 -0
- package/dist/services/commerce/client.d.ts +57 -0
- package/dist/services/commerce/client.d.ts.map +1 -0
- package/dist/services/commerce/generated/endpoints.d.ts +42 -0
- package/dist/services/commerce/generated/endpoints.d.ts.map +1 -0
- package/dist/services/commerce/generated/schemas.d.ts +319 -0
- package/dist/services/commerce/generated/schemas.d.ts.map +1 -0
- package/dist/services/commerce/generated/types.d.ts +1134 -0
- package/dist/services/commerce/generated/types.d.ts.map +1 -0
- package/dist/services/commerce/index.d.ts +2 -0
- package/dist/services/commerce/index.d.ts.map +1 -0
- package/dist/services/customers/client.d.ts +162 -0
- package/dist/services/customers/client.d.ts.map +1 -0
- package/dist/services/customers/generated/endpoints.d.ts +42 -0
- package/dist/services/customers/generated/endpoints.d.ts.map +1 -0
- package/dist/services/customers/generated/schemas.d.ts +1970 -0
- package/dist/services/customers/generated/schemas.d.ts.map +1 -0
- package/dist/services/customers/generated/types.d.ts +3849 -0
- package/dist/services/customers/generated/types.d.ts.map +1 -0
- package/dist/services/customers/index.d.ts +2 -0
- package/dist/services/customers/index.d.ts.map +1 -0
- package/dist/services/goog-mc/client.d.ts +44 -0
- package/dist/services/goog-mc/client.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/endpoints.d.ts +42 -0
- package/dist/services/goog-mc/generated/endpoints.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/schemas.d.ts +175 -0
- package/dist/services/goog-mc/generated/schemas.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/types.d.ts +361 -0
- package/dist/services/goog-mc/generated/types.d.ts.map +1 -0
- package/dist/services/goog-mc/index.d.ts +2 -0
- package/dist/services/goog-mc/index.d.ts.map +1 -0
- package/dist/services/gregorovich/client.d.ts +34 -0
- package/dist/services/gregorovich/client.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/endpoints.d.ts +42 -0
- package/dist/services/gregorovich/generated/endpoints.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/schemas.d.ts +35 -0
- package/dist/services/gregorovich/generated/schemas.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/types.d.ts +70 -0
- package/dist/services/gregorovich/generated/types.d.ts.map +1 -0
- package/dist/services/gregorovich/index.d.ts +2 -0
- package/dist/services/gregorovich/index.d.ts.map +1 -0
- package/dist/services/items/client.d.ts +453 -0
- package/dist/services/items/client.d.ts.map +1 -0
- package/dist/services/items/generated/endpoints.d.ts +42 -0
- package/dist/services/items/generated/endpoints.d.ts.map +1 -0
- package/dist/services/items/generated/schemas.d.ts +4636 -0
- package/dist/services/items/generated/schemas.d.ts.map +1 -0
- package/dist/services/items/generated/types.d.ts +10513 -0
- package/dist/services/items/generated/types.d.ts.map +1 -0
- package/dist/services/items/index.d.ts +2 -0
- package/dist/services/items/index.d.ts.map +1 -0
- package/dist/services/joomla/client.d.ts +74 -0
- package/dist/services/joomla/client.d.ts.map +1 -0
- package/dist/services/joomla/generated/endpoints.d.ts +41 -0
- package/dist/services/joomla/generated/endpoints.d.ts.map +1 -0
- package/dist/services/joomla/generated/schemas.d.ts +550 -0
- package/dist/services/joomla/generated/schemas.d.ts.map +1 -0
- package/dist/services/joomla/generated/types.d.ts +1502 -0
- package/dist/services/joomla/generated/types.d.ts.map +1 -0
- package/dist/services/joomla/index.d.ts +2 -0
- package/dist/services/joomla/index.d.ts.map +1 -0
- package/dist/services/legacy/client.d.ts +75 -0
- package/dist/services/legacy/client.d.ts.map +1 -0
- package/dist/services/legacy/generated/endpoints.d.ts +41 -0
- package/dist/services/legacy/generated/endpoints.d.ts.map +1 -0
- package/dist/services/legacy/generated/schemas.d.ts +567 -0
- package/dist/services/legacy/generated/schemas.d.ts.map +1 -0
- package/dist/services/legacy/generated/types.d.ts +1454 -0
- package/dist/services/legacy/generated/types.d.ts.map +1 -0
- package/dist/services/legacy/index.d.ts +2 -0
- package/dist/services/legacy/index.d.ts.map +1 -0
- package/dist/services/logistics/client.d.ts +64 -0
- package/dist/services/logistics/client.d.ts.map +1 -0
- package/dist/services/logistics/generated/endpoints.d.ts +41 -0
- package/dist/services/logistics/generated/endpoints.d.ts.map +1 -0
- package/dist/services/logistics/generated/schemas.d.ts +375 -0
- package/dist/services/logistics/generated/schemas.d.ts.map +1 -0
- package/dist/services/logistics/generated/types.d.ts +925 -0
- package/dist/services/logistics/generated/types.d.ts.map +1 -0
- package/dist/services/logistics/index.d.ts +2 -0
- package/dist/services/logistics/index.d.ts.map +1 -0
- package/dist/services/markets/client.d.ts +47 -0
- package/dist/services/markets/client.d.ts.map +1 -0
- package/dist/services/markets/generated/endpoints.d.ts +41 -0
- package/dist/services/markets/generated/endpoints.d.ts.map +1 -0
- package/dist/services/markets/generated/schemas.d.ts +180 -0
- package/dist/services/markets/generated/schemas.d.ts.map +1 -0
- package/dist/services/markets/generated/types.d.ts +405 -0
- package/dist/services/markets/generated/types.d.ts.map +1 -0
- package/dist/services/markets/index.d.ts +2 -0
- package/dist/services/markets/index.d.ts.map +1 -0
- package/dist/services/notifications/client.d.ts +58 -0
- package/dist/services/notifications/client.d.ts.map +1 -0
- package/dist/services/notifications/generated/endpoints.d.ts +41 -0
- package/dist/services/notifications/generated/endpoints.d.ts.map +1 -0
- package/dist/services/notifications/generated/schemas.d.ts +247 -0
- package/dist/services/notifications/generated/schemas.d.ts.map +1 -0
- package/dist/services/notifications/generated/types.d.ts +666 -0
- package/dist/services/notifications/generated/types.d.ts.map +1 -0
- package/dist/services/notifications/index.d.ts +2 -0
- package/dist/services/notifications/index.d.ts.map +1 -0
- package/dist/services/open-search/client.d.ts +69 -0
- package/dist/services/open-search/client.d.ts.map +1 -0
- package/dist/services/open-search/generated/endpoints.d.ts +42 -0
- package/dist/services/open-search/generated/endpoints.d.ts.map +1 -0
- package/dist/services/open-search/generated/schemas.d.ts +363 -0
- package/dist/services/open-search/generated/schemas.d.ts.map +1 -0
- package/dist/services/open-search/generated/types.d.ts +983 -0
- package/dist/services/open-search/generated/types.d.ts.map +1 -0
- package/dist/services/open-search/index.d.ts +2 -0
- package/dist/services/open-search/index.d.ts.map +1 -0
- package/dist/services/orders/client.d.ts +180 -0
- package/dist/services/orders/client.d.ts.map +1 -0
- package/dist/services/orders/generated/endpoints.d.ts +42 -0
- package/dist/services/orders/generated/endpoints.d.ts.map +1 -0
- package/dist/services/orders/generated/schemas.d.ts +2479 -0
- package/dist/services/orders/generated/schemas.d.ts.map +1 -0
- package/dist/services/orders/generated/types.d.ts +4717 -0
- package/dist/services/orders/generated/types.d.ts.map +1 -0
- package/dist/services/orders/index.d.ts +2 -0
- package/dist/services/orders/index.d.ts.map +1 -0
- package/dist/services/p21-apis/client.d.ts +59 -0
- package/dist/services/p21-apis/client.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/endpoints.d.ts +41 -0
- package/dist/services/p21-apis/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/schemas.d.ts +46 -0
- package/dist/services/p21-apis/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/types.d.ts +246 -0
- package/dist/services/p21-apis/generated/types.d.ts.map +1 -0
- package/dist/services/p21-apis/index.d.ts +2 -0
- package/dist/services/p21-apis/index.d.ts.map +1 -0
- package/dist/services/p21-core/client.d.ts +131 -0
- package/dist/services/p21-core/client.d.ts.map +1 -0
- package/dist/services/p21-core/generated/endpoints.d.ts +42 -0
- package/dist/services/p21-core/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-core/generated/schemas.d.ts +1478 -0
- package/dist/services/p21-core/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-core/generated/types.d.ts +2718 -0
- package/dist/services/p21-core/generated/types.d.ts.map +1 -0
- package/dist/services/p21-core/index.d.ts +2 -0
- package/dist/services/p21-core/index.d.ts.map +1 -0
- package/dist/services/p21-pim/client.d.ts +75 -0
- package/dist/services/p21-pim/client.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/endpoints.d.ts +41 -0
- package/dist/services/p21-pim/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/schemas.d.ts +383 -0
- package/dist/services/p21-pim/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/types.d.ts +933 -0
- package/dist/services/p21-pim/generated/types.d.ts.map +1 -0
- package/dist/services/p21-pim/index.d.ts +2 -0
- package/dist/services/p21-pim/index.d.ts.map +1 -0
- package/dist/services/p21-sism/client.d.ts +432 -0
- package/dist/services/p21-sism/client.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/endpoints.d.ts +42 -0
- package/dist/services/p21-sism/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/schemas.d.ts +2844 -0
- package/dist/services/p21-sism/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/types.d.ts +6977 -0
- package/dist/services/p21-sism/generated/types.d.ts.map +1 -0
- package/dist/services/p21-sism/index.d.ts +37 -0
- package/dist/services/p21-sism/index.d.ts.map +1 -0
- package/dist/services/payments/client.d.ts +77 -0
- package/dist/services/payments/client.d.ts.map +1 -0
- package/dist/services/payments/generated/endpoints.d.ts +42 -0
- package/dist/services/payments/generated/endpoints.d.ts.map +1 -0
- package/dist/services/payments/generated/schemas.d.ts +1015 -0
- package/dist/services/payments/generated/schemas.d.ts.map +1 -0
- package/dist/services/payments/generated/types.d.ts +1432 -0
- package/dist/services/payments/generated/types.d.ts.map +1 -0
- package/dist/services/payments/index.d.ts +2 -0
- package/dist/services/payments/index.d.ts.map +1 -0
- package/dist/services/pricing/client.d.ts +216 -0
- package/dist/services/pricing/client.d.ts.map +1 -0
- package/dist/services/pricing/generated/endpoints.d.ts +42 -0
- package/dist/services/pricing/generated/endpoints.d.ts.map +1 -0
- package/dist/services/pricing/generated/schemas.d.ts +2048 -0
- package/dist/services/pricing/generated/schemas.d.ts.map +1 -0
- package/dist/services/pricing/generated/types.d.ts +4257 -0
- package/dist/services/pricing/generated/types.d.ts.map +1 -0
- package/dist/services/pricing/index.d.ts +2 -0
- package/dist/services/pricing/index.d.ts.map +1 -0
- package/dist/services/shipping/client.d.ts +33 -0
- package/dist/services/shipping/client.d.ts.map +1 -0
- package/dist/services/shipping/generated/endpoints.d.ts +41 -0
- package/dist/services/shipping/generated/endpoints.d.ts.map +1 -0
- package/dist/services/shipping/generated/schemas.d.ts +29 -0
- package/dist/services/shipping/generated/schemas.d.ts.map +1 -0
- package/dist/services/shipping/generated/types.d.ts +116 -0
- package/dist/services/shipping/generated/types.d.ts.map +1 -0
- package/dist/services/shipping/index.d.ts +2 -0
- package/dist/services/shipping/index.d.ts.map +1 -0
- package/dist/services/smarty-streets/client.d.ts +33 -0
- package/dist/services/smarty-streets/client.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/endpoints.d.ts +41 -0
- package/dist/services/smarty-streets/generated/endpoints.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/schemas.d.ts +72 -0
- package/dist/services/smarty-streets/generated/schemas.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/types.d.ts +145 -0
- package/dist/services/smarty-streets/generated/types.d.ts.map +1 -0
- package/dist/services/smarty-streets/index.d.ts +2 -0
- package/dist/services/smarty-streets/index.d.ts.map +1 -0
- package/dist/services/ups/client.d.ts +32 -0
- package/dist/services/ups/client.d.ts.map +1 -0
- package/dist/services/ups/generated/endpoints.d.ts +40 -0
- package/dist/services/ups/generated/endpoints.d.ts.map +1 -0
- package/dist/services/ups/generated/schemas.d.ts +51 -0
- package/dist/services/ups/generated/schemas.d.ts.map +1 -0
- package/dist/services/ups/generated/types.d.ts +98 -0
- package/dist/services/ups/generated/types.d.ts.map +1 -0
- package/dist/services/ups/index.d.ts +2 -0
- package/dist/services/ups/index.d.ts.map +1 -0
- package/dist/services/vendors/client.d.ts +38 -0
- package/dist/services/vendors/client.d.ts.map +1 -0
- package/dist/services/vendors/generated/endpoints.d.ts +41 -0
- package/dist/services/vendors/generated/endpoints.d.ts.map +1 -0
- package/dist/services/vendors/generated/schemas.d.ts +350 -0
- package/dist/services/vendors/generated/schemas.d.ts.map +1 -0
- package/dist/services/vendors/generated/types.d.ts +470 -0
- package/dist/services/vendors/generated/types.d.ts.map +1 -0
- package/dist/services/vendors/index.d.ts +2 -0
- package/dist/services/vendors/index.d.ts.map +1 -0
- package/dist/services/vmi/client.d.ts +129 -0
- package/dist/services/vmi/client.d.ts.map +1 -0
- package/dist/services/vmi/generated/endpoints.d.ts +41 -0
- package/dist/services/vmi/generated/endpoints.d.ts.map +1 -0
- package/dist/services/vmi/generated/schemas.d.ts +723 -0
- package/dist/services/vmi/generated/schemas.d.ts.map +1 -0
- package/dist/services/vmi/generated/types.d.ts +2620 -0
- package/dist/services/vmi/generated/types.d.ts.map +1 -0
- package/dist/services/vmi/index.d.ts +2 -0
- package/dist/services/vmi/index.d.ts.map +1 -0
- package/dist/testing.d.ts +9 -13
- package/dist/testing.d.ts.map +1 -0
- package/dist/testing.js +7 -17
- package/dist/testing.js.map +1 -1
- package/dist/testing.mjs +7 -17
- package/dist/testing.mjs.map +1 -1
- package/dist/utils/cross-site-auth.d.ts +88 -0
- package/dist/utils/cross-site-auth.d.ts.map +1 -0
- package/package.json +30 -47
- package/dist/client-TPJa269Y.d.mts +0 -58610
- package/dist/client-TPJa269Y.d.ts +0 -58610
- package/dist/index.d.mts +0 -236
- package/dist/testing.d.mts +0 -83
|
@@ -0,0 +1,2718 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated types for the p21-core service.
|
|
3
|
+
* Prophet 21 core reference data including companies, locations, users, payment types, and system
|
|
4
|
+
* settings
|
|
5
|
+
*
|
|
6
|
+
* Public specs (the source of truth for every shape below):
|
|
7
|
+
* https://p21-core.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://p21-core.augur-api.com/openapi.json: the full contract: request and response bodies
|
|
11
|
+
* field by field, descriptions, formats and documented errors.
|
|
12
|
+
* https://p21-core.augur-api.com/llms.txt: the plain-text endpoint list and the other Augur
|
|
13
|
+
* services.
|
|
14
|
+
*
|
|
15
|
+
* Source: shared/specs/p21-core.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 /address */
|
|
22
|
+
export interface AddressListParams extends EdgeCacheParams {
|
|
23
|
+
/** Carrier Flag [(Y)|N|Blank] */
|
|
24
|
+
carrierFlag?: string;
|
|
25
|
+
/** Shipping Method default Code (default_cd) [704|705|700|Blank] */
|
|
26
|
+
defaultCd?: number;
|
|
27
|
+
/** Shipping Method Enabled Code (enabled_cd) [704|705|700|Blank] */
|
|
28
|
+
enabledCd?: number;
|
|
29
|
+
/** Limit number of results (Default: 10) */
|
|
30
|
+
limit?: number;
|
|
31
|
+
/** Starting offset results (Default: 0) */
|
|
32
|
+
offset?: number;
|
|
33
|
+
/** Order By (Default: id|ASC) */
|
|
34
|
+
orderBy?: string;
|
|
35
|
+
/**
|
|
36
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
37
|
+
* (704,705); -1 for every status. Default: 704
|
|
38
|
+
*/
|
|
39
|
+
statusCd?: number | number[];
|
|
40
|
+
}
|
|
41
|
+
/** Params for GET /address/{id} */
|
|
42
|
+
export type AddressGetParams = EdgeCacheParams;
|
|
43
|
+
/** Params for GET /address/{id}/corp-address */
|
|
44
|
+
export interface AddressCorpAddressListParams extends EdgeCacheParams {
|
|
45
|
+
/** Limit number of results (Default: 10) */
|
|
46
|
+
limit?: number;
|
|
47
|
+
/** Starting offset results (Default: 0) */
|
|
48
|
+
offset?: number;
|
|
49
|
+
/** Order By (Default: id|ASC) */
|
|
50
|
+
orderBy?: string;
|
|
51
|
+
/** Search Query */
|
|
52
|
+
q?: string;
|
|
53
|
+
/**
|
|
54
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
55
|
+
* (704,705); -1 for every status. Default: every status
|
|
56
|
+
*/
|
|
57
|
+
statusCd?: number | number[];
|
|
58
|
+
}
|
|
59
|
+
/** Params for GET /address/{id}/default */
|
|
60
|
+
export type AddressDefaultListParams = EdgeCacheParams;
|
|
61
|
+
/** Params for GET /address/{id}/enable */
|
|
62
|
+
export interface AddressEnableGetParams extends EdgeCacheParams {
|
|
63
|
+
/** Shipping Method Enabled Code (enabled_cd) [(704)|705|Blank] */
|
|
64
|
+
enabledCd?: number;
|
|
65
|
+
}
|
|
66
|
+
/** Params for GET /branch */
|
|
67
|
+
export interface BranchListParams extends EdgeCacheParams {
|
|
68
|
+
/** Filter by branch_id (branch.branch_id) */
|
|
69
|
+
branchId?: string;
|
|
70
|
+
/** Filter by company_id (branch.company_id) */
|
|
71
|
+
companyId?: string;
|
|
72
|
+
/** Filter by company_uid (branch.company_uid) */
|
|
73
|
+
companyUid?: number;
|
|
74
|
+
/** P21 delete flag to filter by: Y or N (Default: every row) */
|
|
75
|
+
deleteFlag?: string;
|
|
76
|
+
/** Maximum rows to return (Default: 10) */
|
|
77
|
+
limit?: number;
|
|
78
|
+
/** Starting offset results (Default: 0) */
|
|
79
|
+
offset?: number;
|
|
80
|
+
/** Order By (Default: branch_uid|ASC) */
|
|
81
|
+
orderBy?: string;
|
|
82
|
+
}
|
|
83
|
+
/** Params for GET /branch/{branchUid} */
|
|
84
|
+
export type BranchGetParams = EdgeCacheParams;
|
|
85
|
+
/** Params for GET /cash-drawer */
|
|
86
|
+
export interface CashDrawerListParams extends EdgeCacheParams {
|
|
87
|
+
/** Only cash drawers for this Prophet 21 company */
|
|
88
|
+
companyId?: string;
|
|
89
|
+
/** Filter by drawer open status (Y or N) */
|
|
90
|
+
drawerOpen?: string;
|
|
91
|
+
/** Limit number of results (Default: 10) */
|
|
92
|
+
limit?: number;
|
|
93
|
+
/** Starting offset results (Default: 0) */
|
|
94
|
+
offset?: number;
|
|
95
|
+
/** Order By (Default: cash_drawer_uid|ASC) */
|
|
96
|
+
orderBy?: string;
|
|
97
|
+
/** Search Query */
|
|
98
|
+
q?: string;
|
|
99
|
+
/**
|
|
100
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
101
|
+
* (704,705); -1 for every status. Default: 704
|
|
102
|
+
*/
|
|
103
|
+
statusCd?: number | number[];
|
|
104
|
+
}
|
|
105
|
+
/** Params for GET /cash-drawer/{cashDrawerUid} */
|
|
106
|
+
export type CashDrawerGetParams = EdgeCacheParams;
|
|
107
|
+
/** Params for GET /cc-processor-x-location */
|
|
108
|
+
export interface CcProcessorXLocationListParams extends EdgeCacheParams {
|
|
109
|
+
/** Filter by company_id (cc_processor_x_location.company_id) */
|
|
110
|
+
companyId?: string;
|
|
111
|
+
/** Filter by creditcard_processor_uid (cc_processor_x_location.creditcard_processor_uid) */
|
|
112
|
+
creditcardProcessorUid?: number;
|
|
113
|
+
/** P21 delete flag to filter by: Y or N (Default: every row) */
|
|
114
|
+
deleteFlag?: string;
|
|
115
|
+
/** Maximum rows to return (Default: 10) */
|
|
116
|
+
limit?: number;
|
|
117
|
+
/** Filter by location_id (cc_processor_x_location.location_id) */
|
|
118
|
+
locationId?: string;
|
|
119
|
+
/** Starting offset results (Default: 0) */
|
|
120
|
+
offset?: number;
|
|
121
|
+
/** Order By (Default: cc_processor_x_location_uid|ASC) */
|
|
122
|
+
orderBy?: string;
|
|
123
|
+
/** Filter by processor_x_location_uid (cc_processor_x_location.processor_x_location_uid) */
|
|
124
|
+
processorXLocationUid?: number;
|
|
125
|
+
/**
|
|
126
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
127
|
+
* (704,705); -1 for every status. Default: 704
|
|
128
|
+
*/
|
|
129
|
+
statusCd?: number | number[];
|
|
130
|
+
}
|
|
131
|
+
/** Params for GET /cc-processor-x-location/{ccProcessorXLocationUid} */
|
|
132
|
+
export type CcProcessorXLocationGetParams = EdgeCacheParams;
|
|
133
|
+
/** Params for GET /cc-tables */
|
|
134
|
+
export interface CcTablesListParams extends EdgeCacheParams {
|
|
135
|
+
/** Maximum rows to return (Default: 10) */
|
|
136
|
+
limit?: number;
|
|
137
|
+
/** Starting offset results (Default: 0) */
|
|
138
|
+
offset?: number;
|
|
139
|
+
/** Order By (Default: table_uid|ASC) */
|
|
140
|
+
orderBy?: string;
|
|
141
|
+
}
|
|
142
|
+
/** Params for GET /cc-tables/{tableUid} */
|
|
143
|
+
export type CcTablesGetParams = EdgeCacheParams;
|
|
144
|
+
/** Params for GET /code-p21 */
|
|
145
|
+
export interface CodeP21ListParams extends EdgeCacheParams {
|
|
146
|
+
/** CSV is code_nos to limit results */
|
|
147
|
+
codeNoList?: string;
|
|
148
|
+
/** Limit number of results (Default: 10) */
|
|
149
|
+
limit?: number;
|
|
150
|
+
/** Starting offset results (Default: 0) */
|
|
151
|
+
offset?: number;
|
|
152
|
+
/** Order By (Default: code_uid|ASC) */
|
|
153
|
+
orderBy?: string;
|
|
154
|
+
/** search query */
|
|
155
|
+
q?: string;
|
|
156
|
+
}
|
|
157
|
+
/** Params for GET /code-p21/{codeUid} */
|
|
158
|
+
export type CodeP21GetParams = EdgeCacheParams;
|
|
159
|
+
/** Params for GET /company */
|
|
160
|
+
export interface CompanyListParams extends EdgeCacheParams {
|
|
161
|
+
/** Only this Prophet 21 company */
|
|
162
|
+
companyId?: string;
|
|
163
|
+
/** Limit number of results (Default: 10) */
|
|
164
|
+
limit?: number;
|
|
165
|
+
/** Starting offset results (Default: 0) */
|
|
166
|
+
offset?: number;
|
|
167
|
+
/** Order By (Default: company_uid|ASC) */
|
|
168
|
+
orderBy?: string;
|
|
169
|
+
/** Search Query */
|
|
170
|
+
q?: string;
|
|
171
|
+
}
|
|
172
|
+
/** Params for GET /company/{companyId} */
|
|
173
|
+
export type CompanyGetParams = EdgeCacheParams;
|
|
174
|
+
/** Params for GET /counter */
|
|
175
|
+
export interface CounterListParams extends EdgeCacheParams {
|
|
176
|
+
/** Maximum rows to return (Default: 10) */
|
|
177
|
+
limit?: number;
|
|
178
|
+
/** Starting offset results (Default: 0) */
|
|
179
|
+
offset?: number;
|
|
180
|
+
/** Order By (Default: id|ASC) */
|
|
181
|
+
orderBy?: string;
|
|
182
|
+
}
|
|
183
|
+
/** Params for GET /counter/{id} */
|
|
184
|
+
export type CounterGetParams = EdgeCacheParams;
|
|
185
|
+
/** Params for GET /creditcard-processor */
|
|
186
|
+
export interface CreditcardProcessorListParams extends EdgeCacheParams {
|
|
187
|
+
/** Maximum rows to return (Default: 10) */
|
|
188
|
+
limit?: number;
|
|
189
|
+
/** Starting offset results (Default: 0) */
|
|
190
|
+
offset?: number;
|
|
191
|
+
/** Order By (Default: creditcard_processor_uid|ASC) */
|
|
192
|
+
orderBy?: string;
|
|
193
|
+
}
|
|
194
|
+
/** Params for GET /creditcard-processor/{creditcardProcessorUid} */
|
|
195
|
+
export type CreditcardProcessorGetParams = EdgeCacheParams;
|
|
196
|
+
/** Params for GET /freight-code */
|
|
197
|
+
export interface FreightCodeListParams extends EdgeCacheParams {
|
|
198
|
+
/** Filter by company ID */
|
|
199
|
+
companyId?: string;
|
|
200
|
+
/** Filter by freight code (freight_cd) */
|
|
201
|
+
freightCodeId?: string;
|
|
202
|
+
/** Limit number of results (Default: 10) */
|
|
203
|
+
limit?: number;
|
|
204
|
+
/** Starting offset results (Default: 0) */
|
|
205
|
+
offset?: number;
|
|
206
|
+
/** Order by column, optionally with |DESC (Default: freight_code_uid|ASC) */
|
|
207
|
+
orderBy?: string;
|
|
208
|
+
/** Filter by status code */
|
|
209
|
+
statusCd?: number;
|
|
210
|
+
}
|
|
211
|
+
/** Params for GET /freight-code/{freightCodeUid} */
|
|
212
|
+
export interface FreightCodeGetParams extends EdgeCacheParams {
|
|
213
|
+
/** freightCodeId (freight_cd). Used for lookup if freightCodeUid is zero */
|
|
214
|
+
freightCodeId?: string;
|
|
215
|
+
}
|
|
216
|
+
/** Params for GET /language */
|
|
217
|
+
export interface LanguageListParams extends EdgeCacheParams {
|
|
218
|
+
/** P21 delete flag to filter by: Y or N (Default: every row) */
|
|
219
|
+
deleteFlag?: string;
|
|
220
|
+
/** Maximum rows to return (Default: 10) */
|
|
221
|
+
limit?: number;
|
|
222
|
+
/** Starting offset results (Default: 0) */
|
|
223
|
+
offset?: number;
|
|
224
|
+
/** Order By (Default: language_uid|ASC) */
|
|
225
|
+
orderBy?: string;
|
|
226
|
+
}
|
|
227
|
+
/** Params for GET /language/{languageUid} */
|
|
228
|
+
export type LanguageGetParams = EdgeCacheParams;
|
|
229
|
+
/** Params for GET /location */
|
|
230
|
+
export interface LocationListParams extends EdgeCacheParams {
|
|
231
|
+
/** Y for deleted locations, N for live ones */
|
|
232
|
+
deleteFlag?: string;
|
|
233
|
+
/** Y adds each location's address as an address key */
|
|
234
|
+
includeAddress?: string;
|
|
235
|
+
/** Limit number of results (Default: 10) */
|
|
236
|
+
limit?: number;
|
|
237
|
+
/** Starting offset results (Default: 0) */
|
|
238
|
+
offset?: number;
|
|
239
|
+
/** Order By (Default: location_id|ASC) */
|
|
240
|
+
orderBy?: string;
|
|
241
|
+
/** Search Query */
|
|
242
|
+
q?: string;
|
|
243
|
+
}
|
|
244
|
+
/** Params for GET /location/{locationId} */
|
|
245
|
+
export interface LocationGetParams extends EdgeCacheParams {
|
|
246
|
+
/** Y adds the location's address as an address key */
|
|
247
|
+
includeAddress?: string;
|
|
248
|
+
}
|
|
249
|
+
/** Params for GET /note */
|
|
250
|
+
export interface NoteListParams extends EdgeCacheParams {
|
|
251
|
+
/** Filter by document_uid (note.document_uid) */
|
|
252
|
+
documentUid?: number;
|
|
253
|
+
/** Maximum rows to return (Default: 10) */
|
|
254
|
+
limit?: number;
|
|
255
|
+
/** Starting offset results (Default: 0) */
|
|
256
|
+
offset?: number;
|
|
257
|
+
/** Order By (Default: note_uid|ASC) */
|
|
258
|
+
orderBy?: string;
|
|
259
|
+
/**
|
|
260
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
261
|
+
* (704,705); -1 for every status. Default: 704
|
|
262
|
+
*/
|
|
263
|
+
rowStatusFlag?: number | number[];
|
|
264
|
+
}
|
|
265
|
+
/** Params for GET /note/{noteUid} */
|
|
266
|
+
export type NoteGetParams = EdgeCacheParams;
|
|
267
|
+
/** Params for GET /payment-types */
|
|
268
|
+
export interface PaymentTypesListParams extends EdgeCacheParams {
|
|
269
|
+
/** Limit number of results (Default: 10) */
|
|
270
|
+
limit?: number;
|
|
271
|
+
/** Starting offset results (Default: 0) */
|
|
272
|
+
offset?: number;
|
|
273
|
+
/** Order By (Default: payment_type_id|ASC) */
|
|
274
|
+
orderBy?: string;
|
|
275
|
+
}
|
|
276
|
+
/** Params for GET /payment-types/{paymentTypeId} */
|
|
277
|
+
export type PaymentTypesGetParams = EdgeCacheParams;
|
|
278
|
+
/** Params for GET /restricted-class */
|
|
279
|
+
export interface RestrictedClassListParams extends EdgeCacheParams {
|
|
280
|
+
/** Filter by dealer_type_uid (restricted_class.dealer_type_uid) */
|
|
281
|
+
dealerTypeUid?: number;
|
|
282
|
+
/** Maximum rows to return (Default: 10) */
|
|
283
|
+
limit?: number;
|
|
284
|
+
/** Starting offset results (Default: 0) */
|
|
285
|
+
offset?: number;
|
|
286
|
+
/** Order By (Default: restricted_class_uid|ASC) */
|
|
287
|
+
orderBy?: string;
|
|
288
|
+
/** Filter by parent_class_uid (restricted_class.parent_class_uid) */
|
|
289
|
+
parentClassUid?: number;
|
|
290
|
+
/**
|
|
291
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
292
|
+
* (704,705); -1 for every status. Default: 704
|
|
293
|
+
*/
|
|
294
|
+
rowStatusFlag?: number | number[];
|
|
295
|
+
}
|
|
296
|
+
/** Params for GET /restricted-class/{restrictedClassUid} */
|
|
297
|
+
export type RestrictedClassGetParams = EdgeCacheParams;
|
|
298
|
+
/** Params for GET /state */
|
|
299
|
+
export interface StateListParams extends EdgeCacheParams {
|
|
300
|
+
/** Filter by country_uid (state.country_uid) */
|
|
301
|
+
countryUid?: number;
|
|
302
|
+
/** Maximum rows to return (Default: 10) */
|
|
303
|
+
limit?: number;
|
|
304
|
+
/** Starting offset results (Default: 0) */
|
|
305
|
+
offset?: number;
|
|
306
|
+
/** Order By (Default: state_uid|ASC) */
|
|
307
|
+
orderBy?: string;
|
|
308
|
+
}
|
|
309
|
+
/** Params for GET /state/{stateUid} */
|
|
310
|
+
export type StateGetParams = EdgeCacheParams;
|
|
311
|
+
/** Params for GET /system-setting */
|
|
312
|
+
export interface SystemSettingListParams extends EdgeCacheParams {
|
|
313
|
+
/** Maximum rows to return (Default: 10) */
|
|
314
|
+
limit?: number;
|
|
315
|
+
/** Starting offset results (Default: 0) */
|
|
316
|
+
offset?: number;
|
|
317
|
+
/** Order By (Default: system_setting_uid|ASC) */
|
|
318
|
+
orderBy?: string;
|
|
319
|
+
}
|
|
320
|
+
/** Params for GET /system-setting/{systemSettingUid} */
|
|
321
|
+
export type SystemSettingGetParams = EdgeCacheParams;
|
|
322
|
+
/** Params for GET /term-x-language */
|
|
323
|
+
export interface TermXLanguageListParams extends EdgeCacheParams {
|
|
324
|
+
/** Maximum rows to return (Default: 10) */
|
|
325
|
+
limit?: number;
|
|
326
|
+
/** Starting offset results (Default: 0) */
|
|
327
|
+
offset?: number;
|
|
328
|
+
/** Order By (Default: term_x_language_uid|ASC) */
|
|
329
|
+
orderBy?: string;
|
|
330
|
+
/**
|
|
331
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
332
|
+
* (704,705); -1 for every status. Default: 704
|
|
333
|
+
*/
|
|
334
|
+
rowStatusFlag?: number | number[];
|
|
335
|
+
/** Filter by translation_term_uid (term_x_language.translation_term_uid) */
|
|
336
|
+
translationTermUid?: number;
|
|
337
|
+
}
|
|
338
|
+
/** Params for GET /term-x-language/{termXLanguageUid} */
|
|
339
|
+
export type TermXLanguageGetParams = EdgeCacheParams;
|
|
340
|
+
/** Params for GET /terms */
|
|
341
|
+
export interface TermsListParams extends EdgeCacheParams {
|
|
342
|
+
/** P21 delete flag to filter by: Y or N (Default: every row) */
|
|
343
|
+
deleteFlag?: string;
|
|
344
|
+
/** Filter by discount_inv_mast_uid (terms.discount_inv_mast_uid) */
|
|
345
|
+
discountInvMastUid?: number;
|
|
346
|
+
/** Maximum rows to return (Default: 10) */
|
|
347
|
+
limit?: number;
|
|
348
|
+
/** Starting offset results (Default: 0) */
|
|
349
|
+
offset?: number;
|
|
350
|
+
/** Order By (Default: terms_id|ASC) */
|
|
351
|
+
orderBy?: string;
|
|
352
|
+
}
|
|
353
|
+
/** Params for GET /terms/{termsId} */
|
|
354
|
+
export type TermsGetParams = EdgeCacheParams;
|
|
355
|
+
/** Params for GET /user-defined-column */
|
|
356
|
+
export interface UserDefinedColumnListParams extends EdgeCacheParams {
|
|
357
|
+
/** Maximum rows to return (Default: 10) */
|
|
358
|
+
limit?: number;
|
|
359
|
+
/** Starting offset results (Default: 0) */
|
|
360
|
+
offset?: number;
|
|
361
|
+
/** Order By (Default: user_defined_column_uid|ASC) */
|
|
362
|
+
orderBy?: string;
|
|
363
|
+
}
|
|
364
|
+
/** Params for GET /user-defined-column/{userDefinedColumnUid} */
|
|
365
|
+
export type UserDefinedColumnGetParams = EdgeCacheParams;
|
|
366
|
+
/** Params for GET /users */
|
|
367
|
+
export interface UsersListParams extends EdgeCacheParams {
|
|
368
|
+
/** Filter by contact_id (users.contact_id) */
|
|
369
|
+
contactId?: string;
|
|
370
|
+
/** Filter by customer_profit_role_uid (users.customer_profit_role_uid) */
|
|
371
|
+
customerProfitRoleUid?: number;
|
|
372
|
+
/** P21 delete flag to filter by: Y or N (Default: every row) */
|
|
373
|
+
deleteFlag?: string;
|
|
374
|
+
/** Filter by inv_group_hdr_uid (users.inv_group_hdr_uid) */
|
|
375
|
+
invGroupHdrUid?: number;
|
|
376
|
+
/** Maximum rows to return (Default: 10) */
|
|
377
|
+
limit?: number;
|
|
378
|
+
/** Starting offset results (Default: 0) */
|
|
379
|
+
offset?: number;
|
|
380
|
+
/** Order By (Default: id|ASC) */
|
|
381
|
+
orderBy?: string;
|
|
382
|
+
/** Filter by role_uid (users.role_uid) */
|
|
383
|
+
roleUid?: number;
|
|
384
|
+
/** Filter by strategic_pricing_role_uid (users.strategic_pricing_role_uid) */
|
|
385
|
+
strategicPricingRoleUid?: number;
|
|
386
|
+
}
|
|
387
|
+
/** Params for GET /users/{id} */
|
|
388
|
+
export type UsersGetParams = EdgeCacheParams;
|
|
389
|
+
/**
|
|
390
|
+
* List Addresses
|
|
391
|
+
* Response data for GET /address — MINIMUM fields, extras pass through
|
|
392
|
+
*
|
|
393
|
+
* Returned by: api.p21Core.address.list(params) (array items)
|
|
394
|
+
* Returned by: api.p21Core.address.get(id)
|
|
395
|
+
* Returned by: api.p21Core.address.corpAddress.list(id, params) (array items)
|
|
396
|
+
* Returned by: api.p21Core.address.default.list(id)
|
|
397
|
+
* Returned by: api.p21Core.address.enable.get(id, params)
|
|
398
|
+
* Field `address` of LocationListItem
|
|
399
|
+
*/
|
|
400
|
+
export interface AddressListItem {
|
|
401
|
+
/** Prophet 21 address ID */
|
|
402
|
+
id: number;
|
|
403
|
+
/** Address name (max 50 chars) */
|
|
404
|
+
name: string;
|
|
405
|
+
/** Mailing address line 1 (max 50 chars) */
|
|
406
|
+
mailAddress1: string | null;
|
|
407
|
+
/** Mailing address line 2 (max 50 chars) */
|
|
408
|
+
mailAddress2: string | null;
|
|
409
|
+
/** Mailing city (max 50 chars) */
|
|
410
|
+
mailCity: string | null;
|
|
411
|
+
/** Mailing state or province (max 50 chars) */
|
|
412
|
+
mailState: string | null;
|
|
413
|
+
/** Mailing postal code (max 10 chars) */
|
|
414
|
+
mailPostalCode: string | null;
|
|
415
|
+
/** Mailing country (max 50 chars) */
|
|
416
|
+
mailCountry: string | null;
|
|
417
|
+
/** Physical address line 1 (max 50 chars) */
|
|
418
|
+
physAddress1: string | null;
|
|
419
|
+
/** Physical address line 2 (max 50 chars) */
|
|
420
|
+
physAddress2: string | null;
|
|
421
|
+
/** Physical city (max 50 chars) */
|
|
422
|
+
physCity: string | null;
|
|
423
|
+
/** Physical state or province (max 50 chars) */
|
|
424
|
+
physState: string | null;
|
|
425
|
+
/** Physical postal code (max 10 chars) */
|
|
426
|
+
physPostalCode: string | null;
|
|
427
|
+
/** Physical country (max 50 chars) */
|
|
428
|
+
physCountry: string | null;
|
|
429
|
+
/** Y when the address is a carrier (max 1 chars) */
|
|
430
|
+
carrierFlag: string | null;
|
|
431
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
432
|
+
statusCd: number;
|
|
433
|
+
/** Process code */
|
|
434
|
+
processCd: number;
|
|
435
|
+
/** 704 when the address is enabled for the site, 705 when not */
|
|
436
|
+
enabledCd: number;
|
|
437
|
+
/** 704 for the site's default address, 705 otherwise */
|
|
438
|
+
defaultCd: number;
|
|
439
|
+
[key: string]: unknown;
|
|
440
|
+
}
|
|
441
|
+
/** Returned by: api.p21Core.address.list(params) */
|
|
442
|
+
export type AddressListData = AddressListItem[];
|
|
443
|
+
/**
|
|
444
|
+
* Get Address Details
|
|
445
|
+
* Response data for GET /address/{id} — MINIMUM fields, extras pass through
|
|
446
|
+
*
|
|
447
|
+
* Returned by: api.p21Core.address.get(id)
|
|
448
|
+
*/
|
|
449
|
+
export type AddressGetData = AddressListItem;
|
|
450
|
+
/**
|
|
451
|
+
* Get Corporate Address List
|
|
452
|
+
* Response data for GET /address/{id}/corp-address — MINIMUM fields, extras pass through
|
|
453
|
+
*
|
|
454
|
+
* Returned by: api.p21Core.address.corpAddress.list(id, params) (array items)
|
|
455
|
+
*/
|
|
456
|
+
export type AddressCorpAddressListItem = AddressListItem;
|
|
457
|
+
/** Returned by: api.p21Core.address.corpAddress.list(id, params) */
|
|
458
|
+
export type AddressCorpAddressListData = AddressCorpAddressListItem[];
|
|
459
|
+
/**
|
|
460
|
+
* Set Address as default Shipping Method
|
|
461
|
+
* Response data for GET /address/{id}/default — MINIMUM fields, extras pass through
|
|
462
|
+
*
|
|
463
|
+
* Returned by: api.p21Core.address.default.list(id)
|
|
464
|
+
*/
|
|
465
|
+
export type AddressDefaultListData = AddressListItem;
|
|
466
|
+
/**
|
|
467
|
+
* Enable/disable Address as Shipping Method
|
|
468
|
+
* Response data for GET /address/{id}/enable — MINIMUM fields, extras pass through
|
|
469
|
+
*
|
|
470
|
+
* Returned by: api.p21Core.address.enable.get(id, params)
|
|
471
|
+
*/
|
|
472
|
+
export type AddressEnableGetData = AddressListItem;
|
|
473
|
+
/**
|
|
474
|
+
* List Branch Rows
|
|
475
|
+
* Response data for GET /branch — MINIMUM fields, extras pass through
|
|
476
|
+
*
|
|
477
|
+
* Returned by: api.p21Core.branch.list(params) (array items)
|
|
478
|
+
* Returned by: api.p21Core.branch.get(branchUid)
|
|
479
|
+
*/
|
|
480
|
+
export interface BranchListItem {
|
|
481
|
+
/** P21 company ID (max 8 chars) */
|
|
482
|
+
companyId: string;
|
|
483
|
+
/** P21 branch ID (max 8 chars) */
|
|
484
|
+
branchId: string;
|
|
485
|
+
/** Branch description (max 40 chars) */
|
|
486
|
+
branchDescription: string;
|
|
487
|
+
/** Y when P21 marks the row deleted (max 1 chars) */
|
|
488
|
+
deleteFlag: string;
|
|
489
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
490
|
+
dateCreated: string;
|
|
491
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
492
|
+
dateLastModified: string;
|
|
493
|
+
/** P21 branch UID (unique row ID) */
|
|
494
|
+
branchUid: number;
|
|
495
|
+
/** P21 company UID (company.company_uid) */
|
|
496
|
+
companyUid: number;
|
|
497
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
498
|
+
updateCd: number;
|
|
499
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
500
|
+
processCd: number;
|
|
501
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
502
|
+
statusCd: number;
|
|
503
|
+
[key: string]: unknown;
|
|
504
|
+
}
|
|
505
|
+
/** Returned by: api.p21Core.branch.list(params) */
|
|
506
|
+
export type BranchListData = BranchListItem[];
|
|
507
|
+
/**
|
|
508
|
+
* Get Branch
|
|
509
|
+
* Response data for GET /branch/{branchUid} — MINIMUM fields, extras pass through
|
|
510
|
+
*
|
|
511
|
+
* Returned by: api.p21Core.branch.get(branchUid)
|
|
512
|
+
*/
|
|
513
|
+
export type BranchGetData = BranchListItem;
|
|
514
|
+
/**
|
|
515
|
+
* List Cash Drawers
|
|
516
|
+
* Response data for GET /cash-drawer — MINIMUM fields, extras pass through
|
|
517
|
+
*
|
|
518
|
+
* Returned by: api.p21Core.cashDrawer.list(params) (array items)
|
|
519
|
+
* Returned by: api.p21Core.cashDrawer.get(cashDrawerUid)
|
|
520
|
+
*/
|
|
521
|
+
export interface CashDrawerListItem {
|
|
522
|
+
/** Prophet 21 cash drawer code (max 8 chars) */
|
|
523
|
+
cashDrawerId: string;
|
|
524
|
+
/** Prophet 21 company the cash drawer belongs to (max 8 chars) */
|
|
525
|
+
companyId: string;
|
|
526
|
+
/** Cash drawer name (max 30 chars) */
|
|
527
|
+
cashDrawerDescription: string;
|
|
528
|
+
/** Current sequence number of the drawer */
|
|
529
|
+
currentSequenceNo: number;
|
|
530
|
+
/** Balance when the drawer was opened */
|
|
531
|
+
openingBalance: number | null;
|
|
532
|
+
/** Total withdrawals from the drawer */
|
|
533
|
+
withdrawals: number | null;
|
|
534
|
+
/** Total deposits into the drawer */
|
|
535
|
+
deposits: number | null;
|
|
536
|
+
/** Current drawer balance */
|
|
537
|
+
currentBalance: number;
|
|
538
|
+
/** Y when the drawer is open (max 1 chars) */
|
|
539
|
+
drawerOpen: string;
|
|
540
|
+
/** Prophet 21 bank number for the drawer */
|
|
541
|
+
bankNo: number | null;
|
|
542
|
+
/** General ledger account for cash on hand (max 32 chars) */
|
|
543
|
+
cashOnHandAccountNumber: string;
|
|
544
|
+
/** Y when the cash drawer is deleted in Prophet 21 (max 1 chars) */
|
|
545
|
+
deleteFlag: string;
|
|
546
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
547
|
+
dateCreated: string;
|
|
548
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
549
|
+
dateLastModified: string;
|
|
550
|
+
/** Prophet 21 user who last changed the record (max 30 chars) */
|
|
551
|
+
lastMaintainedBy: string;
|
|
552
|
+
/** Cash card load amount */
|
|
553
|
+
cashCardLoad: number | null;
|
|
554
|
+
/** Unique Prophet 21 ID of the cash drawer */
|
|
555
|
+
cashDrawerUid: number;
|
|
556
|
+
/** Location ID used for branch conflicts */
|
|
557
|
+
locIdForBranchConflict: number | null;
|
|
558
|
+
/** Default branch used when closing the drawer (max 8 chars) */
|
|
559
|
+
defaultCloseBranchId: string | null;
|
|
560
|
+
/** Update code (704 = queued for refresh from Prophet 21, 1185 = current) */
|
|
561
|
+
updateCd: number;
|
|
562
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
563
|
+
statusCd: number;
|
|
564
|
+
/** Process code */
|
|
565
|
+
processCd: number;
|
|
566
|
+
[key: string]: unknown;
|
|
567
|
+
}
|
|
568
|
+
/** Returned by: api.p21Core.cashDrawer.list(params) */
|
|
569
|
+
export type CashDrawerListData = CashDrawerListItem[];
|
|
570
|
+
/**
|
|
571
|
+
* Get Cash Drawer Details
|
|
572
|
+
* Response data for GET /cash-drawer/{cashDrawerUid} — MINIMUM fields, extras pass through
|
|
573
|
+
*
|
|
574
|
+
* Returned by: api.p21Core.cashDrawer.get(cashDrawerUid)
|
|
575
|
+
*/
|
|
576
|
+
export type CashDrawerGetData = CashDrawerListItem;
|
|
577
|
+
/**
|
|
578
|
+
* List Cc Processor X Location Rows
|
|
579
|
+
* Response data for GET /cc-processor-x-location — MINIMUM fields, extras pass through
|
|
580
|
+
*
|
|
581
|
+
* Returned by: api.p21Core.ccProcessorXLocation.list(params) (array items)
|
|
582
|
+
* Returned by: api.p21Core.ccProcessorXLocation.get(ccProcessorXLocationUid)
|
|
583
|
+
*/
|
|
584
|
+
export interface CcProcessorXLocationListItem {
|
|
585
|
+
/** P21 processor_x_location_uid on the cc processor x location */
|
|
586
|
+
processorXLocationUid: number;
|
|
587
|
+
/** P21 company ID (max 8 chars) */
|
|
588
|
+
companyId: string;
|
|
589
|
+
/** P21 location ID (max 255 chars) */
|
|
590
|
+
locationId: string;
|
|
591
|
+
/** P21 credit card processor UID (creditcard_processor.creditcard_processor_uid) */
|
|
592
|
+
creditcardProcessorUid: number;
|
|
593
|
+
/** P21 payment type ID */
|
|
594
|
+
paymentTypeId: number;
|
|
595
|
+
/** P21 order_source_type_cd on the cc processor x location */
|
|
596
|
+
orderSourceTypeCd: number;
|
|
597
|
+
/** P21 processor_used_in_area on the cc processor x location */
|
|
598
|
+
processorUsedInArea: number;
|
|
599
|
+
/** Y when P21 marks the row deleted (max 1 chars) */
|
|
600
|
+
deleteFlag: string;
|
|
601
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
602
|
+
dateCreated: string;
|
|
603
|
+
/** P21 user who created the row (max 255 chars) */
|
|
604
|
+
createdBy: string;
|
|
605
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
606
|
+
dateLastModified: string;
|
|
607
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
608
|
+
lastMaintainedBy: string;
|
|
609
|
+
/** P21 cc processor x location UID (unique row ID) */
|
|
610
|
+
ccProcessorXLocationUid: number;
|
|
611
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
612
|
+
updateCd: number;
|
|
613
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
614
|
+
statusCd: number;
|
|
615
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
616
|
+
processCd: number;
|
|
617
|
+
[key: string]: unknown;
|
|
618
|
+
}
|
|
619
|
+
/** Returned by: api.p21Core.ccProcessorXLocation.list(params) */
|
|
620
|
+
export type CcProcessorXLocationListData = CcProcessorXLocationListItem[];
|
|
621
|
+
/**
|
|
622
|
+
* Get Cc Processor X Location
|
|
623
|
+
* Response data for GET /cc-processor-x-location/{ccProcessorXLocationUid} — MINIMUM fields, extras
|
|
624
|
+
* pass through
|
|
625
|
+
*
|
|
626
|
+
* Returned by: api.p21Core.ccProcessorXLocation.get(ccProcessorXLocationUid)
|
|
627
|
+
*/
|
|
628
|
+
export type CcProcessorXLocationGetData = CcProcessorXLocationListItem;
|
|
629
|
+
/**
|
|
630
|
+
* List Cc Tables Rows
|
|
631
|
+
* Response data for GET /cc-tables — MINIMUM fields, extras pass through
|
|
632
|
+
*
|
|
633
|
+
* Returned by: api.p21Core.ccTables.list(params) (array items)
|
|
634
|
+
* Returned by: api.p21Core.ccTables.get(tableUid)
|
|
635
|
+
*/
|
|
636
|
+
export interface CcTablesListItem {
|
|
637
|
+
/** P21 table_uid on the cc tables */
|
|
638
|
+
tableUid: number;
|
|
639
|
+
/** P21 table name (max 255 chars) */
|
|
640
|
+
tableName: string;
|
|
641
|
+
/** Table description (max 255 chars) */
|
|
642
|
+
tableDescription: string | null;
|
|
643
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
644
|
+
updateCd: number;
|
|
645
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
646
|
+
processCd: number;
|
|
647
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
648
|
+
statusCd: number;
|
|
649
|
+
[key: string]: unknown;
|
|
650
|
+
}
|
|
651
|
+
/** Returned by: api.p21Core.ccTables.list(params) */
|
|
652
|
+
export type CcTablesListData = CcTablesListItem[];
|
|
653
|
+
/**
|
|
654
|
+
* Get Cc Tables
|
|
655
|
+
* Response data for GET /cc-tables/{tableUid} — MINIMUM fields, extras pass through
|
|
656
|
+
*
|
|
657
|
+
* Returned by: api.p21Core.ccTables.get(tableUid)
|
|
658
|
+
*/
|
|
659
|
+
export type CcTablesGetData = CcTablesListItem;
|
|
660
|
+
/**
|
|
661
|
+
* List P21 Codes
|
|
662
|
+
* Response data for GET /code-p21 — MINIMUM fields, extras pass through
|
|
663
|
+
*
|
|
664
|
+
* Returned by: api.p21Core.codeP21.list(params) (array items)
|
|
665
|
+
* Returned by: api.p21Core.codeP21.get(codeUid)
|
|
666
|
+
*/
|
|
667
|
+
export interface CodeP21ListItem {
|
|
668
|
+
/** Unique Prophet 21 ID of the code record */
|
|
669
|
+
codeUid: number;
|
|
670
|
+
/** Numeric code value (e.g. 704) */
|
|
671
|
+
codeNo: number;
|
|
672
|
+
/** Language of the code description (max 8 chars) */
|
|
673
|
+
languageId: string;
|
|
674
|
+
/** Name of the code (e.g. Active) (max 255 chars) */
|
|
675
|
+
codeDescription: string;
|
|
676
|
+
/** Prophet 21 row status flag (max 1 chars) */
|
|
677
|
+
rowStatusFlag: string;
|
|
678
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
679
|
+
dateCreated: string;
|
|
680
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
681
|
+
dateLastModified: string;
|
|
682
|
+
/** Prophet 21 user who last changed the record (max 30 chars) */
|
|
683
|
+
lastMaintainedBy: string;
|
|
684
|
+
/** Secondary description of the code (max 255 chars) */
|
|
685
|
+
codeSubDescription: string | null;
|
|
686
|
+
/** Update code (704 = queued for refresh from Prophet 21, 1185 = current) */
|
|
687
|
+
updateCd: number;
|
|
688
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
689
|
+
processCd: number;
|
|
690
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
691
|
+
statusCd: number;
|
|
692
|
+
[key: string]: unknown;
|
|
693
|
+
}
|
|
694
|
+
/** Returned by: api.p21Core.codeP21.list(params) */
|
|
695
|
+
export type CodeP21ListData = CodeP21ListItem[];
|
|
696
|
+
/**
|
|
697
|
+
* Get P21 Code Details
|
|
698
|
+
* Response data for GET /code-p21/{codeUid} — MINIMUM fields, extras pass through
|
|
699
|
+
*
|
|
700
|
+
* Returned by: api.p21Core.codeP21.get(codeUid)
|
|
701
|
+
*/
|
|
702
|
+
export type CodeP21GetData = CodeP21ListItem;
|
|
703
|
+
/**
|
|
704
|
+
* List Companies
|
|
705
|
+
* Response data for GET /company — MINIMUM fields, extras pass through
|
|
706
|
+
*
|
|
707
|
+
* Returned by: api.p21Core.company.list(params) (array items)
|
|
708
|
+
* Returned by: api.p21Core.company.get(companyId)
|
|
709
|
+
*/
|
|
710
|
+
export interface CompanyListItem {
|
|
711
|
+
/** Unique Prophet 21 ID of the company */
|
|
712
|
+
companyUid: number;
|
|
713
|
+
/** Prophet 21 company code (max 8 chars) */
|
|
714
|
+
companyId: string;
|
|
715
|
+
/** Company name (max 40 chars) */
|
|
716
|
+
companyName: string | null;
|
|
717
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
718
|
+
dateCreated: string;
|
|
719
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
720
|
+
dateLastModified: string;
|
|
721
|
+
/** Y when the company is deleted in Prophet 21 (max 1 chars) */
|
|
722
|
+
deleteFlag: string;
|
|
723
|
+
/** Update code (704 = queued for refresh from Prophet 21, 1185 = current) */
|
|
724
|
+
updateCd: number;
|
|
725
|
+
/** Prophet 21 user who last changed the record (max 8 chars) */
|
|
726
|
+
lastMaintainedBy: string;
|
|
727
|
+
/** Prophet 21 address ID of the company */
|
|
728
|
+
addressId: number | null;
|
|
729
|
+
/** Default sales location ID */
|
|
730
|
+
defaultSalesLocationId: number | null;
|
|
731
|
+
/** Default freight code of the company (freightCodeUid) */
|
|
732
|
+
freightCodeUid: number | null;
|
|
733
|
+
/** UPS account number of the company (max 255 chars) */
|
|
734
|
+
upsAccountNo: string | null;
|
|
735
|
+
/** Default source price (Prophet 21 code number) */
|
|
736
|
+
defaultSourcePriceCd: number | null;
|
|
737
|
+
/** Default pricing multiplier */
|
|
738
|
+
defaultMultiplier: number | null;
|
|
739
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
740
|
+
processCd: number;
|
|
741
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
742
|
+
statusCd: number;
|
|
743
|
+
[key: string]: unknown;
|
|
744
|
+
}
|
|
745
|
+
/** Returned by: api.p21Core.company.list(params) */
|
|
746
|
+
export type CompanyListData = CompanyListItem[];
|
|
747
|
+
/**
|
|
748
|
+
* Get Company Details
|
|
749
|
+
* Response data for GET /company/{companyId} — MINIMUM fields, extras pass through
|
|
750
|
+
*
|
|
751
|
+
* Returned by: api.p21Core.company.get(companyId)
|
|
752
|
+
*/
|
|
753
|
+
export type CompanyGetData = CompanyListItem;
|
|
754
|
+
/**
|
|
755
|
+
* List Counter Rows
|
|
756
|
+
* Response data for GET /counter — MINIMUM fields, extras pass through
|
|
757
|
+
*
|
|
758
|
+
* Returned by: api.p21Core.counter.list(params) (array items)
|
|
759
|
+
* Returned by: api.p21Core.counter.get(id)
|
|
760
|
+
*/
|
|
761
|
+
export interface CounterListItem {
|
|
762
|
+
/** P21 counter ID (max 64 chars) */
|
|
763
|
+
id: string;
|
|
764
|
+
/** Description (max 255 chars) */
|
|
765
|
+
description: string | null;
|
|
766
|
+
/** P21 counter_num on the counter */
|
|
767
|
+
counterNum: number;
|
|
768
|
+
/** P21 seq_name on the counter (max 255 chars) */
|
|
769
|
+
seqName: string | null;
|
|
770
|
+
/** P21 table name (max 255 chars) */
|
|
771
|
+
tableName: string | null;
|
|
772
|
+
/** P21 column name (max 255 chars) */
|
|
773
|
+
columnName: string | null;
|
|
774
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
775
|
+
updateCd: number;
|
|
776
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
777
|
+
processCd: number;
|
|
778
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
779
|
+
statusCd: number;
|
|
780
|
+
[key: string]: unknown;
|
|
781
|
+
}
|
|
782
|
+
/** Returned by: api.p21Core.counter.list(params) */
|
|
783
|
+
export type CounterListData = CounterListItem[];
|
|
784
|
+
/**
|
|
785
|
+
* Get Counter
|
|
786
|
+
* Response data for GET /counter/{id} — MINIMUM fields, extras pass through
|
|
787
|
+
*
|
|
788
|
+
* Returned by: api.p21Core.counter.get(id)
|
|
789
|
+
*/
|
|
790
|
+
export type CounterGetData = CounterListItem;
|
|
791
|
+
/**
|
|
792
|
+
* List Creditcard Processor Rows
|
|
793
|
+
* Response data for GET /creditcard-processor — MINIMUM fields, extras pass through
|
|
794
|
+
*
|
|
795
|
+
* Returned by: api.p21Core.creditcardProcessor.list(params) (array items)
|
|
796
|
+
* Returned by: api.p21Core.creditcardProcessor.get(creditcardProcessorUid)
|
|
797
|
+
*/
|
|
798
|
+
export interface CreditcardProcessorListItem {
|
|
799
|
+
/** P21 credit card processor UID (creditcard_processor.creditcard_processor_uid) */
|
|
800
|
+
creditcardProcessorUid: number;
|
|
801
|
+
/** Credit card processor location name (max 255 chars) */
|
|
802
|
+
locationName: string | null;
|
|
803
|
+
/** Credit card processor name (max 255 chars) */
|
|
804
|
+
processorName: string | null;
|
|
805
|
+
/** Credit card processor number (max 255 chars) */
|
|
806
|
+
processorNumber: string | null;
|
|
807
|
+
/** Credit card merchant ID (max 255 chars) */
|
|
808
|
+
merchantId: string | null;
|
|
809
|
+
/** P21 merchantkey credential (value not described) (max 255 chars) */
|
|
810
|
+
merchantkey: string | null;
|
|
811
|
+
/** P21 help_desk_phone1 on the creditcard processor (max 20 chars) */
|
|
812
|
+
helpDeskPhone1: string | null;
|
|
813
|
+
/** P21 help_desk_phone2 on the creditcard processor (max 20 chars) */
|
|
814
|
+
helpDeskPhone2: string | null;
|
|
815
|
+
/** P21 voice_auth_phone1 on the creditcard processor (max 20 chars) */
|
|
816
|
+
voiceAuthPhone1: string | null;
|
|
817
|
+
/** P21 voice_auth_phone2 on the creditcard processor (max 20 chars) */
|
|
818
|
+
voiceAuthPhone2: string | null;
|
|
819
|
+
/** P21 industry_type on the creditcard processor (max 255 chars) */
|
|
820
|
+
industryType: string | null;
|
|
821
|
+
/** P21 protobase_path on the creditcard processor (max 255 chars) */
|
|
822
|
+
protobasePath: string | null;
|
|
823
|
+
/** P21 pb_admin_path on the creditcard processor (max 255 chars) */
|
|
824
|
+
pbAdminPath: string | null;
|
|
825
|
+
/** P21 settlement_batch_file_path on the creditcard processor (max 255 chars) */
|
|
826
|
+
settlementBatchFilePath: string | null;
|
|
827
|
+
/** P21 request_files_path on the creditcard processor (max 255 chars) */
|
|
828
|
+
requestFilesPath: string | null;
|
|
829
|
+
/** P21 archive_files_path on the creditcard processor (max 255 chars) */
|
|
830
|
+
archiveFilesPath: string | null;
|
|
831
|
+
/** P21 terminal_id on the creditcard processor (max 255 chars) */
|
|
832
|
+
terminalId: string | null;
|
|
833
|
+
/** P21 freight on the creditcard processor (max 20 chars) */
|
|
834
|
+
freight: string;
|
|
835
|
+
/** P21 timeout on the creditcard processor */
|
|
836
|
+
timeout: number;
|
|
837
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
838
|
+
dateCreated: string;
|
|
839
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
840
|
+
lastMaintainedBy: string;
|
|
841
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
842
|
+
dateLastModified: string;
|
|
843
|
+
/** P21 processor_type_cd on the creditcard processor */
|
|
844
|
+
processorTypeCd: number;
|
|
845
|
+
/** P21 web_server_url on the creditcard processor (max 255 chars) */
|
|
846
|
+
webServerUrl: string | null;
|
|
847
|
+
/** P21 secret_key credential (value not described) (max 255 chars) */
|
|
848
|
+
secretKey: string | null;
|
|
849
|
+
/** P21 epayment_integration_type_cd on the creditcard processor */
|
|
850
|
+
epaymentIntegrationTypeCd: number | null;
|
|
851
|
+
/** P21 reporting_url on the creditcard processor (max 255 chars) */
|
|
852
|
+
reportingUrl: string | null;
|
|
853
|
+
/** P21 services_url on the creditcard processor (max 255 chars) */
|
|
854
|
+
servicesUrl: string | null;
|
|
855
|
+
/** P21 transaction_url on the creditcard processor (max 255 chars) */
|
|
856
|
+
transactionUrl: string | null;
|
|
857
|
+
/** P21 default_account_flag on the creditcard processor (max 1 chars) */
|
|
858
|
+
defaultAccountFlag: string;
|
|
859
|
+
/** P21 level_3_transaction_support_flag on the creditcard processor (max 1 chars) */
|
|
860
|
+
level3TransactionSupportFlag: string;
|
|
861
|
+
/** P21 force_level_3_mastercard on the creditcard processor (max 1 chars) */
|
|
862
|
+
forceLevel3Mastercard: string;
|
|
863
|
+
/** P21 currency ID */
|
|
864
|
+
currencyId: number | null;
|
|
865
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
866
|
+
updateCd: number;
|
|
867
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
868
|
+
processCd: number;
|
|
869
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
870
|
+
statusCd: number;
|
|
871
|
+
[key: string]: unknown;
|
|
872
|
+
}
|
|
873
|
+
/** Returned by: api.p21Core.creditcardProcessor.list(params) */
|
|
874
|
+
export type CreditcardProcessorListData = CreditcardProcessorListItem[];
|
|
875
|
+
/**
|
|
876
|
+
* Get Creditcard Processor
|
|
877
|
+
* Response data for GET /creditcard-processor/{creditcardProcessorUid} — MINIMUM fields, extras
|
|
878
|
+
* pass through
|
|
879
|
+
*
|
|
880
|
+
* Returned by: api.p21Core.creditcardProcessor.get(creditcardProcessorUid)
|
|
881
|
+
*/
|
|
882
|
+
export type CreditcardProcessorGetData = CreditcardProcessorListItem;
|
|
883
|
+
/**
|
|
884
|
+
* List Freight Codes
|
|
885
|
+
* Response data for GET /freight-code — MINIMUM fields, extras pass through
|
|
886
|
+
*
|
|
887
|
+
* Returned by: api.p21Core.freightCode.list(params) (array items)
|
|
888
|
+
* Returned by: api.p21Core.freightCode.get(freightCodeUid, params)
|
|
889
|
+
*/
|
|
890
|
+
export interface FreightCodeListItem {
|
|
891
|
+
/** Unique Prophet 21 ID of the freight code */
|
|
892
|
+
freightCodeUid: number;
|
|
893
|
+
/** Prophet 21 company the freight code belongs to (max 8 chars) */
|
|
894
|
+
companyId: string;
|
|
895
|
+
/** Freight code (max 30 chars) */
|
|
896
|
+
freightCd: string;
|
|
897
|
+
/** Freight code description (max 255 chars) */
|
|
898
|
+
freightDesc: string;
|
|
899
|
+
/** Y when the code applies to incoming freight (max 1 chars) */
|
|
900
|
+
incomingFreight: string;
|
|
901
|
+
/** Y when the code applies to outgoing freight (max 1 chars) */
|
|
902
|
+
outgoingFreight: string;
|
|
903
|
+
/** Y when incoming freight reduces commission (max 1 chars) */
|
|
904
|
+
incomingReduceCommission: string;
|
|
905
|
+
/** Y when outgoing freight increases commission (max 1 chars) */
|
|
906
|
+
outgoingIncreaseCommission: string;
|
|
907
|
+
/** Prorate method (Prophet 21 code number) */
|
|
908
|
+
prorateMethodCodeNo: number;
|
|
909
|
+
/** Tax group for the freight charge (max 10 chars) */
|
|
910
|
+
taxGroupId: string | null;
|
|
911
|
+
/** General ledger revenue account for the freight charge (max 32 chars) */
|
|
912
|
+
revenueAccountNo: string;
|
|
913
|
+
/** Prophet 21 row status code */
|
|
914
|
+
rowStatus: number;
|
|
915
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
916
|
+
dateCreated: string | null;
|
|
917
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
918
|
+
dateLastModified: string | null;
|
|
919
|
+
/** Prophet 21 user who last changed the record (max 30 chars) */
|
|
920
|
+
lastMaintainedBy: string;
|
|
921
|
+
/** Basis for free freight (Prophet 21 code number) */
|
|
922
|
+
freeFreightBasisCd: number | null;
|
|
923
|
+
/** Minimum for free incoming freight */
|
|
924
|
+
freeInFreightMin: number | null;
|
|
925
|
+
/** Minimum for free outgoing freight */
|
|
926
|
+
freeOutFreightMin: number | null;
|
|
927
|
+
/** Y when direct shipments get free freight (max 1 chars) */
|
|
928
|
+
directShipFreeFreightFlag: string | null;
|
|
929
|
+
/** Minimum for free incoming freight on web orders */
|
|
930
|
+
freeInFreightMinWeb: number | null;
|
|
931
|
+
/** Minimum for free outgoing freight on web orders */
|
|
932
|
+
freeOutFreightMinWeb: number | null;
|
|
933
|
+
/** Handling charge option (Prophet 21 code number) */
|
|
934
|
+
handlingChargeOptionCd: number | null;
|
|
935
|
+
/** External tax product code for incoming freight (max 255 chars) */
|
|
936
|
+
externalTaxProductCodeIn: string | null;
|
|
937
|
+
/** External tax product code for outgoing freight (max 255 chars) */
|
|
938
|
+
externalTaxProductCodeOut: string | null;
|
|
939
|
+
/** Y when incoming freight increases commission (max 1 chars) */
|
|
940
|
+
incomingIncreaseCommission: string | null;
|
|
941
|
+
/** Prophet 21 pay special flag (max 1 chars) */
|
|
942
|
+
paySpecialFlag: string | null;
|
|
943
|
+
/** Prophet 21 skip-first-shipment flag (max 1 chars) */
|
|
944
|
+
skipFirstShipmentFlag: string | null;
|
|
945
|
+
/** Y when excluded from Sales Master Inquiry (max 1 chars) */
|
|
946
|
+
excludeFromSalesMasterInquiry: string;
|
|
947
|
+
/** Y when the freight charge is deductible (max 1 chars) */
|
|
948
|
+
deductibleFlag: string | null;
|
|
949
|
+
/** Y when cold freight is free (max 1 chars) */
|
|
950
|
+
freeColdFreight: string;
|
|
951
|
+
/** Y when hazmat freight is free (max 1 chars) */
|
|
952
|
+
freeHazmatFreight: string;
|
|
953
|
+
/** Y when express freight is free (max 1 chars) */
|
|
954
|
+
freeExpressFreight: string;
|
|
955
|
+
/** Y when bulk freight is free (max 1 chars) */
|
|
956
|
+
freeBulkFreight: string;
|
|
957
|
+
/** FedEx payment method code */
|
|
958
|
+
fedexPaymentMethod: number | null;
|
|
959
|
+
/** Prophet 21 exclude-discounted-freight flag (max 1 chars) */
|
|
960
|
+
excludeDiscountedFreight: string;
|
|
961
|
+
/** Y when free freight applies by default (max 1 chars) */
|
|
962
|
+
freeFreightDefaultFlag: string | null;
|
|
963
|
+
/** Y when outgoing freight adjusts commission by profit (max 1 chars) */
|
|
964
|
+
outgoingAdjustCommissionByProfitFlag: string | null;
|
|
965
|
+
/** Update code (704 = queued for refresh from Prophet 21, 1185 = current) */
|
|
966
|
+
updateCd: number;
|
|
967
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
968
|
+
statusCd: number;
|
|
969
|
+
/** Process code */
|
|
970
|
+
processCd: number;
|
|
971
|
+
[key: string]: unknown;
|
|
972
|
+
}
|
|
973
|
+
/** Returned by: api.p21Core.freightCode.list(params) */
|
|
974
|
+
export type FreightCodeListData = FreightCodeListItem[];
|
|
975
|
+
/**
|
|
976
|
+
* Get Freight Code
|
|
977
|
+
* Response data for GET /freight-code/{freightCodeUid} — MINIMUM fields, extras pass through
|
|
978
|
+
*
|
|
979
|
+
* Returned by: api.p21Core.freightCode.get(freightCodeUid, params)
|
|
980
|
+
*/
|
|
981
|
+
export type FreightCodeGetData = FreightCodeListItem;
|
|
982
|
+
/**
|
|
983
|
+
* List Language Rows
|
|
984
|
+
* Response data for GET /language — MINIMUM fields, extras pass through
|
|
985
|
+
*
|
|
986
|
+
* Returned by: api.p21Core.language.list(params) (array items)
|
|
987
|
+
* Returned by: api.p21Core.language.get(languageUid)
|
|
988
|
+
*/
|
|
989
|
+
export interface LanguageListItem {
|
|
990
|
+
/** P21 language ID (language.language_id) (max 8 chars) */
|
|
991
|
+
languageId: string;
|
|
992
|
+
/** Language description (max 30 chars) */
|
|
993
|
+
languageDescription: string;
|
|
994
|
+
/** Y when P21 marks the row deleted (max 1 chars) */
|
|
995
|
+
deleteFlag: string;
|
|
996
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
997
|
+
dateCreated: string;
|
|
998
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
999
|
+
dateLastModified: string;
|
|
1000
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
1001
|
+
lastMaintainedBy: string;
|
|
1002
|
+
/** P21 language UID (unique row ID) */
|
|
1003
|
+
languageUid: number;
|
|
1004
|
+
/** P21 crystal_reports_folder on the language (max 255 chars) */
|
|
1005
|
+
crystalReportsFolder: string | null;
|
|
1006
|
+
/** ISO code for the language (max 5 chars) */
|
|
1007
|
+
isoCode: string | null;
|
|
1008
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1009
|
+
updateCd: number;
|
|
1010
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1011
|
+
processCd: number;
|
|
1012
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1013
|
+
statusCd: number;
|
|
1014
|
+
[key: string]: unknown;
|
|
1015
|
+
}
|
|
1016
|
+
/** Returned by: api.p21Core.language.list(params) */
|
|
1017
|
+
export type LanguageListData = LanguageListItem[];
|
|
1018
|
+
/**
|
|
1019
|
+
* Get Language
|
|
1020
|
+
* Response data for GET /language/{languageUid} — MINIMUM fields, extras pass through
|
|
1021
|
+
*
|
|
1022
|
+
* Returned by: api.p21Core.language.get(languageUid)
|
|
1023
|
+
*/
|
|
1024
|
+
export type LanguageGetData = LanguageListItem;
|
|
1025
|
+
/**
|
|
1026
|
+
* List Locations
|
|
1027
|
+
* Response data for GET /location — MINIMUM fields, extras pass through
|
|
1028
|
+
*
|
|
1029
|
+
* Returned by: api.p21Core.location.list(params) (array items)
|
|
1030
|
+
* Returned by: api.p21Core.location.get(locationId, params)
|
|
1031
|
+
*/
|
|
1032
|
+
export interface LocationListItem {
|
|
1033
|
+
/** Prophet 21 location ID (also its address ID) */
|
|
1034
|
+
locationId: number;
|
|
1035
|
+
/** Prophet 21 company (max 8 chars) */
|
|
1036
|
+
companyId: string;
|
|
1037
|
+
/** Default branch for the location (max 8 chars) */
|
|
1038
|
+
defaultBranchId: string | null;
|
|
1039
|
+
/** Y when the location is deleted in Prophet 21 (max 1 chars) */
|
|
1040
|
+
deleteFlag: string;
|
|
1041
|
+
/** When the record was created (Y-m-d H:i:s) */
|
|
1042
|
+
dateCreated: string;
|
|
1043
|
+
/** When the record last changed (Y-m-d H:i:s) */
|
|
1044
|
+
dateLastModified: string;
|
|
1045
|
+
/** Prophet 21 user who last changed the record (max 30 chars) */
|
|
1046
|
+
lastMaintainedBy: string;
|
|
1047
|
+
/** Location name (max 255 chars) */
|
|
1048
|
+
locationName: string | null;
|
|
1049
|
+
/** Y when lots are tracked by bin at the location (max 1 chars) */
|
|
1050
|
+
lotBinIntegration: string | null;
|
|
1051
|
+
/** FedEx account number for the location (max 255 chars) */
|
|
1052
|
+
fedexLocAcctNo: string | null;
|
|
1053
|
+
/** FedEx meter number for the location (max 255 chars) */
|
|
1054
|
+
fedexMeterNo: string | null;
|
|
1055
|
+
/** UPS account number for the location (max 255 chars) */
|
|
1056
|
+
upsAccountNo: string | null;
|
|
1057
|
+
/** Prophet 21 code for the UPS pickup type */
|
|
1058
|
+
upsPickupTypeCd: number | null;
|
|
1059
|
+
/** Prophet 21 code for the UPS customer type */
|
|
1060
|
+
upsCustomerTypeCd: number | null;
|
|
1061
|
+
/** UPS OnLine Tools access key, as Prophet 21 stores it (max 255 chars) */
|
|
1062
|
+
upsOltAccessKey: string | null;
|
|
1063
|
+
/** UPS OnLine Tools password, as Prophet 21 stores it (max 255 chars) */
|
|
1064
|
+
upsOltPassword: string | null;
|
|
1065
|
+
/** UPS OnLine Tools user ID, as Prophet 21 stores it (max 255 chars) */
|
|
1066
|
+
upsOltUserId: string | null;
|
|
1067
|
+
/** Y when the location is a distribution center (max 1 chars) */
|
|
1068
|
+
distributionCenter: string;
|
|
1069
|
+
/** Update code (704 = queued for refresh from Prophet 21, 1185 = current) */
|
|
1070
|
+
updateCd: number;
|
|
1071
|
+
/** The location's address; the key is absent unless includeAddress=Y */
|
|
1072
|
+
address?: AddressListItem | null;
|
|
1073
|
+
[key: string]: unknown;
|
|
1074
|
+
}
|
|
1075
|
+
/** Returned by: api.p21Core.location.list(params) */
|
|
1076
|
+
export type LocationListData = LocationListItem[];
|
|
1077
|
+
/**
|
|
1078
|
+
* Get Location Details
|
|
1079
|
+
* Response data for GET /location/{locationId} — MINIMUM fields, extras pass through
|
|
1080
|
+
*
|
|
1081
|
+
* Returned by: api.p21Core.location.get(locationId, params)
|
|
1082
|
+
*/
|
|
1083
|
+
export type LocationGetData = LocationListItem;
|
|
1084
|
+
/**
|
|
1085
|
+
* List Note Rows
|
|
1086
|
+
* Response data for GET /note — MINIMUM fields, extras pass through
|
|
1087
|
+
*
|
|
1088
|
+
* Returned by: api.p21Core.note.list(params) (array items)
|
|
1089
|
+
* Returned by: api.p21Core.note.get(noteUid)
|
|
1090
|
+
*/
|
|
1091
|
+
export interface NoteListItem {
|
|
1092
|
+
/** P21 note UID (unique row ID) */
|
|
1093
|
+
noteUid: number;
|
|
1094
|
+
/** P21 document_uid on the note */
|
|
1095
|
+
documentUid: number;
|
|
1096
|
+
/** P21 notepad_class_id on the note (max 8 chars) */
|
|
1097
|
+
notepadClassId: string | null;
|
|
1098
|
+
/** Note topic (max 255 chars) */
|
|
1099
|
+
topic: string;
|
|
1100
|
+
/** Note text */
|
|
1101
|
+
note: string | null;
|
|
1102
|
+
/** P21 activation_date on the note (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1103
|
+
activationDate: string;
|
|
1104
|
+
/** P21 expiration_date on the note (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1105
|
+
expirationDate: string;
|
|
1106
|
+
/** P21 entry_date on the note (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1107
|
+
entryDate: string;
|
|
1108
|
+
/** P21 mandatory on the note (max 1 chars) */
|
|
1109
|
+
mandatory: string;
|
|
1110
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1111
|
+
rowStatusFlag: number;
|
|
1112
|
+
/** P21 note_type_cd on the note */
|
|
1113
|
+
noteTypeCd: number;
|
|
1114
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1115
|
+
dateCreated: string;
|
|
1116
|
+
/** P21 user who created the row (max 255 chars) */
|
|
1117
|
+
createdBy: string;
|
|
1118
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1119
|
+
dateLastModified: string;
|
|
1120
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
1121
|
+
lastMaintainedBy: string;
|
|
1122
|
+
/** P21 create_order_line_note_flag on the note (max 1 chars) */
|
|
1123
|
+
createOrderLineNoteFlag: string;
|
|
1124
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1125
|
+
updateCd: number;
|
|
1126
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1127
|
+
processCd: number;
|
|
1128
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1129
|
+
statusCd: number;
|
|
1130
|
+
[key: string]: unknown;
|
|
1131
|
+
}
|
|
1132
|
+
/** Returned by: api.p21Core.note.list(params) */
|
|
1133
|
+
export type NoteListData = NoteListItem[];
|
|
1134
|
+
/**
|
|
1135
|
+
* Get Note
|
|
1136
|
+
* Response data for GET /note/{noteUid} — MINIMUM fields, extras pass through
|
|
1137
|
+
*
|
|
1138
|
+
* Returned by: api.p21Core.note.get(noteUid)
|
|
1139
|
+
*/
|
|
1140
|
+
export type NoteGetData = NoteListItem;
|
|
1141
|
+
/**
|
|
1142
|
+
* List Payment Types
|
|
1143
|
+
* Response data for GET /payment-types — MINIMUM fields, extras pass through
|
|
1144
|
+
*
|
|
1145
|
+
* Returned by: api.p21Core.paymentTypes.list(params) (array items)
|
|
1146
|
+
*/
|
|
1147
|
+
export interface PaymentTypesListItem {
|
|
1148
|
+
/** Prophet 21 payment type ID */
|
|
1149
|
+
paymentTypeId: number;
|
|
1150
|
+
/** Payment type description (max 30 chars) */
|
|
1151
|
+
paymentTypeDesc: string;
|
|
1152
|
+
/** Prophet 21 company (max 8 chars) */
|
|
1153
|
+
companyId: string;
|
|
1154
|
+
/** Prophet 21 payment method the type belongs to (max 2 chars) */
|
|
1155
|
+
paymentMethodId: string;
|
|
1156
|
+
/** Y when the payment type is deleted in Prophet 21 (max 1 chars) */
|
|
1157
|
+
deleteFlag: string;
|
|
1158
|
+
[key: string]: unknown;
|
|
1159
|
+
}
|
|
1160
|
+
/** Returned by: api.p21Core.paymentTypes.list(params) */
|
|
1161
|
+
export type PaymentTypesListData = PaymentTypesListItem[];
|
|
1162
|
+
/**
|
|
1163
|
+
* Get Payment Types
|
|
1164
|
+
* Response data for GET /payment-types/{paymentTypeId} — MINIMUM fields, extras pass through
|
|
1165
|
+
*
|
|
1166
|
+
* Returned by: api.p21Core.paymentTypes.get(paymentTypeId)
|
|
1167
|
+
*/
|
|
1168
|
+
export interface PaymentTypesGetData {
|
|
1169
|
+
/** P21 company ID (max 8 chars) */
|
|
1170
|
+
companyId: string;
|
|
1171
|
+
/** P21 payment method ID (max 2 chars) */
|
|
1172
|
+
paymentMethodId: string;
|
|
1173
|
+
/** P21 payment type ID */
|
|
1174
|
+
paymentTypeId: number;
|
|
1175
|
+
/** Payment type description (max 30 chars) */
|
|
1176
|
+
paymentTypeDesc: string;
|
|
1177
|
+
/** P21 account_number on the payment types (max 32 chars) */
|
|
1178
|
+
accountNumber: string | null;
|
|
1179
|
+
/** P21 discount on the payment types */
|
|
1180
|
+
discount: number | null;
|
|
1181
|
+
/** P21 flat_rate on the payment types */
|
|
1182
|
+
flatRate: number | null;
|
|
1183
|
+
/** Y when P21 marks the row deleted (max 1 chars) */
|
|
1184
|
+
deleteFlag: string;
|
|
1185
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1186
|
+
dateCreated: string;
|
|
1187
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1188
|
+
dateLastModified: string;
|
|
1189
|
+
/** P21 wildcard_account on the payment types (max 1 chars) */
|
|
1190
|
+
wildcardAccount: string;
|
|
1191
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
1192
|
+
lastMaintainedBy: string;
|
|
1193
|
+
/** P21 use_check_verification_flag on the payment types (max 1 chars) */
|
|
1194
|
+
useCheckVerificationFlag: string;
|
|
1195
|
+
/** P21 card_type_cd on the payment types */
|
|
1196
|
+
cardTypeCd: number | null;
|
|
1197
|
+
/** P21 cash_discount_eligible_flag on the payment types (max 1 chars) */
|
|
1198
|
+
cashDiscountEligibleFlag: string;
|
|
1199
|
+
/** P21 convenience_fee_percentage on the payment types */
|
|
1200
|
+
convenienceFeePercentage: number | null;
|
|
1201
|
+
/** P21 service_voucher on the payment types (max 1 chars) */
|
|
1202
|
+
serviceVoucher: string | null;
|
|
1203
|
+
/** P21 billtrust_flag on the payment types (max 1 chars) */
|
|
1204
|
+
billtrustFlag: string | null;
|
|
1205
|
+
/** P21 paypal_flag on the payment types (max 1 chars) */
|
|
1206
|
+
paypalFlag: string | null;
|
|
1207
|
+
/** P21 display_in_rma_flag on the payment types (max 1 chars) */
|
|
1208
|
+
displayInRmaFlag: string;
|
|
1209
|
+
/** P21 bank_no_override on the payment types */
|
|
1210
|
+
bankNoOverride: number | null;
|
|
1211
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1212
|
+
updateCd: number;
|
|
1213
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1214
|
+
processCd: number;
|
|
1215
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1216
|
+
statusCd: number;
|
|
1217
|
+
[key: string]: unknown;
|
|
1218
|
+
}
|
|
1219
|
+
/**
|
|
1220
|
+
* List Restricted Class Rows
|
|
1221
|
+
* Response data for GET /restricted-class — MINIMUM fields, extras pass through
|
|
1222
|
+
*
|
|
1223
|
+
* Returned by: api.p21Core.restrictedClass.list(params) (array items)
|
|
1224
|
+
* Returned by: api.p21Core.restrictedClass.get(restrictedClassUid)
|
|
1225
|
+
*/
|
|
1226
|
+
export interface RestrictedClassListItem {
|
|
1227
|
+
/** P21 restricted class UID (unique row ID) */
|
|
1228
|
+
restrictedClassUid: number;
|
|
1229
|
+
/** P21 parent_class_uid on the restricted class */
|
|
1230
|
+
parentClassUid: number | null;
|
|
1231
|
+
/** P21 class ID (max 255 chars) */
|
|
1232
|
+
classId: string;
|
|
1233
|
+
/** Class description (max 255 chars) */
|
|
1234
|
+
classDescription: string;
|
|
1235
|
+
/** P21 indicator on the restricted class (max 255 chars) */
|
|
1236
|
+
indicator: string | null;
|
|
1237
|
+
/** P21 restriction_state on the restricted class (max 2 chars) */
|
|
1238
|
+
restrictionState: string | null;
|
|
1239
|
+
/** P21 block_in_oe_flag on the restricted class (max 1 chars) */
|
|
1240
|
+
blockInOeFlag: string;
|
|
1241
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1242
|
+
dateCreated: string;
|
|
1243
|
+
/** P21 user who created the row (max 255 chars) */
|
|
1244
|
+
createdBy: string;
|
|
1245
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1246
|
+
dateLastModified: string;
|
|
1247
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
1248
|
+
lastMaintainedBy: string;
|
|
1249
|
+
/** P21 license_required_flag on the restricted class (max 1 chars) */
|
|
1250
|
+
licenseRequiredFlag: string;
|
|
1251
|
+
/** P21 license_expires_flag on the restricted class (max 1 chars) */
|
|
1252
|
+
licenseExpiresFlag: string;
|
|
1253
|
+
/** P21 user_can_override_flag on the restricted class (max 1 chars) */
|
|
1254
|
+
userCanOverrideFlag: string;
|
|
1255
|
+
/** P21 cumulative_restrictions_flag on the restricted class (max 1 chars) */
|
|
1256
|
+
cumulativeRestrictionsFlag: string;
|
|
1257
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1258
|
+
rowStatusFlag: number;
|
|
1259
|
+
/** P21 dealer_type_uid on the restricted class */
|
|
1260
|
+
dealerTypeUid: number | null;
|
|
1261
|
+
/** P21 in_class_cannot_buy_items_flag on the restricted class (max 1 chars) */
|
|
1262
|
+
inClassCannotBuyItemsFlag: string | null;
|
|
1263
|
+
/** P21 ship_to_address_flag on the restricted class (max 1 chars) */
|
|
1264
|
+
shipToAddressFlag: string;
|
|
1265
|
+
/** P21 address_based_flag on the restricted class (max 1 chars) */
|
|
1266
|
+
addressBasedFlag: string;
|
|
1267
|
+
/** P21 address_restriction_setting_type on the restricted class (max 1 chars) */
|
|
1268
|
+
addressRestrictionSettingType: string | null;
|
|
1269
|
+
/** P21 apply_restrictions_flag on the restricted class (max 1 chars) */
|
|
1270
|
+
applyRestrictionsFlag: string | null;
|
|
1271
|
+
/** P21 restriction_type on the restricted class (max 1 chars) */
|
|
1272
|
+
restrictionType: string;
|
|
1273
|
+
/** P21 qty_restr_universal_class_flag on the restricted class (max 1 chars) */
|
|
1274
|
+
qtyRestrUniversalClassFlag: string | null;
|
|
1275
|
+
/** P21 qty_restr_per_time_period_sales_unit_qty on the restricted class */
|
|
1276
|
+
qtyRestrPerTimePeriodSalesUnitQty: number | null;
|
|
1277
|
+
/** P21 qty_restr_time_period on the restricted class (max 1 chars) */
|
|
1278
|
+
qtyRestrTimePeriod: string | null;
|
|
1279
|
+
/** P21 qty_restr_per_order_limit_type on the restricted class (max 1 chars) */
|
|
1280
|
+
qtyRestrPerOrderLimitType: string | null;
|
|
1281
|
+
/** P21 qty_restr_per_order_fixed_sales_unit_qty on the restricted class */
|
|
1282
|
+
qtyRestrPerOrderFixedSalesUnitQty: number | null;
|
|
1283
|
+
/** P21 qty_restr_lookback_number_of_months on the restricted class */
|
|
1284
|
+
qtyRestrLookbackNumberOfMonths: number | null;
|
|
1285
|
+
/**
|
|
1286
|
+
* P21 qty_restr_lookback_start_date on the restricted class (mysql-datetime, e.g. 2025-07-30
|
|
1287
|
+
* 15:50:49)
|
|
1288
|
+
*/
|
|
1289
|
+
qtyRestrLookbackStartDate: string | null;
|
|
1290
|
+
/** P21 qty_restr_per_order_average_multiplier on the restricted class */
|
|
1291
|
+
qtyRestrPerOrderAverageMultiplier: number | null;
|
|
1292
|
+
/** P21 order_restriction_type on the restricted class (max 1 chars) */
|
|
1293
|
+
orderRestrictionType: string | null;
|
|
1294
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1295
|
+
updateCd: number;
|
|
1296
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1297
|
+
processCd: number;
|
|
1298
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1299
|
+
statusCd: number;
|
|
1300
|
+
[key: string]: unknown;
|
|
1301
|
+
}
|
|
1302
|
+
/** Returned by: api.p21Core.restrictedClass.list(params) */
|
|
1303
|
+
export type RestrictedClassListData = RestrictedClassListItem[];
|
|
1304
|
+
/**
|
|
1305
|
+
* Get Restricted Class
|
|
1306
|
+
* Response data for GET /restricted-class/{restrictedClassUid} — MINIMUM fields, extras pass
|
|
1307
|
+
* through
|
|
1308
|
+
*
|
|
1309
|
+
* Returned by: api.p21Core.restrictedClass.get(restrictedClassUid)
|
|
1310
|
+
*/
|
|
1311
|
+
export type RestrictedClassGetData = RestrictedClassListItem;
|
|
1312
|
+
/**
|
|
1313
|
+
* List State Rows
|
|
1314
|
+
* Response data for GET /state — MINIMUM fields, extras pass through
|
|
1315
|
+
*
|
|
1316
|
+
* Returned by: api.p21Core.state.list(params) (array items)
|
|
1317
|
+
* Returned by: api.p21Core.state.get(stateUid)
|
|
1318
|
+
*/
|
|
1319
|
+
export interface StateListItem {
|
|
1320
|
+
/** P21 state UID (unique row ID) */
|
|
1321
|
+
stateUid: number;
|
|
1322
|
+
/** P21 country UID (country.country_uid) */
|
|
1323
|
+
countryUid: number;
|
|
1324
|
+
/** Two-letter state code (max 2 chars) */
|
|
1325
|
+
twoLetterCode: string;
|
|
1326
|
+
/** State name (max 255 chars) */
|
|
1327
|
+
stateName: string;
|
|
1328
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1329
|
+
dateCreated: string;
|
|
1330
|
+
/** P21 user who created the row (max 255 chars) */
|
|
1331
|
+
createdBy: string;
|
|
1332
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1333
|
+
dateLastModified: string;
|
|
1334
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
1335
|
+
lastMaintainedBy: string;
|
|
1336
|
+
/** P21 combined_federal_state_1099_no on the state */
|
|
1337
|
+
combinedFederalState1099No: number | null;
|
|
1338
|
+
/** P21 telecheck_state_code on the state */
|
|
1339
|
+
telecheckStateCode: number | null;
|
|
1340
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1341
|
+
updateCd: number;
|
|
1342
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1343
|
+
processCd: number;
|
|
1344
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1345
|
+
statusCd: number;
|
|
1346
|
+
[key: string]: unknown;
|
|
1347
|
+
}
|
|
1348
|
+
/** Returned by: api.p21Core.state.list(params) */
|
|
1349
|
+
export type StateListData = StateListItem[];
|
|
1350
|
+
/**
|
|
1351
|
+
* Get State
|
|
1352
|
+
* Response data for GET /state/{stateUid} — MINIMUM fields, extras pass through
|
|
1353
|
+
*
|
|
1354
|
+
* Returned by: api.p21Core.state.get(stateUid)
|
|
1355
|
+
*/
|
|
1356
|
+
export type StateGetData = StateListItem;
|
|
1357
|
+
/**
|
|
1358
|
+
* List System Setting Rows
|
|
1359
|
+
* Response data for GET /system-setting — MINIMUM fields, extras pass through
|
|
1360
|
+
*
|
|
1361
|
+
* Returned by: api.p21Core.systemSetting.list(params) (array items)
|
|
1362
|
+
* Returned by: api.p21Core.systemSetting.get(systemSettingUid)
|
|
1363
|
+
*/
|
|
1364
|
+
export interface SystemSettingListItem {
|
|
1365
|
+
/** P21 system setting UID (unique row ID) */
|
|
1366
|
+
systemSettingUid: number;
|
|
1367
|
+
/** P21 configuration_id on the system setting */
|
|
1368
|
+
configurationId: number;
|
|
1369
|
+
/** P21 module_cd on the system setting */
|
|
1370
|
+
moduleCd: number;
|
|
1371
|
+
/** Name (max 128 chars) */
|
|
1372
|
+
name: string;
|
|
1373
|
+
/** Setting value (max 255 chars) */
|
|
1374
|
+
value: string;
|
|
1375
|
+
/** P21 data_type_cd on the system setting */
|
|
1376
|
+
dataTypeCd: number;
|
|
1377
|
+
/** P21 data_type_length on the system setting */
|
|
1378
|
+
dataTypeLength: number;
|
|
1379
|
+
/** P21 data_type_scale on the system setting */
|
|
1380
|
+
dataTypeScale: number;
|
|
1381
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1382
|
+
dateCreated: string;
|
|
1383
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1384
|
+
dateLastModified: string;
|
|
1385
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
1386
|
+
lastMaintainedBy: string;
|
|
1387
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1388
|
+
updateCd: number;
|
|
1389
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1390
|
+
processCd: number;
|
|
1391
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1392
|
+
statusCd: number;
|
|
1393
|
+
[key: string]: unknown;
|
|
1394
|
+
}
|
|
1395
|
+
/** Returned by: api.p21Core.systemSetting.list(params) */
|
|
1396
|
+
export type SystemSettingListData = SystemSettingListItem[];
|
|
1397
|
+
/**
|
|
1398
|
+
* Get System Setting
|
|
1399
|
+
* Response data for GET /system-setting/{systemSettingUid} — MINIMUM fields, extras pass through
|
|
1400
|
+
*
|
|
1401
|
+
* Returned by: api.p21Core.systemSetting.get(systemSettingUid)
|
|
1402
|
+
*/
|
|
1403
|
+
export type SystemSettingGetData = SystemSettingListItem;
|
|
1404
|
+
/**
|
|
1405
|
+
* List Term X Language Rows
|
|
1406
|
+
* Response data for GET /term-x-language — MINIMUM fields, extras pass through
|
|
1407
|
+
*
|
|
1408
|
+
* Returned by: api.p21Core.termXLanguage.list(params) (array items)
|
|
1409
|
+
* Returned by: api.p21Core.termXLanguage.get(termXLanguageUid)
|
|
1410
|
+
*/
|
|
1411
|
+
export interface TermXLanguageListItem {
|
|
1412
|
+
/** P21 term x language UID (unique row ID) */
|
|
1413
|
+
termXLanguageUid: number;
|
|
1414
|
+
/** P21 language ID (language.language_id) (max 8 chars) */
|
|
1415
|
+
languageId: string;
|
|
1416
|
+
/** P21 translation_term_uid on the term x language */
|
|
1417
|
+
translationTermUid: number;
|
|
1418
|
+
/** P21 translated_term on the term x language (max 2048 chars) */
|
|
1419
|
+
translatedTerm: string;
|
|
1420
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1421
|
+
rowStatusFlag: number;
|
|
1422
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1423
|
+
dateCreated: string;
|
|
1424
|
+
/** P21 user who created the row (max 255 chars) */
|
|
1425
|
+
createdBy: string;
|
|
1426
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1427
|
+
dateLastModified: string;
|
|
1428
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
1429
|
+
lastMaintainedBy: string;
|
|
1430
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1431
|
+
updateCd: number;
|
|
1432
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1433
|
+
processCd: number;
|
|
1434
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1435
|
+
statusCd: number;
|
|
1436
|
+
[key: string]: unknown;
|
|
1437
|
+
}
|
|
1438
|
+
/** Returned by: api.p21Core.termXLanguage.list(params) */
|
|
1439
|
+
export type TermXLanguageListData = TermXLanguageListItem[];
|
|
1440
|
+
/**
|
|
1441
|
+
* Get Term X Language
|
|
1442
|
+
* Response data for GET /term-x-language/{termXLanguageUid} — MINIMUM fields, extras pass through
|
|
1443
|
+
*
|
|
1444
|
+
* Returned by: api.p21Core.termXLanguage.get(termXLanguageUid)
|
|
1445
|
+
*/
|
|
1446
|
+
export type TermXLanguageGetData = TermXLanguageListItem;
|
|
1447
|
+
/**
|
|
1448
|
+
* List Terms Rows
|
|
1449
|
+
* Response data for GET /terms — MINIMUM fields, extras pass through
|
|
1450
|
+
*
|
|
1451
|
+
* Returned by: api.p21Core.terms.list(params) (array items)
|
|
1452
|
+
* Returned by: api.p21Core.terms.get(termsId)
|
|
1453
|
+
*/
|
|
1454
|
+
export interface TermsListItem {
|
|
1455
|
+
/** P21 terms ID (max 2 chars) */
|
|
1456
|
+
termsId: string;
|
|
1457
|
+
/** Terms description (max 20 chars) */
|
|
1458
|
+
termsDesc: string;
|
|
1459
|
+
/** P21 discount_pct on the terms */
|
|
1460
|
+
discountPct: number | null;
|
|
1461
|
+
/** P21 discount_days on the terms */
|
|
1462
|
+
discountDays: number | null;
|
|
1463
|
+
/** P21 net_days on the terms */
|
|
1464
|
+
netDays: number | null;
|
|
1465
|
+
/** Y when P21 marks the row deleted (max 1 chars) */
|
|
1466
|
+
deleteFlag: string;
|
|
1467
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1468
|
+
dateCreated: string;
|
|
1469
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1470
|
+
dateLastModified: string;
|
|
1471
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
1472
|
+
lastMaintainedBy: string;
|
|
1473
|
+
/** P21 day_of_month on the terms */
|
|
1474
|
+
dayOfMonth: number | null;
|
|
1475
|
+
/** P21 months on the terms */
|
|
1476
|
+
months: number | null;
|
|
1477
|
+
/** P21 terms_day_of_month on the terms */
|
|
1478
|
+
termsDayOfMonth: number | null;
|
|
1479
|
+
/** P21 terms_months on the terms */
|
|
1480
|
+
termsMonths: number | null;
|
|
1481
|
+
/** P21 net_day_of_month2 on the terms */
|
|
1482
|
+
netDayOfMonth2: number | null;
|
|
1483
|
+
/** P21 terms_day_of_month2 on the terms */
|
|
1484
|
+
termsDayOfMonth2: number | null;
|
|
1485
|
+
/** P21 downpayment_pct on the terms */
|
|
1486
|
+
downpaymentPct: number | null;
|
|
1487
|
+
/** P21 use_current_month_net_day on the terms (max 1 chars) */
|
|
1488
|
+
useCurrentMonthNetDay: string;
|
|
1489
|
+
/** P21 use_current_month_terms_day on the terms (max 1 chars) */
|
|
1490
|
+
useCurrentMonthTermsDay: string;
|
|
1491
|
+
/** P21 billing_cycle_cutoff_day on the terms */
|
|
1492
|
+
billingCycleCutoffDay: number;
|
|
1493
|
+
/** P21 terms_type on the terms */
|
|
1494
|
+
termsType: number;
|
|
1495
|
+
/** P21 creditcard_required_flag on the terms (max 1 chars) */
|
|
1496
|
+
creditcardRequiredFlag: string;
|
|
1497
|
+
/** P21 discount_inv_mast_uid on the terms */
|
|
1498
|
+
discountInvMastUid: number | null;
|
|
1499
|
+
/** P21 cash_discount_eligible_flag on the terms (max 1 chars) */
|
|
1500
|
+
cashDiscountEligibleFlag: string;
|
|
1501
|
+
/** P21 merch_credit_only_flag on the terms (max 1 chars) */
|
|
1502
|
+
merchCreditOnlyFlag: string | null;
|
|
1503
|
+
/** P21 exclude_direct_shipment_terms on the terms (max 1 chars) */
|
|
1504
|
+
excludeDirectShipmentTerms: string | null;
|
|
1505
|
+
/** P21 direct_shipment_terms_desc on the terms (max 20 chars) */
|
|
1506
|
+
directShipmentTermsDesc: string | null;
|
|
1507
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1508
|
+
updateCd: number;
|
|
1509
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1510
|
+
processCd: number;
|
|
1511
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1512
|
+
statusCd: number;
|
|
1513
|
+
[key: string]: unknown;
|
|
1514
|
+
}
|
|
1515
|
+
/** Returned by: api.p21Core.terms.list(params) */
|
|
1516
|
+
export type TermsListData = TermsListItem[];
|
|
1517
|
+
/**
|
|
1518
|
+
* Get Terms
|
|
1519
|
+
* Response data for GET /terms/{termsId} — MINIMUM fields, extras pass through
|
|
1520
|
+
*
|
|
1521
|
+
* Returned by: api.p21Core.terms.get(termsId)
|
|
1522
|
+
*/
|
|
1523
|
+
export type TermsGetData = TermsListItem;
|
|
1524
|
+
/**
|
|
1525
|
+
* List User Defined Column Rows
|
|
1526
|
+
* Response data for GET /user-defined-column — MINIMUM fields, extras pass through
|
|
1527
|
+
*
|
|
1528
|
+
* Returned by: api.p21Core.userDefinedColumn.list(params) (array items)
|
|
1529
|
+
* Returned by: api.p21Core.userDefinedColumn.get(userDefinedColumnUid)
|
|
1530
|
+
*/
|
|
1531
|
+
export interface UserDefinedColumnListItem {
|
|
1532
|
+
/** P21 user defined column UID (unique row ID) */
|
|
1533
|
+
userDefinedColumnUid: number;
|
|
1534
|
+
/** P21 base table the column belongs to (max 40 chars) */
|
|
1535
|
+
baseTable: string;
|
|
1536
|
+
/** P21 column name (max 40 chars) */
|
|
1537
|
+
columnName: string;
|
|
1538
|
+
/** P21 data type of the column (max 10 chars) */
|
|
1539
|
+
dataType: string;
|
|
1540
|
+
/** P21 data length of the column */
|
|
1541
|
+
dataLength: number;
|
|
1542
|
+
/** P21 data scale of the column */
|
|
1543
|
+
dataScale: number | null;
|
|
1544
|
+
/** Column description (max 255 chars) */
|
|
1545
|
+
columnDescription: string;
|
|
1546
|
+
/** Column label (max 255 chars) */
|
|
1547
|
+
columnLabel: string;
|
|
1548
|
+
/** P21 new table name for the column (max 255 chars) */
|
|
1549
|
+
newTableName: string;
|
|
1550
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1551
|
+
dateCreated: string;
|
|
1552
|
+
/** P21 user who created the row (max 255 chars) */
|
|
1553
|
+
createdBy: string;
|
|
1554
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1555
|
+
dateLastModified: string;
|
|
1556
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
1557
|
+
lastMaintainedBy: string;
|
|
1558
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1559
|
+
updateCd: number;
|
|
1560
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1561
|
+
processCd: number;
|
|
1562
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1563
|
+
statusCd: number;
|
|
1564
|
+
[key: string]: unknown;
|
|
1565
|
+
}
|
|
1566
|
+
/** Returned by: api.p21Core.userDefinedColumn.list(params) */
|
|
1567
|
+
export type UserDefinedColumnListData = UserDefinedColumnListItem[];
|
|
1568
|
+
/**
|
|
1569
|
+
* Get User Defined Column
|
|
1570
|
+
* Response data for GET /user-defined-column/{userDefinedColumnUid} — MINIMUM fields, extras pass
|
|
1571
|
+
* through
|
|
1572
|
+
*
|
|
1573
|
+
* Returned by: api.p21Core.userDefinedColumn.get(userDefinedColumnUid)
|
|
1574
|
+
*/
|
|
1575
|
+
export type UserDefinedColumnGetData = UserDefinedColumnListItem;
|
|
1576
|
+
/**
|
|
1577
|
+
* List Users Rows
|
|
1578
|
+
* Response data for GET /users — MINIMUM fields, extras pass through
|
|
1579
|
+
*
|
|
1580
|
+
* Returned by: api.p21Core.users.list(params) (array items)
|
|
1581
|
+
* Returned by: api.p21Core.users.get(id)
|
|
1582
|
+
*/
|
|
1583
|
+
export interface UsersListItem {
|
|
1584
|
+
/** P21 user ID (max 30 chars) */
|
|
1585
|
+
id: string;
|
|
1586
|
+
/** Name (max 40 chars) */
|
|
1587
|
+
name: string;
|
|
1588
|
+
/** P21 password credential (value not described) (max 40 chars) */
|
|
1589
|
+
password: string | null;
|
|
1590
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1591
|
+
dateCreated: string;
|
|
1592
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1593
|
+
dateLastModified: string;
|
|
1594
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
1595
|
+
lastMaintainedBy: string;
|
|
1596
|
+
/** Y when the user is active in P21 (max 1 chars) */
|
|
1597
|
+
active: string;
|
|
1598
|
+
/** Y when P21 marks the row deleted (max 1 chars) */
|
|
1599
|
+
deleteFlag: string;
|
|
1600
|
+
/** P21 language ID (language.language_id) (max 8 chars) */
|
|
1601
|
+
languageId: string;
|
|
1602
|
+
/** P21 default company for the user (max 8 chars) */
|
|
1603
|
+
defaultCompany: string | null;
|
|
1604
|
+
/** P21 default branch for the user (max 8 chars) */
|
|
1605
|
+
defaultBranch: string | null;
|
|
1606
|
+
/** P21 default_quote_order on the users (max 1 chars) */
|
|
1607
|
+
defaultQuoteOrder: string;
|
|
1608
|
+
/** P21 create_customers on the users (max 1 chars) */
|
|
1609
|
+
createCustomers: string | null;
|
|
1610
|
+
/** P21 create_ship_tos on the users (max 1 chars) */
|
|
1611
|
+
createShipTos: string | null;
|
|
1612
|
+
/** P21 default location ID for the user */
|
|
1613
|
+
defaultLocationId: number | null;
|
|
1614
|
+
/** P21 prompt_before_clearing on the users (max 1 chars) */
|
|
1615
|
+
promptBeforeClearing: string | null;
|
|
1616
|
+
/** P21 default customer ID for the user */
|
|
1617
|
+
defaultCustomerId: number | null;
|
|
1618
|
+
/** P21 remote_user on the users (max 1 chars) */
|
|
1619
|
+
remoteUser: string;
|
|
1620
|
+
/** P21 company_security on the users (max 1 chars) */
|
|
1621
|
+
companySecurity: string;
|
|
1622
|
+
/** P21 window_security on the users (max 1 chars) */
|
|
1623
|
+
windowSecurity: string;
|
|
1624
|
+
/** P21 system_security on the users (max 1 chars) */
|
|
1625
|
+
systemSecurity: string;
|
|
1626
|
+
/** P21 create_items_at_oe on the users (max 1 chars) */
|
|
1627
|
+
createItemsAtOe: string | null;
|
|
1628
|
+
/** P21 default_application on the users (max 40 chars) */
|
|
1629
|
+
defaultApplication: string | null;
|
|
1630
|
+
/** P21 script_path on the users (max 255 chars) */
|
|
1631
|
+
scriptPath: string | null;
|
|
1632
|
+
/** P21 create_po_from_oe on the users */
|
|
1633
|
+
createPoFromOe: number;
|
|
1634
|
+
/** P21 role UID assigned to the user */
|
|
1635
|
+
roleUid: number;
|
|
1636
|
+
/** P21 designer_rights on the users (max 8 chars) */
|
|
1637
|
+
designerRights: string;
|
|
1638
|
+
/** P21 contact ID for the user (max 16 chars) */
|
|
1639
|
+
contactId: string | null;
|
|
1640
|
+
/** P21 print_preview_zoom_percentage on the users */
|
|
1641
|
+
printPreviewZoomPercentage: number;
|
|
1642
|
+
/** P21 class ID (max 8 chars) */
|
|
1643
|
+
classId: string | null;
|
|
1644
|
+
/** P21 auto_generate_transfer_in_oe on the users (max 1 chars) */
|
|
1645
|
+
autoGenerateTransferInOe: string;
|
|
1646
|
+
/** User email address (max 255 chars) */
|
|
1647
|
+
emailAddress: string | null;
|
|
1648
|
+
/** P21 receive_system_alerts on the users (max 1 chars) */
|
|
1649
|
+
receiveSystemAlerts: string;
|
|
1650
|
+
/** P21 sales rep ID for the user (max 16 chars) */
|
|
1651
|
+
salesrepId: string | null;
|
|
1652
|
+
/** P21 receive_import_failure_alert on the users (max 1 chars) */
|
|
1653
|
+
receiveImportFailureAlert: string;
|
|
1654
|
+
/** P21 default_to_advanced_search on the users (max 1 chars) */
|
|
1655
|
+
defaultToAdvancedSearch: string;
|
|
1656
|
+
/** P21 adj_qty_available_at_oe on the users */
|
|
1657
|
+
adjQtyAvailableAtOe: number;
|
|
1658
|
+
/** P21 link_stock_item_to_po on the users (max 1 chars) */
|
|
1659
|
+
linkStockItemToPo: string;
|
|
1660
|
+
/** P21 historical_cost_in_sales_hist on the users (max 1 chars) */
|
|
1661
|
+
historicalCostInSalesHist: string;
|
|
1662
|
+
/** P21 order_cost_basis_order_cost on the users (max 1 chars) */
|
|
1663
|
+
orderCostBasisOrderCost: string;
|
|
1664
|
+
/** P21 order_cost_basis_comm_cost on the users (max 1 chars) */
|
|
1665
|
+
orderCostBasisCommCost: string;
|
|
1666
|
+
/** P21 order_cost_basis_other_cost on the users (max 1 chars) */
|
|
1667
|
+
orderCostBasisOtherCost: string;
|
|
1668
|
+
/** P21 default_costing_basis on the users */
|
|
1669
|
+
defaultCostingBasis: number;
|
|
1670
|
+
/** P21 time_zone_cd on the users */
|
|
1671
|
+
timeZoneCd: number | null;
|
|
1672
|
+
/** P21 current_cashdrawer_counter on the users */
|
|
1673
|
+
currentCashdrawerCounter: number;
|
|
1674
|
+
/** P21 max_cashdrawer_counter on the users */
|
|
1675
|
+
maxCashdrawerCounter: number;
|
|
1676
|
+
/** P21 current_oe_line_counter on the users */
|
|
1677
|
+
currentOeLineCounter: number;
|
|
1678
|
+
/** P21 max_oe_line_counter on the users */
|
|
1679
|
+
maxOeLineCounter: number;
|
|
1680
|
+
/** P21 current_invoice_line_counter on the users */
|
|
1681
|
+
currentInvoiceLineCounter: number;
|
|
1682
|
+
/** P21 max_invoice_line_counter on the users */
|
|
1683
|
+
maxInvoiceLineCounter: number;
|
|
1684
|
+
/** P21 task_visibility_cd on the users */
|
|
1685
|
+
taskVisibilityCd: number;
|
|
1686
|
+
/** P21 create_vendor_rfq_cd on the users */
|
|
1687
|
+
createVendorRfqCd: number;
|
|
1688
|
+
/** P21 update_cost_from_rfq_receipt on the users (max 1 chars) */
|
|
1689
|
+
updateCostFromRfqReceipt: string;
|
|
1690
|
+
/** P21 display_transaction_tasks on the users (max 1 chars) */
|
|
1691
|
+
displayTransactionTasks: string;
|
|
1692
|
+
/** P21 allow_nonstock_tbo on the users (max 1 chars) */
|
|
1693
|
+
allowNonstockTbo: string;
|
|
1694
|
+
/** P21 current_inv_tran_counter on the users */
|
|
1695
|
+
currentInvTranCounter: number;
|
|
1696
|
+
/** P21 max_inv_tran_counter on the users */
|
|
1697
|
+
maxInvTranCounter: number;
|
|
1698
|
+
/** P21 current_gl_counter on the users */
|
|
1699
|
+
currentGlCounter: number;
|
|
1700
|
+
/** P21 max_gl_counter on the users */
|
|
1701
|
+
maxGlCounter: number;
|
|
1702
|
+
/** P21 create_contract_from_oe on the users (max 1 chars) */
|
|
1703
|
+
createContractFromOe: string;
|
|
1704
|
+
/** P21 mgmt_allow_branch_edit on the users (max 1 chars) */
|
|
1705
|
+
mgmtAllowBranchEdit: string;
|
|
1706
|
+
/** P21 mgmt_use_default_branch on the users (max 1 chars) */
|
|
1707
|
+
mgmtUseDefaultBranch: string;
|
|
1708
|
+
/** P21 oe_price_library_override_flag on the users (max 1 chars) */
|
|
1709
|
+
oePriceLibraryOverrideFlag: string;
|
|
1710
|
+
/** P21 default_label_printer on the users (max 255 chars) */
|
|
1711
|
+
defaultLabelPrinter: string | null;
|
|
1712
|
+
/** P21 update_prospects_only_flag on the users (max 1 chars) */
|
|
1713
|
+
updateProspectsOnlyFlag: string | null;
|
|
1714
|
+
/** P21 default_item_search on the users */
|
|
1715
|
+
defaultItemSearch: number;
|
|
1716
|
+
/** P21 suppress_manual_adj_alloc_flag on the users (max 1 chars) */
|
|
1717
|
+
suppressManualAdjAllocFlag: string | null;
|
|
1718
|
+
/** P21 shipping_control_flag on the users (max 1 chars) */
|
|
1719
|
+
shippingControlFlag: string;
|
|
1720
|
+
/** P21 cnvrt_prospect_to_customer_oe on the users (max 1 chars) */
|
|
1721
|
+
cnvrtProspectToCustomerOe: string;
|
|
1722
|
+
/** P21 auto_display_rooms on the users (max 1 chars) */
|
|
1723
|
+
autoDisplayRooms: string;
|
|
1724
|
+
/** P21 display_purchaseprice_breaks on the users (max 1 chars) */
|
|
1725
|
+
displayPurchasepriceBreaks: string;
|
|
1726
|
+
/** P21 default_salesrep_on_order on the users (max 16 chars) */
|
|
1727
|
+
defaultSalesrepOnOrder: string | null;
|
|
1728
|
+
/** P21 default_rep_on_comm_rpt_flag on the users (max 1 chars) */
|
|
1729
|
+
defaultRepOnCommRptFlag: string;
|
|
1730
|
+
/** P21 order_validation_password credential (value not described) (max 255 chars) */
|
|
1731
|
+
orderValidationPassword: string | null;
|
|
1732
|
+
/** P21 machine_name on the users (max 255 chars) */
|
|
1733
|
+
machineName: string | null;
|
|
1734
|
+
/** P21 sales_supervisor_flag on the users (max 1 chars) */
|
|
1735
|
+
salesSupervisorFlag: string;
|
|
1736
|
+
/** P21 vacation_end_date on the users (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1737
|
+
vacationEndDate: string | null;
|
|
1738
|
+
/** P21 doe_salesrep_id on the users (max 16 chars) */
|
|
1739
|
+
doeSalesrepId: string | null;
|
|
1740
|
+
/** P21 doe_user_flag on the users (max 1 chars) */
|
|
1741
|
+
doeUserFlag: string;
|
|
1742
|
+
/** P21 vacation_end_date_mod_flag on the users (max 1 chars) */
|
|
1743
|
+
vacationEndDateModFlag: string;
|
|
1744
|
+
/** P21 users UID (unique row ID) */
|
|
1745
|
+
usersUid: number;
|
|
1746
|
+
/** P21 inv_group_hdr_uid on the users */
|
|
1747
|
+
invGroupHdrUid: number | null;
|
|
1748
|
+
/** P21 use_po_approval_threshold_flag on the users (max 1 chars) */
|
|
1749
|
+
usePoApprovalThresholdFlag: string | null;
|
|
1750
|
+
/** P21 po_approval_threshold on the users */
|
|
1751
|
+
poApprovalThreshold: number | null;
|
|
1752
|
+
/** P21 prev_requests_search on the users (max 1 chars) */
|
|
1753
|
+
prevRequestsSearch: string;
|
|
1754
|
+
/** P21 view_cost_on_oe_line on the users (max 1 chars) */
|
|
1755
|
+
viewCostOnOeLine: string;
|
|
1756
|
+
/** P21 bypass_check_verify_password credential (value not described) (max 255 chars) */
|
|
1757
|
+
bypassCheckVerifyPassword: string | null;
|
|
1758
|
+
/** P21 active_directory_role on the users (max 255 chars) */
|
|
1759
|
+
activeDirectoryRole: string | null;
|
|
1760
|
+
/** P21 update_branch_oe_reports_flag on the users (max 1 chars) */
|
|
1761
|
+
updateBranchOeReportsFlag: string | null;
|
|
1762
|
+
/** P21 oe_allow_shipment_edits on the users (max 1 chars) */
|
|
1763
|
+
oeAllowShipmentEdits: string | null;
|
|
1764
|
+
/** P21 oe_allow_packing_list_reprint on the users (max 1 chars) */
|
|
1765
|
+
oeAllowPackingListReprint: string | null;
|
|
1766
|
+
/** P21 salesrep_security_type on the users (max 1 chars) */
|
|
1767
|
+
salesrepSecurityType: string | null;
|
|
1768
|
+
/** P21 sales rep ID linked to the user (max 16 chars) */
|
|
1769
|
+
userSalesrepId: string | null;
|
|
1770
|
+
/** P21 default_as_taker_flag on the users (max 1 chars) */
|
|
1771
|
+
defaultAsTakerFlag: string;
|
|
1772
|
+
/** P21 make_items_sellable_in_oe_flag on the users (max 1 chars) */
|
|
1773
|
+
makeItemsSellableInOeFlag: string;
|
|
1774
|
+
/** P21 add_item_locations_in_oe_flag on the users (max 1 chars) */
|
|
1775
|
+
addItemLocationsInOeFlag: string;
|
|
1776
|
+
/** P21 confirm_dea_pt_flag on the users (max 1 chars) */
|
|
1777
|
+
confirmDeaPtFlag: string | null;
|
|
1778
|
+
/** P21 strategic_pricing_role_uid on the users */
|
|
1779
|
+
strategicPricingRoleUid: number | null;
|
|
1780
|
+
/** P21 search_item_catalog_flag on the users (max 1 chars) */
|
|
1781
|
+
searchItemCatalogFlag: string;
|
|
1782
|
+
/** P21 clear_item_catalog_flag on the users (max 1 chars) */
|
|
1783
|
+
clearItemCatalogFlag: string;
|
|
1784
|
+
/** P21 cash_drawer_id on the users (max 8 chars) */
|
|
1785
|
+
cashDrawerId: string | null;
|
|
1786
|
+
/** P21 dflt_wwms_forms_printer on the users (max 255 chars) */
|
|
1787
|
+
dfltWwmsFormsPrinter: string | null;
|
|
1788
|
+
/** P21 show_components_in_sales_hist on the users (max 1 chars) */
|
|
1789
|
+
showComponentsInSalesHist: string | null;
|
|
1790
|
+
/** P21 field_chooser_perm_cd on the users */
|
|
1791
|
+
fieldChooserPermCd: number;
|
|
1792
|
+
/** P21 customer_profit_role_uid on the users */
|
|
1793
|
+
customerProfitRoleUid: number | null;
|
|
1794
|
+
/** P21 default_send_to_outlook_flag on the users (max 1 chars) */
|
|
1795
|
+
defaultSendToOutlookFlag: string | null;
|
|
1796
|
+
/** P21 display_open_quote_lines_cd on the users */
|
|
1797
|
+
displayOpenQuoteLinesCd: number | null;
|
|
1798
|
+
/** P21 create_items_at_soe on the users (max 1 chars) */
|
|
1799
|
+
createItemsAtSoe: string | null;
|
|
1800
|
+
/** P21 allow_post_to_closed_gl_period on the users (max 1 chars) */
|
|
1801
|
+
allowPostToClosedGlPeriod: string | null;
|
|
1802
|
+
/** P21 restricted_class_override_flag on the users (max 1 chars) */
|
|
1803
|
+
restrictedClassOverrideFlag: string | null;
|
|
1804
|
+
/** P21 allow_ship_to_edit_in_oe_flag on the users (max 1 chars) */
|
|
1805
|
+
allowShipToEditInOeFlag: string | null;
|
|
1806
|
+
/** P21 show_cc_payment_acct_on_save on the users */
|
|
1807
|
+
showCcPaymentAcctOnSave: number | null;
|
|
1808
|
+
/** P21 show_ar_cc_failed on the users (max 1 chars) */
|
|
1809
|
+
showArCcFailed: string | null;
|
|
1810
|
+
/** P21 override_cust_pallet_warn_flag on the users (max 1 chars) */
|
|
1811
|
+
overrideCustPalletWarnFlag: string;
|
|
1812
|
+
/** P21 logo_path_filename on the users (max 255 chars) */
|
|
1813
|
+
logoPathFilename: string | null;
|
|
1814
|
+
/** P21 user_report_path on the users (max 255 chars) */
|
|
1815
|
+
userReportPath: string | null;
|
|
1816
|
+
/** P21 allow_shipment_confirmation on the users (max 1 chars) */
|
|
1817
|
+
allowShipmentConfirmation: string | null;
|
|
1818
|
+
/** P21 view_vendor_type_cd on the users */
|
|
1819
|
+
viewVendorTypeCd: number;
|
|
1820
|
+
/** P21 over_redeem_rewards_flag on the users (max 1 chars) */
|
|
1821
|
+
overRedeemRewardsFlag: string;
|
|
1822
|
+
/** P21 extended_item_info_porg_flag on the users (max 1 chars) */
|
|
1823
|
+
extendedItemInfoPorgFlag: string | null;
|
|
1824
|
+
/** P21 fedex_label_printer_path on the users (max 255 chars) */
|
|
1825
|
+
fedexLabelPrinterPath: string | null;
|
|
1826
|
+
/** P21 default_item_search_in_imi on the users (max 1 chars) */
|
|
1827
|
+
defaultItemSearchInImi: string;
|
|
1828
|
+
/** P21 po_threshold_currency_id on the users */
|
|
1829
|
+
poThresholdCurrencyId: number | null;
|
|
1830
|
+
/** P21 add_customer_part_number_in_oe on the users (max 1 chars) */
|
|
1831
|
+
addCustomerPartNumberInOe: string | null;
|
|
1832
|
+
/** P21 override_754_flag on the users (max 1 chars) */
|
|
1833
|
+
override754Flag: string;
|
|
1834
|
+
/** P21 allow_add_labor_to_completed_po on the users (max 1 chars) */
|
|
1835
|
+
allowAddLaborToCompletedPo: string;
|
|
1836
|
+
/** P21 allow_postprint_edit_labor_est on the users (max 1 chars) */
|
|
1837
|
+
allowPostprintEditLaborEst: string;
|
|
1838
|
+
/** P21 do_not_export_carrier_po_flag on the users (max 1 chars) */
|
|
1839
|
+
doNotExportCarrierPoFlag: string | null;
|
|
1840
|
+
/** P21 network_name on the users (max 30 chars) */
|
|
1841
|
+
networkName: string | null;
|
|
1842
|
+
/** P21 order_cost_basis_rebate_cost on the users (max 1 chars) */
|
|
1843
|
+
orderCostBasisRebateCost: string;
|
|
1844
|
+
/** P21 convert_quote_to_order_prompt_flag on the users (max 1 chars) */
|
|
1845
|
+
convertQuoteToOrderPromptFlag: string | null;
|
|
1846
|
+
/** P21 default_pick_ticket_printer on the users (max 255 chars) */
|
|
1847
|
+
defaultPickTicketPrinter: string | null;
|
|
1848
|
+
/** P21 default_invoice_printer on the users (max 255 chars) */
|
|
1849
|
+
defaultInvoicePrinter: string | null;
|
|
1850
|
+
/** P21 user_signature_path on the users (max 255 chars) */
|
|
1851
|
+
userSignaturePath: string | null;
|
|
1852
|
+
/** P21 disable_item_category_tree_by_desc_flag on the users (max 1 chars) */
|
|
1853
|
+
disableItemCategoryTreeByDescFlag: string;
|
|
1854
|
+
/** P21 imi_default_user_location on the users (max 1 chars) */
|
|
1855
|
+
imiDefaultUserLocation: string;
|
|
1856
|
+
/** P21 dflt_ucc128_label_printer on the users (max 255 chars) */
|
|
1857
|
+
dfltUcc128LabelPrinter: string | null;
|
|
1858
|
+
/** P21 allow_edi_855_manual_orders_flag on the users (max 1 chars) */
|
|
1859
|
+
allowEdi855ManualOrdersFlag: string | null;
|
|
1860
|
+
/** P21 oe_change_customer_with_items on the users (max 1 chars) */
|
|
1861
|
+
oeChangeCustomerWithItems: string;
|
|
1862
|
+
/** P21 allow_edit_labor_time_entry on the users (max 1 chars) */
|
|
1863
|
+
allowEditLaborTimeEntry: string;
|
|
1864
|
+
/** P21 email_signature on the users (max 255 chars) */
|
|
1865
|
+
emailSignature: string | null;
|
|
1866
|
+
/** P21 default_bss_customer_id on the users */
|
|
1867
|
+
defaultBssCustomerId: number | null;
|
|
1868
|
+
/** P21 rebuild_drill_security_flag on the users (max 1 chars) */
|
|
1869
|
+
rebuildDrillSecurityFlag: string;
|
|
1870
|
+
/** P21 check_creation_role on the users */
|
|
1871
|
+
checkCreationRole: number | null;
|
|
1872
|
+
/** P21 show_cc_on_save_cash_receipts on the users (max 1 chars) */
|
|
1873
|
+
showCcOnSaveCashReceipts: string | null;
|
|
1874
|
+
/** P21 p21_client_log_path on the users (max 255 chars) */
|
|
1875
|
+
p21ClientLogPath: string | null;
|
|
1876
|
+
/** P21 enterprise_search_url on the users (max 255 chars) */
|
|
1877
|
+
enterpriseSearchUrl: string | null;
|
|
1878
|
+
/** P21 allow_report_creation_in_studio on the users */
|
|
1879
|
+
allowReportCreationInStudio: number;
|
|
1880
|
+
/** P21 region on the users (max 255 chars) */
|
|
1881
|
+
region: string | null;
|
|
1882
|
+
/** P21 docstar_server_password credential (value not described) (max 255 chars) */
|
|
1883
|
+
docstarServerPassword: string | null;
|
|
1884
|
+
/** P21 pricing_pros_approver_flag on the users (max 1 chars) */
|
|
1885
|
+
pricingProsApproverFlag: string | null;
|
|
1886
|
+
/** P21 taker contact ID for the user (max 16 chars) */
|
|
1887
|
+
takerContactId: string | null;
|
|
1888
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1889
|
+
updateCd: number;
|
|
1890
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1891
|
+
processCd: number;
|
|
1892
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1893
|
+
statusCd: number;
|
|
1894
|
+
[key: string]: unknown;
|
|
1895
|
+
}
|
|
1896
|
+
/** Returned by: api.p21Core.users.list(params) */
|
|
1897
|
+
export type UsersListData = UsersListItem[];
|
|
1898
|
+
/**
|
|
1899
|
+
* Get Users
|
|
1900
|
+
* Response data for GET /users/{id} — MINIMUM fields, extras pass through
|
|
1901
|
+
*
|
|
1902
|
+
* Returned by: api.p21Core.users.get(id)
|
|
1903
|
+
*/
|
|
1904
|
+
export type UsersGetData = UsersListItem;
|
|
1905
|
+
export interface P21CoreClientSpec {
|
|
1906
|
+
address: {
|
|
1907
|
+
/**
|
|
1908
|
+
* List Addresses
|
|
1909
|
+
* Call: api.p21Core.address.list(params)
|
|
1910
|
+
*
|
|
1911
|
+
* Response data, each item: A Prophet 21 address with its mailing and physical lines and
|
|
1912
|
+
* Augur's status, enabled and default flags
|
|
1913
|
+
*
|
|
1914
|
+
* Errors:
|
|
1915
|
+
* 400: orderBy is not column|ASC or column|DESC on an address column.
|
|
1916
|
+
*
|
|
1917
|
+
* GET https://p21-core.augur-api.com/address
|
|
1918
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1address/get
|
|
1919
|
+
*
|
|
1920
|
+
* @param params AddressListParams (query string)
|
|
1921
|
+
* @returns BaseResponse whose `data` is AddressListData
|
|
1922
|
+
*/
|
|
1923
|
+
list: (params?: AddressListParams) => Promise<BaseResponse<AddressListData>>;
|
|
1924
|
+
/**
|
|
1925
|
+
* Get Address Details
|
|
1926
|
+
* Call: api.p21Core.address.get(id)
|
|
1927
|
+
*
|
|
1928
|
+
* Response data: A Prophet 21 address with its mailing and physical lines and Augur's status,
|
|
1929
|
+
* enabled and default flags
|
|
1930
|
+
*
|
|
1931
|
+
* Errors:
|
|
1932
|
+
* 404: No address row with this id.
|
|
1933
|
+
*
|
|
1934
|
+
* GET https://p21-core.augur-api.com/address/{id}
|
|
1935
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1address~1{id}/get
|
|
1936
|
+
*
|
|
1937
|
+
* @param id Prophet 21 address ID
|
|
1938
|
+
* @param params AddressGetParams (query string)
|
|
1939
|
+
* @returns BaseResponse whose `data` is AddressGetData
|
|
1940
|
+
*/
|
|
1941
|
+
get: (id: number, params?: AddressGetParams) => Promise<BaseResponse<AddressGetData>>;
|
|
1942
|
+
corpAddress: {
|
|
1943
|
+
/**
|
|
1944
|
+
* Get Corporate Address List
|
|
1945
|
+
* Call: api.p21Core.address.corpAddress.list(id, params)
|
|
1946
|
+
*
|
|
1947
|
+
* Response data, each item: A Prophet 21 address with its mailing and physical lines and
|
|
1948
|
+
* Augur's status, enabled and default flags
|
|
1949
|
+
*
|
|
1950
|
+
* Errors:
|
|
1951
|
+
* 400: orderBy is not column|ASC or column|DESC on an address column.
|
|
1952
|
+
* 404: No address row with this id.
|
|
1953
|
+
*
|
|
1954
|
+
* GET https://p21-core.augur-api.com/address/{id}/corp-address
|
|
1955
|
+
* Contract:
|
|
1956
|
+
* https://p21-core.augur-api.com/openapi.json#/paths/~1address~1{id}~1corp-address/get
|
|
1957
|
+
*
|
|
1958
|
+
* @param id Prophet 21 address ID
|
|
1959
|
+
* @param params AddressCorpAddressListParams (query string)
|
|
1960
|
+
* @returns BaseResponse whose `data` is AddressCorpAddressListData
|
|
1961
|
+
*/
|
|
1962
|
+
list: (id: number, params?: AddressCorpAddressListParams) => Promise<BaseResponse<AddressCorpAddressListData>>;
|
|
1963
|
+
};
|
|
1964
|
+
default: {
|
|
1965
|
+
/**
|
|
1966
|
+
* Set Address as default Shipping Method
|
|
1967
|
+
* Call: api.p21Core.address.default.list(id)
|
|
1968
|
+
*
|
|
1969
|
+
* Response data: A Prophet 21 address with its mailing and physical lines and Augur's status,
|
|
1970
|
+
* enabled and default flags
|
|
1971
|
+
*
|
|
1972
|
+
* Errors:
|
|
1973
|
+
* 404: No address row with this id.
|
|
1974
|
+
*
|
|
1975
|
+
* GET https://p21-core.augur-api.com/address/{id}/default
|
|
1976
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1address~1{id}~1default/get
|
|
1977
|
+
*
|
|
1978
|
+
* @param id Prophet 21 address ID
|
|
1979
|
+
* @param params AddressDefaultListParams (query string)
|
|
1980
|
+
* @returns BaseResponse whose `data` is AddressDefaultListData
|
|
1981
|
+
*/
|
|
1982
|
+
list: (id: number, params?: AddressDefaultListParams) => Promise<BaseResponse<AddressDefaultListData>>;
|
|
1983
|
+
};
|
|
1984
|
+
enable: {
|
|
1985
|
+
/**
|
|
1986
|
+
* Enable/disable Address as Shipping Method
|
|
1987
|
+
* Call: api.p21Core.address.enable.get(id, params)
|
|
1988
|
+
*
|
|
1989
|
+
* Response data: A Prophet 21 address with its mailing and physical lines and Augur's status,
|
|
1990
|
+
* enabled and default flags
|
|
1991
|
+
*
|
|
1992
|
+
* Errors:
|
|
1993
|
+
* 404: No address row with this id.
|
|
1994
|
+
*
|
|
1995
|
+
* GET https://p21-core.augur-api.com/address/{id}/enable
|
|
1996
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1address~1{id}~1enable/get
|
|
1997
|
+
*
|
|
1998
|
+
* @param id Prophet 21 address ID
|
|
1999
|
+
* @param params AddressEnableGetParams (query string)
|
|
2000
|
+
* @returns BaseResponse whose `data` is AddressEnableGetData
|
|
2001
|
+
*/
|
|
2002
|
+
get: (id: number, params?: AddressEnableGetParams) => Promise<BaseResponse<AddressEnableGetData>>;
|
|
2003
|
+
};
|
|
2004
|
+
};
|
|
2005
|
+
branch: {
|
|
2006
|
+
/**
|
|
2007
|
+
* List Branch Rows
|
|
2008
|
+
* Call: api.p21Core.branch.list(params)
|
|
2009
|
+
*
|
|
2010
|
+
* List branch rows as Augur holds them locally
|
|
2011
|
+
*
|
|
2012
|
+
* Errors:
|
|
2013
|
+
* 400: DeleteFlag is not Y or N, or companyUid is not a number, or orderBy is not one branch
|
|
2014
|
+
* column with ASC or DESC.
|
|
2015
|
+
*
|
|
2016
|
+
* GET https://p21-core.augur-api.com/branch
|
|
2017
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1branch/get
|
|
2018
|
+
*
|
|
2019
|
+
* @param params BranchListParams (query string)
|
|
2020
|
+
* @returns BaseResponse whose `data` is BranchListData
|
|
2021
|
+
*/
|
|
2022
|
+
list: (params?: BranchListParams) => Promise<BaseResponse<BranchListData>>;
|
|
2023
|
+
/**
|
|
2024
|
+
* Get Branch
|
|
2025
|
+
* Call: api.p21Core.branch.get(branchUid)
|
|
2026
|
+
*
|
|
2027
|
+
* Get one branch row as Augur holds it locally
|
|
2028
|
+
*
|
|
2029
|
+
* Errors:
|
|
2030
|
+
* 404: No branch row with this branchUid.
|
|
2031
|
+
*
|
|
2032
|
+
* GET https://p21-core.augur-api.com/branch/{branchUid}
|
|
2033
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1branch~1{branchUid}/get
|
|
2034
|
+
*
|
|
2035
|
+
* @param branchUid Branch key (branch.branch_uid)
|
|
2036
|
+
* @param params BranchGetParams (query string)
|
|
2037
|
+
* @returns BaseResponse whose `data` is BranchGetData
|
|
2038
|
+
*/
|
|
2039
|
+
get: (branchUid: number, params?: BranchGetParams) => Promise<BaseResponse<BranchGetData>>;
|
|
2040
|
+
};
|
|
2041
|
+
cashDrawer: {
|
|
2042
|
+
/**
|
|
2043
|
+
* List Cash Drawers
|
|
2044
|
+
* Call: api.p21Core.cashDrawer.list(params)
|
|
2045
|
+
*
|
|
2046
|
+
* Errors:
|
|
2047
|
+
* 400: orderBy is not column|ASC or column|DESC on a cash_drawer column.
|
|
2048
|
+
*
|
|
2049
|
+
* GET https://p21-core.augur-api.com/cash-drawer
|
|
2050
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1cash-drawer/get
|
|
2051
|
+
*
|
|
2052
|
+
* @param params CashDrawerListParams (query string)
|
|
2053
|
+
* @returns BaseResponse whose `data` is CashDrawerListData
|
|
2054
|
+
*/
|
|
2055
|
+
list: (params?: CashDrawerListParams) => Promise<BaseResponse<CashDrawerListData>>;
|
|
2056
|
+
/**
|
|
2057
|
+
* Get Cash Drawer Details
|
|
2058
|
+
* Call: api.p21Core.cashDrawer.get(cashDrawerUid)
|
|
2059
|
+
*
|
|
2060
|
+
* Errors:
|
|
2061
|
+
* 404: No cash_drawer row with this cashDrawerUid.
|
|
2062
|
+
*
|
|
2063
|
+
* GET https://p21-core.augur-api.com/cash-drawer/{cashDrawerUid}
|
|
2064
|
+
* Contract:
|
|
2065
|
+
* https://p21-core.augur-api.com/openapi.json#/paths/~1cash-drawer~1{cashDrawerUid}/get
|
|
2066
|
+
*
|
|
2067
|
+
* @param cashDrawerUid Cash drawer ID
|
|
2068
|
+
* @param params CashDrawerGetParams (query string)
|
|
2069
|
+
* @returns BaseResponse whose `data` is CashDrawerGetData
|
|
2070
|
+
*/
|
|
2071
|
+
get: (cashDrawerUid: number, params?: CashDrawerGetParams) => Promise<BaseResponse<CashDrawerGetData>>;
|
|
2072
|
+
};
|
|
2073
|
+
ccProcessorXLocation: {
|
|
2074
|
+
/**
|
|
2075
|
+
* List Cc Processor X Location Rows
|
|
2076
|
+
* Call: api.p21Core.ccProcessorXLocation.list(params)
|
|
2077
|
+
*
|
|
2078
|
+
* List cc processor x location rows as Augur holds them locally
|
|
2079
|
+
*
|
|
2080
|
+
* Errors:
|
|
2081
|
+
* 400: DeleteFlag is not Y or N, or processorXLocationUid or creditcardProcessorUid is not a
|
|
2082
|
+
* number, or orderBy is not one cc_processor_x_location column with ASC or DESC.
|
|
2083
|
+
*
|
|
2084
|
+
* GET https://p21-core.augur-api.com/cc-processor-x-location
|
|
2085
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1cc-processor-x-location/get
|
|
2086
|
+
*
|
|
2087
|
+
* @param params CcProcessorXLocationListParams (query string)
|
|
2088
|
+
* @returns BaseResponse whose `data` is CcProcessorXLocationListData
|
|
2089
|
+
*/
|
|
2090
|
+
list: (params?: CcProcessorXLocationListParams) => Promise<BaseResponse<CcProcessorXLocationListData>>;
|
|
2091
|
+
/**
|
|
2092
|
+
* Get Cc Processor X Location
|
|
2093
|
+
* Call: api.p21Core.ccProcessorXLocation.get(ccProcessorXLocationUid)
|
|
2094
|
+
*
|
|
2095
|
+
* Get one cc processor x location row as Augur holds it locally
|
|
2096
|
+
*
|
|
2097
|
+
* Errors:
|
|
2098
|
+
* 404: No cc processor x location row with this ccProcessorXLocationUid.
|
|
2099
|
+
*
|
|
2100
|
+
* GET https://p21-core.augur-api.com/cc-processor-x-location/{ccProcessorXLocationUid}
|
|
2101
|
+
* Contract:
|
|
2102
|
+
* https://p21-core.augur-api.com/openapi.json#/paths/~1cc-processor-x-location~1{ccProcessorXLocationUid}/get
|
|
2103
|
+
*
|
|
2104
|
+
* @param ccProcessorXLocationUid Cc processor x location key
|
|
2105
|
+
* (cc_processor_x_location.cc_processor_x_location_uid)
|
|
2106
|
+
* @param params CcProcessorXLocationGetParams (query string)
|
|
2107
|
+
* @returns BaseResponse whose `data` is CcProcessorXLocationGetData
|
|
2108
|
+
*/
|
|
2109
|
+
get: (ccProcessorXLocationUid: number, params?: CcProcessorXLocationGetParams) => Promise<BaseResponse<CcProcessorXLocationGetData>>;
|
|
2110
|
+
};
|
|
2111
|
+
ccTables: {
|
|
2112
|
+
/**
|
|
2113
|
+
* List Cc Tables Rows
|
|
2114
|
+
* Call: api.p21Core.ccTables.list(params)
|
|
2115
|
+
*
|
|
2116
|
+
* List cc tables rows as Augur holds them locally
|
|
2117
|
+
*
|
|
2118
|
+
* Errors:
|
|
2119
|
+
* 400: OrderBy is not one cc_tables column with ASC or DESC.
|
|
2120
|
+
*
|
|
2121
|
+
* GET https://p21-core.augur-api.com/cc-tables
|
|
2122
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1cc-tables/get
|
|
2123
|
+
*
|
|
2124
|
+
* @param params CcTablesListParams (query string)
|
|
2125
|
+
* @returns BaseResponse whose `data` is CcTablesListData
|
|
2126
|
+
*/
|
|
2127
|
+
list: (params?: CcTablesListParams) => Promise<BaseResponse<CcTablesListData>>;
|
|
2128
|
+
/**
|
|
2129
|
+
* Get Cc Tables
|
|
2130
|
+
* Call: api.p21Core.ccTables.get(tableUid)
|
|
2131
|
+
*
|
|
2132
|
+
* Get one cc tables row as Augur holds it locally
|
|
2133
|
+
*
|
|
2134
|
+
* Errors:
|
|
2135
|
+
* 404: No cc tables row with this tableUid.
|
|
2136
|
+
*
|
|
2137
|
+
* GET https://p21-core.augur-api.com/cc-tables/{tableUid}
|
|
2138
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1cc-tables~1{tableUid}/get
|
|
2139
|
+
*
|
|
2140
|
+
* @param tableUid Cc tables key (cc_tables.table_uid)
|
|
2141
|
+
* @param params CcTablesGetParams (query string)
|
|
2142
|
+
* @returns BaseResponse whose `data` is CcTablesGetData
|
|
2143
|
+
*/
|
|
2144
|
+
get: (tableUid: number, params?: CcTablesGetParams) => Promise<BaseResponse<CcTablesGetData>>;
|
|
2145
|
+
};
|
|
2146
|
+
codeP21: {
|
|
2147
|
+
/**
|
|
2148
|
+
* List P21 Codes
|
|
2149
|
+
* Call: api.p21Core.codeP21.list(params)
|
|
2150
|
+
*
|
|
2151
|
+
* Errors:
|
|
2152
|
+
* 400: orderBy is not column|ASC or column|DESC on a code_p21 column.
|
|
2153
|
+
*
|
|
2154
|
+
* GET https://p21-core.augur-api.com/code-p21
|
|
2155
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1code-p21/get
|
|
2156
|
+
*
|
|
2157
|
+
* @param params CodeP21ListParams (query string)
|
|
2158
|
+
* @returns BaseResponse whose `data` is CodeP21ListData
|
|
2159
|
+
*/
|
|
2160
|
+
list: (params?: CodeP21ListParams) => Promise<BaseResponse<CodeP21ListData>>;
|
|
2161
|
+
/**
|
|
2162
|
+
* Get P21 Code Details
|
|
2163
|
+
* Call: api.p21Core.codeP21.get(codeUid)
|
|
2164
|
+
*
|
|
2165
|
+
* Errors:
|
|
2166
|
+
* 404: No code_p21 row with this codeUid.
|
|
2167
|
+
*
|
|
2168
|
+
* GET https://p21-core.augur-api.com/code-p21/{codeUid}
|
|
2169
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1code-p21~1{codeUid}/get
|
|
2170
|
+
*
|
|
2171
|
+
* @param codeUid Prophet 21 code ID
|
|
2172
|
+
* @param params CodeP21GetParams (query string)
|
|
2173
|
+
* @returns BaseResponse whose `data` is CodeP21GetData
|
|
2174
|
+
*/
|
|
2175
|
+
get: (codeUid: number, params?: CodeP21GetParams) => Promise<BaseResponse<CodeP21GetData>>;
|
|
2176
|
+
};
|
|
2177
|
+
company: {
|
|
2178
|
+
/**
|
|
2179
|
+
* List Companies
|
|
2180
|
+
* Call: api.p21Core.company.list(params)
|
|
2181
|
+
*
|
|
2182
|
+
* Errors:
|
|
2183
|
+
* 400: orderBy is not column|ASC or column|DESC on a company column.
|
|
2184
|
+
*
|
|
2185
|
+
* GET https://p21-core.augur-api.com/company
|
|
2186
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1company/get
|
|
2187
|
+
*
|
|
2188
|
+
* @param params CompanyListParams (query string)
|
|
2189
|
+
* @returns BaseResponse whose `data` is CompanyListData
|
|
2190
|
+
*/
|
|
2191
|
+
list: (params?: CompanyListParams) => Promise<BaseResponse<CompanyListData>>;
|
|
2192
|
+
/**
|
|
2193
|
+
* Get Company Details
|
|
2194
|
+
* Call: api.p21Core.company.get(companyId)
|
|
2195
|
+
*
|
|
2196
|
+
* Errors:
|
|
2197
|
+
* 404: No company with this ID.
|
|
2198
|
+
*
|
|
2199
|
+
* GET https://p21-core.augur-api.com/company/{companyId}
|
|
2200
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1company~1{companyId}/get
|
|
2201
|
+
*
|
|
2202
|
+
* @param companyId Prophet 21 company ID (a string, e.g. AMPRO)
|
|
2203
|
+
* @param params CompanyGetParams (query string)
|
|
2204
|
+
* @returns BaseResponse whose `data` is CompanyGetData
|
|
2205
|
+
*/
|
|
2206
|
+
get: (companyId: string, params?: CompanyGetParams) => Promise<BaseResponse<CompanyGetData>>;
|
|
2207
|
+
};
|
|
2208
|
+
counter: {
|
|
2209
|
+
/**
|
|
2210
|
+
* List Counter Rows
|
|
2211
|
+
* Call: api.p21Core.counter.list(params)
|
|
2212
|
+
*
|
|
2213
|
+
* List counter rows as Augur holds them locally
|
|
2214
|
+
*
|
|
2215
|
+
* Errors:
|
|
2216
|
+
* 400: OrderBy is not one counter column with ASC or DESC.
|
|
2217
|
+
*
|
|
2218
|
+
* GET https://p21-core.augur-api.com/counter
|
|
2219
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1counter/get
|
|
2220
|
+
*
|
|
2221
|
+
* @param params CounterListParams (query string)
|
|
2222
|
+
* @returns BaseResponse whose `data` is CounterListData
|
|
2223
|
+
*/
|
|
2224
|
+
list: (params?: CounterListParams) => Promise<BaseResponse<CounterListData>>;
|
|
2225
|
+
/**
|
|
2226
|
+
* Get Counter
|
|
2227
|
+
* Call: api.p21Core.counter.get(id)
|
|
2228
|
+
*
|
|
2229
|
+
* Get one counter row as Augur holds it locally
|
|
2230
|
+
*
|
|
2231
|
+
* Errors:
|
|
2232
|
+
* 400: id is missing or invalid.
|
|
2233
|
+
* 404: No counter row with this id.
|
|
2234
|
+
*
|
|
2235
|
+
* GET https://p21-core.augur-api.com/counter/{id}
|
|
2236
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1counter~1{id}/get
|
|
2237
|
+
*
|
|
2238
|
+
* @param id Counter key (counter.id)
|
|
2239
|
+
* @param params CounterGetParams (query string)
|
|
2240
|
+
* @returns BaseResponse whose `data` is CounterGetData
|
|
2241
|
+
*/
|
|
2242
|
+
get: (id: string, params?: CounterGetParams) => Promise<BaseResponse<CounterGetData>>;
|
|
2243
|
+
};
|
|
2244
|
+
creditcardProcessor: {
|
|
2245
|
+
/**
|
|
2246
|
+
* List Creditcard Processor Rows
|
|
2247
|
+
* Call: api.p21Core.creditcardProcessor.list(params)
|
|
2248
|
+
*
|
|
2249
|
+
* List creditcard processor rows as Augur holds them locally
|
|
2250
|
+
*
|
|
2251
|
+
* Errors:
|
|
2252
|
+
* 400: OrderBy is not one creditcard_processor column with ASC or DESC.
|
|
2253
|
+
*
|
|
2254
|
+
* GET https://p21-core.augur-api.com/creditcard-processor
|
|
2255
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1creditcard-processor/get
|
|
2256
|
+
*
|
|
2257
|
+
* @param params CreditcardProcessorListParams (query string)
|
|
2258
|
+
* @returns BaseResponse whose `data` is CreditcardProcessorListData
|
|
2259
|
+
*/
|
|
2260
|
+
list: (params?: CreditcardProcessorListParams) => Promise<BaseResponse<CreditcardProcessorListData>>;
|
|
2261
|
+
/**
|
|
2262
|
+
* Get Creditcard Processor
|
|
2263
|
+
* Call: api.p21Core.creditcardProcessor.get(creditcardProcessorUid)
|
|
2264
|
+
*
|
|
2265
|
+
* Get one creditcard processor row as Augur holds it locally
|
|
2266
|
+
*
|
|
2267
|
+
* Errors:
|
|
2268
|
+
* 404: No creditcard processor row with this creditcardProcessorUid.
|
|
2269
|
+
*
|
|
2270
|
+
* GET https://p21-core.augur-api.com/creditcard-processor/{creditcardProcessorUid}
|
|
2271
|
+
* Contract:
|
|
2272
|
+
* https://p21-core.augur-api.com/openapi.json#/paths/~1creditcard-processor~1{creditcardProcessorUid}/get
|
|
2273
|
+
*
|
|
2274
|
+
* @param creditcardProcessorUid Creditcard processor key
|
|
2275
|
+
* (creditcard_processor.creditcard_processor_uid)
|
|
2276
|
+
* @param params CreditcardProcessorGetParams (query string)
|
|
2277
|
+
* @returns BaseResponse whose `data` is CreditcardProcessorGetData
|
|
2278
|
+
*/
|
|
2279
|
+
get: (creditcardProcessorUid: number, params?: CreditcardProcessorGetParams) => Promise<BaseResponse<CreditcardProcessorGetData>>;
|
|
2280
|
+
};
|
|
2281
|
+
freightCode: {
|
|
2282
|
+
/**
|
|
2283
|
+
* List Freight Codes
|
|
2284
|
+
* Call: api.p21Core.freightCode.list(params)
|
|
2285
|
+
*
|
|
2286
|
+
* List freight codes
|
|
2287
|
+
*
|
|
2288
|
+
* Errors:
|
|
2289
|
+
* 400: orderBy is not column|ASC or column|DESC on a freight_code column.
|
|
2290
|
+
*
|
|
2291
|
+
* GET https://p21-core.augur-api.com/freight-code
|
|
2292
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1freight-code/get
|
|
2293
|
+
*
|
|
2294
|
+
* @param params FreightCodeListParams (query string)
|
|
2295
|
+
* @returns BaseResponse whose `data` is FreightCodeListData
|
|
2296
|
+
*/
|
|
2297
|
+
list: (params?: FreightCodeListParams) => Promise<BaseResponse<FreightCodeListData>>;
|
|
2298
|
+
/**
|
|
2299
|
+
* Get Freight Code
|
|
2300
|
+
* Call: api.p21Core.freightCode.get(freightCodeUid, params)
|
|
2301
|
+
*
|
|
2302
|
+
* Get a freight code by UID, or by code when the UID is zero
|
|
2303
|
+
*
|
|
2304
|
+
* Errors:
|
|
2305
|
+
* 400: freightCodeUid is 0 and no freightCodeId was sent.
|
|
2306
|
+
* 404: No freight code with this ID.
|
|
2307
|
+
*
|
|
2308
|
+
* GET https://p21-core.augur-api.com/freight-code/{freightCodeUid}
|
|
2309
|
+
* Contract:
|
|
2310
|
+
* https://p21-core.augur-api.com/openapi.json#/paths/~1freight-code~1{freightCodeUid}/get
|
|
2311
|
+
*
|
|
2312
|
+
* @param freightCodeUid freight_code.freight_code_uid
|
|
2313
|
+
* @param params FreightCodeGetParams (query string)
|
|
2314
|
+
* @returns BaseResponse whose `data` is FreightCodeGetData
|
|
2315
|
+
*/
|
|
2316
|
+
get: (freightCodeUid: number, params?: FreightCodeGetParams) => Promise<BaseResponse<FreightCodeGetData>>;
|
|
2317
|
+
};
|
|
2318
|
+
language: {
|
|
2319
|
+
/**
|
|
2320
|
+
* List Language Rows
|
|
2321
|
+
* Call: api.p21Core.language.list(params)
|
|
2322
|
+
*
|
|
2323
|
+
* List language rows as Augur holds them locally
|
|
2324
|
+
*
|
|
2325
|
+
* Errors:
|
|
2326
|
+
* 400: DeleteFlag is not Y or N, or orderBy is not one language column with ASC or DESC.
|
|
2327
|
+
*
|
|
2328
|
+
* GET https://p21-core.augur-api.com/language
|
|
2329
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1language/get
|
|
2330
|
+
*
|
|
2331
|
+
* @param params LanguageListParams (query string)
|
|
2332
|
+
* @returns BaseResponse whose `data` is LanguageListData
|
|
2333
|
+
*/
|
|
2334
|
+
list: (params?: LanguageListParams) => Promise<BaseResponse<LanguageListData>>;
|
|
2335
|
+
/**
|
|
2336
|
+
* Get Language
|
|
2337
|
+
* Call: api.p21Core.language.get(languageUid)
|
|
2338
|
+
*
|
|
2339
|
+
* Get one language row as Augur holds it locally
|
|
2340
|
+
*
|
|
2341
|
+
* Errors:
|
|
2342
|
+
* 404: No language row with this languageUid.
|
|
2343
|
+
*
|
|
2344
|
+
* GET https://p21-core.augur-api.com/language/{languageUid}
|
|
2345
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1language~1{languageUid}/get
|
|
2346
|
+
*
|
|
2347
|
+
* @param languageUid Language key (language.language_uid)
|
|
2348
|
+
* @param params LanguageGetParams (query string)
|
|
2349
|
+
* @returns BaseResponse whose `data` is LanguageGetData
|
|
2350
|
+
*/
|
|
2351
|
+
get: (languageUid: number, params?: LanguageGetParams) => Promise<BaseResponse<LanguageGetData>>;
|
|
2352
|
+
};
|
|
2353
|
+
location: {
|
|
2354
|
+
/**
|
|
2355
|
+
* List Locations
|
|
2356
|
+
* Call: api.p21Core.location.list(params)
|
|
2357
|
+
*
|
|
2358
|
+
* Response data, each item: A Prophet 21 location, with its address when the caller asks for it
|
|
2359
|
+
*
|
|
2360
|
+
* Errors:
|
|
2361
|
+
* 400: orderBy is not column|ASC or column|DESC on a location column.
|
|
2362
|
+
*
|
|
2363
|
+
* GET https://p21-core.augur-api.com/location
|
|
2364
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1location/get
|
|
2365
|
+
*
|
|
2366
|
+
* @param params LocationListParams (query string)
|
|
2367
|
+
* @returns BaseResponse whose `data` is LocationListData
|
|
2368
|
+
*/
|
|
2369
|
+
list: (params?: LocationListParams) => Promise<BaseResponse<LocationListData>>;
|
|
2370
|
+
/**
|
|
2371
|
+
* Get Location Details
|
|
2372
|
+
* Call: api.p21Core.location.get(locationId, params)
|
|
2373
|
+
*
|
|
2374
|
+
* Response data: A Prophet 21 location, with its address when the caller asks for it
|
|
2375
|
+
*
|
|
2376
|
+
* Errors:
|
|
2377
|
+
* 404: No location row with this locationId.
|
|
2378
|
+
*
|
|
2379
|
+
* GET https://p21-core.augur-api.com/location/{locationId}
|
|
2380
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1location~1{locationId}/get
|
|
2381
|
+
*
|
|
2382
|
+
* @param locationId Prophet 21 location ID
|
|
2383
|
+
* @param params LocationGetParams (query string)
|
|
2384
|
+
* @returns BaseResponse whose `data` is LocationGetData
|
|
2385
|
+
*/
|
|
2386
|
+
get: (locationId: number, params?: LocationGetParams) => Promise<BaseResponse<LocationGetData>>;
|
|
2387
|
+
};
|
|
2388
|
+
note: {
|
|
2389
|
+
/**
|
|
2390
|
+
* List Note Rows
|
|
2391
|
+
* Call: api.p21Core.note.list(params)
|
|
2392
|
+
*
|
|
2393
|
+
* List note rows as Augur holds them locally
|
|
2394
|
+
*
|
|
2395
|
+
* Errors:
|
|
2396
|
+
* 400: DocumentUid is not a number, or orderBy is not one note column with ASC or DESC.
|
|
2397
|
+
*
|
|
2398
|
+
* GET https://p21-core.augur-api.com/note
|
|
2399
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1note/get
|
|
2400
|
+
*
|
|
2401
|
+
* @param params NoteListParams (query string)
|
|
2402
|
+
* @returns BaseResponse whose `data` is NoteListData
|
|
2403
|
+
*/
|
|
2404
|
+
list: (params?: NoteListParams) => Promise<BaseResponse<NoteListData>>;
|
|
2405
|
+
/**
|
|
2406
|
+
* Get Note
|
|
2407
|
+
* Call: api.p21Core.note.get(noteUid)
|
|
2408
|
+
*
|
|
2409
|
+
* Get one note row as Augur holds it locally
|
|
2410
|
+
*
|
|
2411
|
+
* Errors:
|
|
2412
|
+
* 404: No note row with this noteUid.
|
|
2413
|
+
*
|
|
2414
|
+
* GET https://p21-core.augur-api.com/note/{noteUid}
|
|
2415
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1note~1{noteUid}/get
|
|
2416
|
+
*
|
|
2417
|
+
* @param noteUid Note key (note.note_uid)
|
|
2418
|
+
* @param params NoteGetParams (query string)
|
|
2419
|
+
* @returns BaseResponse whose `data` is NoteGetData
|
|
2420
|
+
*/
|
|
2421
|
+
get: (noteUid: number, params?: NoteGetParams) => Promise<BaseResponse<NoteGetData>>;
|
|
2422
|
+
};
|
|
2423
|
+
paymentTypes: {
|
|
2424
|
+
/**
|
|
2425
|
+
* List Payment Types
|
|
2426
|
+
* Call: api.p21Core.paymentTypes.list(params)
|
|
2427
|
+
*
|
|
2428
|
+
* Response data, each item: A Prophet 21 payment type
|
|
2429
|
+
*
|
|
2430
|
+
* Errors:
|
|
2431
|
+
* 400: orderBy is not column|ASC or column|DESC on a payment_types column.
|
|
2432
|
+
*
|
|
2433
|
+
* GET https://p21-core.augur-api.com/payment-types
|
|
2434
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1payment-types/get
|
|
2435
|
+
*
|
|
2436
|
+
* @param params PaymentTypesListParams (query string)
|
|
2437
|
+
* @returns BaseResponse whose `data` is PaymentTypesListData
|
|
2438
|
+
*/
|
|
2439
|
+
list: (params?: PaymentTypesListParams) => Promise<BaseResponse<PaymentTypesListData>>;
|
|
2440
|
+
/**
|
|
2441
|
+
* Get Payment Types
|
|
2442
|
+
* Call: api.p21Core.paymentTypes.get(paymentTypeId)
|
|
2443
|
+
*
|
|
2444
|
+
* Get one payment types row as Augur holds it locally
|
|
2445
|
+
*
|
|
2446
|
+
* Errors:
|
|
2447
|
+
* 400: paymentTypeId is missing or invalid.
|
|
2448
|
+
* 404: No payment types row with this paymentTypeId.
|
|
2449
|
+
*
|
|
2450
|
+
* GET https://p21-core.augur-api.com/payment-types/{paymentTypeId}
|
|
2451
|
+
* Contract:
|
|
2452
|
+
* https://p21-core.augur-api.com/openapi.json#/paths/~1payment-types~1{paymentTypeId}/get
|
|
2453
|
+
*
|
|
2454
|
+
* @param paymentTypeId Payment types key (payment_types.payment_type_id)
|
|
2455
|
+
* @param params PaymentTypesGetParams (query string)
|
|
2456
|
+
* @returns BaseResponse whose `data` is PaymentTypesGetData
|
|
2457
|
+
*/
|
|
2458
|
+
get: (paymentTypeId: number, params?: PaymentTypesGetParams) => Promise<BaseResponse<PaymentTypesGetData>>;
|
|
2459
|
+
};
|
|
2460
|
+
restrictedClass: {
|
|
2461
|
+
/**
|
|
2462
|
+
* List Restricted Class Rows
|
|
2463
|
+
* Call: api.p21Core.restrictedClass.list(params)
|
|
2464
|
+
*
|
|
2465
|
+
* List restricted class rows as Augur holds them locally
|
|
2466
|
+
*
|
|
2467
|
+
* Errors:
|
|
2468
|
+
* 400: ParentClassUid or dealerTypeUid is not a number, or orderBy is not one
|
|
2469
|
+
* restricted_class column with ASC or DESC.
|
|
2470
|
+
*
|
|
2471
|
+
* GET https://p21-core.augur-api.com/restricted-class
|
|
2472
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1restricted-class/get
|
|
2473
|
+
*
|
|
2474
|
+
* @param params RestrictedClassListParams (query string)
|
|
2475
|
+
* @returns BaseResponse whose `data` is RestrictedClassListData
|
|
2476
|
+
*/
|
|
2477
|
+
list: (params?: RestrictedClassListParams) => Promise<BaseResponse<RestrictedClassListData>>;
|
|
2478
|
+
/**
|
|
2479
|
+
* Get Restricted Class
|
|
2480
|
+
* Call: api.p21Core.restrictedClass.get(restrictedClassUid)
|
|
2481
|
+
*
|
|
2482
|
+
* Get one restricted class row as Augur holds it locally
|
|
2483
|
+
*
|
|
2484
|
+
* Errors:
|
|
2485
|
+
* 404: No restricted class row with this restrictedClassUid.
|
|
2486
|
+
*
|
|
2487
|
+
* GET https://p21-core.augur-api.com/restricted-class/{restrictedClassUid}
|
|
2488
|
+
* Contract:
|
|
2489
|
+
* https://p21-core.augur-api.com/openapi.json#/paths/~1restricted-class~1{restrictedClassUid}/get
|
|
2490
|
+
*
|
|
2491
|
+
* @param restrictedClassUid Restricted class key (restricted_class.restricted_class_uid)
|
|
2492
|
+
* @param params RestrictedClassGetParams (query string)
|
|
2493
|
+
* @returns BaseResponse whose `data` is RestrictedClassGetData
|
|
2494
|
+
*/
|
|
2495
|
+
get: (restrictedClassUid: number, params?: RestrictedClassGetParams) => Promise<BaseResponse<RestrictedClassGetData>>;
|
|
2496
|
+
};
|
|
2497
|
+
state: {
|
|
2498
|
+
/**
|
|
2499
|
+
* List State Rows
|
|
2500
|
+
* Call: api.p21Core.state.list(params)
|
|
2501
|
+
*
|
|
2502
|
+
* List state rows as Augur holds them locally
|
|
2503
|
+
*
|
|
2504
|
+
* Errors:
|
|
2505
|
+
* 400: CountryUid is not a number, or orderBy is not one state column with ASC or DESC.
|
|
2506
|
+
*
|
|
2507
|
+
* GET https://p21-core.augur-api.com/state
|
|
2508
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1state/get
|
|
2509
|
+
*
|
|
2510
|
+
* @param params StateListParams (query string)
|
|
2511
|
+
* @returns BaseResponse whose `data` is StateListData
|
|
2512
|
+
*/
|
|
2513
|
+
list: (params?: StateListParams) => Promise<BaseResponse<StateListData>>;
|
|
2514
|
+
/**
|
|
2515
|
+
* Get State
|
|
2516
|
+
* Call: api.p21Core.state.get(stateUid)
|
|
2517
|
+
*
|
|
2518
|
+
* Get one state row as Augur holds it locally
|
|
2519
|
+
*
|
|
2520
|
+
* Errors:
|
|
2521
|
+
* 404: No state row with this stateUid.
|
|
2522
|
+
*
|
|
2523
|
+
* GET https://p21-core.augur-api.com/state/{stateUid}
|
|
2524
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1state~1{stateUid}/get
|
|
2525
|
+
*
|
|
2526
|
+
* @param stateUid State key (state.state_uid)
|
|
2527
|
+
* @param params StateGetParams (query string)
|
|
2528
|
+
* @returns BaseResponse whose `data` is StateGetData
|
|
2529
|
+
*/
|
|
2530
|
+
get: (stateUid: number, params?: StateGetParams) => Promise<BaseResponse<StateGetData>>;
|
|
2531
|
+
};
|
|
2532
|
+
systemSetting: {
|
|
2533
|
+
/**
|
|
2534
|
+
* List System Setting Rows
|
|
2535
|
+
* Call: api.p21Core.systemSetting.list(params)
|
|
2536
|
+
*
|
|
2537
|
+
* List system setting rows as Augur holds them locally
|
|
2538
|
+
*
|
|
2539
|
+
* Errors:
|
|
2540
|
+
* 400: OrderBy is not one system_setting column with ASC or DESC.
|
|
2541
|
+
*
|
|
2542
|
+
* GET https://p21-core.augur-api.com/system-setting
|
|
2543
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1system-setting/get
|
|
2544
|
+
*
|
|
2545
|
+
* @param params SystemSettingListParams (query string)
|
|
2546
|
+
* @returns BaseResponse whose `data` is SystemSettingListData
|
|
2547
|
+
*/
|
|
2548
|
+
list: (params?: SystemSettingListParams) => Promise<BaseResponse<SystemSettingListData>>;
|
|
2549
|
+
/**
|
|
2550
|
+
* Get System Setting
|
|
2551
|
+
* Call: api.p21Core.systemSetting.get(systemSettingUid)
|
|
2552
|
+
*
|
|
2553
|
+
* Get one system setting row as Augur holds it locally
|
|
2554
|
+
*
|
|
2555
|
+
* Errors:
|
|
2556
|
+
* 404: No system setting row with this systemSettingUid.
|
|
2557
|
+
*
|
|
2558
|
+
* GET https://p21-core.augur-api.com/system-setting/{systemSettingUid}
|
|
2559
|
+
* Contract:
|
|
2560
|
+
* https://p21-core.augur-api.com/openapi.json#/paths/~1system-setting~1{systemSettingUid}/get
|
|
2561
|
+
*
|
|
2562
|
+
* @param systemSettingUid System setting key (system_setting.system_setting_uid)
|
|
2563
|
+
* @param params SystemSettingGetParams (query string)
|
|
2564
|
+
* @returns BaseResponse whose `data` is SystemSettingGetData
|
|
2565
|
+
*/
|
|
2566
|
+
get: (systemSettingUid: number, params?: SystemSettingGetParams) => Promise<BaseResponse<SystemSettingGetData>>;
|
|
2567
|
+
};
|
|
2568
|
+
termXLanguage: {
|
|
2569
|
+
/**
|
|
2570
|
+
* List Term X Language Rows
|
|
2571
|
+
* Call: api.p21Core.termXLanguage.list(params)
|
|
2572
|
+
*
|
|
2573
|
+
* List term x language rows as Augur holds them locally
|
|
2574
|
+
*
|
|
2575
|
+
* Errors:
|
|
2576
|
+
* 400: TranslationTermUid is not a number, or orderBy is not one term_x_language column with
|
|
2577
|
+
* ASC or DESC.
|
|
2578
|
+
*
|
|
2579
|
+
* GET https://p21-core.augur-api.com/term-x-language
|
|
2580
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1term-x-language/get
|
|
2581
|
+
*
|
|
2582
|
+
* @param params TermXLanguageListParams (query string)
|
|
2583
|
+
* @returns BaseResponse whose `data` is TermXLanguageListData
|
|
2584
|
+
*/
|
|
2585
|
+
list: (params?: TermXLanguageListParams) => Promise<BaseResponse<TermXLanguageListData>>;
|
|
2586
|
+
/**
|
|
2587
|
+
* Get Term X Language
|
|
2588
|
+
* Call: api.p21Core.termXLanguage.get(termXLanguageUid)
|
|
2589
|
+
*
|
|
2590
|
+
* Get one term x language row as Augur holds it locally
|
|
2591
|
+
*
|
|
2592
|
+
* Errors:
|
|
2593
|
+
* 404: No term x language row with this termXLanguageUid.
|
|
2594
|
+
*
|
|
2595
|
+
* GET https://p21-core.augur-api.com/term-x-language/{termXLanguageUid}
|
|
2596
|
+
* Contract:
|
|
2597
|
+
* https://p21-core.augur-api.com/openapi.json#/paths/~1term-x-language~1{termXLanguageUid}/get
|
|
2598
|
+
*
|
|
2599
|
+
* @param termXLanguageUid Term x language key (term_x_language.term_x_language_uid)
|
|
2600
|
+
* @param params TermXLanguageGetParams (query string)
|
|
2601
|
+
* @returns BaseResponse whose `data` is TermXLanguageGetData
|
|
2602
|
+
*/
|
|
2603
|
+
get: (termXLanguageUid: number, params?: TermXLanguageGetParams) => Promise<BaseResponse<TermXLanguageGetData>>;
|
|
2604
|
+
};
|
|
2605
|
+
terms: {
|
|
2606
|
+
/**
|
|
2607
|
+
* List Terms Rows
|
|
2608
|
+
* Call: api.p21Core.terms.list(params)
|
|
2609
|
+
*
|
|
2610
|
+
* List terms rows as Augur holds them locally
|
|
2611
|
+
*
|
|
2612
|
+
* Errors:
|
|
2613
|
+
* 400: DeleteFlag is not Y or N, or discountInvMastUid is not a number, or orderBy is not one
|
|
2614
|
+
* terms column with ASC or DESC.
|
|
2615
|
+
*
|
|
2616
|
+
* GET https://p21-core.augur-api.com/terms
|
|
2617
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1terms/get
|
|
2618
|
+
*
|
|
2619
|
+
* @param params TermsListParams (query string)
|
|
2620
|
+
* @returns BaseResponse whose `data` is TermsListData
|
|
2621
|
+
*/
|
|
2622
|
+
list: (params?: TermsListParams) => Promise<BaseResponse<TermsListData>>;
|
|
2623
|
+
/**
|
|
2624
|
+
* Get Terms
|
|
2625
|
+
* Call: api.p21Core.terms.get(termsId)
|
|
2626
|
+
*
|
|
2627
|
+
* Get one terms row as Augur holds it locally
|
|
2628
|
+
*
|
|
2629
|
+
* Errors:
|
|
2630
|
+
* 400: termsId is missing or invalid.
|
|
2631
|
+
* 404: No terms row with this termsId.
|
|
2632
|
+
*
|
|
2633
|
+
* GET https://p21-core.augur-api.com/terms/{termsId}
|
|
2634
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1terms~1{termsId}/get
|
|
2635
|
+
*
|
|
2636
|
+
* @param termsId Terms key (terms.terms_id)
|
|
2637
|
+
* @param params TermsGetParams (query string)
|
|
2638
|
+
* @returns BaseResponse whose `data` is TermsGetData
|
|
2639
|
+
*/
|
|
2640
|
+
get: (termsId: string, params?: TermsGetParams) => Promise<BaseResponse<TermsGetData>>;
|
|
2641
|
+
};
|
|
2642
|
+
userDefinedColumn: {
|
|
2643
|
+
/**
|
|
2644
|
+
* List User Defined Column Rows
|
|
2645
|
+
* Call: api.p21Core.userDefinedColumn.list(params)
|
|
2646
|
+
*
|
|
2647
|
+
* List user defined column rows as Augur holds them locally
|
|
2648
|
+
*
|
|
2649
|
+
* Errors:
|
|
2650
|
+
* 400: OrderBy is not one user_defined_column column with ASC or DESC.
|
|
2651
|
+
*
|
|
2652
|
+
* GET https://p21-core.augur-api.com/user-defined-column
|
|
2653
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1user-defined-column/get
|
|
2654
|
+
*
|
|
2655
|
+
* @param params UserDefinedColumnListParams (query string)
|
|
2656
|
+
* @returns BaseResponse whose `data` is UserDefinedColumnListData
|
|
2657
|
+
*/
|
|
2658
|
+
list: (params?: UserDefinedColumnListParams) => Promise<BaseResponse<UserDefinedColumnListData>>;
|
|
2659
|
+
/**
|
|
2660
|
+
* Get User Defined Column
|
|
2661
|
+
* Call: api.p21Core.userDefinedColumn.get(userDefinedColumnUid)
|
|
2662
|
+
*
|
|
2663
|
+
* Get one user defined column row as Augur holds it locally
|
|
2664
|
+
*
|
|
2665
|
+
* Errors:
|
|
2666
|
+
* 404: No user defined column row with this userDefinedColumnUid.
|
|
2667
|
+
*
|
|
2668
|
+
* GET https://p21-core.augur-api.com/user-defined-column/{userDefinedColumnUid}
|
|
2669
|
+
* Contract:
|
|
2670
|
+
* https://p21-core.augur-api.com/openapi.json#/paths/~1user-defined-column~1{userDefinedColumnUid}/get
|
|
2671
|
+
*
|
|
2672
|
+
* @param userDefinedColumnUid User defined column key
|
|
2673
|
+
* (user_defined_column.user_defined_column_uid)
|
|
2674
|
+
* @param params UserDefinedColumnGetParams (query string)
|
|
2675
|
+
* @returns BaseResponse whose `data` is UserDefinedColumnGetData
|
|
2676
|
+
*/
|
|
2677
|
+
get: (userDefinedColumnUid: number, params?: UserDefinedColumnGetParams) => Promise<BaseResponse<UserDefinedColumnGetData>>;
|
|
2678
|
+
};
|
|
2679
|
+
users: {
|
|
2680
|
+
/**
|
|
2681
|
+
* List Users Rows
|
|
2682
|
+
* Call: api.p21Core.users.list(params)
|
|
2683
|
+
*
|
|
2684
|
+
* List users rows as Augur holds them locally
|
|
2685
|
+
*
|
|
2686
|
+
* Errors:
|
|
2687
|
+
* 400: DeleteFlag is not Y or N, or roleUid or invGroupHdrUid or strategicPricingRoleUid or
|
|
2688
|
+
* customerProfitRoleUid is not a number, or orderBy is not one users column with ASC or
|
|
2689
|
+
* DESC.
|
|
2690
|
+
*
|
|
2691
|
+
* GET https://p21-core.augur-api.com/users
|
|
2692
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1users/get
|
|
2693
|
+
*
|
|
2694
|
+
* @param params UsersListParams (query string)
|
|
2695
|
+
* @returns BaseResponse whose `data` is UsersListData
|
|
2696
|
+
*/
|
|
2697
|
+
list: (params?: UsersListParams) => Promise<BaseResponse<UsersListData>>;
|
|
2698
|
+
/**
|
|
2699
|
+
* Get Users
|
|
2700
|
+
* Call: api.p21Core.users.get(id)
|
|
2701
|
+
*
|
|
2702
|
+
* Get one users row as Augur holds it locally
|
|
2703
|
+
*
|
|
2704
|
+
* Errors:
|
|
2705
|
+
* 400: id is missing or invalid.
|
|
2706
|
+
* 404: No users row with this id.
|
|
2707
|
+
*
|
|
2708
|
+
* GET https://p21-core.augur-api.com/users/{id}
|
|
2709
|
+
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1users~1{id}/get
|
|
2710
|
+
*
|
|
2711
|
+
* @param id Users key (users.id)
|
|
2712
|
+
* @param params UsersGetParams (query string)
|
|
2713
|
+
* @returns BaseResponse whose `data` is UsersGetData
|
|
2714
|
+
*/
|
|
2715
|
+
get: (id: string, params?: UsersGetParams) => Promise<BaseResponse<UsersGetData>>;
|
|
2716
|
+
};
|
|
2717
|
+
}
|
|
2718
|
+
//# sourceMappingURL=types.d.ts.map
|