TAG LINE
SMALL TITLE
This entity is assigned to an Account to determine which payment terms and dunning rules should apply.
identity READ-ONLY | "identity": 23 Type: Number This is the unique numeric identifier for the AccountsReceivableTerms |
ownerId READ-ONLY | "ownerId": 16 Type: Number Unique identifier for the associated Owner object. |
ownerName READ-ONLY | "ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property. |
name | "name": "Net 30" Type: String User defined name given to the Terms. |
paymentTermId | "paymentTermId": 9 Type: Number Unique identifier for the associated PaymentTerm object. |
paymentTermName | "paymentTermName": "Sample Name" Type: String The name of the object associated with the paymentTermId property. |
paymentDunningRuleId | "paymentDunningRuleId": 1 Type: Number Unique identifier for the associated PaymentDunningRule object. |
paymentDunningRuleName | "paymentDunningRuleName": "Sample Name" Type: String The name of the object associated with the paymentDunningRuleId property. |
paymentRetryRuleId | "paymentRetryRuleId": 26 Type: Number Unique identifier for the associated PaymentRetryRule object. |
paymentRetryRuleName | "paymentRetryRuleName": "Sample Name" Type: String The name of the object associated with the paymentRetryRuleId property. |
isDefault | "isDefault": true Type: Boolean Whether or not this Term is considered the default one used on data entry. |
When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.
Field List:
| DELETE | api/v3/AccountsReceivable/Terms/{id} |
| Delete an instance of the AccountsReceivableTerms object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the AccountsReceivableTerms object. |
Delete an instance of the AccountsReceivableTerms object. DELETE api/v3/AccountsReceivable/Terms/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "accountsReceivableTerms"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | api/v3/AccountsReceivable/Terms/ |
| Retrieve all of the AccountsReceivableTerms objects. | |
Retrieve all of the AccountsReceivableTerms objects. GET api/v3/AccountsReceivable/Terms/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 6,
"ownerName": "Sample Text Data",
"name": "Net 30",
"paymentTermId": 16,
"paymentTermName": "Sample Text Data",
"paymentDunningRuleId": 20,
"paymentDunningRuleName": "Sample Text Data",
"paymentRetryRuleId": 1,
"paymentRetryRuleName": "Sample Text Data",
"isDefault": true
}
]
} | |
| GET | api/v3/AccountsReceivable/Terms/Paged |
| Retrieve all of the AccountsReceivableTerms objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the AccountsReceivableTerms objects in a paged fashion. GET api/v3/AccountsReceivable/Terms/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 4,
"ownerName": "Sample Text Data",
"name": "Net 30",
"paymentTermId": 0,
"paymentTermName": "Sample Text Data",
"paymentDunningRuleId": 7,
"paymentDunningRuleName": "Sample Text Data",
"paymentRetryRuleId": 24,
"paymentRetryRuleName": "Sample Text Data",
"isDefault": true
}
]
}
} | |
| GET | api/v3/AccountsReceivable/Terms/{id} |
| Retrieve an instance of the AccountsReceivableTerms object by its ID. | |
| {id} | Unique identifier for the AccountsReceivableTerms object. |
Retrieve an instance of the AccountsReceivableTerms object by its ID. GET api/v3/AccountsReceivable/Terms/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 0,
"ownerName": "Sample Text Data",
"name": "Net 30",
"paymentTermId": 12,
"paymentTermName": "Sample Text Data",
"paymentDunningRuleId": 0,
"paymentDunningRuleName": "Sample Text Data",
"paymentRetryRuleId": 5,
"paymentRetryRuleName": "Sample Text Data",
"isDefault": true
}
} | |
| POST | api/v3/AccountsReceivable/Terms/ |
| Create a new instance of the AccountsReceivableTerms object. | |
Create a new instance of the AccountsReceivableTerms object. POST api/v3/AccountsReceivable/Terms/
{
"name": "Net 30",
"paymentTermId": 12,
"paymentDunningRuleId": 4,
"paymentRetryRuleId": 21,
"isDefault": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 14,
"ownerName": "Sample Text Data",
"name": "Net 30",
"paymentTermId": 23,
"paymentTermName": "Sample Text Data",
"paymentDunningRuleId": 26,
"paymentDunningRuleName": "Sample Text Data",
"paymentRetryRuleId": 22,
"paymentRetryRuleName": "Sample Text Data",
"isDefault": true
}
]
}
} | |
| PUT | api/v3/AccountsReceivable/Terms/{id} |
| Update an existing instance of the AccountsReceivableTerms object. | |
Update an existing instance of the AccountsReceivableTerms object. PUT api/v3/AccountsReceivable/Terms/{id}
{
"identity": 1,
"name": "Net 30",
"paymentTermId": 11,
"paymentDunningRuleId": 1,
"paymentRetryRuleId": 12,
"isDefault": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 26,
"ownerName": "Sample Text Data",
"name": "Net 30",
"paymentTermId": 23,
"paymentTermName": "Sample Text Data",
"paymentDunningRuleId": 21,
"paymentDunningRuleName": "Sample Text Data",
"paymentRetryRuleId": 7,
"paymentRetryRuleName": "Sample Text Data",
"isDefault": true
}
]
}
} | |