POST/v1/definitions/{key}/rows/{rowId}/document-requests

Request documents from a record's contact

Records that a document is owed on one record: documentType (required), an optional note and an optional RFC 3339 dueAt. A second OPEN ask for the same document on the same record is a 409 that NAMES the ask already standing, so the caller can chase or withdraw that one. IT SENDS NOTHING — this writes down the need; asking the merchant for it is the stipulations route.

Access class: def:read.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

keypath · stringrequired

rowIdpath · stringrequired

Request body

application/jsonrequired

bodyoptional

paramsoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "cancelledAt": "string",
    "documentType": "string",
    "dueAt": "string",
    "fulfilledAt": "string",
    "fulfilledBy": 1,
    "fulfilledFileId": "",
    "id": "",
    "note": "string",
    "periods": [
      {
        "label": "string",
        "periodEnd": "string",
        "periodStart": "string"
      }
    ],
    "requestedAt": "string",
    "requestedBy": 1,
    "rowId": "",
    "sentAt": "string",
    "sentMedium": "string",
    "sentMessageId": 1,
    "sentTo": "string",
    "status": "string"
  }
}

dataoptional

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired

curl --request POST \ 'https://neo-app-api-prod-836053680024.us-central1.run.app/v1/definitions/string/rows/{rowId}/document-requests' \ --header 'Content-Type: application/json' \ --data '{ "body": { "documentType": "string", "dueAt": "string", "note": "string" }, "params": { ":key": "string", ":rowId": "" }, "query": {}}'

{ "data": { "cancelledAt": "string", "documentType": "string", "dueAt": "string", "fulfilledAt": "string", "fulfilledBy": 1, "fulfilledFileId": "", "id": "", "note": "string", "periods": [ { "label": "string", "periodEnd": "string", "periodStart": "string" } ], "requestedAt": "string", "requestedBy": 1, "rowId": "", "sentAt": "string", "sentMedium": "string", "sentMessageId": 1, "sentTo": "string", "status": "string" }}