Download OpenAPI specification:
External invoice API, authenticated via the shared Keycloak invoice-api realm.
{- "data": [
- {
- "invoiceId": "string",
- "companyId": null,
- "direction": null,
- "status": "string",
- "createdAt": null,
- "invoiceNumber": null,
- "invoiceType": null,
- "invoice": null
}
], - "exclusiveStartKey": null
}{- "data": [
- {
- "invoiceId": "string",
- "companyId": null,
- "direction": null,
- "status": "string",
- "createdAt": null,
- "invoiceNumber": null,
- "invoiceType": null,
- "invoice": null
}
], - "exclusiveStartKey": null
}required | Array of objects (Invoices) [ 1 .. 200 ] items |
{- "invoices": [
- {
- "deliveryType": "email",
- "invoice": {
- "invoiceTypeCode": "380",
- "invoiceNumber": "string",
- "invoiceIssueDate": "string",
- "invoiceCurrencyCode": "EUR",
- "invoiceFormat": "ubl",
- "buyerReference": "B2B_Rechnung",
- "paymentMeansTypeCode": "string",
- "paymentDueDate": null,
- "paymentTerms": null,
- "remittanceInformation": null,
- "paidAmount": null,
- "creditTransfer": null,
- "mandateReferenceIdentifier": null,
- "bankAssignedCreditorIdentifier": null,
- "debitedAccountIdentifier": null,
- "purchaseOrderReference": null,
- "salesOrderReference": null,
- "despatchAdviceReference": null,
- "tenderOrLotReference": null,
- "contractReference": null,
- "projectReference": null,
- "invoicingPeriodStartDate": null,
- "invoicingPeriodEndDate": null,
- "invoiceDocumentReference": null,
- "deliverToParty": null,
- "documentAllowance": null,
- "documentCharge": null,
- "buyer": {
- "name": "string",
- "electronicAddress": "string",
- "addressLine1": null,
- "addressLine2": null,
- "addressLine3": null,
- "postCode": "string",
- "city": "string",
- "countryCode": null,
- "electronicAddressScheme": null,
- "contactPoint": null,
- "contactEmailAddress": null,
- "contactTelephoneNumber": null,
- "vatIdentifier": null,
- "identifier": null,
- "identifierScheme": null
}, - "seller": {
- "name": "string",
- "electronicAddress": "string",
- "addressLine1": null,
- "addressLine2": null,
- "addressLine3": null,
- "postCode": "string",
- "city": "string",
- "countryCode": "string",
- "electronicAddressScheme": null,
- "contactPoint": "string",
- "contactEmailAddress": "string",
- "contactTelephoneNumber": "string",
- "vatIdentifier": null,
- "identifier": null,
- "identifierScheme": null,
- "additionalLegalInformation": null
}, - "invoiceLine": [
- {
- "identifier": "string",
- "name": "string",
- "quantityUnitMeasureCode": "string",
- "description": null,
- "quantity": null,
- "netPrice": null,
- "priceBaseQuantity": null,
- "vatRate": null,
- "vatCategoryCode": null,
- "netAmount": null,
- "sellersIdentifier": null,
- "buyersIdentifier": null,
- "standardIdentifier": null,
- "standardIdentifierScheme": null,
- "referencedPurchaseOrderLineReference": null,
- "itemAttributes": null,
- "allowance": null,
- "charge": null
}
]
}
}
]
}{- "total": 0,
- "createdCount": 0,
- "failedCount": 0,
- "created": [
- {
- "invoiceId": "string",
- "invoiceNumber": ""
}
], - "errors": [
- {
- "invoiceId": null,
- "error": "string",
- "invoice": { }
}
]
}