List purchase agreements

GET

admin

api

purchases

purchase-agreements

List purchase agreements

curl --request GET \
  --url https://erp.arukz.com/admin/api/v1/purchases/purchase-agreements \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://erp.arukz.com/admin/api/v1/purchases/purchase-agreements"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://erp.arukz.com/admin/api/v1/purchases/purchase-agreements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://erp.arukz.com/admin/api/v1/purchases/purchase-agreements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": [
    {
      "id": null,
      "name": "PA-3683",
      "type": "blanket_order",
      "state": "draft",
      "reference": null,
      "starts_at": null,
      "ends_at": null,
      "description": null,
      "currency_id": 787,
      "partner_id": 1,
      "user_id": null,
      "company_id": 1394,
      "creator_id": 1,
      "created_at": null,
      "updated_at": null,
      "deleted_at": null
    },
    {
      "id": null,
      "name": "PA-5307",
      "type": "blanket_order",
      "state": "draft",
      "reference": null,
      "starts_at": null,
      "ends_at": null,
      "description": null,
      "currency_id": 788,
      "partner_id": 1,
      "user_id": null,
      "company_id": 1395,
      "creator_id": 1,
      "created_at": null,
      "updated_at": null,
      "deleted_at": null
    }
  ],
  "links": {
    "first": "/?page=1",
    "last": "/?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "/?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "/",
    "per_page": 10,
    "to": 2,
    "total": 2
  }
}

{
  "message": "Unauthenticated."
}

Authorizations

Authorization

string

header

required

An API token from Sign in, sent as Authorization: Bearer <token>. Tokens last 30 days.

Query Parameters

include

string

Comma-separated list of relationships to include.

Available options: currency, partner, user, company, creator, lines, lines.requisition, lines.product, lines.uom, lines.company, lines.creator

Example:

"partner,lines"

filter[id]

string

Comma-separated list of IDs to filter by

filter[state]

string

Filter by agreement state

Example:

"draft"

filter[type]

string

Filter by agreement type

Example:

"blanket_order"

filter[partner_id]

string

Filter by vendor IDs

filter[trashed]

string

Filter by trashed status.

Available options: with, only

Example:

"with"

sort

string

required

Sort field

Example:

"-created_at"

page

integer

required

Page number

Example:

1

Response

Success

⌘I

List purchase agreements

curl --request GET \
  --url https://erp.arukz.com/admin/api/v1/purchases/purchase-agreements \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://erp.arukz.com/admin/api/v1/purchases/purchase-agreements"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://erp.arukz.com/admin/api/v1/purchases/purchase-agreements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://erp.arukz.com/admin/api/v1/purchases/purchase-agreements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": [
    {
      "id": null,
      "name": "PA-3683",
      "type": "blanket_order",
      "state": "draft",
      "reference": null,
      "starts_at": null,
      "ends_at": null,
      "description": null,
      "currency_id": 787,
      "partner_id": 1,
      "user_id": null,
      "company_id": 1394,
      "creator_id": 1,
      "created_at": null,
      "updated_at": null,
      "deleted_at": null
    },
    {
      "id": null,
      "name": "PA-5307",
      "type": "blanket_order",
      "state": "draft",
      "reference": null,
      "starts_at": null,
      "ends_at": null,
      "description": null,
      "currency_id": 788,
      "partner_id": 1,
      "user_id": null,
      "company_id": 1395,
      "creator_id": 1,
      "created_at": null,
      "updated_at": null,
      "deleted_at": null
    }
  ],
  "links": {
    "first": "/?page=1",
    "last": "/?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "/?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "/",
    "per_page": 10,
    "to": 2,
    "total": 2
  }
}

{
  "message": "Unauthenticated."
}

Get started

Endpoints

Authorizations

Query Parameters

Response