Get list of outstanding receivables

GET /api-v1/receivable/outstanding

Headers

TARGET-ORGANIZATION-ID integer(int32)

ID of organization, for which the operation must be performed
WEAL-TOKEN string Required

API token (can be retrieved from account settings)

Responses

200

OK
Hide response attributes Show response attributes object
- contactId integer
- contactName string
- periods array[object]
  
  Hide periods attributes Show periods attributes object
  
  data number
  
  endDate string(date-time)
  
  startDate string(date-time)
- total number
400

400 Bad Request
401

401 Unauthorized
403

403 Access Denied
404

404 Not Found
500

500 Internal Server Error

GET /api-v1/receivable/outstanding

curl \
 -X GET http://10.10.10.132/api-v1/receivable/outstanding \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string"

Response examples (200)

[
  {
    "contactId": 42,
    "contactName": "string",
    "periods": [
      {
        "data": 42.0,
        "endDate": "2024-05-04T09:42:00+00:00",
        "startDate": "2024-05-04T09:42:00+00:00"
      }
    ],
    "total": 42.0
  }
]