Skip to Main Content
Riverty Docs
    riverty logo Docs

    Post Receivables

    Create a new recievable for which an invoice should be created.

    Path

    POST /v1/clients/{clientId}/receivables

    Request Parameters

    clientId
    required
    integer
    Your assigned `ClientId`.

    Request Body

    application/json

    object
    externalInvoiceNumber
    string
    Unique number that identifies an invoice. Auto-generated if not given.
    direct
    boolean
    true = invoices should be created asap, currently the only supported option
    customerDataDeferred
    boolean
    If true, invoicing process will be suspended until payer details are provided (Contract Parking case)
    addConfiguredFee
    boolean
    array
    externalReference
    string
    merchant's own reference
    actualStart
    string
    Accepted formats example: 1985-04-12T23:02:50 or 1985-04-12T23:02:50Z or 1985-04-12T23:02:50-04:00
    actualEnd
    string
    Accepted formats example: 1985-04-12T23:02:50 or 1985-04-12T23:02:50Z or 1985-04-12T23:02:50-04:00
    array
    currently supports only one credential
    type
    string
    object
    id
    string
    license plate of the car
    country
    string
    ISO 3166-1 alpha-2 country code of the car
    object
    id
    string
    parking space
    array
    languageCode
    required
    string
    ISO language code
    value
    required
    string
    text in language code
    object
    id of current receivable owner
    id
    string
    array
    actualStart
    string
    Accepted formats example: 1985-04-12T23:02:50 or 1985-04-12T23:02:50Z or 1985-04-12T23:02:50-04:00
    actualEnd
    string
    Accepted formats example: 1985-04-12T23:02:50 or 1985-04-12T23:02:50Z or 1985-04-12T23:02:50-04:00
    object
    id
    string
    array
    languageCode
    required
    string
    ISO language code
    value
    required
    string
    text in language code
    zoneName
    string
    zoneCode
    string
    FacilityCode
    string
    FacilityName
    string
    object
    object
    currencyValue
    string
    currencyType
    string
    taxIncluded
    boolean
    array
    array
    languageCode
    required
    string
    ISO language code
    value
    required
    string
    text in language code
    taxRate
    string
    taxAmount
    string
    feeType
    string
    One value must to be assigned [SEGMENT, PENALTY, INVOICE, REMINDER, LOOKUP]

    Responses

    • id
      string
      The Id of the Receivable created
      status
      string
      Enum:
      • PENDING
      • CARHOLDER_LOOKUP_REQUESTED
      • CARHOLDER_RESOLUTION_FAILED
      • INVOICE_CREATED
      • INVOICING_FAILED
      • WHITELISTED
      • INVOICE_REQUESTED
      • CREDITED_PENDING
      • CREDITED_NOTES_FAILED
      • CREDITED_NOTES_SUCCEED
      • WAITING_CONTRACT_DATA
    • 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 occured. 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`.
    • 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 occured. 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`.
    • 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 occured. 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`.
    • 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 occured. 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`.
    • 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 occured. 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`.
      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 occured. 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`.
      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 occured. 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`.
      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 occured. 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`.
      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 occured. 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`.