Get invoices

GET

accounting

invoices

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": "ABC123",
      "invoiceNumber": "1",
      "name": "Invoice name",
      "reference": "REF-12345",
      "contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
      "currency": "EUR",
      "status": "DRAFT",
      "invoiceType": "STANDARD",
      "updatedDate": "2021-01-01T00:00:00Z",
      "invoiceDate": "2021-01-01T00:00:00Z",
      "dueDate": "2021-01-01T00:00:00Z",
      "paidDate": "2021-01-01T00:00:00Z",
      "shippingDate": "2021-01-01T00:00:00Z",
      "createdDate": "2021-01-01T00:00:00Z",
      "paymentTermDuration": 30,
      "oneLineAddress": "Main street 45, Berlin",
      "addresses": [
        {
          "addressLine1": "Street",
          "addressLine2": "Building",
          "city": "City",
          "postalCode": "12345",
          "countryCode": "DE",
          "type": "BILLING"
        }
      ],
      "discountAmount": 10,
      "totalTaxAmount": 19,
      "sumNetAmount": 100,
      "totalAmount": 109,
      "paymentStatus": "PENDING",
      "taxRule": "NET",
      "lineAmountType": "EXCLUSIVE",
      "lineItems": [
        {
          "lineItemId": "1",
          "itemId": "item id",
          "name": "Line item name",
          "updatedDate": "2021-01-01T00:00:00Z",
          "createdDate": "2021-01-01T00:00:00Z",
          "quantity": 1,
          "taxRatePercentage": 19,
          "unitAmount": 100,
          "grossAmount": 119,
          "taxCode": "tax code",
          "itemsAmount": 100,
          "discountItemAmount": 10,
          "discountItemPercentage": 10,
          "description": "Line item description"
        }
      ]
    }
  ]
}

Test Api token:

663222ee

Test Account token:

85b30b51

Field support per integration

Please note that this endpoint does not retrieve the line items for the invoices. To obtain the line items of a specific invoice, please use the following endpoint: GET /accounting/invoices/{invoiceId}.

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:

status
lastModifiedAt

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

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

Supported filters:

status
paymentStatus

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:

status
lastModifiedAt

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, GROSS, FREETAX, INTRACOMMUNITY, CONSTRUCTIONSERVICE, EXTERNALSERVICE, THIRDPARTYCOUNTRYSERVICE , THIRDPARTYCOUNTRYDELIVERY, REVERSECHARGE, VATSALES, EXPORT, NONE

lineAmountType

enum

Available options: EXCLUSIVE, INCLUSIVE, NOTAX

lineItems

LineItem[]

Supported filters:

status

Supported Response Fields:

invoiceId

string

invoiceNumber

string

Unique alpha numeric code identifying the invoice.

name

string

currency

enum

Available options (3-letter ISO 4217):

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):

paymentStatus

enum

Available options: PENDING, PAID, PARTLY_PAID,CANCELED, PARTIAL_CANCELLATION, BAD_DEBT,DEBITED

lineAmountType

enum

Available options: EXCLUSIVE, INCLUSIVE, NOTAX

Supported filters:

status
lastModifiedAt
paymentStatus

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):

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

Please note, that the Xero API does not send back the discount values for the list endpoint.

Supported filters:

status
lastModifiedAt

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):

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

taxRule

enum

Available options:

NET, GROSS, FREETAX, INTRACOMMUNITY, CONSTRUCTIONSERVICE, EXTERNALSERVICE, THIRDPARTYCOUNTRYSERVICE , THIRDPARTYCOUNTRYDELIVERY, REVERSECHARGE, VATSALES, EXPORT, NONE

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

lastModifiedAt

number

rawData

boolean

environmentName

string

companyId

string

Response

200 - application/json

meta

object

data

object[]

data.invoiceId

string

data.invoiceNumber

string

data.name

string

data.reference

string

data.contactId

string

data.currency

enum<string>

Available options:

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

data.status

enum<string>

Available options:

DRAFT,

SUBMITTED,

AUTHORISED,

PAID,

CANCELED,

OPEN

data.invoiceType

enum<string>

Available options:

STANDARD

data.updatedDate

string

data.invoiceDate

string

data.dueDate

string

data.paidDate

string

data.shippingDate

string

data.createdDate

string

data.paymentTermDuration

number

data.oneLineAddress

string

data.addresses

object[]

data.discountAmount

number

data.totalTaxAmount

number

data.sumNetAmount

number

data.totalAmount

number

data.paymentStatus

enum<string>

Available options:

PENDING,

PAID,

PARTLY_PAID,

CANCELED,

PARTIAL_CANCELLATION,

BAD_DEBT,

DEBITED

data.taxRule

enum<string>

Available options:

NET,

GROSS,

FREETAX,

INTRACOMMUNITY,

CONSTRUCTIONSERVICE,

EXTERNALSERVICE,

THIRDPARTYCOUNTRYSERVICE,

THIRDPARTYCOUNTRYDELIVERY,

REVERSECHARGE,

VATSALES,

EXPORT,

NONE

data.lineAmountType

enum<string>

Available options:

EXCLUSIVE,

INCLUSIVE,

NOTAX

data.lineItems

object[]

Was this page helpful?

Get document extensions Get invoice

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": "ABC123",
      "invoiceNumber": "1",
      "name": "Invoice name",
      "reference": "REF-12345",
      "contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
      "currency": "EUR",
      "status": "DRAFT",
      "invoiceType": "STANDARD",
      "updatedDate": "2021-01-01T00:00:00Z",
      "invoiceDate": "2021-01-01T00:00:00Z",
      "dueDate": "2021-01-01T00:00:00Z",
      "paidDate": "2021-01-01T00:00:00Z",
      "shippingDate": "2021-01-01T00:00:00Z",
      "createdDate": "2021-01-01T00:00:00Z",
      "paymentTermDuration": 30,
      "oneLineAddress": "Main street 45, Berlin",
      "addresses": [
        {
          "addressLine1": "Street",
          "addressLine2": "Building",
          "city": "City",
          "postalCode": "12345",
          "countryCode": "DE",
          "type": "BILLING"
        }
      ],
      "discountAmount": 10,
      "totalTaxAmount": 19,
      "sumNetAmount": 100,
      "totalAmount": 109,
      "paymentStatus": "PENDING",
      "taxRule": "NET",
      "lineAmountType": "EXCLUSIVE",
      "lineItems": [
        {
          "lineItemId": "1",
          "itemId": "item id",
          "name": "Line item name",
          "updatedDate": "2021-01-01T00:00:00Z",
          "createdDate": "2021-01-01T00:00:00Z",
          "quantity": 1,
          "taxRatePercentage": 19,
          "unitAmount": 100,
          "grossAmount": 119,
          "taxCode": "tax code",
          "itemsAmount": 100,
          "discountItemAmount": 10,
          "discountItemPercentage": 10,
          "description": "Line item description"
        }
      ]
    }
  ]
}

Get started

Guides

Integrations

Use cases

API reference

Get invoices

Field support per integration

Headers

Query Parameters

Response

Get started

Guides

Integrations

Use cases

API reference

​Field support per integration

Headers

Query Parameters

Response

Field support per integration