Get started
Integrations
Use cases
API reference
- Accounting
- Overview
- Accounts
- Async Task
- Batch
- 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
Create bookingproposal
curl --request POST \
--url https://api.maesn.dev/accounting/bookingProposals \
--header 'Content-Type: multipart/form-data' \
--header 'X-ACCOUNT-KEY: <x-account-key>' \
--header 'X-API-KEY: <x-api-key>' \
--form 'files=[
null
]' \
--form bookingType=INVOICE \
--form 'bookingProposal={
"id": "BP-12345",
"addresses ": [
{
"city": "city"
}
],
"bankAccountId": "5a6b7f5dw45c1c-403e-ad56-202fbc312414",
"bookingProposalDate": "2021-01-01T00:00:00Z",
"contactAccountNumber": "70000",
"contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
"contactName ": "John Doe",
"currency": "EUR",
"deliveryDate": "2021-01-01T00:00:00Z",
"dueDate": "2021-01-01T00:00:00Z",
"journalCode": "60",
"iban": "DE43100500000920018963",
"isPaymentOrder": "true",
"ledgerName": "Payroll",
"lineItems": [
{
"id": "Item-112233",
"accountCode": "200",
"accountId": "db32-4f56-8a9b-1234567890ab",
"accountName": "EXPENSE",
"accountNumber": "4900",
"bookingTaxCode": "9",
"description": "Item A",
"dimension1": "Marketing",
"dimension2": "Service and Maintenance",
"taxCode": "02",
"taxRatePercentage": "19",
"totalGrossAmount": "500",
"totalNetAmount": "450"
}
],
"notes": "Bill for maintenance services",
"number": "1233330",
"paidDate": "2021-01-01T00:00:00Z",
"paymentTermsId": "03",
"totalGrossAmount": "500",
"vatId": "DE987654321"
}'{
"meta": {
"warnings": [
"Field not used by target system"
],
"pagination": {
"total": 123,
"perPage": 123,
"currentPage": 123,
"totalPages": 123
}
},
"data": {
"id": "BP-12345",
"addresses ": [
{
"city": "city"
}
],
"bankAccountId": "5a6b7f5dw45c1c-403e-ad56-202fbc312414",
"bookingProposalDate": "2021-01-01T00:00:00Z",
"contactAccountNumber": "70000",
"contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
"contactName ": "John Doe",
"createdDate": "2021-01-01T00:00:00Z",
"currency": "EUR",
"deliveryDate": "2021-01-01T00:00:00Z",
"dueDate": "2021-01-01T00:00:00Z",
"files": [
"file1.pdf"
],
"journalCode": "60",
"iban": "DE43100500000920018963",
"isPaymentOrder": "true",
"ledgerName": "Payroll",
"lineItems": [
{
"id": "Item-112233",
"accountCode": "200",
"accountId": "db32-4f56-8a9b-1234567890ab",
"accountName": "EXPENSE",
"accountNumber": "4900",
"bookingTaxCode": "9",
"createdDate": "2021-01-01T00:00:00Z",
"description": "Item A",
"dimension1": "Marketing",
"dimension2": "Service and Maintenance",
"taxCode": "02",
"taxRatePercentage": "19",
"totalGrossAmount": "500",
"totalNetAmount": "450",
"updatedDate": "2021-01-01T00:00:00Z"
}
],
"notes": "Bill for maintenance services",
"number": "1233330",
"paidDate": "2021-01-01T00:00:00Z",
"paymentTermsId": "03",
"taskId": "ADHUR74BCBSW8399DCN",
"totalGrossAmount": "500",
"updatedDate": "2021-01-01T00:00:00Z",
"vatId": "DE987654321"
}
}Field support per integration
This endpoints is asynchronous. To check the status of the request, use the GET asyncTask endpoint.
For more info about asynchronous tasks visit the Asynchronous Task section.
If you’re not using the Interactive Authentication Flow, make sure the query parameter companyId is accurately populated with the appropriate company ID. You can obtain this value by using the GET Companies endpoint available under the Authentication section.
Supported Request Parameters:
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
The contactAccountNumber field represents the account number of the contact associated with the booking proposal.
It is the customer account number for INVOICE or the vendor account number for BILL.
The contactName field represents the name of the contact associated with the booking proposal.
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
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
The isPaymentOrder field determines whether a payment instruction (transfer for bills or direct debit for invoices) should
be automatically created when the booking proposal is processed
The ledgerName field represents the name of the correct ledger folder where the data will be sent to.
To get the correct name, you can use the GET Accounts endpoint.
The accountName field specifies the name of the general ledger account linked to the individual line item within the invoice or bill.
The accountNumber field specifies the general ledger account linked to the individual line item within the invoice or bill.
The dimension1 field represents the information for cost accounting (KOST1)
The dimension2 field represents the information for cost accounting (KOST2)
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
Available options: INVOICE, BILL
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:
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
The contactId field represents the id of the supplier associated with the booking proposal.
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
The accountId field specifies the id of the general ledger account linked to the individual line item within the booking proposal.
The dimension1 field represents the name of CostCenter category.
The dimension2 field represents the name of CostUnit category.
If the taxCode is not provided, it will be set to the default tax code for the account.
If the taxCode is provided and is of type INCLUSIVE, the totalNetAmount will be treated as a gross amount (i.e., including tax).
The paymentTermsId field represents the code of the payment term associated with the booking proposal.
To get the correct code, you can use the GET PaymentTerms endpoint.
Available options: BILL
Supported Request Parameters:
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
The contactId field represents the id of the contact associated with the booking proposal.
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
It is only supported for booking proposals of type INVOICE.
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
The accountId field specifies the id of the posting category in Lexware that represents the general ledger account linked to the individual line item within the booking proposal.
To get the correct accountId, you can use the GET Accounts endpoint.
Available options: BILL, INVOICE
Supported Request Parameters:
The bankAccountId field represents the id of the end user bank account associated with the booking proposal.
To get the correct id, you can use the GET Accounts endpoint. Only accounts of type BANK are accepted.
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
The contactId field represents the id of the contact associated with the booking proposal.
The number field represents the reference number for the booking proposal transaction.
Available options: BILL, INVOICE
Headers
API key
"example value"
Account key
"example value"
Query Parameters
Body
Response
The response is of type object.
Was this page helpful?
curl --request POST \
--url https://api.maesn.dev/accounting/bookingProposals \
--header 'Content-Type: multipart/form-data' \
--header 'X-ACCOUNT-KEY: <x-account-key>' \
--header 'X-API-KEY: <x-api-key>' \
--form 'files=[
null
]' \
--form bookingType=INVOICE \
--form 'bookingProposal={
"id": "BP-12345",
"addresses ": [
{
"city": "city"
}
],
"bankAccountId": "5a6b7f5dw45c1c-403e-ad56-202fbc312414",
"bookingProposalDate": "2021-01-01T00:00:00Z",
"contactAccountNumber": "70000",
"contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
"contactName ": "John Doe",
"currency": "EUR",
"deliveryDate": "2021-01-01T00:00:00Z",
"dueDate": "2021-01-01T00:00:00Z",
"journalCode": "60",
"iban": "DE43100500000920018963",
"isPaymentOrder": "true",
"ledgerName": "Payroll",
"lineItems": [
{
"id": "Item-112233",
"accountCode": "200",
"accountId": "db32-4f56-8a9b-1234567890ab",
"accountName": "EXPENSE",
"accountNumber": "4900",
"bookingTaxCode": "9",
"description": "Item A",
"dimension1": "Marketing",
"dimension2": "Service and Maintenance",
"taxCode": "02",
"taxRatePercentage": "19",
"totalGrossAmount": "500",
"totalNetAmount": "450"
}
],
"notes": "Bill for maintenance services",
"number": "1233330",
"paidDate": "2021-01-01T00:00:00Z",
"paymentTermsId": "03",
"totalGrossAmount": "500",
"vatId": "DE987654321"
}'{
"meta": {
"warnings": [
"Field not used by target system"
],
"pagination": {
"total": 123,
"perPage": 123,
"currentPage": 123,
"totalPages": 123
}
},
"data": {
"id": "BP-12345",
"addresses ": [
{
"city": "city"
}
],
"bankAccountId": "5a6b7f5dw45c1c-403e-ad56-202fbc312414",
"bookingProposalDate": "2021-01-01T00:00:00Z",
"contactAccountNumber": "70000",
"contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
"contactName ": "John Doe",
"createdDate": "2021-01-01T00:00:00Z",
"currency": "EUR",
"deliveryDate": "2021-01-01T00:00:00Z",
"dueDate": "2021-01-01T00:00:00Z",
"files": [
"file1.pdf"
],
"journalCode": "60",
"iban": "DE43100500000920018963",
"isPaymentOrder": "true",
"ledgerName": "Payroll",
"lineItems": [
{
"id": "Item-112233",
"accountCode": "200",
"accountId": "db32-4f56-8a9b-1234567890ab",
"accountName": "EXPENSE",
"accountNumber": "4900",
"bookingTaxCode": "9",
"createdDate": "2021-01-01T00:00:00Z",
"description": "Item A",
"dimension1": "Marketing",
"dimension2": "Service and Maintenance",
"taxCode": "02",
"taxRatePercentage": "19",
"totalGrossAmount": "500",
"totalNetAmount": "450",
"updatedDate": "2021-01-01T00:00:00Z"
}
],
"notes": "Bill for maintenance services",
"number": "1233330",
"paidDate": "2021-01-01T00:00:00Z",
"paymentTermsId": "03",
"taskId": "ADHUR74BCBSW8399DCN",
"totalGrossAmount": "500",
"updatedDate": "2021-01-01T00:00:00Z",
"vatId": "DE987654321"
}
}