Retrieve Account List: /accounts
Purpose
This API retrieves a list of all accounts in the system with support for pagination, sorting, and field selection. It returns detailed information about each account including contact details, billing preferences, and associated metadata.
Use Case
Used when displaying the list of customer accounts on the admin dashboard or CRM screen. Allows filtering, sorting, and pagination for performance-optimized data retrieval.
Path Parameters
No path parameters required for this endpoint.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| order_by | String | Field name to sort the result set. |
| direction | String | Sorting direction. Accepts asc or desc. |
| limit | Integer | Number of records to retrieve per page. |
| offset | Integer | Number of records to skip from the beginning. |
| fields | String | Comma-separated list of fields to include in the response. |
Request Body
No request body is required for this endpoint.
Response
The response includes a paginated list of account objects with detailed data such as status, name, display name, contact information, currency, time zone, communication preferences, addresses, social links, payment methods, and KPI metrics. It also includes pagination metadata for client-side navigation.
Response Body
{
"accounts": [
{
"status": "ACCOUNT_STATUS",
"id": "ACCOUNT_ID",
"name": "ACCOUNT_NAME",
"display_name": "ACCOUNT_DISPLAY_NAME",
"description": "ACCOUNT_DESCRIPTION",
"origin": "ACCOUNT_ORIGIN",
"invoice_parent_account": "BOOLEAN_STRING",
"type": "ACCOUNT_TYPE",
"email_address": "ACCOUNT_EMAIL",
"user_team": {},
"image_uri": "ACCOUNT_IMAGE_URI",
"custom_forms": {
"uuid": "FORM_UUID",
"name": "FORM_NAME"
},
"currency": {
"uuid": "CURRENCY_UUID",
"name": "CURRENCY_NAME",
"link": "CURRENCY_LINK"
},
"time_zone": {
"uuid": "TIMEZONE_UUID",
"name": "TIMEZONE_NAME",
"link": "TIMEZONE_LINK"
},
"grant_portal_access": "BOOLEAN_STRING",
"tax": {
"uuid": "TAX_UUID",
"code": "TAX_CODE",
"rate": TAX_RATE,
"link": "TAX_LINK"
},
"accounting_code": {},
"communication_preference": [
{
"media": "COMMUNICATION_MEDIA",
"enabled": "BOOLEAN_STRING"
}
],
"addresses": [
{
"address_line_1": "ADDR_LINE_1",
"address_line_2": "ADDR_LINE_2",
"address_line_3": "ADDR_LINE_3",
"address_line_4": "ADDR_LINE_4",
"address_line_5": "ADDR_LINE_5",
"post_code": "POST_CODE",
"city": "CITY",
"state": "STATE",
"country": "COUNTRY",
"default_billing": "BOOLEAN_STRING",
"default_shipping": "BOOLEAN_STRING",
"uuid": "ADDRESS_UUID"
}
],
"website": "ACCOUNT_WEBSITE",
"linkedin": "ACCOUNT_LINKEDIN",
"twitter": "ACCOUNT_TWITTER",
"facebook": "ACCOUNT_FACEBOOK",
"created_by": "CREATOR_NAME",
"created_on": "CREATED_TIMESTAMP",
"last_updated_by": "LAST_UPDATER",
"last_updated_on": "UPDATED_TIMESTAMP",
"uuid": "ACCOUNT_UUID",
"version": "VERSION",
"custom_attributes": [],
"custom_objects": [],
"billing_preferences": {
"communication_profile": "PROFILE_NAME",
"invoice_mode": "INVOICE_MODE",
"invoice_term": "INVOICE_TERM",
"billing_period": "BILLING_PERIOD",
"billing_start_date": "START_DATE",
"billing_start_day_of_month": "START_DAY",
"charging_and_billing_alignment": "BOOLEAN_STRING",
"payment_processor": "PROCESSOR_NAME",
"payment_mode": "PAYMENT_MODE",
"payment_term": "PAYMENT_TERM",
"payment_term_alignment": "TERM_ALIGNMENT"
},
"contacts": [
{
"type": "CONTACT_TYPE",
"type_display_name": "TYPE_DISPLAY",
"billing_contact": "BOOLEAN_STRING",
"shipping_contact": "BOOLEAN_STRING",
"salutation": {},
"designation": {},
"first_name": "FIRST_NAME",
"middle_name": "MIDDLE_NAME",
"last_name": "LAST_NAME",
"email": {
"address": "EMAIL_ADDRESS",
"do_not_email": "BOOLEAN_STRING"
},
"address_line_1": "ADDR1",
"address_line_2": "ADDR2",
"address_line_3": "ADDR3",
"address_line_4": "ADDR4",
"address_line_5": "ADDR5",
"post_code": "POSTCODE",
"city": "CITY",
"state": "STATE",
"country": "COUNTRY",
"phone": {
"country_code": "CC",
"area_code": "AC",
"number": "NUMBER",
"full": "FULL_NUMBER",
"do_not_call": "BOOLEAN_STRING"
},
"fax": {},
"mobile": {
"country_code": "CC",
"area_code": "AC",
"number": "NUMBER",
"full": "FULL_NUMBER",
"do_not_call": "BOOLEAN_STRING"
},
"receive_billing_information": "BOOLEAN_STRING",
"created_by": "CREATOR",
"created_on": "CREATED_DATE",
"last_updated_by": "UPDATER",
"last_updated_on": "UPDATED_DATE",
"uuid": "CONTACT_UUID",
"version": "VERSION",
"custom_attributes": []
}
],
"payment_methods": [
{
"processor_type": "PROCESSOR_TYPE",
"status": "STATUS",
"default": "BOOLEAN_STRING",
"processor": {
"uuid": "PROCESSOR_UUID",
"name": "PROCESSOR_NAME",
"link": "PROCESSOR_LINK"
},
"card_type": "CARD_TYPE",
"token": "CARD_TOKEN",
"card_number": "XXXX",
"expiry_month": "MM",
"expiry_year": "YY",
"card_cvv": "XXX",
"name_on_card": "NAME",
"reference": "CARD_REFERENCE",
"payment_count": "COUNT",
"last_used_on": "LAST_USED",
"last_used_result": "RESULT",
"error_count_since_last_success": "COUNT",
"created_by": "CREATOR",
"created_on": "CREATED_DATE",
"last_updated_by": "UPDATER",
"last_updated_on": "UPDATED_DATE",
"uuid": "PM_UUID",
"version": "VERSION",
"use_for_specified_orders": "BOOLEAN_STRING",
"specified_orders": "ORDERS"
}
],
"kpis": {
"total_revenue": 0,
"monthly_recurring_revenue": 0,
"total_collected": 0,
"total_refunded": 0,
"total_outstanding": 0,
"total_overdue": 0,
"total_balance": 0,
"total_credit_balance": 0,
"total_orders": 0,
"total_active_orders": 0,
"last_reactivated_on": "",
"last_cancelled_on": "",
"deleted_on": ""
}
}
],
"pagination": {
"records": RECORD_COUNT,
"limit": LIMIT_VALUE,
"offset": OFFSET_VALUE,
"previous_page": "PREVIOUS_PAGE_URL",
"next_page": "NEXT_PAGE_URL"
}
}
| Attribute | Type | Description |
|---|---|---|
| status | String | Status of the account |
| id | String | Unique account identifier |
| name | String | Name of the account |
| display_name | String | Display name of the account |
| description | String | Description of the account |
| origin | String | Origin or source of the account |
| invoice_parent_account | String | Whether the account is an invoice parent (boolean as string) |
| type | String | Type of the account |
| email_address | String | Email address associated with the account |
| user_team | Object | User team information (empty object in this example) |
| image_uri | String | URI of the account's image |
| custom_forms | Object | Custom form associated with the account |
| currency | Object | Currency details used by the account |
| time_zone | Object | Time zone details |
| grant_portal_access | String | Whether portal access is granted (boolean as string) |
| tax | Object | Tax settings applied to the account |
| accounting_code | Object | Accounting code information (empty object) |
| communication_preference | Array | List of communication preferences |
| addresses | Array | List of addresses associated with the account |
| website | String | Website URL |
| String | LinkedIn profile URL | |
| String | Twitter handle or URL | |
| String | Facebook profile URL | |
| created_by | String | Creator of the account |
| created_on | String | Timestamp when the account was created |
| last_updated_by | String | Last user who updated the account |
| last_updated_on | String | Timestamp of last update |
| uuid | String | Unique UUID of the account |
| version | String | Version number |
| custom_attributes | Array | List of custom attributes (empty in this example) |
| custom_objects | Array | List of custom objects (empty in this example) |
| billing_preferences | Object | Billing preferences for the account |
| contacts | Array | List of contact persons for the account |
| payment_methods | Array | Payment methods linked to the account |
| kpis | Object | Key performance indicators |
Retrieve Account Details by ID : /accounts/{account_id}
Purpose
This API retrieves the complete details of a specific customer account using its unique ID. It returns core account metadata along with billing preferences, contacts, addresses, communication settings, KPIs, payment methods, and configuration settings. This endpoint is essential for fetching all necessary information needed to manage or display a customer's account profile in the system.
Use Case
This endpoint is used to retrieve comprehensive information for a specific account, which may be either a customer or a supplier. The data returned includes identity details, contact and address information, payment methods, billing preferences, account status, time zone, currency, social media links, and performance KPIs. It is particularly useful for administrators or integrated systems needing full visibility into how an account is set up and managed.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| account_id | String | Unique identifier of account |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The API response for account details returns a complete and structured overview of a specific customer/Supplier account. It includes essential identity fields such as name, email, and status, as well as extensive business-related configurations. Billing preferences define how and when the account is invoiced (manual or automated, terms, and processor type). The contact list contains rich contact records, including names, phone numbers, email addresses, and whether they serve as billing or shipping contacts. Payment method data includes the card details , processor info, status, and usage metadata. The system also returns the full address list, communication preferences ( EMAIL), timezone, currency, tax settings, and associated custom forms or objects. Finally, a set of financial KPIs is included covering total revenue, balance, MRR, overdue amounts, and order counts supporting reporting and account analysis purposes. This response consolidates everything needed to understand, operate on, or display the account across interfaces or internal tools
Response Body
{
"ACCOUNT": {
"STATUS": "ACCOUNT_STATUS",
"ID": "ACCOUNT_ID",
"NAME": "ACCOUNT_NAME",
"DISPLAY_NAME": "ACCOUNT_DISPLAY_NAME",
"DESCRIPTION": "ACCOUNT_DESCRIPTION",
"ORIGIN": "ACCOUNT_ORIGIN",
"INVOICE_PARENT_ACCOUNT": "BOOLEAN",
"TYPE": "ACCOUNT_TYPE",
"EMAIL_ADDRESS": "ACCOUNT_EMAIL",
"USER_TEAM": {},
"IMAGE_URI": "ACCOUNT_IMAGE_URL",
"CUSTOM_FORMS": {
"UUID": "FORM_UUID",
"NAME": "FORM_NAME"
},
"CURRENCY": {
"UUID": "CURRENCY_UUID",
"NAME": "CURRENCY_NAME",
"LINK": "CURRENCY_API_LINK"
},
"TIME_ZONE": {
"UUID": "TIMEZONE_UUID",
"NAME": "TIMEZONE_NAME",
"LINK": "TIMEZONE_API_LINK"
},
"GRANT_PORTAL_ACCESS": "BOOLEAN",
"TAX": {
"UUID": "TAX_UUID",
"CODE": "TAX_CODE",
"RATE": "TAX_RATE",
"LINK": "TAX_API_LINK"
},
"ACCOUNTING_CODE": {},
"COMMUNICATION_PREFERENCE": [
{
"MEDIA": "COMMUNICATION_MEDIA",
"ENABLED": "BOOLEAN"
}
],
"ADDRESSES": [
{
"ADDRESS_LINE_1": "ADDRESS_LINE_1",
"ADDRESS_LINE_2": "ADDRESS_LINE_2",
"ADDRESS_LINE_3": "ADDRESS_LINE_3",
"ADDRESS_LINE_4": "ADDRESS_LINE_4",
"ADDRESS_LINE_5": "ADDRESS_LINE_5",
"POST_CODE": "POST_CODE",
"CITY": "CITY",
"STATE": "STATE",
"COUNTRY": "COUNTRY",
"DEFAULT_BILLING": "BOOLEAN",
"DEFAULT_SHIPPING": "BOOLEAN",
"UUID": "ADDRESS_UUID"
}
],
"WEBSITE": "WEBSITE_URL",
"LINKEDIN": "LINKEDIN_URL",
"TWITTER": "TWITTER_URL",
"FACEBOOK": "FACEBOOK_URL",
"CREATED_BY": "CREATED_BY_USER",
"CREATED_ON": "TIMESTAMP",
"LAST_UPDATED_BY": "UPDATED_BY_USER",
"LAST_UPDATED_ON": "TIMESTAMP",
"UUID": "ACCOUNT_UUID",
"VERSION": "VERSION_NUMBER",
"CUSTOM_ATTRIBUTES": [],
"CUSTOM_OBJECTS": [],
"BILLING_PREFERENCES": {
"COMMUNICATION_PROFILE": "BILLING_PROFILE",
"INVOICE_MODE": "INVOICE_MODE",
"INVOICE_TERM": "INVOICE_TERM",
"BILLING_PERIOD": "BILLING_PERIOD",
"BILLING_START_DATE": "BILLING_START_DATE",
"BILLING_START_DAY_OF_MONTH": "",
"CHARGING_AND_BILLING_ALIGNMENT": "BOOLEAN",
"PAYMENT_PROCESSOR": "PAYMENT_PROCESSOR",
"PAYMENT_MODE": "PAYMENT_MODE",
"PAYMENT_TERM": "PAYMENT_TERM",
"PAYMENT_TERM_ALIGNMENT": "PAYMENT_ALIGNMENT"
},
"CONTACTS": [
{
"TYPE": "CONTACT_TYPE",
"TYPE_DISPLAY_NAME": "CONTACT_TYPE_NAME",
"BILLING_CONTACT": "BOOLEAN",
"SHIPPING_CONTACT": "BOOLEAN",
"SALUTATION": {},
"DESIGNATION": {},
"FIRST_NAME": "CONTACT_FIRST_NAME",
"MIDDLE_NAME": "CONTACT_MIDDLE_NAME",
"LAST_NAME": "CONTACT_LAST_NAME",
"EMAIL": {
"ADDRESS": "CONTACT_EMAIL",
"DO_NOT_EMAIL": "BOOLEAN"
},
"ADDRESS_LINE_1": "CONTACT_ADDRESS_1",
"ADDRESS_LINE_2": "CONTACT_ADDRESS_2",
"ADDRESS_LINE_3": "CONTACT_ADDRESS_3",
"ADDRESS_LINE_4": "CONTACT_ADDRESS_4",
"ADDRESS_LINE_5": "CONTACT_ADDRESS_5",
"POST_CODE": "CONTACT_POST_CODE",
"CITY": "CONTACT_CITY",
"STATE": "CONTACT_STATE",
"COUNTRY": "CONTACT_COUNTRY",
"PHONE": {
"COUNTRY_CODE": "PHONE_COUNTRY_CODE",
"AREA_CODE": "PHONE_AREA_CODE",
"NUMBER": "PHONE_NUMBER",
"FULL": "PHONE_FULL",
"DO_NOT_CALL": "BOOLEAN"
},
"FAX": {},
"MOBILE": {
"COUNTRY_CODE": "MOBILE_COUNTRY_CODE",
"AREA_CODE": "NULL",
"NUMBER": "MOBILE_NUMBER",
"FULL": "MOBILE_FULL",
"DO_NOT_CALL": "BOOLEAN"
},
"RECEIVE_BILLING_INFORMATION": "BOOLEAN",
"CREATED_BY": "CREATED_BY_USER",
"CREATED_ON": "TIMESTAMP",
"LAST_UPDATED_BY": "UPDATED_BY_USER",
"LAST_UPDATED_ON": "TIMESTAMP",
"UUID": "CONTACT_UUID",
"VERSION": "VERSION_NUMBER",
"CUSTOM_ATTRIBUTES": []
}
],
"PAYMENT_METHODS": [
{
"PROCESSOR_TYPE": "PAYMENT_PROCESSOR_TYPE",
"STATUS": "PAYMENT_METHOD_STATUS",
"DEFAULT": "BOOLEAN",
"PROCESSOR": {
"UUID": "PROCESSOR_UUID",
"NAME": "PROCESSOR_NAME",
"LINK": "PROCESSOR_API_LINK"
},
"CARD_TYPE": "CARD_TYPE",
"TOKEN": "PAYMENT_TOKEN",
"CARD_NUMBER": "CARD_NUMBER_MASKED",
"EXPIRY_MONTH": "EXPIRY_MONTH",
"EXPIRY_YEAR": "EXPIRY_YEAR",
"CARD_CVV": "CARD_CVV_MASKED",
"NAME_ON_CARD": "",
"REFERENCE": "PAYMENT_REFERENCE",
"PAYMENT_COUNT": "NUMBER",
"LAST_USED_ON": "",
"LAST_USED_RESULT": "",
"ERROR_COUNT_SINCE_LAST_SUCCESS": "",
"CREATED_BY": "CREATED_BY_USER",
"CREATED_ON": "TIMESTAMP",
"LAST_UPDATED_BY": "",
"LAST_UPDATED_ON": "",
"UUID": "PAYMENT_METHOD_UUID",
"VERSION": "VERSION_NUMBER",
"USE_FOR_SPECIFIED_ORDERS": "BOOLEAN",
"SPECIFIED_ORDERS": ""
}
],
"KPIS": {
"TOTAL_REVENUE": "NUMBER",
"MONTHLY_RECURRING_REVENUE": "NUMBER",
"TOTAL_COLLECTED": "NUMBER",
"TOTAL_REFUNDED": "NUMBER",
"TOTAL_OUTSTANDING": "NUMBER",
"TOTAL_OVERDUE": "NUMBER",
"TOTAL_BALANCE": "NUMBER",
"TOTAL_CREDIT_BALANCE": "NUMBER",
"TOTAL_ORDERS": "NUMBER",
"TOTAL_ACTIVE_ORDERS": "NUMBER",
"LAST_REACTIVATED_ON": "",
"LAST_CANCELLED_ON": "",
"DELETED_ON": ""
}
}
}| Attribute | Type | Description |
|---|---|---|
| status | String | Status of the account (ACTIVE). |
| id | String | Unique account ID. |
| name / display_name | String | Name of the account owner. |
| description | String | Description or notes about the account. |
| origin | String | Source or origin of account creation. |
| type | String | Type of the account (e.g., CUSTOMER). |
| email_address | String | Email linked to the account. |
| user_team | Object | Associated user team (empty if not assigned). |
| image_uri | String | URL of the profile image. |
| custom_forms | Object | Linked form with UUID and name. |
| currency | Object | Account's currency info with name and link. |
| time_zone | Object | Timezone info with name and link. |
| grant_portal_access | String | Indicates if customer has portal access. |
| tax | Object | Tax setup including code and rate. |
| accounting_code | Object | Accounting code details (empty if not set). |
| communication_preference | Array | Preferred communication method (EMAIL). |
| addresses | Array | List of addresses (with full detail and UUID). |
| website, linkedin, twitter, facebook | String | Social and web links. |
| created_by / created_on | String | Metadata of account creation. |
| last_updated_by / last_updated_on | String | Metadata of last update. |
| uuid | String | Unique identifier for account. |
| version | String | Version number of the account. |
| custom_attributes | Array | Any additional custom attributes. |
| custom_objects | Array | Custom object list tied to the account. |
| billing_preferences | Object | Preferences related to billing, invoice mode, term, payment setup, etc. |
| contacts | Array | Detailed contact list with email, phone, address, and communication settings. |
| payment_methods | Array | Linked payment options with processor, card type, token, and UUID. |
| kpis | Object | Financial indicators like revenue, outstanding, credit balance, orders. |
Retrieving Account Information: /accounts/{account_id}/information
Purpose
This endpoint is used to retrieve detailed information for a specific account identified by its unique ID. It returns comprehensive data including the account’s identity, type, contact details, preferences, tax, time zone, and currency settings. This allows systems or users to understand and manage account configurations.
Use Case
This endpoint is primarily used to fetch complete information about an individual account, which can be either a customer or a supplier. It helps administrators or systems view core account metadata such as status, type, display name, tax configuration, communication preferences, and social media profiles. The endpoint is especially useful in scenarios where full visibility of an account’s setup is necessary, such as during account audits, integrations, profile rendering, or administrative reviews.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| account_id | String | Unique identifier of account |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The response contains a detailed structure of the requested account, including identifiers like ID and UUID, the account’s display and system names, status, and description. It also includes configuration data such as assigned currency, time zone, tax code, invoice parent setting, and grant portal access flag. Communication preferences like email, along with external links such as LinkedIn, Twitter, and Facebook, are also provided. System metadata like creation and update timestamps and user identifiers are included to track account history. This response ensures that all account-related configurations are available in a single payload for seamless use in UI rendering or backend logic.
{
"ACCOUNT": {
"STATUS": "ACCOUNT_STATUS",
"ID": "ACCOUNT_ID",
"NAME": "ACCOUNT_NAME",
"DISPLAY_NAME": "ACCOUNT_DISPLAY_NAME",
"DESCRIPTION": "ACCOUNT_DESCRIPTION",
"ORIGIN": "ACCOUNT_ORIGIN",
"INVOICE_PARENT_ACCOUNT": "BOOLEAN_FALSE",
"TYPE": "ACCOUNT_TYPE_CUSTOMER",
"EMAIL_ADDRESS": "ACCOUNT_EMAIL",
"USER_TEAM": {},
"IMAGE_URI": "ACCOUNT_IMAGE_URL",
"CUSTOM_FORMS": {
"UUID": "CUSTOM_FORM_UUID",
"NAME": "DEFAULT_FORM_NAME"
},
"CURRENCY": {
"UUID": "CURRENCY_UUID",
"NAME": "CURRENCY_CODE_AUD",
"LINK": "CURRENCY_API_LINK"
},
"TIME_ZONE": {
"UUID": "TIMEZONE_UUID",
"NAME": "TIMEZONE_NAME",
"LINK": "TIMEZONE_API_LINK"
},
"GRANT_PORTAL_ACCESS": "BOOLEAN_TRUE",
"TAX": {
"UUID": "TAX_UUID",
"CODE": "TAX_CODE_NO_TAX",
"RATE": "TAX_RATE_ZERO",
"LINK": "TAX_API_LINK"
},
"ACCOUNTING_CODE": {},
"COMMUNICATION_PREFERENCE": [
{
"MEDIA": "COMMUNICATION_MEDIA_EMAIL",
"ENABLED": "BOOLEAN_TRUE"
}
],
"WEBSITE": "WEBSITE_URL",
"LINKEDIN": "LINKEDIN_PROFILE_URL",
"TWITTER": "TWITTER_PROFILE_URL",
"FACEBOOK": "FACEBOOK_PROFILE_URL",
"CREATED_BY": "CREATED_BY_USER",
"CREATED_ON": "TIMESTAMP_CREATED",
"LAST_UPDATED_BY": "UPDATED_BY_USER",
"LAST_UPDATED_ON": "TIMESTAMP_UPDATED",
"UUID": "ACCOUNT_UUID",
"VERSION": "ACCOUNT_VERSION",
"CUSTOM_ATTRIBUTES": [],
"CUSTOM_OBJECTS": []
}
}| Attribute | Type | Description |
|---|---|---|
| status | String | Status of the account (e.g., ACTIVE). |
| id | String | Unique short identifier of the account. |
| name | String | Official name of the account. |
| display_name | String | Display name used for UI or external presentation. |
| description | String | Additional description of the account. |
| origin | String | Origin or source of the account. |
| invoice_parent_account | String | Indicates if this account is an invoice parent account. |
| type | String | Type of account (CUSTOMER or SUPPLIER). |
| email_address | String | Registered email address. |
| user_team | Object | Team or user group associated with the account. |
| image_uri | String | URL to the profile image. |
| custom_forms | Object | Assigned custom form data (UUID, name). |
| currency | Object | Assigned currency (UUID, name, API link). |
| time_zone | Object | Time zone assigned to the account (UUID, name, API link). |
| grant_portal_access | String | Whether portal access is granted (true/false). |
| tax | Object | Tax configuration details (UUID, code, rate, API link). |
| accounting_code | Object | Accounting-related codes (may be empty). |
| communication_preference | Array | Communication channels and preferences (e.g., EMAIL). |
| website | String | Website URL of the account. |
| linkedin | String | LinkedIn profile link. |
| twitter | String | Twitter profile link. |
| facebook | String | Facebook profile link. |
| created_by | String | Name of the user who created the account. |
| created_on | String | Timestamp of account creation (ISO 8601 format). |
| last_updated_by | String | Name of the last user who updated the account. |
| last_updated_on | String | Timestamp of last update (ISO 8601 format). |
| uuid | String | Global unique identifier for the account. |
| version | String | Version number of the account record. |
| custom_attributes | Array | List of custom attributes (if any). |
| custom_objects | Array | List of custom objects (if any). |
Retrieve Account Addresses: /accounts/{id}/addresses
Purpose
This API retrieves all saved address records associated with a specific account, including billing and shipping address details.
Use Case
Used when displaying or managing an account's stored addresses in account settings, checkout forms, invoice configurations, or shipping modules.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| id | String | Unique identifier of the account. |
Query Parameters
No query parameters required for this endpoint.
Request Body
No request body is required for this endpoint.
Response
Returns a list of all address records attached to the specified account. Each address includes structured fields and flags for default billing and shipping designation
{
"account": {
"id": "ACCOUNT_ID",
"addresses": [
{
"address_line_1": "ADDRESS_LINE_1",
"address_line_2": "ADDRESS_LINE_2",
"address_line_3": "ADDRESS_LINE_3",
"address_line_4": "ADDRESS_LINE_4",
"address_line_5": "ADDRESS_LINE_5",
"post_code": "POST_CODE",
"city": "CITY",
"state": "STATE",
"country": "COUNTRY",
"default_billing": "BOOLEAN_STRING",
"default_shipping": "BOOLEAN_STRING",
"uuid": "ADDRESS_UUID"
}
]
}
}
| Field | Type | Description |
|---|---|---|
| id | String | The account ID to which the addresses belong. |
| addresses | Array | List of address objects. |
| address_line_1-5 | String | Structured components of the full address. |
| post_code | String | ZIP or postal code. |
| city | String | Name of the city. |
| state | String | State or province. |
| country | String | Country name. |
| default_billing | String | Indicates if the address is used for billing. |
| default_shipping | String | Indicates if the address is used for shipping. |
| uuid | UUID | Unique identifier for the address. |
Get Address Details for a Specific Account:/accounts/{id}/addresses/{uuid}
Purpose
This API retrieves the detailed address information associated with a specific account, including all address lines, postal information, and flags indicating billing or shipping defaults. It ensures accurate retrieval of customer address data for operations such as invoicing, shipping, and auditing.
Use Case
Use this endpoint when you need to display or verify the physical or billing address of a customer account within systems like CRM, invoicing, delivery tracking, or contact management platforms.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | Unique identifier of the account. |
| uuid | string | Unique identifier (UUID) of the specific address. |
Query Parameters
No query parameters required for this endpoint.
Request Body
No request body is required.
Response
The response provides a single address associated with the given account and address UUID. It includes multiple address lines, city, state, postal code, country, and boolean flags indicating if the address is set as the default billing or shipping location.
{
"account": {
"id": "ACCOUNT_ID",
"addresses": {
"address_line_1": "ADDRESS_LINE_1",
"address_line_2": "ADDRESS_LINE_2",
"address_line_3": "ADDRESS_LINE_3",
"address_line_4": "ADDRESS_LINE_4",
"address_line_5": "ADDRESS_LINE_5",
"post_code": "POSTAL_CODE",
"city": "CITY_NAME",
"state": "STATE_NAME",
"country": "COUNTRY_NAME",
"default_billing": "BOOLEAN_STRING",
"default_shipping": "BOOLEAN_STRING",
"uuid": "ADDRESS_UUID"
}
}
}
| Field | Type | Description |
|---|---|---|
| account.id | string | Unique ID of the account. |
| addresses.address_line_1 to address_line_5 | string | Components of the physical address. Supports up to 5 lines. |
| addresses.post_code | string | Postal or ZIP code of the address. |
| addresses.city | string | City where the address is located. |
| addresses.state | string | State or province of the address. |
| addresses.country | string | Country where the address is located. |
| addresses.default_billing | string (boolean) | Indicates if this is the default billing address. |
| addresses.default_shipping | string (boolean) | Indicates if this is the default shipping address. |
| addresses.uuid | string (UUID) | Unique identifier for the address record. |
Retrieving All Payment Methods for an Account: /accounts/{account_id}/payment-methods
Purpose
This endpoint retrieves all the payment methods associated with a specific account. It includes both manual methods like Cash and Cheque, Bank Deposit and digital methods such as credit card processors. Each payment method's configuration, status, reference, and metadata are included in the response.
Use Case
This endpoint is used to retrieve and review all payment methods associated with a specific account. It supports both manual methods (like Cash, Cheque, and Bank Deposit) and digital processors (such as credit card payments via secure gateways). By calling this endpoint, users can view which processors are active, which one is set as the default, and retrieve processor details such as names, UUIDs, creation timestamps, and other metadata. It is particularly useful for managing billing configurations, checking card expiration details, or auditing which methods are being used most frequently by the account.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| account_id | String | Unique identifier of account |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The response returns the list of all payment methods associated with the specified account. Each payment method includes metadata such as status, default flag, payment processor details (name, UUID, link), reference string, card details (if applicable), creation metadata, and usage statistics. It also includes processor-specific details like the processor’s name, UUID, and API link. If the payment method involves a credit card, additional fields like card type, masked card number, expiry month and year, and a masked CVV are provided. Metadata such as creation date, last updated date, and user information (who created or modified it) are also included. The response ensures that all essential data is available to manage and audit payment setups tied to an account.
{
"ACCOUNT": {
"ID": "ACCOUNT_ID",
"PAYMENT_METHODS": [
{
"PROCESSOR_TYPE": "PAYMENT_PROCESSOR_TYPE_OTHER",
"STATUS": "PAYMENT_METHOD_STATUS_ACTIVE",
"DEFAULT": "BOOLEAN_FALSE",
"PROCESSOR": {
"UUID": "PAYMENT_PROCESSOR_UUID_1",
"NAME": "PAYMENT_METHOD_CASH",
"LINK": "PAYMENT_PROCESSOR_API_URL_1"
},
"REFERENCE": "PAYMENT_REFERENCE_1",
"PAYMENT_COUNT": "0",
"LAST_USED_ON": "",
"CREATED_BY": "CREATED_BY_IMPLEMENTER",
"CREATED_ON": "TIMESTAMP_1",
"LAST_UPDATED_BY": "",
"LAST_UPDATED_ON": "",
"UUID": "PAYMENT_METHOD_UUID_1",
"VERSION": "1",
"USE_FOR_SPECIFIED_ORDERS": "BOOLEAN_FALSE",
"SPECIFIED_ORDERS": ""
},
{
"PROCESSOR_TYPE": "PAYMENT_PROCESSOR_TYPE_OTHER",
"STATUS": "PAYMENT_METHOD_STATUS_ACTIVE",
"DEFAULT": "BOOLEAN_FALSE",
"PROCESSOR": {
"UUID": "PAYMENT_PROCESSOR_UUID_2",
"NAME": "PAYMENT_METHOD_CHEQUE",
"LINK": "PAYMENT_PROCESSOR_API_URL_2"
},
"REFERENCE": "PAYMENT_REFERENCE_2",
"PAYMENT_COUNT": "0",
"LAST_USED_ON": "",
"CREATED_BY": "CREATED_BY_IMPLEMENTER",
"CREATED_ON": "TIMESTAMP_2",
"LAST_UPDATED_BY": "",
"LAST_UPDATED_ON": "",
"UUID": "PAYMENT_METHOD_UUID_2",
"VERSION": "1",
"USE_FOR_SPECIFIED_ORDERS": "BOOLEAN_FALSE",
"SPECIFIED_ORDERS": ""
},
{
"PROCESSOR_TYPE": "PAYMENT_PROCESSOR_TYPE_OTHER",
"STATUS": "PAYMENT_METHOD_STATUS_ACTIVE",
"DEFAULT": "BOOLEAN_FALSE",
"PROCESSOR": {
"UUID": "PAYMENT_PROCESSOR_UUID_3",
"NAME": "PAYMENT_METHOD_BANK_DEPOSIT",
"LINK": "PAYMENT_PROCESSOR_API_URL_3"
},
"REFERENCE": "PAYMENT_REFERENCE_3",
"PAYMENT_COUNT": "0",
"LAST_USED_ON": "",
"CREATED_BY": "CREATED_BY_IMPLEMENTER",
"CREATED_ON": "TIMESTAMP_3",
"LAST_UPDATED_BY": "",
"LAST_UPDATED_ON": "",
"UUID": "PAYMENT_METHOD_UUID_3",
"VERSION": "1",
"USE_FOR_SPECIFIED_ORDERS": "BOOLEAN_FALSE",
"SPECIFIED_ORDERS": ""
},
{
"PROCESSOR_TYPE": "PAYMENT_PROCESSOR_TYPE_DIRECT_CREDIT",
"STATUS": "PAYMENT_METHOD_STATUS_ACTIVE",
"DEFAULT": "BOOLEAN_TRUE",
"PROCESSOR": {
"UUID": "PAYMENT_PROCESSOR_UUID_4",
"NAME": "PAYMENT_PROCESSOR_SECURE_PAY",
"LINK": "PAYMENT_PROCESSOR_API_URL_4"
},
"CARD_TYPE": "CARD_TYPE_VISA",
"TOKEN": "PAYMENT_TOKEN",
"CARD_NUMBER": "CARD_NUMBER_MASKED",
"EXPIRY_MONTH": "CARD_EXPIRY_MONTH",
"EXPIRY_YEAR": "CARD_EXPIRY_YEAR",
"CARD_CVV": "CARD_CVV_MASKED",
"NAME_ON_CARD": "",
"REFERENCE": "PAYMENT_REFERENCE_4",
"PAYMENT_COUNT": "0",
"LAST_USED_ON": "",
"LAST_USED_RESULT": "",
"ERROR_COUNT_SINCE_LAST_SUCCESS": "",
"CREATED_BY": "CREATED_BY_IMPLEMENTER",
"CREATED_ON": "TIMESTAMP_4",
"LAST_UPDATED_BY": "UPDATED_BY_IMPLEMENTER",
"LAST_UPDATED_ON": "TIMESTAMP_5",
"UUID": "PAYMENT_METHOD_UUID_4",
"VERSION": "2",
"USE_FOR_SPECIFIED_ORDERS": "BOOLEAN_FALSE",
"SPECIFIED_ORDERS": ""
}
]
}
}| Attribute | Type | Description |
|---|---|---|
| account.id | String | Unique ID of the account. |
| payment_methods | Array | List of payment methods under the account. |
| processor_type | String | Type of the processor (OTHER, DIRECT_CREDIT). |
| status | String | Status of the payment method . |
| default | Boolean | Indicates if this is the default payment method. |
| processor.uuid | String | UUID of the linked payment processor. |
| processor.name | String | Name of the payment processor . |
| processor.link | String | API link to the processor. |
| reference | String | Reference string assigned to the method. |
| card_type | String | Card type if applicable . |
| card_number | String | Masked card number. |
| expiry_month | String | Expiry month of the card. |
| expiry_year | String | Expiry year of the card. |
| created_by | String | Name of the user who created the method. |
| created_on | DateTime | Creation timestamp in ISO 8601 format. |
| last_updated_by | String | Name of the user who last updated the method. |
| last_updated_on | DateTime | Last update timestamp. |
| uuid | String | Unique identifier for the payment method. |
| version | String | Version number of the payment method record. |
| use_for_specified_orders | Boolean | Indicates if this payment method is tied to specific orders only. |
| specified_orders | String | Contains the list of associated order IDs (if any). |
Retrieve Account Payment Method by Reference: /accounts/{account_id}/payment-methods/$reference$
Purpose
This endpoint retrieves the details of a single payment method associated with a specific account, identified by a unique reference string. It is used to fetch processor configuration, card details (if applicable), and metadata linked to that particular payment method.
Use Case
This API is useful when a system administrator, billing handler, or support personnel needs to view the complete setup of a particular payment method linked to an account. By providing the account ID and the payment method’s reference, the function returns all stored data for that method, such as processor type (DIRECT_CREDIT), default status, card type and number (if applicable), processor info, and timestamps related to creation or last update. It helps ensure accuracy and traceability for financial configurations within the system.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| account_id | String | The unique ID of the account holding the payment method. |
| reference | String | A unique reference string to identify the specific payment method. |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The response returns the account ID and the full detail of the payment method associated with the provided reference. The information includes the processor type (DIRECT_CREDIT), processor details (name, UUID, link), status, default flag, and relevant card details if applicable (card type, masked card number, expiry, and token). It also includes timestamps, versioning information, and any usage metadata such as last used date or number of times used.
{
"account": {
"id": "ACCOUNT_ID",
"payment_method": {
"processor_type": "PAYMENT_PROCESSOR_TYPE",
"status": "PAYMENT_METHOD_STATUS",
"default": "BOOLEAN_TRUE",
"processor": {
"uuid": "PAYMENT_PROCESSOR_UUID",
"name": "PAYMENT_PROCESSOR_NAME",
"link": "PAYMENT_PROCESSOR_API_URL"
},
"card_type": "CARD_TYPE",
"token": "PAYMENT_TOKEN",
"card_number": "MASKED_CARD_NUMBER",
"expiry_month": "CARD_EXPIRY_MONTH",
"expiry_year": "CARD_EXPIRY_YEAR",
"card_cvv": "MASKED_CVV",
"name_on_card": "",
"reference": "PAYMENT_REFERENCE",
"payment_count": "0",
"last_used_on": "",
"last_used_result": "",
"error_count_since_last_success": "",
"created_by": "SYSTEM_USER",
"created_on": "TIMESTAMP_CREATED",
"last_updated_by": "SYSTEM_USER",
"last_updated_on": "TIMESTAMP_UPDATED",
"uuid": "PAYMENT_METHOD_UUID",
"version": "VERSION_NUMBER",
"use_for_specified_orders": "BOOLEAN_FALSE",
"specified_orders": ""
}
}
}| Attribute | Type | Description |
|---|---|---|
| account.id | String | ID of the account associated with the payment method. |
| payment_method.processor_type | String | Type of processor (e.g., DIRECT_CREDIT, OTHER). |
| payment_method.status | String | Current status of the payment method . |
| payment_method.default | String | Indicates whether this method is set as default. |
| payment_method.processor | Object | Contains UUID, name, and API link of the processor. |
| payment_method.card_type | String | Type of card if the processor is credit-based . |
| payment_method.card_number | String | Masked card number for display. |
| payment_method.expiry_month | String | Card expiry month. |
| payment_method.expiry_year | String | Card expiry year. |
| payment_method.card_cvv | String | Masked CVV information. |
| payment_method.reference | String | Unique reference string of the payment method. |
| payment_method.payment_count | String | Total number of times this method was used. |
| payment_method.last_used_on | String | Timestamp of the last usage. |
| payment_method.created_by | String | Name of the user who created this method. |
| payment_method.created_on | String | Creation timestamp. |
| payment_method.last_updated_by | String | User who last updated the payment method. |
| payment_method.last_updated_on | String | Last update timestamp. |
| payment_method.uuid | String | Unique ID of the payment method. |
| payment_method.version | String | Version number of this payment configuration. |
| payment_method.use_for_specified_orders | String | Indicates whether it's tied to specific orders. |
| payment_method.specified_orders | String | Comma-separated list of specific order IDs (if any). |
Retrieve Billing Preferences for an Account: /accounts/{account_id}/billing-preferences
Purpose
This API retrieves the billing preferences configured for a specific account. It provides detailed settings that define how invoices are generated, when billing occurs, how payments are processed, and the communication preferences related to billing.
Use Case
This endpoint is used by the UI or internal systems when viewing or editing account billing settings. This endpoint fetches and displays current preferences like invoice mode, payment terms, billing start date logic, and communication profile. It is also used during troubleshooting to understand how billing is configured for a specific customer.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| account_id | String | Unique identifier of the account. |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The response contains the billing preference settings for the specified account. These preferences include how and when invoices are generated (invoice_mode, invoice_term), how often (billing_period), and which day of the month they start (billing_start_day_of_month). It also indicates whether charging aligns with billing, what payment processor and method are used, and the preferred communication profile for invoice delivery.
{
"account": {
"id": "ACCOUNT_ID",
"billing_preferences": {
"communication_profile": "COMMUNICATION_PROFILE_NAME",
"invoice_mode": "INVOICE_MODE",
"invoice_term": "INVOICE_TERM",
"billing_period": "BILLING_PERIOD",
"billing_start_date": "BILLING_START_DATE",
"billing_start_day_of_month": "DAY_OF_MONTH",
"charging_and_billing_alignment": "BOOLEAN",
"payment_processor": "PAYMENT_PROCESSOR",
"payment_mode": "PAYMENT_MODE",
"payment_term": "PAYMENT_TERM",
"payment_term_alignment": "PAYMENT_TERM_ALIGNMENT"
}
}
}| Attribute | Type | Description |
|---|---|---|
| account.id | String | The unique identifier of the account. |
| billing_preferences.communication_profile | String | Profile used for sending billing communication. |
| billing_preferences.invoice_mode | String | Determines how invoices are generated. |
| billing_preferences.invoice_term | String | Indicates the term type. Billing Start Date, Order Date. |
| billing_preferences.billing_period | String | Duration of each billing cycle. Monthly, Quarterly, 4 Month. |
| billing_preferences.billing_start_date | String | Logic for when billing begins. |
| billing_preferences.billing_start_day_of_month | String | Day of the month billing starts. |
| billing_preferences.charging_and_billing_alignment | Boolean (as String) | Indicates if charging is aligned with billing (true or false). |
| billing_preferences.payment_processor | String | The name of the configured payment processor (Cash, Cheque). |
| billing_preferences.payment_mode | String | Defines if payment is manual or automatic. MANUAL, AUTOMATIC. |
| billing_preferences.payment_term | String | Payment due timeline after invoice. |
| billing_preferences.payment_term_alignment | String | Specifies alignment for payment terms. |
Retrieve All Notes of an Account: /accounts/{account_id}/notes
Purpose
This API retrieves all notes associated with a specific account. Notes include plain text, formatted content, or attachments that document account activity. It supports note history with versioning and includes metadata such as creation date, author, and linked files.
Use Case
This endpoint is used to view all notes stored for a specific account. These notes may include manual entries, automated system logs, or uploaded file attachments and help maintain a timeline of events and references related to customer management or communication. It's particularly helpful for understanding account history during service calls or audits.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| account_id | String | Unique identifier of account |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The response returns a list of notes associated with the specified account. Each note contains a unique identifier (), content (which may include HTML-formatted text), the creator's name, creation and last update timestamps, and any associated file metadata (name, version, UUID). Pagination details are included to manage long lists of notes effectively.
{
"account": {
"notes": [
{
"uuid": "NOTE_UUID_1",
"version": "VERSION",
"content": "NOTE_CONTENT_1",
"files": [],
"created_by": "CREATED_BY",
"created_on": "TIMESTAMP",
"last_updated_by": "EMPTY",
"last_updated_on": "EMPTY",
"custom_attributes": []
},
{
"uuid": "NOTE_UUID_2",
"version": "VERSION",
"content": "NOTE_CONTENT_2",
"files": [],
"created_by": "CREATED_BY",
"created_on": "TIMESTAMP",
"last_updated_by": "EMPTY",
"last_updated_on": "EMPTY",
"custom_attributes": []
}
],
"pagination": {
"records": "NUMBER",
"limit": "NUMBER",
"offset": "NUMBER",
"previous_page": "EMPTY",
"next_page": "PAGINATION_URL"
}
}
}| Attribute | Type | Description |
|---|---|---|
| uuid | String | Unique identifier for the note |
| version | String | Version number of the note |
| content | String | Text or HTML content of the note |
| files | Array | List of attached files with uuid, name, and version |
| created_by | String | Name of the user who created the note |
| created_on | DateTime | Timestamp when the note was created |
| last_updated_by | String | Name of the user who last updated the note (if applicable) |
| last_updated_on | DateTime | Timestamp of the last update (if applicable) |
| custom_attributes | Array | Custom attributes associated with the note (currently empty) |
| pagination.records | Integer | Total number of notes |
| pagination.limit | Integer | Maximum notes per page |
| pagination.offset | Integer | Current page offset |
| pagination.previous_page | String | Link to the previous page (if any) |
| pagination.next_page | String | Link to the next page (if any) |
Retrieving a Note Details: /accounts/{account_id}/notes/{note_uuid}
Purpose
This API retrieves the detailed information of a single note associated with a specific account. The note may contain plain or formatted text, attached files, and metadata indicating who created or updated it and when.
Use Case
This endpoint is used when authenticate user interface needs to view the full content and metadata of a specific note within an account's communication history. A note created by an internal watcher (such as system) and sent it to an external watcher (such as customers or portal users). Notes may include rich HTML-formatted content, file attachments, or both. This endpoint supports scenarios like customer support reviews, audit trails, and documentation lookups, where accessing the full context of a particular note is essential.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| account_id | String | Unique identifier of the account |
| note_uuid | String | Unique identifier of the note to retrieve |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint
Response
The response returns the complete details of the requested note. It includes the note content, version, author details, timestamps, and any files attached to the note. It also indicates who last updated the note and when, supporting audit and traceability functions. Notes can contain HTML content and may also include custom attributes for extended metadata handling.
{
"account": {
"note": {
"uuid": "NOTE_UUID",
"version": "VERSION",
"content": "HTML_FORMATTED_CONTENT",
"files": [
{
"uuid": "FILE_UUID",
"name": "FILE_NAME",
"version": "FILE_VERSION"
}
],
"created_by": "CREATED_BY",
"created_on": "CREATION_TIMESTAMP",
"last_updated_by": "UPDATED_BY",
"last_updated_on": "UPDATE_TIMESTAMP",
"custom_attributes": []
}
}
}| Attribute | Type | Description |
|---|---|---|
| uuid | String | Unique identifier of the note |
| version | String | Version of the note record |
| content | String | Content of the note, can be plain or rich HTML |
| files | Array | List of files attached to the note |
| files[].uuid | String | Unique ID of the attached file |
| files[].name | String | Name of the attached file |
| files[].version | String | Version of the attached file |
| created_by | String | Name of the user or system who created the note |
| created_on | DateTime | Timestamp when the note was created |
| last_updated_by | String | Name of the user or system who last updated the note |
| last_updated_on | DateTime | Timestamp when the note was last updated |
| custom_attributes | Array | List of custom attributes associated with the note |
Retrieve All Files of a Note: /accounts/{account_id}/notes/{note_uuid}/files
Purpose
This API is used to retrieve all the files that are attached to a specific note associated with a particular account. It provides access to all type of attachments such as documents, images, spreadsheets, or text files that were uploaded as part of the note content.
Use Case
This endpoint is used when authenticated user want to review or see the all type of files associated with a note they can use this to programmatically fetch all attachments linked to that note. This ensures that file records are properly accessible and auditable within the account's communication history.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| account_id | String | The unique identifier of the account |
| note_uuid | String | The unique identifier of the note |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The API response includes a list of all file records linked to the specified note. Each file object contains the UUID, filename, and version. This helps identify and manage note-related documents efficiently. If there are no files attached to the note, the returned list will be empty.
{
"account": {
"note": {
"files": [
{
"uuid": "FILE_UUID_1",
"name": "IMAGE_FILE.jpg",
"version": "FILE_VERSION"
},
{
"uuid": "FILE_UUID_2",
"name": "DATA_FILE.csv",
"version": "FILE_VERSION"
},
{
"uuid": "FILE_UUID_3",
"name": "DOCUMENT_FILE.pdf",
"version": "FILE_VERSION"
},
{
"uuid": "FILE_UUID_4",
"name": "TEXT_FILE.txt",
"version": "FILE_VERSION"
}
],
"custom_attributes": []
}
}
}| Attribute | Type | Description |
|---|---|---|
| uuid | String | Unique identifier of the file |
| name | String | Name of the uploaded file |
| version | String | Version number of the file |
| custom_attributes | Array | Custom metadata attributes (if applicable) |
Retrieve Single Note File Details: /accounts/{account_id}/notes/{note_uuid}/files/{file_uuid}
Purpose
This API is used to retrieve detailed information about a specific file attached to a particular note within an account. It enables users to inspect the metadata of an individual file without needing to fetch the entire list of note attachments.
Use Case
This endpoint is used to fetch just one file’s details instead of retrieving all note files. When working with account-related notes that include file uploads (invoices, reports, images), users may need to inspect a single file for its version, name, or unique ID especially when verifying attachments, debugging sync issues, or displaying metadata.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| account__id | String | Unique identifier of the account |
| note_uuid | String | Unique identifier of the note |
| file_uuid | String | Unique identifier of the file to be deleted |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The API response includes the metadata of the specified file, such as its unique UUID, filename, and version. It confirms the existence and integrity of the file within the note, helping ensure accurate tracking and management of attached resources. Additionally, a custom_attributes array is included for extensibility but may be empty if not used.
{
"account": {
"note": {
"files": [
{
"uuid": "FILE_UUID",
"name": "SPREADSHEET_FILE.xlsx",
"version": "FILE_VERSION"
}
],
"custom_attributes": []
}
}
}| Attribute | Type | Description |
|---|---|---|
| uuid | String | Unique identifier of the file |
| name | String | The name of the file (including extension) |
| version | String | Version number of the file |
| custom_attributes | Array | Additional metadata for the file (if any) |
Retrieve Account Image Details: /accounts/{account_id}/image
Purpose
This endpoint retrieves the image details associated with a specific account. When an account is created, an optional image can be attached.
Use Case
This endpoint is used to retrieve the profile image of an account for display in dashboards, user portals, or account summaries. If no image has been set for the account, the image_uri field will return null. This endpoint helps determine whether an image is associated with the account and provides the file path to access it.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| account_id | String | The unique identifier of the account |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The API response contains the image_uri which points to the file path of the uploaded image for the account, and the corresponding account_id. If no image was uploaded for the account, the image_uri will be , indicating the absence of an associated image.
{
"account": {
"image_uri": "RESOURCE_PATH/ACCOUNT_IMAGE.jpg",
"account_id": "ACCOUNT_ID"
}
}| Attribute | Type | Description |
|---|---|---|
| image_uri | String | URI path to the image file associated with the account, or null if not available |
| account_id | String | The unique identifier of the account |