Get started
Integrations
Use cases
API reference
- Accounting
- Overview
- Accounts
- Async Task
- Bills
- Bill Lines
- Bookings
- Booking Proposals
- Contacts
- Customers
- Dimensions
- Expenses
- Files
- Invoices
- Invoice Lines
- Items
- Journals
- Journal Entries
- Offers
- Offer Lines
- Payments
- Payment Terms
- Projects
- Sales Orders
- Sales Order Lines
- Suppliers
- Tax Rates
- Transactions
- Vendor Credits
- Authentication
- Tenant Management
- User
Update vendorcredit
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": "1",
"addresses": [
{
"addressLine1": "Street",
"addressLine2": "Building",
"city": "City",
"postalCode": "12345",
"countryCode": "DE",
"type": "BILLING"
}
],
"contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
"currency": "EUR",
"deliveryDate": "2021-01-01T00:00:00Z",
"dueDate": "2021-01-01T00:00:00Z",
"journalCode": "10",
"lineItems": [
{
"id": "ea77eed16538deaafb0c4f1a2d3e5b8",
"accountId": "item id",
"accountNumber": "item id",
"description": "Line item description",
"itemId": "10",
"itemName": "Item name",
"quantity": 1,
"taxCode": "tax code",
"taxRatePercentage": 19,
"totalDiscountAmount": 10,
"totalDiscountPercentage": 10,
"totalGrossAmount": 119,
"totalNetAmount": 100,
"totalTaxAmount": 19,
"unitAmount": 100,
"unitDiscountAmount": 10,
"unitDiscountPercentage": 10,
"unitName": "Unit name"
}
],
"name": "Bill name",
"oneLineAddress": "Main street 45, Berlin",
"paidDate": "2021-01-01T00:00:00Z",
"paymentStatus": "PENDING",
"paymentDays": 30,
"reference": "REF-12345",
"shippingDate": "2021-01-01T00:00:00Z",
"shippingType": "SHIPPING",
"status": "DRAFT",
"taxRule": "NET",
"taxText": "Tax text",
"totalDiscountAmount": 0,
"totalDiscountPercentage": 0,
"totalGrossAmount": 109,
"totalNetAmount": 100,
"totalTaxAmount": 19,
"vendorCreditDate": "2021-01-01T00:00:00Z",
"vendorCreditNumber": "1"
}'
{
"meta": {
"warnings": [
"Field not used by target system"
],
"pagination": {
"total": 123,
"perPage": 123,
"currentPage": 123,
"totalPages": 123
}
},
"data": {
"id": "ABC123",
"accountId": "1",
"addresses": [
{
"addressLine1": "Street",
"addressLine2": "Building",
"city": "City",
"postalCode": "12345",
"countryCode": "DE",
"type": "BILLING"
}
],
"contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
"createdDate": "2021-01-01T00:00:00Z",
"currency": "EUR",
"deliveryDate": "2021-01-01T00:00:00Z",
"dueDate": "2021-01-01T00:00:00Z",
"journalCode": "10",
"lineItems": [
{
"id": "1",
"accountId": "item id",
"accountNumber": "item id",
"createdDate": "2021-01-01T00:00:00Z",
"description": "Line item description",
"dimensions": [
{
"name": "C1",
"categoryName": "CostCenter"
}
],
"itemId": "10",
"itemName": "Item name",
"quantity": 1,
"taxCode": "tax code",
"taxRatePercentage": 19,
"totalDiscountAmount": 10,
"totalDiscountPercentage": 10,
"totalGrossAmount": 119,
"totalNetAmount": 100,
"totalTaxAmount": 19,
"unitAmount": 100,
"unitDiscountAmount": 10,
"unitDiscountPercentage": 10,
"unitName": "Unit name",
"updatedDate": "2021-01-01T00:00:00Z"
}
],
"name": "Bill name",
"oneLineAddress": "Main street 45, Berlin",
"paidDate": "2021-01-01T00:00:00Z",
"paymentStatus": "PENDING",
"paymentDays": 30,
"reference": "REF-12345",
"shippingDate": "2021-01-01T00:00:00Z",
"shippingType": "SHIPPING",
"status": "DRAFT",
"taxRule": "NET",
"taxText": "Tax text",
"totalDiscountAmount": 0,
"totalDiscountPercentage": 0,
"totalGrossAmount": 109,
"totalNetAmount": 100,
"totalTaxAmount": 19,
"updatedDate": "2021-01-01T00:00:00Z",
"vendorCreditDate": "2021-01-01T00:00:00Z",
"vendorCreditNumber": "1"
}
}
Field support per integration
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:
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
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
Available options: BAD_DEBT
, PENDING
, PAID
Available options: OPEN
, PAID
, OVERDUE
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
Path Parameters
Body
Response
The response is of type object
.
Was this page helpful?
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": "1",
"addresses": [
{
"addressLine1": "Street",
"addressLine2": "Building",
"city": "City",
"postalCode": "12345",
"countryCode": "DE",
"type": "BILLING"
}
],
"contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
"currency": "EUR",
"deliveryDate": "2021-01-01T00:00:00Z",
"dueDate": "2021-01-01T00:00:00Z",
"journalCode": "10",
"lineItems": [
{
"id": "ea77eed16538deaafb0c4f1a2d3e5b8",
"accountId": "item id",
"accountNumber": "item id",
"description": "Line item description",
"itemId": "10",
"itemName": "Item name",
"quantity": 1,
"taxCode": "tax code",
"taxRatePercentage": 19,
"totalDiscountAmount": 10,
"totalDiscountPercentage": 10,
"totalGrossAmount": 119,
"totalNetAmount": 100,
"totalTaxAmount": 19,
"unitAmount": 100,
"unitDiscountAmount": 10,
"unitDiscountPercentage": 10,
"unitName": "Unit name"
}
],
"name": "Bill name",
"oneLineAddress": "Main street 45, Berlin",
"paidDate": "2021-01-01T00:00:00Z",
"paymentStatus": "PENDING",
"paymentDays": 30,
"reference": "REF-12345",
"shippingDate": "2021-01-01T00:00:00Z",
"shippingType": "SHIPPING",
"status": "DRAFT",
"taxRule": "NET",
"taxText": "Tax text",
"totalDiscountAmount": 0,
"totalDiscountPercentage": 0,
"totalGrossAmount": 109,
"totalNetAmount": 100,
"totalTaxAmount": 19,
"vendorCreditDate": "2021-01-01T00:00:00Z",
"vendorCreditNumber": "1"
}'
{
"meta": {
"warnings": [
"Field not used by target system"
],
"pagination": {
"total": 123,
"perPage": 123,
"currentPage": 123,
"totalPages": 123
}
},
"data": {
"id": "ABC123",
"accountId": "1",
"addresses": [
{
"addressLine1": "Street",
"addressLine2": "Building",
"city": "City",
"postalCode": "12345",
"countryCode": "DE",
"type": "BILLING"
}
],
"contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
"createdDate": "2021-01-01T00:00:00Z",
"currency": "EUR",
"deliveryDate": "2021-01-01T00:00:00Z",
"dueDate": "2021-01-01T00:00:00Z",
"journalCode": "10",
"lineItems": [
{
"id": "1",
"accountId": "item id",
"accountNumber": "item id",
"createdDate": "2021-01-01T00:00:00Z",
"description": "Line item description",
"dimensions": [
{
"name": "C1",
"categoryName": "CostCenter"
}
],
"itemId": "10",
"itemName": "Item name",
"quantity": 1,
"taxCode": "tax code",
"taxRatePercentage": 19,
"totalDiscountAmount": 10,
"totalDiscountPercentage": 10,
"totalGrossAmount": 119,
"totalNetAmount": 100,
"totalTaxAmount": 19,
"unitAmount": 100,
"unitDiscountAmount": 10,
"unitDiscountPercentage": 10,
"unitName": "Unit name",
"updatedDate": "2021-01-01T00:00:00Z"
}
],
"name": "Bill name",
"oneLineAddress": "Main street 45, Berlin",
"paidDate": "2021-01-01T00:00:00Z",
"paymentStatus": "PENDING",
"paymentDays": 30,
"reference": "REF-12345",
"shippingDate": "2021-01-01T00:00:00Z",
"shippingType": "SHIPPING",
"status": "DRAFT",
"taxRule": "NET",
"taxText": "Tax text",
"totalDiscountAmount": 0,
"totalDiscountPercentage": 0,
"totalGrossAmount": 109,
"totalNetAmount": 100,
"totalTaxAmount": 19,
"updatedDate": "2021-01-01T00:00:00Z",
"vendorCreditDate": "2021-01-01T00:00:00Z",
"vendorCreditNumber": "1"
}
}