Supported Formats

json

Errors

Code Description
404 Resource Not Found
422 Validation Error
500 Internal Server Error

Examples

curl 'https://app.octopi.co/api/v1/chargeable_events/bulk_update' \
  -X 'PUT' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token=YOURTOKEN' \
  -d '{
    "chargeable_events": [
        {
            "event_id": "876b92d7-1716-4bc8-b9e8-975c1f535bea",
            "general_ledger_id": "GL00019432",
            "notes": "Some Notes"
        },
        {
            "event_id": "8230a8b7-71b1-402c-84ad-891f9d7246eb",
            "general_ledger_id": "GL00019433",
            "notes": "Some Notes 1"
        },
        {
            "event_id": "c4f82fa0-f3be-4eda-9085-199ad61282d5",
            "general_ledger_id": "GL00019434",
            "notes": "Some Notes 2"
        }
    ]
}'
{
  "success": true,
  "records_updated": 3
}

Params

Param name Description
chargeable_events
required

Validations:

  • Must be an Array of nested elements

chargeable_events[event_id]
optional

Octopi ID (UUID) of the chargeable event.

Validations:

  • Must be a String

chargeable_events[general_ledger_id]
optional

Customer assigned ID for future references.

Validations:

  • Must be a String

chargeable_events[notes]
optional

Notes or Comments

Validations:

  • Must be a String