Reject an invoice

Post

/v1/invoices/{invoiceId}/reject

Reject an invoice. Requires a user-linked API token.

Any provided notes and tags are applied as annotations after the rejection succeeds.

Request Fields

Field	Type	Description
notes	string	Rejection reason. Also stored as a communication entry.
tags	string	Comma-separated tags to apply.

Security

HTTP

Type bearer

Enter your API token.

Path parameters

invoiceId

integerRequired

The invoice ID to reject.

Minimum1

Body parameters

reject

Reject Invoice

{
  "notes": "Missing line item details for materials",
  "tags": "needs-revision"
}

object

Request body for invoice actions (annotate, approve, reject, unApprove, unReject). Both fields are optional.

notes

string

Notes to add to the invoice. Stored as a communication entry with the acting user's ID and timestamp.

tags

string

Comma-separated tags to apply to the invoice.

Responses

200

Invoice rejected

success

Success

{
  "status": "OK",
  "msg": "Reject successful.",
  "result": 12345
}

object

status

string

Valid values[ "OK" ]

msg

string

result

400

Bad Request

invoiceGroup

Invoice Group Not Actionable

{
  "status": "Error",
  "msg": "ID is of an invoice group and is not actionable.",
  "result": null
}

object

status

string

Valid values[ "Error" ]

msg

string

result

401

Unauthorized

403

Forbidden - Token not linked to user

404

Invoice not found