Edit a damage record

curl --request PUT \
  --url https://api.exowpee.com/v1/catalog/inventory-damages/{inventory_damage} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "purchase_id": "<string>",
  "purchase_reception_id": "<string>",
  "reference": "<string>",
  "items": [
    {
      "stockable_id": "<string>",
      "stock_sources": [
        {
          "quantity": 123,
          "asset_id": "<string>",
          "group_id": "<string>"
        }
      ],
      "stockable_unit_id": "<string>"
    }
  ]
}
'

import requests

url = "https://api.exowpee.com/v1/catalog/inventory-damages/{inventory_damage}"

payload = {
    "purchase_id": "<string>",
    "purchase_reception_id": "<string>",
    "reference": "<string>",
    "items": [
        {
            "stockable_id": "<string>",
            "stock_sources": [
                {
                    "quantity": 123,
                    "asset_id": "<string>",
                    "group_id": "<string>"
                }
            ],
            "stockable_unit_id": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    purchase_id: '<string>',
    purchase_reception_id: '<string>',
    reference: '<string>',
    items: [
      {
        stockable_id: '<string>',
        stock_sources: [{quantity: 123, asset_id: '<string>', group_id: '<string>'}],
        stockable_unit_id: '<string>'
      }
    ]
  })
};

fetch('https://api.exowpee.com/v1/catalog/inventory-damages/{inventory_damage}', 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://api.exowpee.com/v1/catalog/inventory-damages/{inventory_damage}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'purchase_id' => '<string>',
    'purchase_reception_id' => '<string>',
    'reference' => '<string>',
    'items' => [
        [
                'stockable_id' => '<string>',
                'stock_sources' => [
                                [
                                                                'quantity' => 123,
                                                                'asset_id' => '<string>',
                                                                'group_id' => '<string>'
                                ]
                ],
                'stockable_unit_id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.exowpee.com/v1/catalog/inventory-damages/{inventory_damage}"

	payload := strings.NewReader("{\n  \"purchase_id\": \"<string>\",\n  \"purchase_reception_id\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"items\": [\n    {\n      \"stockable_id\": \"<string>\",\n      \"stock_sources\": [\n        {\n          \"quantity\": 123,\n          \"asset_id\": \"<string>\",\n          \"group_id\": \"<string>\"\n        }\n      ],\n      \"stockable_unit_id\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.exowpee.com/v1/catalog/inventory-damages/{inventory_damage}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"purchase_id\": \"<string>\",\n  \"purchase_reception_id\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"items\": [\n    {\n      \"stockable_id\": \"<string>\",\n      \"stock_sources\": [\n        {\n          \"quantity\": 123,\n          \"asset_id\": \"<string>\",\n          \"group_id\": \"<string>\"\n        }\n      ],\n      \"stockable_unit_id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.exowpee.com/v1/catalog/inventory-damages/{inventory_damage}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"purchase_id\": \"<string>\",\n  \"purchase_reception_id\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"items\": [\n    {\n      \"stockable_id\": \"<string>\",\n      \"stock_sources\": [\n        {\n          \"quantity\": 123,\n          \"asset_id\": \"<string>\",\n          \"group_id\": \"<string>\"\n        }\n      ],\n      \"stockable_unit_id\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "purchase_id": "<string>",
  "purchase_reception_id": "<string>",
  "reference": "<string>",
  "status": "<string>",
  "damage_reason": "<string>",
  "confirmed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "items": [
    {
      "id": "<string>",
      "inventory_damage_id": "<string>",
      "stockable_id": "<string>",
      "stockable_unit_id": "<string>",
      "quantity": 123,
      "stock_sources": "<array>",
      "cost_total": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "message": "<string>",
  "errors": {}
}

PUT

catalog

inventory-damages

{inventory_damage}

Edit a damage record

curl --request PUT \
  --url https://api.exowpee.com/v1/catalog/inventory-damages/{inventory_damage} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "purchase_id": "<string>",
  "purchase_reception_id": "<string>",
  "reference": "<string>",
  "items": [
    {
      "stockable_id": "<string>",
      "stock_sources": [
        {
          "quantity": 123,
          "asset_id": "<string>",
          "group_id": "<string>"
        }
      ],
      "stockable_unit_id": "<string>"
    }
  ]
}
'

import requests

url = "https://api.exowpee.com/v1/catalog/inventory-damages/{inventory_damage}"

payload = {
    "purchase_id": "<string>",
    "purchase_reception_id": "<string>",
    "reference": "<string>",
    "items": [
        {
            "stockable_id": "<string>",
            "stock_sources": [
                {
                    "quantity": 123,
                    "asset_id": "<string>",
                    "group_id": "<string>"
                }
            ],
            "stockable_unit_id": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    purchase_id: '<string>',
    purchase_reception_id: '<string>',
    reference: '<string>',
    items: [
      {
        stockable_id: '<string>',
        stock_sources: [{quantity: 123, asset_id: '<string>', group_id: '<string>'}],
        stockable_unit_id: '<string>'
      }
    ]
  })
};

fetch('https://api.exowpee.com/v1/catalog/inventory-damages/{inventory_damage}', 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://api.exowpee.com/v1/catalog/inventory-damages/{inventory_damage}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'purchase_id' => '<string>',
    'purchase_reception_id' => '<string>',
    'reference' => '<string>',
    'items' => [
        [
                'stockable_id' => '<string>',
                'stock_sources' => [
                                [
                                                                'quantity' => 123,
                                                                'asset_id' => '<string>',
                                                                'group_id' => '<string>'
                                ]
                ],
                'stockable_unit_id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.exowpee.com/v1/catalog/inventory-damages/{inventory_damage}"

	payload := strings.NewReader("{\n  \"purchase_id\": \"<string>\",\n  \"purchase_reception_id\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"items\": [\n    {\n      \"stockable_id\": \"<string>\",\n      \"stock_sources\": [\n        {\n          \"quantity\": 123,\n          \"asset_id\": \"<string>\",\n          \"group_id\": \"<string>\"\n        }\n      ],\n      \"stockable_unit_id\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.exowpee.com/v1/catalog/inventory-damages/{inventory_damage}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"purchase_id\": \"<string>\",\n  \"purchase_reception_id\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"items\": [\n    {\n      \"stockable_id\": \"<string>\",\n      \"stock_sources\": [\n        {\n          \"quantity\": 123,\n          \"asset_id\": \"<string>\",\n          \"group_id\": \"<string>\"\n        }\n      ],\n      \"stockable_unit_id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.exowpee.com/v1/catalog/inventory-damages/{inventory_damage}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"purchase_id\": \"<string>\",\n  \"purchase_reception_id\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"items\": [\n    {\n      \"stockable_id\": \"<string>\",\n      \"stock_sources\": [\n        {\n          \"quantity\": 123,\n          \"asset_id\": \"<string>\",\n          \"group_id\": \"<string>\"\n        }\n      ],\n      \"stockable_unit_id\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "purchase_id": "<string>",
  "purchase_reception_id": "<string>",
  "reference": "<string>",
  "status": "<string>",
  "damage_reason": "<string>",
  "confirmed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "items": [
    {
      "id": "<string>",
      "inventory_damage_id": "<string>",
      "stockable_id": "<string>",
      "stockable_unit_id": "<string>",
      "quantity": 123,
      "stock_sources": "<array>",
      "cost_total": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "message": "<string>",
  "errors": {}
}

Company space For: Stock keeper, Manager · Permission: inventory_damages.update Conditions

Only a draft record can be changed: a confirmed record is refused (409).
Only reference and damage_reason can be changed; purchase_id, purchase_reception_id and items are refused.
reference, when sent, must stay unique among the damage records of the company.

Part of Correct stock and declare damage.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

inventory_damage

string

required

Identifier of the damage record (27-character KSUID).

Body

application/json

purchase_id

string

Optional purchase the damage relates to, as a 27-character identifier of a purchase of the current company. Accepted on creation only and cannot be sent together with purchase_reception_id. When set, only stock coming from this purchase can be declared.

purchase_reception_id

string

Optional confirmed purchase reception the damage relates to, as a 27-character identifier of a reception of the current company. Accepted on creation only and cannot be sent together with purchase_id. When set, only stock received through it can be declared.

reference

string | null

Optional free reference of the record, up to 255 characters, unique among the company's damage records. Can be changed while the record is a draft.

Maximum string length: 255

damage_reason

enum<string>

Why the stock was damaged: ordinary (expected loss) or exceptional. Required on creation, optional on update.

Available options:

ordinary,

exceptional

items

object[]

Damaged items of the record, at least one. Accepted on creation only; on update use the items endpoints.

Show child attributes

Response

InventoryDamageResource

string

required

Identifier of the damage record (27-character KSUID).

purchase_id

string | null

required

Purchase the damage is tied to; null when the record has no purchase origin.

purchase_reception_id

string | null

required

Purchase reception the damage is tied to; null when the record has no reception origin.

reference

string | null

required

Free reference of the record; null when none was given.

status

string

required

State of the record: draft (editable, no stock moved) or confirmed (stock removed, no more changes).

damage_reason

string

required

Reason of the damage: ordinary or exceptional.

confirmed_at

string<date-time> | null

required

Date and time of confirmation (ISO 8601); null while the record is a draft.

created_at

string<date-time>

required

Date and time the record was created (ISO 8601, UTC).

updated_at

string<date-time>

required

Date and time the record was last changed (ISO 8601, UTC).

items

InventoryDamageItemResource · object[]

Damaged items of the record.

Show child attributes

Platform access and team

Set up your organization and companies

Products, prices and taxes

Stock and logistics

Buy from suppliers

Sell at the counter and on order

Customers, credit and promotions

Keep the books day to day

Follow payments to the bank

Close periods and the fiscal year

Reports, statements and tax filings

Analyze costs and results by activity

Edit a damage record

Authorizations

Path Parameters

Body

Response