POST
/
customer_invoices
{
  "invoice_number": "<string>",
  "currency": "AED",
  "amount": "<string>",
  "currency_amount": "<string>",
  "currency_amount_before_tax": "<string>",
  "date": "<string>",
  "deadline": "<string>",
  "currency_tax": "<string>",
  "tax": "<string>",
  "id": 123,
  "label": "<string>",
  "exchange_rate": "<string>",
  "public_file_url": "<string>",
  "filename": "<string>",
  "remaining_amount_with_tax": "<string>",
  "remaining_amount_without_tax": "<string>",
  "archived_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "v1_external_id": "<string>",
  "v2_id": 123,
  "customer": {
    "id": 123,
    "url": "<string>"
  },
  "language": "fr_FR",
  "discount": {
    "type": "relative",
    "value": "<string>"
  },
  "special_mention": "<string>",
  "pdf_invoice_free_text": "<string>",
  "pdf_invoice_subject": "<string>",
  "pdf_description": "<string>",
  "billing_subscription": {
    "id": 123,
    "url": "<string>"
  },
  "external_reference": "<string>",
  "paid": true,
  "draft": true,
  "ledger_entry": {
    "id": 123,
    "url": "<string>"
  },
  "estimate": {
    "id": 123,
    "url": "<string>"
  },
  "credited_invoice": {
    "id": 123,
    "url": "<string>"
  },
  "from_estimate_id": 123,
  "customer_invoice_template": {
    "id": 123,
    "url": "<string>"
  },
  "invoice_lines": {
    "url": "<string>"
  },
  "payments": "<any>",
  "matched_transactions": "<any>",
  "appendices": "<any>",
  "status": "incomplete",
  "transaction_reference": {
    "banking_provider": "gocardless",
    "provider_field_name": "payment_id",
    "provider_field_value": "<string>"
  }
}

Headers

x-source
enum<string>
required
Available options:
billy
x-source-software
enum<string>
required
Available options:
EASYBEER,
AMAZON,
AMAZONSELLER,
AXONAUT,
HARVEST,
HUBSPOT,
PENNYLANE,
ZOHO,
CHARGEBEE,
SELLSY,
VOSFACTURES,
FACTOMOS,
BOONDMANAGER,
TEAMLEADER,
CHORUSPRO,
DOLIBARR,
PROGBAT,
EVOLIZ,
RECURLY,
KARLIA,
PIPEDRIVE,
SHOPIFY,
ODOO,
LAGO,
SALESFORCE,
HYPERLINE,
RENTMAN,
SPENDESK,
WEEBATI,
PROABONO,
WOOCOMMERCE,
PRESTASHOP,
MAGENTO,
SQUARESPACE,
BIGCOMMERCE,
SYLIUS,
ORGANILOG,
XERO,
ZETTLE,
SUMUP,
METRO,
VSA

Body

application/json

Body

draft
boolean
required
date
string
required
deadline
string
required
customer_id
number
required
invoice_lines
object[]
required
customer_invoice_template_id
number
pdf_invoice_free_text
string | null
pdf_invoice_subject
string | null
pdf_description
string | null
currency
default:EUR
Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTC,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNY,
COP,
CRC,
CUC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRO,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLL,
SOS,
SRD,
SSP,
STD,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XAG,
XAU,
BCH,
XCD,
XDR,
XOF,
XPD,
XPF,
XPT,
YER,
ZAR,
ZMW,
ZWL
special_mention
string | null
language
enum<string>
default:fr_FR
Available options:
fr_FR,
en_GB
discount
object | null
invoice_line_sections
object[]
Minimum length: 1
external_reference
string | null

Response

201

invoice_number
string
required
currency
enum<string>
required
Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTC,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNY,
COP,
CRC,
CUC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRO,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLL,
SOS,
SRD,
SSP,
STD,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XAG,
XAU,
BCH,
XCD,
XDR,
XOF,
XPD,
XPF,
XPT,
YER,
ZAR,
ZMW,
ZWL
amount
string
required
currency_amount_before_tax
string
required
id
number
required
exchange_rate
string
required
created_at
string
required
updated_at
string
required
draft
boolean
required
status
enum<string>
required
Available options:
incomplete,
draft,
credit_note,
upcoming,
late,
paid,
cancelled,
partially_cancelled,
partially_cancelled_draft,
archived,
proforma
currency_amount
string
date
string | null
deadline
string | null
currency_tax
string
tax
string
label
string | null
public_file_url
string | null
filename
string | null
remaining_amount_with_tax
string | null
remaining_amount_without_tax
string | null
archived_at
string | null
v1_external_id
string | null
Maximum length: 2000
v2_id
number | null
customer
object | null
language
enum<string>
Available options:
fr_FR,
en_GB
discount
object | null
special_mention
string | null
pdf_invoice_free_text
string | null
pdf_invoice_subject
string | null
pdf_description
string | null
billing_subscription
object | null
external_reference
string | null
paid
boolean | null
ledger_entry
object | null
estimate
object | null
credited_invoice
object | null
from_estimate_id
number | null
customer_invoice_template
object | null
invoice_lines
object | null
payments
any
matched_transactions
any
appendices
any
transaction_reference
object | null