Create an invoice

curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "<string>",
  "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
    },
    "welfare_fund": {
      "rate": 123,
      "amount": 123
    },
    "payment_reporting": {}
  }
}
'

import requests

url = "https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices"

payload = {
    "currency": "<string>",
    "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
        },
        "welfare_fund": {
            "rate": 123,
            "amount": 123
        },
        "payment_reporting": {}
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    currency: '<string>',
    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},
      welfare_fund: {rate: 123, amount: 123},
      payment_reporting: {}
    }
  })
};

fetch('https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'currency' => '<string>',
    '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
        ],
        'welfare_fund' => [
                'rate' => 123,
                'amount' => 123
        ],
        'payment_reporting' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices"

	payload := strings.NewReader("{\n  \"currency\": \"<string>\",\n  \"invoice_date\": \"2023-12-25\",\n  \"tax_amount\": 123,\n  \"untaxed_amount\": 123,\n  \"total\": 123,\n  \"lines\": [],\n  \"partner_id\": \"<string>\",\n  \"invoice_number\": \"<string>\",\n  \"due_date\": \"2023-12-25\",\n  \"reference\": \"<string>\",\n  \"payment_communication\": \"<string>\",\n  \"customer_memo\": \"<string>\",\n  \"journal_ref\": {\n    \"id\": \"<string>\",\n    \"model\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"italian_specificities\": {\n    \"stamp_duty_amount\": 123,\n    \"withholding_tax\": {\n      \"rate\": 123,\n      \"amount\": 123\n    },\n    \"welfare_fund\": {\n      \"rate\": 123,\n      \"amount\": 123\n    },\n    \"payment_reporting\": {}\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices")
  .header("Content-Type", "application/json")
  .body("{\n  \"currency\": \"<string>\",\n  \"invoice_date\": \"2023-12-25\",\n  \"tax_amount\": 123,\n  \"untaxed_amount\": 123,\n  \"total\": 123,\n  \"lines\": [],\n  \"partner_id\": \"<string>\",\n  \"invoice_number\": \"<string>\",\n  \"due_date\": \"2023-12-25\",\n  \"reference\": \"<string>\",\n  \"payment_communication\": \"<string>\",\n  \"customer_memo\": \"<string>\",\n  \"journal_ref\": {\n    \"id\": \"<string>\",\n    \"model\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"italian_specificities\": {\n    \"stamp_duty_amount\": 123,\n    \"withholding_tax\": {\n      \"rate\": 123,\n      \"amount\": 123\n    },\n    \"welfare_fund\": {\n      \"rate\": 123,\n      \"amount\": 123\n    },\n    \"payment_reporting\": {}\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"currency\": \"<string>\",\n  \"invoice_date\": \"2023-12-25\",\n  \"tax_amount\": 123,\n  \"untaxed_amount\": 123,\n  \"total\": 123,\n  \"lines\": [],\n  \"partner_id\": \"<string>\",\n  \"invoice_number\": \"<string>\",\n  \"due_date\": \"2023-12-25\",\n  \"reference\": \"<string>\",\n  \"payment_communication\": \"<string>\",\n  \"customer_memo\": \"<string>\",\n  \"journal_ref\": {\n    \"id\": \"<string>\",\n    \"model\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"italian_specificities\": {\n    \"stamp_duty_amount\": 123,\n    \"withholding_tax\": {\n      \"rate\": 123,\n      \"amount\": 123\n    },\n    \"welfare_fund\": {\n      \"rate\": 123,\n      \"amount\": 123\n    },\n    \"payment_reporting\": {}\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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,
  "last_payment_date": "2023-12-25",
  "accounting_date": "2023-12-25",
  "payment_method_id": "<string>",
  "currency_exchange_rate": 1
}

{
  "message": "Error while trying to perform your request",
  "status": "error"
}

{
  "message": "Validation error",
  "status": "error",
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

consumers

{consumer_id}

invoicing

invoices

Create an invoice

curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "<string>",
  "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
    },
    "welfare_fund": {
      "rate": 123,
      "amount": 123
    },
    "payment_reporting": {}
  }
}
'

import requests

url = "https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices"

payload = {
    "currency": "<string>",
    "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
        },
        "welfare_fund": {
            "rate": 123,
            "amount": 123
        },
        "payment_reporting": {}
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    currency: '<string>',
    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},
      welfare_fund: {rate: 123, amount: 123},
      payment_reporting: {}
    }
  })
};

fetch('https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'currency' => '<string>',
    '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
        ],
        'welfare_fund' => [
                'rate' => 123,
                'amount' => 123
        ],
        'payment_reporting' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices"

	payload := strings.NewReader("{\n  \"currency\": \"<string>\",\n  \"invoice_date\": \"2023-12-25\",\n  \"tax_amount\": 123,\n  \"untaxed_amount\": 123,\n  \"total\": 123,\n  \"lines\": [],\n  \"partner_id\": \"<string>\",\n  \"invoice_number\": \"<string>\",\n  \"due_date\": \"2023-12-25\",\n  \"reference\": \"<string>\",\n  \"payment_communication\": \"<string>\",\n  \"customer_memo\": \"<string>\",\n  \"journal_ref\": {\n    \"id\": \"<string>\",\n    \"model\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"italian_specificities\": {\n    \"stamp_duty_amount\": 123,\n    \"withholding_tax\": {\n      \"rate\": 123,\n      \"amount\": 123\n    },\n    \"welfare_fund\": {\n      \"rate\": 123,\n      \"amount\": 123\n    },\n    \"payment_reporting\": {}\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices")
  .header("Content-Type", "application/json")
  .body("{\n  \"currency\": \"<string>\",\n  \"invoice_date\": \"2023-12-25\",\n  \"tax_amount\": 123,\n  \"untaxed_amount\": 123,\n  \"total\": 123,\n  \"lines\": [],\n  \"partner_id\": \"<string>\",\n  \"invoice_number\": \"<string>\",\n  \"due_date\": \"2023-12-25\",\n  \"reference\": \"<string>\",\n  \"payment_communication\": \"<string>\",\n  \"customer_memo\": \"<string>\",\n  \"journal_ref\": {\n    \"id\": \"<string>\",\n    \"model\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"italian_specificities\": {\n    \"stamp_duty_amount\": 123,\n    \"withholding_tax\": {\n      \"rate\": 123,\n      \"amount\": 123\n    },\n    \"welfare_fund\": {\n      \"rate\": 123,\n      \"amount\": 123\n    },\n    \"payment_reporting\": {}\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"currency\": \"<string>\",\n  \"invoice_date\": \"2023-12-25\",\n  \"tax_amount\": 123,\n  \"untaxed_amount\": 123,\n  \"total\": 123,\n  \"lines\": [],\n  \"partner_id\": \"<string>\",\n  \"invoice_number\": \"<string>\",\n  \"due_date\": \"2023-12-25\",\n  \"reference\": \"<string>\",\n  \"payment_communication\": \"<string>\",\n  \"customer_memo\": \"<string>\",\n  \"journal_ref\": {\n    \"id\": \"<string>\",\n    \"model\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"italian_specificities\": {\n    \"stamp_duty_amount\": 123,\n    \"withholding_tax\": {\n      \"rate\": 123,\n      \"amount\": 123\n    },\n    \"welfare_fund\": {\n      \"rate\": 123,\n      \"amount\": 123\n    },\n    \"payment_reporting\": {}\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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,
  "last_payment_date": "2023-12-25",
  "accounting_date": "2023-12-25",
  "payment_method_id": "<string>",
  "currency_exchange_rate": 1
}

{
  "message": "Error while trying to perform your request",
  "status": "error"
}

{
  "message": "Validation error",
  "status": "error",
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

consumer_id

string<uuid>

required

Body

application/json

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

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

InvoiceLineItem · object[]

Invoice lines

Show child attributes

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

Show child attributes

italian_specificities

ItalianSpecificities · object | null

Specificities for Italy

Show child attributes

Response

Successful Response

string

required

Technical id in Chift

source_ref

Ref · object

required

Technical id in the target software

Show child attributes

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

Show child attributes

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

Show child attributes

italian_specificities

ItalianSpecificities · object | null

Specificities for Italy

Show child attributes

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

API Reference Overview

Access & Connections

Accounting

Invoicing

POS

eCommerce

PMS

Payment

Banking

Other

Create an invoice

Path Parameters

Body

Response