TAG LINE
SMALL TITLE
| id | "id": 23 Type: Number This is the unique numeric identifier for the Payment |
| date | "date": "2005-04-11T14:56:24" Type: Date |
| amount | "amount": 12 Type: Number |
| accountId | "accountId": 11 Type: Number Unique identifier for the associated Account object. |
| disbursed | "disbursed": true Type: Boolean |
| paymentTypeId | "paymentTypeId": 1 Type: Number Unique identifier for the associated PaymentType object. |
| detail | "detail": "Hello World" Type: String |
| cardTypeId | "cardTypeId": 4 Type: Number Unique identifier for the associated CardType object. |
| checkNumber | "checkNumber": "Hello World" Type: String |
| automaticDisburse | "automaticDisburse": true Type: Boolean |
| created | "created": "2005-04-11T14:56:24" Type: Date |
| invoiceId | "invoiceId": 1 Type: Number Unique identifier for the associated Invoice object. |
| posting | "posting": "2005-04-11T14:56:24" Type: Date |
| baseAmount | "baseAmount": 4 Type: Number |
| invoiceAmount | "invoiceAmount": 20 Type: Number |
| currencyExchangeDetailId | "currencyExchangeDetailId": 14 Type: Number Unique identifier for the associated CurrencyExchangeDetail object. |
| billRunHistoryId | "billRunHistoryId": 8 Type: Number Unique identifier for the associated BillRunHistory object. |
| isManual | "isManual": true Type: Boolean |
| reversePaymentId | "reversePaymentId": 4 Type: Number Unique identifier for the associated Payment object. |
| createdByUserId | "createdByUserId": 11 Type: Number Unique identifier for the associated User object. |
| paymentMethodId | "paymentMethodId": 25 Type: Number Unique identifier for the associated PaymentMethod object. |
| paymentPreAuthorizeId | "paymentPreAuthorizeId": 7 Type: Number Unique identifier for the associated PaymentPreAuthorize object. |
| paymentTransactionId | "paymentTransactionId": 27 Type: Number Unique identifier for the associated PaymentTransaction object. |
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:
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 Payment object.
Standard PATCH objects:
DataFlow PATCH objects:
| DELETE | api/v2/Payment/{id:int} |
| Delete an instance of the Payment object. | |
| GET | api/v2/Payment |
| Retrieve all of the Payment objects. | |
| GET | api/v2/Payment/Paged |
| Retreive all of the Payment objects in a paged fashion. | |
| GET | api/v2/Payment/Paged/Detail |
| Retreive all of the Payment objects in a paged fashion with all object details. | |
| GET | api/v2/Payment/{id:int} |
| Retrieve an instance of the Payment object by it's ID. | |
| {id:int} | Unique identifier for the Payment object. |
| GET | api/v2/Payment/{id:int}/Detail |
| Retreive all of the Detail objects for the specified Payment. | |
| {id:int} | Unique identifier for the Payment object. |
| PATCH | api/v2/Payment/{id:int} |
| Update the Payment object and optionally make changes to any child objects. | |
| POST | api/v2/Payment |
| Create a new instance of the Payment object. | |
| POST | api/v2/Payment |
| Create a new instance of the Payment object. | |
| POST | api/v2/Payment/Reverse |
| Create a new instance of the Payment object. | |
| PUT | api/v2/Payment/{id:int} |
| Update an existing instance of the Payment object. | |