Skip to main content
GET
/
billing
/
contract
/
filter
cURL
curl --request GET \
  --url https://api.valyx.com/billing/contract/filter \
  --header 'X-Valyx-Signature: <x-valyx-signature>'
{
  "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 for fetching ledger entries

​
X-Fields
string<mask>

An optional fields mask

Query Parameters

​
customerId
string

Customer ID of the customer

​
buyerId
string

Buyer ID of the customer

​
contractNumber
string
​
contractDurationValue
integer

Value of the contract duration (if contract duration is 3 years, value will be 3)

​
contractDurationUnit
string

Unit of the contract duration (if contract duration is 3 years, unit will be YEAR)

​
billingFrequencyValue
integer

Value of the billing frequency (if billing frequency is 2 months, value will be 2)

​
billingFrequencyUnit
string

Unit of the billing frequency (if billing frequency is 2 months, unit will be MONTH)

​
nextBillingDateStart
string

Start date of the next billing date filter

​
nextBillingDateEnd
string

End date of the next billing date filter

​
status
enum<string>
Available options:
ACTIVE,
DRAFT,
CANCELLED,
EXPIRED
​
pageNumber
integer
required
​
pageSize
integer
required
​
currencies
string[]

Response

200 - application/json

Success

​
error
string
​
message
string
​
data
object