Create invoice

Field support per integration

BuchhaltungsButler

Supported Request Parameters:

contactId

string

required

name

string

invoiceDate

string

required

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

addresses

Address[]

Show properties

addressLine1

string

addressLine2

string

city

string

postalCode

string

countryCode

enum

Available options (ISO 3166-1 alpha-2): AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

lineItems

LineItem[]

required

Show properties

description

string

required

quantity

number

required

Note that quantity can be a decimal numeral.

unitAmount

number

required

taxRatePercentage

number

required

unitName

string

required

discountPercentage

number

Business Central

If you’re not using the Interactive Authentication Flow, make sure the query parameters environmentName and companyId are correctly populated. You can obtain these values by using the GET Environments and GET Companies endpoints available under the Authentication section.

Supported Request Parameters:

contactId

string

required

invoiceType

enum

Available options: STANDARD

currency

enum

Available options (3-letter ISO 4217):
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GQE, 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, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZM, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SYP, SZL, THB, TJS, TMT, TND, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEB, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, YER, ZAR, ZMK, ZWR

invoiceDate

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

dueDate

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

addresses

Address[]

Show properties

addressLine1

string

addressLine2

string

city

string

postalCode

string

countryCode

enum

type

enum

Available options: SELLING, DELIVERY

lineItems

LineItem[]

Show properties

itemId

string

description

string

quantity

number

Note that quantity can be a decimal numeral.

unitAmount

number

taxCode

number

discountItemPercentage

number

Exact

If you’re not using the Interactive Authentication Flow, make sure the query parameter companyId is correctly populated. You can obtain this value by using the GET Companies endpoint available under the Authentication section.

Supported Request Parameters:

contactId

string

required

currency

enum

Available options (3-letter ISO 4217): AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GQE, 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, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZM, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SYP, SZL, THB, TJS, TMT, TND, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEB, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, YER, ZAR, ZMK, ZWR

discountPercentage

number

dueDate

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

fileId

string

journalCode

string

required

lineItems

LineItem[]

Show properties

accountId

string

required

description

string

dimensions

Dimension[]

Show properties

categoryName

string

name

string

itemId

string

required

name

string

quantity

number

taxCode

string

The taxCode is used to determine the tax rate for the line item.

If taxCode is not provided, the default tax code will be used (if available).

taxRatePercentage

number

If taxCode is provided, this taxRatePercentage will be overridden by the tax rate associated with the provided taxCode.

unitAmount

number

required

The unitAmount is the net amount charged for each unit of the line item.

When the taxCode is of type INCLUSIVE, then the unitAmount will be treated as a gross amount (i.e., including tax).

paymentTermId

string

Lexware Office

As a minimum a valid contactId OR a name and countryCode must be provided. We recommend to always provide a valid address in addition in the latter case

Supported Request Parameters:

contactId

string

name

string

currency

enum

required

Available options (3-letter ISO 4217):AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GQE, 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, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZM, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SYP, SZL, THB, TJS, TMT, TND, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEB, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, YER, ZAR, ZMK, ZWR

invoiceDate

string

required

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

addresses

Address[]

Show properties

addressLine1

string

addressLine2

string

city

string

postalCode

string

countryCode

enum

type

enum

Available options: BILLING

taxRule

enum

required

Available options:NET, TAXFREE, INTRACOMMUNITY_GOODS, INTRACOMMUNITY_SERVICE, EXPORT_SERVICE, EXPORT_GOODS, REVERSE_CHARGE , GROSS, CONSTRUCTION_SERVICE, PHOTOVOLTAIC_EQUIPMENT

lineItems

LineItem[]

required

Show properties

string

name

string

required

quantity

number

Note that quantity can be a decimal numeral.

type

enum

required

Available options: SERVICE_ITEM, MATERIAL, CUSTOM, TEXT

unitName

string

required

unitAmount

number

grossAmount

number

taxRatePercentage

number

required

discountItemPercentage

number

shippingType

enum

required

Available options:SERVICE, SERVICEPERIOD, DELIVERY, DELIVERYPERIOD, NONE

shippingDate

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

shippingEndDate

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

paymentTermDuration

number

required

QuickBooks

Supported Request Parameters:

contactId

string

invoiceDate

string

required

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

addresses

Address[]

Show properties

addressLine1

string

addressLine2

string

city

string

postalCode

string

countryCode

enum

type

enum

Available options: BILLING

lineItems

LineItem[]

required

Show properties

string

name

string

required

quantity

number

Note that quantity can be a decimal numeral.

unitAmount

number

dueDate

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

Sage Active

If you’re not using the Interactive Authentication Flow, make sure the query parameters environmentName and companyId are correctly populated. You can obtain these values by using the GET Companies endpoint available under the Authentication section. Please use the id field as the companyId and the environmentId field as the environmentName.

Supported Request Parameters:

contactId

string

invoiceDate

string

required

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

reference

string

Additional document number.

lineItems

LineItem[]

required

Show properties

itemId

string

required

The product ID.

name

string

required

quantity

number

Note that quantity can be a decimal numeral.

unitAmount

number

discountItemPercentage

number

Sevdesk

Supported Request Parameters:

contactId

string

required

reference

string

Additional reference number. May be customer number, order number or similar.

currency

enum

required

Available options (3-letter ISO 4217):AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GQE, 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, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZM, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SYP, SZL, THB, TJS, TMT, TND, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEB, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, YER, ZAR, ZMK, ZWR

invoiceDate

string

required

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

status

enum

required

Available options: DRAFT, SUBMITTED, AUTHORISED, PAID, CANCELED

invoiceType

enum

required

Available options: STANDARD

taxRule

enum

required

Available options:NET, TAXFREE, INTRACOMMUNITY_SERVICE, EXPORT_SERVICE, REVERSE_CHARGE, SMALL_BUSINESS_VAT_EXEMPTION , NON_DOMESTIC_SERVICE, OSS_GOODS, OSS_ELECTRONIC_SERVICES, OSS_SERVICES

taxText

string

required

Tax description

lineItems

LineItem[]

required

Show properties

name

string

required

quantity

number

required

Note that quantity can be a decimal numeral.

description

string

unitAmount

number

taxRatePercentage

number

required

discountPercentage

number

shippingDate

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

paidDate

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

paymentTermDuration

number

weclapp

Supported Request Parameters:

invoiceId

string

addresses

Address[]

Show properties

addressLine1

string

addressLine2

string

city

string

postalCode

string

countryCode

enum

type

enum

Available options: BILLING, DELIVERY

contactId

string

required

dueDate

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

invoiceDate

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

invoiceNumber

string

Unique alpha numeric code identifying the invoice.

invoiceType

enum

Available options: STANDARD

lineItems

LineItem[]

Show properties

lineItemId

string

name

string

quantity

number

Note that quantity can be a decimal numeral.

taxRatePercentage

number

unitAmount

number

grossAmount

number

itemsAmount

number

discountItemAmount

number

discountItemPercentage

number

description

string

paymentStatus

enum

Available options: PENDING, PAID, CLEARED_WITH_CREDIT_NOTE, CREDIT_NOTE_CLEARED, NO_OPEN_ITEM, UNKNOWN

shippingDate

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

status

enum

Available options: DRAFT, SUBMITTED, DOCUMENT_CREATED, OPEN, VOIDED

sumNetAmount

number

totalAmount

number

totalTaxAmount

number

Xero

Supported Request Parameters:

contactId

string

required

reference

string

Additional reference number. May be customer number, order number or similar.

currency

enum

required

Available options (3-letter ISO 4217):AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GQE, 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, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZM, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SYP, SZL, THB, TJS, TMT, TND, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEB, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, YER, ZAR, ZMK, ZWR

invoiceDate

string

required

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

status

enum

required

Available options: DRAFT, SUBMITTED, AUTHORISED, PAID, CANCELED

invoiceType

enum

required

Available options: STANDARD

lineItems

LineItem[]

required

Show properties

quantity

number

required

Note that quantity can be a decimal numeral.

description

string

unitAmount

number

accountCode

number

required

discountItemPercentage

number

lineAmountTypes

enum

Available options: EXCLUSIVE, INCLUSIVE, NOTAX

dueDate

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

Headers

X-API-KEY

string

API key

X-ACCOUNT-KEY

string

Account key

Query Parameters

companyId

string

environmentName

string

Body

application/json

Response

200 - application/json

The response is of type object.

Get started

Guides

Integrations

Use cases

API reference

Create invoice

Field support per integration

Headers

Query Parameters

Body

Response

Get started

Guides

Integrations

Use cases

API reference

​Field support per integration

Headers

Query Parameters

Body

Response

Field support per integration