@flexprice/sdk 2.1.44-dev.7 → 2.1.45-dev.8
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/FUNCTIONS.md +3 -3
- package/USAGE.md +1 -1
- package/docs/sdk/models/accounting-period-response.md +21 -0
- package/docs/sdk/models/accounting-period-status.md +17 -0
- package/docs/sdk/models/accountingperiod-filter-order.md +15 -0
- package/docs/sdk/models/accountingperiod-filter.md +25 -0
- package/docs/sdk/models/amortization-method.md +17 -0
- package/docs/sdk/models/contract-association-response.md +18 -0
- package/docs/sdk/models/contract-filter-order.md +15 -0
- package/docs/sdk/models/contract-filter.md +28 -0
- package/docs/sdk/models/contract-response.md +25 -0
- package/docs/sdk/models/contract-status.md +17 -0
- package/docs/sdk/models/create-price-request.md +1 -0
- package/docs/sdk/models/create-product-request.md +20 -0
- package/docs/sdk/models/delete-product-request.md +17 -0
- package/docs/sdk/models/get-contract-request.md +17 -0
- package/docs/sdk/models/get-journal-entry-request.md +17 -0
- package/docs/sdk/models/get-performance-obligation-request.md +17 -0
- package/docs/sdk/models/get-product-request.md +17 -0
- package/docs/sdk/models/invoice-filter.md +1 -0
- package/docs/sdk/models/journal-direction.md +17 -0
- package/docs/sdk/models/journal-entry-response.md +26 -0
- package/docs/sdk/models/journal-event-type.md +17 -0
- package/docs/sdk/models/journal-filter-order.md +15 -0
- package/docs/sdk/models/journal-filter.md +32 -0
- package/docs/sdk/models/journal-line-response.md +19 -0
- package/docs/sdk/models/ledger-account-key.md +17 -0
- package/docs/sdk/models/list-accounting-periods-response.md +16 -0
- package/docs/sdk/models/list-contracts-response.md +16 -0
- package/docs/sdk/models/list-journal-entries-response.md +16 -0
- package/docs/sdk/models/list-payments-request.md +2 -1
- package/docs/sdk/models/list-performance-obligations-response.md +16 -0
- package/docs/sdk/models/list-products-order.md +15 -0
- package/docs/sdk/models/list-products-request.md +23 -0
- package/docs/sdk/models/list-products-response.md +16 -0
- package/docs/sdk/models/list-products-status.md +15 -0
- package/docs/sdk/models/performance-obligation-association-response.md +18 -0
- package/docs/sdk/models/performance-obligation-response.md +26 -0
- package/docs/sdk/models/performance-obligation-status.md +17 -0
- package/docs/sdk/models/pob-filter-order.md +15 -0
- package/docs/sdk/models/pob-filter.md +28 -0
- package/docs/sdk/models/price-filter.md +1 -0
- package/docs/sdk/models/price-price.md +1 -0
- package/docs/sdk/models/price-response.md +1 -0
- package/docs/sdk/models/product-filter-order.md +15 -0
- package/docs/sdk/models/product-filter.md +25 -0
- package/docs/sdk/models/product-response.md +21 -0
- package/docs/sdk/models/recognition-method.md +17 -0
- package/docs/sdk/models/rev-rec-entity-type.md +17 -0
- package/docs/sdk/models/revenue-breakdown.md +18 -0
- package/docs/sdk/models/revenue-report-group-by.md +15 -0
- package/docs/sdk/models/rollforward-request.md +28 -0
- package/docs/sdk/models/rollforward-response.md +17 -0
- package/docs/sdk/models/rollforward-row.md +22 -0
- package/docs/sdk/models/update-price-request.md +1 -0
- package/docs/sdk/models/update-product-request-request.md +19 -0
- package/docs/sdk/models/update-product-request.md +16 -0
- package/docs/sdk/models/waterfall-cell.md +18 -0
- package/docs/sdk/models/waterfall-request.md +29 -0
- package/docs/sdk/models/waterfall-response.md +17 -0
- package/docs/sdk/models/waterfall-row.md +18 -0
- package/docs/sdks/accountingperiods/README.md +78 -0
- package/docs/sdks/contracts/README.md +150 -0
- package/docs/sdks/journalentries/README.md +150 -0
- package/docs/sdks/performanceobligations/README.md +150 -0
- package/docs/sdks/products/README.md +445 -0
- package/docs/sdks/revenuereports/README.md +164 -0
- package/esm/funcs/accounting-periods-query-accounting-period.d.ts +17 -0
- package/esm/funcs/accounting-periods-query-accounting-period.d.ts.map +1 -0
- package/esm/funcs/accounting-periods-query-accounting-period.js +83 -0
- package/esm/funcs/accounting-periods-query-accounting-period.js.map +1 -0
- package/esm/funcs/contracts-get-contract.d.ts +17 -0
- package/esm/funcs/contracts-get-contract.d.ts.map +1 -0
- package/esm/funcs/contracts-get-contract.js +91 -0
- package/esm/funcs/contracts-get-contract.js.map +1 -0
- package/esm/funcs/contracts-query-contract.d.ts +17 -0
- package/esm/funcs/contracts-query-contract.d.ts.map +1 -0
- package/esm/funcs/contracts-query-contract.js +83 -0
- package/esm/funcs/contracts-query-contract.js.map +1 -0
- package/esm/funcs/journal-entries-get-journal-entry.d.ts +17 -0
- package/esm/funcs/journal-entries-get-journal-entry.d.ts.map +1 -0
- package/esm/funcs/journal-entries-get-journal-entry.js +91 -0
- package/esm/funcs/journal-entries-get-journal-entry.js.map +1 -0
- package/esm/funcs/journal-entries-query-journal-entry.d.ts +17 -0
- package/esm/funcs/journal-entries-query-journal-entry.d.ts.map +1 -0
- package/esm/funcs/journal-entries-query-journal-entry.js +83 -0
- package/esm/funcs/journal-entries-query-journal-entry.js.map +1 -0
- package/esm/funcs/payments-list-payments.js +1 -0
- package/esm/funcs/payments-list-payments.js.map +1 -1
- package/esm/funcs/performance-obligations-get-performance-obligation.d.ts +17 -0
- package/esm/funcs/performance-obligations-get-performance-obligation.d.ts.map +1 -0
- package/esm/funcs/performance-obligations-get-performance-obligation.js +91 -0
- package/esm/funcs/performance-obligations-get-performance-obligation.js.map +1 -0
- package/esm/funcs/performance-obligations-query-performance-obligation.d.ts +17 -0
- package/esm/funcs/performance-obligations-query-performance-obligation.d.ts.map +1 -0
- package/esm/funcs/performance-obligations-query-performance-obligation.js +83 -0
- package/esm/funcs/performance-obligations-query-performance-obligation.js.map +1 -0
- package/esm/funcs/products-create-product.d.ts +17 -0
- package/esm/funcs/products-create-product.d.ts.map +1 -0
- package/esm/funcs/products-create-product.js +83 -0
- package/esm/funcs/products-create-product.js.map +1 -0
- package/esm/funcs/products-delete-product.d.ts +17 -0
- package/esm/funcs/products-delete-product.d.ts.map +1 -0
- package/esm/funcs/products-delete-product.js +91 -0
- package/esm/funcs/products-delete-product.js.map +1 -0
- package/esm/funcs/products-get-product.d.ts +17 -0
- package/esm/funcs/products-get-product.d.ts.map +1 -0
- package/esm/funcs/products-get-product.js +91 -0
- package/esm/funcs/products-get-product.js.map +1 -0
- package/esm/funcs/products-list-products.d.ts +17 -0
- package/esm/funcs/products-list-products.d.ts.map +1 -0
- package/esm/funcs/products-list-products.js +95 -0
- package/esm/funcs/products-list-products.js.map +1 -0
- package/esm/funcs/products-query-product.d.ts +17 -0
- package/esm/funcs/products-query-product.d.ts.map +1 -0
- package/esm/funcs/products-query-product.js +83 -0
- package/esm/funcs/products-query-product.js.map +1 -0
- package/esm/funcs/products-update-product.d.ts +17 -0
- package/esm/funcs/products-update-product.d.ts.map +1 -0
- package/esm/funcs/products-update-product.js +93 -0
- package/esm/funcs/products-update-product.js.map +1 -0
- package/esm/funcs/revenue-reports-get-revenue-rollforward.d.ts +17 -0
- package/esm/funcs/revenue-reports-get-revenue-rollforward.d.ts.map +1 -0
- package/esm/funcs/revenue-reports-get-revenue-rollforward.js +83 -0
- package/esm/funcs/revenue-reports-get-revenue-rollforward.js.map +1 -0
- package/esm/funcs/revenue-reports-get-revenue-waterfall.d.ts +17 -0
- package/esm/funcs/revenue-reports-get-revenue-waterfall.d.ts.map +1 -0
- package/esm/funcs/revenue-reports-get-revenue-waterfall.js +83 -0
- package/esm/funcs/revenue-reports-get-revenue-waterfall.js.map +1 -0
- package/esm/lib/config.d.ts +2 -2
- package/esm/lib/config.js +2 -2
- package/esm/sdk/accounting-periods.d.ts +12 -0
- package/esm/sdk/accounting-periods.d.ts.map +1 -0
- package/esm/sdk/accounting-periods.js +18 -0
- package/esm/sdk/accounting-periods.js.map +1 -0
- package/esm/sdk/contracts.d.ts +19 -0
- package/esm/sdk/contracts.d.ts.map +1 -0
- package/esm/sdk/contracts.js +28 -0
- package/esm/sdk/contracts.js.map +1 -0
- package/esm/sdk/journal-entries.d.ts +19 -0
- package/esm/sdk/journal-entries.d.ts.map +1 -0
- package/esm/sdk/journal-entries.js +28 -0
- package/esm/sdk/journal-entries.js.map +1 -0
- package/esm/sdk/models/accounting-period-response.d.ts +18 -0
- package/esm/sdk/models/accounting-period-response.d.ts.map +1 -0
- package/esm/sdk/models/accounting-period-response.js +31 -0
- package/esm/sdk/models/accounting-period-response.js.map +1 -0
- package/esm/sdk/models/accounting-period-status.d.ts +12 -0
- package/esm/sdk/models/accounting-period-status.d.ts.map +1 -0
- package/esm/sdk/models/accounting-period-status.js +13 -0
- package/esm/sdk/models/accounting-period-status.js.map +1 -0
- package/esm/sdk/models/accountingperiod-filter.d.ts +44 -0
- package/esm/sdk/models/accountingperiod-filter.d.ts.map +1 -0
- package/esm/sdk/models/accountingperiod-filter.js +40 -0
- package/esm/sdk/models/accountingperiod-filter.js.map +1 -0
- package/esm/sdk/models/amortization-method.d.ts +11 -0
- package/esm/sdk/models/amortization-method.d.ts.map +1 -0
- package/esm/sdk/models/amortization-method.js +12 -0
- package/esm/sdk/models/amortization-method.js.map +1 -0
- package/esm/sdk/models/contract-association-response.d.ts +14 -0
- package/esm/sdk/models/contract-association-response.d.ts.map +1 -0
- package/esm/sdk/models/contract-association-response.js +25 -0
- package/esm/sdk/models/contract-association-response.js.map +1 -0
- package/esm/sdk/models/contract-filter.d.ts +50 -0
- package/esm/sdk/models/contract-filter.d.ts.map +1 -0
- package/esm/sdk/models/contract-filter.js +46 -0
- package/esm/sdk/models/contract-filter.js.map +1 -0
- package/esm/sdk/models/contract-response.d.ts +23 -0
- package/esm/sdk/models/contract-response.d.ts.map +1 -0
- package/esm/sdk/models/contract-response.js +38 -0
- package/esm/sdk/models/contract-response.js.map +1 -0
- package/esm/sdk/models/contract-status.d.ts +14 -0
- package/esm/sdk/models/contract-status.d.ts.map +1 -0
- package/esm/sdk/models/contract-status.js +15 -0
- package/esm/sdk/models/contract-status.js.map +1 -0
- package/esm/sdk/models/create-price-request.d.ts +2 -0
- package/esm/sdk/models/create-price-request.d.ts.map +1 -1
- package/esm/sdk/models/create-price-request.js +2 -0
- package/esm/sdk/models/create-price-request.js.map +1 -1
- package/esm/sdk/models/create-product-request.d.ts +16 -0
- package/esm/sdk/models/create-product-request.d.ts.map +1 -0
- package/esm/sdk/models/create-product-request.js +19 -0
- package/esm/sdk/models/create-product-request.js.map +1 -0
- package/esm/sdk/models/delete-product-op.d.ts +15 -0
- package/esm/sdk/models/delete-product-op.d.ts.map +1 -0
- package/esm/sdk/models/delete-product-op.js +12 -0
- package/esm/sdk/models/delete-product-op.js.map +1 -0
- package/esm/sdk/models/get-contract-op.d.ts +15 -0
- package/esm/sdk/models/get-contract-op.d.ts.map +1 -0
- package/esm/sdk/models/get-contract-op.js +12 -0
- package/esm/sdk/models/get-contract-op.js.map +1 -0
- package/esm/sdk/models/get-journal-entry-op.d.ts +15 -0
- package/esm/sdk/models/get-journal-entry-op.d.ts.map +1 -0
- package/esm/sdk/models/get-journal-entry-op.js +12 -0
- package/esm/sdk/models/get-journal-entry-op.js.map +1 -0
- package/esm/sdk/models/get-performance-obligation-op.d.ts +15 -0
- package/esm/sdk/models/get-performance-obligation-op.d.ts.map +1 -0
- package/esm/sdk/models/get-performance-obligation-op.js +12 -0
- package/esm/sdk/models/get-performance-obligation-op.js.map +1 -0
- package/esm/sdk/models/get-product-op.d.ts +15 -0
- package/esm/sdk/models/get-product-op.d.ts.map +1 -0
- package/esm/sdk/models/get-product-op.js +12 -0
- package/esm/sdk/models/get-product-op.js.map +1 -0
- package/esm/sdk/models/index.d.ts +45 -0
- package/esm/sdk/models/index.d.ts.map +1 -1
- package/esm/sdk/models/index.js +45 -0
- package/esm/sdk/models/index.js.map +1 -1
- package/esm/sdk/models/invoice-filter.d.ts +5 -0
- package/esm/sdk/models/invoice-filter.d.ts.map +1 -1
- package/esm/sdk/models/invoice-filter.js +2 -0
- package/esm/sdk/models/invoice-filter.js.map +1 -1
- package/esm/sdk/models/journal-direction.d.ts +10 -0
- package/esm/sdk/models/journal-direction.d.ts.map +1 -0
- package/esm/sdk/models/journal-direction.js +11 -0
- package/esm/sdk/models/journal-direction.js.map +1 -0
- package/esm/sdk/models/journal-entry-response.d.ts +24 -0
- package/esm/sdk/models/journal-entry-response.d.ts.map +1 -0
- package/esm/sdk/models/journal-entry-response.js +41 -0
- package/esm/sdk/models/journal-entry-response.js.map +1 -0
- package/esm/sdk/models/journal-event-type.d.ts +19 -0
- package/esm/sdk/models/journal-event-type.d.ts.map +1 -0
- package/esm/sdk/models/journal-event-type.js +20 -0
- package/esm/sdk/models/journal-event-type.js.map +1 -0
- package/esm/sdk/models/journal-filter.d.ts +60 -0
- package/esm/sdk/models/journal-filter.d.ts.map +1 -0
- package/esm/sdk/models/journal-filter.js +55 -0
- package/esm/sdk/models/journal-filter.js.map +1 -0
- package/esm/sdk/models/journal-line-response.d.ts +16 -0
- package/esm/sdk/models/journal-line-response.d.ts.map +1 -0
- package/esm/sdk/models/journal-line-response.js +25 -0
- package/esm/sdk/models/journal-line-response.js.map +1 -0
- package/esm/sdk/models/ledger-account-key.d.ts +18 -0
- package/esm/sdk/models/ledger-account-key.d.ts.map +1 -0
- package/esm/sdk/models/ledger-account-key.js +19 -0
- package/esm/sdk/models/ledger-account-key.js.map +1 -0
- package/esm/sdk/models/list-accounting-periods-response.d.ts +13 -0
- package/esm/sdk/models/list-accounting-periods-response.d.ts.map +1 -0
- package/esm/sdk/models/list-accounting-periods-response.js +17 -0
- package/esm/sdk/models/list-accounting-periods-response.js.map +1 -0
- package/esm/sdk/models/list-contracts-response.d.ts +13 -0
- package/esm/sdk/models/list-contracts-response.d.ts.map +1 -0
- package/esm/sdk/models/list-contracts-response.js +17 -0
- package/esm/sdk/models/list-contracts-response.js.map +1 -0
- package/esm/sdk/models/list-journal-entries-response.d.ts +13 -0
- package/esm/sdk/models/list-journal-entries-response.d.ts.map +1 -0
- package/esm/sdk/models/list-journal-entries-response.js +17 -0
- package/esm/sdk/models/list-journal-entries-response.js.map +1 -0
- package/esm/sdk/models/list-payments-op.d.ts +5 -0
- package/esm/sdk/models/list-payments-op.d.ts.map +1 -1
- package/esm/sdk/models/list-payments-op.js +2 -0
- package/esm/sdk/models/list-payments-op.js.map +1 -1
- package/esm/sdk/models/list-performance-obligations-response.d.ts +13 -0
- package/esm/sdk/models/list-performance-obligations-response.d.ts.map +1 -0
- package/esm/sdk/models/list-performance-obligations-response.js +17 -0
- package/esm/sdk/models/list-performance-obligations-response.js.map +1 -0
- package/esm/sdk/models/list-products-op.d.ts +44 -0
- package/esm/sdk/models/list-products-op.d.ts.map +1 -0
- package/esm/sdk/models/list-products-op.js +41 -0
- package/esm/sdk/models/list-products-op.js.map +1 -0
- package/esm/sdk/models/list-products-response.d.ts +13 -0
- package/esm/sdk/models/list-products-response.d.ts.map +1 -0
- package/esm/sdk/models/list-products-response.js +17 -0
- package/esm/sdk/models/list-products-response.js.map +1 -0
- package/esm/sdk/models/performance-obligation-association-response.d.ts +14 -0
- package/esm/sdk/models/performance-obligation-association-response.d.ts.map +1 -0
- package/esm/sdk/models/performance-obligation-association-response.js +25 -0
- package/esm/sdk/models/performance-obligation-association-response.js.map +1 -0
- package/esm/sdk/models/performance-obligation-response.d.ts +26 -0
- package/esm/sdk/models/performance-obligation-response.d.ts.map +1 -0
- package/esm/sdk/models/performance-obligation-response.js +42 -0
- package/esm/sdk/models/performance-obligation-response.js.map +1 -0
- package/esm/sdk/models/performance-obligation-status.d.ts +14 -0
- package/esm/sdk/models/performance-obligation-status.d.ts.map +1 -0
- package/esm/sdk/models/performance-obligation-status.js +15 -0
- package/esm/sdk/models/performance-obligation-status.js.map +1 -0
- package/esm/sdk/models/pob-filter.d.ts +51 -0
- package/esm/sdk/models/pob-filter.d.ts.map +1 -0
- package/esm/sdk/models/pob-filter.js +47 -0
- package/esm/sdk/models/pob-filter.js.map +1 -0
- package/esm/sdk/models/price-filter.d.ts +2 -0
- package/esm/sdk/models/price-filter.d.ts.map +1 -1
- package/esm/sdk/models/price-filter.js +2 -0
- package/esm/sdk/models/price-filter.js.map +1 -1
- package/esm/sdk/models/price-price.d.ts +1 -0
- package/esm/sdk/models/price-price.d.ts.map +1 -1
- package/esm/sdk/models/price-price.js +2 -0
- package/esm/sdk/models/price-price.js.map +1 -1
- package/esm/sdk/models/price-response.d.ts +1 -0
- package/esm/sdk/models/price-response.d.ts.map +1 -1
- package/esm/sdk/models/price-response.js +2 -0
- package/esm/sdk/models/price-response.js.map +1 -1
- package/esm/sdk/models/product-filter.d.ts +43 -0
- package/esm/sdk/models/product-filter.d.ts.map +1 -0
- package/esm/sdk/models/product-filter.js +39 -0
- package/esm/sdk/models/product-filter.js.map +1 -0
- package/esm/sdk/models/product-response.d.ts +17 -0
- package/esm/sdk/models/product-response.d.ts.map +1 -0
- package/esm/sdk/models/product-response.js +28 -0
- package/esm/sdk/models/product-response.js.map +1 -0
- package/esm/sdk/models/recognition-method.d.ts +13 -0
- package/esm/sdk/models/recognition-method.d.ts.map +1 -0
- package/esm/sdk/models/recognition-method.js +14 -0
- package/esm/sdk/models/recognition-method.js.map +1 -0
- package/esm/sdk/models/rev-rec-entity-type.d.ts +17 -0
- package/esm/sdk/models/rev-rec-entity-type.d.ts.map +1 -0
- package/esm/sdk/models/rev-rec-entity-type.js +18 -0
- package/esm/sdk/models/rev-rec-entity-type.js.map +1 -0
- package/esm/sdk/models/revenue-breakdown.d.ts +16 -0
- package/esm/sdk/models/revenue-breakdown.d.ts.map +1 -0
- package/esm/sdk/models/revenue-breakdown.js +17 -0
- package/esm/sdk/models/revenue-breakdown.js.map +1 -0
- package/esm/sdk/models/revenue-report-group-by.d.ts +11 -0
- package/esm/sdk/models/revenue-report-group-by.d.ts.map +1 -0
- package/esm/sdk/models/revenue-report-group-by.js +12 -0
- package/esm/sdk/models/revenue-report-group-by.js.map +1 -0
- package/esm/sdk/models/rollforward-request.d.ts +49 -0
- package/esm/sdk/models/rollforward-request.d.ts.map +1 -0
- package/esm/sdk/models/rollforward-request.js +35 -0
- package/esm/sdk/models/rollforward-request.js.map +1 -0
- package/esm/sdk/models/rollforward-response.d.ts +20 -0
- package/esm/sdk/models/rollforward-response.d.ts.map +1 -0
- package/esm/sdk/models/rollforward-response.js +18 -0
- package/esm/sdk/models/rollforward-response.js.map +1 -0
- package/esm/sdk/models/rollforward-row.d.ts +26 -0
- package/esm/sdk/models/rollforward-row.d.ts.map +1 -0
- package/esm/sdk/models/rollforward-row.js +29 -0
- package/esm/sdk/models/rollforward-row.js.map +1 -0
- package/esm/sdk/models/update-price-request.d.ts +5 -0
- package/esm/sdk/models/update-price-request.d.ts.map +1 -1
- package/esm/sdk/models/update-price-request.js +2 -0
- package/esm/sdk/models/update-price-request.js.map +1 -1
- package/esm/sdk/models/update-product-op.d.ts +21 -0
- package/esm/sdk/models/update-product-op.d.ts.map +1 -0
- package/esm/sdk/models/update-product-op.js +14 -0
- package/esm/sdk/models/update-product-op.js.map +1 -0
- package/esm/sdk/models/update-product-request.d.ts +14 -0
- package/esm/sdk/models/update-product-request.d.ts.map +1 -0
- package/esm/sdk/models/update-product-request.js +13 -0
- package/esm/sdk/models/update-product-request.js.map +1 -0
- package/esm/sdk/models/waterfall-cell.d.ts +23 -0
- package/esm/sdk/models/waterfall-cell.d.ts.map +1 -0
- package/esm/sdk/models/waterfall-cell.js +18 -0
- package/esm/sdk/models/waterfall-cell.js.map +1 -0
- package/esm/sdk/models/waterfall-request.d.ts +48 -0
- package/esm/sdk/models/waterfall-request.d.ts.map +1 -0
- package/esm/sdk/models/waterfall-request.js +34 -0
- package/esm/sdk/models/waterfall-request.js.map +1 -0
- package/esm/sdk/models/waterfall-response.d.ts +18 -0
- package/esm/sdk/models/waterfall-response.d.ts.map +1 -0
- package/esm/sdk/models/waterfall-response.js +19 -0
- package/esm/sdk/models/waterfall-response.js.map +1 -0
- package/esm/sdk/models/waterfall-row.d.ts +17 -0
- package/esm/sdk/models/waterfall-row.d.ts.map +1 -0
- package/esm/sdk/models/waterfall-row.js +25 -0
- package/esm/sdk/models/waterfall-row.js.map +1 -0
- package/esm/sdk/performance-obligations.d.ts +19 -0
- package/esm/sdk/performance-obligations.d.ts.map +1 -0
- package/esm/sdk/performance-obligations.js +28 -0
- package/esm/sdk/performance-obligations.js.map +1 -0
- package/esm/sdk/products.d.ts +47 -0
- package/esm/sdk/products.d.ts.map +1 -0
- package/esm/sdk/products.js +68 -0
- package/esm/sdk/products.js.map +1 -0
- package/esm/sdk/revenue-reports.d.ts +19 -0
- package/esm/sdk/revenue-reports.d.ts.map +1 -0
- package/esm/sdk/revenue-reports.js +28 -0
- package/esm/sdk/revenue-reports.js.map +1 -0
- package/esm/sdk/sdk.d.ts +18 -0
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +30 -0
- package/esm/sdk/sdk.js.map +1 -1
- package/examples/{activityListActivity.example.ts → accountingPeriodsQueryAccountingPeriod.example.ts} +2 -2
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/accounting-periods-query-accounting-period.ts +172 -0
- package/src/funcs/contracts-get-contract.ts +181 -0
- package/src/funcs/contracts-query-contract.ts +172 -0
- package/src/funcs/journal-entries-get-journal-entry.ts +181 -0
- package/src/funcs/journal-entries-query-journal-entry.ts +172 -0
- package/src/funcs/payments-list-payments.ts +1 -0
- package/src/funcs/performance-obligations-get-performance-obligation.ts +182 -0
- package/src/funcs/performance-obligations-query-performance-obligation.ts +172 -0
- package/src/funcs/products-create-product.ts +172 -0
- package/src/funcs/products-delete-product.ts +181 -0
- package/src/funcs/products-get-product.ts +181 -0
- package/src/funcs/products-list-products.ts +189 -0
- package/src/funcs/products-query-product.ts +172 -0
- package/src/funcs/products-update-product.ts +187 -0
- package/src/funcs/revenue-reports-get-revenue-rollforward.ts +172 -0
- package/src/funcs/revenue-reports-get-revenue-waterfall.ts +172 -0
- package/src/lib/config.ts +2 -2
- package/src/sdk/accounting-periods.ts +27 -0
- package/src/sdk/contracts.ts +45 -0
- package/src/sdk/journal-entries.ts +45 -0
- package/src/sdk/models/accounting-period-response.ts +60 -0
- package/src/sdk/models/accounting-period-status.ts +24 -0
- package/src/sdk/models/accountingperiod-filter.ts +100 -0
- package/src/sdk/models/amortization-method.ts +20 -0
- package/src/sdk/models/contract-association-response.ts +51 -0
- package/src/sdk/models/contract-filter.ts +106 -0
- package/src/sdk/models/contract-response.ts +76 -0
- package/src/sdk/models/contract-status.ts +26 -0
- package/src/sdk/models/create-price-request.ts +4 -0
- package/src/sdk/models/create-product-request.ts +44 -0
- package/src/sdk/models/delete-product-op.ts +33 -0
- package/src/sdk/models/get-contract-op.ts +33 -0
- package/src/sdk/models/get-journal-entry-op.ts +33 -0
- package/src/sdk/models/get-performance-obligation-op.ts +35 -0
- package/src/sdk/models/get-product-op.ts +33 -0
- package/src/sdk/models/index.ts +45 -0
- package/src/sdk/models/invoice-filter.ts +9 -0
- package/src/sdk/models/journal-direction.ts +19 -0
- package/src/sdk/models/journal-entry-response.ts +81 -0
- package/src/sdk/models/journal-event-type.ts +31 -0
- package/src/sdk/models/journal-filter.ts +129 -0
- package/src/sdk/models/journal-line-response.ts +55 -0
- package/src/sdk/models/ledger-account-key.ts +30 -0
- package/src/sdk/models/list-accounting-periods-response.ts +41 -0
- package/src/sdk/models/list-contracts-response.ts +41 -0
- package/src/sdk/models/list-journal-entries-response.ts +41 -0
- package/src/sdk/models/list-payments-op.ts +7 -0
- package/src/sdk/models/list-performance-obligations-response.ts +42 -0
- package/src/sdk/models/list-products-op.ts +89 -0
- package/src/sdk/models/list-products-response.ts +41 -0
- package/src/sdk/models/performance-obligation-association-response.ts +55 -0
- package/src/sdk/models/performance-obligation-response.ts +87 -0
- package/src/sdk/models/performance-obligation-status.ts +28 -0
- package/src/sdk/models/pob-filter.ts +112 -0
- package/src/sdk/models/price-filter.ts +4 -0
- package/src/sdk/models/price-price.ts +3 -0
- package/src/sdk/models/price-response.ts +3 -0
- package/src/sdk/models/product-filter.ts +90 -0
- package/src/sdk/models/product-response.ts +54 -0
- package/src/sdk/models/recognition-method.ts +25 -0
- package/src/sdk/models/rev-rec-entity-type.ts +29 -0
- package/src/sdk/models/revenue-breakdown.ts +40 -0
- package/src/sdk/models/revenue-report-group-by.ts +18 -0
- package/src/sdk/models/rollforward-request.ts +97 -0
- package/src/sdk/models/rollforward-response.ts +49 -0
- package/src/sdk/models/rollforward-row.ts +65 -0
- package/src/sdk/models/update-price-request.ts +7 -0
- package/src/sdk/models/update-product-op.ts +46 -0
- package/src/sdk/models/update-product-request.ts +33 -0
- package/src/sdk/models/waterfall-cell.ts +50 -0
- package/src/sdk/models/waterfall-request.ts +93 -0
- package/src/sdk/models/waterfall-response.ts +47 -0
- package/src/sdk/models/waterfall-row.ts +52 -0
- package/src/sdk/performance-obligations.ts +45 -0
- package/src/sdk/products.ts +119 -0
- package/src/sdk/revenue-reports.ts +45 -0
- package/src/sdk/sdk.ts +38 -0
package/FUNCTIONS.md
CHANGED
|
@@ -20,7 +20,7 @@ specific category of applications.
|
|
|
20
20
|
|
|
21
21
|
```typescript
|
|
22
22
|
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
23
|
-
import {
|
|
23
|
+
import { accountingPeriodsQueryAccountingPeriod } from "@flexprice/sdk/funcs/accounting-periods-query-accounting-period.js";
|
|
24
24
|
|
|
25
25
|
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
26
26
|
// You can create one instance of it to use across an application.
|
|
@@ -29,12 +29,12 @@ const flexprice = new FlexpriceCore({
|
|
|
29
29
|
});
|
|
30
30
|
|
|
31
31
|
async function run() {
|
|
32
|
-
const res = await
|
|
32
|
+
const res = await accountingPeriodsQueryAccountingPeriod(flexprice, {});
|
|
33
33
|
if (res.ok) {
|
|
34
34
|
const { value: result } = res;
|
|
35
35
|
console.log(result);
|
|
36
36
|
} else {
|
|
37
|
-
console.log("
|
|
37
|
+
console.log("accountingPeriodsQueryAccountingPeriod failed:", res.error);
|
|
38
38
|
}
|
|
39
39
|
}
|
|
40
40
|
|
package/USAGE.md
CHANGED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# AccountingPeriodResponse
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { AccountingPeriodResponse } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: AccountingPeriodResponse = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `id` | *string* | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `periodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `periodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `periodStatus` | [models.AccountingPeriodStatus](../../sdk/models/accounting-period-status.md) | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# AccountingPeriodStatus
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { AccountingPeriodStatus } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: AccountingPeriodStatus = "open";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"open" | "closed" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# AccountingperiodFilterOrder
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { AccountingperiodFilterOrder } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: AccountingperiodFilterOrder = "asc";
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Values
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
"asc" | "desc"
|
|
15
|
+
```
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# AccountingperiodFilter
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { AccountingperiodFilter } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: AccountingperiodFilter = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `accountingPeriodIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `expand` | *string* | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `filters` | [models.FilterCondition](../../sdk/models/filter-condition.md)[] | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `limit` | *number* | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `offset` | *number* | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `order` | [models.AccountingperiodFilterOrder](../../sdk/models/accountingperiod-filter-order.md) | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `periodStatuses` | [models.AccountingPeriodStatus](../../sdk/models/accounting-period-status.md)[] | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `sort` | [models.SortCondition](../../sdk/models/sort-condition.md)[] | :heavy_minus_sign: | N/A |
|
|
24
|
+
| `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# AmortizationMethod
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { AmortizationMethod } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: AmortizationMethod = "period_even_prorated";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"daily" | "period_even" | "period_even_prorated" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ContractAssociationResponse
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ContractAssociationResponse } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ContractAssociationResponse = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `entityId` | *string* | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `entityType` | [models.RevRecEntityType](../../sdk/models/rev-rec-entity-type.md) | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `id` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# ContractFilter
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ContractFilter } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ContractFilter = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `contractIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `contractStatuses` | [models.ContractStatus](../../sdk/models/contract-status.md)[] | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `customerIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `endedAtGte` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `expand` | *string* | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `filters` | [models.FilterCondition](../../sdk/models/filter-condition.md)[] | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `limit` | *number* | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `offset` | *number* | :heavy_minus_sign: | N/A |
|
|
24
|
+
| `order` | [models.ContractFilterOrder](../../sdk/models/contract-filter-order.md) | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `sort` | [models.SortCondition](../../sdk/models/sort-condition.md)[] | :heavy_minus_sign: | N/A |
|
|
26
|
+
| `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
27
|
+
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
28
|
+
| `subscriptionIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# ContractResponse
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ContractResponse } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ContractResponse = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `associations` | [models.ContractAssociationResponse](../../sdk/models/contract-association-response.md)[] | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `contractStatus` | [models.ContractStatus](../../sdk/models/contract-status.md) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `currency` | *string* | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `customerId` | *string* | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `endedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `id` | *string* | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `termEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
24
|
+
| `termStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ContractStatus
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ContractStatus } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ContractStatus = "ended";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"draft" | "active" | "ended" | "cancelled" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -41,6 +41,7 @@ let value: CreatePriceRequest = {
|
|
|
41
41
|
| `minQuantity` | *number* | :heavy_minus_sign: | MinQuantity is the minimum quantity of the price |
|
|
42
42
|
| `priceUnitConfig` | [models.PriceUnitConfig](../../sdk/models/price-unit-config.md) | :heavy_minus_sign: | N/A |
|
|
43
43
|
| `priceUnitType` | [models.PriceUnitType](../../sdk/models/price-unit-type.md) | :heavy_check_mark: | N/A |
|
|
44
|
+
| `productId` | *string* | :heavy_minus_sign: | N/A |
|
|
44
45
|
| `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
45
46
|
| `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
|
|
46
47
|
| `tiers` | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[] | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# CreateProductRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { CreateProductRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: CreateProductRequest = {
|
|
9
|
+
lookupKey: "<value>",
|
|
10
|
+
name: "<value>",
|
|
11
|
+
};
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Fields
|
|
15
|
+
|
|
16
|
+
| Field | Type | Required | Description |
|
|
17
|
+
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
18
|
+
| `description` | *string* | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `lookupKey` | *string* | :heavy_check_mark: | N/A |
|
|
20
|
+
| `name` | *string* | :heavy_check_mark: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# DeleteProductRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { DeleteProductRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: DeleteProductRequest = {
|
|
9
|
+
id: "<id>",
|
|
10
|
+
};
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
17
|
+
| `id` | *string* | :heavy_check_mark: | Product ID |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# GetContractRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { GetContractRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: GetContractRequest = {
|
|
9
|
+
id: "<id>",
|
|
10
|
+
};
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
17
|
+
| `id` | *string* | :heavy_check_mark: | Contract ID |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# GetJournalEntryRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { GetJournalEntryRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: GetJournalEntryRequest = {
|
|
9
|
+
id: "<id>",
|
|
10
|
+
};
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
17
|
+
| `id` | *string* | :heavy_check_mark: | Journal entry ID |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# GetPerformanceObligationRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { GetPerformanceObligationRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: GetPerformanceObligationRequest = {
|
|
9
|
+
id: "<id>",
|
|
10
|
+
};
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
|
17
|
+
| `id` | *string* | :heavy_check_mark: | Performance obligation ID |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# GetProductRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { GetProductRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: GetProductRequest = {
|
|
9
|
+
id: "<id>",
|
|
10
|
+
};
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
17
|
+
| `id` | *string* | :heavy_check_mark: | Product ID |
|
|
@@ -41,4 +41,5 @@ let value: InvoiceFilter = {};
|
|
|
41
41
|
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
42
42
|
| `subscriptionCustomerId` | *string*[] | :heavy_minus_sign: | subscription_customer_id filters invoices by the subscription owner's customer ID |
|
|
43
43
|
| `subscriptionId` | *string* | :heavy_minus_sign: | subscription_id filters invoices generated for a specific subscription<br/>Only returns invoices that were created as part of the specified subscription's billing |
|
|
44
|
+
| `updatedAtGte` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | updated_at_gte filters invoices updated at or after the given instant |
|
|
44
45
|
| `voidedAtGte` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | voided_at_gte filters invoices voided at or after the given instant |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# JournalDirection
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { JournalDirection } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: JournalDirection = "debit";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"debit" | "credit" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# JournalEntryResponse
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { JournalEntryResponse } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: JournalEntryResponse = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `accountingPeriodId` | *string* | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `businessDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `contractId` | *string* | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `currency` | *string* | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `customerId` | *string* | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `eventType` | [models.JournalEventType](../../sdk/models/journal-event-type.md) | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `id` | *string* | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `lines` | [models.JournalLineResponse](../../sdk/models/journal-line-response.md)[] | :heavy_minus_sign: | N/A |
|
|
24
|
+
| `reversalOf` | *string* | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `sourceEntityId` | *string* | :heavy_minus_sign: | N/A |
|
|
26
|
+
| `sourceEntityType` | [models.RevRecEntityType](../../sdk/models/rev-rec-entity-type.md) | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# JournalEventType
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { JournalEventType } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: JournalEventType = "invoice_voided";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"invoice_finalized" | "invoice_voided" | "credit_note_finalized" | "credit_note_voided" | "payment_succeeded" | "payment_reversed" | "refund_succeeded" | "revenue_earned" | "revenue_offset" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# JournalFilter
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { JournalFilter } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: JournalFilter = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `accountingPeriodIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `accounts` | [models.LedgerAccountKey](../../sdk/models/ledger-account-key.md)[] | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `contractIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `customerIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `eventTypes` | [models.JournalEventType](../../sdk/models/journal-event-type.md)[] | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `expand` | *string* | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `filters` | [models.FilterCondition](../../sdk/models/filter-condition.md)[] | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `journalEntryIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
24
|
+
| `limit` | *number* | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `offset` | *number* | :heavy_minus_sign: | N/A |
|
|
26
|
+
| `order` | [models.JournalFilterOrder](../../sdk/models/journal-filter-order.md) | :heavy_minus_sign: | N/A |
|
|
27
|
+
| `pobIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
28
|
+
| `sort` | [models.SortCondition](../../sdk/models/sort-condition.md)[] | :heavy_minus_sign: | N/A |
|
|
29
|
+
| `sourceEntityIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
30
|
+
| `sourceEntityType` | [models.RevRecEntityType](../../sdk/models/rev-rec-entity-type.md) | :heavy_minus_sign: | N/A |
|
|
31
|
+
| `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
32
|
+
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# JournalLineResponse
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { JournalLineResponse } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: JournalLineResponse = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
|
15
|
+
| `account` | [models.LedgerAccountKey](../../sdk/models/ledger-account-key.md) | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `amount` | *string* | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `direction` | [models.JournalDirection](../../sdk/models/journal-direction.md) | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `id` | *string* | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `pobId` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# LedgerAccountKey
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { LedgerAccountKey } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: LedgerAccountKey = "customer_credit";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"cash" | "accounts_receivable" | "unbilled_receivable" | "deferred_revenue" | "customer_credit" | "tax_payable" | "revenue" | "contra_revenue" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# ListAccountingPeriodsResponse
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ListAccountingPeriodsResponse } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ListAccountingPeriodsResponse = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
|
15
|
+
| `items` | [models.AccountingPeriodResponse](../../sdk/models/accounting-period-response.md)[] | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `pagination` | [models.PaginationResponse](../../sdk/models/pagination-response.md) | :heavy_minus_sign: | N/A |
|