Skip to main content
POST
/
consumers
/
{consumer_id}
/
invoicing
/
upload-document
Upload a document (PDF)
curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/invoicing/upload-document \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "base64_string": "<string>",
  "document_type": "customer_document"
}'
{
  "id": "<string>",
  "source_ref": {
    "id": "<string>",
    "model": "<string>"
  },
  "currency": "<string>",
  "invoice_type": "customer_invoice",
  "status": "cancelled",
  "invoice_date": "2023-12-25",
  "tax_amount": 123,
  "untaxed_amount": 123,
  "total": 123,
  "lines": [
    {
      "description": "<string>",
      "unit_price": 123,
      "quantity": 123,
      "discount_amount": 0,
      "tax_amount": 123,
      "untaxed_amount": 123,
      "total": 123,
      "tax_rate": 123,
      "account_number": "<string>",
      "tax_id": "<string>",
      "tax_exemption_reason": "<string>",
      "unit_of_measure": "<string>",
      "product_id": "<string>",
      "product_code": "<string>",
      "product_name": "<string>"
    }
  ],
  "partner_id": "<string>",
  "invoice_number": "<string>",
  "due_date": "2023-12-25",
  "reference": "<string>",
  "payment_communication": "<string>",
  "customer_memo": "<string>",
  "journal_ref": {
    "id": "<string>",
    "model": "<string>",
    "name": "<string>"
  },
  "italian_specificities": {
    "stamp_duty_amount": 123,
    "withholding_tax": {
      "rate": 123,
      "amount": 123,
      "reason": "RT01",
      "payment_reason": "A"
    },
    "welfare_fund": {
      "rate": 123,
      "amount": 123,
      "type": "TC01"
    },
    "payment_reporting": {
      "method": "MP01",
      "conditions": "TP01"
    }
  },
  "last_updated_on": "2023-11-07T05:31:56Z",
  "outstanding_amount": 123,
  "last_payment_date": "2023-12-25",
  "accounting_date": "2023-12-25",
  "payment_method_id": "<string>",
  "currency_exchange_rate": 123
}

Authorizations

Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

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
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
object | null

Journal

italian_specificities
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.

I