Add New Purchase Refund

curl --location -g --request POST 'https://.daftra.com/api2/purchase_refunds' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer ' \ --header 'apikey: ' \ --header 'Content-Type: application/json' \ --data-raw '{ "PurchaseRefund": { "id": 98, "staff_id": 0, "no": "987", "supplier_id": 0, "is_offline": true, "currency_code": "USD", "supplier_business_name": "string", "supplier_first_name": "string", "supplier_last_name": "string", "supplier_email": "user@example.com", "supplier_address1": "string", "supplier_address2": "string", "supplier_postal_code": "string", "supplier_city": "string", "supplier_state": "string", "supplier_country_code": "str", "date": "2019-08-24", "draft": true, "Supplier_active_secondary_address": true, "Supplier_secondary_country_code": "string", "Supplier_secondary_name": "string", "Supplier_secondary_address1": "string", "Supplier_secondary_address2": "string", "Supplier_secondary_city": "string", "Supplier_secondary_state": "string", "Supplier_secondary_postal_code": "string", "is_received": true, "received_date": "2019-10-30 12:59:30" }, "PurchaseOrderItem": [ { "product_id": 0, "org_name": "string", "description": "string", "unit_price": 0, "quantity": 0, "tax1": 0, "tax2": 0, "purchase_order_id": 0, "item": "string", "col_3": null, "col_4": null, "col_5": null, "discount": 0, "discount_type": "1 => Percentage", "store_id": "The Purchase Order store id" } ] }'

Request

Path Params

format

string

required

Header Params

string

optional

Default:

application/json

Content-Type

string

optional

Default:

application/json

Authorization

string

optional

You can generate the bearer token using the the authorization endpoint then use it here to be able to operate over your account's data

Default:

Bearer {{access_token}}

apikey

string

deprecated

You can find/generate your apikey(s) from inside your Daftra Account

Default:

Body Params application/json

PurchaseRefund

object

PurchaseOrderBase

optional

integer <int64>

optional

Unique Identifier

Example:

staff_id

integer <int32>

optional

Staff user submitting the request

string

optional

Purchase invoice user identifier

<= 255 characters

Example:

987

supplier_id

integer <int64>

optional

Supplier REF#, you can get it through the Suppliers API

is_offline

boolean

optional

0 : if it is an online order / 1 : if it is an offline order

currency_code

string

optional

3 Digit currency code following ISO 4217 standard

<= 3 characters

Example:

USD

supplier_business_name

string

optional

Supplier business name

<= 255 characters

supplier_first_name

string

optional

Supplier first name

<= 255 characters

supplier_last_name

string

optional

Supplier last name

<= 255 characters

supplier_email

string <email>

optional

Supplier email

<= 255 characters

supplier_address1

string

optional

Supplier address line 1

<= 255 characters

supplier_address2

string

optional

Supplier address line 2

<= 255 characters

supplier_postal_code

string

optional

Supplier postal code

<= 10 characters

supplier_city

string

optional

Supplier City

<= 100 characters

supplier_state

string

optional

Supplier State

<= 100 characters

supplier_country_code

string

optional

Supplier Country code

<= 3 characters

date

string <date>

optional

Date of the purchase invoice

draft

boolean

optional

1 : if it is only a draft and doesn't affect the stock, 0 : not a draft and will affect the stock

Supplier_active_secondary_address

boolean

optional

Supplier_secondary_country_code

string

optional

Supplier 2 country code

<= 255 characters

Supplier_secondary_name

string

optional

Supplier 2 name

<= 255 characters

Supplier_secondary_address1

string

optional

Supplier 2 address line 1

<= 255 characters

Supplier_secondary_address2

string

optional

Supplier 2 address line 2

<= 255 characters

Supplier_secondary_city

string

optional

Supplier 2 City

<= 255 characters

Supplier_secondary_state

string

optional

Supplier 2 State

<= 255 characters

Supplier_secondary_postal_code

string

optional

Supplier 2 Postal code

<= 255 characters

is_received

boolean

optional

0: the supplies are not received /1 the supplies are received

received_date

string <date-time>

optional

Date for when it was received

Example:

2019-10-30 12:59:30

PurchaseOrderItem

array [object {15}]

optional

product_id

integer <int32>

optional

Product Ref #

org_name

string <>

optional

Name of the category that this item is following

description

string <>

optional

Description of the item

unit_price

number <double>

optional

Unit price of the item

quantity

integer <int32>

optional

Quantity of the item in the order

tax1

number <double>

optional

Tax 1 value applied on this item

tax2

number <double>

optional

Tax 2 value applied on this item

purchase_order_id

integer

optional

Purchase Order Ref #

item

string

optional

Name of the product

col_3

string | null

optional

additional data to be appear in the Purchase Order layout

Default:

null

col_4

string | null

optional

additional data to be appear in the Purchase Order layout

Default:

null

col_5

string | null

optional

additional data to be appear in the Purchase Order layout

Default:

null

discount

number <double>

optional

discount amount

discount_type

enum<integer>

optional

discount type

Allowed values:

1 => Percentage2 => Absolute

store_id

integer <int64>

optional

The store which this item belongs to get it from GET STORE API if it's not set the Purchase Order store is used

Default:

The Purchase Order store id

Example:

Examples

Created

Add New Purchase Refund

Request

Responses