curl --request GET \
--url http:localhost:3000/v2/objects/{objectNumber}/byNumber
{
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"customerId": "<string>",
"name": "<string>",
"contact": {
"phone": "<string>",
"email": "jsmith@example.com",
"fax": "<string>"
},
"contract": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z"
},
"objectManagerId": "<string>",
"material": [
{
"articleId": "<string>",
"budget": 123
}
],
"address": {
"street": "<string>",
"zip": "<string>",
"city": "<string>",
"country": "<string>"
},
"location": {
"latitude": 123,
"longitude": 123
},
"rating": 2.5,
"description": "<string>",
"securityCode": "<any>",
"key": "<any>",
"orderDescription": "<string>",
"contactName": "<string>",
"invoiceRecipientId": "<string>",
"invoiceCCRecipientIds": [
"<string>"
],
"serviceRecipient": "<string>",
"contactIds": [
"<string>"
],
"tags": [
"<string>"
]
}
Retrieve a customer object using its number instead of its MongoDB ID.
curl --request GET \
--url http:localhost:3000/v2/objects/{objectNumber}/byNumber
{
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"customerId": "<string>",
"name": "<string>",
"contact": {
"phone": "<string>",
"email": "jsmith@example.com",
"fax": "<string>"
},
"contract": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z"
},
"objectManagerId": "<string>",
"material": [
{
"articleId": "<string>",
"budget": 123
}
],
"address": {
"street": "<string>",
"zip": "<string>",
"city": "<string>",
"country": "<string>"
},
"location": {
"latitude": 123,
"longitude": 123
},
"rating": 2.5,
"description": "<string>",
"securityCode": "<any>",
"key": "<any>",
"orderDescription": "<string>",
"contactName": "<string>",
"invoiceRecipientId": "<string>",
"invoiceCCRecipientIds": [
"<string>"
],
"serviceRecipient": "<string>",
"contactIds": [
"<string>"
],
"tags": [
"<string>"
]
}
Object number (not MongoDB ID)
Customer object retrieved successfully
A customer object represents a location or building where services are performed Base class for all entities that can have a chat associated with them. Base class for all entities in the system, providing common properties and methods.
Was this page helpful?