TAG LINE
SMALL TITLE

Order

(API Version v2)


Represents the linking of an Order which has been created for an Account.


What can you do with Order?


Properties

Property Details
identity
READ-ONLY
"identity": 1
Type: Number
This is the unique numeric identifier for the Order
ownerId
READ-ONLY
"ownerId": 6
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.
accountId
"accountId": 15
Type: Number
Unique identifier for the associated Account object.
accountName
"accountName": "Sample Name"
Type: String
The name of the object associated with the accountId property.
contactId
"contactId": 15
Type: Number
Unique identifier for the associated Contact object.
contactName
"contactName": "Sample Name"
Type: String
The name of the object associated with the contactId property.
invoiceId
"invoiceId": 19
Type: Number
Unique identifier for the associated Invoice object.
invoiceName
"invoiceName": "Sample Name"
Type: String
The name of the object associated with the invoiceId property.
orderStatusTypeId
"orderStatusTypeId": 4
Type: Number
Unique identifier for the associated OrderStatusType object.
orderStatusTypeName
"orderStatusTypeName": "Sample Name"
Type: String
The name of the object associated with the orderStatusTypeId property.
companyName
"companyName": "Acme Co."
Type: String
User defined company name assigned to the Order.
externalIdentifier
"externalIdentifier": "124567-23"
Type: String
User defined identifier to be linked to an external ordering system.
completed
"completed": "2021-04-26T15:25:27.587Z"
Type: Date
Date Time Stamp that represents when the Order was billed.

Date and time values are specified in the ISO 8601 format.
purchaseOrderNumber
"purchaseOrderNumber": "PO123454"
Type: String
User defined PO number to be associated with this Order.
totalAmountEstimate
"totalAmountEstimate": 456.67
Type: Number
Estimate pre-tax and prorated charges.
preAuthTransactionIdentifier
"preAuthTransactionIdentifier": "236958"
Type: String
User defined pre-authorization field for user defined information to be attached to an order.
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.
createdByUserId
"createdByUserId": 22
Type: Number
Unique identifier for the associated User object.
createdByUserName
"createdByUserName": "Sample Name"
Type: String
The name of the object associated with the createdByUserId property.
statusUpdated
"statusUpdated": "2021-04-26T15:25:27.587Z"
Type: Date
Date Time Stamp that represents the last time the orderStatusTypeId was updated.

Date and time values are specified in the ISO 8601 format.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

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:

  • contactId
  • companyName
  • externalIdentifier
  • purchaseOrderNumber
  • totalAmountEstimate
  • preAuthTransactionIdentifier

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the Order object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v2/Order/{id}
Delete an instance of the Order 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 Order object.
Delete an instance of the Order object.
DELETE api/v2/Order/{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": "order"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v2/Order/
Retrieve all of the Order objects.
Retrieve all of the Order objects.
GET api/v2/Order/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 23,
            "ownerName": "Sample Text Data",
            "accountId": 14,
            "accountName": "Sample Text Data",
            "contactId": 7,
            "contactName": "Sample Text Data",
            "invoiceId": 5,
            "invoiceName": "Sample Text Data",
            "orderStatusTypeId": 11,
            "orderStatusTypeName": "Sample Text Data",
            "companyName": "Acme Co.",
            "externalIdentifier": "124567-23",
            "completed": "2021-04-26T15:25:27.587Z",
            "purchaseOrderNumber": "PO123454",
            "totalAmountEstimate": 456.67,
            "preAuthTransactionIdentifier": "236958",
            "created": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 18,
            "createdByUserName": "Sample Text Data",
            "statusUpdated": "2021-04-26T15:25:27.587Z"
        }
    ]
}
GETapi/v2/Order/Paged
Retrieve all of the Order 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 Order objects in a paged fashion.
GET api/v2/Order/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": 14,
                "ownerName": "Sample Text Data",
                "accountId": 13,
                "accountName": "Sample Text Data",
                "contactId": 24,
                "contactName": "Sample Text Data",
                "invoiceId": 13,
                "invoiceName": "Sample Text Data",
                "orderStatusTypeId": 1,
                "orderStatusTypeName": "Sample Text Data",
                "companyName": "Acme Co.",
                "externalIdentifier": "124567-23",
                "completed": "2021-04-26T15:25:27.587Z",
                "purchaseOrderNumber": "PO123454",
                "totalAmountEstimate": 456.67,
                "preAuthTransactionIdentifier": "236958",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 21,
                "createdByUserName": "Sample Text Data",
                "statusUpdated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
GETapi/v2/Order/Paged/Detail
Retrieve all of the Order objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the Order objects in a paged fashion with all object details.
GET api/v2/Order/Paged/Detail
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": 25,
                "ownerName": "Sample Text Data",
                "accountId": 17,
                "accountName": "Sample Text Data",
                "contactId": 13,
                "contactName": "Sample Text Data",
                "invoiceId": 26,
                "invoiceName": "Sample Text Data",
                "orderStatusTypeId": 20,
                "orderStatusTypeName": "Sample Text Data",
                "companyName": "Acme Co.",
                "externalIdentifier": "124567-23",
                "completed": "2021-04-26T15:25:27.587Z",
                "purchaseOrderNumber": "PO123454",
                "totalAmountEstimate": 456.67,
                "preAuthTransactionIdentifier": "236958",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 3,
                "createdByUserName": "Sample Text Data",
                "statusUpdated": "2021-04-26T15:25:27.587Z",
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v2/Order/{id}
Retrieve an instance of the Order object by its ID.
{id}Unique identifier for the Order object.
Retrieve an instance of the Order object by its ID.
GET api/v2/Order/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 3,
        "ownerName": "Sample Text Data",
        "accountId": 10,
        "accountName": "Sample Text Data",
        "contactId": 5,
        "contactName": "Sample Text Data",
        "invoiceId": 15,
        "invoiceName": "Sample Text Data",
        "orderStatusTypeId": 23,
        "orderStatusTypeName": "Sample Text Data",
        "companyName": "Acme Co.",
        "externalIdentifier": "124567-23",
        "completed": "2021-04-26T15:25:27.587Z",
        "purchaseOrderNumber": "PO123454",
        "totalAmountEstimate": 456.67,
        "preAuthTransactionIdentifier": "236958",
        "created": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 23,
        "createdByUserName": "Sample Text Data",
        "statusUpdated": "2021-04-26T15:25:27.587Z"
    }
}
GETapi/v2/Order/{id}/Detail
Retrieve deep detail of the Order object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the Order object.
Retrieve deep detail of the Order object by its ID.
GET api/v2/Order/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 18,
        "ownerName": "Sample Text Data",
        "accountId": 17,
        "accountName": "Sample Text Data",
        "contactId": 18,
        "contactName": "Sample Text Data",
        "invoiceId": 22,
        "invoiceName": "Sample Text Data",
        "orderStatusTypeId": 3,
        "orderStatusTypeName": "Sample Text Data",
        "companyName": "Acme Co.",
        "externalIdentifier": "124567-23",
        "completed": "2021-04-26T15:25:27.587Z",
        "purchaseOrderNumber": "PO123454",
        "totalAmountEstimate": 456.67,
        "preAuthTransactionIdentifier": "236958",
        "created": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 4,
        "createdByUserName": "Sample Text Data",
        "statusUpdated": "2021-04-26T15:25:27.587Z",
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
PATCHapi/v2/Order/{id}
Update or Add the Order object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the Order object.
Update or Add the Order object and optionally make changes to any child objects.
PATCH api/v2/Order/{id}

{
    "details": {},
    "orders": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "accountId": 27,
                "contactId": 16,
                "invoiceId": 0,
                "orderStatusTypeId": 19,
                "companyName": "Acme Co.",
                "externalIdentifier": "124567-23",
                "completed": "2021-04-26T15:25:27.587Z",
                "purchaseOrderNumber": "PO123454",
                "totalAmountEstimate": 456.67,
                "preAuthTransactionIdentifier": "236958",
                "createdByUserId": 24,
                "statusUpdated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "order",
                "instance": {
                    "identity": 1,
                    "ownerId": 15,
                    "ownerName": "Sample Text Data",
                    "accountId": 15,
                    "accountName": "Sample Text Data",
                    "contactId": 13,
                    "contactName": "Sample Text Data",
                    "invoiceId": 13,
                    "invoiceName": "Sample Text Data",
                    "orderStatusTypeId": 6,
                    "orderStatusTypeName": "Sample Text Data",
                    "companyName": "Acme Co.",
                    "externalIdentifier": "124567-23",
                    "completed": "2021-04-26T15:25:27.587Z",
                    "purchaseOrderNumber": "PO123454",
                    "totalAmountEstimate": 456.67,
                    "preAuthTransactionIdentifier": "236958",
                    "created": "2021-04-26T15:25:27.587Z",
                    "createdByUserId": 21,
                    "createdByUserName": "Sample Text Data",
                    "statusUpdated": "2021-04-26T15:25:27.587Z"
                }
            }
        ]
    }
}
POSTapi/v2/Order/
Create a new instance of the Order object.
Create a new instance of the Order object.
POST api/v2/Order/

{
    "accountId": 12,
    "contactId": 23,
    "invoiceId": 10,
    "orderStatusTypeId": 7,
    "companyName": "Acme Co.",
    "externalIdentifier": "124567-23",
    "completed": "2021-04-26T15:25:27.587Z",
    "purchaseOrderNumber": "PO123454",
    "totalAmountEstimate": 456.67,
    "preAuthTransactionIdentifier": "236958",
    "createdByUserId": 1,
    "statusUpdated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 0,
                "ownerName": "Sample Text Data",
                "accountId": 17,
                "accountName": "Sample Text Data",
                "contactId": 0,
                "contactName": "Sample Text Data",
                "invoiceId": 2,
                "invoiceName": "Sample Text Data",
                "orderStatusTypeId": 5,
                "orderStatusTypeName": "Sample Text Data",
                "companyName": "Acme Co.",
                "externalIdentifier": "124567-23",
                "completed": "2021-04-26T15:25:27.587Z",
                "purchaseOrderNumber": "PO123454",
                "totalAmountEstimate": 456.67,
                "preAuthTransactionIdentifier": "236958",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 7,
                "createdByUserName": "Sample Text Data",
                "statusUpdated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
POSTapi/v2/Order/Process
Process an existing draft Order or re-process an existing failed Order. Optionally, the order can be billed immediately via billNow: true. Billing now is required if there are manual charges that need to be included, otherwise they are not billed.
Process an existing draft Order or re-process an existing failed Order.
POST api/v2/Order/Process

{
    "identity": 1234,
    "billNow": true
}
View Sample Response
HTTP/1.1 200 OK
PUTapi/v2/Order/{id}
Update an existing instance of the Order object.
Update an existing instance of the Order object.
PUT api/v2/Order/{id}

{
    "identity": 1,
    "accountId": 18,
    "contactId": 9,
    "invoiceId": 22,
    "orderStatusTypeId": 13,
    "companyName": "Acme Co.",
    "externalIdentifier": "124567-23",
    "completed": "2021-04-26T15:25:27.587Z",
    "purchaseOrderNumber": "PO123454",
    "totalAmountEstimate": 456.67,
    "preAuthTransactionIdentifier": "236958",
    "createdByUserId": 18,
    "statusUpdated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 11,
                "ownerName": "Sample Text Data",
                "accountId": 18,
                "accountName": "Sample Text Data",
                "contactId": 20,
                "contactName": "Sample Text Data",
                "invoiceId": 24,
                "invoiceName": "Sample Text Data",
                "orderStatusTypeId": 6,
                "orderStatusTypeName": "Sample Text Data",
                "companyName": "Acme Co.",
                "externalIdentifier": "124567-23",
                "completed": "2021-04-26T15:25:27.587Z",
                "purchaseOrderNumber": "PO123454",
                "totalAmountEstimate": 456.67,
                "preAuthTransactionIdentifier": "236958",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 5,
                "createdByUserName": "Sample Text Data",
                "statusUpdated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}