Daftra API
DocsAll EndpointsDaftra Partners
DocsAll EndpointsDaftra Partners
  1. Suppliers
  • Welcome
  • Getting Started
  • Authorization
  • All Endpoints
    • Auth
      • Generate Access Token
    • Invoices
      • GET All Invoices
      • GET Single Invoice
      • Edit Invoices
      • Delete Invoices
      • Add New Invoice
    • Estimates
      • GET All Estimates
      • GET Single Estimate
      • Edit Estimates
      • Delete Estimates
      • Add New Estimate
    • Credit Notes
      • GET All Credit Notes
      • GET Single Credit Note
      • Edit Credit Notes
      • Delete Credit Notes
      • Add New Credit Note
    • Refund Receipts
      • GET All Refund Receipts
      • GET Single Refund Receipt
      • Edit Refund Receipts
      • Delete Refund Receipts
      • Add New Refund Receipt
    • Clients
      • GET All Clients
      • GET Single Client
      • Edit Clients
      • Delete Clients
      • Add New Client
    • Suppliers
      • GET All Suppliers
        GET
      • GET Single Supplier
        GET
      • Edit Suppliers
        PUT
      • Delete Suppliers
        DELETE
      • Add New Supplier
        POST
    • Work Orders
      • GET Single Work Order
      • Edit Work Orders
      • Delete Work Orders
      • GET All Work Orders
      • Add New Work Order
    • Client Appointments
      • GET All Client Appointments
      • GET Single Client Appointment
      • Edit Client Appointments
      • Delete Client Appointments
      • Add New Client Appointment
    • Invoice Appointments
      • GET All Invoice Appointments
      • GET Single Invoice Appointment
      • Edit Invoice Appointments
      • Delete Invoice Appointments
      • Add New Invoice Appointment
    • Estimate Appointments
      • GET All Estimate Appointments
      • GET Single Estimate Appointment
      • Edit Estimate Appointments
      • Delete Estimate Appointments
      • Add New Estimate Appointment
    • Work Order Appointments
      • GET All Work Order Appointments
      • GET Single Work Order Appointment
      • Edit Work Order Appointments
      • Delete Work Order Appointments
      • Add New Work Order Appointment
    • Notes
      • GET All Notes
      • GET Single Note
      • Edit Notes
      • Delete Notes
      • Add New Note
    • Time Tracking
      • GET All Time Tracking
      • GET Single Time Tracking
      • Edit Time Tracking
      • Delete Time Tracking
      • Add New Time Tracking
    • Invoice Payments
      • GET All Invoice Payments
      • GET Single Invoice Payment
      • Edit Invoice Payments
      • Delete Invoice Payments
      • Add New Invoice Payment
    • Client Payments
      • GET All Client Payments
      • GET Single Client Payment
      • Edit Client Payments
      • Delete Client Payments
      • Add New Client Payment
    • Products
      • GET All Products
      • GET Single Product
      • Edit Products
      • Delete Products
      • Add New Product
    • Journals
      • GET All Journals
      • GET Single Journal
      • Edit Journals
      • Delete Journals
      • Add New Journal
    • Journal Accounts
      • GET All Journal Accounts
      • GET Single Journal Account
      • Edit Journal Accounts
      • Delete Journal Accounts
      • Add New Journal Account
    • Journal Cats
      • GET All Journal Cats
      • GET Single Journal Cat
      • Edit Journal Cats
      • Delete Journal Cats
      • Add New Journal Cat
    • Expenses
      • GET All Expenses
      • GET Single Expens
      • Edit Expenses
      • Delete Expenses
      • Add New Expens
    • Incomes
      • GET All Incomes
      • GET Single Income
      • Edit Incomes
      • Delete Incomes
      • Add New Income
    • Taxes
      • GET All Taxes
      • GET Single Taxe
      • Edit Taxes
      • Delete Taxes
      • Add New Taxe
    • Purchase Invoices
      • GET All Purchase Invoices
      • GET Single Purchase Invoice
      • Edit Purchase Invoices
      • Delete Purchase Invoices
      • Add New Purchase Invoice
    • Purchase Refunds
      • GET All Purchase Refunds
      • GET Single Purchase Refund
      • Edit Purchase Refunds
      • Delete Purchase Refunds
      • Add New Purchase Refund
    • Stock Transactions
      • GET All Stock Transactions
      • GET Single Stock Transaction
      • Edit Stock Transactions
      • Delete Stock Transactions
      • Add New Stock Transaction
    • Stores
      • GET All Stores
      • GET Single Store
      • Edit Stores
      • Delete Stores
      • Add New Store
    • Treasuries
      • GET All Treasuries
      • GET Single Treasury
      • Edit Treasuries
      • Delete Treasuries
      • Add New Treasury
    • Product Categories
      • GET All Product Categories
      • GET Single Product Category
    • Staff
      • GET All Staff
      • GET Single Staff
    • Client-attendance-log
      • Add New Client-attendance-log
    • Follow Up Actions
      • GET All Follow Up Actions
      • GET Single Follow Up Action
      • Delete Follow Up Action
    • Follow Up Statuses
      • GET All Follow Up Statuses
      • GET Single Follow Up Status
      • Delete Follow Up Status
    • General Listing
      • GET General Listing
    • Site
      • GET Site Info
  1. Suppliers

Add New Supplier

Production
https://{{subdomain}}.daftra.com/api2
Production
https://{{subdomain}}.daftra.com/api2
POST
https://{{subdomain}}.daftra.com/api2
/suppliers{format}
Suppliers
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://.daftra.com/api2/suppliers' \
--header 'Accept: application/json' \
--header 'apikey: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Supplier": {
        "is_offline": true,
        "supplier_number": 0,
        "staff_id": 0,
        "business_name": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "string",
        "password": "string",
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "string",
        "postal_code": "string",
        "phone1": "string",
        "phone2": "string",
        "country_code": "str",
        "notes": "string",
        "active_secondary_address": true,
        "secondary_name": "string",
        "secondary_address1": "string",
        "secondary_address2": "string",
        "secondary_city": "string",
        "secondary_state": "string",
        "secondary_postal_code": "string",
        "secondary_country_code": "string",
        "language_code": "string",
        "default_currency_code": "strin",
        "follow_up_status": null,
        "bn1": "string",
        "bn1_label": "string",
        "bn2_label": "string",
        "bn2": "string"
    }
}'
Response Response Example
202 - Example 1
{
    "code": 202,
    "result": "successful",
    "id": "2415"
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
format
string 
required
Header Params
Accept
string 
optional
Default:
application/json
Content-Type
string 
optional
Default:
application/json
apikey
string 
deprecated
You can find/generate your apikey(s) from inside your Daftra Account
Default:
{{apikey}}
Body Params application/json
Supplier
object 
SupplierBase
optional
is_offline
boolean 
optional
!! 0 / 1 indicates if the supplier is offline
supplier_number
integer <int32>
required
Visual identifier for the supplier
staff_id
integer <int64>
optional
Staff ID who created the supplier get it from GET STAFF API if it's 0 that means the site owner is the staff that created it
Default:
0
Example:
0
business_name
string 
optional
Supplier's business name
<= 100 characters
first_name
string 
required
Supplier's first name
<= 255 characters
last_name
string 
required
Supplier's last name
<= 255 characters
email
string 
required
Supplier's email
<= 255 characters
password
string 
write-onlyrequired
Supplier's password
<= 255 characters
address1
string 
optional
Supplier's Address line 1
<= 255 characters
address2
string 
optional
Supplier's Address line 2
<= 255 characters
city
string 
optional
Supplier's City
<= 100 characters
state
string 
optional
Supplier's State
<= 100 characters
postal_code
string 
optional
Supplier's postal code
<= 20 characters
phone1
string 
optional
Supplier's phone number
<= 50 characters
phone2
string 
optional
Supplier's mobile number
<= 50 characters
country_code
string 
optional
Supplier's country ISO "ALPHA-2" Code
<= 3 characters
notes
string 
optional
Notes for the supplier
active_secondary_address
boolean 
optional
0/1 if the secondary data is active.
secondary_name
string 
optional
Supplier's name
<= 255 characters
secondary_address1
string 
optional
Supplier's address line 1
<= 255 characters
secondary_address2
string 
optional
Supplier's address line 2
<= 255 characters
secondary_city
string 
optional
Supplier's City
<= 100 characters
secondary_state
string 
optional
Supplier's State
<= 100 characters
secondary_postal_code
string 
optional
Supplier's postal code
<= 50 characters
secondary_country_code
string 
optional
Supplier's country ISO "ALPHA-2" Code
<= 10 characters
language_code
string 
optional
default language code get it from GET General Listing by sending languageCodes as Model
default_currency_code
string 
optional
3 Digit currency code following ISO 4217 standard
<= 5 characters
follow_up_status
integer  | null 
optional
Follow Up Status get it from GET Follow up statuses with model supplier
Default:
null
bn1
string 
optional
value for the bn1
bn1_label
string 
optional
label for the bn1 depends on the country like Tax ID number OR Business number
bn2_label
string 
optional
label for the bn2 depends on the country like Tax ID number OR Business number
bn2
string 
optional
value for the bn2
Examples

Responses

🟢202Accepted
application/json
Created
Body
code
integer 
optional
Example:
202
result
string 
optional
Example:
successful
id
integer 
optional
Example:
2415
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
Previous
Delete Suppliers
Next
GET Single Work Order