Dibito REST API (1.1)
The Dibito REST API provides services to submit, verify and deliver eBills. The API is designed to be used by biller integrations.
Product Website
https://www.dibito.chAPI Key
This API requires an API key to be passed in the `X-API-Key` header.Generate your API key in the Dibito application under "Dibito -> API Keys".
Further Informations
Consult our documentation for futher informations about creating and handling eBills.https://app.dibito.ch/
Request
This operation accepts either a QR-Invoice PDF or a PDF in the eBill Format, containing the business case information as XML attachment included in the PDF. The specific business case type (bill, advice...) is specified in the XML attachment. Ideally the PDF conforms to the PDF/A-3b, if not, conversion is attempted. Please note that PDF format conversion may fail due to various technical reason.
Filename for the business case PDF. This is only used for analytical purposes and support. The filename is not visible for the bill recipient. Minimal length: 1
Maximal length: 99
- Generated server url
https://app.dibito.ch/api/v1/business-cases
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://app.dibito.ch/api/v1/business-cases?processingMode=STAGE' \
-H 'Content-Type: application/pdf' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-H 'x-anomaly-detection: string' \
-H 'x-filename: string' \
-d '[object Object]'
Request
This operation accepts a PDF along with the business case information, which is to be included as XML attachment. The provided PDF must not contain an XML attachment. Ideally the PDF conforms to the PDF/A-3b, if not, conversion is attempted. Please note that PDF format conversion may fail due to various technical reason.
- application/json
- application/xml
- Generated server url
https://app.dibito.ch/api/v1/business-cases/reminder
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://app.dibito.ch/api/v1/business-cases/reminder?processingMode=STAGE' \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-d '{
"pdf": "string",
"businessCase": {
"referenceNumber": "string",
"businessCaseDate": "2019-08-24",
"totalAmount": {
"value": 0,
"currencyCode": "string"
},
"referencedBill": {
"referenceNumber": "string"
},
"billRecipient": {
"emailAddress": "string",
"enterpriseIdentificationNumber": "string",
"billRecipientSixId": "string",
"name": "string",
"address": {
"structuredAddress": {
"street": "string",
"buildingNumber": "string",
"city": "string",
"postalCode": "string",
"countryCode": "string"
}
}
},
"singlePayment": {
"paymentMode": "EBILL",
"paymentInformation": {
"accountAndReference": {
"accountHolder": {
"name": "string",
"structuredAddress": {
"street": "string",
"buildingNumber": "string",
"city": "string",
"postalCode": "string",
"countryCode": "string"
}
},
"generic": {
"referenceType": "QRR",
"referenceStructured": "string",
"referenceUnstructured": "string",
"iban": "CH9300762011623852957"
}
},
"amount": {
"value": 0,
"currencyCode": "string"
},
"dueDate": "2019-08-24",
"payableAmountCanBeModified": true
}
},
"workflow": {
"vatEnterpriseIdentificationNumbers": {
"vatEnterpriseIdentificationNumber": [
"string"
]
},
"deliveryDateStart": "2019-08-24",
"deliveryDateEnd": "2019-08-24",
"netAmount": {
"value": 0,
"currencyCode": "string"
},
"amountPaid": {
"value": 0,
"currencyCode": "string"
},
"vatRates": {
"vatRate": [
{
"percentage": 0,
"taxBaseAmount": {
"value": 0,
"currencyCode": "string"
},
"taxAmount": {
"value": 0,
"currencyCode": "string"
}
}
]
},
"caseReferenceForBillRecipient": "string"
}
}
}'
Business case created
A unique SIX ID for this business case. Property must not be given when creating a new business case.
the type of the business case
A business case reference given by the biller. Must be unique in combination with the billerId.
The business case date (ISO-8601 format), can not be more than 90 days in the past on the date it was created. Cannot be in the future.
the processing status of the business case
An amount whose value may be omitted.
The amount value. Take care when using JavaScript libraries to parse this value - it should be treated as a financial amount and therefore not as a floating point number but rather using a precise decimal representation (like BigDecimal in Java). Maximum value: 99'999'999.99
Maximal length: 10
{ "id": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "type": "Bill", "billerSixId": "BIID0000123456", "referenceNumber": "2018-123456-22", "referencedBill": { "businessCaseSixId": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "referenceNumber": "2018-123456-22" }, "businessCaseDate": "Fri Dec 22 01:00:00 CET 2017", "status": "OPEN", "processingStatus": "STAGED", "totalAmount": { "value": 99.99, "currencyCode": "CHF" } }
Request
This operation accepts a PDF along with the business case information, which is to be included as XML attachment. The provided PDF must not contain an XML attachment. Ideally the PDF conforms to the PDF/A-3b, if not, conversion is attempted. Please note that PDF format conversion may fail due to various technical reason.
Reminder
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
- max. 99'999'999.99 for invoices, payments by instalments, reminders, credit notes and donation inquiries
- min. - 99'999'999.99, max 99'999'999.99 for advices
- Amount must be greater than 0 for invoices, payments by instalments, reminders and donation inquiries.
- Amount must be ≥ 0 for credit notes.
- If an IBAN or QR-IBAN is used for invoices or payments by instalments, the amount does not have to be supplied (compatibility QR invoice).
Information about the account and reference of the invoice issuer.
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
- max. 99'999'999.99 for invoices, payments by instalments, reminders, credit notes and donation inquiries
- min. - 99'999'999.99, max 99'999'999.99 for advices
- Amount must be greater than 0 for invoices, payments by instalments, reminders and donation inquiries.
- Amount must be ≥ 0 for credit notes.
- If an IBAN or QR-IBAN is used for invoices or payments by instalments, the amount does not have to be supplied (compatibility QR invoice).
Due date. In the case of donation inquiries, the due date acts as a proposal for the payment date.
At time of submission, cannot be set to more than 3 years in the future (1095 days) for payment mode ebill. At time of submission, cannot be set to more than 30 days in the future for payment mode ebill debit. At time of submission, cannot be older than 90 days.
- Generated server url
https://app.dibito.ch/api/v1/business-cases/reminder/multipart
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://app.dibito.ch/api/v1/business-cases/reminder/multipart?processingMode=STAGE' \
-H 'Content-Type: multipart/form-data' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-F file=string \
-F 'reminder[referenceNumber]=string' \
-F 'reminder[businessCaseDate]=2019-08-24' \
-F 'reminder[totalAmount][value]=0' \
-F 'reminder[totalAmount][currencyCode]=string' \
-F 'reminder[referencedBill][referenceNumber]=string' \
-F 'reminder[billRecipient][emailAddress]=string' \
-F 'reminder[billRecipient][enterpriseIdentificationNumber]=string' \
-F 'reminder[billRecipient][billRecipientSixId]=string' \
-F 'reminder[billRecipient][name]=string' \
-F 'reminder[billRecipient][address][structuredAddress][street]=string' \
-F 'reminder[billRecipient][address][structuredAddress][buildingNumber]=string' \
-F 'reminder[billRecipient][address][structuredAddress][city]=string' \
-F 'reminder[billRecipient][address][structuredAddress][postalCode]=string' \
-F 'reminder[billRecipient][address][structuredAddress][countryCode]=string' \
-F 'reminder[singlePayment][paymentMode]=EBILL' \
-F 'reminder[singlePayment][paymentInformation][accountAndReference][accountHolder][name]=string' \
-F 'reminder[singlePayment][paymentInformation][accountAndReference][accountHolder][structuredAddress][street]=string' \
-F 'reminder[singlePayment][paymentInformation][accountAndReference][accountHolder][structuredAddress][buildingNumber]=string' \
-F 'reminder[singlePayment][paymentInformation][accountAndReference][accountHolder][structuredAddress][city]=string' \
-F 'reminder[singlePayment][paymentInformation][accountAndReference][accountHolder][structuredAddress][postalCode]=string' \
-F 'reminder[singlePayment][paymentInformation][accountAndReference][accountHolder][structuredAddress][countryCode]=string' \
-F 'reminder[singlePayment][paymentInformation][accountAndReference][generic][referenceType]=QRR' \
-F 'reminder[singlePayment][paymentInformation][accountAndReference][generic][referenceStructured]=string' \
-F 'reminder[singlePayment][paymentInformation][accountAndReference][generic][referenceUnstructured]=string' \
-F 'reminder[singlePayment][paymentInformation][accountAndReference][generic][iban]=CH9300762011623852957' \
-F 'reminder[singlePayment][paymentInformation][amount][value]=0' \
-F 'reminder[singlePayment][paymentInformation][amount][currencyCode]=string' \
-F 'reminder[singlePayment][paymentInformation][dueDate]=2019-08-24' \
-F 'reminder[singlePayment][paymentInformation][payableAmountCanBeModified]=true' \
-F 'reminder[workflow][vatEnterpriseIdentificationNumbers][vatEnterpriseIdentificationNumber]=string' \
-F 'reminder[workflow][deliveryDateStart]=2019-08-24' \
-F 'reminder[workflow][deliveryDateEnd]=2019-08-24' \
-F 'reminder[workflow][netAmount][value]=0' \
-F 'reminder[workflow][netAmount][currencyCode]=string' \
-F 'reminder[workflow][amountPaid][value]=0' \
-F 'reminder[workflow][amountPaid][currencyCode]=string' \
-F 'reminder[workflow][vatRates][vatRate][0][percentage]=0' \
-F 'reminder[workflow][vatRates][vatRate][0][taxBaseAmount][value]=0' \
-F 'reminder[workflow][vatRates][vatRate][0][taxBaseAmount][currencyCode]=string' \
-F 'reminder[workflow][vatRates][vatRate][0][taxAmount][value]=0' \
-F 'reminder[workflow][vatRates][vatRate][0][taxAmount][currencyCode]=string' \
-F 'reminder[workflow][caseReferenceForBillRecipient]=string'
Business case created
A unique SIX ID for this business case. Property must not be given when creating a new business case.
the type of the business case
A business case reference given by the biller. Must be unique in combination with the billerId.
The business case date (ISO-8601 format), can not be more than 90 days in the past on the date it was created. Cannot be in the future.
the processing status of the business case
An amount whose value may be omitted.
The amount value. Take care when using JavaScript libraries to parse this value - it should be treated as a financial amount and therefore not as a floating point number but rather using a precise decimal representation (like BigDecimal in Java). Maximum value: 99'999'999.99
Maximal length: 10
{ "id": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "type": "Bill", "billerSixId": "BIID0000123456", "referenceNumber": "2018-123456-22", "referencedBill": { "businessCaseSixId": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "referenceNumber": "2018-123456-22" }, "businessCaseDate": "Fri Dec 22 01:00:00 CET 2017", "status": "OPEN", "processingStatus": "STAGED", "totalAmount": { "value": 99.99, "currencyCode": "CHF" } }
Request
This operation accepts a PDF along with the business case information, which is to be included as XML attachment. The provided PDF must not contain an XML attachment. Ideally the PDF conforms to the PDF/A-3b, if not, conversion is attempted. Please note that PDF format conversion may fail due to various technical reason.
- application/json
- application/xml
- Generated server url
https://app.dibito.ch/api/v1/business-cases/instalment-bill
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://app.dibito.ch/api/v1/business-cases/instalment-bill?processingMode=STAGE' \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-d '{
"pdf": "string",
"businessCase": {
"referenceNumber": "string",
"businessCaseDate": "2019-08-24",
"totalAmount": {
"value": 0,
"currencyCode": "string"
},
"referencedBill": {
"referenceNumber": "string"
},
"billRecipient": {
"emailAddress": "string",
"enterpriseIdentificationNumber": "string",
"billRecipientSixId": "string",
"name": "string",
"address": {
"structuredAddress": {
"street": "string",
"buildingNumber": "string",
"city": "string",
"postalCode": "string",
"countryCode": "string"
}
}
},
"paymentsByInstalments": {
"paymentByInstalments": [
{
"externalPaymentByInstalmentsId": "string",
"description": "string",
"isTotalAmountHidden": true,
"isTotalPaymentOption": true,
"instalments": {
"instalment": [
{}
]
}
}
]
},
"workflow": {
"vatEnterpriseIdentificationNumbers": {
"vatEnterpriseIdentificationNumber": [
"string"
]
},
"deliveryDateStart": "2019-08-24",
"deliveryDateEnd": "2019-08-24",
"netAmount": {
"value": 0,
"currencyCode": "string"
},
"amountPaid": {
"value": 0,
"currencyCode": "string"
},
"vatRates": {
"vatRate": [
{
"percentage": 0,
"taxBaseAmount": {
"value": 0,
"currencyCode": "string"
},
"taxAmount": {
"value": 0,
"currencyCode": "string"
}
}
]
},
"caseReferenceForBillRecipient": "string"
}
}
}'
Business case created
A unique SIX ID for this business case. Property must not be given when creating a new business case.
the type of the business case
A business case reference given by the biller. Must be unique in combination with the billerId.
The business case date (ISO-8601 format), can not be more than 90 days in the past on the date it was created. Cannot be in the future.
the processing status of the business case
An amount whose value may be omitted.
The amount value. Take care when using JavaScript libraries to parse this value - it should be treated as a financial amount and therefore not as a floating point number but rather using a precise decimal representation (like BigDecimal in Java). Maximum value: 99'999'999.99
Maximal length: 10
{ "id": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "type": "Bill", "billerSixId": "BIID0000123456", "referenceNumber": "2018-123456-22", "referencedBill": { "businessCaseSixId": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "referenceNumber": "2018-123456-22" }, "businessCaseDate": "Fri Dec 22 01:00:00 CET 2017", "status": "OPEN", "processingStatus": "STAGED", "totalAmount": { "value": 99.99, "currencyCode": "CHF" } }
Request
This operation accepts a PDF along with the business case information, which is to be included as XML attachment. The provided PDF must not contain an XML attachment. Ideally the PDF conforms to the PDF/A-3b, if not, conversion is attempted. Please note that PDF format conversion may fail due to various technical reason.
Instalment Bill
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
- max. 99'999'999.99 for invoices, payments by instalments, reminders, credit notes and donation inquiries
- min. - 99'999'999.99, max 99'999'999.99 for advices
- Amount must be greater than 0 for invoices, payments by instalments, reminders and donation inquiries.
- Amount must be ≥ 0 for credit notes.
- If an IBAN or QR-IBAN is used for invoices or payments by instalments, the amount does not have to be supplied (compatibility QR invoice).
- Generated server url
https://app.dibito.ch/api/v1/business-cases/instalment-bill/multipart
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://app.dibito.ch/api/v1/business-cases/instalment-bill/multipart?processingMode=STAGE' \
-H 'Content-Type: multipart/form-data' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-F file=string \
-F 'instalmentBill[referenceNumber]=string' \
-F 'instalmentBill[businessCaseDate]=2019-08-24' \
-F 'instalmentBill[totalAmount][value]=0' \
-F 'instalmentBill[totalAmount][currencyCode]=string' \
-F 'instalmentBill[referencedBill][referenceNumber]=string' \
-F 'instalmentBill[billRecipient][emailAddress]=string' \
-F 'instalmentBill[billRecipient][enterpriseIdentificationNumber]=string' \
-F 'instalmentBill[billRecipient][billRecipientSixId]=string' \
-F 'instalmentBill[billRecipient][name]=string' \
-F 'instalmentBill[billRecipient][address][structuredAddress][street]=string' \
-F 'instalmentBill[billRecipient][address][structuredAddress][buildingNumber]=string' \
-F 'instalmentBill[billRecipient][address][structuredAddress][city]=string' \
-F 'instalmentBill[billRecipient][address][structuredAddress][postalCode]=string' \
-F 'instalmentBill[billRecipient][address][structuredAddress][countryCode]=string' \
-F 'instalmentBill[paymentsByInstalments][paymentByInstalments][0][externalPaymentByInstalmentsId]=string' \
-F 'instalmentBill[paymentsByInstalments][paymentByInstalments][0][description]=string' \
-F 'instalmentBill[paymentsByInstalments][paymentByInstalments][0][isTotalAmountHidden]=true' \
-F 'instalmentBill[paymentsByInstalments][paymentByInstalments][0][isTotalPaymentOption]=true' \
-F 'instalmentBill[paymentsByInstalments][paymentByInstalments][0][instalments][instalment][0][externalInstalmentId]=undefined' \
-F 'instalmentBill[paymentsByInstalments][paymentByInstalments][0][instalments][instalment][0][description]=undefined' \
-F 'instalmentBill[paymentsByInstalments][paymentByInstalments][0][instalments][instalment][0][paymentInformation]=undefined' \
-F 'instalmentBill[workflow][vatEnterpriseIdentificationNumbers][vatEnterpriseIdentificationNumber]=string' \
-F 'instalmentBill[workflow][deliveryDateStart]=2019-08-24' \
-F 'instalmentBill[workflow][deliveryDateEnd]=2019-08-24' \
-F 'instalmentBill[workflow][netAmount][value]=0' \
-F 'instalmentBill[workflow][netAmount][currencyCode]=string' \
-F 'instalmentBill[workflow][amountPaid][value]=0' \
-F 'instalmentBill[workflow][amountPaid][currencyCode]=string' \
-F 'instalmentBill[workflow][vatRates][vatRate][0][percentage]=0' \
-F 'instalmentBill[workflow][vatRates][vatRate][0][taxBaseAmount][value]=0' \
-F 'instalmentBill[workflow][vatRates][vatRate][0][taxBaseAmount][currencyCode]=string' \
-F 'instalmentBill[workflow][vatRates][vatRate][0][taxAmount][value]=0' \
-F 'instalmentBill[workflow][vatRates][vatRate][0][taxAmount][currencyCode]=string' \
-F 'instalmentBill[workflow][caseReferenceForBillRecipient]=string'
Business case created
A unique SIX ID for this business case. Property must not be given when creating a new business case.
the type of the business case
A business case reference given by the biller. Must be unique in combination with the billerId.
The business case date (ISO-8601 format), can not be more than 90 days in the past on the date it was created. Cannot be in the future.
the processing status of the business case
An amount whose value may be omitted.
The amount value. Take care when using JavaScript libraries to parse this value - it should be treated as a financial amount and therefore not as a floating point number but rather using a precise decimal representation (like BigDecimal in Java). Maximum value: 99'999'999.99
Maximal length: 10
{ "id": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "type": "Bill", "billerSixId": "BIID0000123456", "referenceNumber": "2018-123456-22", "referencedBill": { "businessCaseSixId": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "referenceNumber": "2018-123456-22" }, "businessCaseDate": "Fri Dec 22 01:00:00 CET 2017", "status": "OPEN", "processingStatus": "STAGED", "totalAmount": { "value": 99.99, "currencyCode": "CHF" } }
Request
This operation accepts a PDF along with the business case information, which is to be included as XML attachment. The provided PDF must not contain an XML attachment. Ideally the PDF conforms to the PDF/A-3b, if not, conversion is attempted. Please note that PDF format conversion may fail due to various technical reason.
- application/json
- application/xml
- Generated server url
https://app.dibito.ch/api/v1/business-cases/donation-inquiry
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://app.dibito.ch/api/v1/business-cases/donation-inquiry?processingMode=STAGE' \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-d '{
"pdf": "string",
"businessCase": {
"referenceNumber": "string",
"businessCaseDate": "2019-08-24",
"totalAmount": {
"value": 0,
"currencyCode": "string"
},
"referencedBill": {
"referenceNumber": "string"
},
"billRecipient": {
"emailAddress": "string",
"enterpriseIdentificationNumber": "string",
"billRecipientSixId": "string",
"name": "string",
"address": {
"structuredAddress": {
"street": "string",
"buildingNumber": "string",
"city": "string",
"postalCode": "string",
"countryCode": "string"
}
}
},
"singlePayment": {
"paymentMode": "EBILL",
"paymentInformation": {
"accountAndReference": {
"accountHolder": {
"name": "string",
"structuredAddress": {
"street": "string",
"buildingNumber": "string",
"city": "string",
"postalCode": "string",
"countryCode": "string"
}
},
"generic": {
"referenceType": "QRR",
"referenceStructured": "string",
"referenceUnstructured": "string",
"iban": "CH9300762011623852957"
}
},
"amount": {
"value": 0,
"currencyCode": "string"
},
"dueDate": "2019-08-24",
"payableAmountCanBeModified": true
}
},
"proposedDonationAmounts": {
"proposedDonationAmount": [
{
"value": 0,
"currencyCode": "string"
}
]
},
"donationPurposes": {
"donationPurpose": [
{
"externalDonationPurposeId": "string",
"label": "string"
}
]
},
"workflow": {
"vatEnterpriseIdentificationNumbers": {
"vatEnterpriseIdentificationNumber": [
"string"
]
},
"deliveryDateStart": "2019-08-24",
"deliveryDateEnd": "2019-08-24",
"netAmount": {
"value": 0,
"currencyCode": "string"
},
"amountPaid": {
"value": 0,
"currencyCode": "string"
},
"vatRates": {
"vatRate": [
{
"percentage": 0,
"taxBaseAmount": {
"value": 0,
"currencyCode": "string"
},
"taxAmount": {
"value": 0,
"currencyCode": "string"
}
}
]
},
"caseReferenceForBillRecipient": "string"
}
}
}'
Business case created
A unique SIX ID for this business case. Property must not be given when creating a new business case.
the type of the business case
A business case reference given by the biller. Must be unique in combination with the billerId.
The business case date (ISO-8601 format), can not be more than 90 days in the past on the date it was created. Cannot be in the future.
the processing status of the business case
An amount whose value may be omitted.
The amount value. Take care when using JavaScript libraries to parse this value - it should be treated as a financial amount and therefore not as a floating point number but rather using a precise decimal representation (like BigDecimal in Java). Maximum value: 99'999'999.99
Maximal length: 10
{ "id": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "type": "Bill", "billerSixId": "BIID0000123456", "referenceNumber": "2018-123456-22", "referencedBill": { "businessCaseSixId": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "referenceNumber": "2018-123456-22" }, "businessCaseDate": "Fri Dec 22 01:00:00 CET 2017", "status": "OPEN", "processingStatus": "STAGED", "totalAmount": { "value": 99.99, "currencyCode": "CHF" } }
Request
This operation accepts a PDF along with the business case information, which is to be included as XML attachment. The provided PDF must not contain an XML attachment. Ideally the PDF conforms to the PDF/A-3b, if not, conversion is attempted. Please note that PDF format conversion may fail due to various technical reason.
Donation Inquiry
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
- max. 99'999'999.99 for invoices, payments by instalments, reminders, credit notes and donation inquiries
- min. - 99'999'999.99, max 99'999'999.99 for advices
- Amount must be greater than 0 for invoices, payments by instalments, reminders and donation inquiries.
- Amount must be ≥ 0 for credit notes.
- If an IBAN or QR-IBAN is used for invoices or payments by instalments, the amount does not have to be supplied (compatibility QR invoice).
Information about the account and reference of the invoice issuer.
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
- max. 99'999'999.99 for invoices, payments by instalments, reminders, credit notes and donation inquiries
- min. - 99'999'999.99, max 99'999'999.99 for advices
- Amount must be greater than 0 for invoices, payments by instalments, reminders and donation inquiries.
- Amount must be ≥ 0 for credit notes.
- If an IBAN or QR-IBAN is used for invoices or payments by instalments, the amount does not have to be supplied (compatibility QR invoice).
Due date. In the case of donation inquiries, the due date acts as a proposal for the payment date.
At time of submission, cannot be set to more than 3 years in the future (1095 days) for payment mode ebill. At time of submission, cannot be set to more than 30 days in the future for payment mode ebill debit. At time of submission, cannot be older than 90 days.
- Generated server url
https://app.dibito.ch/api/v1/business-cases/donation-inquiry/multipart
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://app.dibito.ch/api/v1/business-cases/donation-inquiry/multipart?processingMode=STAGE' \
-H 'Content-Type: multipart/form-data' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-F file=string \
-F 'donationInquiry[referenceNumber]=string' \
-F 'donationInquiry[businessCaseDate]=2019-08-24' \
-F 'donationInquiry[totalAmount][value]=0' \
-F 'donationInquiry[totalAmount][currencyCode]=string' \
-F 'donationInquiry[referencedBill][referenceNumber]=string' \
-F 'donationInquiry[billRecipient][emailAddress]=string' \
-F 'donationInquiry[billRecipient][enterpriseIdentificationNumber]=string' \
-F 'donationInquiry[billRecipient][billRecipientSixId]=string' \
-F 'donationInquiry[billRecipient][name]=string' \
-F 'donationInquiry[billRecipient][address][structuredAddress][street]=string' \
-F 'donationInquiry[billRecipient][address][structuredAddress][buildingNumber]=string' \
-F 'donationInquiry[billRecipient][address][structuredAddress][city]=string' \
-F 'donationInquiry[billRecipient][address][structuredAddress][postalCode]=string' \
-F 'donationInquiry[billRecipient][address][structuredAddress][countryCode]=string' \
-F 'donationInquiry[singlePayment][paymentMode]=EBILL' \
-F 'donationInquiry[singlePayment][paymentInformation][accountAndReference][accountHolder][name]=string' \
-F 'donationInquiry[singlePayment][paymentInformation][accountAndReference][accountHolder][structuredAddress][street]=string' \
-F 'donationInquiry[singlePayment][paymentInformation][accountAndReference][accountHolder][structuredAddress][buildingNumber]=string' \
-F 'donationInquiry[singlePayment][paymentInformation][accountAndReference][accountHolder][structuredAddress][city]=string' \
-F 'donationInquiry[singlePayment][paymentInformation][accountAndReference][accountHolder][structuredAddress][postalCode]=string' \
-F 'donationInquiry[singlePayment][paymentInformation][accountAndReference][accountHolder][structuredAddress][countryCode]=string' \
-F 'donationInquiry[singlePayment][paymentInformation][accountAndReference][generic][referenceType]=QRR' \
-F 'donationInquiry[singlePayment][paymentInformation][accountAndReference][generic][referenceStructured]=string' \
-F 'donationInquiry[singlePayment][paymentInformation][accountAndReference][generic][referenceUnstructured]=string' \
-F 'donationInquiry[singlePayment][paymentInformation][accountAndReference][generic][iban]=CH9300762011623852957' \
-F 'donationInquiry[singlePayment][paymentInformation][amount][value]=0' \
-F 'donationInquiry[singlePayment][paymentInformation][amount][currencyCode]=string' \
-F 'donationInquiry[singlePayment][paymentInformation][dueDate]=2019-08-24' \
-F 'donationInquiry[singlePayment][paymentInformation][payableAmountCanBeModified]=true' \
-F 'donationInquiry[proposedDonationAmounts][proposedDonationAmount][0][value]=0' \
-F 'donationInquiry[proposedDonationAmounts][proposedDonationAmount][0][currencyCode]=string' \
-F 'donationInquiry[donationPurposes][donationPurpose][0][externalDonationPurposeId]=string' \
-F 'donationInquiry[donationPurposes][donationPurpose][0][label]=string' \
-F 'donationInquiry[workflow][vatEnterpriseIdentificationNumbers][vatEnterpriseIdentificationNumber]=string' \
-F 'donationInquiry[workflow][deliveryDateStart]=2019-08-24' \
-F 'donationInquiry[workflow][deliveryDateEnd]=2019-08-24' \
-F 'donationInquiry[workflow][netAmount][value]=0' \
-F 'donationInquiry[workflow][netAmount][currencyCode]=string' \
-F 'donationInquiry[workflow][amountPaid][value]=0' \
-F 'donationInquiry[workflow][amountPaid][currencyCode]=string' \
-F 'donationInquiry[workflow][vatRates][vatRate][0][percentage]=0' \
-F 'donationInquiry[workflow][vatRates][vatRate][0][taxBaseAmount][value]=0' \
-F 'donationInquiry[workflow][vatRates][vatRate][0][taxBaseAmount][currencyCode]=string' \
-F 'donationInquiry[workflow][vatRates][vatRate][0][taxAmount][value]=0' \
-F 'donationInquiry[workflow][vatRates][vatRate][0][taxAmount][currencyCode]=string' \
-F 'donationInquiry[workflow][caseReferenceForBillRecipient]=string'
Business case created
A unique SIX ID for this business case. Property must not be given when creating a new business case.
the type of the business case
A business case reference given by the biller. Must be unique in combination with the billerId.
The business case date (ISO-8601 format), can not be more than 90 days in the past on the date it was created. Cannot be in the future.
the processing status of the business case
An amount whose value may be omitted.
The amount value. Take care when using JavaScript libraries to parse this value - it should be treated as a financial amount and therefore not as a floating point number but rather using a precise decimal representation (like BigDecimal in Java). Maximum value: 99'999'999.99
Maximal length: 10
{ "id": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "type": "Bill", "billerSixId": "BIID0000123456", "referenceNumber": "2018-123456-22", "referencedBill": { "businessCaseSixId": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "referenceNumber": "2018-123456-22" }, "businessCaseDate": "Fri Dec 22 01:00:00 CET 2017", "status": "OPEN", "processingStatus": "STAGED", "totalAmount": { "value": 99.99, "currencyCode": "CHF" } }
Request
This operation accepts a PDF along with the business case information, which is to be included as XML attachment. The provided PDF must not contain an XML attachment. Ideally the PDF conforms to the PDF/A-3b, if not, conversion is attempted. Please note that PDF format conversion may fail due to various technical reason.
- application/json
- application/xml
- Generated server url
https://app.dibito.ch/api/v1/business-cases/credit-note
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://app.dibito.ch/api/v1/business-cases/credit-note?processingMode=STAGE' \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-d '{
"pdf": "string",
"businessCase": {
"referenceNumber": "string",
"businessCaseDate": "2019-08-24",
"totalAmount": {
"value": 0,
"currencyCode": "string"
},
"referencedBill": {
"referenceNumber": "string"
},
"billRecipient": {
"emailAddress": "string",
"enterpriseIdentificationNumber": "string",
"billRecipientSixId": "string",
"name": "string",
"address": {
"structuredAddress": {
"street": "string",
"buildingNumber": "string",
"city": "string",
"postalCode": "string",
"countryCode": "string"
}
}
},
"workflow": {
"vatEnterpriseIdentificationNumbers": {
"vatEnterpriseIdentificationNumber": [
"string"
]
},
"deliveryDateStart": "2019-08-24",
"deliveryDateEnd": "2019-08-24",
"netAmount": {
"value": 0,
"currencyCode": "string"
},
"amountPaid": {
"value": 0,
"currencyCode": "string"
},
"vatRates": {
"vatRate": [
{
"percentage": 0,
"taxBaseAmount": {
"value": 0,
"currencyCode": "string"
},
"taxAmount": {
"value": 0,
"currencyCode": "string"
}
}
]
},
"caseReferenceForBillRecipient": "string"
}
}
}'
Business case created
A unique SIX ID for this business case. Property must not be given when creating a new business case.
the type of the business case
A business case reference given by the biller. Must be unique in combination with the billerId.
The business case date (ISO-8601 format), can not be more than 90 days in the past on the date it was created. Cannot be in the future.
the processing status of the business case
An amount whose value may be omitted.
The amount value. Take care when using JavaScript libraries to parse this value - it should be treated as a financial amount and therefore not as a floating point number but rather using a precise decimal representation (like BigDecimal in Java). Maximum value: 99'999'999.99
Maximal length: 10
{ "id": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "type": "Bill", "billerSixId": "BIID0000123456", "referenceNumber": "2018-123456-22", "referencedBill": { "businessCaseSixId": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "referenceNumber": "2018-123456-22" }, "businessCaseDate": "Fri Dec 22 01:00:00 CET 2017", "status": "OPEN", "processingStatus": "STAGED", "totalAmount": { "value": 99.99, "currencyCode": "CHF" } }
Request
This operation accepts a PDF along with the business case information, which is to be included as XML attachment. The provided PDF must not contain an XML attachment. Ideally the PDF conforms to the PDF/A-3b, if not, conversion is attempted. Please note that PDF format conversion may fail due to various technical reason.
Credit Note
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
- max. 99'999'999.99 for invoices, payments by instalments, reminders, credit notes and donation inquiries
- min. - 99'999'999.99, max 99'999'999.99 for advices
- Amount must be greater than 0 for invoices, payments by instalments, reminders and donation inquiries.
- Amount must be ≥ 0 for credit notes.
- If an IBAN or QR-IBAN is used for invoices or payments by instalments, the amount does not have to be supplied (compatibility QR invoice).
- Generated server url
https://app.dibito.ch/api/v1/business-cases/credit-note/multipart
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://app.dibito.ch/api/v1/business-cases/credit-note/multipart?processingMode=STAGE' \
-H 'Content-Type: multipart/form-data' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-F file=string \
-F 'creditNote[referenceNumber]=string' \
-F 'creditNote[businessCaseDate]=2019-08-24' \
-F 'creditNote[totalAmount][value]=0' \
-F 'creditNote[totalAmount][currencyCode]=string' \
-F 'creditNote[referencedBill][referenceNumber]=string' \
-F 'creditNote[billRecipient][emailAddress]=string' \
-F 'creditNote[billRecipient][enterpriseIdentificationNumber]=string' \
-F 'creditNote[billRecipient][billRecipientSixId]=string' \
-F 'creditNote[billRecipient][name]=string' \
-F 'creditNote[billRecipient][address][structuredAddress][street]=string' \
-F 'creditNote[billRecipient][address][structuredAddress][buildingNumber]=string' \
-F 'creditNote[billRecipient][address][structuredAddress][city]=string' \
-F 'creditNote[billRecipient][address][structuredAddress][postalCode]=string' \
-F 'creditNote[billRecipient][address][structuredAddress][countryCode]=string' \
-F 'creditNote[workflow][vatEnterpriseIdentificationNumbers][vatEnterpriseIdentificationNumber]=string' \
-F 'creditNote[workflow][deliveryDateStart]=2019-08-24' \
-F 'creditNote[workflow][deliveryDateEnd]=2019-08-24' \
-F 'creditNote[workflow][netAmount][value]=0' \
-F 'creditNote[workflow][netAmount][currencyCode]=string' \
-F 'creditNote[workflow][amountPaid][value]=0' \
-F 'creditNote[workflow][amountPaid][currencyCode]=string' \
-F 'creditNote[workflow][vatRates][vatRate][0][percentage]=0' \
-F 'creditNote[workflow][vatRates][vatRate][0][taxBaseAmount][value]=0' \
-F 'creditNote[workflow][vatRates][vatRate][0][taxBaseAmount][currencyCode]=string' \
-F 'creditNote[workflow][vatRates][vatRate][0][taxAmount][value]=0' \
-F 'creditNote[workflow][vatRates][vatRate][0][taxAmount][currencyCode]=string' \
-F 'creditNote[workflow][caseReferenceForBillRecipient]=string'
Business case created
A unique SIX ID for this business case. Property must not be given when creating a new business case.
the type of the business case
A business case reference given by the biller. Must be unique in combination with the billerId.
The business case date (ISO-8601 format), can not be more than 90 days in the past on the date it was created. Cannot be in the future.
the processing status of the business case
An amount whose value may be omitted.
The amount value. Take care when using JavaScript libraries to parse this value - it should be treated as a financial amount and therefore not as a floating point number but rather using a precise decimal representation (like BigDecimal in Java). Maximum value: 99'999'999.99
Maximal length: 10
{ "id": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "type": "Bill", "billerSixId": "BIID0000123456", "referenceNumber": "2018-123456-22", "referencedBill": { "businessCaseSixId": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "referenceNumber": "2018-123456-22" }, "businessCaseDate": "Fri Dec 22 01:00:00 CET 2017", "status": "OPEN", "processingStatus": "STAGED", "totalAmount": { "value": 99.99, "currencyCode": "CHF" } }
Request
This operation accepts a PDF along with the business case information, which is to be included as XML attachment. The provided PDF must not contain an XML attachment. Ideally the PDF conforms to the PDF/A-3b, if not, conversion is attempted. Please note that PDF format conversion may fail due to various technical reason.
- application/json
- application/xml
- Generated server url
https://app.dibito.ch/api/v1/business-cases/bill
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://app.dibito.ch/api/v1/business-cases/bill?processingMode=STAGE' \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-d '{
"pdf": "string",
"businessCase": {
"referenceNumber": "string",
"businessCaseDate": "2019-08-24",
"totalAmount": {
"value": 0,
"currencyCode": "string"
},
"referencedBill": {
"referenceNumber": "string"
},
"billRecipient": {
"emailAddress": "string",
"enterpriseIdentificationNumber": "string",
"billRecipientSixId": "string",
"name": "string",
"address": {
"structuredAddress": {
"street": "string",
"buildingNumber": "string",
"city": "string",
"postalCode": "string",
"countryCode": "string"
}
}
},
"singlePayment": {
"paymentMode": "EBILL",
"paymentInformation": {
"accountAndReference": {
"accountHolder": {
"name": "string",
"structuredAddress": {
"street": "string",
"buildingNumber": "string",
"city": "string",
"postalCode": "string",
"countryCode": "string"
}
},
"generic": {
"referenceType": "QRR",
"referenceStructured": "string",
"referenceUnstructured": "string",
"iban": "CH9300762011623852957"
}
},
"amount": {
"value": 0,
"currencyCode": "string"
},
"dueDate": "2019-08-24",
"payableAmountCanBeModified": true
}
},
"workflow": {
"vatEnterpriseIdentificationNumbers": {
"vatEnterpriseIdentificationNumber": [
"string"
]
},
"deliveryDateStart": "2019-08-24",
"deliveryDateEnd": "2019-08-24",
"netAmount": {
"value": 0,
"currencyCode": "string"
},
"amountPaid": {
"value": 0,
"currencyCode": "string"
},
"vatRates": {
"vatRate": [
{
"percentage": 0,
"taxBaseAmount": {
"value": 0,
"currencyCode": "string"
},
"taxAmount": {
"value": 0,
"currencyCode": "string"
}
}
]
},
"caseReferenceForBillRecipient": "string"
}
}
}'
Business case created
A unique SIX ID for this business case. Property must not be given when creating a new business case.
the type of the business case
A business case reference given by the biller. Must be unique in combination with the billerId.
The business case date (ISO-8601 format), can not be more than 90 days in the past on the date it was created. Cannot be in the future.
the processing status of the business case
An amount whose value may be omitted.
The amount value. Take care when using JavaScript libraries to parse this value - it should be treated as a financial amount and therefore not as a floating point number but rather using a precise decimal representation (like BigDecimal in Java). Maximum value: 99'999'999.99
Maximal length: 10
{ "id": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "type": "Bill", "billerSixId": "BIID0000123456", "referenceNumber": "2018-123456-22", "referencedBill": { "businessCaseSixId": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "referenceNumber": "2018-123456-22" }, "businessCaseDate": "Fri Dec 22 01:00:00 CET 2017", "status": "OPEN", "processingStatus": "STAGED", "totalAmount": { "value": 99.99, "currencyCode": "CHF" } }
Request
This operation accepts a PDF along with the business case information, which is to be included as XML attachment. The provided PDF must not contain an XML attachment. Ideally the PDF conforms to the PDF/A-3b, if not, conversion is attempted. Please note that PDF format conversion may fail due to various technical reason.
Bill
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
- max. 99'999'999.99 for invoices, payments by instalments, reminders, credit notes and donation inquiries
- min. - 99'999'999.99, max 99'999'999.99 for advices
- Amount must be greater than 0 for invoices, payments by instalments, reminders and donation inquiries.
- Amount must be ≥ 0 for credit notes.
- If an IBAN or QR-IBAN is used for invoices or payments by instalments, the amount does not have to be supplied (compatibility QR invoice).
Information about the account and reference of the invoice issuer.
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
- max. 99'999'999.99 for invoices, payments by instalments, reminders, credit notes and donation inquiries
- min. - 99'999'999.99, max 99'999'999.99 for advices
- Amount must be greater than 0 for invoices, payments by instalments, reminders and donation inquiries.
- Amount must be ≥ 0 for credit notes.
- If an IBAN or QR-IBAN is used for invoices or payments by instalments, the amount does not have to be supplied (compatibility QR invoice).
Due date. In the case of donation inquiries, the due date acts as a proposal for the payment date.
At time of submission, cannot be set to more than 3 years in the future (1095 days) for payment mode ebill. At time of submission, cannot be set to more than 30 days in the future for payment mode ebill debit. At time of submission, cannot be older than 90 days.
- Generated server url
https://app.dibito.ch/api/v1/business-cases/bill/multipart
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://app.dibito.ch/api/v1/business-cases/bill/multipart?processingMode=STAGE' \
-H 'Content-Type: multipart/form-data' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-F file=string \
-F 'bill[referenceNumber]=string' \
-F 'bill[businessCaseDate]=2019-08-24' \
-F 'bill[totalAmount][value]=0' \
-F 'bill[totalAmount][currencyCode]=string' \
-F 'bill[referencedBill][referenceNumber]=string' \
-F 'bill[billRecipient][emailAddress]=string' \
-F 'bill[billRecipient][enterpriseIdentificationNumber]=string' \
-F 'bill[billRecipient][billRecipientSixId]=string' \
-F 'bill[billRecipient][name]=string' \
-F 'bill[billRecipient][address][structuredAddress][street]=string' \
-F 'bill[billRecipient][address][structuredAddress][buildingNumber]=string' \
-F 'bill[billRecipient][address][structuredAddress][city]=string' \
-F 'bill[billRecipient][address][structuredAddress][postalCode]=string' \
-F 'bill[billRecipient][address][structuredAddress][countryCode]=string' \
-F 'bill[singlePayment][paymentMode]=EBILL' \
-F 'bill[singlePayment][paymentInformation][accountAndReference][accountHolder][name]=string' \
-F 'bill[singlePayment][paymentInformation][accountAndReference][accountHolder][structuredAddress][street]=string' \
-F 'bill[singlePayment][paymentInformation][accountAndReference][accountHolder][structuredAddress][buildingNumber]=string' \
-F 'bill[singlePayment][paymentInformation][accountAndReference][accountHolder][structuredAddress][city]=string' \
-F 'bill[singlePayment][paymentInformation][accountAndReference][accountHolder][structuredAddress][postalCode]=string' \
-F 'bill[singlePayment][paymentInformation][accountAndReference][accountHolder][structuredAddress][countryCode]=string' \
-F 'bill[singlePayment][paymentInformation][accountAndReference][generic][referenceType]=QRR' \
-F 'bill[singlePayment][paymentInformation][accountAndReference][generic][referenceStructured]=string' \
-F 'bill[singlePayment][paymentInformation][accountAndReference][generic][referenceUnstructured]=string' \
-F 'bill[singlePayment][paymentInformation][accountAndReference][generic][iban]=CH9300762011623852957' \
-F 'bill[singlePayment][paymentInformation][amount][value]=0' \
-F 'bill[singlePayment][paymentInformation][amount][currencyCode]=string' \
-F 'bill[singlePayment][paymentInformation][dueDate]=2019-08-24' \
-F 'bill[singlePayment][paymentInformation][payableAmountCanBeModified]=true' \
-F 'bill[workflow][vatEnterpriseIdentificationNumbers][vatEnterpriseIdentificationNumber]=string' \
-F 'bill[workflow][deliveryDateStart]=2019-08-24' \
-F 'bill[workflow][deliveryDateEnd]=2019-08-24' \
-F 'bill[workflow][netAmount][value]=0' \
-F 'bill[workflow][netAmount][currencyCode]=string' \
-F 'bill[workflow][amountPaid][value]=0' \
-F 'bill[workflow][amountPaid][currencyCode]=string' \
-F 'bill[workflow][vatRates][vatRate][0][percentage]=0' \
-F 'bill[workflow][vatRates][vatRate][0][taxBaseAmount][value]=0' \
-F 'bill[workflow][vatRates][vatRate][0][taxBaseAmount][currencyCode]=string' \
-F 'bill[workflow][vatRates][vatRate][0][taxAmount][value]=0' \
-F 'bill[workflow][vatRates][vatRate][0][taxAmount][currencyCode]=string' \
-F 'bill[workflow][caseReferenceForBillRecipient]=string'
Business case created
A unique SIX ID for this business case. Property must not be given when creating a new business case.
the type of the business case
A business case reference given by the biller. Must be unique in combination with the billerId.
The business case date (ISO-8601 format), can not be more than 90 days in the past on the date it was created. Cannot be in the future.
the processing status of the business case
An amount whose value may be omitted.
The amount value. Take care when using JavaScript libraries to parse this value - it should be treated as a financial amount and therefore not as a floating point number but rather using a precise decimal representation (like BigDecimal in Java). Maximum value: 99'999'999.99
Maximal length: 10
{ "id": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "type": "Bill", "billerSixId": "BIID0000123456", "referenceNumber": "2018-123456-22", "referencedBill": { "businessCaseSixId": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "referenceNumber": "2018-123456-22" }, "businessCaseDate": "Fri Dec 22 01:00:00 CET 2017", "status": "OPEN", "processingStatus": "STAGED", "totalAmount": { "value": 99.99, "currencyCode": "CHF" } }
Request
This operation accepts a PDF along with the business case information, which is to be included as XML attachment. The provided PDF must not contain an XML attachment. Ideally the PDF conforms to the PDF/A-3b, if not, conversion is attempted. Please note that PDF format conversion may fail due to various technical reason.
- application/json
- application/xml
- Generated server url
https://app.dibito.ch/api/v1/business-cases/advice
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://app.dibito.ch/api/v1/business-cases/advice?processingMode=STAGE' \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-d '{
"pdf": "string",
"businessCase": {
"referenceNumber": "string",
"businessCaseDate": "2019-08-24",
"totalAmount": {
"value": 0,
"currencyCode": "string"
},
"referencedBill": {
"referenceNumber": "string"
},
"billRecipient": {
"emailAddress": "string",
"enterpriseIdentificationNumber": "string",
"billRecipientSixId": "string",
"name": "string",
"address": {
"structuredAddress": {
"street": "string",
"buildingNumber": "string",
"city": "string",
"postalCode": "string",
"countryCode": "string"
}
}
},
"workflow": {
"vatEnterpriseIdentificationNumbers": {
"vatEnterpriseIdentificationNumber": [
"string"
]
},
"deliveryDateStart": "2019-08-24",
"deliveryDateEnd": "2019-08-24",
"netAmount": {
"value": 0,
"currencyCode": "string"
},
"amountPaid": {
"value": 0,
"currencyCode": "string"
},
"vatRates": {
"vatRate": [
{
"percentage": 0,
"taxBaseAmount": {
"value": 0,
"currencyCode": "string"
},
"taxAmount": {
"value": 0,
"currencyCode": "string"
}
}
]
},
"caseReferenceForBillRecipient": "string"
}
}
}'
Business case created
A unique SIX ID for this business case. Property must not be given when creating a new business case.
the type of the business case
A business case reference given by the biller. Must be unique in combination with the billerId.
The business case date (ISO-8601 format), can not be more than 90 days in the past on the date it was created. Cannot be in the future.
the processing status of the business case
An amount whose value may be omitted.
The amount value. Take care when using JavaScript libraries to parse this value - it should be treated as a financial amount and therefore not as a floating point number but rather using a precise decimal representation (like BigDecimal in Java). Maximum value: 99'999'999.99
Maximal length: 10
{ "id": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "type": "Bill", "billerSixId": "BIID0000123456", "referenceNumber": "2018-123456-22", "referencedBill": { "businessCaseSixId": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "referenceNumber": "2018-123456-22" }, "businessCaseDate": "Fri Dec 22 01:00:00 CET 2017", "status": "OPEN", "processingStatus": "STAGED", "totalAmount": { "value": 99.99, "currencyCode": "CHF" } }
Request
This operation accepts a PDF along with the business case information, which is to be included as XML attachment. The provided PDF must not contain an XML attachment. Ideally the PDF conforms to the PDF/A-3b, if not, conversion is attempted. Please note that PDF format conversion may fail due to various technical reason.
Advice
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
- max. 99'999'999.99 for invoices, payments by instalments, reminders, credit notes and donation inquiries
- min. - 99'999'999.99, max 99'999'999.99 for advices
- Amount must be greater than 0 for invoices, payments by instalments, reminders and donation inquiries.
- Amount must be ≥ 0 for credit notes.
- If an IBAN or QR-IBAN is used for invoices or payments by instalments, the amount does not have to be supplied (compatibility QR invoice).
- Generated server url
https://app.dibito.ch/api/v1/business-cases/advice/multipart
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://app.dibito.ch/api/v1/business-cases/advice/multipart?processingMode=STAGE' \
-H 'Content-Type: multipart/form-data' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-F file=string \
-F 'advice[referenceNumber]=string' \
-F 'advice[businessCaseDate]=2019-08-24' \
-F 'advice[totalAmount][value]=0' \
-F 'advice[totalAmount][currencyCode]=string' \
-F 'advice[referencedBill][referenceNumber]=string' \
-F 'advice[billRecipient][emailAddress]=string' \
-F 'advice[billRecipient][enterpriseIdentificationNumber]=string' \
-F 'advice[billRecipient][billRecipientSixId]=string' \
-F 'advice[billRecipient][name]=string' \
-F 'advice[billRecipient][address][structuredAddress][street]=string' \
-F 'advice[billRecipient][address][structuredAddress][buildingNumber]=string' \
-F 'advice[billRecipient][address][structuredAddress][city]=string' \
-F 'advice[billRecipient][address][structuredAddress][postalCode]=string' \
-F 'advice[billRecipient][address][structuredAddress][countryCode]=string' \
-F 'advice[workflow][vatEnterpriseIdentificationNumbers][vatEnterpriseIdentificationNumber]=string' \
-F 'advice[workflow][deliveryDateStart]=2019-08-24' \
-F 'advice[workflow][deliveryDateEnd]=2019-08-24' \
-F 'advice[workflow][netAmount][value]=0' \
-F 'advice[workflow][netAmount][currencyCode]=string' \
-F 'advice[workflow][amountPaid][value]=0' \
-F 'advice[workflow][amountPaid][currencyCode]=string' \
-F 'advice[workflow][vatRates][vatRate][0][percentage]=0' \
-F 'advice[workflow][vatRates][vatRate][0][taxBaseAmount][value]=0' \
-F 'advice[workflow][vatRates][vatRate][0][taxBaseAmount][currencyCode]=string' \
-F 'advice[workflow][vatRates][vatRate][0][taxAmount][value]=0' \
-F 'advice[workflow][vatRates][vatRate][0][taxAmount][currencyCode]=string' \
-F 'advice[workflow][caseReferenceForBillRecipient]=string'
Business case created
A unique SIX ID for this business case. Property must not be given when creating a new business case.
the type of the business case
A business case reference given by the biller. Must be unique in combination with the billerId.
The business case date (ISO-8601 format), can not be more than 90 days in the past on the date it was created. Cannot be in the future.
the processing status of the business case
An amount whose value may be omitted.
The amount value. Take care when using JavaScript libraries to parse this value - it should be treated as a financial amount and therefore not as a floating point number but rather using a precise decimal representation (like BigDecimal in Java). Maximum value: 99'999'999.99
Maximal length: 10
{ "id": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "type": "Bill", "billerSixId": "BIID0000123456", "referenceNumber": "2018-123456-22", "referencedBill": { "businessCaseSixId": "BCID0FB909852BBC4D06AD8336AAE87D7FC9", "referenceNumber": "2018-123456-22" }, "businessCaseDate": "Fri Dec 22 01:00:00 CET 2017", "status": "OPEN", "processingStatus": "STAGED", "totalAmount": { "value": 99.99, "currencyCode": "CHF" } }
- Generated server url
https://app.dibito.ch/api/v1/business-cases/{businessCaseId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://app.dibito.ch/api/v1/business-cases/{businessCaseId}' \
-H 'X-API-Key: YOUR_API_KEY_HERE'