Update vendorcredit

cURL

curl --request PUT \
  --url https://api.maesn.dev/accounting/vendorCredits/{vendorCreditId} \
  --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",
  "addresses": [
    {
      "addressLine1": "Main street 45",
      "addressLine2": "2nd floor",
      "city": "Berlin",
      "countryCode": "DE",
      "postalCode": "10243",
      "type": "BILLING"
    }
  ],
  "contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
  "currency": "EUR",
  "deliveryDate": "2021-01-01T00:00:00Z",
  "dueDate": "2021-02-01T00:00:00Z",
  "journalCode": "30",
  "lineItems": [
    {
      "id": "987a2b3c-4d5e-6f7g-8h9i-0j1k2l3m4n5o",
      "accountId": "6733a433-9662-4a40-8e36-e38ebda94fe1",
      "accountNumber": "200",
      "description": "SEOUL Guest Chair, red",
      "dimensions": [
        {
          "name": "C1",
          "categoryName": "CostCenter"
        }
      ],
      "itemId": "4f3a2hf4-5b8e-4d1b-8a0c-9f6e7d2f3e4b",
      "itemName": "RED CHAIR",
      "quantity": 1,
      "taxCode": "03",
      "taxRatePercentage": 19,
      "totalDiscountAmount": 10,
      "totalDiscountPercentage": 10,
      "totalGrossAmount": 109,
      "totalNetAmount": 100,
      "totalTaxAmount": 19,
      "unitAmount": 100,
      "unitDiscountAmount": 10,
      "unitDiscountPercentage": 10,
      "unitName": "PIECE"
    }
  ],
  "name": "Office Supplies",
  "oneLineAddress": "Main street 45, Berlin",
  "paidDate": "2021-01-25T00:00:00Z",
  "paymentDays": 30,
  "paymentStatus": "PENDING",
  "paymentTermId": "d2f3e4b5-6a7b-8c9d-0e1f-2g3h4i5j6k7l",
  "reference": "RCXF197253F",
  "shippingDate": "2021-01-01T00:00:00Z",
  "shippingType": "DELIVERY",
  "status": "DRAFT",
  "taxRule": "NET",
  "taxText": "Tax 19 percent",
  "totalDiscountAmount": 10,
  "totalDiscountPercentage": 10,
  "totalGrossAmount": 109,
  "totalNetAmount": 100,
  "totalTaxAmount": 19,
  "vendorCreditDate": "2021-01-01T00:00:00Z",
  "vendorCreditNumber": "1020"
}'

{
  "meta": {
    "warnings": [
      "Field not used by target system"
    ],
    "pagination": {
      "total": 123,
      "perPage": 123,
      "currentPage": 123,
      "totalPages": 123
    }
  },
  "data": {
    "id": "9714f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b",
    "accountId": "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",
    "createdDate": "2021-01-01T00:00:00Z",
    "currency": "EUR",
    "deliveryDate": "2021-01-01T00:00:00Z",
    "dueDate": "2021-02-01T00:00:00Z",
    "journalCode": "30",
    "lineItems": [
      {
        "id": "987a2b3c-4d5e-6f7g-8h9i-0j1k2l3m4n5o",
        "accountId": "6733a433-9662-4a40-8e36-e38ebda94fe1",
        "accountNumber": "200",
        "createdDate": "2021-01-01T00:00:00Z",
        "description": "SEOUL Guest Chair, red",
        "dimensions": [
          {
            "name": "C1",
            "categoryName": "CostCenter"
          }
        ],
        "itemId": "4f3a2hf4-5b8e-4d1b-8a0c-9f6e7d2f3e4b",
        "itemName": "RED CHAIR",
        "quantity": 1,
        "taxCode": "03",
        "taxRatePercentage": 19,
        "totalDiscountAmount": 10,
        "totalDiscountPercentage": 10,
        "totalGrossAmount": 109,
        "totalNetAmount": 100,
        "totalTaxAmount": 19,
        "unitAmount": 100,
        "unitDiscountAmount": 10,
        "unitDiscountPercentage": 10,
        "unitName": "PIECE",
        "updatedDate": "2021-01-01T00:00:00Z"
      }
    ],
    "name": "Office Supplies",
    "oneLineAddress": "Main street 45, Berlin",
    "paidDate": "2021-01-25T00:00:00Z",
    "paymentDays": 30,
    "paymentStatus": "PENDING",
    "paymentTermId": "d2f3e4b5-6a7b-8c9d-0e1f-2g3h4i5j6k7l",
    "reference": "RCXF197253F",
    "shippingDate": "2021-01-01T00:00:00Z",
    "shippingType": "DELIVERY",
    "status": "DRAFT",
    "taxRule": "NET",
    "taxText": "Tax 19 percent",
    "totalDiscountAmount": 10,
    "totalDiscountPercentage": 10,
    "totalGrossAmount": 109,
    "totalNetAmount": 100,
    "totalTaxAmount": 19,
    "updatedDate": "2021-01-01T00:00:00Z",
    "vendorCreditDate": "2021-01-01T00:00:00Z",
    "vendorCreditNumber": "1020"
  }
}

PUT

accounting

vendorCredits

{vendorCreditId}

cURL

curl --request PUT \
  --url https://api.maesn.dev/accounting/vendorCredits/{vendorCreditId} \
  --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",
  "addresses": [
    {
      "addressLine1": "Main street 45",
      "addressLine2": "2nd floor",
      "city": "Berlin",
      "countryCode": "DE",
      "postalCode": "10243",
      "type": "BILLING"
    }
  ],
  "contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
  "currency": "EUR",
  "deliveryDate": "2021-01-01T00:00:00Z",
  "dueDate": "2021-02-01T00:00:00Z",
  "journalCode": "30",
  "lineItems": [
    {
      "id": "987a2b3c-4d5e-6f7g-8h9i-0j1k2l3m4n5o",
      "accountId": "6733a433-9662-4a40-8e36-e38ebda94fe1",
      "accountNumber": "200",
      "description": "SEOUL Guest Chair, red",
      "dimensions": [
        {
          "name": "C1",
          "categoryName": "CostCenter"
        }
      ],
      "itemId": "4f3a2hf4-5b8e-4d1b-8a0c-9f6e7d2f3e4b",
      "itemName": "RED CHAIR",
      "quantity": 1,
      "taxCode": "03",
      "taxRatePercentage": 19,
      "totalDiscountAmount": 10,
      "totalDiscountPercentage": 10,
      "totalGrossAmount": 109,
      "totalNetAmount": 100,
      "totalTaxAmount": 19,
      "unitAmount": 100,
      "unitDiscountAmount": 10,
      "unitDiscountPercentage": 10,
      "unitName": "PIECE"
    }
  ],
  "name": "Office Supplies",
  "oneLineAddress": "Main street 45, Berlin",
  "paidDate": "2021-01-25T00:00:00Z",
  "paymentDays": 30,
  "paymentStatus": "PENDING",
  "paymentTermId": "d2f3e4b5-6a7b-8c9d-0e1f-2g3h4i5j6k7l",
  "reference": "RCXF197253F",
  "shippingDate": "2021-01-01T00:00:00Z",
  "shippingType": "DELIVERY",
  "status": "DRAFT",
  "taxRule": "NET",
  "taxText": "Tax 19 percent",
  "totalDiscountAmount": 10,
  "totalDiscountPercentage": 10,
  "totalGrossAmount": 109,
  "totalNetAmount": 100,
  "totalTaxAmount": 19,
  "vendorCreditDate": "2021-01-01T00:00:00Z",
  "vendorCreditNumber": "1020"
}'

{
  "meta": {
    "warnings": [
      "Field not used by target system"
    ],
    "pagination": {
      "total": 123,
      "perPage": 123,
      "currentPage": 123,
      "totalPages": 123
    }
  },
  "data": {
    "id": "9714f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b",
    "accountId": "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",
    "createdDate": "2021-01-01T00:00:00Z",
    "currency": "EUR",
    "deliveryDate": "2021-01-01T00:00:00Z",
    "dueDate": "2021-02-01T00:00:00Z",
    "journalCode": "30",
    "lineItems": [
      {
        "id": "987a2b3c-4d5e-6f7g-8h9i-0j1k2l3m4n5o",
        "accountId": "6733a433-9662-4a40-8e36-e38ebda94fe1",
        "accountNumber": "200",
        "createdDate": "2021-01-01T00:00:00Z",
        "description": "SEOUL Guest Chair, red",
        "dimensions": [
          {
            "name": "C1",
            "categoryName": "CostCenter"
          }
        ],
        "itemId": "4f3a2hf4-5b8e-4d1b-8a0c-9f6e7d2f3e4b",
        "itemName": "RED CHAIR",
        "quantity": 1,
        "taxCode": "03",
        "taxRatePercentage": 19,
        "totalDiscountAmount": 10,
        "totalDiscountPercentage": 10,
        "totalGrossAmount": 109,
        "totalNetAmount": 100,
        "totalTaxAmount": 19,
        "unitAmount": 100,
        "unitDiscountAmount": 10,
        "unitDiscountPercentage": 10,
        "unitName": "PIECE",
        "updatedDate": "2021-01-01T00:00:00Z"
      }
    ],
    "name": "Office Supplies",
    "oneLineAddress": "Main street 45, Berlin",
    "paidDate": "2021-01-25T00:00:00Z",
    "paymentDays": 30,
    "paymentStatus": "PENDING",
    "paymentTermId": "d2f3e4b5-6a7b-8c9d-0e1f-2g3h4i5j6k7l",
    "reference": "RCXF197253F",
    "shippingDate": "2021-01-01T00:00:00Z",
    "shippingType": "DELIVERY",
    "status": "DRAFT",
    "taxRule": "NET",
    "taxText": "Tax 19 percent",
    "totalDiscountAmount": 10,
    "totalDiscountPercentage": 10,
    "totalGrossAmount": 109,
    "totalNetAmount": 100,
    "totalTaxAmount": 19,
    "updatedDate": "2021-01-01T00:00:00Z",
    "vendorCreditDate": "2021-01-01T00:00:00Z",
    "vendorCreditNumber": "1020"
  }
}

Field support per integration

Exact

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 Request Parameters:

contactId

string

required

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

journalCode

string

required

lineItems

LineItem[]

required

Show properties

string

required

accountId

string

required

description

string

dimensions

Dimension[]

Show properties

name

string

required

categoryName

string

required

quantity

number

Note that quantity can be a decimal numeral.

taxCode

string

taxRatePercentage

number

totalNetAmount

number

The total amount for the item excluding tax.

When the taxCode is provided and is of type INCLUSIVE, then the totalNetAmount will be treated as a gross amount (i.e., including tax).

reference

string

paymentTermId

string

paymentStatus

enum

Available options: BAD_DEBT, PENDING, PAID

status

enum

Available options: OPEN, PAID, OVERDUE

vendorCreditDate

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

vendorCreditNumber

string

Headers

X-API-KEY

string

required

API key

X-ACCOUNT-KEY

string

required

Account key

Path Parameters

vendorCreditId

string

required

Query Parameters

companyId

string

environmentName

string

Body

application/json

accountId

string

Example:

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

addresses

object[]

Show child attributes

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"

deliveryDate

string

Example:

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

dueDate

string

Example:

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

journalCode

string

Example:

"30"

lineItems

object[]

Show child attributes

name

string

Example:

"Office Supplies"

oneLineAddress

string

Example:

"Main street 45, Berlin"

paidDate

string

Example:

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

paymentDays

number

Example:

30

paymentStatus

enum<string>

Available options:

NO_OPEN_ITEM,

PENDING,

PAID,

PARTLY_PAID,

CANCELED,

PARTIAL_CANCELLATION,

BAD_DEBT,

DEBITED,

CREDIT_NOTE_CLEARED,

CLEARED_WITH_CREDIT_NOTE,

UNKNOWN

Example:

"PENDING"

paymentTermId

string

Example:

"d2f3e4b5-6a7b-8c9d-0e1f-2g3h4i5j6k7l"

reference

string

Example:

"RCXF197253F"

shippingDate

string

Example:

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

shippingType

enum<string>

Available options:

SERVICE,

SERVICEPERIOD,

DELIVERY,

DELIVERYPERIOD,

NONE

Example:

"DELIVERY"

status

enum<string>

Available options:

DRAFT,

CORRECTIVE,

SUBMITTED,

DOCUMENT_CREATED,

OPEN,

PARTIALLY_PAID,

PAID,

PARTIALLY_OVERDUE,

OVERDUE,

VOIDED

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"

totalDiscountAmount

number

Example:

10

totalDiscountPercentage

number

Example:

10

totalGrossAmount

number

Example:

109

totalNetAmount

number

Example:

100

totalTaxAmount

number

Example:

19

vendorCreditDate

string

Example:

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

vendorCreditNumber

string

Example:

"1020"

Response

200 - application/json

Get started

Guides

Integrations

Use cases

API reference

Update vendorcredit

Field support per integration

Headers

Path Parameters

Query Parameters

Body

Response

Get started

Guides

Integrations

Use cases

API reference

​Field support per integration

Headers

Path Parameters

Query Parameters

Body

Response

Field support per integration