comecerodocs
Settings

Get general settings

GET
/settings/general

Returns the reporting currencies, notification from addresses, document templates and custom invoice fields. Settings are kept per mode: a test token works on the test settings, a live token on the live ones. Secret and trusted tokens may call it when their permissions include settings_general. Limited tokens may not.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Query Parameters

show?string

Comma-separated fields to return; all others are left out. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

hide?string

Comma-separated fields to leave out of the response. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

formatted?boolean

When true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.

Defaultfalse

Response Body

The general settings.

application/json
  1. response

General settings of the account in the current mode: reporting currencies, the addresses emails are sent from, document templates and custom invoice fields.

object?"settings_general"

The object type. Always settings_general.

Value in"settings_general"
url?string

The URL of this object.

Formaturi
account_id?string

The ID of the account the settings belong to.

test?boolean

True for the test mode settings, false for live.

date_modified?string

When the settings were last changed.

Formatdate-time
reporting_currency_primary?string

The main currency reports are shown in (ISO 4217 code). It is stored on every payment, so it cannot be changed after the first payment in this mode. Contact support if you need to change it.

reporting_currency_secondary?string

A second reporting currency (ISO 4217 code). Like the primary, it is fixed after the first payment in this mode.

notification_from_addresses?array<>

The email addresses your notifications may be sent from. Each new address gets a verification email. Accounts may have 1 address unless support raises the limit.

cart_app_id?|

The ID of the installed app that serves the cart.

invoice_app_id?|

The ID of the installed app that serves the invoice payment page.

customer_admin_app_id?|

The ID of the installed app that serves the customer account pages.

order_pdf_template_id?|

The ID of your template used for order PDFs. null uses the default.

invoice_pdf_template_id?|

The ID of your template used for invoice PDFs. null uses the default.

invoice_custom_fields?array<>

Extra fields shown on every invoice form, PDF and email, such as a PO number. The values for an invoice are kept in its meta, under each field's key.

Itemsitems <= 20
formatted?

Display text for the dates. Returned only when formatted=true.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/settings/general'
Example Response
{  "object": "settings_general",  "url": "https://api.comecero.com/api/v1/settings/general",  "account_id": "AB1234",  "test": true,  "date_modified": "2026-10-02T14:21:07Z",  "reporting_currency_primary": "USD",  "reporting_currency_secondary": "EUR",  "notification_from_addresses": [    "sales@example.com"  ],  "cart_app_id": "comecero-shopping-cart",  "invoice_app_id": "comecero-shopping-cart",  "customer_admin_app_id": "comecero-customer-admin",  "order_pdf_template_id": null,  "invoice_pdf_template_id": null,  "invoice_custom_fields": [    {      "key": "po_number",      "label": "PO Number",      "required": false    }  ]}

Update fulfillment settings POST

Changes the capture and fulfillment rules. Send only the fields you want to change. The change applies to payments and orders made after it. Settings are kept per mode: a test token works on the test settings, a live token on the live ones. Secret and trusted tokens may call it when their permissions include `settings_fulfillment`. Limited tokens may not.

Update general settings POST

Changes the general settings. Send only the fields you want to change. A new notification from address is sent a verification email. Reporting currencies cannot change once the account has a payment in this mode. Settings are kept per mode: a test token works on the test settings, a live token on the live ones. Secret and trusted tokens may call it when their permissions include `settings_general`. Limited tokens may not.