Sage Active
Overview API resources
PaymentTerm
BETA
Operation
Type
Object
Dto
Create
Mutation
createPaymentTerm
PaymentTermCreateGLDtoInput
Delete
Mutation
deletePaymentTerm
PaymentTermDeleteGLDtoInput
Read
Query
ById
PaymentTermGLDto
List
Query
paymentTerms
PaymentTermGLDto
Description
Payment terms, 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
Key
Value
Authorization
Bearer Current access Token
X-TenantId
Current tenant id obtained from userProfile
X-OrganizationId
Current organization Id
x-api-key
Primary or secondary subscription key of your app
paymentTerms
Fields
Type
Description
Length
idSSystem field that cannot be assigned
UUID
Id
name *The value of the field or object is mandatory
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 :
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
Fields
Type
Description
idSSystem field that cannot be assigned
UUID
Id
order *The value of the field or object is mandatory
int
classification of lines from 0 to n.
paymentMeanId
UUID
Id of the payment mean
Type
NONE LINEAL PERCENTAGE FIXED_AMOUNT REMAINING_AMOUNT
Type of calculation
value *The value of the field or object is mandatory
decimal
Value
condition
NONE DAY_OF_PAYMENT END_OF_MONTH
To calculate due date
day
int
Number of days
payDays[]
Array
optional due days
Info
order : If REMAINING_AMOUNT
, must always be last with the code 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.