Skip to main content
GET
/
api
/
payment-terms
List Payment Terms
curl --request GET \
  --url https://qwoty.app/api/payment-terms \
  --header 'Authorization: <authorization>'
{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Net 30 Days",
      "api_name": "net_30_days",
      "reference": "PT001",
      "is_active": true,
      "id_crm": null,
      "id_erp": null,
      "id_accounting": null,
      "installments": [
        {
          "id": "660e8400-e29b-41d4-a716-446655440001",
          "name": "Full Payment",
          "percentage": 100,
          "term": "net30",
          "custom_text": null,
          "order_number": 1
        }
      ],
      "created_at": "2024-12-21T10:30:00Z",
      "updated_at": "2024-12-21T10:30:00Z"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440002",
      "name": "30% Deposit + 70% on Delivery",
      "api_name": "30_deposit_70_delivery",
      "reference": "PT002",
      "is_active": true,
      "id_crm": "crm_123",
      "id_erp": null,
      "id_accounting": null,
      "installments": [
        {
          "id": "660e8400-e29b-41d4-a716-446655440003",
          "name": "Deposit",
          "percentage": 30,
          "term": "due_now",
          "custom_text": null,
          "order_number": 1
        },
        {
          "id": "660e8400-e29b-41d4-a716-446655440004",
          "name": "Balance",
          "percentage": 70,
          "term": "due_on_receipt",
          "custom_text": null,
          "order_number": 2
        }
      ],
      "created_at": "2024-12-21T11:00:00Z",
      "updated_at": "2024-12-21T11:00:00Z"
    }
  ]
}

​
Authorization

​
Authorization
string
required
Bearer token for authentication. Format: Bearer qwoty_your_token

​
Query Parameters

​
is_active
boolean
Filter by active status. Omit to return all payment terms.
​
search
string
Search by name or api_name

​
Examples

curl https://qwoty.app/api/payment-terms \
  -H "Authorization: Bearer qwoty_your_token"

​
Response

​
success
boolean
Indicates if the request was successful
​
data
array
Array of payment term objects
{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Net 30 Days",
      "api_name": "net_30_days",
      "reference": "PT001",
      "is_active": true,
      "id_crm": null,
      "id_erp": null,
      "id_accounting": null,
      "installments": [
        {
          "id": "660e8400-e29b-41d4-a716-446655440001",
          "name": "Full Payment",
          "percentage": 100,
          "term": "net30",
          "custom_text": null,
          "order_number": 1
        }
      ],
      "created_at": "2024-12-21T10:30:00Z",
      "updated_at": "2024-12-21T10:30:00Z"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440002",
      "name": "30% Deposit + 70% on Delivery",
      "api_name": "30_deposit_70_delivery",
      "reference": "PT002",
      "is_active": true,
      "id_crm": "crm_123",
      "id_erp": null,
      "id_accounting": null,
      "installments": [
        {
          "id": "660e8400-e29b-41d4-a716-446655440003",
          "name": "Deposit",
          "percentage": 30,
          "term": "due_now",
          "custom_text": null,
          "order_number": 1
        },
        {
          "id": "660e8400-e29b-41d4-a716-446655440004",
          "name": "Balance",
          "percentage": 70,
          "term": "due_on_receipt",
          "custom_text": null,
          "order_number": 2
        }
      ],
      "created_at": "2024-12-21T11:00:00Z",
      "updated_at": "2024-12-21T11:00:00Z"
    }
  ]
}

​
Error Responses

{
  "success": false,
  "error": "Invalid API token"
}