GET
/
accounting
/
invoices
cURL
curl --request GET \
  --url https://api.maesn.dev/accounting/invoices \
  --header 'X-ACCOUNT-KEY: <x-account-key>' \
  --header 'X-API-KEY: <x-api-key>'
{
  "meta": {
    "warnings": [
      "Field not used by target system"
    ],
    "pagination": {
      "total": 123,
      "perPage": 123,
      "currentPage": 123,
      "totalPages": 123
    }
  },
  "data": [
    {
      "invoiceId": "9714f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b",
      "addresses": [
        {
          "addressLine1": "Main street 45",
          "addressLine2": "2nd floor",
          "city": "Berlin",
          "countryCode": "DE",
          "postalCode": "10243",
          "type": "BILLING"
        }
      ],
      "contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
      "createdDate": "2021-01-01T00:00:00Z",
      "currency": "EUR",
      "discountAmount": 10,
      "dueDate": "2021-02-01T00:00:00Z",
      "fileId": "93c6b8e0-80a4-4c22-a46c-18beebab82d6",
      "invoiceDate": "2021-01-01T00:00:00Z",
      "invoiceNumber": "1020",
      "invoiceType": "STANDARD",
      "journalCode": "50",
      "lineAmountType": "EXCLUSIVE",
      "lineItems": [
        {
          "lineItemId": "987a2b3c-4d5e-6f7g-8h9i-0j1k2l3m4n5o",
          "accountId": "6733a433-9662-4a40-8e36-e38ebda94fe1",
          "createdDate": "2021-01-01T00:00:00Z",
          "description": "SEOUL Guest Chair, red",
          "dimensions": [
            {
              "id": "c1d2e3f4-5678-9abc-def0-1234567890ab",
              "categoryName": "CostCenter",
              "name": "C1"
            }
          ],
          "discountItemAmount": 10,
          "discountItemPercentage": 10,
          "grossAmount": 109,
          "itemsAmount": 100,
          "itemId": "9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b",
          "name": "RED CHAIR",
          "quantity": 1,
          "taxCode": "03",
          "taxRatePercentage": 19,
          "unitAmount": 100,
          "updatedDate": "2021-01-01T00:00:00Z"
        }
      ],
      "name": "Office Supplies",
      "oneLineAddress": "Main street 45, Berlin",
      "paidDate": "2021-01-25T00:00:00Z",
      "paymentStatus": "PENDING",
      "paymentTermDuration": 30,
      "paymentTermId": "1",
      "reference": "RCXF197253F",
      "shippingDate": "2021-01-01T00:00:00Z",
      "status": "DRAFT",
      "sumNetAmount": 100,
      "taxRule": "NET",
      "totalAmount": 109,
      "totalTaxAmount": 19,
      "updatedDate": "2021-01-01T00:00:00Z"
    }
  ]
}

Field support per integration

Supported filters:
  • paymentStatus
Support pagination: trueSupport ordering: falseSupport rawData: true
Supported Response Fields:
invoiceId
string
invoiceNumber
string
invoiceDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
name
string
totalAmount
number
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.
Please ensure the query parameters environmentName and companyId are accurately populated with the appropriate environment and company ID. You can obtain these values by using the GET Environments and GET Companies endpoints available under the Authentication section.
Supported filters:
  • lastModifiedAt
  • status
Support pagination: trueSupport ordering: falseSupport rawData: true
Supported Response Fields:
invoiceId
string
invoiceNumber
string
contactId
string
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
status
enum
Available options: DRAFT, OPEN, PAID
updatedDate
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
addresses
Address[]
totalTaxAmount
number
discountAmount
number
sumNetAmount
number
totalAmount
number
dueDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
lineAmountType
enum
Available options: EXCLUSIVE, INCLUSIVE
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 filters:
  • lastModifiedAt
Support pagination: trueSupport rawData: true
Supported Response Fields:
invoiceId
string
contactId
string
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
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
discountAmount
number
dueDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
fileId
string
invoiceDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
invoiceNumber
string
invoiceType
enum
Available options: STANDARD
journalCode
string
name
string
paymentTermId
string
reference
string
status
enum
Available options: DRAFT, OPEN, SUBMITTED
sumNetAmount
number
totalAmount
number
totalTaxAmount
number
updatedDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
Supported filters:
  • lastModifiedAt
Support pagination: trueSupport rawData: true
Supported Response Fields:
invoiceId
string
contactId
string
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
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
journalCode
string
paidDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
paymentTermId
string
status
enum
Available options: VOIDED, DRAFT, PAID
totalAmount
number
Supported filters:
  • lastModifiedAt
It must be a timestamp in the form YYYY-MM-DDT00:00:00Z (milliseconds are not supported by lexoffice)
  • status
Support pagination: trueSupport ordering: falseSupport rawData: true
Supported Response Fields:
invoiceId
string
invoiceNumber
string
Unique alpha numeric code identifying the invoice.
name
string
contactId
string
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
status
enum
Available options: DRAFT, SUBMITTED, AUTHORISED, PAID, CANCELED
invoiceType
enum
Available options: STANDARD
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
updatedDate
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
dueDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
totalAmount
number
Supported filters:
  • lastModifiedAt
Support pagination: trueSupport ordering: falseSupport rawData: true
Supported Response Fields:
invoiceId
string
invoiceNumber
string
contactId
string
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
status
enum
Available options: OPEN, PAID
updatedDate
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
addresses
Address[]
lineItems
LineItem[]
totalTaxAmount
number
sumNetAmount
number
totalAmount
number
dueDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
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 filters:
  • lastModifiedAt
  • status
Support pagination: trueSupport ordering: falseSupport rawData: true
Supported Response Fields:
invoiceId
string
invoiceNumber
string
contactId
string
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
status
enum
Available options: DRAFT, SUBMITTED, VOIDED
paymentStatus
enum
Available options: PENDING, PAID, PARTLY_PAID, CANCELED, PARTIAL_CANCELLATION, BAD_DEBT, DEBITED
updatedDate
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
addresses
Address[]
lineItems
LineItem[]
totalTaxAmount
number
sumNetAmount
number
totalAmount
number
dueDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
Supported filters:
  • lastModifiedAt
  • status
Support pagination: trueSupport ordering: falseSupport rawData: true
Supported Response Fields:
invoiceId
string
invoiceNumber
string
Unique alpha numeric code identifying the invoice.
name
string
reference
string
Additional reference number. May be customer number, order number or similar.
contactId
string
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
status
enum
Available options: DRAFT, SUBMITTED, AUTHORISED, PAID, CANCELED
invoiceType
enum
Available options: STANDARD
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
updatedDate
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
dueDate
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
shippingDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
paymentTermDuration
number
oneLineAddress
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
discountAmount
number
totalTaxAmount
number
sumNetAmount
number
totalAmount
number
taxRule
enum
Available options:NET, TAXFREE, INTRACOMMUNITY_SERVICE, EXPORT_SERVICE, REVERSE_CHARGE, SMALL_BUSINESS_VAT_EXEMPTION , NON_DOMESTIC_SERVICE, OSS_GOODS, OSS_ELECTRONIC_SERVICES, OSS_SERVICES
lineAmountType
enum
Available options: EXCLUSIVE, INCLUSIVE, NOTAX
lineItems
LineItem[]
Supported filters:
  • lastModifiedAt
  • paymentStatus
  • status
Support pagination: trueSupport ordering: falseSupport rawData: true
Supported Response Fields:
invoiceId
string
addresses
Address[]
contactId
string
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
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
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[]
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
updatedDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
Supported filters:
  • paymentStatus
  • status
Support pagination: trueSupport ordering: trueSupport rawData: true
Supported Response Fields:
invoiceId
string
invoiceNumber
string
Unique alpha numeric code identifying the invoice.
name
string
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
status
enum
Available options: DRAFT, SUBMITTED, AUTHORISED, PAID, CANCELED, OPEN
invoiceType
enum
Available options: STANDARD
updatedDate
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
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
paymentStatus
enum
Available options: PENDING, PAID, PARTLY_PAID,CANCELED, PARTIAL_CANCELLATION, BAD_DEBT,DEBITED
lineAmountType
enum
Available options: EXCLUSIVE, INCLUSIVE, NOTAX
Please note, that the Xero API does not send back the discount values for the list endpoint.
Supported filters:
  • lastModifiedAt
  • status
Support pagination: trueSupport ordering: falseSupport rawData: true
Supported Response Fields:
invoiceId
string
invoiceNumber
string
Unique alpha numeric code identifying the invoice.
name
string
reference
string
Additional reference number. May be customer number, order number or similar.
contactId
string
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
status
enum
Available options: DRAFT, SUBMITTED, AUTHORISED, PAID, CANCELED
invoiceType
enum
Available options: STANDARD
updatedDate
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
dueDate
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
addresses
Address[]
discountAmount
number
totalTaxAmount
number
sumNetAmount
number
totalAmount
number
lineAmountType
enum
Available options: EXCLUSIVE, INCLUSIVE, NOTAX
lineItems
LineItem[]

Headers

X-API-KEY
string
required

API key

X-ACCOUNT-KEY
string
required

Account key

Query Parameters

page
number
limit
enum<number>
Available options:
5,
10,
20,
50,
100
orderDir
string
orderField
string
companyId
string
environmentName
string
lastModifiedAt
number
paymentStatus
string
status
string
rawData
boolean

Response

200 - application/json
meta
object
data
object[]