Skip to main content
GET
Retrieve one invoice

Path Parameters

consumer_id
string<uuid>
required
invoice_id
string
required

Query Parameters

include_pdf
enum<string> | null
default:false

Include the invoice PDF as a base64 encoded string in the response

Available options:
true,
false
include_analytic_accounts
enum<string> | null
default:false

Include analytic accounts in the response

Available options:
true,
false

Response

Successful Response

Invoice item returned in get 1 invoice

id
string
required

Technical id in Chift

source_ref
Ref · object
required

Technical id in the target software

currency
string
required

Currency matching target sofware name

invoice_type
enum<string>
required

Invoice type

Available options:
customer_invoice,
customer_refund,
supplier_invoice,
supplier_refund,
all
status
enum<string>
required

Status

Available options:
cancelled,
draft,
posted,
paid
invoice_date
string<date>
required

Invoicing date

tax_amount
number
required

Taxes amount

untaxed_amount
number
required

Untaxed amount

total
number
required

Total amount incl. taxes

lines
InvoiceLineItemOut · object[]

Invoice lines

partner_id
string | null

Technical id of the vendor/customer in Chift

invoice_number
string | null

Number/sequence

due_date
string<date> | null

Due date

reference
string | null

Reference

payment_communication
string | null

Payment communication

customer_memo
string | null

Customer note/memo

journal_ref
FieldRef · object | null

Journal

italian_specificities
ItalianSpecificities · object | null

Specificities for Italy

last_updated_on
string<date-time> | null
outstanding_amount
number | null

Amount left to be paid

last_payment_date
string<date> | null

Date of the last payment linked to the invoice

accounting_date
string<date> | null

Accounting date

payment_method_id
string | null

Technical id of the payment method in Chift

currency_exchange_rate
number | null
default:1

Indicates the exchange rate at the date of the invoice.

pdf
string | null

PDF document in base64