API Docs Help

Document External

/v1/external/documents/delivery-notes GET

GET method/v1/external/documents/delivery-notes

Request parameters

Responses

{ "data": "example", "count": 96, "total": 96, "page": 96, "pageCount": 96 }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/external/documents/delivery-notes/upload POST

POST method/v1/external/documents/delivery-notes/upload

Request parameters

{ "source": "example", "metadata": "example", "note": "example", "vendorInternalNumber": "example", "recipientInternalNumber": "example", "action": "normal", "files": [ { "fileName": "example", "fileContent": "example" } ] }

Responses

{ "documents": [ { "documentId": "example", "dnId": "example", "estimatedTime": 16.0 } ] }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/external/documents/e-invoices GET

GET method/v1/external/documents/e-invoices

Request parameters

Responses

{ "count": 96, "data": [ { "attachments": [ "example" ], "auditTrail": [ { "id": "example", "documentId": "example", "userId": "example", "userName": "example", "UserRole": "customer", "createdAt": "1971-04-26T12:26:06Z", "type": "created", "subType": "email", "comment": "example", "field": "example", "updates": { "newValue": "example", "oldValue": "example" } } ], "companyId": "example", "createdAt": "example", "creatorId": "example", "document": { "action": "example", "companyId": "example", "documentsCount": 96, "extractionStatus": "example", "id": "example", "metadata": "example", "name": "example", "note": "example", "pagesCount": 96, "path": "example", "senderEmail": "example", "totalExtractionIssues": 96, "type": "example", "userId": "example", "uuid": "example" }, "documentId": "example", "eInvoiceFields": { "invoiceNumber": "example", "invoiceIssueDate": "example", "invoiceTypeCode": "example", "invoiceCurrencyCode": "example", "vatAccountingCurrencyCode": "example", "valueAddedTaxPointDate": "example", "valueAddedTaxPointDateCode": "example", "paymentDueDate": "example", "recipientReference": "example", "projectReferenceId": "example", "projectReferenceName": "example", "contractReference": "example", "purchaseOrderReference": "example", "salesOrderReference": "example", "receivingAdviceReference": "example", "despatchAdviceReference": "example", "tenderOrLotReferenceId": "example", "tenderOrLotReferenceTypeCode": "example", "invoicedObjectIdentifierId": "example", "invoicedObjectIdentifierSchemeIdentifier": "example", "recipientAccountingReference": "example", "paymentTerms": "example", "invoiceNote": [ { "invoiceNoteSubjectCode": "example", "invoiceNote": "example" } ], "processControlBusinessProcessType": "example", "processControlSpecificationIdentifierId": "example", "processControlSpecificationIdentifierSchemeIdentifier": "example", "precedingInvoiceReference": [ { "precedingInvoiceReferenceId": "example", "precedingInvoiceReferenceSchemeIdentifier": "example", "precedingInvoiceIssueDate": "example" } ], "vendorName": "example", "vendorTradingName": "example", "vendorIdentifierId": [ "example" ], "vendorIdentifierSchemeIdentifier": [ "example" ], "vendorLegalRegistrationIdentifierId": "example", "vendorLegalRegistrationIdentifierSchemeIdentifier": "example", "vendorVatIdentifier": "example", "vendorTaxRegistrationIdentifier": "example", "vendorAdditionalLegalInformation": "example", "vendorElectronicAddressUriId": "example", "vendorElectronicAddressSchemeIdentifier": "example", "vendorPostalAddressAddressLines": [ "example" ], "vendorPostalAddressCity": "example", "vendorPostalAddressPostCode": "example", "vendorPostalAddressCountrySubdivision": "example", "vendorPostalAddressCountryCode": "example", "vendorContactPersonName": "example", "vendorContactDepartmentName": "example", "vendorContactTelephoneNumber": "example", "vendorContactEmailAddress": "example", "recipientName": "example", "recipientTradingName": "example", "recipientIdentifierId": "example", "recipientIdentifierSchemeIdentifier": "example", "recipientLegalRegistrationIdentifierId": "example", "recipientLegalRegistrationIdentifierSchemeIdentifier": "example", "recipientVatIdentifier": "example", "recipientElectronicAddressUriId": "example", "recipientElectronicAddressSchemeIdentifier": "example", "recipientPostalAddressAddressLines": [ "example" ], "recipientPostalAddressCity": "example", "recipientPostalAddressPostCode": "example", "recipientPostalAddressCountrySubdivision": "example", "recipientPostalAddressCountryCode": "example", "recipientContactPersonName": "example", "recipientContactDepartmentName": "example", "recipientContactTelephoneNumber": "example", "recipientContactEmailAddress": "example", "payeeName": "example", "payeeIdentifierId": [ "example" ], "payeeIdentifierSchemeIdentifier": [ "example" ], "payeeLegalRegistrationIdentifierId": "example", "payeeLegalRegistrationIdentifierSchemeIdentifier": "example", "vendorTaxRepresentativeName": "example", "vendorTaxRepresentativeVatIdentifierId": "example", "vendorTaxRepresentativeVatIdentifierSchemeIdentifier": "example", "vendorTaxRepresentativePostalAddressAddressLines": [ "example" ], "vendorTaxRepresentativePostalAddressCity": "example", "vendorTaxRepresentativePostalAddressPostCode": "example", "vendorTaxRepresentativePostalAddressCountrySubdivision": "example", "vendorTaxRepresentativePostalAddressCountryCode": "example", "deliveryInformationDeliverToPartyName": "example", "deliveryInformationDeliverToLocationIdentifierId": "example", "deliveryInformationDeliverToLocationIdentifierScheme": "example", "deliveryInformationActualDeliveryDate": "example", "deliveryInformationInvoicingPeriodStartDate": "example", "deliveryInformationInvoicingPeriodEndDate": "example", "deliveryInformationDeliverToAddressAddressLines": [ "example" ], "deliveryInformationDeliverToAddressCity": "example", "deliveryInformationDeliverToAddressPostCode": "example", "deliveryInformationDeliverToAddressCountrySubdivision": "example", "deliveryInformationDeliverToAddressCountryCode": "example", "paymentInstructionsPaymentMeansTypeCode": "example", "paymentInstructionsPaymentMeansText": "example", "paymentInstructionsRemittanceInformation": "example", "paymentInstructionsCreditTransfer": [ { "paymentAccountIdentifierId": [ "example" ], "paymentAccountIdentifierSchemeIdentifier": [ "example" ], "paymentAccountName": "example", "paymentServiceProviderIdentifierId": [ "example" ], "paymentServiceProviderIdentifierSchemeIdentifier": [ "example" ] } ], "paymentInstructionsCardInformationPrimaryAccountNumber": "example", "paymentInstructionsCardInformationCardHolderName": "example", "paymentInstructionsDirectDebitMandateId": "example", "paymentInstructionsDirectDebitMandateScheme": "example", "paymentInstructionsDirectDebitBankCreditorId": "example", "paymentInstructionsDirectDebitBankCreditorScheme": "example", "paymentInstructionsDirectDebitDebitedAccountId": "example", "paymentInstructionsDirectDebitDebitedAccountScheme": "example", "documentLevelAllowances": [ { "documentLevelAllowanceAmount": 16.0, "documentLevelAllowanceBaseAmount": 16.0, "documentLevelAllowancePercentage": 16.0, "documentLevelAllowanceVatCategoryCode": "example", "documentLevelAllowanceVatCategoryTypeCode": "example", "documentLevelAllowanceVatRate": 16.0, "documentLevelAllowanceReason": "example", "documentLevelAllowanceReasonCode": "example" } ], "documentLevelCharges": [ { "documentLevelChargeAmount": 16.0, "documentLevelChargeBaseAmount": 16.0, "documentLevelChargePercentage": 16.0, "documentLevelChargeVatCategoryCode": "example", "documentLevelChargeVatCategoryTypeCode": "example", "documentLevelChargeVatRate": 16.0, "documentLevelChargeReason": "example", "documentLevelChargeReasonCode": "example" } ], "sumOfInvoiceLineNetAmount": 16.0, "sumOfAllowancesOnDocumentLevel": 16.0, "sumOfChargesOnDocumentLevel": 16.0, "invoiceTotalAmountWithoutVat": 16.0, "invoiceTotalVatAmount": 16.0, "invoiceTotalVatAmountInAccountingCurrency": 16.0, "invoiceTotalAmountWithVat": 16.0, "paidAmount": 16.0, "roundingAmount": 16.0, "amountDueForPayment": 16.0, "vatBreakdown": [ { "vatCategoryTaxableAmount": 16.0, "vatCategoryTaxAmount": 16.0, "vatCategoryCode": "example", "vatCategoryTypeCode": "example", "vatCategoryRate": 16.0, "vatExemptionReasonText": "example", "vatExemptionReasonCode": "example" } ], "additionalSupportingDocuments": [ { "supportingDocumentReference": "example", "supportingDocumentDescription": "example", "externalDocumentLocation": "example", "attachedDocumentBinaryObject": "example", "attachedDocumentMimeCode": "example", "attachedDocumentFilename": "example" } ], "invoiceLine": [ { "invoiceLineIdentifierId": "example", "invoiceLineIdentifierSchemeIdentifier": "example", "invoiceLineNote": "example", "invoiceLineObjectIdentifierId": "example", "invoiceLineObjectIdentifierSchemeIdentifier": "example", "invoicedQuantity": 16.0, "invoicedQuantityUnitOfMeasureCode": "example", "invoiceLineNetAmount": 16.0, "referencedPurchaseOrderLineReferenceId": "example", "referencedPurchaseOrderLineReferenceSchemeIdentifier": "example", "invoiceLineRecipientAccountingReference": "example", "invoiceLinePeriodInvoiceLinePeriodStartDate": "example", "invoiceLinePeriodInvoiceLinePeriodEndDate": "example", "invoiceLineAllowanceAmount": [ 16.0 ], "invoiceLineAllowanceBaseAmount": [ 16.0 ], "invoiceLineAllowancePercentage": [ 16.0 ], "invoiceLineAllowanceReason": [ "example" ], "invoiceLineAllowanceReasonCode": [ "example" ], "invoiceLineChargeAmount": [ 16.0 ], "invoiceLineChargeBaseAmount": [ 16.0 ], "invoiceLineChargePercentage": [ 16.0 ], "invoiceLineChargeReason": [ "example" ], "invoiceLineChargeReasonCode": [ "example" ], "priceDetailsItemNetPrice": 16.0, "priceDetailsItemPriceDiscount": 16.0, "priceDetailsItemGrossPrice": 16.0, "priceDetailsItemPriceBaseQuantity": 16.0, "priceDetailsItemPriceBaseQuantityUnitOfMeasureCode": "example", "lineVatInformationInvoicedItemVatCategoryCode": "example", "lineVatInformationInvoicedItemVatCategoryTypeCode": "example", "lineVatInformationInvoicedItemVatRate": 16.0, "itemInformationItemName": "example", "itemInformationItemDescription": "example", "itemInformationItemVendorsIdentifierId": "example", "itemInformationItemVendorsIdentifierSchemeIdentifier": "example", "itemInformationItemRecipientsIdentifierId": "example", "itemInformationItemRecipientsIdentifierSchemeIdentifier": "example", "itemInformationItemStandardIdentifierId": "example", "itemInformationItemStandardIdentifierSchemeIdentifier": "example", "itemInformationItemClassificationIdentifiersId": [ "example" ], "itemInformationItemClassificationIdentifiersSchemeIdentifier": [ "example" ], "itemInformationItemClassificationIdentifierSchemeIdentifier": "example", "itemInformationItemClassificationIdentifierSchemeVersionIdentifier": "example", "itemInformationItemCountryOfOriginCode": "example", "itemInformationItemAttributesItemAttributeName": [ "example" ], "itemInformationItemAttributesItemAttributeValue": [ "example" ] } ] }, "eInvoicePdfPath": "example", "errorsCount": 96, "exportedAt": "example", "fileName": "example", "id": "example", "rejectReason": "example", "reportFilePath": "example", "source": "example", "status": "example", "validationStatus": "example", "violations": [ "example" ], "warningsCount": 96 } ], "page": 96, "pageCount": 96, "total": 96 }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/external/documents/invoices GET

GET method/v1/external/documents/invoices

Request parameters

Responses

{ "data": "example", "count": 96, "total": 96, "page": 96, "pageCount": 96 }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/external/documents/invoices/to-export GET

GET method/v1/external/documents/invoices/to-export

Request parameters

Responses

{ "data": [ "example" ], "count": 96, "total": 96, "page": 96, "pageCount": 96 }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/external/documents/invoices/upload POST

POST method/v1/external/documents/invoices/upload

Request parameters

{ "source": "example", "metadata": "example", "note": "example", "vendorInternalNumber": "example", "recipientInternalNumber": "example", "action": "normal", "files": [ { "fileName": "example", "fileContent": "example" } ] }

Responses

{ "files": [ { "fileId": "example", "invoiceId": "example", "estimatedTime": 16.0 } ] }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/external/documents/{id}/audit-trails GET

GET method/v1/external/documents/{id}/audit-trails

Request parameters

Responses

{ "data": "example", "count": 96, "total": 96, "page": 96, "pageCount": 96 }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v2/external/documents/invoices/upload POST

POST method/v2/external/documents/invoices/upload

Request parameters

{ "source": "example", "metadata": "example", "note": "example", "vendorInternalNumber": "example", "recipientInternalNumber": "example", "action": "normal", "files": [ { "fileName": "example", "fileContent": "example" } ] }

Responses

{ "files": [ { "fileId": "example", "invoiceId": "example", "type": "example", "estimatedTime": 16.0 } ] }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }
Last modified: 20 October 2024