Skip to content
Pitch2SaleDevelopers
Open the app
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

Update the default payment terms

PUT
/api/v1/org/payment-terms
curl --request PUT \
  --url https://api.pitch2sale.com/api/v1/org/payment-terms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "presets": [ { "_id": "example", "key": "example", "label": "example", "days": 1, "is_default": true } ], "early_discount": { "enabled": true, "percentage": 1, "within_days": 1 }, "late_fee": { "enabled": true, "type": "percentage", "value": 1, "grace_days": 1, "max_fee_percent": 1 } }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
presets
Array<object>
>= 1 items <= 20 items
object
_id
string
/^[0-9a-fA-F]{24}$/
key
required
string
>= 1 characters <= 50 characters
label
required
string
>= 1 characters <= 100 characters
days
required
integer
<= 365
is_default
required
boolean
early_discount
object
enabled
required
boolean
percentage
required
number
<= 100
within_days
required
integer
>= 1 <= 365
late_fee
object
enabled
required
boolean
type
required
string
Allowed values: percentage fixed
value
required
number
grace_days
required
integer
<= 365
max_fee_percent
required
number
<= 100

Responses

Section titled “Responses”

200

Section titled “200”

OK

400

Section titled “400”

Validation failed

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Section titled “401”

Authentication required or token invalid

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Section titled “403”

Role permission or token scope missing

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Section titled “429”

Rate limit exceeded

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}