Purchase

Contains all the list of products which are related to the accounts.

createdAt
string <date-time>

The date and time the task was created.

currency
string <= 255 characters

It tells you what type of currency we are using to purchase

custom1
string

The value of the purchases first custom field.

custom2
string

The value of the purchases second custom field.

custom3
string

The value of the purchases third custom field.

custom4
string

The value of the purchases fourth custom field.

custom5
string

The value of the purchases fifth custom field.

custom6
string

The value of the purchases sixth custom field.

custom7
string

The value of the purchases seventh custom field.

custom8
string

The value of the purchases eight custom field.

custom9
string

The value of the purchases ninth custom field.

custom10
string

The value of the purchases 10th custom field.

custom11
string

The value of the purchases 11th custom field.

custom12
string

The value of the purchases 12th custom field.

custom13
string

The value of the purchases 13th custom field.

custom14
string

The value of the purchases 14th custom field.

custom15
string

The value of the purchases 15th custom field.

custom16
string

The value of the purchases 16th custom field.

custom17
string

The value of the purchases 17th custom field.

custom18
string

The value of the purchases 18th custom field.

custom19
string

The value of the purchases 19th custom field.

custom20
string

The value of the purchases 20th custom field.

custom21
string

The value of the purchases 21st custom field.

custom22
string

The value of the purchases 22nd custom field.

custom23
string

The value of the purchases 23rd custom field.

custom24
string

The value of the purchases 24th custom field.

custom25
string

The value of the purchases 25th custom field.

custom26
string

The value of the purchases 26th custom field.

custom27
string

The value of the purchases 27th custom field.

custom28
string

The value of the purchases 28th custom field.

custom29
string

The value of the purchases 29th custom field.

custom30
string

The value of the purchases 30th custom field.

custom31
string

The value of the purchases 31st custom field.

custom32
string

The value of the purchases 32nd custom field.

custom33
string

The value of the purchases 33rd custom field.

custom34
string

The value of the purchases 34th custom field.

custom35
string

The value of the purchases 35th custom field.

custom36
string

The value of the purchases 36th custom field.

custom37
string

The value of the purchases 37th custom field.

custom38
string

The value of the purchases 38th custom field.

custom39
string

The value of the purchases 39th custom field.

custom40
string

The value of the purchases 40th custom field.

custom41
string

The value of the purchases 41st custom field.

custom42
string

The value of the purchases 42nd custom field.

custom43
string

The value of the purchases 43rd custom field.

custom44
string

The value of the purchases 44th custom field.

custom45
string

The value of the purchases 45th custom field.

custom46
string

The value of the purchases 46th custom field.

custom47
string

The value of the purchases 47th custom field.

custom48
string

The value of the purchases 48th custom field.

custom49
string

The value of the purchases 49th custom field.

custom50
string

The value of the purchases 50th custom field.

custom51
string

The value of the purchases 51st custom field.

custom52
string

The value of the purchases 52nd custom field.

custom53
string

The value of the purchases 53rd custom field.

custom54
string

The value of the purchases 54th custom field.

custom55
string

The value of the purchases 55th custom field.

custom56
string

The value of the purchases 56th custom field.

custom57
string

The value of the purchases 57th custom field.

custom58
string

The value of the purchases 58th custom field.

custom59
string

The value of the purchases 59th custom field.

custom60
string

The value of the purchases 60th custom field.

custom61
string

The value of the purchases 61st custom field.

custom62
string

The value of the purchases 62nd custom field.

custom63
string

The value of the purchases 63rd custom field.

custom64
string

The value of the purchases 64th custom field.

custom65
string

The value of the purchases 65th custom field.

custom66
string

The value of the purchases 66th custom field.

custom67
string

The value of the purchases 67th custom field.

custom68
string

The value of the purchases 68th custom field.

custom69
string

The value of the purchases 69th custom field.

custom70
string

The value of the purchases 70th custom field.

custom71
string

The value of the purchases 71st custom field.

custom72
string

The value of the purchases 72nd custom field.

custom73
string

The value of the purchases 73rd custom field.

custom74
string

The value of the purchases 74th custom field.

custom75
string

The value of the purchases 75th custom field.

custom76
string

The value of the purchases 76th custom field.

custom77
string

The value of the purchases 77th custom field.

custom78
string

The value of the purchases 78th custom field.

custom79
string

The value of the purchases 79th custom field.

custom80
string

The value of the purchases 80th custom field.

custom81
string

The value of the purchases 81st custom field.

custom82
string

The value of the purchases 82nd custom field.

custom83
string

The value of the purchases 83rd custom field.

custom84
string

The value of the purchases 84th custom field.

custom85
string

The value of the purchases 85th custom field.

custom86
string

The value of the purchases 86th custom field.

custom87
string

The value of the purchases 87th custom field.

custom88
string

The value of the purchases 88th custom field.

custom89
string

The value of the purchases 89th custom field.

custom90
string

The value of the purchases 90th custom field.

custom91
string

The value of the purchases 91st custom field.

custom92
string

The value of the purchases 92nd custom field.

custom93
string

The value of the purchases 93rd custom field.

custom94
string

The value of the purchases 94th custom field.

custom95
string

The value of the purchases 95th custom field.

custom96
string

The value of the purchases 96th custom field.

custom97
string

The value of the purchases 97th custom field.

custom98
string

The value of the purchases 98th custom field.

custom99
string

The value of the purchases 99th custom field.

custom100
string

The value of the purchases 100th custom field.

custom101
string

The value of the purchases 101st custom field.

custom102
string

The value of the purchases 102nd custom field.

custom103
string

The value of the purchases 103rd custom field.

custom104
string

The value of the purchases 104th custom field.

custom105
string

The value of the purchases 105th custom field.

custom106
string

The value of the purchases 106th custom field.

custom107
string

The value of the purchases 107th custom field.

custom108
string

The value of the purchases 108th custom field.

custom109
string

The value of the purchases 109th custom field.

custom110
string

The value of the purchases 110th custom field.

custom111
string

The value of the purchases 111th custom field.

custom112
string

The value of the purchases 112th custom field.

custom113
string

The value of the purchases 113th custom field.

custom114
string

The value of the purchases 114th custom field.

custom115
string

The value of the purchases 115th custom field.

custom116
string

The value of the purchases 116th custom field.

custom117
string

The value of the purchases 117th custom field.

custom118
string

The value of the purchases 118th custom field.

custom119
string

The value of the purchases 119th custom field.

custom120
string

The value of the purchases 120th custom field.

custom121
string

The value of the purchases 121st custom field.

custom122
string

The value of the purchases 122nd custom field.

custom123
string

The value of the purchases 123rd custom field.

custom124
string

The value of the purchases 124th custom field.

custom125
string

The value of the purchases 125th custom field.

custom126
string

The value of the purchases 126th custom field.

custom127
string

The value of the purchases 127th custom field.

custom128
string

The value of the purchases 128th custom field.

custom129
string

The value of the purchases 129th custom field.

custom130
string

The value of the purchases 130th custom field.

custom131
string

The value of the purchases 131st custom field.

custom132
string

The value of the purchases 132nd custom field.

custom133
string

The value of the purchases 133rd custom field.

custom134
string

The value of the purchases 134th custom field.

custom135
string

The value of the purchases 135th custom field.

custom136
string

The value of the purchases 136th custom field.

custom137
string

The value of the purchases 137th custom field.

custom138
string

The value of the purchases 138th custom field.

custom139
string

The value of the purchases 139th custom field.

custom140
string

The value of the purchases 140th custom field.

custom141
string

The value of the purchases 141st custom field.

custom142
string

The value of the purchases 142nd custom field.

custom143
string

The value of the purchases 143rd custom field.

custom144
string

The value of the purchases 144th custom field.

custom145
string

The value of the purchases 145th custom field.

custom146
string

The value of the purchases 146th custom field.

custom147
string

The value of the purchases 147th custom field.

custom148
string

The value of the purchases 148th custom field.

custom149
string

The value of the purchases 149th custom field.

custom150
string

The value of the purchases 150th custom field.

endDate
string <date>

End Date of Contract.

potentialQuantity
number <float>

Net Potential within an Account.

potentialValue
number <float>

Net Potential Revenue within an Account.

saturation
number <float>

Contract seat as a % of potential.

source
string <= 255 characters

It tells how the purchase record was populated. Either is it manual or some API or some other source

startDate
string <date>

Start Date of Contract.

status
boolean

A boolean value whether the product is active or not.

totalQuantity
number <float>

Net Contracted Quantity (Always less than or equal to the potential)

totalValue
number <float>

Net Current Revenue Sold.

updatedAt
string <date-time>

The date and time the task was last updated.

{
}

Purchase Relationships

data (object) or links (object) (account)

The associated account. You can use only the attribute id to filter purcahses by account id (e.g. filter[account][id]=X).

(user (data (object) or links (object)))

The creator of this task.

data (object) or links (object) (user)

The owner of the purchase. You can use only the attribute id to filter purchases by owner (e.g. filter[owner][id]=X).

data (object) or links (object) (product)

The associated product. You can use only the attribute id to filter purcahses by product id (e.g. filter[product][id]=X).

(user (data (object) or links (object)))
{
}

Purchase Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta
dataConnections The set of connections a given Purchase has to external sources. provideDataConnections

⌵ Purchase Actions

Get a Collection of Purchases

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/purchases
Request samples 
Response samples 
application/vnd.api+json
{
}
Create a New Purchase
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/purchases
Request samples 
application/vnd.api+json
{
}
Response samples 
application/vnd.api+json
{
}
Delete an Existing Purchase by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/purchases/{id}
Request samples 
Response samples 
application/vnd.api+json
{
}
Get a Purchase by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/purchases/{id}
Request samples 
Response samples 
application/vnd.api+json
{
}
Update a Purchase
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/purchases/{id}
Request samples 
application/vnd.api+json
{
}
Response samples 
application/vnd.api+json
{
}