Record a purchase cost

POST/api/v1/purchase-costs

認証

AuthorizationOAuth2 アクセストークン · header必須

Authorization-code grant with PKCE. Clients are public and hold no secret. Discovery is published at /.well-known/oauth-authorization-server/api/auth.

スコープ:api.access

ヘッダーパラメーター

Idempotency-Keystring必須

Replays the first answer for a repeated request

最小長 8 · 最大長 128

リクエストボディ

必須application/json

currencystring必須

^[A-Z]{3}$ に一致

productIdstring必須

最小長 1 · 最大長 255

purchasedOnstring<date>必須

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ に一致

referencestring必須

最小長 1 · 最大長 200

supplierRecordIdstring

最小長 1 · 最大長 255

unitCoststring必須

^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致

レスポンス

201

The purchase cost was recorded

idstring必須

最小長 1 · 最大長 255

400

The request body, query or parameters were refused

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

401

The access token is missing, invalid or revoked

errorstring必須

403

The tenant's module is off, or the token's scope or the member's role does not permit the action

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

404

No such record, or none the caller may read

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

409

The operation conflicts with the current state

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

413

The request exceeds the route's body limit

errorstring必須

500

An unexpected failure

errorstring必須

リクエスト

curl -X POST '/api/v1/api/v1/purchase-costs' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Idempotency-Key: stringst' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "currency": "string",
  "productId": "string",
  "purchasedOn": "2019-08-24",
  "reference": "string",
  "supplierRecordId": "string",
  "unitCost": "string"
}'

const response = await fetch("/api/v1/api/v1/purchase-costs", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Idempotency-Key": "stringst",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"currency\": \"string\",\n  \"productId\": \"string\",\n  \"purchasedOn\": \"2019-08-24\",\n  \"reference\": \"string\",\n  \"supplierRecordId\": \"string\",\n  \"unitCost\": \"string\"\n}"
});

import requests

response = requests.post(
    "/api/v1/api/v1/purchase-costs",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Idempotency-Key": "stringst",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"currency\": \"string\",\n  \"productId\": \"string\",\n  \"purchasedOn\": \"2019-08-24\",\n  \"reference\": \"string\",\n  \"supplierRecordId\": \"string\",\n  \"unitCost\": \"string\"\n}",
)

レスポンス

{
  "id": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}