Patch invoice line

PATCH /accounting/invoices/{invoiceId}/lineItems/{lineItemId}

cURL

cURL

curl --request PATCH \
  --url https://api.maesn.dev/accounting/invoices/{invoiceId}/lineItems/{lineItemId} \
  --header 'Content-Type: application/json' \
  --header 'X-ACCOUNT-KEY: <x-account-key>' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "accountId": "6733a433-9662-4a40-8e36-e38ebda94fe1",
  "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
}
'

201

{
  "meta": {
    "warnings": [
      "Field not used by target system"
    ],
    "pagination": {
      "total": 125,
      "perPage": 50,
      "currentPage": 1,
      "totalPages": 3
    }
  },
  "data": {
    "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"
  }
}

Field support per integration

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:

description · string

discountItemAmount · number

discountItemPercentage · number

grossAmount · number

itemsAmount · number

itemId · string

quantity · number

Note that quantity can be a decimal numeral.

taxCode · string

taxRatePercentage · number

unitAmount · number

Headers

X-API-KEY · string · required

API key

X-ACCOUNT-KEY · string · required

Account key

Path Parameters

invoiceId · string · required

lineItemId · string · required

Query Parameters

companyId · string

environmentName · string

rawData · boolean

Body

application/json

accountId · string

Example:

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

description · string

Example:

"SEOUL Guest Chair, red"

dimensions · object[]

Show child attributes

discountItemAmount · number

Discount applied to the line item, in the document currency.

Example:

10

discountItemPercentage · number

Discount applied to the line item, as a percentage.

Example:

10

grossAmount · number

Gross amount of the line item — net plus tax (including VAT).

Example:

109

itemsAmount · number

Line subtotal — unit price multiplied by quantity, before discount and tax.

Example:

100

itemId · string

Example:

"9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b"

name · string

Example:

"RED CHAIR"

quantity · number

Example:

1

taxCode · string

Example:

"03"

taxRatePercentage · number

Example:

19

unitAmount · number

Price per unit, in the document currency.

Example:

100

Response

201 - application/json

meta · object

Show child attributes

data · object

Show child attributes