Create Payment Term

curl --request POST \
  --url https://qwoty.app/api/payment-terms \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "api_name": "<string>",
  "reference": "<string>",
  "is_active": true,
  "identifiers": {
    "identifiers.crm": "<string>",
    "identifiers.erp": "<string>",
    "identifiers.accounting": "<string>"
  },
  "installments": [
    {
      "name": "<string>",
      "percentage": 123,
      "term": {},
      "custom_text": "<string>",
      "order_number": 123,
      "is_date_required": true
    }
  ]
}
'

import requests

url = "https://qwoty.app/api/payment-terms"

payload = {
    "name": "<string>",
    "api_name": "<string>",
    "reference": "<string>",
    "is_active": True,
    "identifiers": {
        "identifiers.crm": "<string>",
        "identifiers.erp": "<string>",
        "identifiers.accounting": "<string>"
    },
    "installments": [
        {
            "name": "<string>",
            "percentage": 123,
            "term": {},
            "custom_text": "<string>",
            "order_number": 123,
            "is_date_required": True
        }
    ]
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    api_name: '<string>',
    reference: '<string>',
    is_active: true,
    identifiers: {
      'identifiers.crm': '<string>',
      'identifiers.erp': '<string>',
      'identifiers.accounting': '<string>'
    },
    installments: [
      {
        name: '<string>',
        percentage: 123,
        term: {},
        custom_text: '<string>',
        order_number: 123,
        is_date_required: true
      }
    ]
  })
};

fetch('https://qwoty.app/api/payment-terms', 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://qwoty.app/api/payment-terms",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'api_name' => '<string>',
    'reference' => '<string>',
    'is_active' => true,
    'identifiers' => [
        'identifiers.crm' => '<string>',
        'identifiers.erp' => '<string>',
        'identifiers.accounting' => '<string>'
    ],
    'installments' => [
        [
                'name' => '<string>',
                'percentage' => 123,
                'term' => [
                                
                ],
                'custom_text' => '<string>',
                'order_number' => 123,
                'is_date_required' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "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://qwoty.app/api/payment-terms"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"api_name\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"is_active\": true,\n  \"identifiers\": {\n    \"identifiers.crm\": \"<string>\",\n    \"identifiers.erp\": \"<string>\",\n    \"identifiers.accounting\": \"<string>\"\n  },\n  \"installments\": [\n    {\n      \"name\": \"<string>\",\n      \"percentage\": 123,\n      \"term\": {},\n      \"custom_text\": \"<string>\",\n      \"order_number\": 123,\n      \"is_date_required\": true\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "<authorization>")
	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.post("https://qwoty.app/api/payment-terms")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"api_name\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"is_active\": true,\n  \"identifiers\": {\n    \"identifiers.crm\": \"<string>\",\n    \"identifiers.erp\": \"<string>\",\n    \"identifiers.accounting\": \"<string>\"\n  },\n  \"installments\": [\n    {\n      \"name\": \"<string>\",\n      \"percentage\": 123,\n      \"term\": {},\n      \"custom_text\": \"<string>\",\n      \"order_number\": 123,\n      \"is_date_required\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://qwoty.app/api/payment-terms")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"api_name\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"is_active\": true,\n  \"identifiers\": {\n    \"identifiers.crm\": \"<string>\",\n    \"identifiers.erp\": \"<string>\",\n    \"identifiers.accounting\": \"<string>\"\n  },\n  \"installments\": [\n    {\n      \"name\": \"<string>\",\n      \"percentage\": 123,\n      \"term\": {},\n      \"custom_text\": \"<string>\",\n      \"order_number\": 123,\n      \"is_date_required\": true\n    }\n  ]\n}"

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

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Net 30 Days",
    "api_name": "net_30_days",
    "reference": "PT001",
    "is_active": true,
    "installments": [
      {
        "id": "660e8400-e29b-41d4-a716-446655440001",
        "name": "Full Payment",
        "percentage": 100,
        "term": "net30",
        "order_number": 1,
        "is_date_required": false
      }
    ],
    "created_at": "2024-12-21T10:30:00Z"
  }
}

POST

api

payment-terms

Create Payment Term

curl --request POST \
  --url https://qwoty.app/api/payment-terms \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "api_name": "<string>",
  "reference": "<string>",
  "is_active": true,
  "identifiers": {
    "identifiers.crm": "<string>",
    "identifiers.erp": "<string>",
    "identifiers.accounting": "<string>"
  },
  "installments": [
    {
      "name": "<string>",
      "percentage": 123,
      "term": {},
      "custom_text": "<string>",
      "order_number": 123,
      "is_date_required": true
    }
  ]
}
'

import requests

url = "https://qwoty.app/api/payment-terms"

payload = {
    "name": "<string>",
    "api_name": "<string>",
    "reference": "<string>",
    "is_active": True,
    "identifiers": {
        "identifiers.crm": "<string>",
        "identifiers.erp": "<string>",
        "identifiers.accounting": "<string>"
    },
    "installments": [
        {
            "name": "<string>",
            "percentage": 123,
            "term": {},
            "custom_text": "<string>",
            "order_number": 123,
            "is_date_required": True
        }
    ]
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    api_name: '<string>',
    reference: '<string>',
    is_active: true,
    identifiers: {
      'identifiers.crm': '<string>',
      'identifiers.erp': '<string>',
      'identifiers.accounting': '<string>'
    },
    installments: [
      {
        name: '<string>',
        percentage: 123,
        term: {},
        custom_text: '<string>',
        order_number: 123,
        is_date_required: true
      }
    ]
  })
};

fetch('https://qwoty.app/api/payment-terms', 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://qwoty.app/api/payment-terms",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'api_name' => '<string>',
    'reference' => '<string>',
    'is_active' => true,
    'identifiers' => [
        'identifiers.crm' => '<string>',
        'identifiers.erp' => '<string>',
        'identifiers.accounting' => '<string>'
    ],
    'installments' => [
        [
                'name' => '<string>',
                'percentage' => 123,
                'term' => [
                                
                ],
                'custom_text' => '<string>',
                'order_number' => 123,
                'is_date_required' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "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://qwoty.app/api/payment-terms"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"api_name\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"is_active\": true,\n  \"identifiers\": {\n    \"identifiers.crm\": \"<string>\",\n    \"identifiers.erp\": \"<string>\",\n    \"identifiers.accounting\": \"<string>\"\n  },\n  \"installments\": [\n    {\n      \"name\": \"<string>\",\n      \"percentage\": 123,\n      \"term\": {},\n      \"custom_text\": \"<string>\",\n      \"order_number\": 123,\n      \"is_date_required\": true\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "<authorization>")
	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.post("https://qwoty.app/api/payment-terms")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"api_name\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"is_active\": true,\n  \"identifiers\": {\n    \"identifiers.crm\": \"<string>\",\n    \"identifiers.erp\": \"<string>\",\n    \"identifiers.accounting\": \"<string>\"\n  },\n  \"installments\": [\n    {\n      \"name\": \"<string>\",\n      \"percentage\": 123,\n      \"term\": {},\n      \"custom_text\": \"<string>\",\n      \"order_number\": 123,\n      \"is_date_required\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://qwoty.app/api/payment-terms")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"api_name\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"is_active\": true,\n  \"identifiers\": {\n    \"identifiers.crm\": \"<string>\",\n    \"identifiers.erp\": \"<string>\",\n    \"identifiers.accounting\": \"<string>\"\n  },\n  \"installments\": [\n    {\n      \"name\": \"<string>\",\n      \"percentage\": 123,\n      \"term\": {},\n      \"custom_text\": \"<string>\",\n      \"order_number\": 123,\n      \"is_date_required\": true\n    }\n  ]\n}"

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

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Net 30 Days",
    "api_name": "net_30_days",
    "reference": "PT001",
    "is_active": true,
    "installments": [
      {
        "id": "660e8400-e29b-41d4-a716-446655440001",
        "name": "Full Payment",
        "percentage": 100,
        "term": "net30",
        "order_number": 1,
        "is_date_required": false
      }
    ],
    "created_at": "2024-12-21T10:30:00Z"
  }
}

Authorization

string

required

Bearer token for authentication. Format: Bearer qwoty_your_token

Request Body

string

required

Name of the payment term (max 50 characters)

string

required

Unique API identifier (slug format, e.g., net_30_days)

string

Internal reference code (max 50 characters)

boolean

default:"true"

Whether the payment term is active

object

External system identifiers

Show Identifiers

string

CRM identifier

string

ERP identifier

string

Accounting identifier

array

Array of payment installments. Total percentage must equal 100%.

Show Installment Object

string

Name of the installment

number

required

Percentage of total amount (0-100)

enum

required

Payment term type. Options: due_now, due_on_receipt, net15, net30, net45, net60, net90, net120, eom30, eom45, eom60, po_received, custom

string

Custom text (required if term is custom)

number

required

Display order (1, 2, 3…)

boolean

default:"false"

Whether a due date must be entered on the quote for this installment. Only applies to custom and po_received terms; ignored (stored as false) for other terms.

The sum of all installment percentages must equal exactly 100%.

Examples

curl -X POST https://qwoty.app/api/payment-terms \
  -H "Authorization: Bearer qwoty_your_token" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Net 30 Days",
    "api_name": "net_30_days",
    "reference": "PT001",
    "is_active": true,
    "installments": [
      {
        "name": "Full Payment",
        "percentage": 100,
        "term": "net30",
        "order_number": 1,
        "is_date_required": false
      }
    ]
  }'

curl -X POST https://qwoty.app/api/payment-terms \
  -H "Authorization: Bearer qwoty_your_token" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "30% Deposit + 70% on Delivery",
    "api_name": "30_deposit_70_delivery",
    "reference": "PT002",
    "is_active": true,
    "installments": [
      {
        "name": "Deposit on Order",
        "percentage": 30,
        "term": "due_now",
        "order_number": 1,
        "is_date_required": false
      },
      {
        "name": "Balance on Delivery",
        "percentage": 70,
        "term": "due_on_receipt",
        "order_number": 2,
        "is_date_required": false
      }
    ]
  }'

const response = await fetch('https://qwoty.app/api/payment-terms', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer qwoty_your_token',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Net 30 Days',
    api_name: 'net_30_days',
    is_active: true,
    installments: [
      {
        name: 'Full Payment',
        percentage: 100,
        term: 'net30',
        order_number: 1,
      },
    ],
  }),
})

const data = await response.json()

import requests

response = requests.post(
    'https://qwoty.app/api/payment-terms',
    headers={
        'Authorization': 'Bearer qwoty_your_token',
        'Content-Type': 'application/json'
    },
    json={
        'name': 'Net 30 Days',
        'api_name': 'net_30_days',
        'is_active': True,
        'installments': [
            {
                'name': 'Full Payment',
                'percentage': 100,
                'term': 'net30',
                'order_number': 1
            }
        ]
    }
)

data = response.json()

Response

boolean

Indicates if the request was successful

object

The created payment term object

Show Payment Term Object

string

Unique identifier (UUID)

string

Payment term name

string

API identifier

string

Internal reference

boolean

Active status

array

Array of installment objects with id, name, percentage, term, custom_text, order_number, and is_date_required

string

ISO 8601 timestamp

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Net 30 Days",
    "api_name": "net_30_days",
    "reference": "PT001",
    "is_active": true,
    "installments": [
      {
        "id": "660e8400-e29b-41d4-a716-446655440001",
        "name": "Full Payment",
        "percentage": 100,
        "term": "net30",
        "order_number": 1,
        "is_date_required": false
      }
    ],
    "created_at": "2024-12-21T10:30:00Z"
  }
}

Error Responses

{
  "error": "Installment percentages must sum to 100%"
}

{
  "error": "Payment term with api_name 'net_30_days' already exists"
}

{
  "error": "Invalid or expired token"
}

Last modified on October 28, 2026

Catalogs

Categories

Product Parents

Products

Prices

Payment Terms

Customers

Contacts

Addresses

Quotes

Media

Tokens

Create Payment Term

Authorization

Request Body

Examples

Response

Error Responses

​Authorization

​Request Body

​Examples

​Response

​Error Responses

Authorization

Request Body

Examples

Response

Error Responses