Create a price agreement

POST/api/v1/price-agreements

Authorization

AuthorizationOAuth2 access token · headerrequired

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

Scopes:api.access

Request body

requiredapplication/json

accountRecordIdstringrequired

min length 1 · max length 255

priceBookIdstringrequired

min length 1 · max length 255

priorityinteger

min 0 · max 1000000 · default: 0

validFromstring<date>required

matches ^(?:(?:\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])))$

validUntilstring<date> | null

default: null

Show properties

Any of:

string<date>

string<date>

null

null

Responses

201

The agreement was created

idstringrequired

min length 1 · max length 255

400

The request body, query or parameters were refused

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

401

The access token is missing, invalid or revoked

errorstringrequired

403

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

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

404

No such record, or none the caller may read

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

409

The operation conflicts with the current state

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

413

The request exceeds the route's body limit

errorstringrequired

500

An unexpected failure

errorstringrequired

Request

curl -X POST '/api/v1/api/v1/price-agreements' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "accountRecordId": "string",
  "priceBookId": "string",
  "priority": 0,
  "validFrom": "2019-08-24",
  "validUntil": null
}'

const response = await fetch("/api/v1/api/v1/price-agreements", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"accountRecordId\": \"string\",\n  \"priceBookId\": \"string\",\n  \"priority\": 0,\n  \"validFrom\": \"2019-08-24\",\n  \"validUntil\": null\n}"
});

import requests

response = requests.post(
    "/api/v1/api/v1/price-agreements",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"accountRecordId\": \"string\",\n  \"priceBookId\": \"string\",\n  \"priority\": 0,\n  \"validFrom\": \"2019-08-24\",\n  \"validUntil\": null\n}",
)

Response

{
  "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"
}