Get an invoice

GET

/invoices/{id}/

curl --request GET \
  --url https://app.commitly.com/api/invoices/3102/ \
  --header 'Authorization: Bearer <token>'

• Production

Returns a single invoice by its internal ID (id). To look up an invoice by its number, use GET /invoices/?reference= (substring match) and check reference in the results.

Authorizations

• commitlyOAuth

Parameters

Path Parameters

id

required

integer

Internal invoice ID (id in invoice responses), not the invoice number.

Example

3102

Responses

200

The invoice.

Media typeapplication/json

object

id

Internal invoice ID. Used in /invoices/{id}/ and as id selector.

integer

transactions

Bank transactions matched to the invoice.

Array<object>

A bank transaction matched to the invoice.

object

id

integer

account

Bank account of the transaction.

value_date

string

amount

number

purpose

string

counterpart_name

string

reporting_amount

number

paid_amount

number

amount_due

number

date_created

string format: date-time

date_updated

string format: date-time

name

string

notes

string

amount

Decimal with at most 10 digits and 2 decimal places.

number

type

RE receivable, PA payable. Optional on create: if omitted, a positive amount sets RE, any other amount PA.

string

Allowed values: RE PA

reference

Invoice number.

string

date

Invoice date.

string format: date

due_date

string format: date

expected_date

Expected payment date.

string format: date

source

Origin of the invoice, e.g. direct_api or Manually Added.

string

source_id

ID of the invoice in its source.

string

status

Code	Label
OD	Overdue
PL	Expected
OR	Lead/Order
PD	Paid
PP	Partially Paid
IN	Installments
HD	On Hold
PR	Promised
DP	In Dispute
CA	Cancelled
IP	In Progress

string

Allowed values: OD PL OR PD PP IN HD PR DP CA IP

status_label

Label of status, e.g. Expected.

string

is_archived

boolean

category

Category ID.

integer | null

comment_count

Present in list responses.

integer

Examples

ExampleInvoiceCreated

Invoice

{
  "id": 3102,
  "transactions": [],
  "paid_amount": 0,
  "amount_due": 7450,
  "date_created": "2022-04-16T09:53:03.919398Z",
  "date_updated": "2022-04-16T09:53:03.919422Z",
  "name": "Equipment",
  "notes": "Special equipment",
  "amount": 7450,
  "type": "RE",
  "reference": "AR-007",
  "date": "2022-04-16",
  "due_date": "2022-04-28",
  "source": "direct_api",
  "source_id": "00000000-0000-4000-8000-000000000002",
  "status": "PL",
  "status_label": "Expected",
  "is_archived": false,
  "category": 1002
}

401

The access token is invalid or has expired. Request a new token. The message is localized (see Accept-Language).

Media typeapplication/json

object

detail

required

Error message.

string

code

Present only if the company’s edition does not include the function; value billing_plan_permission_denied.

string

Example

{
  "detail": "Invalid token."
}

Headers

WWW-Authenticate

string

Authentication scheme, Bearer.

Example

Bearer

403

No access token was sent, or the credentials are not allowed to call this endpoint. If the company’s COMMITLY edition does not include the requested function, the body additionally contains "code": "billing_plan_permission_denied".

Media typeapplication/json

object

detail

required

Error message.

string

code

Present only if the company’s edition does not include the function; value billing_plan_permission_denied.

string

Example

{
  "detail": "User must be authenticated to access this resource."
}

404

The resource does not exist or is not accessible with these credentials.

Media typeapplication/json

object

detail

required

Error message.

string

code

Present only if the company’s edition does not include the function; value billing_plan_permission_denied.

string

Example^generated

{
  "detail": "example",
  "code": "example"
}