Sign in

v1

latestOpenAPI 3.1.12026-07-2452287575.4 KB
Receivables

Update a Receivable

Update an existing Receivable.

🏁 This endpoint's rate limit is 100 calls per minute.

patch/v1/receivables/{id}

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"
}