Lire la configuration clients

Prod Env

https://relay.exostack.cloud/{{relay_path}}

GET

/api/customers/control

Retourne la configuration globale du module clients. Ressource singleton (toujours control_id=1). Par défaut, retourne les blocs core (invoicing, interest, statements, payments, receivables). Ajouter include=advanced pour les blocs techniques complets.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Query Params

Responses

🟢200

application/json

Successful Response

Body

🟠400

🟠401

🟠409

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://relay.exostack.cloud//api/customers/control?include=advanced&refresh=auto' \
--header 'x-api-key: <api-key>'

Response Example

{
    "control_id": 1,
    "customer_app_active": true,
    "interest": {
        "last_date": "2026-02-28T00:00:00-05:00",
        "last_number": "INT-000123",
        "minimum_charge": 5,
        "rate": 12
    },
    "invoicing": {
        "confirm_product_group": false,
        "current_year": 2026,
        "default_invoice_qty": 1,
        "discount_allowed": true,
        "invoice_number_length": 12,
        "invoicing_cost": {
            "code": "last_cost",
            "id": 1,
            "label": "Dernier coûtant"
        },
        "multi_sales_rep_active": false,
        "multi_sales_rep_default_mode": {
            "code": "global",
            "id": 0,
            "label": "Global"
        },
        "pos_qty_before_product": false,
        "pos_qty_maximum": 999999,
        "show_red_below_cost": true,
        "taxes_included": false,
        "to_receive_name": "À recevoir",
        "total_purchases_date": "2026-01-01T00:00:00-05:00",
        "upc_next_line": true,
        "warning_on_invoice_no_change": true
    },
    "metadata": {
        "sdk_interface": "ControlCustomer",
        "sdk_record_card_pos": 1,
        "unique_id": 11,
        "updated_at": "2026-03-05T10:45:00-05:00",
        "updated_by_user_id": 7
    },
    "payments": {
        "authorized_payments_active": false,
        "credit_cards": [
            {
                "card_index": 1,
                "name": "Visa"
            }
        ],
        "default_mode": {
            "code": "to_receive",
            "id": 0,
            "label": "Paiement à recevoir"
        },
        "multiple_payment": true,
        "notification_delay_days": 0,
        "payment_number": "PAY-001024",
        "withdrawal_allowed": false
    },
    "receivables": [
        {
            "active": true,
            "description": "Recevable principal",
            "invoice_number": "F-10001",
            "invoice_prefix": "F",
            "price_list_to_use": 1,
            "receivable_index": 0,
            "shipping_enabled": true,
            "shipping_tax_exception": {
                "code": "EX2",
                "id": 2
            },
            "tax_group": {
                "code": "TXG1",
                "id": 5
            },
            "used": true
        }
    ],
    "statements": {
        "aged_trial_balance_date": "2026-02-28T00:00:00-05:00",
        "aged_trial_balance_date_active": true,
        "customer_statement_date": "2026-02-28T00:00:00-05:00",
        "customer_statement_date_active": true,
        "statement_number": "STAT-000512"
    },
    "sync": {
        "cache_source": "sdk",
        "cache_stale": false,
        "cursor": {
            "card_pos": 1,
            "modified_at": "2026-03-05T10:45:00-05:00"
        },
        "extracted_at": "2026-03-05T10:46:00-05:00",
        "organisation_id": "org-main"
    }
}

Modified at 2026-03-17 18:36:59

Clients

Extraction incrémentale configuration clients (avancé)