Fetch customer details

Search customers based on passed search parameters

curl --request GET \
  --url https://api.valyx.com/external/customer/search \
  --header 'X-Valyx-Signature: <x-valyx-signature>'

{
  "error": "<string>",
  "message": "<string>",
  "data": {
    "totalDocs": 123,
    "docs": [
      {
        "id": "<string>",
        "buyerId": "<string>",
        "companyId": "<string>",
        "name": "<string>",
        "alias": "<string>",
        "registeredAddress": {
          "line1": "<string>",
          "line2": "<string>",
          "state": "<string>",
          "city": "<string>",
          "country": "<string>",
          "zipCode": "<string>"
        },
        "addresses": [
          {
            "line1": "<string>",
            "line2": "<string>",
            "state": "<string>",
            "city": "<string>",
            "country": "<string>",
            "zipCode": "<string>"
          }
        ],
        "contacts": [
          {
            "id": "<string>",
            "name": "<string>",
            "primaryPhone": "<string>",
            "primaryEmail": "<string>",
            "role": "<string>"
          }
        ],
        "internalStakeholders": [
          {
            "id": "<string>",
            "name": "<string>",
            "primaryPhone": "<string>",
            "primaryEmail": "<string>",
            "role": "<string>",
            "isRegistered": true
          }
        ],
        "taxIdentifiers": [
          {
            "value": "<string>",
            "type": "<string>"
          }
        ],
        "customerContactPerson": "<string>",
        "currency": "<string>",
        "currencyId": "<string>",
        "tags": {},
        "metaData": {},
        "customerStatus": "<string>",
        "upcomingCustomerStatus": "<string>",
        "upcomingCustomerStatusChangeDate": "<string>",
        "upcomingCustomerStatusChangeReason": "<string>",
        "upcomingCustomerStatusChangeByUserid": "<string>",
        "isManuallyCreated": true,
        "erpId": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "totalInvoiceAmount": 123,
        "totalPaidAmount": 123,
        "totalOutstandingAmount": 123,
        "totalAdjustedAmount": 123,
        "invoiceCount": 123,
        "creditNoteCount": 123,
        "overdueAmount": 123,
        "overdueCount": 123
      }
    ],
    "hasNext": true,
    "hasPrev": true,
    "pageNumber": 123,
    "pageSize": 123,
    "totalPages": 123,
    "prevPageNumber": 123,
    "nextPageNumber": 123
  }
}

GET

external

customer

Search customers based on passed search parameters

curl --request GET \
  --url https://api.valyx.com/external/customer/search \
  --header 'X-Valyx-Signature: <x-valyx-signature>'

{
  "error": "<string>",
  "message": "<string>",
  "data": {
    "totalDocs": 123,
    "docs": [
      {
        "id": "<string>",
        "buyerId": "<string>",
        "companyId": "<string>",
        "name": "<string>",
        "alias": "<string>",
        "registeredAddress": {
          "line1": "<string>",
          "line2": "<string>",
          "state": "<string>",
          "city": "<string>",
          "country": "<string>",
          "zipCode": "<string>"
        },
        "addresses": [
          {
            "line1": "<string>",
            "line2": "<string>",
            "state": "<string>",
            "city": "<string>",
            "country": "<string>",
            "zipCode": "<string>"
          }
        ],
        "contacts": [
          {
            "id": "<string>",
            "name": "<string>",
            "primaryPhone": "<string>",
            "primaryEmail": "<string>",
            "role": "<string>"
          }
        ],
        "internalStakeholders": [
          {
            "id": "<string>",
            "name": "<string>",
            "primaryPhone": "<string>",
            "primaryEmail": "<string>",
            "role": "<string>",
            "isRegistered": true
          }
        ],
        "taxIdentifiers": [
          {
            "value": "<string>",
            "type": "<string>"
          }
        ],
        "customerContactPerson": "<string>",
        "currency": "<string>",
        "currencyId": "<string>",
        "tags": {},
        "metaData": {},
        "customerStatus": "<string>",
        "upcomingCustomerStatus": "<string>",
        "upcomingCustomerStatusChangeDate": "<string>",
        "upcomingCustomerStatusChangeReason": "<string>",
        "upcomingCustomerStatusChangeByUserid": "<string>",
        "isManuallyCreated": true,
        "erpId": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "totalInvoiceAmount": 123,
        "totalPaidAmount": 123,
        "totalOutstandingAmount": 123,
        "totalAdjustedAmount": 123,
        "invoiceCount": 123,
        "creditNoteCount": 123,
        "overdueAmount": 123,
        "overdueCount": 123
      }
    ],
    "hasNext": true,
    "hasPrev": true,
    "pageNumber": 123,
    "pageSize": 123,
    "totalPages": 123,
    "prevPageNumber": 123,
    "nextPageNumber": 123
  }
}

Headers

X-Valyx-Signature

string

required

Auth key

X-Fields

string<mask>

An optional fields mask

Query Parameters

amountType

string

identifierType

enum<string>

Available options:

GSTIN,

PAN,

BUYER_ID,

CUSTOMER_NAME

identifierValue

string

minAmount

number

maxAmount

number

invoiceStatus

string[]

list of invoice statuses to filter by

paymentStatus

string[]

list of payment statuses to filter by

customerStatus

string[]

list of customer statuses to filter by

tag

string[]

list of tag key-value pair to filter by

excludeTag

string[]

list of tag key-value pair to filter by (exclude)

excludeTagKey

string[]

list of tag key to filter by (exclude)

ownerId

string[]

owner ID to search by

ownerRole

string[]

owner role to search by

notOwnerRole

string[]

not owner role to search by

contactRole

string[]

contact role to search by

notContactRole

string[]

not contact role to search by

page

integer

required

Page number for pagination.

pageSize

integer

required

Page size for pagination.

dateType

enum<string>

Available options:

INVOICE_DATE,

DUE_DATE,

PROMISE_TO_PAY_DATE

startDate

string

Start date for invoices

endDate

string

End date for invoices

createdAtStart

string

Customer creation date start - will return customers created on or after this date. Pass as YYYY-MM-DD string

createdAtEnd

string

Customer creation date end - will return customers created on or before this date. Pass as YYYY-MM-DD string

currencies

string[]

Currencies

Response

200 - application/json

Success

error

string

message

string

data

object

Show child attributes

data.totalDocs

integer

data.docs

object[]

Show child attributes

data.docs.id

string

data.docs.buyerId

string

data.docs.companyId

string

data.docs.name

string

data.docs.alias

string

data.docs.registeredAddress

object

Show child attributes

data.docs.registeredAddress.line1

string

data.docs.registeredAddress.line2

string

data.docs.registeredAddress.state

string

data.docs.registeredAddress.city

string

data.docs.registeredAddress.country

string

data.docs.registeredAddress.zipCode

string

data.docs.addresses

object[]

Show child attributes

data.docs.addresses.line1

string

data.docs.addresses.line2

string

data.docs.addresses.state

string

data.docs.addresses.city

string

data.docs.addresses.country

string

data.docs.addresses.zipCode

string

data.docs.contacts

object[]

Show child attributes

data.docs.contacts.id

string

data.docs.contacts.name

string

data.docs.contacts.primaryPhone

string

data.docs.contacts.primaryEmail

string

data.docs.contacts.role

string

data.docs.internalStakeholders

object[]

Show child attributes

data.docs.internalStakeholders.id

string

data.docs.internalStakeholders.name

string

data.docs.internalStakeholders.primaryPhone

string

data.docs.internalStakeholders.primaryEmail

string

data.docs.internalStakeholders.role

string

data.docs.internalStakeholders.isRegistered

boolean

data.docs.taxIdentifiers

object[]

Show child attributes

data.docs.taxIdentifiers.value

string

data.docs.taxIdentifiers.type

string

data.docs.customerContactPerson

string

data.docs.currency

string

data.docs.currencyId

string

data.docs.tags

object

data.docs.metaData

object

data.docs.customerStatus

string

data.docs.upcomingCustomerStatus

string

data.docs.upcomingCustomerStatusChangeDate

string

data.docs.upcomingCustomerStatusChangeReason

string

data.docs.upcomingCustomerStatusChangeByUserid

string

data.docs.isManuallyCreated

boolean

data.docs.erpId

string

data.docs.createdAt

string

data.docs.updatedAt

string

data.docs.totalInvoiceAmount

number

data.docs.totalPaidAmount

number

data.docs.totalOutstandingAmount

number

data.docs.totalAdjustedAmount

number

data.docs.invoiceCount

number

data.docs.creditNoteCount

number

data.docs.overdueAmount

number

data.docs.overdueCount

number

data.hasNext

boolean

data.hasPrev

boolean

data.pageNumber

integer

data.pageSize

integer

data.totalPages

integer

data.prevPageNumber

integer

data.nextPageNumber

integer

Update an existing customer Create / Update an Invoice

⌘I

Authentication

Billing

Usage

Customer

Invoice

Credit Notes

Examples

Fetch customer details

Headers

Query Parameters

Response