Centrex CRM ## Sections • [Authentication](https://dev.centrexsoftware.com/centrex-crm/get-started/authentication.md): Here is a quick description of authentication and authorization in the context of access to Centrex APIs: Authentication: This is the process of verifying your identity. When you make an API request, you prove your identity by providing a valid API Key. Authorization: Once authenticated, this is the process of confirming that you have permission to access a specific API resource or perform an action. Connection Flow All API endpoints require authentication. A valid API Key must be included when sending a request. If you do not have an API Key or your previous key has expired, you will need to obtain a new one by completing the following steps: 1 Access REST API Management Page Log-in to Centrex and navigate to the API Credentials Management Page. 2 Generate a Secret / Key Pair On the API Credentials Management Page: Select the User Type (Standard or Service) Choose a Company via the dropdown menu Select a User via the dropdown menu Enter a Description Click the Generate Key button at the bottom left of the section A pop-up screen will appear, displaying your API Secret and Key ID (see example below). Copy and save both values in a secure location like a secrets or password manager. The API Secret will not be shown again. 3 Obtain Access Token Use the Get Access Token endpoint to swap your API Secret and Key ID for an access token. The access token expires after 10 days and must be refreshed using this endpoint before the expiration date. Our APIs use Api Key-based authentication/authorization schemes to create a session. You must pass this access token in the Api-Key header in every HTTP request made to a Centrex API endpoint. • [Get Access Token](https://dev.centrexsoftware.com/centrex-crm/get-started/authentication/get-access-token.md): Receive an API Access Token. The Token that is returned can be entered for any API Request that requires an Api-Key . • [Error Codes](https://dev.centrexsoftware.com/centrex-crm/get-started/error-codes.md): The Centrex API uses conventional HTTP response codes to indicate the success or failure of an API request. In general, response codes fall into these categories: 2xx (Success): The request was successfully received, understood, and accepted. 4xx (Client Error): The request failed due to an issue on your end (e.g., missing parameter, invalid data, lack of permissions). 5xx (Server Error): An unexpected error occurred on Centrex's servers. These are rare, but if you encounter one, please check our status page or contact our support team. Here are some common error codes you may encounter: Code HTTP Status Meaning Possible Causes Resolution Steps 400 Bad Request The request is malformed or contains invalid parameters. Missing parameters, invalid JSON format, incorrect data types. Validate request parameters, check JSON structure, and ensure required fields are included. 401 Unauthorized Authentication is missing or invalid. Missing API key, expired token, incorrect credentials. Include a valid API key, a refresh authentication token, and verify credentials. 403 Forbidden Client lacks permission to access the resource. Insufficient user permissions, resource restrictions. Ensure user has the required permissions, check access control settings. 404 Not Found The requested resource does not exist. Incorrect URL, resource deleted or moved. Verify the request URL, check resource availability. 405 Method Not Allowed HTTP method is not allowed for the endpoint. Using GET instead of POST, or vice versa. Use the correct HTTP method per the API documentation. 429 Too Many Requests Too many requests hit the API too quickly Exceeding rate limits Examine rate limit headers, avoid aggressive retries, ID high-volume processes, and optimize if possible, Exponential backoff of your requests. 500 Internal Server Error An unexpected error occurred on the server. Server misconfiguration, unhandled exceptions. Check server logs, debug application code. 502 Bad Gateway Server received an invalid response from an upstream server. API gateway issues, backend server down. Check backend server health, retry request. 503 Service Unavailable Server is overloaded or under maintenance. High traffic, scheduled maintenance. Retry after some time, check the API status page. 504 Gateway Timeout Server did not receive a timely response from an upstream server. Slow database query, network congestion. Optimize backend response times, increase timeout threshold. • [Developer Tools](https://dev.centrexsoftware.com/centrex-crm/get-started/developer-tools.md): Under Construction, Coming Soon! Postman Collections To improve the developer experience, Centrex will soon be providing users with a convenient way to access and interact with predefined API collections for our various products. By viewing or running these collections in Postman, users can easily test and explore various API endpoints and functionalities. • [Rate Limits](https://dev.centrexsoftware.com/centrex-crm/get-started/rate-limits.md): To ensure platform stability and fair usage for all clients, the Centrex API employs rate limiting. The current Request Rate Limit is set to twenty (20) requests per second Handling Rate Limiting Errors If you exceed the Request Rate Limit, you will receive an HTTP 429 "Too Many Requests" response code, and your API use will be restricted. Resolution Options: Wait progressively longer before retrying requests. Avoid aggressive retries. Identify high-volume processes and optimize them (e.g., use bulk endpoints if available, implement caching). If you consistently hit limits due to legitimate high usage, contact us to discuss potential options. • [User Guides](https://dev.centrexsoftware.com/centrex-crm/forth-crm/user-guides.md): Our User Guides provide step-by-step instructions and documentation to help you navigate and utilize the Centrex CRM API. These guides include best practices and troubleshooting tips to enhance your experience and create better applicausing the Centrex CRM API. • [Download a Contact List](https://dev.centrexsoftware.com/centrex-crm/forth-crm/user-guides/download-a-contact-list.md): This guide outlines the steps to follow for downloading a contact list using the CRM's API. Step by Step Workflow 1 Retrieve All Available Contact Lists Use the Get All Contact Lists endpoint to retrieve all lists that your API user has access to 2 (Optional) Get All Contacts in a List Before downloading a contact list, you may want to verify the contents of the list. Use the Get All Contacts In List endpoint to retrieve full list of contacts in the contact list. 3 Download the Contact List Use the Download Contact List by ID endpoint to download the list of contacts. • [Core Objects](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects.md): Our core objects represent the backbone of our APIs. Most, if not all, actions are tied to these core objects and are fundamental to the Centrex ecosystem. These objects reflect key pillars of the financing process, from Contacts (the consumers you intend to enroll), to Documents, to communication objects like the Call object to log conversations. • [Contact](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact.md): The Contact is the central object for Centrex workflows and processes. This object represents the consumer you intend to enroll and all of their accompanying data. This includes: Advances Credit Reports Calendar Events Logged Calls and SMS messages Notes Documents Banking Information • [Contact Object](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/contact-object.md): The Contact Object represents basic CRUD operations for Contacts in your system. Additionally, you can use this endpoint to de-link a co-applicant from this contact's record. • [Search Contacts](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/contact-object/search-contacts.md): The Search Contacts section allows users to query and retrieve contact information based on specified search criteria. Users can retrieve details such as contact names, addresses, phone numbers, email addresses, and enrollment status. This functionality enables users to efficiently search for and access relevant contact information within the system. • [Create Contact Record](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/contact-object/create-contact-record.md): The /contacts endpoint creates a contact record. This record is the primary object to which auxiliary components, such as notes, SMS messages, and documents, are associated. Upon creation, the API returns a contact ID for use in future calls requiring it in the path parameters or request body. • [Get Contact](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/contact-object/get-contact.md): Returns a Contact Record This endpoint retrieves details about a specific contact by their unique identifier. It provides comprehensive information, including personal details, financial records, and associated documents. • [Update Contact](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/contact-object/update-contact.md): Updates a Contact Record This endpoint allows you to modify contact details by updating specific fields such as personal information, financial records, and account settings. It ensures that contact data remains accurate and up to date within the system. • [Delete Contact](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/contact-object/delete-contact.md): Deletes a Contact Record This endpoint removes a specific contact record from the system. It ensures that all associated data is permanently deleted or follows defined retention policies. • [Delink Co-Applicant](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/contact-object/delink-co-applicant.md): This endpoint allows you to remove a co-applicant from a contact's profile. It ensures that the primary applicant's data remains intact while eliminating any associated connections to the co-applicant. • [Get History Feed](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/contact-object/get-history-feed.md): Returns a specified set of log records from a Contact's History Feed. This endpoint retrieves a chronological activity log for a contact, providing insights into key interactions, updates, and system-generated events. • [Get All Advances](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/advances/get-advances-by-id.md) • [Alerts](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/alerts.md): The Alerts section allows you to manage and view alerts associated with a specific contact. You can create, update, delete, and retrieve alerts to stay informed about important events or notifications related to the contact. • [Get All Alerts](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/alerts/get-all-alerts.md): This section allows you to retrieve all alerts associated with a specific contact by their ID. Users can view details such as alert type, creation date, and dismissal status to stay informed about important notifications related to the contact. • [Delete Alert](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/alerts/delete-alert.md): The "Delete Alert" endpoint allows you to remove a specific contact alert by its unique ID. By utilizing this functionality, users can manage their contact alerts more effectively and keep their alert system organized. • [Update Alert](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/alerts/update-alert.md): The "Update Alert" section enables you to modify a contact alert identified by its ID. By updating the alert details, users can effectively manage and customize the alerts associated with specific contacts within the system. • [Create Alert](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/alerts/create-alert.md): The Create Alert endpoint allows you to set up a new alert for a specific contact. By providing details such as the type of alert, the alert message, and expiration date, users can ensure timely notifications for important events or updates related to the contact. • [Notes](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/notes.md): The Notes section allows you to manage and store additional information related to specific contacts. You can create, update, and delete notes associated with a contact, providing valuable context and documentation for each contact interaction. • [Get All Notes](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/notes/get-all-notes.md): Returns all Notes for a Contact by the Contact's ID. Contact notes may be filtered on any property of the ContactNote object, passing the field, an operator, and a value as an optional query parameter. The basic syntax is field_name[operator]=value . For example, the parameter note_created_date[gt]=2019-01-01 will only return notes created after 2019-01-01. Please find the available operators below and the operations they correspond to in parentheses: start, min, gte ( >= ) end, max, lte ( <= ) gt ( > ) lt ( < ) value, values, eq ( = ) neq ( != ) • [Create Note](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/notes/create-note.md): The Create Note endpoint allows you to add a new note to a contact's record. You can provide content, note type, and choose whether the note should be public or notify specific user • [Update Note](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/notes/update-note.md): The "Update Note" endpoint allows you to modify a specific contact note by providing the contact's ID and the note's ID. You can update various details within the note, such as content, type, and visibility, among others. • [Delete Note](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/notes/delete-note.md): The "Delete Note" endpoint allows you to remove a specific Contact Note associated with a Contact by providing the Contact's Id and the Note's Id. • [Communication](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/communication.md): The Communication section contains various endpoints to send and/or log various forms of communication like email and SMS. • [Send External Form Request](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/communication/send-external-form-request.md): This endpoint allows you to send a form to a contact via email address using the contact's ID. • [Upload a contract in the "Signed Contract / Gateway Authorization" section](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/communication/send-external-form-request/upload-a-contract-in-the-signed-contract-gateway-authorization-section.md): This endpoint allows you to upload signed contracts or documents related to gateway authorizations. The response includes status codes for successful uploads and error handling. • [Send Email](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/communication/send-email.md): The "Send Email" endpoint allows you to send emails to contacts within the system. Users can specify the email's subject, content, recipients, and attachments, facilitating communication with contacts. • [SMS](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/communication/sms.md): The SMS section of endpoints allows you to send text messages to recipients as well as log SMS messages to a contact. • [Get All SMS Records](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/communication/sms/get-all-sms-records.md): This endpoint allows you to retrieve all SMS messages associated with a specific contact, ordered from newest to oldest. Users can access detailed information about each message, including the sender's details and message content. • [Create SMS Log](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/communication/sms/create-sms-log.md): If you do not have a SMS provider configured in the CRM, please do so before using this endpoint The "Create SMS Log" endpoint enables you to record SMS messages in the system from a designated provider that must already be present in Centrex. • [Send SMS](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/communication/sms/send-sms.md): The "Send SMS" endpoint allows you to send text messages to specific contacts within the system. The API response includes status codes to indicate the success or failure of the SMS delivery process. • [Credit Reports](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/credit-reports.md): The Credit Reports section provides you with access to detailed reports on credit information related to a specific entity or individual. • [Get Last Credit Report](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/credit-reports/get-last-credit-report.md): This endpoint allows you to retrieve the contents of the last credit report requested for a specific contact. • [Pull Credit](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/credit-reports/pull-credit.md): Your desired credit pull provider must be active and configured in your CRM account before using this endpoint The "Pull Credit" endpoint allows you to request a credit report for a specific contact ID from various credit report providers. By performing a credit pull, users can retrieve essential credit information for the specified contact from providers like MCL and Xactus360. • [Documents](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/documents.md): The Documents section provides functionality for managing and accessing various documents associated with a contact. You can upload, delete, and retrieve documents, as well as update document details such as file type. • [Get All Documents](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/documents/get-all-documents.md): This endpoint allows you to retrieve all documents associated with a specific contact ID. • [Create/Upload Document](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/documents/create-upload-document.md): The Create/Upload Document endpoint allows you to upload documents to a specified contact using various parameters such as file content, URL, and description. Users can also associate the uploaded document with specific document types and receive detailed response information, including document IDs and creator details. • [Delete Document](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/documents/delete-document.md): This endpoint allows you to delete a specific document associated with a contact by its unique document ID. • [Update Document](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/documents/update-document.md): The Update Document endpoint allows you to modify specific document details associated with a contact, such as updating the file name, document type, and file content. • [Get Document](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/documents/get-document.md): This endpoint allows you to retrieve a specific document associated with a contact using the document ID. By accessing this endpoint, users can access detailed information about the document, including file type, creation details, and download link. • [Debts Management](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/debts-management.md): The Debts Management section allows you to retrieve information about debts related to specific contacts. You can view details on unsettled debts, settled debts, debts that are not yet enrolled, enrolled debts, and all debts associated with a particular contact. • [Get Unsettled Debts](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/debts-management/get-unsettled-debts.md): This endpoint allows you to retrieve unsettled debts specifically associated with a contact. • [Get Settled Debts](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/debts-management/get-settled-debts.md): This endpoint allows you to retrieve only settled debts associated with a specific contact. • [Get Unenrolled Debts](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/debts-management/get-unenrolled-debts.md): This endpoint allows you to retrieve only unenrolled debts associated with a specific contact. • [Get Enrolled Debts](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/debts-management/get-enrolled-debts.md): This endpoint allows you to retrieve only enrolled debts associated with a specific contact. • [Get Contact Debts](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/debts-management/get-contact-debts.md): This endpoint allows you to retrieve all debts associated with a specific contact ID. • [Workflow](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/workflow.md): The Workflow section of endpoints allows you to interact with and manage the various stages and steps involved in a project or task. • [Get status and workflow history](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/workflow/get-status-and-workflow-history.md): Retrieve the current status and workflow history for a specific contact. You can gain insight into the contact's status, stage, labels, and timestamp, allowing for efficient tracking of their workflow progress and history. • [List All Stages and Statuses](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/workflow/list-all-stages-and-statuses.md): This endpoint allows you to retrieve a comprehensive list of all contact stages along with their associated statuses. • [Update Contact Status](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/workflow/update-contact-status.md): Updates a contact's status, sets the associated stage, and executes all configured STATUS_CHANGE triggers. • [Banking](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/banking.md): The Banking section of endpoints provides functionality related to financial transactions and account management. You can perform tasks such as transferring funds, querying account balances, and setting up direct debits. • [Update Bank Account](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/banking/update-bank-account.md): The "Update Bank Account" endpoint allows you to update and modify the details of a bank account associated with a specific contact. Users can change account numbers, routing numbers, account types, payment types, and account holder information. • [Create Bank Account](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/banking/create-bank-account.md): The "Create Bank Account" endpoint allows you to add a new bank account associated with a specific contact. By providing necessary account details, users can securely store banking information for future transactions and financial operations. • [Get Bank Account](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact/banking/get-bank-account.md): This endpoint allows you to retrieve detailed information about a bank account stored on a contact record. You can access essential details such as the name on the account, account number, routing number, account type, and bank information. • [Contact Lists](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact-lists.md): The endpoints within the Contact Lists section allow you to manage and organize their contact information efficiently. Users can create, update, and delete contact lists, as well as add, remove, and retrieve contacts within these lists. • [Get All Contact Fields](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact-lists/get-all-contact-fields.md): This section allows users to retrieve all contact fields associated with a specific contact in the system. By accessing this information, users can gain insights into the standard and custom fields available for a contact, enabling them to tailor their interactions and data collection processes accordingly. • [Get All Contact Lists](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact-lists/get-all-contact-lists.md): The "Get All Contact Lists" section allows users to retrieve a comprehensive list of all contact lists associated with their account. With this functionality, users can easily access and manage their contact lists in one centralized location, enhancing their overall organizational efficiency. • [Get All Contacts In List](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact-lists/get-all-contacts-in-list.md): This endpoint allows you to retrieve a paginated list of contact records within a specific contact list. You can access essential contact details such as full name, email, phone number, and status information for each contact in the list. The API response includes pagination information to navigate through the list efficiently. • [Download Contact List](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact-lists/download-contact-list.md): The "Download Contact List" endpoint allows you to retrieve a previously queued export job for a contact list. By accessing this functionality, you can easily download the exported file containing the contact list data. • [Publish Contact List](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/contact-lists/publish-contact-list.md): The "Publish Contact List" endpoint enables you to queue a download for a contact list, facilitating the retrieval of important contact information. • [Call](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/call.md): The endpoints within the Call section allow you to interact with and manage call data within the system. You can retrieve, update, and delete specific call entries, as well as create new calls and access information about call dispositions. • [Create Call Record](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/call/create-call.md): The Create Call endpoint allows you to create a new call record with specific parameters such as contact ID, call type, duration, and notes. Select the 'Examples' option to change the content of the request's Body to ONLY contain the required POST Parameters. The dialer_id field supports the following valid IDs: ID Title 1 Five9 2 Bluerock 3 CallFire 6 Ytel 9 Vicidial 12 Newbridge 15 FreeVoicePBX 17 Voipment 19 Ring Central 23 Caller Ready 24 CISCO 27 Vastipp 30 BrightPattern 32 Asterisk 33 Infobip • [Get Call Record](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/call/get-call.md): The "Get Call" endpoint allows you to retrieve a detailed Call Record with information such as call type, disposition, notes, and assigned agent. • [Update Call Record](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/call/update-call.md): The "Update Call" endpoint allows you to modify and update existing call records within the system. • [Delete Call Record](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/call/delete-call.md): Allows you to delete a specific Call Record by providing the corresponding ID. • [Get Call Dispositions](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/call/get-call-dispositions.md): This endpoint allows you to retrieve all call dispositions, including both system and custom dispositions. • [Document](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/document.md): This collection of endpoints allows you to generate and delete documents in our system. • [Generate Document](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/document/generate-document.md): This endpoint allows you to use a Document Template ID to create a Document Record object. Select the 'Examples' option to change the content of the request's Body to ONLY contain the required POST Parameters. • [Delete Document](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/document/delete-document.md): This endpoint allows you to delete a document by ID. • [Document Package](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/document-package.md): This collection of endpoints allows you to generate and/or delete entire document packages. These document packages must be configured in your Centrex account before leveraging these endpoints. • [Delete Document Package](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/document-package/delete-document-package.md): This endpoint allows you to delete a document package by package ID. • [Generate Document Package](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/document-package/generate-document-package.md): This endpoint allows you to use a Package Template ID to create a Document package object. Select the 'Examples' option to change the content of the request's Body to ONLY contain the required POST Parameters. • [Task](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/task.md): The endpoints within the Task section allow you to interact with tasks in the default project's calendar. You can create, retrieve, update, and delete individual tasks. • [Create Task](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/task/create-task.md): This endpoint allows you to create a Task Record. Select the 'Examples' option to change the content of the request's Body to ONLY contain the required POST Parameters. • [Get Task](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/task/get-task.md): This endpoint allows you to retrieve a particular Task Record. • [Update Task](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/task/update-task.md): This endpoint allows you to update a Task Record. • [Delete Task](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/task/delete-task.md): This endpoint allows you to delete a Task Record. • [Complete Task](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/task/complete-task.md): This endpoint allows you to mark a particular Task Record as complete. • [Calendar Event](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/calendar-event.md): The endpoints within the Calendar Event section allow you to interact with calendar events in our system. Calendar events in our systare tied to contacts. You can create, retrieve, update, and delete individual calendar events using this section. This functionality enables users to efficiently manage and organize their project's schedule through Centrex. • [Create Event](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/calendar-event/create-event.md): This endpoint allows you to create and schedule an event for a contact. • [Get Event](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/calendar-event/get-event.md): This endpoint allows you to retrieve an event for a contact by the ID of the event. • [Update Event](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/calendar-event/update-event.md): This endpoint allows you to modify an event by using its ID to locate it. • [Delete Event](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/calendar-event/delete-event.md): This endpoint allows you to delete an event by using its ID to locate it • [User](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/user.md): The User section of the API allows you to manage and retrieve information about individual users within an account. Users can create, update, delete, and view user profiles, as well as access user-specific data and settings. Users represent internal CRM users associated with your account. If you are wanting to edit the records of your customers/consumers, please use the Contact set of endpoints. • [Get User Events](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/user/get-user-events.md): This endpoint allows you to retrieve a listing of all existing Event records for a single User. • [Get User Tasks](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/user/get-user-tasks.md): This endpoint allows you to retrieve a listing of all existing Task Records for a single User. • [Get Current User](https://dev.centrexsoftware.com/centrex-crm/forth-crm/core-objects/user/get-current-user.md): This endpoint allows you to retrieve the User Record of the Current Active User. • [Marketing](https://dev.centrexsoftware.com/centrex-crm/forth-crm/marketing.md): The Marketing APIs enable you to manage promotional campaigns, manage email marketing templates and more. • [Campaigns](https://dev.centrexsoftware.com/centrex-crm/forth-crm/marketing/campaigns.md): The Campaigns section of the Centrex CRM API allows you to create, manage, and track marketing campaigns. You can easily set up targeted campaigns, monitor their performance, and make adjustments as needed to optimize their marketing efforts. • [Create Campaign Record](https://dev.centrexsoftware.com/centrex-crm/forth-crm/marketing/campaigns/create-campaign-record.md): This endpoint allows you to create a Campaign Record. Users can add attributes such as title, start and end dates, cost, priority, and media type for a campaign. Select the 'Examples' option to change the content of the request's Body to ONLY contain the required POST Parameters. • [Get Campaign Record by ID](https://dev.centrexsoftware.com/centrex-crm/forth-crm/marketing/campaigns/get-campaign-record-by-id.md): This endpoint allows you to retrieve a Campaign Record by the Campaign's ID. • [Update Campaign Record by ID](https://dev.centrexsoftware.com/centrex-crm/forth-crm/marketing/campaigns/update-campaign-record-by-id.md): The Update campaign Record endpoint allows you to update specific details of a campaign record by its unique ID. You can modify attributes such as title, start and end dates, cost, priority, and media type for a campaign. The API response includes the updated campaign record object along with status codes for successful or error responses. • [Delete Campaign Record by ID](https://dev.centrexsoftware.com/centrex-crm/forth-crm/marketing/campaigns/delete-campaign-record-by-id.md): This endpoint allows you to delete a Campaign Record. • [Get All Campaigns](https://dev.centrexsoftware.com/centrex-crm/forth-crm/marketing/campaigns/get-all-campaigns.md): Get All Campaigns • [Email Marketing](https://dev.centrexsoftware.com/centrex-crm/forth-crm/marketing/email-marketing.md): The Email Marketing section of the API allows you to interact with the email marketing functionality of the Centrex CRM. You can create, manage, and schedule email campaigns, as well as access templates for designing compelling marketing emails. • [Get All Email Templates](https://dev.centrexsoftware.com/centrex-crm/forth-crm/marketing/email-marketing/get-all-email-templates.md): The Get All Email Templates endpoint retrieves a comprehensive list of email templates available for use within the account. You can access template details such as title, subject, category, and creator information. • [Platform Management](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management.md): The Platform Management section provides functions to effectively manage various aspects of their platform settings. You can configure and customize settings related to account preferences, notifications, and user permissions. • [Administration](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration.md): The Administration section allows you to manage teams and users within the account. You can create, update, and delete teams, as well as add, update, and remove individual users. This section provides essential functionality for overseeing and maintaining company members and their roles. Users represent internal Centrex users associated with your account. If you are wanting to edit the records of your customers/consumers, please use the Contact set of endpoints. • [Teams](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/teams.md): Teams are groups of users that share roles and/or responsibilities. You can assign various tasks and events to Teams as well as have certain permissions set for teams. • [Get All Teams](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/teams/get-all-teams.md): Returns a List all Existing Team Records • [Create Team](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/teams/create-team.md): Creates a Team Record • [Get Team](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/teams/get-team.md): Returns a Team Record • [Update Team](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/teams/update-team.md): Updates a Team Record • [Delete Team](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/teams/delete-team.md): Deletes a Team Record • [Users](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/users.md): Users represent internal Centrex users associated with your account. If you are wanting to edit the records of your customers/consumers, please use the Contact set of endpoints. • [Get All Users](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/users/get-all-users.md): Gets all Users in the current account and displays their ID Users may be filtered on any property of the Users object, passing the field, an operator, and a value as an optional query parameter. The basic syntax is field_name[operator]=value. For example, the parameter email[eq]= test@test.com will only return users with email address test@test.com . Please find the available operators below and the operations they correspond to in parentheses: start, min, gte ( >= ) end, max, lte ( <= ) gt ( > ) lt ( < ) value, values, eq ( = ) neq ( != ) List of allowed parameters: id company_id role_id user_name firstname lastname email • [Create User](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/users/create-user.md): Creates a User Record object Select the 'Examples' option to change the content of the request's Body to ONLY contain the required POST Parameters. • [Get User](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/users/get-user.md): Returns a User Record • [Update User](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/users/update-user.md): Updates a User Record • [Delete User](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/users/delete-user.md): Deletes a User Record • [Get Users Settings](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/users/get-users-settings.md): Get User Settings • [Update Users Settings](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/users/update-users-settings.md): Update User Settings • [Reset User Password](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/users/reset-user-password.md): The reset password API allows an administrator to reset a users password programatically. The ability to specify a temporary pasword, send the users password reset email, and force a password change on next login are supported on this endpoint. In order to use this endpoint a user must be previously created and have a valid email saved to their user in the system. In order to reset the users password via API the role the API user is tied to must have the “edit user” role permission enabled. Passwords MUST have 12-64 characters, at least one numeric digit, and at least one speical character. “send_reset_email” being set to true will send a password reset button to the users currrently saved email in the system. “reset_pw_on_login” being set to true will require the user to change thier password when they next login to the system. • [Companies](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/companies.md): Companies must be established in Centrex before leveraging these endpoints • [Payees](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/companies/payees.md): Payees are associated with a company. This group of endpoints allows you to retrieve a list of payees as well as creating and updating payees for a company. • [Get Payees](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/companies/payees/get-payees.md): Returns All Payee Records • [Update Payee](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/companies/payees/update-payee.md): Updates Payee Records • [Create Payee](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/companies/payees/create-payee.md): Creates Payee Records • [Content Configuration](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/content-configuration.md): This collection of endpoints allows administrators to edit types and statuses for notes and debts • [Get All Contact Note Types](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/content-configuration/get-contact-note-types.md): Returns all Existing Types of Notes • [Debts](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/content-configuration/debts.md): The Debts section of the Default project allows users to manage and retrieve information related to debts within the system. Users can view the types of debts available, update the status of a specific debt, and retrieve the current statuses of all debts. This section provides essential functionalities for tracking and managing debts efficiently. • [Get All Debt Types](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/content-configuration/debts/get-all-debt-types.md): Retrieve a list of all debt types available for an account • [Update Debt Status](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/content-configuration/debts/update-debt-status.md): Update a debt status' label and color within the CRM • [Get All Debt Statuses](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/administration/content-configuration/debts/get-all-debt-statuses.md): Retrieve all available debt statuses • [Document Management](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/document-management.md): The Document Management section allows you to securely upload, store, and retrieve various types of documents within the system. By leveraging this functionality, users can easily manage their documentation needs, ensuring efficient access and organization of important files. • [Templates](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/document-management/templates.md): The Templates section allows you to easily create and manage predefined templates for various types of content. • [List All Document Templates](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/document-management/templates/list-all-document-templates.md): Retrieve a list of all visible documets. • [Packages](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/document-management/packages.md): The Packages section allows you to manage and view the various packages available within the system. You can create, update, and delete packages, as well as retrieve information about existing packages. This section is essential for customizing and organizing packages to suit business needs efficiently. • [List All Document Packages](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/document-management/packages/list-all-document-packages.md): Retrieve a list of all visible document packages. • [Document Types](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/document-management/document-types.md): The Document Types section provides information on the various types of documents that can be used via the API. You can learn about the specific formats and requirements for different document types, allowing them to effectively manage and process documents within their applications. • [Delete Document Type](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/document-management/document-types/delete-document-type.md): Delete a Document Type by ID • [Update Document Type](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/document-management/document-types/update-document-type.md): Update a Document Type by ID • [Create Document Type](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/document-management/document-types/create-document-type.md): Create a Document Type • [Get All Document Types](https://dev.centrexsoftware.com/centrex-crm/forth-crm/platform-management/document-management/document-types/get-all-document-types.md): Returns all existing Document Types. NOTE: By default, the Document Types are returned in order from Oldest to Newest. • [Servicing](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing.md): The Servicing section of the API allows you to manage and update various settings and configurations for the common servicing functions of financing workflows. This includes advances, lenders, submissions, and transactions. • [Submissions](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/submissions.md): The Submissions section allows users to submit data or content to the system for processing or storage. By utilizing this section, users can seamlessly send information to the platform for further handling or analysis. It serves as a crucial gateway for integrating external data into the system effectively. • [Get All Advance Submissions](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/submissions/get-submissions-for-advance.md): Return Submissions for Advance Record • [Get All Lender Submission Statuses](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/submissions/get-lender-submission-statuses.md): Retrieve a list of all visible lender submission statuses. • [Update Lender Submission Status](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/submissions/update-submission-status.md): Update a lender submission by lender, advance, and submission ID. • [Get Lender Submission](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/submissions/get-submission-details.md): Get the details for a lender submission by lender, advance, and submission ID. This API is not for email submissions, and will not return the details for email submissions • [Loans Financial Actions](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/loans-financial-actions.md): The Loans API enables you to create, retrieve, and manage loan records within the Centrex Developer Preview platform. Use this API to initiate new loans, track their status, and update loan details efficiently, streamlining your lending workflows. • [Get Loan Transactions](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/loans-financial-actions/get-loan-transactions.md): This endpoint retrieves a comprehensive list of every transaction ever recorded for a specific loan. This includes payments, fees, interest adjustments, and credits. It is the "source of truth" for a loan's financial history. • [Create Credit Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/loans-financial-actions/create-credit-transaction.md): Use this endpoint to record a credit (money applied) to a loan. This is typically used for client payments or adjustments that reduce the balance. • [Create Debit Extra Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/loans-financial-actions/create-debit-extra-transaction.md): Use this endpoint to record a debit transaction that is specifically designated as Extra Principal. This is different from a standard payment because it typically bypasses interest and goes straight toward reducing the loan's core balance. • [Create Debit Additional Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/loans-financial-actions/create-debit-additional-transaction.md): This endpoint is used to record a supplemental debit transaction. Unlike the "Extra Principal" endpoint, this is typically used for catch-up payments or one-off additions to the regular payment schedule. • [Update Loan Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/loans-financial-actions/update-loan-transaction.md): This endpoint allows you to modify the details of an existing transaction record. Use this if a payment amount was recorded incorrectly or if the memo needs to be updated for accounting clarity. • [Mark Transaction as Cleared](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/loans-financial-actions/mark-transaction-as-cleared.md): This endpoint updates a transaction's status to "Cleared." This is a critical step in the loan lifecycle, as it often locks the transaction from further edits and officially updates the loan's principal balance. • [Delete Loan Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/loans-financial-actions/delete-loan-transaction.md): This endpoint completely removes a transaction from the loan record. It is typically used for transactions created in error that have not yet been "Cleared." • [Create Payoff Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/loans-financial-actions/create-payoff-transaction.md): This endpoint calculates the final amount needed to close out a loan (including all remaining principal and interest) and creates a payoff transaction record. This is essential for customers who want to settle their debt entirely on a specific date. • [Create Fee Payment](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/loans-financial-actions/create-fee-payment.md): Use this endpoint to record a payment specifically directed toward fees on a loan. This ensures that the money is applied to the fee balance rather than being swallowed up by the principal or interest. • [Toggle Autodraft-Autopay](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/loans-financial-actions/toggle-autodraft-autopay.md): This endpoint enables or disables the automated drafting (Autopay) for a specific loan. When enabled, the system will automatically pull scheduled payments on their due dates. • [Get Loan Balance as of Date](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/loans-financial-actions/get-loan-balance-as-of-date.md): This endpoint calculates the projected principal and interest balance for a specific loan as of a chosen date. • [Get Fees Balance](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/loans-financial-actions/get-fees-balance.md): This endpoint returns the total outstanding balance for all fees associated with a specific loan. It provides a quick snapshot of what is owed in late fees, NSF charges, or service fees, separate from the principal debt. • [Get Fee Ledger](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/loans-financial-actions/get-fee-ledger.md): This endpoint retrieves a detailed history of all fee-related activity. It includes when a fee was charged (Assessed), when it was paid, and what type of fee it was (e.g., Late Fee, Origination Fee). This is the best endpoint for building a "Fee History" table in a user interface. • [Get Fee Settings](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/loans-financial-actions/get-fee-settings.md): This endpoint retrieves the global configuration for fees across the entire system. It tells the user what the standard amounts are for common charges (like Late Fees or NSF Fees) and how those fees are calculated (flat fee vs. percentage). • [Advances](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/advances.md): The Advances section provides additional information and parameters that users can utilize to enhance their API requests and gain more context. By leveraging these advanced features, users can further customize their interactions with the API and optimize their integration with the system. Explore the possibilities of fine-tuning your API calls and achieving more precise results with the resources available in this section. • [Enroll An Advance](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/advances/enroll-an-advance.md): The "Enroll An Advance" section enables users to update the status of a specific advance, facilitating the enrollment process within the system. It provides the necessary functionality to mark an advance as enrolled or transitioned to its next stage, supporting effective advance management and tracking. • [Get Advance](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/advances/get-advance.md): Return an Advance Record • [Create an Advance](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/advances/create-an-advance.md): Creates an advance and its assocated objects. • [Update Advance](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/advances/update-an-advance.md): Updates an advance and its associated objects. • [Delete Advance](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/advances/delete-an-advance.md): Hard deletes an advance and all associated objects. This action is irreversible and the deleted items can't be recovered! • [Toggle Advance Lock Status](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/advances/lock-unlock-advance-by-id.md): Lock or unlock advance pricing • [Get All Advance Statuses](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/advances/get-advance-statuses.md): Return statuses for advance • [Update Advance Payment Method](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/advances/update-payment-method.md): Update Method for Advance Record • [Update Repayment Frequency](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/advances/put-advance-repayment-frequency.md): Update Advance Repayment Frequency • [Get Participants](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/advances/get-participants.md): Return Participants for Advance Record • [Get Commissions](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/advances/get-commissions.md): Return Commissions for Advance Record • [Get Advance Assignments](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/advances/get-advance-assignments.md): Return all advance assignments • [Update Advance Status](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/advances/update-advance-status.md): Update an advance status and fund it if the status is configured as such. • [Toggle Auto ACH Drafting](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/advances/enable-or-disable-ach-drafting.md): Enable or disable ACH autodrafting for an advance by ID. • [Transactions](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions.md): The Transactions section allows you to retrieve transactions assigned to a contact, along with the transaction types • [Get Contact Transactions](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/get-contact-transactions.md): Returns every Transaction for a Contact by ID • [Get all Transactions on Advance](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/get-all-transactions-on-advance.md) • [Get All Transaction Types](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/get-all-transaction-types.md): Get list of transaction types available in the system • [Get All Transaction Subtypes](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/get-all-transaction-subtypes.md): Get list of transaction subtypes • [Create Transactions](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/create-transactions.md): The "Create Transactions" section allows users to initiate new transactions associated with a specific advance ID, facilitating the processing of financial transactions within the project. By utilizing this section, users can seamlessly generate transactions to track and manage advances in a streamlined manner. • [Create ACH Debit Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/create-transactions/create-ach-debit.md) • [Create Credit Card Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/create-transactions/copy-1.md) • [Create ACH Credit Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/create-transactions/copy-1-2.md) • [Create Refund Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/create-transactions/copy-2.md) • [Create Account Adjustment Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/create-transactions/create-ach-credit-copy-1.md) • [Update Transactions](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/create-transactions-copy-1.md): The Update Transactions section allows users to modify existing transaction records within the system. Users can update transaction details such as amounts, descriptions, and payment statuses. This section provides flexibility for managing transactions and ensuring accurate record-keeping within the platform. • [Update ACH Debit Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/create-transactions-copy-1/create-ach-debit-transaction-copy.md) • [Update Credit Card Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/create-transactions-copy-1/create-credit-card-transaction-copy.md) • [Update ACH Credit Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/create-transactions-copy-1/create-ach-credit-transaction-copy.md) • [Update Client Refund Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/create-transactions-copy-1/create-refund-transaction-copy.md) • [Update Account Adjustment Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/create-transactions-copy-1/create-account-adjustment-transaction-copy.md) • [Update Transaction Statuses](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/update-transaction-statuses.md): The Update Transaction Statuses section allows users to easily modify the status of transactions within their projects. With this functionality, users can streamline their workflow by updating transaction statuses as needed without having to manually intervene. This section empowers users to manage their transaction processes efficiently and effectively. • [Clear Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/update-transaction-statuses/clear-transaction.md) • [Return Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/update-transaction-statuses/clear-transaction-copy-1.md) • [Cancel Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/update-transaction-statuses/clear-transaction-copy-1-2.md) • [Mark Transaction Pending](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/update-transaction-statuses/clear-transaction-copy-2-1.md) • [Activate Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/update-transaction-statuses/clear-transaction-copy-3-1.md) • [Deactivate Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/update-transaction-statuses/copy-3.md) • [Delete a Transaction](https://dev.centrexsoftware.com/centrex-crm/forth-crm/servicing/transactions/delete-a-transaction.md): This section provides the ability to delete a specific transaction associated with an advance. By deleting a transaction, you can correct financial records and ensure that only accurate data is kept in the system. Only open, pending, and cleared Centrex transactions can be deleted. A transaction that has already been processed cannot be deleted. • [Utilities](https://dev.centrexsoftware.com/centrex-crm/forth-crm/utilities.md): The Utilities section provides various tools and functions to assist you in managing and manipulating data within the system. With this section, users can perform tasks such as searching for contacts by phone number and conducting lookups on institutions. • [Data Sources](https://dev.centrexsoftware.com/centrex-crm/forth-crm/utilities/data-sources.md): The endpoints within the Data Sources section allow you to access information related to various data sources connected to the account. You can retrieve data from these sources to enhance their analysis, reporting, or integration processes within your application. • [Get All Data Sources](https://dev.centrexsoftware.com/centrex-crm/forth-crm/utilities/data-sources/get-all-data-sources.md): This endpoint retrieves a comprehensive list of data sources available in the system. It provides essential details about each source, enabling users to access, filter, and integrate relevant information into their workflows. • [Search Contact by Phone Number](https://dev.centrexsoftware.com/centrex-crm/forth-crm/utilities/search-contact-by-phone-number.md): This endpoint enables you to quickly search for contact records within the system by phone number. The search will attempt to match the provided phone number against stored contact phone numbers. • [Routing Number Validation](https://dev.centrexsoftware.com/centrex-crm/forth-crm/utilities/routing-number-validation.md): This endpoint is used to retrieve routing numbers and confirm their validity. • [User Guides](https://dev.centrexsoftware.com/centrex-crm/clixsign/user-guides.md): This section contains a user guide specific to the Clixsign feature. Clixsign is Centrex's proprietary electronic document signing platform. To enable this platform, please contact Support@centrexsoftware.com . • [Request a Signature](https://dev.centrexsoftware.com/centrex-crm/clixsign/user-guides/request-a-signature.md): This guide provides the steps you should follow to request a signature via Clixsign using the Centrex API. To generate a document and send it to Clixsign, you must first have the following information available: The document template ID you wish to generate and send through Clixsign The contact ID you wish to originate the Clixsign request for The details of the various individuals or entities that are signers on the agreement To successfully send a Clixsign document, complete the following steps. 1 Determine Document Template / Package To Be Sent For Signature Your Centrex CRM account will contain various documents and document packages stored within the ‘Docs’ tab of your system. Navigate to this tab to see what documents you have available for generation, or retrieve them programatically via a GET request to the list-all-documents endpoint. You can retrieve all packages similarly through the documents tab UI or via the endpoint list-document-packages . You will need the corresponding ‘Template ID’ or ‘Package ID’ in the following step. 2 Generate Document Template/Package to Prepare For Signature Next, use the generate-a-document endpoint or the generate-a-document-package endpoint, and reference the corresponding document template ID or package ID you wish to generate for a contact record. In the response, you will receive a doc_id that needs to be referenced in the following request. JSON { "response": { "html": null, "doc_id": 37256536, "doc_data": { "signers": { "1": { "signer_type": "Signature here", "default": "contact", "signatures": [ { "type": "SIGNATURE", "x": "78.138", "y": "288.008", "width": "110.959", "height": "27.740", "required": true, "page": 0 }, { "type": "INITIAL", "x": "452.664", "y": "325.468", "width": "37.500", "height": "18.750", "required": true, "page": 0 }, { "type": "TEXTINPUT", "x": "215.328", "y": "335.734", "width": "79.109", "height": "10.788", "required": true, "page": 0, "replaceable": { "text": "Text", "font": "droid_sans", "size": 10, "color": "#000", "alignment": "left", "bold": false, "italic": false, "wrap": true, "fill": false } } ] }, "2": { "signer_type": "", "default": "manual", "signatures": [ { "type": "SIGNATURE", "x": "226.709", "y": "293.602", "width": "52.397", "height": "13.099", "required": true, "page": 0 } ] }, "3": { "signer_type": "", "default": "manual", "signatures": [ { "type": "SIGNATURE", "x": "314.640", "y": "290.496", "width": "52.397", "height": "13.099", "required": false, "page": 0 } ] }, "4": { "signer_type": "", "default": "manual", "signatures": [ { "type": "SIGNATURE", "x": "405.155", "y": "285.841", "width": "52.397", "height": "13.099", "required": false, "page": 0 } ] } }, "pages": [ { "width": 612, "height": 792 }, { "width": 612, "height": 792 } ], "filename": "" }, "title": "Clixsign template 4 signer" }, "status": { "code": 200 } } Additionally, you should see a corresponding history event and document generated on the contact record in the CRM. 3 Send via Clixsign for Signature The doc_id value from the previous request will now be used to send a document through Clixsign via the send-clixsign-document request with the ‘gen_id’ field in the request body. Additionally, define the values of the signer as if you were generating the document for the contact record within the Centrex UI, including details such as the signer's name, email, and phone numbers, and whether they are receiving this document via email or SMS message. NOTE: If ‘enforce_order’ is set to ‘true’, then each signer must complete the document before sending to the next signer in numerical order defined by the request. JSON { "gen_id": 37256536, "request_settings": { "enforce_order": true, "expiration_date": "2025-07-18" }, "notifications": { "email": { "message": "Thisis your document to sign" } }, "signers": [ { "signer_number": 1, "signer_type": "Contact", "signer_name": "Bob Test", "signer_email": "test@test.net", "signer_phone": 16665554444, "verbal_auth": true, "signer_notifications": { "email": true, "sms": false } } ] } Once all signers are defined and the request is sent, the Clixsign documents will be sent to their respective recipients via their specified delivery methods. Once all documents have been signed, you should see the document status updated to ‘Completed’ within the contact record in the Centrex CRM. • [Create Signing Request](https://dev.centrexsoftware.com/centrex-crm/clixsign/create-signing-request.md): This endpoint allows you to initiate the sending of a Clixsign document to a specified client. By providing the necessary documents and signer details, you can trigger the document delivery process efficiently.