PaymentTerms

The latest version of the Cin7 Core API (V2) is available, with more advanced functionality and support for recent system changes. See the full API documentation to get started.

The PaymentTerms resource allows payment terms to be listed and viewed. Here are some examples URIs:

· /PaymentTerms - returns all payment terms;

· /PaymentTerms?isActive=true - returns payment terms having same IsActive flag value;

· /PaymentTerms?isDefault=true - returns payment terms having same IsDefault flag value;

· /PaymentTerms?name=ABC - returns payment terms with name starting with ABC;

The full range of URIs and HTTP Verbs supported are:

Operation HTTP Action
List of payment terms GET /PaymentTerms
Get payment term GET /PaymentTerms/{id}

These filters can be used with the GET PaymentTermsendpoint:

Filter Description
name Only return payment terms with name starts with the specific name
isActive Only return payment terms having same isActive flag value
isDefault Only return payment terms having same isDefault flag value

Filters are used by adding the filter and value to the URI: /PaymentTerms?name=ABC

Available Fields for Payment term:

Property Type Length Required Notes
Id Guid Required for PUT, Ignored for POST operations
Name String 50 Yes Payment term name
Duration int Yes Duration in days. Not applicable for LASTMONTHDAY method (ignored in this case)
Method string 50 Yes Term Method. See list of valid values below
IsActive Boolean Flag indicates if Payment Term is active
IsDefault Boolean Flag indicates if Payment Term is default

Valid Payment Term Methods Values:

Value Description
DAYS Number of days
MONTHDAY Day of next month
LASTMONTHDAY Last day of next month

Was this article helpful?

Have more questions? Submit a request