GET
/
consumers
/
{consumer_id}
/
invoicing
/
invoices
/
{invoice_id}
curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices/{invoice_id} \
  --header 'Authorization: Bearer <token>'
{
  "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": [],
  "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,
  "accounting_date": "2023-12-25",
  "payment_method_id": "<string>",
  "currency_exchange_rate": 1,
  "pdf": "<string>"
}

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
required
​
invoice_id
string
required

Query Parameters

​
include_pdf
enum<string>
default:false

An enumeration.

Available options:
true,
false

Response

200
application/json
Successful Response

Invoice item returned in get 1 invoice

​
id
string
required

Technical id in Chift

​
source_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
required

Invoicing date

​
tax_amount
number
required

Taxes amount

​
untaxed_amount
number
required

Untaxed amount

​
total
number
required

Total amount incl. taxes

​
lines
object[]

Invoice lines

​
partner_id
string

Technical id of the vendor/customer in Chift

​
invoice_number
string

Number/sequence

​
due_date
string

Due date

​
reference
string

Reference

​
payment_communication
string

Payment communication

​
customer_memo
string

Customer note/memo

​
journal_ref
object

Journal

​
italian_specificities
object

Specificities for Italy

​
last_updated_on
string
​
outstanding_amount
number

Amount left to be paid

​
accounting_date
string

Accounting date

​
payment_method_id
string

Technical id of the payment method in Chift

​
currency_exchange_rate
number
default:1

Indicates the exchange rate at the date of the invoice.

​
pdf
string

PDF document in base64