PaymentTerm

Quick Links

Accounts Accounting Entries Products Customers Sales quotes Sales invoices Suppliers Purchase invoices

HTTP Operation Type Object DTO Why-DTOs?
Mutation Why 200? createPaymentTerm PaymentTermCreateGLDtoInput
Mutation Why 200? deletePaymentTerm PaymentTermDeleteGLDtoInput
Query paymentTerms filtered by id Why?  
Query paymentTerms  

Description

Used to define different templates of list of payment terms for a customer or supplier

Example of a template :

  • Advance payment by check 30%
  • 30% by transfer at 30 days net
  • the balance of 40% by bank transfer at 60 days end of month

Within the PaymentTerm, the specific conditions of payment are detailed under paymentTerms/lines.

img

Key Value
Authorization Bearer Current access Token How to find?
X-TenantId Current tenant id How to find?
X-OrganizationId Current organization Id How to find?
x-api-key Primary or secondary subscription key of your app How to find?

paymentTerms

Fields Type Description Length
id UUID Id  
creationDate DateTime Creation Date  
modificationDate DateTime Modification Date  
       
name String Name 50
lines[] Array List of all Payment terms  

paymentTerms/lines

Payment terms, used to define the list of payment terms for PaymentTerm
Example :

Fields Type Description
id UUID Id
creationDate DateTime Creation Date
modificationDate DateTime Modification Date
     
order Int Classification of lines from 0 to n.
paymentMean PaymentMean Fields of PaymentMean
paymentMeanId UUID Id of the payment mean
type
  • NONE
  • PERCENTAGE
  • FIXED_AMOUNT
  • REMAINING_AMOUNT
 Type of calculation for the payment term line
value Decimal Numerical value used based on the type of calculation
condition
  • NONE
  • DAY_OF_PAYMENT
  • END_OF_MONTH
 To calculate due date
day Int Number of days
payDays[] Int Array of Optional due days
Info
  • order : If REMAINING_AMOUNT, must always be last with the value 9999.
  • payDays : Array of optional due days. The day contained in the array closest to the number of days defined in day will be used to calculate the Due Date.
  • type : Defines the method used for payment term calculations. The interpretation of value depends on the selected type:
    • NONE : No specific calculation is applied.
    • PERCENTAGE : value represents a percentage of the total amount.
    • FIXED_AMOUNT : value is a fixed monetary amount.
    • REMAINING_AMOUNT : The remaining balance after all prior calculations. Must always be last in the order.
  • value : Represents the numerical input for the calculation based on type.
    • If type = PERCENTAGE, value should be between 0 and 100, indicating the percentage of the total amount.
    • If type = FIXED_AMOUNT, value is a fixed currency amount (e.g., 500 means a fixed payment of 500).
    • If type = REMAINING_AMOUNT, value is ignored, as the system automatically calculates the remaining balance.
    Examples:
    • If type = PERCENTAGE and value = 30, the payment term will cover 30% of the total amount.
    • If type = FIXED_AMOUNT and value = 500, the payment term will apply a fixed amount of 500.
    • If type = REMAINING_AMOUNT, the system will allocate the remaining balance after all prior lines are processed.
      In this case, order must always be set to 9999