Read
GET {{baseUrl}}/crm/v3/objects/commerce_payments/:commercePaymentId?properties=<string>&properties=<string>&propertiesWithHistory=<string>&propertiesWithHistory=<string>&associations=<string>&associations=<string>&archived=false&idProperty=<string>
Read a payment identified by its ID. Include an optional properties query parameter to control the properties that are returned.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
properties | string | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested payment, they will be ignored. | |
properties | string | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested payment, they will be ignored. | |
propertiesWithHistory | string | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested payment, they will be ignored. | |
propertiesWithHistory | string | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested payment, they will be ignored. | |
associations | string | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | |
associations | string | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | |
archived | boolean | Whether to return only results that have been archived. | |
idProperty | string | The name of a property whose values are unique for this object type. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"createdAt":"\u003cdateTime\u003e","id":"\u003cstring\u003e","properties":{"commodo_2":"\u003cstring\u003e"},"updatedAt":"\u003cdateTime\u003e","associations":{"esse8":{"results":[{"id":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"paging":{"next":{"after":"\u003cstring\u003e","link":"\u003cstring\u003e"},"prev":{"before":"\u003cstring\u003e","link":"\u003cstring\u003e"}}},"eiusmod_3":{"results":[{"id":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"paging":{"next":{"after":"\u003cstring\u003e","link":"\u003cstring\u003e"},"prev":{"before":"\u003cstring\u003e","link":"\u003cstring\u003e"}}}},"archived":"\u003cboolean\u003e","archivedAt":"\u003cdateTime\u003e","propertiesWithHistory":{"dolor_fe":[{"sourceType":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","value":"\u003cstring\u003e","sourceId":"\u003cstring\u003e","sourceLabel":"\u003cstring\u003e","updatedByUserId":"\u003cinteger\u003e"},{"sourceType":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","value":"\u003cstring\u003e","sourceId":"\u003cstring\u003e","sourceLabel":"\u003cstring\u003e","updatedByUserId":"\u003cinteger\u003e"}],"Ut_c21":[{"sourceType":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","value":"\u003cstring\u003e","sourceId":"\u003cstring\u003e","sourceLabel":"\u003cstring\u003e","updatedByUserId":"\u003cinteger\u003e"},{"sourceType":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","value":"\u003cstring\u003e","sourceId":"\u003cstring\u003e","sourceLabel":"\u003cstring\u003e","updatedByUserId":"\u003cinteger\u003e"}],"sed82":[{"sourceType":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","value":"\u003cstring\u003e","sourceId":"\u003cstring\u003e","sourceLabel":"\u003cstring\u003e","updatedByUserId":"\u003cinteger\u003e"},{"sourceType":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","value":"\u003cstring\u003e","sourceId":"\u003cstring\u003e","sourceLabel":"\u003cstring\u003e","updatedByUserId":"\u003cinteger\u003e"}]}}