{"info":{"_postman_id":"7fb574ce-809c-4394-9eda-15923ac95813","name":"Financials System Client Integrations","description":"

The financials system allows integrated parties to connect to the payments process throughout the Financials Module.

\n

All below calls are authenticated via a JWT token strategy. These tokens will expire after a pre-determined period.

\n

All time representations are in UTC

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4577361","collectionId":"7fb574ce-809c-4394-9eda-15923ac95813","publishedId":"2s93RXsAtx","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-04-05T06:57:43.000Z"},"item":[{"name":"Authentication","item":[{"name":"Get JWT","id":"21a932e0-c3b1-4812-ba1d-db5fc97df0e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{JWT}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/accessmanagement/login/sending-system","urlObject":{"path":["accessmanagement","login","sending-system"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"21a932e0-c3b1-4812-ba1d-db5fc97df0e6"}],"id":"b8f930fd-be3a-4c23-bef8-f89723e9024c","description":"

Here we consume your provided Api-Key to return a JWT token used in calls across the financials system. Once the token is recieved, pass into all future calls under the Authorization header.

\n

Eg:

\n

\"Authorization\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\"

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"635fe495-e3ae-4f2a-ba5d-5bdd60960f02","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"79e56a60-31ea-484f-b201-760bfdcff7ef","type":"text/javascript","exec":[""]}}],"_postman_id":"b8f930fd-be3a-4c23-bef8-f89723e9024c"},{"name":"Engagements","item":[{"name":"Get Enagements","id":"8842ddcf-e3ac-4827-8dbb-447de00c193c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"DriverUids\": [],\n \"StartDate\": \"2023-05-26T00:00:00Z\",\n \"EndDate\": \"2023-05-26T23:59:59.99Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/financials/engagement/get-engagements","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWT}}"}]},"isInherited":true,"source":{"_postman_id":"7fb574ce-809c-4394-9eda-15923ac95813","id":"7fb574ce-809c-4394-9eda-15923ac95813","name":"Financials System Client Integrations","type":"collection"}},"urlObject":{"path":["financials","engagement","get-engagements"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8842ddcf-e3ac-4827-8dbb-447de00c193c"}],"id":"cdb63621-4098-4d05-80b9-9cfb63b8d44f","_postman_id":"cdb63621-4098-4d05-80b9-9cfb63b8d44f","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWT}}"}]},"isInherited":true,"source":{"_postman_id":"7fb574ce-809c-4394-9eda-15923ac95813","id":"7fb574ce-809c-4394-9eda-15923ac95813","name":"Financials System Client Integrations","type":"collection"}}},{"name":"Ledgers","item":[{"name":"Create driver ledger entry","id":"6d6eb665-d4b4-4199-b0c6-a5f3e078a0d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"DriverUid\": \"in labore\",\n \"Amount\": 100.00,\n \"Description\": \"Test via Integration\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/financials/driver-ledger-entry/create-entry","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWT}}"}]},"isInherited":true,"source":{"_postman_id":"7fb574ce-809c-4394-9eda-15923ac95813","id":"7fb574ce-809c-4394-9eda-15923ac95813","name":"Financials System Client Integrations","type":"collection"}},"urlObject":{"path":["financials","driver-ledger-entry","create-entry"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6d6eb665-d4b4-4199-b0c6-a5f3e078a0d1"}],"id":"2f407d6e-d90c-4e27-b9c5-cf8065ba8892","_postman_id":"2f407d6e-d90c-4e27-b9c5-cf8065ba8892","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWT}}"}]},"isInherited":true,"source":{"_postman_id":"7fb574ce-809c-4394-9eda-15923ac95813","id":"7fb574ce-809c-4394-9eda-15923ac95813","name":"Financials System Client Integrations","type":"collection"}}},{"name":"Payment Runs","item":[{"name":"Get Payment Runs","id":"7c6853b0-b492-4a20-9bdd-866781e9124f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"VendorUid\": \"{{VendorUid}}\",\n \"FromDate\": \"2023-01-01T06:20:29.895Z\",\n \"ToDate\": \"2023-04-27T06:20:29.895Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/financials/payment-run/get-payment-runs","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWT}}"}]},"isInherited":true,"source":{"_postman_id":"7fb574ce-809c-4394-9eda-15923ac95813","id":"7fb574ce-809c-4394-9eda-15923ac95813","name":"Financials System Client Integrations","type":"collection"}},"urlObject":{"path":["financials","payment-run","get-payment-runs"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7c6853b0-b492-4a20-9bdd-866781e9124f"},{"name":"Get Payment Run","id":"56ab6f39-6c72-4543-849d-7f6676b14618","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"PaymentRunHeaderUid\": \"{{paymentRunHeaderUid}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/financials/payment-run/get-payment-run","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWT}}"}]},"isInherited":true,"source":{"_postman_id":"7fb574ce-809c-4394-9eda-15923ac95813","id":"7fb574ce-809c-4394-9eda-15923ac95813","name":"Financials System Client Integrations","type":"collection"}},"urlObject":{"path":["financials","payment-run","get-payment-run"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"56ab6f39-6c72-4543-849d-7f6676b14618"},{"name":"Process payment run","id":"efe33edb-12ed-4ce6-ba30-0ca1068e52c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PaymentMethod\": \"ManualPayment\",\n \"VendorUid\": \"{{vendorUid}}\",\n \"DriverUids\": [\n \"{{driverUid}}\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/financials/payment-run/process","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWT}}"}]},"isInherited":true,"source":{"_postman_id":"7fb574ce-809c-4394-9eda-15923ac95813","id":"7fb574ce-809c-4394-9eda-15923ac95813","name":"Financials System Client Integrations","type":"collection"}},"urlObject":{"path":["financials","payment-run","process"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"efe33edb-12ed-4ce6-ba30-0ca1068e52c2"},{"name":"Download payment run","id":"bbe0e7c3-744c-47c0-807a-2dfa8445dc3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"PaymentRunHeaderUid\": \"{{paymentRunHeaderUid}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/financials/payment-run/download-payment-run","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWT}}"}]},"isInherited":true,"source":{"_postman_id":"7fb574ce-809c-4394-9eda-15923ac95813","id":"7fb574ce-809c-4394-9eda-15923ac95813","name":"Financials System Client Integrations","type":"collection"}},"urlObject":{"path":["financials","payment-run","download-payment-run"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bbe0e7c3-744c-47c0-807a-2dfa8445dc3b"}],"id":"46c0ece2-54fb-49c7-9c57-d6eb9dce8762","_postman_id":"46c0ece2-54fb-49c7-9c57-d6eb9dce8762","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWT}}"}]},"isInherited":true,"source":{"_postman_id":"7fb574ce-809c-4394-9eda-15923ac95813","id":"7fb574ce-809c-4394-9eda-15923ac95813","name":"Financials System Client Integrations","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWT}}"}]}},"event":[{"listen":"prerequest","script":{"id":"ef25754b-7fff-40b2-961c-a20aac04dc4c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3a011b35-3ebd-4de9-ad98-7f61185d8824","type":"text/javascript","exec":[""]}}]}