ROroutable
Receivables

Update a Receivable

Changed on

Update an existing Receivable.

patch/v1/receivables/{id}

Request

Path parameters

idstring uuid required
Example:8c581d79-bb84-4bc1-b1c5-8c073264a569

The ID for the resource being accessed.

Headers

Idempotency-Keystring

An idempotency key to prevent duplicate requests. All requests with the same key will be considered attempts for the same request.

These keys are stored for a period of 24 hours. To ensure these keys are sufficiently tied to a request, we recommend either storing generated idempotency keys alongside your payment data, or using a hash of the request JSON itself to generate your idempotency key.

Request body

OR

Example request

{
  "acting_team_member": "8c581d79-bb84-4bc1-b1c5-8c073264a569",
  "deposit_into_account": "8c581d79-bb84-4bc1-b1c5-8c073264a569",
  "due_from_company": "8c581d79-bb84-4bc1-b1c5-8c073264a569",
  "due_on": "2022-11-11",
  "send_on": "2022-11-26"
}

Response

OK

OR

Example response

{
  "created_at": "2021-05-15T03:49:53.299680+00:00",
  "deposit_into_account": {
    "type_details": {
      "primary_color": "#0075a3"
    }
  },
  "send_on": "2022-11-26"
}

Changes

  • 9d71f3ec4b5cRevision changes
    • breaking

      the response property ///////// became optional for the status

    • warning

      changed the pattern of the request property ////// from ^data:(text\/csv|application\/vnd.openxmlformats-officedocument.wordprocessingm1.document|image\/jpeg|application\/pdf|image\/png|text\/plain|application\/vnd.openxmlformats-officedocument.spreadsheetml.sheet){1};base64, to ^data:(text\/csv|application\/vnd.openxmlformats-officedocument.wordprocessingml.document|image\/jpeg|application\/pdf|image\/png|text\/plain|application\/vnd.openxmlformats-officedocument.spreadsheetml.sheet){1};base64,

    • warning

      added the new GHS enum value to the //////////// response property for the response status

    • warning

      added the new GHS enum value to the //////////// response property for the response status

    • warning

      added the new GHS enum value to the //////////// response property for the response status

    • warning

      added the new GHS enum value to the //////////////// response property for the response status

    • warning

      added the new GHS enum value to the //////////////// response property for the response status

    • warning

      added the new GHS enum value to the //////////////// response property for the response status

    • warning

      added the new MOP enum value to the //////////// response property for the response status

    • warning

      added the new MOP enum value to the //////////// response property for the response status

    • warning

      added the new MOP enum value to the //////////// response property for the response status

    • warning

      added the new MOP enum value to the //////////////// response property for the response status

    • warning

      added the new MOP enum value to the //////////////// response property for the response status

    • warning

      added the new MOP enum value to the //////////////// response property for the response status

    • info

      added the new GHS enum value to the request property ////////

    • info

      added the new MOP enum value to the request property ////////

    • info

      removed the new enum value from the //////// response property for the response status

    • info

      removed the new enum value from the //////////// response property for the response status

    • info

      added the required property /////////////// to the response with the status

    • info

      added the success response with the status