The Customer object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

customer_name string required
gender string
customer_type string

Default: Company

default_bank_account string
lead_name string
image string
account_manager string
customer_group string
territory string
tax_id string
tax_category string
disabled boolean

Default: false

is_internal_customer boolean

Default: false

represents_company string
default_currency string
default_price_list string
language string
website string
customer_primary_contact string
mobile_no string
email_id string
customer_primary_address string
primary_address string
payment_terms string
customer_details string
market_segment string
industry string
is_frozen boolean

Default: false

loyalty_program string
loyalty_program_tier string
default_sales_partner string
default_commission_rate number
customer_pos_id string
so_required boolean

Default: false

dn_required boolean

Default: false

tax_withholding_category string
opportunity_name string
prospect_name string
first_name string
last_name string
tax_withholding_group string
The Customer object 
{
  "id": "customer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "customer_name": "customer_name_example",
  "gender": "gender_example",
  "customer_type": "Company",
  "default_bank_account": "default_bank_account_example",
  "lead_name": "lead_name_example",
  "image": "image_example",
  "account_manager": "account_manager_example",
  "customer_group": "customer_group_example",
  "territory": "territory_example",
  "tax_id": "tax_id_example",
  "tax_category": "tax_category_example",
  "disabled": false,
  "is_internal_customer": false,
  "represents_company": "Example Corp",
  "default_currency": "USD",
  "default_price_list": "default_price_list_example",
  "language": "language_example",
  "website": "website_example",
  "customer_primary_contact": "customer_primary_contact_example",
  "mobile_no": "mobile_no_example",
  "email_id": "user@example.com",
  "customer_primary_address": "customer_primary_address_example",
  "primary_address": "primary_address_example",
  "payment_terms": "payment_terms_example",
  "customer_details": "customer_details_example",
  "market_segment": "market_segment_example",
  "industry": "industry_example",
  "is_frozen": false,
  "loyalty_program": "loyalty_program_example",
  "loyalty_program_tier": "loyalty_program_tier_example",
  "default_sales_partner": "default_sales_partner_example",
  "default_commission_rate": 0,
  "customer_pos_id": "customer_pos_id_example",
  "so_required": false,
  "dn_required": false,
  "tax_withholding_category": "tax_withholding_category_example",
  "opportunity_name": "opportunity_name_example",
  "prospect_name": "prospect_name_example",
  "first_name": "first_name_example",
  "last_name": "last_name_example",
  "tax_withholding_group": "tax_withholding_group_example"
}
GET /api/crm/customer/{id}

Retrieve a customer

Retrieves the details of an existing customer. Supply the unique customer ID that was returned from a previous request.

Path parameters

id string required

The identifier of the customer to retrieve.

Returns

Returns the customer object if a valid identifier was provided.

GET /api/crm/customer/{id} 
curl https://api.overplane.dev/api/crm/customer/customer_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "customer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "customer_name": "customer_name_example",
  "gender": "gender_example",
  "customer_type": "Company",
  "default_bank_account": "default_bank_account_example",
  "lead_name": "lead_name_example",
  "image": "image_example",
  "account_manager": "account_manager_example",
  "customer_group": "customer_group_example",
  "territory": "territory_example",
  "tax_id": "tax_id_example",
  "tax_category": "tax_category_example",
  "disabled": false,
  "is_internal_customer": false,
  "represents_company": "Example Corp",
  "default_currency": "USD",
  "default_price_list": "default_price_list_example",
  "language": "language_example",
  "website": "website_example",
  "customer_primary_contact": "customer_primary_contact_example",
  "mobile_no": "mobile_no_example",
  "email_id": "user@example.com",
  "customer_primary_address": "customer_primary_address_example",
  "primary_address": "primary_address_example",
  "payment_terms": "payment_terms_example",
  "customer_details": "customer_details_example",
  "market_segment": "market_segment_example",
  "industry": "industry_example",
  "is_frozen": false,
  "loyalty_program": "loyalty_program_example",
  "loyalty_program_tier": "loyalty_program_tier_example",
  "default_sales_partner": "default_sales_partner_example",
  "default_commission_rate": 0,
  "customer_pos_id": "customer_pos_id_example",
  "so_required": false,
  "dn_required": false,
  "tax_withholding_category": "tax_withholding_category_example",
  "opportunity_name": "opportunity_name_example",
  "prospect_name": "prospect_name_example",
  "first_name": "first_name_example",
  "last_name": "last_name_example",
  "tax_withholding_group": "tax_withholding_group_example"
}
GET /api/crm/customer

List all customers

Returns a list of customers. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of customer objects.

GET /api/crm/customer 
curl https://api.overplane.dev/api/crm/customer \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "customer_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "customer_name": "customer_name_example",
      "gender": "gender_example",
      "customer_type": "Company",
      "default_bank_account": "default_bank_account_example",
      "lead_name": "lead_name_example",
      "image": "image_example",
      "account_manager": "account_manager_example",
      "customer_group": "customer_group_example",
      "territory": "territory_example",
      "tax_id": "tax_id_example",
      "tax_category": "tax_category_example",
      "disabled": false,
      "is_internal_customer": false,
      "represents_company": "Example Corp",
      "default_currency": "USD",
      "default_price_list": "default_price_list_example",
      "language": "language_example",
      "website": "website_example",
      "customer_primary_contact": "customer_primary_contact_example",
      "mobile_no": "mobile_no_example",
      "email_id": "user@example.com",
      "customer_primary_address": "customer_primary_address_example",
      "primary_address": "primary_address_example",
      "payment_terms": "payment_terms_example",
      "customer_details": "customer_details_example",
      "market_segment": "market_segment_example",
      "industry": "industry_example",
      "is_frozen": false,
      "loyalty_program": "loyalty_program_example",
      "loyalty_program_tier": "loyalty_program_tier_example",
      "default_sales_partner": "default_sales_partner_example",
      "default_commission_rate": 0,
      "customer_pos_id": "customer_pos_id_example",
      "so_required": false,
      "dn_required": false,
      "tax_withholding_category": "tax_withholding_category_example",
      "opportunity_name": "opportunity_name_example",
      "prospect_name": "prospect_name_example",
      "first_name": "first_name_example",
      "last_name": "last_name_example",
      "tax_withholding_group": "tax_withholding_group_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/crm/customer

Create a customer

Creates a new customer object.

Body parameters

customer_name string required
gender string
customer_type string

Default: Company

default_bank_account string
lead_name string
image string
account_manager string
customer_group string
territory string
tax_id string
tax_category string
disabled boolean

Default: false

is_internal_customer boolean

Default: false

represents_company string
default_currency string
default_price_list string
language string
website string
customer_primary_contact string
mobile_no string
email_id string
customer_primary_address string
primary_address string
payment_terms string
customer_details string
market_segment string
industry string
is_frozen boolean

Default: false

loyalty_program string
loyalty_program_tier string
default_sales_partner string
default_commission_rate number
customer_pos_id string
so_required boolean

Default: false

dn_required boolean

Default: false

tax_withholding_category string
opportunity_name string
prospect_name string
first_name string
last_name string
tax_withholding_group string

Returns

Returns the newly created customer object if the call succeeded.

POST /api/crm/customer 
curl https://api.overplane.dev/api/crm/customer \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"customer_name":"customer_name_example"}'
Response 
{
  "id": "customer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "customer_name": "customer_name_example",
  "gender": "gender_example",
  "customer_type": "Company",
  "default_bank_account": "default_bank_account_example",
  "lead_name": "lead_name_example",
  "image": "image_example",
  "account_manager": "account_manager_example",
  "customer_group": "customer_group_example",
  "territory": "territory_example",
  "tax_id": "tax_id_example",
  "tax_category": "tax_category_example",
  "disabled": false,
  "is_internal_customer": false,
  "represents_company": "Example Corp",
  "default_currency": "USD",
  "default_price_list": "default_price_list_example",
  "language": "language_example",
  "website": "website_example",
  "customer_primary_contact": "customer_primary_contact_example",
  "mobile_no": "mobile_no_example",
  "email_id": "user@example.com",
  "customer_primary_address": "customer_primary_address_example",
  "primary_address": "primary_address_example",
  "payment_terms": "payment_terms_example",
  "customer_details": "customer_details_example",
  "market_segment": "market_segment_example",
  "industry": "industry_example",
  "is_frozen": false,
  "loyalty_program": "loyalty_program_example",
  "loyalty_program_tier": "loyalty_program_tier_example",
  "default_sales_partner": "default_sales_partner_example",
  "default_commission_rate": 0,
  "customer_pos_id": "customer_pos_id_example",
  "so_required": false,
  "dn_required": false,
  "tax_withholding_category": "tax_withholding_category_example",
  "opportunity_name": "opportunity_name_example",
  "prospect_name": "prospect_name_example",
  "first_name": "first_name_example",
  "last_name": "last_name_example",
  "tax_withholding_group": "tax_withholding_group_example"
}
PATCH /api/crm/customer/{id}

Update a customer

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the customer to update.

Body parameters

customer_name string
gender string
customer_type string

Default: Company

default_bank_account string
lead_name string
image string
account_manager string
customer_group string
territory string
tax_id string
tax_category string
disabled boolean

Default: false

is_internal_customer boolean

Default: false

represents_company string
default_currency string
default_price_list string
language string
website string
customer_primary_contact string
mobile_no string
email_id string
customer_primary_address string
primary_address string
payment_terms string
customer_details string
market_segment string
industry string
is_frozen boolean

Default: false

loyalty_program string
loyalty_program_tier string
default_sales_partner string
default_commission_rate number
customer_pos_id string
so_required boolean

Default: false

dn_required boolean

Default: false

tax_withholding_category string
opportunity_name string
prospect_name string
first_name string
last_name string
tax_withholding_group string

Returns

Returns the updated customer object.

PATCH /api/crm/customer/{id} 
curl https://api.overplane.dev/api/crm/customer/customer_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"customer_name":"customer_name_example","gender":"gender_example"}'
Response 
{
  "id": "customer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "customer_name": "customer_name_example",
  "gender": "gender_example",
  "customer_type": "Company",
  "default_bank_account": "default_bank_account_example",
  "lead_name": "lead_name_example",
  "image": "image_example",
  "account_manager": "account_manager_example",
  "customer_group": "customer_group_example",
  "territory": "territory_example",
  "tax_id": "tax_id_example",
  "tax_category": "tax_category_example",
  "disabled": false,
  "is_internal_customer": false,
  "represents_company": "Example Corp",
  "default_currency": "USD",
  "default_price_list": "default_price_list_example",
  "language": "language_example",
  "website": "website_example",
  "customer_primary_contact": "customer_primary_contact_example",
  "mobile_no": "mobile_no_example",
  "email_id": "user@example.com",
  "customer_primary_address": "customer_primary_address_example",
  "primary_address": "primary_address_example",
  "payment_terms": "payment_terms_example",
  "customer_details": "customer_details_example",
  "market_segment": "market_segment_example",
  "industry": "industry_example",
  "is_frozen": false,
  "loyalty_program": "loyalty_program_example",
  "loyalty_program_tier": "loyalty_program_tier_example",
  "default_sales_partner": "default_sales_partner_example",
  "default_commission_rate": 0,
  "customer_pos_id": "customer_pos_id_example",
  "so_required": false,
  "dn_required": false,
  "tax_withholding_category": "tax_withholding_category_example",
  "opportunity_name": "opportunity_name_example",
  "prospect_name": "prospect_name_example",
  "first_name": "first_name_example",
  "last_name": "last_name_example",
  "tax_withholding_group": "tax_withholding_group_example"
}
DELETE /api/crm/customer/{id}

Delete a customer

Permanently deletes a customer. This cannot be undone.

Path parameters

id string required

The identifier of the customer to delete.

Returns

Returns a confirmation that the customer has been deleted.

DELETE /api/crm/customer/{id} 
curl https://api.overplane.dev/api/crm/customer/customer_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "customer_abc123",
  "deleted": true
}

Line items

Child objects that belong to this customer. These are accessed via the parent's ID.

Supplier Number At Customer

Attributes

idx integer
customer_id string required
company string
supplier_number string

Endpoints

GET /api/crm/supplier-number-at-customer?parent_id={id}
POST /api/crm/supplier-number-at-customer
PATCH /api/crm/supplier-number-at-customer/{id}
DELETE /api/crm/supplier-number-at-customer/{id}
POST /api/crm/supplier-number-at-customer/reorder
Supplier Number At Customer object 
{
  "id": "supplier-number-at-customer_abc123",
  "idx": 1,
  "customer_id": "customer_id_example",
  "company": "Example Corp",
  "supplier_number": "supplier_number_example"
}