{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Pricing & Charges","description":"The operational transportation management API. Full access to planning, tracking, invoicing, and integrations — built on the OTM5 open data standard.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"pricing--charges","__idx":0},"children":["Pricing & Charges"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Manage pricing rules, execute charges, track transactions, and view ledger entries. Transportial's financial system supports configurable rate structures, automated pricing, and full financial reporting."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"pricing-rules","__idx":1},"children":["Pricing Rules"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Pricing rules define how transport costs are calculated — per kilometer, per hour, per pallet, or custom formulas."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-a-pricing-rule","__idx":2},"children":["Create a Pricing Rule"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/pricing \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"name\": \"Standard road rate - NL\",\n    \"type\": \"distance\",\n    \"rate\": 1.25,\n    \"currency\": \"EUR\",\n    \"unit\": \"km\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-a-pricing-rule","__idx":3},"children":["Get a Pricing Rule"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.otms.transportial.com/api/pricing/{id}\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-pricing-rules","__idx":4},"children":["List Pricing Rules"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.otms.transportial.com/api/pricings/0/20\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"search-pricing-rules","__idx":5},"children":["Search Pricing Rules"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \"https://api.otms.transportial.com/api/pricings/search/0/20\" \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"type\": \"distance\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"pricing-variable-indexes","__idx":6},"children":["Pricing Variable Indexes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Variable indexes allow dynamic pricing based on fuel surcharges, seasonal rates, or other variable factors."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-a-variable-index","__idx":7},"children":["Create a Variable Index"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/pricingVariableIndex \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"name\": \"Fuel surcharge index Q1 2026\",\n    \"value\": 1.15\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-variable-indexes","__idx":8},"children":["List Variable Indexes"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.otms.transportial.com/api/pricingVariableIndexes/0/20\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"charges","__idx":9},"children":["Charges"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Charges are one-time or recurring financial events linked to transport operations."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-a-charge","__idx":10},"children":["Create a Charge"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/charge \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"name\": \"Waiting time surcharge\",\n    \"amount\": 75.00,\n    \"currency\": \"EUR\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"execute-a-charge","__idx":11},"children":["Execute a Charge"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Process a charge against a transport entity:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/charge/execute \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"chargeId\": \"charge-uuid\",\n    \"entityId\": \"transport-order-uuid\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"payouts","__idx":12},"children":["Payouts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Track payouts to carriers, subcontractors, or drivers."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-a-payout","__idx":13},"children":["Create a Payout"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/payout \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"name\": \"Weekly payout - Carrier XYZ\",\n    \"amount\": 3500.00,\n    \"currency\": \"EUR\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-payouts","__idx":14},"children":["List Payouts"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.otms.transportial.com/api/payouts/0/20\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"transactions","__idx":15},"children":["Transactions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["View all financial transactions on your platform."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-a-transaction","__idx":16},"children":["Get a Transaction"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.otms.transportial.com/api/transaction/{id}\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-transactions","__idx":17},"children":["List Transactions"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# All transactions\ncurl -X GET \"https://api.otms.transportial.com/api/transactions/0/20\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n\n# By user\ncurl -X GET \"https://api.otms.transportial.com/api/transactions/user/{userId}/0/20\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n\n# By business\ncurl -X GET \"https://api.otms.transportial.com/api/transactions/business/{businessId}/0/20\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n\n# By date range\ncurl -X GET \"https://api.otms.transportial.com/api/transactions/date/2026-03-01/2026-03-31\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"ledger-entries","__idx":18},"children":["Ledger Entries"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ledger entries provide a detailed financial audit trail."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"by-entity","__idx":19},"children":["By Entity"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/ledgerEntriesByEntity \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"entityId\": \"transport-order-uuid\",\n    \"entityType\": \"transportOrder\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"by-date-range","__idx":20},"children":["By Date Range"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/ledgerEntriesByDateRange \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"startDate\": \"2026-03-01\",\n    \"endDate\": \"2026-03-31\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"by-category-and-date-range","__idx":21},"children":["By Category and Date Range"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/ledgerEntriesByCategoryAndDateRange \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"category\": \"revenue\",\n    \"startDate\": \"2026-03-01\",\n    \"endDate\": \"2026-03-31\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"financial-insights","__idx":22},"children":["Financial Insights"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"financial-overview","__idx":23},"children":["Financial Overview"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.otms.transportial.com/api/management/financial/{administrationId}/2026-03-01/2026-03-31\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"operational-overview","__idx":24},"children":["Operational Overview"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.otms.transportial.com/api/management/operational/2026-03-01/2026-03-31\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"trips-per-day","__idx":25},"children":["Trips Per Day"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.otms.transportial.com/api/management/operational/tripsPerDay/2026-03-01/2026-03-31\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"pricing-categories","__idx":26},"children":["Pricing Categories"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get and update the pricing categories used across your platform:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Get categories\ncurl -X GET https://api.otms.transportial.com/api/pricingCategories \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n\n# Update categories\ncurl -X PUT https://api.otms.transportial.com/api/pricingCategories \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '[\n    { \"name\": \"Base rate\" },\n    { \"name\": \"Fuel surcharge\" },\n    { \"name\": \"Waiting time\" },\n    { \"name\": \"Loading/unloading\" }\n  ]'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":27},"children":["Next Steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Generate invoices from pricing data in ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/invoicing-and-finance"},"children":["Invoicing & Finance"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Apply pricing to transport orders in the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/quickstart"},"children":["Quickstart guide"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["See the full ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis"},"children":["API Reference"]}," for all pricing endpoints"]}]}]},"headings":[{"value":"Pricing & Charges","id":"pricing--charges","depth":1},{"value":"Pricing Rules","id":"pricing-rules","depth":2},{"value":"Create a Pricing Rule","id":"create-a-pricing-rule","depth":3},{"value":"Get a Pricing Rule","id":"get-a-pricing-rule","depth":3},{"value":"List Pricing Rules","id":"list-pricing-rules","depth":3},{"value":"Search Pricing Rules","id":"search-pricing-rules","depth":3},{"value":"Pricing Variable Indexes","id":"pricing-variable-indexes","depth":2},{"value":"Create a Variable Index","id":"create-a-variable-index","depth":3},{"value":"List Variable Indexes","id":"list-variable-indexes","depth":3},{"value":"Charges","id":"charges","depth":2},{"value":"Create a Charge","id":"create-a-charge","depth":3},{"value":"Execute a Charge","id":"execute-a-charge","depth":3},{"value":"Payouts","id":"payouts","depth":2},{"value":"Create a Payout","id":"create-a-payout","depth":3},{"value":"List Payouts","id":"list-payouts","depth":3},{"value":"Transactions","id":"transactions","depth":2},{"value":"Get a Transaction","id":"get-a-transaction","depth":3},{"value":"List Transactions","id":"list-transactions","depth":3},{"value":"Ledger Entries","id":"ledger-entries","depth":2},{"value":"By Entity","id":"by-entity","depth":3},{"value":"By Date Range","id":"by-date-range","depth":3},{"value":"By Category and Date Range","id":"by-category-and-date-range","depth":3},{"value":"Financial Insights","id":"financial-insights","depth":2},{"value":"Financial Overview","id":"financial-overview","depth":3},{"value":"Operational Overview","id":"operational-overview","depth":3},{"value":"Trips Per Day","id":"trips-per-day","depth":3},{"value":"Pricing Categories","id":"pricing-categories","depth":2},{"value":"Next Steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Pricing & Charges"}},"lastModified":"2026-03-22T21:04:26.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/pricing-and-charges","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}