Payment / Term

(API Version v8)

Specfies how many days that a customer has to pay an invoice. For example Net30.

What can you do with PaymentTerm?

DELETE Payment/Term/{id}
Delete an instance of the PaymentTerm object.
GET Payment/Term/
Retrieve all of the PaymentTerm objects.
GET Payment/Term/Paged
Retrieve all of the PaymentTerm objects in a paged fashion.
GET Payment/Term/{id}
Retrieve an instance of the PaymentTerm object by its ID.
POST Payment/Term/
Create a new instance of the PaymentTerm object.
PUT Payment/Term/{id}
Update an existing instance of the PaymentTerm object.

Properties

Property Details

identity READ-ONLY	"identity": 9 Type: Number This is the unique numeric identifier for the PaymentTerm
ownerId READ-ONLY	"ownerId": 13 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": "Net30" Type: String User defined name for the Payment Term.
paymentTermTypeId	"paymentTermTypeId": 5 Type: Number Unique identifier for the associated PaymentTermType object.
paymentTermTypeName	"paymentTermTypeName": "Sample Name" Type: String The name of the object associated with the paymentTermTypeId property.
value	"value": 0 Type: Number Number of days

End Points

DELETE	Payment/Term/{id}
Delete an instance of the PaymentTerm object. Upon successful delete, this API will return a record of all of the related 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 PaymentTerm object.
Delete an instance of the PaymentTerm object. DELETE Payment/Term/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "delete", "results": { "totalCount": 4, "items": [ { "identity": 1, "action": "deleted", "dtoTypeKey": "paymentTerm" }, { "lhsId": 2, "rhsId": 2, "action": "detached", "dtoTypeKey": "sampleObjectConnector" }, { "foreignKeyIdentity": 2, "action": "deleted", "dtoTypeKey": "sampleObject" } ] } }

Retrieve all of the PaymentTerm objects.

GET Payment/Term/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 10,
            "ownerName": "Sample Text Data",
            "name": "Net30",
            "paymentTermTypeId": 19,
            "paymentTermTypeName": "Sample Text Data",
            "value": 11
        }
    ]
}

Retrieve all of the PaymentTerm 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 PaymentTerm objects in a paged fashion.

GET Payment/Term/Paged

View Sample Response

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": 16,
                "ownerName": "Sample Text Data",
                "name": "Net30",
                "paymentTermTypeId": 2,
                "paymentTermTypeName": "Sample Text Data",
                "value": 2
            }
        ]
    }
}

GET	Payment/Term/{id}
Retrieve an instance of the PaymentTerm object by its ID.
{id}	Unique identifier for the PaymentTerm object.
Retrieve an instance of the PaymentTerm object by its ID. GET Payment/Term/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "ownerId": 10, "ownerName": "Sample Text Data", "name": "Net30", "paymentTermTypeId": 3, "paymentTermTypeName": "Sample Text Data", "value": 18 } }

Create a new instance of the PaymentTerm object.

POST Payment/Term/

{
    "name": "Net30",
    "paymentTermTypeId": 5,
    "value": 19
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 25,
                "ownerName": "Sample Text Data",
                "name": "Net30",
                "paymentTermTypeId": 11,
                "paymentTermTypeName": "Sample Text Data",
                "value": 0
            }
        ]
    }
}

Update an existing instance of the PaymentTerm object.

PUT Payment/Term/{id}

{
    "identity": 1,
    "name": "Net30",
    "paymentTermTypeId": 5,
    "value": 0
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 6,
                "ownerName": "Sample Text Data",
                "name": "Net30",
                "paymentTermTypeId": 21,
                "paymentTermTypeName": "Sample Text Data",
                "value": 10
            }
        ]
    }
}