Update an invoice

PATCH 
/invoices/:invoice_id

Draft invoices are fully editable. Once an invoice is finalized, Invoice and Invoice Items become uneditable.

Request

Path Parameters

invoice_id uuidrequired

Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Invoice's ID

application/json

Body

required

customer_id uuid

Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

UUID v4

due_date Unix timestamp

Unix timestamp representing the date

Responses

200

Invoice updated successfully

application/json

Schema

Schema

status string

Possible values: [success]

code integer

Possible values: [200]

message string

Possible values: [Successful request]

Example (from schema)

{
  "status": "success",
  "code": 200,
  "message": "Successful request"
}

401

Access token is missing or invalid

403

Access denied

404

Invoice not found

application/json

Schema

Schema

status string

Possible values: [not found]

code integer

Possible values: [404]

message string

Failure reason

Example (from schema)

{
  "status": "not found",
  "code": 404,
  "message": "Entity not found"
}

409

Request failed due to a conflict in the provided entity

application/json

Schema

Schema

status string

Possible values: [fail]

code integer

Possible values: [409]

message string

Failure reason

Example (from schema)

{
  "status": "fail",
  "code": 409,
  "message": "Entity with Id already exists"
}

422

Request failed due to validation failure

application/json

Schema

Schema

status string

Possible values: [error]

data object
code integer

Possible values: [422]

message string

Example (from schema)

{
  "status": "error",
  "data": {
    "dob": {
      "day": "Value expected to be 'integer', 'string' given."
    }
  },
  "code": 422,
  "message": "cannot process the provided entity"
}

500

Server error

Loading...