Get Payment
643 matches
53 actions
Accounting
53 actions
- Create BillPOSTv1.0.0
- Create Credit NotePOSTv1.0.0
- Create CustomerPOSTv1.0.0
- Create InvoicePOSTv1.0.0
- Create Invoice ItemPOSTv1.0.0
- Create Journal EntryPOSTv1.0.0
- Create Ledger AccountPOSTv1.0.0
- Create PaymentPOSTv1.0.0
- Create SupplierPOSTv1.0.0
- Create Tax RatePOSTv1.0.0
- Delete BillDELETEv1.0.0
- Delete Credit NoteDELETEv1.0.0
- Delete CustomerDELETEv1.0.0
- Delete InvoiceDELETEv1.0.0
- Delete Invoice ItemDELETEv1.0.0
- Delete Journal EntryDELETEv1.0.0
- Delete Ledger AccountDELETEv1.0.0
- Delete PaymentDELETEv1.0.0
- Delete SupplierDELETEv1.0.0
- Delete Tax RateDELETEv1.0.0
- Get BalanceSheetGETv1.0.0
- Get BillGETv1.0.0
- Get company infoGETv1.0.0
- Get Credit NoteGETv1.0.0
- Get CustomerGETv1.0.0
- Get InvoiceGETv1.0.0
- Get Invoice ItemGETv1.0.0
- Get Journal EntryGETv1.0.0
- Get Ledger AccountGETv1.0.0
- Get PaymentGETv1.0.0
- Get Profit and LossGETv1.0.0
- Get SupplierGETv1.0.0
- Get Tax RateGETv1.0.0
- List BillsGETv1.0.0
- List Credit NotesGETv1.0.0
- List CustomersGETv1.0.0
- List Invoice ItemsGETv1.0.0
- List InvoicesGETv1.0.0
- List Journal EntriesGETv1.0.0
- List Ledger AccountsGETv1.0.0
- List PaymentsGETv1.0.0
- List SuppliersGETv1.0.0
- List Tax RatesGETv1.0.0
- Update BillPATCHv1.0.0
- Update Credit NotePATCHv1.0.0
- Update CustomerPATCHv1.0.0
- Update InvoicePATCHv1.0.0
- Update Invoice ItemPATCHv1.0.0
- Update Journal EntryPATCHv1.0.0
- Update Ledger AccountPATCHv1.0.0
- Update PaymentPATCHv1.0.0
- Update SupplierPATCHv1.0.0
- Update Tax RatePATCHv1.0.0
Other/Accounting
Get Payment
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
{
"type": "object",
"properties": {
"fields": {
"type": "string"
},
"id": {
"type": "string"
},
"raw": {
"type": "boolean"
},
"x-apideck-app-id": {
"type": "string"
},
"x-apideck-consumer-id": {
"type": "string"
},
"x-apideck-service-id": {
"type": "string"
}
},
"required": [
"id",
"x-apideck-app-id",
"x-apideck-consumer-id"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
- 316
- 317
- 318
- 319
- 320
- 321
- 322
- 323
- 324
- 325
- 326
- 327
- 328
- 329
- 330
- 331
- 332
- 333
- 334
- 335
- 336
- 337
- 338
- 339
- 340
- 341
- 342
- 343
- 344
- 345
- 346
- 347
- 348
- 349
- 350
- 351
- 352
- 353
- 354
- 355
- 356
- 357
- 358
- 359
- 360
- 361
- 362
- 363
- 364
- 365
- 366
- 367
- 368
- 369
- 370
- 371
- 372
- 373
- 374
- 375
- 376
- 377
- 378
- 379
- 380
- 381
- 382
- 383
- 384
- 385
- 386
- 387
- 388
- 389
- 390
- 391
- 392
- 393
- 394
- 395
- 396
- 397
- 398
- 399
- 400
- 401
- 402
- 403
- 404
- 405
- 406
- 407
- 408
- 409
- 410
- 411
- 412
- 413
- 414
- 415
- 416
- 417
- 418
- 419
- 420
- 421
- 422
- 423
- 424
- 425
- 426
- 427
- 428
- 429
- 430
- 431
- 432
- 433
- 434
- 435
- 436
- 437
- 438
- 439
- 440
- 441
- 442
- 443
- 444
- 445
- 446
- 447
- 448
- 449
- 450
- 451
- 452
- 453
- 454
- 455
- 456
- 457
- 458
- 459
- 460
- 461
- 462
- 463
- 464
- 465
- 466
- 467
- 468
- 469
- 470
- 471
- 472
- 473
- 474
- 475
- 476
- 477
- 478
- 479
- 480
- 481
- 482
- 483
- 484
- 485
- 486
- 487
- 488
- 489
- 490
- 491
- 492
- 493
- 494
- 495
- 496
- 497
- 498
- 499
- 500
- 501
- 502
- 503
- 504
- 505
- 506
- 507
- 508
- 509
- 510
- 511
- 512
- 513
- 514
- 515
- 516
- 517
- 518
- 519
- 520
- 521
- 522
- 523
- 524
- 525
- 526
- 527
- 528
- 529
- 530
- 531
- 532
- 533
{
"type": "object",
"required": [
"data",
"operation",
"resource",
"service",
"status",
"status_code"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"total_amount",
"transaction_date"
],
"properties": {
"account": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The code assigned to the account."
},
"id": {
"type": "string",
"description": "The unique identifier for the account."
},
"name": {
"type": "string",
"description": "The name of the account."
},
"nominal_code": {
"type": "string",
"description": "The nominal code of the account."
}
}
},
"accounts_receivable_account_id": {
"type": "string",
"description": "Unique identifier for the account to allocate payment to."
},
"accounts_receivable_account_type": {
"type": "string",
"description": "Type of accounts receivable account."
},
"allocations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "Amount of payment that should be attributed to this allocation. If null, the total_amount will be used."
},
"code": {
"type": "string"
},
"id": {
"type": "string",
"description": "Unique identifier of entity this payment should be attributed to."
},
"type": {
"type": "string",
"description": "Type of entity this payment should be attributed to.",
"enum": [
"invoice",
"order",
"expense",
"credit_memo",
"over_payment",
"pre_payment"
]
}
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The date and time when the object was created."
},
"created_by": {
"type": "string",
"description": "The user who created the object."
},
"currency": {
"type": "string",
"description": "Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).",
"enum": [
"UNKNOWN_CURRENCY",
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOV",
"BRL",
"BSD",
"BTN",
"BWP",
"BYR",
"BZD",
"CAD",
"CDF",
"CHE",
"CHF",
"CHW",
"CLF",
"CLP",
"CNY",
"COP",
"COU",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STD",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRC",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"USS",
"UYI",
"UYU",
"UZS",
"VEF",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XTS",
"XXX",
"YER",
"ZAR",
"ZMK",
"ZMW",
"BTC",
"ETH"
]
},
"currency_rate": {
"type": "number",
"description": "Currency Exchange Rate at the time entity was recorded/generated."
},
"customer": {
"type": "object",
"description": "The customer this entity is linked to.",
"required": [
"id"
],
"properties": {
"company_name": {
"type": "string",
"description": "The company name of the customer."
},
"display_id": {
"type": "string",
"description": "The display ID of the customer."
},
"display_name": {
"type": "string",
"description": "The display name of the customer."
},
"id": {
"type": "string",
"description": "The ID of the customer this entity is linked to."
},
"name": {
"type": "string",
"description": "The name of the customer. Deprecated, use display_name instead."
}
}
},
"display_id": {
"type": "string",
"description": "Payment id to be displayed."
},
"downstream_id": {
"type": "string",
"description": "The third-party API ID of original entity"
},
"id": {
"type": "string",
"description": "Unique identifier representing the entity"
},
"note": {
"type": "string",
"description": "Optional note to be associated with the payment."
},
"payment_method": {
"type": "string",
"description": "Payment method name"
},
"payment_method_id": {
"type": "string",
"description": "Unique identifier for the payment method."
},
"payment_method_reference": {
"type": "string",
"description": "Optional reference message returned by payment method on processing"
},
"reconciled": {
"type": "boolean",
"description": "Payment has been reconciled"
},
"reference": {
"type": "string",
"description": "Optional payment reference message ie: Debit remittance detail."
},
"row_version": {
"type": "string",
"description": "A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object."
},
"status": {
"type": "string",
"description": "Status of payment",
"enum": [
"authorised",
"paid",
"voided",
"deleted"
]
},
"supplier": {
"type": "object",
"description": "The supplier this entity is linked to.",
"required": [
"id"
],
"properties": {
"address": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "Name of city."
},
"contact_name": {
"type": "string"
},
"country": {
"type": "string",
"description": "country code according to ISO 3166-1 alpha-2."
},
"county": {
"type": "string",
"description": "Address field that holds a sublocality, such as a county"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
},
"id": {
"type": "string"
},
"latitude": {
"type": "string"
},
"line1": {
"type": "string",
"description": "Line 1 of the address e.g. number, street, suite, apt #, etc."
},
"line2": {
"type": "string",
"description": "Line 2 of the address"
},
"line3": {
"type": "string",
"description": "Line 3 of the address"
},
"line4": {
"type": "string",
"description": "Line 4 of the address"
},
"longitude": {
"type": "string"
},
"name": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"postal_code": {
"type": "string",
"description": "Zip code or equivalent."
},
"row_version": {
"type": "string",
"description": "A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object."
},
"salutation": {
"type": "string"
},
"state": {
"type": "string",
"description": "Name of state"
},
"street_number": {
"type": "string",
"description": "Street number"
},
"string": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"primary",
"secondary",
"home",
"office",
"shipping",
"billing",
"other"
]
},
"website": {
"type": "string"
}
},
"additionalProperties": false
},
"company_name": {
"type": "string",
"description": "The company name of the supplier."
},
"display_name": {
"type": "string",
"description": "The display name of the supplier."
},
"id": {
"type": "string",
"description": "The ID of the supplier this entity is linked to."
}
}
},
"total_amount": {
"type": "number",
"description": "Amount of payment"
},
"transaction_date": {
"type": "string",
"format": "date-time",
"description": "Date transaction was entered - YYYY:MM::DDThh:mm:ss.sTZD"
},
"type": {
"type": "string",
"description": "Type of payment",
"enum": [
"accounts_receivable",
"accounts_payable",
"accounts_receivable_credit",
"accounts_payable_credit",
"accounts_receivable_overpayment",
"accounts_payable_overpayment",
"accounts_receivable_prepayment",
"accounts_payable_prepayment"
]
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The date and time when the object was last updated."
},
"updated_by": {
"type": "string",
"description": "The user who last updated the object."
}
},
"additionalProperties": false
},
"operation": {
"type": "string",
"description": "Operation performed"
},
"resource": {
"type": "string",
"description": "Unified API resource name"
},
"service": {
"type": "string",
"description": "Apideck ID of service provider"
},
"status": {
"type": "string",
"description": "HTTP Response Status"
},
"status_code": {
"type": "integer",
"description": "HTTP Response Status Code"
}
}
}