PATCH
/
accounting
/
invoices
/
{invoiceId}
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 '{
  "contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
  "name": "Invoice name",
  "reference": "REF-12345",
  "currency": "EUR",
  "invoiceDate": "2021-01-01T00:00:00Z",
  "status": "DRAFT",
  "invoiceType": "STANDARD",
  "oneLineAddress": "Main street 45, Berlin",
  "addresses": [
    {
      "addressLine1": "Street",
      "addressLine2": "Building",
      "city": "City",
      "postalCode": "12345",
      "countryCode": "DE",
      "type": "BILLING"
    }
  ],
  "countryCode": "DE",
  "taxRule": "NET",
  "taxText": "tax description",
  "lineItems": [
    {
      "lineItemId": "1",
      "itemId": "Item id",
      "name": "Line item name",
      "quantity": 1,
      "type": "SERVICE",
      "description": "Line item description",
      "unitName": "Unit name",
      "unitAmount": 100,
      "grossAmount": 119,
      "taxCode": "tax code",
      "TaxRatePercentage": 19,
      "taxType": "Tax type",
      "accountCode": "Account code",
      "discountItemPercentage": 10
    }
  ],
  "discountPercentage": 10,
  "shippingType": "SERVICE",
  "shippingDate": "2021-01-01T00:00:00Z",
  "shippingEndDate": "2021-01-10T00:00:00Z",
  "lineAmountTypes": "EXCLUSIVE",
  "dueDate": "2021-01-01T00:00:00Z",
  "paidDate": "2021-01-01T00:00:00Z",
  "paymentTermDuration": 30
}'
{
  "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"
      }
    ]
  }
}

Field support per integration

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

Response

200 - application/json

The response is of type object.