Skip to main content
POST
/
billing
/
contract
/
feeComponent
cURL
curl --request POST \
  --url https://api.valyx.com/billing/contract/feeComponent \
  --header 'Content-Type: application/json' \
  --header 'X-Valyx-Signature: <x-valyx-signature>' \
  --data '
{
  "feeComponentId": "<string>",
  "contractId": "<string>"
}
'
{
  "error": "<string>",
  "message": "<string>",
  "data": {
    "totalDocs": 123,
    "docs": [
      {
        "id": {},
        "customerId": {},
        "contractNumber": {},
        "contractTitle": {},
        "contractPeriod": {},
        "renewalPeriod": {},
        "noteContract": {},
        "billingFrequency": {},
        "usageBillingCycle": {},
        "estimateCycle": {},
        "billingTime": {},
        "startDate": {},
        "virtualStartDate": {},
        "endDate": {},
        "nextBillingDate": {},
        "billingDiscounts": {},
        "isPreusage": {},
        "billingReportLimit": {},
        "contractLimit": {},
        "creditTermId": {},
        "poNumber": {},
        "placeOfSupply": {},
        "billingAddress": {},
        "shippingAddress": {},
        "totalInvoicedAmount": {},
        "noteInvoice": {},
        "terms": {},
        "advanceConfig": {},
        "invoiceSplitConfig": {},
        "gstin": {},
        "companyGstin": {},
        "currency": {},
        "currencyId": {},
        "companyId": {},
        "createdBy": {},
        "updatedBy": {},
        "status": {},
        "autoRenew": {}
      }
    ],
    "hasNext": true,
    "hasPrev": true,
    "pageNumber": 123,
    "pageSize": 123,
    "totalPages": 123,
    "prevPageNumber": 123,
    "nextPageNumber": 123
  }
}

Headers

​
X-Valyx-Signature
string
required

Auth key to authenticate the request

Body

application/json
​
feeComponentId
string
required

The unique identifier of the fee component to associate with the contract.

​
contractId
string
required

The unique identifier of the contract to which the fee component will be linked.

Response

200 - application/json

Success

​
error
string
​
message
string
​
data
object