comecerodocs

Update general settings

POST
/settings/general

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.

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

Request Body

application/json
  1. body

The general fields to change. Send only the fields you want to change.

Properties1 <= properties
reporting_currency_primary?string

ISO 4217 currency code. Refused with 400 once the account has a payment in this mode.

reporting_currency_secondary?string

ISO 4217 currency code. Refused with 400 once the account has a payment in this mode.

notification_from_addresses?array<>

The full list of from addresses (it replaces the saved list). Each new address is sent a verification email. More addresses than your limit (1 by default), or removing an address a notification subscription still uses, returns 422.

cart_app_id?|

An installed app that accepts carts. Refused with 400 if the app is not installed or cannot take carts.

invoice_app_id?|

An installed app that accepts invoice payments. Refused with 400 if the app is not installed or cannot take invoices.

customer_admin_app_id?|

An installed app for the customer account pages.

order_pdf_template_id?|

A template of yours in the same mode. A template from the other mode or another account returns 400. Send null to use the default.

invoice_pdf_template_id?|

Like order_pdf_template_id, for invoice PDFs.

invoice_custom_fields?array<>

The full list of custom invoice fields (it replaces the saved list). Labels and keys are trimmed, blanks and repeated keys are dropped. More than 20 returns 422.

Response Body

The general settings, after the change.

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 POST 'https://api.comecero.com/api/v1/settings/general' \  -H 'Content-Type: application/json' \  -d '{  "notification_from_addresses": [    "sales@example.com"  ],  "invoice_custom_fields": [    {      "label": "PO Number",      "required": false    }  ]}'
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    }  ]}