Purchases

Server

Purchases

This section deals with requests for getting a list of business purchases or specific purchases, getting a list of business purchase items, sending a purchase to eTIMS and creating eTIMS business purchases.

Get specific purchase

GET

https://api-dev.slade360edi.com/erp

/api/etims/purchases/{id}

Description

This endpoint retrieves the details of a specific purchase identified by the unique ID in the URL.

Parameters

Path parameter

id: this is the id of the etims purchase

Get specific purchase › path Parameters

id

integer · int32 · required · style: simple

etims purchase id

Example: 227

Get specific purchase › Headers

Accept

string · required · style: simple

Returns response in json format

Example: application/json

Get specific purchase › Responses

200

No data returned

Get list of business purchases from etims

GET

https://api-dev.slade360edi.com/erp

/api/etims/purchases

Description

This endpoint retrieves a list of purchases from the eTims.

Get list of business purchases from etims › Headers

Accept

string · required · style: simple

Get list of business purchases from etims › Responses

200

No data returned

Get a list of business purchase items from eTIMS

GET

https://api-dev.slade360edi.com/erp

/api/etims/purchasesitems

Description

The endpoint retrieves a list of purchase items from the eTIMS system.

Optional query parameters allow filtering results.

Get a list of business purchase items from eTIMS › query Parameters

purchase_invoice

integer

Filter purchase items by purchase invoice ID

Example: 261

Get a list of business purchase items from eTIMS › Headers

Accept

string · required · style: simple

Returns response in JSON format

Example: application/json

Get a list of business purchase items from eTIMS › Responses

200

No data returned

Map a purchase item to a product

PATCH

https://api-dev.slade360edi.com/erp

/api/etims/purchasesitems/{purchase_item_id}

Description

Links (maps) a specific ETIMS purchase item to an existing product. .

Parameters

Path parameter

id (integer): The ID of the ETIMS purchase item to be linked.

Header parameter

X-Workstation (string): The workstation ID from which the request is made. Required for audit and tracking.

Body parameter

product (string, UUID): The unique identifier of the product you want to link to the purchase item.

Example

Code
PATCH /api/etims/purchasesitems/404/
X-Workstation: POS-01
Content-Type: application/json

{
  "product": "fd4b9ecd-5f0a-4f9a-8edb-6eab66494782"
}

Map a purchase item to a product › path Parameters

purchase_item_id

integer · required

ID of the ETIMS purchase item to map

Example: 404

Map a purchase item to a product › Headers

X-Workstation

string · required

[REQUIRED] Workstation ID from which the mapping is performed

Example: POS-01

Map a purchase item to a product › Request Body

product

string · uuid · required

The UUID of the product to map to the purchase item

Example: fd4b9ecd-5f0a-4f9a-8edb-6eab66494782

Map a purchase item to a product › Responses

Mapping successful. Returns the updated purchase item details.

id

integer

is_mapped

boolean

product_name

string

product_code

string

item_sequence_number

integer

item_code

string

item_classification_code

string

item_name

string

barcode

string | null

package_unit_code

string

package

string

quantity_unit_code

string

quantity

number

unit_price

number

supply_amount

number

discount_rate

number

discount_amount

number

taxation_type_code

string

taxable_amount

number

tax_amount

number

total_amount

number

purchase_invoice

integer

organisation

string · uuid

branch

string · uuid

product

string · uuid

PATCH/api/etims/purchasesitems/{purchase_item_id}

curl https://api-dev.slade360edi.com/erp/api/etims/purchasesitems/:purchase_item_id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'X-Workstation: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "product": "fd4b9ecd-5f0a-4f9a-8edb-6eab66494782"
}'

Example Request Body

{
  "product": "fd4b9ecd-5f0a-4f9a-8edb-6eab66494782"
}

json

Example Responses

{
  "id": 404,
  "is_mapped": true,
  "product_name": "CLOBEDERM",
  "product_code": "KE2AMU0000172",
  "item_sequence_number": 2,
  "item_code": "AX2BRXBLL0000001",
  "item_classification_code": "70171600",
  "item_name": "Water Sanitizer",
  "barcode": null,
  "package_unit_code": "BR",
  "package": "0.00",
  "quantity_unit_code": "BLL",
  "quantity": 5,
  "unit_price": 100,
  "supply_amount": 500,
  "discount_rate": 0,
  "discount_amount": 0,
  "taxation_type_code": "C",
  "taxable_amount": 500,
  "tax_amount": 0,
  "total_amount": 500,
  "purchase_invoice": 261,
  "organisation": "18d2cb54-b4dd-4b2c-baad-13df951bfed9",
  "branch": "c685d3f7-08f6-40ec-b343-c31323a6fcd2",
  "product": "fd4b9ecd-5f0a-4f9a-8edb-6eab66494782"
}

json

application/json

Send purchase to eTIMS

POST

https://api-dev.slade360edi.com/erp

/api/etims/purchases/{id}/send_to_etims

Description

Sends a specific ETIMS purchase to the ETIMS system, allowing you to trigger either processing or cancellation of the transaction.

Parameters

Path parameter

id (integer): The ID of the ETIMS purchase invoice to be sent.

Header parameters

X-Workstation (string): The workstation ID from which the request is made. Required for audit and tracking.
Accept (string): Specifies the response format. Use application/json.

Body parameter

purchase_transaction_status (string): The action to perform. Must be either:
- PROCESS – to process and send the purchase to ETIMS.
- CANCELLED – to cancel the purchase transaction in ETIMS.

Example

Code
POST /api/etims/purchases/397/send_to_etims
Accept: application/json
Content-Type: application/json

{
  "purchase_transaction_status": "PROCESS"
}

# or

{
  "purchase_transaction_status": "CANCELLED"
}

Send purchase to eTIMS › path Parameters

id

integer · int32 · required

(Required) A unique identifier for the ETIMS purchase invoice.

Example: 397

Send purchase to eTIMS › Headers

X-Workstation

string · required

[REQUIRED] Workstation ID

Example: POS-01

Accept

string · required

Response format. Use application/json.

Example: application/json

Send purchase to eTIMS › Request Body

purchase_transaction_status

string · enum · required

The action to perform: PROCESS to send the purchase, or CANCELLED to cancel it.

Enum values:

PROCESS

CANCELLED

Send purchase to eTIMS › Responses

Request successful.

No data returned

Sales Item

Get specific purchase

GET

https://api-dev.slade360edi.com/erp

/api/etims/purchases/{id}

Description

This endpoint retrieves the details of a specific purchase identified by the unique ID in the URL.

Parameters

Path parameter

id: this is the id of the etims purchase

Get specific purchase › path Parameters

id

integer · int32 · required · style: simple

etims purchase id

Example: 227

Get specific purchase › Headers

Accept

string · required · style: simple

Returns response in json format

Example: application/json

Get specific purchase › Responses

200

No data returned

Get list of business purchases from etims

GET

https://api-dev.slade360edi.com/erp

/api/etims/purchases

Description

This endpoint retrieves a list of purchases from the eTims.

Get list of business purchases from etims › Headers

Accept

string · required · style: simple

Get list of business purchases from etims › Responses

200

No data returned

Get a list of business purchase items from eTIMS

GET

https://api-dev.slade360edi.com/erp

/api/etims/purchasesitems

Description

The endpoint retrieves a list of purchase items from the eTIMS system.

Optional query parameters allow filtering results.

Get a list of business purchase items from eTIMS › query Parameters

purchase_invoice

integer

Filter purchase items by purchase invoice ID

Example: 261

Get a list of business purchase items from eTIMS › Headers

Accept

string · required · style: simple

Returns response in JSON format

Example: application/json

Get a list of business purchase items from eTIMS › Responses

200

No data returned

Map a purchase item to a product

PATCH

https://api-dev.slade360edi.com/erp

/api/etims/purchasesitems/{purchase_item_id}

Description

Links (maps) a specific ETIMS purchase item to an existing product. .

Parameters

Path parameter

id (integer): The ID of the ETIMS purchase item to be linked.

Header parameter

X-Workstation (string): The workstation ID from which the request is made. Required for audit and tracking.

Body parameter

product (string, UUID): The unique identifier of the product you want to link to the purchase item.

Example

Code
PATCH /api/etims/purchasesitems/404/
X-Workstation: POS-01
Content-Type: application/json

{
  "product": "fd4b9ecd-5f0a-4f9a-8edb-6eab66494782"
}

Map a purchase item to a product › path Parameters

purchase_item_id

integer · required

ID of the ETIMS purchase item to map

Example: 404

Map a purchase item to a product › Headers

X-Workstation

string · required

[REQUIRED] Workstation ID from which the mapping is performed

Example: POS-01

Map a purchase item to a product › Request Body

product

string · uuid · required

The UUID of the product to map to the purchase item

Example: fd4b9ecd-5f0a-4f9a-8edb-6eab66494782

Map a purchase item to a product › Responses

Mapping successful. Returns the updated purchase item details.

id

integer

is_mapped

boolean

product_name

string

product_code

string

item_sequence_number

integer

item_code

string

item_classification_code

string

item_name

string

barcode

string | null

package_unit_code

string

package

string

quantity_unit_code

string

quantity

number

unit_price

number

supply_amount

number

discount_rate

number

discount_amount

number

taxation_type_code

string

taxable_amount

number

tax_amount

number

total_amount

number

purchase_invoice

integer

organisation

string · uuid

branch

string · uuid

product

string · uuid

Send purchase to eTIMS

POST

https://api-dev.slade360edi.com/erp

/api/etims/purchases/{id}/send_to_etims

Description

Sends a specific ETIMS purchase to the ETIMS system, allowing you to trigger either processing or cancellation of the transaction.

Parameters

Path parameter

id (integer): The ID of the ETIMS purchase invoice to be sent.

Header parameters

X-Workstation (string): The workstation ID from which the request is made. Required for audit and tracking.
Accept (string): Specifies the response format. Use application/json.

Body parameter

purchase_transaction_status (string): The action to perform. Must be either:
- PROCESS – to process and send the purchase to ETIMS.
- CANCELLED – to cancel the purchase transaction in ETIMS.

Example

Code
POST /api/etims/purchases/397/send_to_etims
Accept: application/json
Content-Type: application/json

{
  "purchase_transaction_status": "PROCESS"
}

# or

{
  "purchase_transaction_status": "CANCELLED"
}

Send purchase to eTIMS › path Parameters

id

integer · int32 · required

(Required) A unique identifier for the ETIMS purchase invoice.

Example: 397

Send purchase to eTIMS › Headers

X-Workstation

string · required

[REQUIRED] Workstation ID

Example: POS-01

Accept

string · required

Response format. Use application/json.

Example: application/json

Send purchase to eTIMS › Request Body

purchase_transaction_status

string · enum · required

The action to perform: PROCESS to send the purchase, or CANCELLED to cancel it.

Enum values:

PROCESS

CANCELLED

Send purchase to eTIMS › Responses

Request successful.

No data returned