Introduction
Uome's API Reference provides a set of endpoints for managing financial transactions between users. It allows users to send and receive payments, manage their accounts, and retrieve transaction history. The Uome API Reference Guide provides developers with the information needed to integrate Uome into their own applications, allowing them to offer their users a secure and seamless financial experience.
The Uome API Reference Guide provides detailed information on each endpoint, including request and response formats, authentication methods, and sample code snippets in multiple programming languages. It also includes information on error handling and troubleshooting, as well as best practices for integrating Uome into your application. The guide is designed to be used in conjunction with the Uome API itself, making it easy for developers to start making API requests and building their financial applications.
Why you find this section not helpful?
API Access
Accessing the Uome API requires the use of a client ID and secret key, which must be obtained from Uome after you have agreed to our terms of use. The client ID is used to identify your application and the secret key is used to secure your API requests and ensure that only your application has access to the data you request from Uome. Both the client ID and secret key must be included in every API request made to Uome.
To ensure the security of your data, it is recommended that you keep your secret key confidential and store it securely. Do not include it in client-side code or share it with anyone else, as this could compromise the security of your data and your users' financial information. When making API requests, the client ID and secret key should be passed as headers in the request, along with any other required parameters and authentication information. Once you have obtained your client ID and secret key, you can start making API requests to Uome and integrating their financial services into your own application.
Why you find this section not helpful?
Base URL
Versioning
Uome API is versioned, which means that different versions of the API may be released over time with different features, bug fixes, and improvements. When a new version of the API is released, it is best to maintain backwards compatibility so that existing applications that are already integrated with the Uome API will continue to work as expected.
To maintain backwards compatibility, it is recommended that Uome API keep the existing endpoints, request and response formats, and data structures intact. When new features or changes are added, they should be added as new endpoints or additional data fields, rather than changing the existing endpoints or data structures. This allows existing applications to continue using the old version of the API, while new applications can take advantage of the new features and improvements in the latest version.
It is also recommended that Uome API include a version in the URL of each API endpoint, so that developers can specify which version of the API they want to use. This allows developers to easily switch between different versions of the API as needed, and ensures that their applications will continue to work even if a new version of the API is released in the future. By following these best practices for API versioning and backwards compatibility, Uome can ensure that their API remains stable and usable for years to come.
Why you find this section not helpful?
Sign Up
Uome's sign up API enables new users to create an account and have their information stored in the database. The API provides a secure and efficient way for users to sign up and get started with Uome, giving them access to all its features and benefits.
Why you find this section not helpful?
Endpoints
POST
Create account
The getStarted API is used to create a new user account. It is a RESTful API that allows developers to programmatically create a new user account by sending a HTTP POST request to the API endpoint with the necessary information as the request body. Once the API is successfully executed, it returns a response indicating the status of the request and any relevant information regarding the newly created user account.
An email will be sent to the user with a validate email link.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
First name of the user
Last name of the user
The email address of the user
Password of the user
Responses
Response attributes
Response attributes
Response attributes
Response attributes
Why you find this section not helpful?
Base URL
Login
The Uome Login API is an endpoint that allows you to authenticate users and reset their passwords. It provides a secure and convenient way for users to log into your application and access their financial information. The Login API uses industry standard authentication methods, such as email/password or OAuth2, to ensure the security of your users' data.
The Login API provides endpoints for handling user authentication and password reset functionality. When a user logs in, you can use the authentication endpoint to verify their credentials and receive an access token that can be used to make API requests on their behalf. If a user forgets their password, you can use the password reset endpoint to send a password reset email to the user. Once the user has reset their password, they can log in using the new password and access their financial information. The Login API also includes error handling and troubleshooting information, so you can easily handle any issues that arise during the login process. With the Uome Login API, you can provide your users with a secure and seamless login experience, and easily manage their financial transactions.
Why you find this section not helpful?
Endpoints
POST
POST
Authenticate
The authenticateJwtProfile API is used to authenticate users and retrieve their profile information. This API allows users to access their profile information after logging in to the application, by sending a HTTP POST request to the API endpoint with their JSON Web Token (JWT). The API then validates the JWT and returns the user's profile information, including details such as their name, address, and account status.
HEADER PARAMETERS
mimeType
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
The username to authenticate
Password of the user
Responses
Response attributes
Response attributes
Why you find this section not helpful?
Base URL
Forgot password
The forgotPasswordJwt API is used to enable users to reset their password if they have forgotten it. This API allows users to initiate a password reset by sending a HTTP POST request to the API endpoint with their email address. The API then generates a JSON Web Token (JWT) and sends it to the user's email address, along with instructions for resetting their password. The user can then use the JWT to access a password reset page, where they can enter a new password.
HEADER PARAMETERS
mimeType
BODY PARAMETERS
Username of the user
child attributes
User login ID
Responses
Response attributes
Response attributes
Response attributes
Why you find this section not helpful?
Base URL
Upload Files
Uome uses Amazon AWS to upload media and retrieve attachments. In order to upload a file you must first obtain a pre-signed URL relevant to the API you are using e.g. chat media upload, upload avatar, expense attachment.
The obtain endpoint URL returns a pre-signed URL for each individual file. This is a temporary URL that allows access to the S3 bucket for a limited time period.
To generate a pre-signed URL, you must use the respective ‘obtain upload url’ API for the service for e.g.
- Chat media uploads - /upload/obtainUploadUrl
- Profile avatar - /profile/obtainPostAvatarUrl
- Expenses attachment - /expenses/uploadUrl
- RTB expenses attachment - /expenses/uploadRTBUrl
Once you have the pre-signed URL, you can use it to upload your media file.
Your client-side process can use this URL to upload the file to the relevant s3 bucket.
Why you find this section not helpful?
Account Settings
Uome's account settings API provides a secure and convenient way for users to update their information, such as personal details, or security settings. The API utilizes RESTful principles for handling requests and responses and is easily integratable with various types of applications. This API allows users to have full control over their account information, keeping it up-to-date and secure at all times.
Why you find this section not helpful?
Endpoints
POST
POST
POST
POST
POST
POST
Obtain upload url
The obtainPostAvatarUrl API is used to get a URL for uploading and storing media, such as a profile picture or avatar. This API allows the user to upload images or other media files to a server, where they can be stored and retrieved at a later time. The API generates a unique AWS signed URL for the user to upload the media to, which can then be stored in the database along with information about the user.
Learn more about uploading files here
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
User JW Token
File name of image
Responses
Response attributes
Response attributes
child attributes
Response attributes
Why you find this section not helpful?
Base URL
Link profile avatar
The upload avatar API stores the relevant file name of the image against the user collection. This profile icon serves as their visual representation in the app. This icon is also stored against the profile for use in generated documents and other parts of the app.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
User JW Token
File name of image
Responses
Response attributes
Response attributes
child attributes
Why you find this section not helpful?
Base URL
Profile details
The profile details API is used to store information about the user profile, including the user's name, contact information, and address. This information is used to personalize the user's experience and help with communication and billing purposes.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
User JW Token
First name of the user
Last name of the user
Telephone number for the user
The user's address line 1
The user's address line 2
The city of the user
The user's postal code
Country of the user
Country code of the user
Responses
Response attributes
Response attributes
Why you find this section not helpful?
Base URL
Company details
The company details API is used to store important information about the user's company such as company name, company registration number, VAT number, and industry type. This information is used to identify the company for various business purposes such as invoicing and payment processing.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Responses
Response attributes
Response attributes
Why you find this section not helpful?
Base URL
Bank details
The bank details API allows users to store their banking information, such as the name on the account, account number, and sort code, for use in processing customer payments. This information is securely stored and can be easily retrieved for use in transactions, helping to streamline the payment process and reduce the risk of errors or misunderstandings. This API is an essential tool for businesses looking to improve the efficiency and reliability of their financial processes, while also maintaining the security of sensitive information.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
User JW token
Name on bank account
The user's sort code
The user's account number
Financial institution
Responses
Response attributes
Response attributes
Why you find this section not helpful?
Base URL
Purchase orders on/off
The purchase order setting API allows businesses to enable customers to place orders directly, using items from the business's catalogue. By using this API, businesses can streamline their order process, reducing administrative overhead and improving the customer experience. This can help to drive sales and improve customer satisfaction, leading to stronger relationships and increased loyalty over time.
Go to catalogue section to for purchase order flow
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
User JW Token
A for active and I for inactive
Responses
Response attributes
Response attributes
Response attributes
child attributes
Response attributes
Why you find this section not helpful?
Base URL
Contacts
The Uome Contacts API is a feature within the Uome ecosystem that allows users to add and manage contacts for their customer relationship management (CRM) purposes. This API enables users to store and organize important information about their contacts, such as their names, email addresses, and phone numbers, and use this information to build and maintain strong relationships with their customers. The API provides a simple and user-friendly interface for adding, updating, and retrieving contact information, making it easy for users to manage their customer relationships in an efficient and organized manner.
Why you find this section not helpful?
Endpoints
POST
Add contact
The add contacts API allows users to store information about their contacts, such as name, email, and phone number. This information can be used to manage relationships and facilitate communication with clients, suppliers, and other key stakeholders.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
User JW Token
Email address of the contact
First name of the contact
Last name of the contact
Telephone number of the contact
Company of the contact
Address line 1 of the contact
Address line 2 of the contact
City of the contact
Postcode of the contact
Country of the contact
Country code for the contact
Responses
Response attributes
Response attributes
Response attributes
Response attributes
Why you find this section not helpful?
Base URL
Chat CRM
Uome's chat API enables users to communicate with clients through a messaging platform. The API allows users to send messages, documents, media, and actions, providing a rich and dynamic way to manage client relationships. With Uome's chat API, users can have real-time conversations, share information and files, and take actions directly within the platform, eliminating the need for multiple tools and increasing efficiency. The API is designed to be user-friendly, providing a seamless experience for both users and clients. With Uome's chat API, users can improve client relationships and streamline communication, making it easier to do business.
Why you find this section not helpful?
Endpoints
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST
Role for group
The group role API allows users to receive a role for group token which is used to generate messages and documents between two specific users. This information is used to determine the user's permissions and capabilities within the group.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
User JW Token
Group id from groups collection
Responses
Response attributes
Response attributes
Response attributes
child attributes
Response attributes
Why you find this section not helpful?
Base URL
Display avatar
The group list avatar API retrieves profile icons for all members in the chat function. This allows users to easily identify participants and helps to create a visually appealing interface for group conversations.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
User JW Token
Responses
Response attributes
child attributes
Response attributes
child attributes
Why you find this section not helpful?
Base URL
Group lists
The group info API retrieves the list of groups and their details such as the name, description, and members associated with the user in the Uome ecosystem. This API provides users with an overview of all the groups they are part of, making it easier to manage and navigate the groups within the app.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
User JW Token
Group id from groups collection
Responses
Response attributes
child attributes
Response attributes
child attributes
Response attributes
Why you find this section not helpful?
Base URL
FCM token
The chat token API is used to verify the token for the user's access to the chat platform. This ensures secure communication by verifying the identity of the user before allowing them to send messages within the chat.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
User JW Token
Fcm token from userChatTokens collection
Responses
Response attributes
child attributes
Response attributes
child attributes
Why you find this section not helpful?
Base URL
Chat history
The chat history API retrieves a record of past messages and conversations for a user. It provides a convenient way for users to view previous interactions in the chat and retrieve important information.
Use skip or limit to return a certain number of messages.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Sort order descending
Skip messages already loaded to show next batch
Amount of messages to limit
Responses
Response attributes
child attributes
Response attributes
child attributes
Why you find this section not helpful?
Base URL
Chat text
The FCM chat text API enables users to send secure and encrypted text messages within the chat environment. The API uses Firebase Cloud Messaging technology to deliver the messages to the intended recipients.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
child attributes
Message to be sent
Responses
Response attributes
child attributes
Response attributes
child attributes
Why you find this section not helpful?
Base URL
Obtain chat upload url
The obtain upload url API retrieves a secure URL for uploading media files in the chat. The API enables users to send and store images, videos, and other types of media files in the chat.
Read more about uploading files here
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
File name of media
Responses
Response attributes
Response attributes
child attributes
Response attributes
Why you find this section not helpful?
Base URL
Upload chat media
The link content API allows users to upload and share media files such as images and videos in the chat. It helps to provide more context and make communication more engaging for all users involved in the chat.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
new-fence.mp4
Description of upload
File extension
Responses
Response attributes
child attributes
Response attributes
Response attributes
Response attributes
child attributes
Why you find this section not helpful?
Base URL
Get information
The information API is a powerful tool for displaying relevant information in the chat. It enables users to access information about other users, clients, and catalogue items, making it a central hub for all the data necessary for effective communication and collaboration in the chat.
Why you find this section not helpful?
User information
The user info API retrieves information about the group users such as name, profile picture, role and date joined. This information can be used to manage group members and display in the chat.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Responses
Response attributes
child attributes
Response attributes
child attributes
Why you find this section not helpful?
Base URL
Client information
The client info API retrieves relevant information about the clients for the group. This information can include the client's contact details, billing information, and any previous interactions with the group.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Responses
Response attributes
child attributes
Response attributes
child attributes
Why you find this section not helpful?
Base URL
Payment information
The get user API retrieves information about a specific user in the group, including payment information. This information can be used to manage transactions and payments within the group chat.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
User id from users collection
Responses
Response attributes
child attributes
Response attributes
child attributes
Why you find this section not helpful?
Base URL
Geo location
The geo location API is used to retrieve the client's address and display it in a navigation map app stored on the user's device. This makes it easier for the user to find the client's location and plan their route to the destination.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Responses
Response attributes
child attributes
child attributes
child attributes
child attributes
child attributes
child attributes
child attributes
child attributes
Response attributes
child attributes
Why you find this section not helpful?
Base URL
Catalogue items
The contact catalogue API allows businesses to display all the items in their product catalogue to customers via the chat. This API helps customers initiate purchase orders by selecting items from the catalogue directly in the chat interface.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Responses
Response attributes
child attributes
Response attributes
child attributes
Why you find this section not helpful?
Base URL
Record types
The records API is a feature in the chat system that allows users to view various records within the chat interface, such as quotes, invoices, and orders. This API enables quick and easy access to important information and helps users stay organized and up-to-date with their transactions.
Why you find this section not helpful?
Quote record
The quote record info API retrieves information about quotes for the user, such as the quote description, date, and price, and displays it in chat. This information is used to keep track of the quotes generated for clients and can be accessed easily for reference purposes.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Quote object from quotes collection
Responses
Response attributes
child attributes
Response attributes
child attributes
Response attributes
Why you find this section not helpful?
Base URL
Invoice record
The invoice record info API retrieves the necessary information about invoices, such as amount, date, and items, to display in the chat interface. This information helps the user stay organised and up-to-date with their financial transactions.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Transaction id of invoice in ledgerGroups
Responses
Response attributes
child attributes
child attributes
Response attributes
child attributes
Response attributes
Why you find this section not helpful?
Base URL
Order record
The order record Info API retrieves information about an order made by a customer for a specific product or service. This information can include the date of the order, the products or services requested, and the customer's details. The API allows this information to be displayed in the chat for easy reference and management.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Order object from orders collection table
Responses
Response attributes
child attributes
Response attributes
child attributes
Response attributes
Why you find this section not helpful?
Base URL
Quotes
The Uome Quote API includes endpoints for creating and managing quotes, including the ability to generate quotes, approve quotes, reject quotes, and send reminders. When a client generates a quote, they can use the create quote endpoint to create a quote document that outlines the terms of the proposed financial agreement. The approve quote endpoint allows clients to approve the quote and start the financial agreement. The reject quote endpoint allows clients to reject the quote if it does not meet their needs. The send reminder endpoint allows clients to send reminders to Uome about their quote and keep the quote process moving forward. With the Uome Quote API, clients have full control over their quotes and can easily manage their financial agreements with Uome.
Why you find this section not helpful?
Endpoints
POST
POST
POST
POST
POST
Create quote
The create quote API generates a quote for the client, providing an estimate of the cost and scope of work that will be performed. By using this API, businesses can create professional and detailed quotes that clearly communicate the services they offer, the expected results, and the associated costs. This helps to build trust and credibility with clients, improving the chances of winning new business and building strong relationships.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
The user who is generating the quote
child attributes
Role for group JW Token
Currency
Items in array
child attributes
Friendly user reference
Date when the quote is due
User notes for the quote
Responses
Response attributes
Response attributes
child attributes
Response attributes
Why you find this section not helpful?
Base URL
Approve quote
The approve quote API is used to mark a quote as approved and automatically convert it into an invoice for the client. This API streamlines the invoicing process, allowing clients to quickly and easily approve quotes and move on to the payment stage. By automating this process, businesses can save time and reduce the risk of errors, ensuring that invoices are generated accurately and efficiently.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Quote object to update
Responses
Response attributes
Response attributes
Response attributes
Response attributes
Response attributes
child attributes
Response attributes
Why you find this section not helpful?
Base URL
Reject quote
The reject quote API enables clients to decline a quote that has been sent to them. By using this API, clients can quickly and easily reject a quote and provide feedback to the business about why it was not suitable for their needs. This helps businesses improve their processes and increase their chances of winning future deals.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Quote object to update
Responses
Response attributes
Response attributes
Response attributes
Response attributes
Response attributes
child attributes
Response attributes
Why you find this section not helpful?
Base URL
Send reminder
The send quote reminder API allows businesses to send a one-off reminder to clients who have received a quote but have not yet approved or rejected it. This helps to follow up on outstanding quotes and keep the sales process moving forward, ensuring that quotes are not forgotten and helping businesses close more deals.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Quote object to send reminder
Responses
Response attributes
Response attributes
Response attributes
child attributes
Response attributes
Why you find this section not helpful?
Base URL
List all quotes
The get quotes API allows users to retrieve the quotes they have generated and stored within the system, filtered by month and year. This feature provides users with quick access to the quotes they need, making it easier to track quotes and their status over time.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
User JW Token
Date of quotes to return in certain month
Responses
Response attributes
child attributes
child attributes
Response attributes
Response attributes
child attributes
Why you find this section not helpful?
Base URL
Invoices
Uome's invoice API enables users to bill clients, cancel invoices, send reminders, and manually settle invoices. The API provides a comprehensive solution for invoicing, allowing users to manage the entire process, from billing to settlement, with ease and efficiency, improving cash flow and streamlining financial operations.
Why you find this section not helpful?
Endpoints
POST
POST
POST
POST
POST
POST
POST
Create invoice
The create invoice API is used to generate invoices in an automated manner. It takes the necessary information, such as the client's details and the items or services being invoiced, and creates a professional, formatted invoice that can be sent to the client.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Currency
child attributes
Friendly reference
Date when invoice is due
Additional notes
Responses
Response attributes
Response attributes
child attributes
Response attributes
Why you find this section not helpful?
Base URL
Send reminder
The send invoice reminder API can be used to send a one-off reminder to a client with an outstanding invoice. This allows businesses to manually trigger a reminder, in addition to any automated reminders that may already be in place, helping to ensure prompt payment and reduce the amount of time spent following up on overdue invoices.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Transaction id of invoice
Responses
Response attributes
Response attributes
child attributes
Response attributes
Response attributes
Why you find this section not helpful?
Base URL
Address request
The address request API triggers an email to the client if their address is not on file for invoice generation. The API requests the client's updated address information to ensure the accuracy of invoice generation.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Responses
Response attributes
Response attributes
child attributes
Why you find this section not helpful?
Base URL
Mark as paid
The mark as paid API allows users to manually settle an invoice transaction by updating the ledger to reflect that the invoice has been paid. This API is often used when payment is made outside of the system and the user wants to manually update the status of the invoice.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Ledger object to update
Responses
Response attributes
Response attributes
Response attributes
child attributes
Response attributes
Response attributes
Why you find this section not helpful?
Base URL
Cancel transaction
The cancelTransaction API allows a user to cancel an invoice by reversing the transaction and updating the ledger. It enables businesses to correct mistakes and manage their finances effectively in the Uome ecosystem.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Ledger object to update
Responses
Response attributes
Response attributes
Response attributes
child attributes
Response attributes
Response attributes
Response attributes
Why you find this section not helpful?
Base URL
List all invoices
The get invoices API allows the user to retrieve invoices generated in the Uome ecosystem, with the ability to sort the results by date. This API provides a convenient way to access and view past invoices and their related information.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
User JW Token
Date of invoices to return in certain month
Responses
Response attributes
child attributes
child attributes
Response attributes
Response attributes
child attributes
Why you find this section not helpful?
Base URL
Related expenses
The expenses invoice API allows users to view and manage expenses related to a specific invoice. This can be helpful in tracking expenses, reviewing costs, and ensuring accurate accounting.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Ledger object to retrieve information
Responses
Response attributes
child attributes
Response attributes
child attributes
Response attributes
Response attributes
Why you find this section not helpful?
Base URL
Orders
Uome's purchase order API enables clients to make orders directly to the business user with built-in approval flows. The API streamlines the ordering process, allowing clients to place orders and receive approvals in a timely and efficient manner, while also providing the necessary transparency and accountability to manage the procurement process effectively.
Why you find this section not helpful?
Endpoints
POST
POST
POST
POST
Create order
The create order API enables customers to place an order with a business. It creates a purchase order request that includes details of the items and their quantity requested by the customer.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Currency
child attributes
Date when order is due
Additional notes
Responses
Response attributes
Response attributes
child attributes
Response attributes
Why you find this section not helpful?
Base URL
Approve order
The approve order API is used by businesses to accept purchase orders from customers. It marks the order as approved, generates an invoice and updates the ledger with the transaction information.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Order object to update
Responses
Response attributes
Response attributes
Response attributes
Response attributes
child attributes
Response attributes
Response attributes
Why you find this section not helpful?
Base URL
Reject order
The reject order API enables a business to decline an incoming purchase order request from a customer. This API marks the order as rejected, stopping any further processing towards its approval.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Order object to update
Responses
Response attributes
Response attributes
Response attributes
Response attributes
child attributes
Response attributes
Response attributes
Why you find this section not helpful?
Base URL
Send reminder
The reminder order API allows customers to send reminders about outstanding orders to the business. This helps ensure that the business is aware of the new order and any required actions, such as making payment or confirming the order details.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
Role for group JW Token
Order object to send reminder
Responses
Response attributes
Response attributes
Response attributes
child attributes
Response attributes
Why you find this section not helpful?
Base URL
POS
The POS (Point of Sale) API is a key component of the Uome ecosystem which allows users to generate transactions and accept quick in-person payments from clients. This API integrates with the user's existing payment system and provides real-time transactions for efficient checkout processes. By using the POS API, users can streamline the payment process and reduce the time required for manual transactions, improving overall business efficiency.
Why you find this section not helpful?
Endpoints
POST
POST
POST
POST
POST
POST
Create POS
The create POS API allows users to create a record for a point of sale (POS) transaction, enabling them to quickly and efficiently process in-person payments. This API allows users to enter the details of a transaction and generate a receipt or record for future reference.
HEADER PARAMETERS
application/json
BODY PARAMETERS
Secret key to perform Uome API request
child attributes
User JW Token
Currency
Items in array
child attributes
Responses
Why you find this section not helpful?
Base URL