Purchase

A collection of purchases.

createdAt
string <date-time>

The date and time the purchase was created.

currency
string <= 255 characters

The purchase's currency.

custom1
string <= 32000 characters

The value of the purchase's first custom field.

custom2
string <= 32000 characters

The value of the purchase's second custom field.

custom3
string <= 32000 characters

The value of the purchase's third custom field.

custom4
string <= 32000 characters

The value of the purchase's fourth custom field.

custom5
string <= 32000 characters

The value of the purchase's fifth custom field.

custom6
string <= 32000 characters

The value of the purchase's sixth custom field.

custom7
string <= 32000 characters

The value of the purchase's seventh custom field.

custom8
string <= 32000 characters

The value of the purchase's eight custom field.

custom9
string <= 32000 characters

The value of the purchase's ninth custom field.

custom10
string <= 32000 characters

The value of the purchase's 10th custom field.

custom11
string <= 32000 characters

The value of the purchase's 11th custom field.

custom12
string <= 32000 characters

The value of the purchase's 12th custom field.

custom13
string <= 32000 characters

The value of the purchase's 13th custom field.

custom14
string <= 32000 characters

The value of the purchase's 14th custom field.

custom15
string <= 32000 characters

The value of the purchase's 15th custom field.

custom16
string <= 32000 characters

The value of the purchase's 16th custom field.

custom17
string <= 32000 characters

The value of the purchase's 17th custom field.

custom18
string <= 32000 characters

The value of the purchase's 18th custom field.

custom19
string <= 32000 characters

The value of the purchase's 19th custom field.

custom20
string <= 32000 characters

The value of the purchase's 20th custom field.

custom21
string <= 32000 characters

The value of the purchase's 21st custom field.

custom22
string <= 32000 characters

The value of the purchase's 22nd custom field.

custom23
string <= 32000 characters

The value of the purchase's 23rd custom field.

custom24
string <= 32000 characters

The value of the purchase's 24th custom field.

custom25
string <= 32000 characters

The value of the purchase's 25th custom field.

custom26
string <= 32000 characters

The value of the purchase's 26th custom field.

custom27
string <= 32000 characters

The value of the purchase's 27th custom field.

custom28
string <= 32000 characters

The value of the purchase's 28th custom field.

custom29
string <= 32000 characters

The value of the purchase's 29th custom field.

custom30
string <= 32000 characters

The value of the purchase's 30th custom field.

custom31
string <= 32000 characters

The value of the purchase's 31st custom field.

custom32
string <= 32000 characters

The value of the purchase's 32nd custom field.

custom33
string <= 32000 characters

The value of the purchase's 33rd custom field.

custom34
string <= 32000 characters

The value of the purchase's 34th custom field.

custom35
string <= 32000 characters

The value of the purchase's 35th custom field.

custom36
string <= 32000 characters

The value of the purchase's 36th custom field.

custom37
string <= 32000 characters

The value of the purchase's 37th custom field.

custom38
string <= 32000 characters

The value of the purchase's 38th custom field.

custom39
string <= 32000 characters

The value of the purchase's 39th custom field.

custom40
string <= 32000 characters

The value of the purchase's 40th custom field.

custom41
string <= 32000 characters

The value of the purchase's 41st custom field.

custom42
string <= 32000 characters

The value of the purchase's 42nd custom field.

custom43
string <= 32000 characters

The value of the purchase's 43rd custom field.

custom44
string <= 32000 characters

The value of the purchase's 44th custom field.

custom45
string <= 32000 characters

The value of the purchase's 45th custom field.

custom46
string <= 32000 characters

The value of the purchase's 46th custom field.

custom47
string <= 32000 characters

The value of the purchase's 47th custom field.

custom48
string <= 32000 characters

The value of the purchase's 48th custom field.

custom49
string <= 32000 characters

The value of the purchase's 49th custom field.

custom50
string <= 32000 characters

The value of the purchase's 50th custom field.

custom51
string <= 32000 characters

The value of the purchase's 51st custom field.

custom52
string <= 32000 characters

The value of the purchase's 52nd custom field.

custom53
string <= 32000 characters

The value of the purchase's 53rd custom field.

custom54
string <= 32000 characters

The value of the purchase's 54th custom field.

custom55
string <= 32000 characters

The value of the purchase's 55th custom field.

custom56
string <= 32000 characters

The value of the purchase's 56th custom field.

custom57
string <= 32000 characters

The value of the purchase's 57th custom field.

custom58
string <= 32000 characters

The value of the purchase's 58th custom field.

custom59
string <= 32000 characters

The value of the purchase's 59th custom field.

custom60
string <= 32000 characters

The value of the purchase's 60th custom field.

custom61
string <= 32000 characters

The value of the purchase's 61st custom field.

custom62
string <= 32000 characters

The value of the purchase's 62nd custom field.

custom63
string <= 32000 characters

The value of the purchase's 63rd custom field.

custom64
string <= 32000 characters

The value of the purchase's 64th custom field.

custom65
string <= 32000 characters

The value of the purchase's 65th custom field.

custom66
string <= 32000 characters

The value of the purchase's 66th custom field.

custom67
string <= 32000 characters

The value of the purchase's 67th custom field.

custom68
string <= 32000 characters

The value of the purchase's 68th custom field.

custom69
string <= 32000 characters

The value of the purchase's 69th custom field.

custom70
string <= 32000 characters

The value of the purchase's 70th custom field.

custom71
string <= 32000 characters

The value of the purchase's 71st custom field.

custom72
string <= 32000 characters

The value of the purchase's 72nd custom field.

custom73
string <= 32000 characters

The value of the purchase's 73rd custom field.

custom74
string <= 32000 characters

The value of the purchase's 74th custom field.

custom75
string <= 32000 characters

The value of the purchase's 75th custom field.

custom76
string <= 32000 characters

The value of the purchase's 76th custom field.

custom77
string <= 32000 characters

The value of the purchase's 77th custom field.

custom78
string <= 32000 characters

The value of the purchase's 78th custom field.

custom79
string <= 32000 characters

The value of the purchase's 79th custom field.

custom80
string <= 32000 characters

The value of the purchase's 80th custom field.

custom81
string <= 32000 characters

The value of the purchase's 81st custom field.

custom82
string <= 32000 characters

The value of the purchase's 82nd custom field.

custom83
string <= 32000 characters

The value of the purchase's 83rd custom field.

custom84
string <= 32000 characters

The value of the purchase's 84th custom field.

custom85
string <= 32000 characters

The value of the purchase's 85th custom field.

custom86
string <= 32000 characters

The value of the purchase's 86th custom field.

custom87
string <= 32000 characters

The value of the purchase's 87th custom field.

custom88
string <= 32000 characters

The value of the purchase's 88th custom field.

custom89
string <= 32000 characters

The value of the purchase's 89th custom field.

custom90
string <= 32000 characters

The value of the purchase's 90th custom field.

custom91
string <= 32000 characters

The value of the purchase's 91st custom field.

custom92
string <= 32000 characters

The value of the purchase's 92nd custom field.

custom93
string <= 32000 characters

The value of the purchase's 93rd custom field.

custom94
string <= 32000 characters

The value of the purchase's 94th custom field.

custom95
string <= 32000 characters

The value of the purchase's 95th custom field.

custom96
string <= 32000 characters

The value of the purchase's 96th custom field.

custom97
string <= 32000 characters

The value of the purchase's 97th custom field.

custom98
string <= 32000 characters

The value of the purchase's 98th custom field.

custom99
string <= 32000 characters

The value of the purchase's 99th custom field.

custom100
string <= 32000 characters

The value of the purchase's 100th custom field.

custom101
string <= 32000 characters

The value of the purchase's 101st custom field.

custom102
string <= 32000 characters

The value of the purchase's 102nd custom field.

custom103
string <= 32000 characters

The value of the purchase's 103rd custom field.

custom104
string <= 32000 characters

The value of the purchase's 104th custom field.

custom105
string <= 32000 characters

The value of the purchase's 105th custom field.

custom106
string <= 32000 characters

The value of the purchase's 106th custom field.

custom107
string <= 32000 characters

The value of the purchase's 107th custom field.

custom108
string <= 32000 characters

The value of the purchase's 108th custom field.

custom109
string <= 32000 characters

The value of the purchase's 109th custom field.

custom110
string <= 32000 characters

The value of the purchase's 110th custom field.

custom111
string <= 32000 characters

The value of the purchase's 111th custom field.

custom112
string <= 32000 characters

The value of the purchase's 112th custom field.

custom113
string <= 32000 characters

The value of the purchase's 113th custom field.

custom114
string <= 32000 characters

The value of the purchase's 114th custom field.

custom115
string <= 32000 characters

The value of the purchase's 115th custom field.

custom116
string <= 32000 characters

The value of the purchase's 116th custom field.

custom117
string <= 32000 characters

The value of the purchase's 117th custom field.

custom118
string <= 32000 characters

The value of the purchase's 118th custom field.

custom119
string <= 32000 characters

The value of the purchase's 119th custom field.

custom120
string <= 32000 characters

The value of the purchase's 120th custom field.

custom121
string <= 32000 characters

The value of the purchase's 121st custom field.

custom122
string <= 32000 characters

The value of the purchase's 122nd custom field.

custom123
string <= 32000 characters

The value of the purchase's 123rd custom field.

custom124
string <= 32000 characters

The value of the purchase's 124th custom field.

custom125
string <= 32000 characters

The value of the purchase's 125th custom field.

custom126
string <= 32000 characters

The value of the purchase's 126th custom field.

custom127
string <= 32000 characters

The value of the purchase's 127th custom field.

custom128
string <= 32000 characters

The value of the purchase's 128th custom field.

custom129
string <= 32000 characters

The value of the purchase's 129th custom field.

custom130
string <= 32000 characters

The value of the purchase's 130th custom field.

custom131
string <= 32000 characters

The value of the purchase's 131st custom field.

custom132
string <= 32000 characters

The value of the purchase's 132nd custom field.

custom133
string <= 32000 characters

The value of the purchase's 133rd custom field.

custom134
string <= 32000 characters

The value of the purchase's 134th custom field.

custom135
string <= 32000 characters

The value of the purchase's 135th custom field.

custom136
string <= 32000 characters

The value of the purchase's 136th custom field.

custom137
string <= 32000 characters

The value of the purchase's 137th custom field.

custom138
string <= 32000 characters

The value of the purchase's 138th custom field.

custom139
string <= 32000 characters

The value of the purchase's 139th custom field.

custom140
string <= 32000 characters

The value of the purchase's 140th custom field.

custom141
string <= 32000 characters

The value of the purchase's 141st custom field.

custom142
string <= 32000 characters

The value of the purchase's 142nd custom field.

custom143
string <= 32000 characters

The value of the purchase's 143rd custom field.

custom144
string <= 32000 characters

The value of the purchase's 144th custom field.

custom145
string <= 32000 characters

The value of the purchase's 145th custom field.

custom146
string <= 32000 characters

The value of the purchase's 146th custom field.

custom147
string <= 32000 characters

The value of the purchase's 147th custom field.

custom148
string <= 32000 characters

The value of the purchase's 148th custom field.

custom149
string <= 32000 characters

The value of the purchase's 149th custom field.

custom150
string <= 32000 characters

The value of the purchase's 150th custom field.

endDate
string <= 255 characters

The purchase's end date.

potentialQuantity
number <float>

The purchase's potential quantity.

potentialValue
number <float>

The purchase's potential value

saturation
number <float>

The purchase’s saturation.

source
string <= 255 characters

The purchase's source.

startDate
string <= 255 characters

The purchase's start date.

status
boolean

The purchase's status.

totalQuantity
number <float>

The purchase's total quantity.

totalValue
number <float>

The purchase's total value.

updatedAt
string <date-time>

The date and time the purchase was last updated.

{
}

Purchase Relationships

links (object) (account)

The account, purchase is created for

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

The creator of the purchase. Relationship creator cannot be used as a filter.

links (object) (product)

The product, purchase is created for

{
}

⌵ 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
{
}