KIO Link
KIO Link XC API
KIO Link APIHuawei BMSHuawei Alert
KIO Link XC API
KIO Link APIHuawei BMSHuawei Alert
  1. XC Contract Settings
  • DocuSign
    • Overview
    • List a XC request's DocuSign envelopes
      GET
    • Get an embeded URL signature for a XC Request
      GET
    • Regenerate a URL signature for the current signer
      GET
    • List the order of signers of a DocuSign Envelope
      GET
    • Create a DocuSign envelope for a XC request
      POST
    • Resend email & recover URL signature for a XC request
      POST
    • Create a DocuSign envelope for multiple signers
      POST
  • XC Client Prices
    • Overview
    • List XC client prices
      GET
    • Get a XC client's price
      GET
    • Create a XC client's price
      POST
    • Update a XC client's price
      PATCH
    • Delete a XC client's price
      DELETE
  • XC Comments
    • Overview
    • List XC comments
      GET
    • Get a XC comment
      GET
    • Create a XC comment
      POST
    • Update a XC comment
      PATCH
    • Delete a XC comment
      DELETE
  • XC Connections
    • Overview
    • List XC connections
    • Get a XC connection
    • Create a XC connection
    • Update a XC connection
    • Delete a XC connection
  • XC Contract Settings
    • Overview
    • List XC contract settings
      GET
    • Get a XC contract setting
      GET
    • Get a XC Request's contract setting
      GET
    • Create a XC contract setting
      POST
    • Update a XC contract setting
      PATCH
    • Delete a XC contract setting
      DELETE
  • XC Contract Setting Participants
    • Overview
    • List all XC contract settings participants
    • List a XC contract settings participants
    • Get a XC contract settings participant
    • Create a XC contract settings participant
    • Update a XC contract settings participant
    • Delete a XC contract settings participant
  • XC Data Centers
    • Overview
    • List XC datacenters
    • Create a XC datacenter
    • Update a XC datacenter
    • Delete a XC datacenter
  • XC Documents
    • Overview
    • List XC documents
    • Get a XC document's metadata
    • Get a XC document download URL
    • Get a XC document binary file
    • Upload a XC document
    • Delete a XC document
  • XC Reports
    • Overview
    • Download XC requests report
    • Download XC satisfaction survey report
    • Download XC connections report
  • XC Requests
    • Overview
    • List XC requests
    • Get a XC request
    • Get a XC request (complete details)
    • Create a XC request
    • Upsert a XC request draft
    • Update a XC request's general data
    • Change a XC request's status
    • Delete a XC request
    • Revert a XC request to Revision
  • XC Salesforce
    • Overview
    • Accounts
      • Overview
      • List accounts
      • Get an account
    • Opportunities
      • Overview
      • Attachments
        • Overview
        • List opportunity attachments
        • Upload an opportunity attachment
        • Download an opportunity file
      • List opportunities
      • Get an opportunity
      • Create an opportunity
      • Update an opportunity
    • Products
      • Overview
      • List products
      • Get a product
    • Project Requests
      • Overview
      • List project requests
      • Get a project request
      • Create a project request
      • Update a project request
    • Users
      • Overview
      • List users
      • Get a user
    • XC/IC Requests
      • Overview
      • Attachments
        • Overview
        • List XC/IC attachments
        • Upload a XC/IC attachment
        • Download a XC/IC file
      • List XC/IC requests
      • List all KIO Link connections from Salesforce XC/IC requests
      • Get a XC/IC request
      • Create a XC/IC request
      • Update a XC/IC request
  • XC Satisfaction Survey
    • Overview
    • List XC satisfaction surveys
    • Get a XC satisfaction survey
    • Get a XC satisfaction survey per user
    • Create XC satisfaction survey
  • XC Statuses
    • Overview
    • List XC statuses
    • Get a XC status
    • Create a XC status
    • Update a XC status
    • Delete a XC status
  • XC Status Histories
    • Overview
    • List XC status histories
    • List XC status history time summary
    • Get a XC status history record
  • Schemas
    • DocuSign
      • DocuSign Envelope Signer
      • DocuSign Signing URL Result
      • DocuSign Signer Routing
      • DocuSign Resend Result
      • DocuSign Envelope
    • XC Client Prices
      • XC Client Price
    • XC Comments
      • XC Comment
    • XC Connections
      • XC Connection
    • XC Contract Settings
      • XC Contract Setting
    • XC Contract Setting Participants
      • XC Contract Setting Participant
    • XC Data Centers
      • XC Datacenter
    • XC Documents
      • XC Document
    • XC Requests
      • XC Request With Relations
      • XC Request List Item
      • XC Request
      • XC Request With Details
    • XC Salesforce
      • Salesforce Connection
      • Salesforce Account
      • Salesforce User
      • Salesforce Product
      • Salesforce Opportunity List Item
      • Salesforce Opportunity
      • Salesforce Opportunity Write Result
      • Salesforce Attachment
      • Salesforce Attachment Upload Result
      • Salesforce Attachment Download Result
      • Salesforce Request List Item
      • Salesforce Request Point
      • Salesforce Request
      • Salesforce Request Write Result
      • Salesforce Project Request
      • Salesforce Project Request Write Result
      • Salesforce Quote
      • Salesforce Quote Line
    • XC Satisfaction Surveys
      • XC Satisfaction Survey
    • XC Statuses
      • XC Status
    • XC Status Histories
      • XC Status Time
      • XC Status Stage Time
      • XC Status History
    • Error
    • Date Metadata
    • Pagination Metadata
  1. XC Contract Settings

Overview

XC Contract Settings#

CRUD endpoints for the billing/document configuration of an XC (Cross-Connect) request: document language, pricing (MRC/NRC), currency, and the account name shown on generated documents.

Concepts#

One setting per request: each XC request can have at most one contract setting. Creating a second one for the same xc_request_id returns 409 Conflict.
doc_lang is required on create: must be EN or ES — this is the language used when generating the SOW/Acta documents for the request.
Deriving price from a client price record: passing xc_client_price_id (a record from XC Client Prices) copies its mrc_price, nrc_price, currency, and account_name onto the contract setting, overriding any explicit values passed in the same request. Passing it again on update re-syncs those fields from the (possibly different) client price record.
xc_request_id is immutable: it can only be set at creation; attempting to change it on update returns 400 Bad Request.
Participants: Get responses (by ID and by request) include the setting's participants (see XC Contract Setting Participants); the List response does not.

Endpoints#

List XC contract settings#

GET /v1/xc/contract-settings
Paginated list, optionally filtered by xc_request_id, xc_client_price_id, or doc_lang.

Create a XC contract setting#

POST /v1/xc/contract-settings
Creates the contract setting for a request. Requires xc_request_id and doc_lang.

Get a XC contract setting#

GET /v1/xc/contract-settings/{id}
Returns a setting by its own ID.

Get a XC Request's contract setting#

GET /v1/xc/contract-settings/by-request/{id}
Returns the setting for a given XC request ID.

Update a XC contract setting#

PATCH /v1/xc/contract-settings/{id}
Updates one or more fields; xc_request_id cannot be changed.

Delete a XC contract setting#

DELETE /v1/xc/contract-settings/{id}
Permanently deletes a setting.

Source#

Router: routes/v1/xc/contract-settings.router.js
Controller: controllers/xc/contract-settings.controller.js
Service: services/xc/contract-settings.service.js
Entity: entities/xc-contract-setting.js
Modified at 2026-09-25 18:13:15
Previous
Delete a XC connection
Next
List XC contract settings
Built with