Skip to Main Content
Riverty Docs
    riverty logo Docs

    Upload picture URL for a Receivable

    Path

    POST /v1/clients/{clientId}/receivables/{receivableId}/picturesurl

    Request Parameters

    clientId
    required
    integer
    Your assigned `ClientId`.
    receivableId
    required
    string
    The Receivable Id.

    Request Body

    application/json

    type
    string
    One value must to be assigned [URL, BASE64]
    value
    string
    Base64 encoded file content or URL where the file is accessible
    description
    string
    Textual note about the image
    exposeToCustomer
    boolean
    When true, allowed to expose file content to the customer

    Responses

    • Id
      string
      Id of the stored image
    • type
      required
      string
      The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.
      category
      required
      string
      Enum:
      • BUSINESS_ERROR
      • TECHNICAL_ERROR
      Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: * `BUSINESS_ERROR` - A business error occurred. This request should *not* be retried without modification * `TECHNICAL_ERROR` - A temporary, technical error occurred. the request *should* be retried after a back-off period.
      title
      string
      A short, human-readable summary of the problem.
      message
      string
      A short, human-readable summary of the problem. Identical to `title`.
      reason
      string
      Long optional human-readable summary of the problem.
    • type
      required
      string
      The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.
      category
      required
      string
      Enum:
      • BUSINESS_ERROR
      • TECHNICAL_ERROR
      Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: * `BUSINESS_ERROR` - A business error occurred. This request should *not* be retried without modification * `TECHNICAL_ERROR` - A temporary, technical error occurred. the request *should* be retried after a back-off period.
      title
      string
      A short, human-readable summary of the problem.
      message
      string
      A short, human-readable summary of the problem. Identical to `title`.
      reason
      string
      Long optional human-readable summary of the problem.
    • type
      required
      string
      The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.
      category
      required
      string
      Enum:
      • BUSINESS_ERROR
      • TECHNICAL_ERROR
      Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: * `BUSINESS_ERROR` - A business error occurred. This request should *not* be retried without modification * `TECHNICAL_ERROR` - A temporary, technical error occurred. the request *should* be retried after a back-off period.
      title
      string
      A short, human-readable summary of the problem.
      message
      string
      A short, human-readable summary of the problem. Identical to `title`.
      reason
      string
      Long optional human-readable summary of the problem.
    • type
      required
      string
      The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.
      category
      required
      string
      Enum:
      • BUSINESS_ERROR
      • TECHNICAL_ERROR
      Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: * `BUSINESS_ERROR` - A business error occurred. This request should *not* be retried without modification * `TECHNICAL_ERROR` - A temporary, technical error occurred. the request *should* be retried after a back-off period.
      title
      string
      A short, human-readable summary of the problem.
      message
      string
      A short, human-readable summary of the problem. Identical to `title`.
      reason
      string
      Long optional human-readable summary of the problem.
    • type
      required
      string
      The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.
      category
      required
      string
      Enum:
      • BUSINESS_ERROR
      • TECHNICAL_ERROR
      Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: * `BUSINESS_ERROR` - A business error occurred. This request should *not* be retried without modification * `TECHNICAL_ERROR` - A temporary, technical error occurred. the request *should* be retried after a back-off period.
      title
      string
      A short, human-readable summary of the problem.
      message
      string
      A short, human-readable summary of the problem. Identical to `title`.
      reason
      string
      Long optional human-readable summary of the problem.
      type
      required
      string
      The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.
      category
      required
      string
      Enum:
      • BUSINESS_ERROR
      • TECHNICAL_ERROR
      Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: * `BUSINESS_ERROR` - A business error occurred. This request should *not* be retried without modification * `TECHNICAL_ERROR` - A temporary, technical error occurred. the request *should* be retried after a back-off period.
      title
      string
      A short, human-readable summary of the problem.
      message
      string
      A short, human-readable summary of the problem. Identical to `title`.
      reason
      string
      Long optional human-readable summary of the problem.
      required
      array
      A list of validation failures for the request.
      name
      required
      string
      Name of the field that did not meet validation requirements.
      reason
      required
      string
      The reason that validation of this field failed.
    • type
      required
      string
      The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.
      category
      required
      string
      Enum:
      • BUSINESS_ERROR
      • TECHNICAL_ERROR
      Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: * `BUSINESS_ERROR` - A business error occurred. This request should *not* be retried without modification * `TECHNICAL_ERROR` - A temporary, technical error occurred. the request *should* be retried after a back-off period.
      title
      string
      A short, human-readable summary of the problem.
      message
      string
      A short, human-readable summary of the problem. Identical to `title`.
      reason
      string
      Long optional human-readable summary of the problem.