Skip to main content
POST
Upload a document (PDF)

Path Parameters

consumer_id
string<uuid>
required

Body

application/json
base64_string
string
required
document_type
enum<string>
required
Available options:
customer_document,
supplier_document,
employee_expense

Response

Successful Response

id
string
required

Technical id in Chift

source_ref
Ref · object
required

Technical id in the target software

currency
string | null

Currency of the uploaded document

invoice_type
enum<string> | null

Invoice type of the uploaded document

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

Status of the uploaded document

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

Invoicing date

tax_amount
number | null

Taxes amount

untaxed_amount
number | null

Untaxed amount

total
number | null

Total amount incl. taxes

lines
InvoiceLineItem · object[] | null

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.