Skip to main content
PATCH
/
accounting
/
invoices
/
{invoiceId}
cURL
curl --request PATCH \
  --url https://api.maesn.dev/accounting/invoices/{invoiceId} \
  --header 'Content-Type: application/json' \
  --header 'X-ACCOUNT-KEY: <x-account-key>' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '{
  "invoiceId": "6733a433-9662-4a40-8e36-e38ebda94fe1",
  "addresses": [
    {
      "addressLine1": "Main street 45",
      "addressLine2": "2nd floor",
      "city": "Berlin",
      "countryCode": "DE",
      "postalCode": "10243",
      "type": "BILLING"
    }
  ],
  "contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
  "currency": "EUR",
  "discountPercentage": 10,
  "dueDate": "2021-01-01T00:00:00Z",
  "fileId": "93c6b8e0-80a4-4c22-a46c-18beebab82d6",
  "invoiceDate": "2021-01-01T00:00:00Z",
  "invoiceType": "STANDARD",
  "journalCode": "50",
  "lineAmountTypes": "EXCLUSIVE",
  "lineItems": [
    {
      "accountCode": "1890",
      "accountId": "6733a433-9662-4a40-8e36-e38ebda94fe1",
      "description": "SEOUL Guest Chair, red",
      "dimensions": [
        {
          "id": "c1d2e3f4-5678-9abc-def0-1234567890ab",
          "categoryName": "CostCenter",
          "name": "C1"
        }
      ],
      "discountItemPercentage": 10,
      "grossAmount": 109,
      "itemId": "9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b",
      "name": "RED CHAIR",
      "quantity": 1,
      "taxCode": "03",
      "TaxRatePercentage": 19,
      "taxType": "Tax 19 percent",
      "type": "SERVICE",
      "unitAmount": 100,
      "unitName": "PIECE"
    }
  ],
  "name": "Invoice name",
  "oneLineAddress": "Main street 45, Berlin",
  "paidDate": "2021-01-01T00:00:00Z",
  "paymentTermDuration": 30,
  "paymentTermId": "1",
  "reference": "RCXF197253F",
  "shippingDate": "2021-01-01T00:00:00Z",
  "shippingEndDate": "2021-01-10T00:00:00Z",
  "shippingType": "SERVICE",
  "status": "DRAFT",
  "taxRule": "NET",
  "taxText": "Tax 19 percent"
}'
{
  "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

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
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[]

Headers

X-API-KEY
string
required

API key

X-ACCOUNT-KEY
string
required

Account key

Path Parameters

invoiceId
string
required

Query Parameters

companyId
string
environmentName
string

Body

application/json
invoiceId
string
Example:

"6733a433-9662-4a40-8e36-e38ebda94fe1"

addresses
object[]
contactId
string
Example:

"eaa28f49-6028-4b6e-bb12-d8f6278073fc"

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

"EUR"

discountPercentage
number
Example:

10

dueDate
string
Example:

"2021-01-01T00:00:00Z"

fileId
string
Example:

"93c6b8e0-80a4-4c22-a46c-18beebab82d6"

invoiceDate
string
Example:

"2021-01-01T00:00:00Z"

invoiceType
enum<string>
Available options:
STANDARD
Example:

"STANDARD"

journalCode
string
Example:

"50"

lineAmountTypes
enum<string>
Available options:
EXCLUSIVE,
INCLUSIVE,
NOTAX
Example:

"EXCLUSIVE"

lineItems
object[]
name
string
Example:

"Invoice name"

oneLineAddress
string
Example:

"Main street 45, Berlin"

paidDate
string
Example:

"2021-01-01T00:00:00Z"

paymentTermDuration
number
Example:

30

paymentTermId
string
Example:

"1"

reference
string
Example:

"RCXF197253F"

shippingDate
string
Example:

"2021-01-01T00:00:00Z"

shippingEndDate
string
Example:

"2021-01-10T00:00:00Z"

shippingType
enum<string>
Available options:
SERVICE,
SERVICEPERIOD,
DELIVERY,
DELIVERYPERIOD,
NONE
Example:

"SERVICE"

status
enum<string>
Available options:
DRAFT,
SUBMITTED,
AUTHORISED,
PAID,
CANCELED
Example:

"DRAFT"

taxRule
enum<string>
Available options:
NET,
TAXFREE,
INTRACOMMUNITY_GOODS,
INTRACOMMUNITY_SERVICE,
EXPORT_SERVICE,
EXPORT_GOODS,
REVERSE_CHARGE,
GROSS,
CONSTRUCTION_SERVICE,
PHOTOVOLTAIC_EQUIPMENT,
SMALL_BUSINESS_VAT_EXEMPTION,
NON_DOMESTIC_SERVICE,
OSS_GOODS,
OSS_ELECTRONIC_SERVICES,
OSS_SERVICES
Example:

"NET"

taxText
string
Example:

"Tax 19 percent"

Response

200 - application/json
meta
object
data
object
I