The Supplier 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.

supplier_name string required
country string
default_bank_account string
tax_id string
tax_category string
tax_withholding_category string
is_transporter boolean

Default: false

is_internal_supplier boolean

Default: false

represents_company string
image string
supplier_group string
supplier_type string

Default: Company

language string
disabled boolean

Default: false

warn_rfqs boolean

Default: false

warn_pos boolean

Default: false

prevent_rfqs boolean

Default: false

prevent_pos boolean

Default: false

default_currency string
default_price_list string
payment_terms string
on_hold boolean

Default: false

hold_type string
release_date string
website string
supplier_details string
is_frozen boolean

Default: false

allow_purchase_invoice_creation_without_purchase_order boolean

Default: false

allow_purchase_invoice_creation_without_purchase_receipt boolean

Default: false

supplier_primary_contact string
mobile_no string
email_id string
primary_address string
supplier_primary_address string
tax_withholding_group string
gender string
The Supplier object 
{
  "id": "supplier_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "supplier_name": "supplier_name_example",
  "country": "country_example",
  "default_bank_account": "default_bank_account_example",
  "tax_id": "tax_id_example",
  "tax_category": "tax_category_example",
  "tax_withholding_category": "tax_withholding_category_example",
  "is_transporter": false,
  "is_internal_supplier": false,
  "represents_company": "Example Corp",
  "image": "image_example",
  "supplier_group": "supplier_group_example",
  "supplier_type": "Company",
  "language": "language_example",
  "disabled": false,
  "warn_rfqs": false,
  "warn_pos": false,
  "prevent_rfqs": false,
  "prevent_pos": false,
  "default_currency": "USD",
  "default_price_list": "default_price_list_example",
  "payment_terms": "payment_terms_example",
  "on_hold": false,
  "hold_type": "hold_type_example",
  "release_date": "2024-01-15",
  "website": "website_example",
  "supplier_details": "supplier_details_example",
  "is_frozen": false,
  "allow_purchase_invoice_creation_without_purchase_order": false,
  "allow_purchase_invoice_creation_without_purchase_receipt": false,
  "supplier_primary_contact": "supplier_primary_contact_example",
  "mobile_no": "mobile_no_example",
  "email_id": "user@example.com",
  "primary_address": "primary_address_example",
  "supplier_primary_address": "supplier_primary_address_example",
  "tax_withholding_group": "tax_withholding_group_example",
  "gender": "gender_example"
}
GET /api/buying/supplier/{id}

Retrieve a supplier

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

Path parameters

id string required

The identifier of the supplier to retrieve.

Returns

Returns the supplier object if a valid identifier was provided.

GET /api/buying/supplier/{id} 
curl https://api.overplane.dev/api/buying/supplier/supplier_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "supplier_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "supplier_name": "supplier_name_example",
  "country": "country_example",
  "default_bank_account": "default_bank_account_example",
  "tax_id": "tax_id_example",
  "tax_category": "tax_category_example",
  "tax_withholding_category": "tax_withholding_category_example",
  "is_transporter": false,
  "is_internal_supplier": false,
  "represents_company": "Example Corp",
  "image": "image_example",
  "supplier_group": "supplier_group_example",
  "supplier_type": "Company",
  "language": "language_example",
  "disabled": false,
  "warn_rfqs": false,
  "warn_pos": false,
  "prevent_rfqs": false,
  "prevent_pos": false,
  "default_currency": "USD",
  "default_price_list": "default_price_list_example",
  "payment_terms": "payment_terms_example",
  "on_hold": false,
  "hold_type": "hold_type_example",
  "release_date": "2024-01-15",
  "website": "website_example",
  "supplier_details": "supplier_details_example",
  "is_frozen": false,
  "allow_purchase_invoice_creation_without_purchase_order": false,
  "allow_purchase_invoice_creation_without_purchase_receipt": false,
  "supplier_primary_contact": "supplier_primary_contact_example",
  "mobile_no": "mobile_no_example",
  "email_id": "user@example.com",
  "primary_address": "primary_address_example",
  "supplier_primary_address": "supplier_primary_address_example",
  "tax_withholding_group": "tax_withholding_group_example",
  "gender": "gender_example"
}
GET /api/buying/supplier

List all suppliers

Returns a list of suppliers. 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 supplier objects.

GET /api/buying/supplier 
curl https://api.overplane.dev/api/buying/supplier \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "supplier_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "supplier_name": "supplier_name_example",
      "country": "country_example",
      "default_bank_account": "default_bank_account_example",
      "tax_id": "tax_id_example",
      "tax_category": "tax_category_example",
      "tax_withholding_category": "tax_withholding_category_example",
      "is_transporter": false,
      "is_internal_supplier": false,
      "represents_company": "Example Corp",
      "image": "image_example",
      "supplier_group": "supplier_group_example",
      "supplier_type": "Company",
      "language": "language_example",
      "disabled": false,
      "warn_rfqs": false,
      "warn_pos": false,
      "prevent_rfqs": false,
      "prevent_pos": false,
      "default_currency": "USD",
      "default_price_list": "default_price_list_example",
      "payment_terms": "payment_terms_example",
      "on_hold": false,
      "hold_type": "hold_type_example",
      "release_date": "2024-01-15",
      "website": "website_example",
      "supplier_details": "supplier_details_example",
      "is_frozen": false,
      "allow_purchase_invoice_creation_without_purchase_order": false,
      "allow_purchase_invoice_creation_without_purchase_receipt": false,
      "supplier_primary_contact": "supplier_primary_contact_example",
      "mobile_no": "mobile_no_example",
      "email_id": "user@example.com",
      "primary_address": "primary_address_example",
      "supplier_primary_address": "supplier_primary_address_example",
      "tax_withholding_group": "tax_withholding_group_example",
      "gender": "gender_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/buying/supplier

Create a supplier

Creates a new supplier object.

Body parameters

supplier_name string required
country string
default_bank_account string
tax_id string
tax_category string
tax_withholding_category string
is_transporter boolean

Default: false

is_internal_supplier boolean

Default: false

represents_company string
image string
supplier_group string
supplier_type string

Default: Company

language string
disabled boolean

Default: false

warn_rfqs boolean

Default: false

warn_pos boolean

Default: false

prevent_rfqs boolean

Default: false

prevent_pos boolean

Default: false

default_currency string
default_price_list string
payment_terms string
on_hold boolean

Default: false

hold_type string
release_date string
website string
supplier_details string
is_frozen boolean

Default: false

allow_purchase_invoice_creation_without_purchase_order boolean

Default: false

allow_purchase_invoice_creation_without_purchase_receipt boolean

Default: false

supplier_primary_contact string
mobile_no string
email_id string
primary_address string
supplier_primary_address string
tax_withholding_group string
gender string

Returns

Returns the newly created supplier object if the call succeeded.

POST /api/buying/supplier 
curl https://api.overplane.dev/api/buying/supplier \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"supplier_name":"supplier_name_example"}'
Response 
{
  "id": "supplier_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "supplier_name": "supplier_name_example",
  "country": "country_example",
  "default_bank_account": "default_bank_account_example",
  "tax_id": "tax_id_example",
  "tax_category": "tax_category_example",
  "tax_withholding_category": "tax_withholding_category_example",
  "is_transporter": false,
  "is_internal_supplier": false,
  "represents_company": "Example Corp",
  "image": "image_example",
  "supplier_group": "supplier_group_example",
  "supplier_type": "Company",
  "language": "language_example",
  "disabled": false,
  "warn_rfqs": false,
  "warn_pos": false,
  "prevent_rfqs": false,
  "prevent_pos": false,
  "default_currency": "USD",
  "default_price_list": "default_price_list_example",
  "payment_terms": "payment_terms_example",
  "on_hold": false,
  "hold_type": "hold_type_example",
  "release_date": "2024-01-15",
  "website": "website_example",
  "supplier_details": "supplier_details_example",
  "is_frozen": false,
  "allow_purchase_invoice_creation_without_purchase_order": false,
  "allow_purchase_invoice_creation_without_purchase_receipt": false,
  "supplier_primary_contact": "supplier_primary_contact_example",
  "mobile_no": "mobile_no_example",
  "email_id": "user@example.com",
  "primary_address": "primary_address_example",
  "supplier_primary_address": "supplier_primary_address_example",
  "tax_withholding_group": "tax_withholding_group_example",
  "gender": "gender_example"
}
PATCH /api/buying/supplier/{id}

Update a supplier

Updates the specified supplier 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 supplier to update.

Body parameters

supplier_name string
country string
default_bank_account string
tax_id string
tax_category string
tax_withholding_category string
is_transporter boolean

Default: false

is_internal_supplier boolean

Default: false

represents_company string
image string
supplier_group string
supplier_type string

Default: Company

language string
disabled boolean

Default: false

warn_rfqs boolean

Default: false

warn_pos boolean

Default: false

prevent_rfqs boolean

Default: false

prevent_pos boolean

Default: false

default_currency string
default_price_list string
payment_terms string
on_hold boolean

Default: false

hold_type string
release_date string
website string
supplier_details string
is_frozen boolean

Default: false

allow_purchase_invoice_creation_without_purchase_order boolean

Default: false

allow_purchase_invoice_creation_without_purchase_receipt boolean

Default: false

supplier_primary_contact string
mobile_no string
email_id string
primary_address string
supplier_primary_address string
tax_withholding_group string
gender string

Returns

Returns the updated supplier object.

PATCH /api/buying/supplier/{id} 
curl https://api.overplane.dev/api/buying/supplier/supplier_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"supplier_name":"supplier_name_example","country":"country_example"}'
Response 
{
  "id": "supplier_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "supplier_name": "supplier_name_example",
  "country": "country_example",
  "default_bank_account": "default_bank_account_example",
  "tax_id": "tax_id_example",
  "tax_category": "tax_category_example",
  "tax_withholding_category": "tax_withholding_category_example",
  "is_transporter": false,
  "is_internal_supplier": false,
  "represents_company": "Example Corp",
  "image": "image_example",
  "supplier_group": "supplier_group_example",
  "supplier_type": "Company",
  "language": "language_example",
  "disabled": false,
  "warn_rfqs": false,
  "warn_pos": false,
  "prevent_rfqs": false,
  "prevent_pos": false,
  "default_currency": "USD",
  "default_price_list": "default_price_list_example",
  "payment_terms": "payment_terms_example",
  "on_hold": false,
  "hold_type": "hold_type_example",
  "release_date": "2024-01-15",
  "website": "website_example",
  "supplier_details": "supplier_details_example",
  "is_frozen": false,
  "allow_purchase_invoice_creation_without_purchase_order": false,
  "allow_purchase_invoice_creation_without_purchase_receipt": false,
  "supplier_primary_contact": "supplier_primary_contact_example",
  "mobile_no": "mobile_no_example",
  "email_id": "user@example.com",
  "primary_address": "primary_address_example",
  "supplier_primary_address": "supplier_primary_address_example",
  "tax_withholding_group": "tax_withholding_group_example",
  "gender": "gender_example"
}
DELETE /api/buying/supplier/{id}

Delete a supplier

Permanently deletes a supplier. This cannot be undone.

Path parameters

id string required

The identifier of the supplier to delete.

Returns

Returns a confirmation that the supplier has been deleted.

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

Line items

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

Customer Number At Supplier

Attributes

idx integer
supplier_id string required
company string
customer_number string

Endpoints

GET /api/buying/customer-number-at-supplier?parent_id={id}
POST /api/buying/customer-number-at-supplier
PATCH /api/buying/customer-number-at-supplier/{id}
DELETE /api/buying/customer-number-at-supplier/{id}
POST /api/buying/customer-number-at-supplier/reorder
Customer Number At Supplier object 
{
  "id": "customer-number-at-supplier_abc123",
  "idx": 1,
  "supplier_id": "supplier_id_example",
  "company": "Example Corp",
  "customer_number": "customer_number_example"
}